Skip to content

Default gem update documentation format is now only ri #3888

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hsbt merged 6 commits into from
Aug 26, 2020
Merged

Default gem update documentation format is now only ri #3888

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
44d4d8a
Re-use the install_update_default_str and its options.
hsbt Aug 6, 2020
899b992
Fixed the inconsitency options between install and update commands
hsbt Aug 18, 2020
8a3e771
Extract the default options with install and update commands
hsbt Aug 18, 2020
2db38f4
Fixed the test failures with document options of update command
hsbt Aug 18, 2020
2e6ef11
rubocop -a
hsbt Aug 18, 2020
314bbda
--wrappers option is true on the default option of Gem::DependencyIns…
hsbt Aug 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions lib/rubygems/commands/install_command.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ def initialize
:without_groups => [],
})

defaults.merge!(install_update_options)

super 'install', 'Install a gem into the local repository', defaults

add_install_update_options
Expand All @@ -43,8 +45,9 @@ def arguments # :nodoc:
end

def defaults_str # :nodoc:
"--both --version '#{Gem::Requirement.default}' --document --no-force\n" +
"--install-dir #{Gem.dir} --lock"
"--both --version '#{Gem::Requirement.default}' --no-force\n" +
"--install-dir #{Gem.dir} --lock\n" +
install_update_defaults_str
end

def description # :nodoc:
Expand Down
13 changes: 9 additions & 4 deletions lib/rubygems/commands/update_command.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,13 @@ class Gem::Commands::UpdateCommand < Gem::Command
attr_reader :updated # :nodoc:

def initialize
super 'update', 'Update installed gems to the latest version',
:document => %w[rdoc ri],
:force => false
options = {
:force => false,
}

options.merge!(install_update_options)

super 'update', 'Update installed gems to the latest version', options

add_install_update_options

Expand Down Expand Up @@ -51,7 +55,8 @@ def arguments # :nodoc:
end

def defaults_str # :nodoc:
"--document --no-force --install-dir #{Gem.dir}"
"--no-force --install-dir #{Gem.dir}\n" +
install_update_defaults_str
end

def description # :nodoc:
Expand Down
13 changes: 11 additions & 2 deletions lib/rubygems/install_update_options.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,10 +181,19 @@ def add_install_update_options
end

##
# Default options for the gem install command.
# Default options for the gem install and update commands.

def install_update_options
{
:document => %w[ri],
}
end

##
# Default description for the gem install and update commands.

def install_update_defaults_str
'--document=rdoc,ri --wrappers'
'--document=ri'
Copy link
Copy Markdown
Contributor

@deivid-rodriguez deivid-rodriguez Aug 28, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you know what this --wrappers thing is?

Copy link
Copy Markdown
Member Author

@hsbt hsbt Aug 28, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default value of --wrappers is true on DependencyInstaller. I remove it with the other options.

Copy link
Copy Markdown
Contributor

@deivid-rodriguez deivid-rodriguez Aug 28, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I understood, I was just asking if you now what it does. I think it's about creating binstubs wrappers instead of symlinks, but not sure. Anyways, I was just curious.

end

end
2 changes: 1 addition & 1 deletion test/rubygems/test_gem_command_manager.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ def test_process_args_update

#check defaults
@command_manager.process_args %w[update]
assert_includes check_options[:document], 'rdoc'
assert_includes check_options[:document], 'ri'

#check settings
check_options = nil
Expand Down
4 changes: 2 additions & 2 deletions test/rubygems/test_gem_commands_update_command.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -552,7 +552,7 @@ def test_handle_options_system

expected = {
:args => [],
:document => %w[rdoc ri],
:document => %w[ri],
:force => false,
:system => true,
}
Expand All @@ -571,7 +571,7 @@ def test_handle_options_system_specific

expected = {
:args => [],
:document => %w[rdoc ri],
:document => %w[ri],
:force => false,
:system => "1.3.7",
}
Expand Down