Skip to content

Commit

Permalink
Move ronn pages to lib
Browse files Browse the repository at this point in the history
  • Loading branch information
deivid-rodriguez committed Oct 7, 2020
1 parent 4425cd6 commit 8e20455
Show file tree
Hide file tree
Showing 33 changed files with 41 additions and 36 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/install-rubygems.yml
Expand Up @@ -42,6 +42,8 @@ jobs:
run: bundle --version
- name: Check bundler man pages were installed and are properly picked up
run: bundle install --help | grep -q BUNDLE-INSTALL
- name: Check bundler fallback man pages are properly picked up
run: sudo rm $(which man) && bundle install --help
- name: Build bundler
run: gem build bundler.gemspec
working-directory: ./bundler
Expand Down
51 changes: 26 additions & 25 deletions Manifest.txt
Expand Up @@ -89,6 +89,32 @@ bundler/lib/bundler/installer/standalone.rb
bundler/lib/bundler/lazy_specification.rb
bundler/lib/bundler/lockfile_generator.rb
bundler/lib/bundler/lockfile_parser.rb
bundler/lib/bundler/man/.document
bundler/lib/bundler/man/bundle-add.1.ronn
bundler/lib/bundler/man/bundle-binstubs.1.ronn
bundler/lib/bundler/man/bundle-cache.1.ronn
bundler/lib/bundler/man/bundle-check.1.ronn
bundler/lib/bundler/man/bundle-clean.1.ronn
bundler/lib/bundler/man/bundle-config.1.ronn
bundler/lib/bundler/man/bundle-doctor.1.ronn
bundler/lib/bundler/man/bundle-exec.1.ronn
bundler/lib/bundler/man/bundle-gem.1.ronn
bundler/lib/bundler/man/bundle-info.1.ronn
bundler/lib/bundler/man/bundle-init.1.ronn
bundler/lib/bundler/man/bundle-inject.1.ronn
bundler/lib/bundler/man/bundle-install.1.ronn
bundler/lib/bundler/man/bundle-list.1.ronn
bundler/lib/bundler/man/bundle-lock.1.ronn
bundler/lib/bundler/man/bundle-open.1.ronn
bundler/lib/bundler/man/bundle-outdated.1.ronn
bundler/lib/bundler/man/bundle-platform.1.ronn
bundler/lib/bundler/man/bundle-pristine.1.ronn
bundler/lib/bundler/man/bundle-remove.1.ronn
bundler/lib/bundler/man/bundle-show.1.ronn
bundler/lib/bundler/man/bundle-update.1.ronn
bundler/lib/bundler/man/bundle-viz.1.ronn
bundler/lib/bundler/man/bundle.1.ronn
bundler/lib/bundler/man/gemfile.5.ronn
bundler/lib/bundler/match_platform.rb
bundler/lib/bundler/mirror.rb
bundler/lib/bundler/plugin.rb
Expand Down Expand Up @@ -253,55 +279,30 @@ bundler/lib/bundler/vlad.rb
bundler/lib/bundler/worker.rb
bundler/lib/bundler/yaml_serializer.rb
bundler/man/bundle-add.1
bundler/man/bundle-add.1.ronn
bundler/man/bundle-binstubs.1
bundler/man/bundle-binstubs.1.ronn
bundler/man/bundle-cache.1
bundler/man/bundle-cache.1.ronn
bundler/man/bundle-check.1
bundler/man/bundle-check.1.ronn
bundler/man/bundle-clean.1
bundler/man/bundle-clean.1.ronn
bundler/man/bundle-config.1
bundler/man/bundle-config.1.ronn
bundler/man/bundle-doctor.1
bundler/man/bundle-doctor.1.ronn
bundler/man/bundle-exec.1
bundler/man/bundle-exec.1.ronn
bundler/man/bundle-gem.1
bundler/man/bundle-gem.1.ronn
bundler/man/bundle-info.1
bundler/man/bundle-info.1.ronn
bundler/man/bundle-init.1
bundler/man/bundle-init.1.ronn
bundler/man/bundle-inject.1
bundler/man/bundle-inject.1.ronn
bundler/man/bundle-install.1
bundler/man/bundle-install.1.ronn
bundler/man/bundle-list.1
bundler/man/bundle-list.1.ronn
bundler/man/bundle-lock.1
bundler/man/bundle-lock.1.ronn
bundler/man/bundle-open.1
bundler/man/bundle-open.1.ronn
bundler/man/bundle-outdated.1
bundler/man/bundle-outdated.1.ronn
bundler/man/bundle-platform.1
bundler/man/bundle-platform.1.ronn
bundler/man/bundle-pristine.1
bundler/man/bundle-pristine.1.ronn
bundler/man/bundle-remove.1
bundler/man/bundle-remove.1.ronn
bundler/man/bundle-show.1
bundler/man/bundle-show.1.ronn
bundler/man/bundle-update.1
bundler/man/bundle-update.1.ronn
bundler/man/bundle-viz.1
bundler/man/bundle-viz.1.ronn
bundler/man/bundle.1
bundler/man/bundle.1.ronn
bundler/man/gemfile.5
bundler/man/gemfile.5.ronn
bundler/man/index.txt
hide_lib_for_update/note.txt
lib/rubygems.rb
Expand Down
4 changes: 2 additions & 2 deletions bundler/Rakefile
Expand Up @@ -79,8 +79,8 @@ namespace :man do
else
directory "man"

index = Dir["man/*.ronn"].map do |source|
ronn = "man/#{File.basename(source)}"
index = Dir["lib/bundler/man/*.ronn"].map do |source|
ronn = "lib/bundler/man/#{File.basename(source)}"
roff = "man/#{File.basename(source, ".ronn")}"

file roff => ["man", ronn] do
Expand Down
4 changes: 2 additions & 2 deletions bundler/doc/documentation/WRITING.md
Expand Up @@ -20,9 +20,9 @@ Don't see a man page for a command? Make a new page and send us a PR! We also we

## Creating a new man page

To create a new man page, simply create a new `.ronn` file in the `man/` directory.
To create a new man page, simply create a new `.ronn` file in the `lib/bundler/man/` directory.

For example: to create a man page for the command `bundle cookies` (not a real command, sadly), I would create a file `man/bundle-cookies.1.ronn` and add my documentation there.
For example: to create a man page for the command `bundle cookies` (not a real command, sadly), I would create a file `lib/bundler/man/bundle-cookies.1.ronn` and add my documentation there.

## Formatting

Expand Down
3 changes: 2 additions & 1 deletion bundler/lib/bundler/cli.rb
Expand Up @@ -134,7 +134,8 @@ def help(cli = nil)
if Bundler.which("man") && man_path !~ %r{^file:/.+!/META-INF/jruby.home/.+}
Kernel.exec "man #{man_page}"
else
puts File.read("#{File.dirname(man_page)}/#{File.basename(man_page)}.ronn")
fallback_man_path = File.expand_path("../man", __FILE__)
puts File.read("#{fallback_man_path}/#{File.basename(man_page)}.ronn")
end
elsif command_path = Bundler.which("bundler-#{cli}")
Kernel.exec(command_path, "--help")
Expand Down
1 change: 1 addition & 0 deletions bundler/lib/bundler/man/.document
@@ -0,0 +1 @@
# Ignore all files in this directory
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions bundler/spec/quality_spec.rb
Expand Up @@ -190,7 +190,7 @@ def check_for_specific_pronouns(filename)
line.scan(/Bundler\.settings\[:#{key_pattern}\]/).flatten.each {|s| all_settings[s] << "referenced at `#{filename}:#{number.succ}`" }
end
end
documented_settings = File.read("man/bundle-config.1.ronn")[/LIST OF AVAILABLE KEYS.*/m].scan(/^\* `#{key_pattern}`/).flatten
documented_settings = File.read("lib/bundler/man/bundle-config.1.ronn")[/LIST OF AVAILABLE KEYS.*/m].scan(/^\* `#{key_pattern}`/).flatten

documented_settings.each do |s|
all_settings.delete(s)
Expand Down Expand Up @@ -249,7 +249,7 @@ def check_for_specific_pronouns(filename)
end

it "does not use require internally, but require_relative" do
exempt = %r{templates/|vendor/}
exempt = %r{templates/|man/|vendor/}
all_bad_requires = []
lib_tracked_files.each do |filename|
next if filename =~ exempt
Expand Down
8 changes: 4 additions & 4 deletions test/rubygems/test_gem_commands_setup_command.rb
Expand Up @@ -26,12 +26,12 @@ def setup
bundler/exe/bundle
bundler/lib/bundler.rb
bundler/lib/bundler/b.rb
bundler/lib/bundler/man/bundle-b.1.ronn
bundler/lib/bundler/man/gemfile.5.ronn
bundler/lib/bundler/templates/.circleci/config.yml
bundler/lib/bundler/templates/.travis.yml
bundler/man/bundle-b.1
bundler/man/bundle-b.1.ronn
bundler/man/gemfile.5
bundler/man/gemfile.5.ronn
]

create_dummy_files(filelist)
Expand Down Expand Up @@ -182,7 +182,7 @@ def test_install_lib
assert_path_exists File.join(dir, 'bundler.rb')
assert_path_exists File.join(dir, 'bundler/b.rb')

assert_path_exists File.join(dir, 'bundler/templates/.circleci/config.yml')
assert_path_exists File.join(dir, 'bundler/templates/.circleci/config.yml') unless RUBY_ENGINE == "truffleruby" # https://github.com/oracle/truffleruby/issues/2116
assert_path_exists File.join(dir, 'bundler/templates/.travis.yml')
end
end
Expand Down Expand Up @@ -292,7 +292,7 @@ def test_remove_old_lib_files

@cmd.remove_old_lib_files lib

files_that_go.each {|file| refute_path_exists file }
files_that_go.each {|file| refute_path_exists(file) unless file == old_bundler_ci && RUBY_ENGINE == "truffleruby" } # https://github.com/oracle/truffleruby/issues/2116

files_that_stay.each {|file| assert_path_exists file }
end
Expand Down

0 comments on commit 8e20455

Please sign in to comment.