jenkins-bot has submitted this change and it was merged. Change subject: Fixed Style/StringLiterals RuboCop offense ......................................................................
Fixed Style/StringLiterals RuboCop offense Bug: T106220 Change-Id: I512044e683c671373c935708dbd65788465a19da --- M .rubocop_todo.yml M features/step_definitions/roles_steps.rb M features/support/hooks.rb M lib/labs-vagrant.rb M lib/mediawiki-vagrant/config.rb M lib/mediawiki-vagrant/environment.rb M lib/mediawiki-vagrant/forward_port.rb M lib/mediawiki-vagrant/git-update.rb M lib/mediawiki-vagrant/hiera.rb M lib/mediawiki-vagrant/import-dump.rb M lib/mediawiki-vagrant/paste-puppet.rb M lib/mediawiki-vagrant/roles/enable.rb M lib/mediawiki-vagrant/roles/list.rb M lib/mediawiki-vagrant/run-tests.rb M lib/mediawiki-vagrant/settings/definitions.rb M lib/mediawiki-vagrant/setup.rb 16 files changed, 79 insertions(+), 85 deletions(-) Approvals: Dduvall: Looks good to me, approved Hashar: Looks good to me, but someone else must approve jenkins-bot: Verified diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index 4e85f76..339e23d 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -145,12 +145,6 @@ - 'support/completion.rb' - 'support/setup.rb' -# Offense count: 95 -# Cop supports --auto-correct. -# Configuration parameters: EnforcedStyle, SupportedStyles. -Style/StringLiterals: - Enabled: false - # Offense count: 5 # Cop supports --auto-correct. # Configuration parameters: EnforcedStyleForMultiline, SupportedStyles. diff --git a/features/step_definitions/roles_steps.rb b/features/step_definitions/roles_steps.rb index 322a8e5..7868c4c 100644 --- a/features/step_definitions/roles_steps.rb +++ b/features/step_definitions/roles_steps.rb @@ -16,7 +16,7 @@ end Given(/^the settings for the "(.*?)" role are:$/) do |role, settings| - FileUtils.mkdir_p(@mwv.path("puppet/modules/role/settings")) + FileUtils.mkdir_p(@mwv.path('puppet/modules/role/settings')) @mwv.path("puppet/modules/role/settings/#{role}.yaml").open('w') { |io| io.write(settings) } end diff --git a/features/support/hooks.rb b/features/support/hooks.rb index 100ccec..c2503fa 100644 --- a/features/support/hooks.rb +++ b/features/support/hooks.rb @@ -11,7 +11,7 @@ FileUtils.mkdir_p('tmp/testenv/home') FileUtils.mkdir_p('tmp/testenv/mwv') - excludes = "--exclude=/Gemfile --exclude=/vendor --exclude=/.git --exclude=/tmp" + excludes = '--exclude=/Gemfile --exclude=/vendor --exclude=/.git --exclude=/tmp' system("rsync -a #{excludes} --filter='dir-merge,- .gitignore' ./ 'tmp/testenv/mwv/'") end diff --git a/lib/labs-vagrant.rb b/lib/labs-vagrant.rb index 679d4db..fb3f2b0 100755 --- a/lib/labs-vagrant.rb +++ b/lib/labs-vagrant.rb @@ -19,10 +19,10 @@ end col, *cols = roles.each_slice((roles.size/3.0).ceil).to_a col.zip(*cols) do |a,b,c| - puts sprintf("%-26s %-26s %-26s", a, b, c) + puts sprintf('%-26s %-26s %-26s', a, b, c) end puts "\nRoles marked with '*' are enabled." - puts "Note that roles enabled by dependency are not marked." + puts 'Note that roles enabled by dependency are not marked.' puts 'Use "labs-vagrant enable-role" & "labs-vagrant disable-role" to customize.' when 'reset-roles' diff --git a/lib/mediawiki-vagrant/config.rb b/lib/mediawiki-vagrant/config.rb index c41f24f..dcab194 100644 --- a/lib/mediawiki-vagrant/config.rb +++ b/lib/mediawiki-vagrant/config.rb @@ -1,7 +1,7 @@ -require "mediawiki-vagrant/plugin_environment" -require "mediawiki-vagrant/settings/definitions" -require "mediawiki-vagrant/settings_plugin" -require "optparse" +require 'mediawiki-vagrant/plugin_environment' +require 'mediawiki-vagrant/settings/definitions' +require 'mediawiki-vagrant/settings_plugin' +require 'optparse' module MediaWikiVagrant # Provides a command-line interface for configuration of MediaWiki-Vagrant @@ -12,7 +12,7 @@ include SettingsPlugin def self.synopsis - "configures mediawiki-vagrant settings" + 'configures mediawiki-vagrant settings' end def execute @@ -25,29 +25,29 @@ } opts = OptionParser.new do |o| - o.banner = "Usage: vagrant config [options] [name] [value]" - o.separator "" - o.separator "Options:" - o.separator "" + o.banner = 'Usage: vagrant config [options] [name] [value]' + o.separator '' + o.separator 'Options:' + o.separator '' - o.on("--all", "Configure all settings") do + o.on('--all', 'Configure all settings') do options[:interactive] = true end - o.on("--required", "Configure only required settings") do + o.on('--required', 'Configure only required settings') do options[:interactive] = true options[:required] = true end - o.on("--list", "List all settings") do + o.on('--list', 'List all settings') do options[:list] = true end - o.on("--get NAME", "Get a configured setting") do |name| + o.on('--get NAME', 'Get a configured setting') do |name| options[:get] << name end - o.on("--unset NAME", "Remove a configured setting") do |name| + o.on('--unset NAME', 'Remove a configured setting') do |name| options[:unset] << name end end @@ -128,11 +128,11 @@ @env.ui.info name, bold: true, new_line: false - prompt = value.empty? ? "" : " [#{value}]" - prompt += ": " + prompt = value.empty? ? '' : " [#{value}]" + prompt += ': ' input = @env.ui.ask(prompt).strip - @env.ui.info "" + @env.ui.info '' if !input.empty? setting.value = parse_setting(setting, input) @@ -151,9 +151,9 @@ @env.ui.info "#{name}\t#{setting.description}", bold: true @env.ui.info indent(setting.help, 2) unless setting.help.nil? value_info = "Current value: #{setting.value}" - value_info += " (default)" unless setting.set? + value_info += ' (default)' unless setting.set? @env.ui.info indent(value_info, 2) - @env.ui.info "" + @env.ui.info '' end end end diff --git a/lib/mediawiki-vagrant/environment.rb b/lib/mediawiki-vagrant/environment.rb index 74d1a8e..d9ec046 100644 --- a/lib/mediawiki-vagrant/environment.rb +++ b/lib/mediawiki-vagrant/environment.rb @@ -176,8 +176,8 @@ role_file = module_path("role/manifests/#{role}.pp") return nil unless role_file.exist? - role_file.each_line.take_while { |line| line =~ /^#( |$)/ }.inject("") do |doc, line| - doc << line.sub(/^# ?/, "") + role_file.each_line.take_while { |line| line =~ /^#( |$)/ }.inject('') do |doc, line| + doc << line.sub(/^# ?/, '') end end diff --git a/lib/mediawiki-vagrant/forward_port.rb b/lib/mediawiki-vagrant/forward_port.rb index 92ce219..24efc7c 100644 --- a/lib/mediawiki-vagrant/forward_port.rb +++ b/lib/mediawiki-vagrant/forward_port.rb @@ -1,7 +1,7 @@ -require "mediawiki-vagrant/plugin_environment" -require "mediawiki-vagrant/settings/definitions" -require "mediawiki-vagrant/settings_plugin" -require "optparse" +require 'mediawiki-vagrant/plugin_environment' +require 'mediawiki-vagrant/settings/definitions' +require 'mediawiki-vagrant/settings_plugin' +require 'optparse' module MediaWikiVagrant # Configures port forwarding from the host to the guest VM. @@ -11,7 +11,7 @@ include SettingsPlugin def self.synopsis - "configures port forwarding from the host to the guest VM" + 'configures port forwarding from the host to the guest VM' end def execute @@ -21,16 +21,16 @@ } opts = OptionParser.new do |o| - o.banner = "Usage: vagrant forward-port [options] [host-port guest-port [...]]" - o.separator "" - o.separator "Options:" - o.separator "" + o.banner = 'Usage: vagrant forward-port [options] [host-port guest-port [...]]' + o.separator '' + o.separator 'Options:' + o.separator '' - o.on("-l", "--list", "List currently forwarded ports") do + o.on('-l', '--list', 'List currently forwarded ports') do options[:list] = true end - o.on("-r", "--remove PORT", "Remove forwarding for the given host port") do |port| + o.on('-r', '--remove PORT', 'Remove forwarding for the given host port') do |port| options[:remove] << port end end @@ -67,7 +67,7 @@ def list @env.ui.info "Local port => VM's port" - @env.ui.info "-----------------------" + @env.ui.info '-----------------------' configure do |settings| settings[:forward_ports].each do |guest_port, host_port| @env.ui.info "#{host_port} => #{guest_port}" diff --git a/lib/mediawiki-vagrant/git-update.rb b/lib/mediawiki-vagrant/git-update.rb index 263bf20..bfd1d89 100644 --- a/lib/mediawiki-vagrant/git-update.rb +++ b/lib/mediawiki-vagrant/git-update.rb @@ -1,7 +1,7 @@ module MediaWikiVagrant class GitUpdates < Vagrant.plugin(2, :command) def self.synopsis - "fetches new code from Gerrit" + 'fetches new code from Gerrit' end def execute diff --git a/lib/mediawiki-vagrant/hiera.rb b/lib/mediawiki-vagrant/hiera.rb index 271b0cd..f61f4aa 100644 --- a/lib/mediawiki-vagrant/hiera.rb +++ b/lib/mediawiki-vagrant/hiera.rb @@ -1,5 +1,5 @@ -require "mediawiki-vagrant/plugin_environment" -require "optparse" +require 'mediawiki-vagrant/plugin_environment' +require 'optparse' module MediaWikiVagrant # Provides a command-line interface for configuration of hiera settings. @@ -8,7 +8,7 @@ include PluginEnvironment def self.synopsis - "configures hiera settings" + 'configures hiera settings' end def execute @@ -17,12 +17,12 @@ } opts = OptionParser.new do |o| - o.banner = "Usage: vagrant hiera [options] [key] [value]" - o.separator "" - o.separator "Options:" - o.separator "" + o.banner = 'Usage: vagrant hiera [options] [key] [value]' + o.separator '' + o.separator 'Options:' + o.separator '' - o.on("--unset NAME", "Remove a configured key") do |name| + o.on('--unset NAME', 'Remove a configured key') do |name| options[:unset] << name end end diff --git a/lib/mediawiki-vagrant/import-dump.rb b/lib/mediawiki-vagrant/import-dump.rb index 22036f6..a1a4561 100644 --- a/lib/mediawiki-vagrant/import-dump.rb +++ b/lib/mediawiki-vagrant/import-dump.rb @@ -1,12 +1,12 @@ module MediaWikiVagrant class ImportDump < Vagrant.plugin(2, :command) def self.synopsis - "imports an XML file into MediaWiki" + 'imports an XML file into MediaWiki' end def execute if ['-h', '--help'].include? @argv.first - @env.ui.info "Usage: vagrant import-dump dumpfile.xml [-h]" + @env.ui.info 'Usage: vagrant import-dump dumpfile.xml [-h]' return 0 end opts = { extra_args: @argv.unshift('import-mediawiki-dump') } diff --git a/lib/mediawiki-vagrant/paste-puppet.rb b/lib/mediawiki-vagrant/paste-puppet.rb index cee1b74..b0125bf 100644 --- a/lib/mediawiki-vagrant/paste-puppet.rb +++ b/lib/mediawiki-vagrant/paste-puppet.rb @@ -10,7 +10,7 @@ URL = URI.parse('https://dpaste.de/api/') def self.synopsis - "uploads your puppet logs to dpaste.de pastebin" + 'uploads your puppet logs to dpaste.de pastebin' end def execute diff --git a/lib/mediawiki-vagrant/roles/enable.rb b/lib/mediawiki-vagrant/roles/enable.rb index f264c45..2f9be82 100644 --- a/lib/mediawiki-vagrant/roles/enable.rb +++ b/lib/mediawiki-vagrant/roles/enable.rb @@ -6,7 +6,7 @@ module Roles class Enable < Change def self.synopsis - "enables a mediawiki-vagrant role" + 'enables a mediawiki-vagrant role' end private diff --git a/lib/mediawiki-vagrant/roles/list.rb b/lib/mediawiki-vagrant/roles/list.rb index 4e34b93..24027b5 100644 --- a/lib/mediawiki-vagrant/roles/list.rb +++ b/lib/mediawiki-vagrant/roles/list.rb @@ -90,7 +90,7 @@ if roles.any? col, *cols = roles.each_slice((roles.size/3.0).ceil).to_a col.zip(*cols) do |a,b,c| - @env.ui.info sprintf("%-26s %-26s %-26s", a, b, c) + @env.ui.info sprintf('%-26s %-26s %-26s', a, b, c) end end end diff --git a/lib/mediawiki-vagrant/run-tests.rb b/lib/mediawiki-vagrant/run-tests.rb index e152929..36a472f 100644 --- a/lib/mediawiki-vagrant/run-tests.rb +++ b/lib/mediawiki-vagrant/run-tests.rb @@ -6,7 +6,7 @@ def execute if ['-h', '--help'].include? @argv.first - @env.ui.info "Usage: vagrant run-tests [tests] [-h]" + @env.ui.info 'Usage: vagrant run-tests [tests] [-h]' return 0 end opts = { extra_args: @argv.unshift('run-mediawiki-tests') } diff --git a/lib/mediawiki-vagrant/settings/definitions.rb b/lib/mediawiki-vagrant/settings/definitions.rb index 7678c99..ea95497 100644 --- a/lib/mediawiki-vagrant/settings/definitions.rb +++ b/lib/mediawiki-vagrant/settings/definitions.rb @@ -3,12 +3,12 @@ module MediaWikiVagrant Settings.define do setting :git_user, - description: "Your git/Gerrit username", + description: 'Your git/Gerrit username', help: "Enter 'anonymous' for anonymous access, leave blank to manage it yourself", allows_empty: true setting :vagrant_ram, - description: "Amount of RAM (in MB) allocated to the guest VM", + description: 'Amount of RAM (in MB) allocated to the guest VM', help: "Specify 'auto' to automatically allocate 1/4 of your system's memory", default: 1536, auto: -> { Environment.total_memory / 4 }, @@ -16,15 +16,15 @@ combiner: ->(setting, new) { setting.value + new.to_i } setting :vagrant_cores, - description: "CPU cores allocated to the guest VM", + description: 'CPU cores allocated to the guest VM', help: "All of your host system's cores are allocated by default.", default: :auto, auto: -> { Environment.total_cpus }, coercion: ->(_setting, new) { new && new.to_i } setting :static_ip, - description: "IP address assigned to the guest VM", - default: "10.11.12.13" + description: 'IP address assigned to the guest VM', + default: '10.11.12.13' setting :http_port, description: "Host port forwarded to the guest VM's HTTP server (port 80)", @@ -32,24 +32,24 @@ coercion: ->(_setting, new) { new && new.to_i } setting :host_ip, - description: "Host ip address to bind forwards to", + description: 'Host ip address to bind forwards to', help: "Set to '0.0.0.0' to bind to all ips and allow external access", - default: "127.0.0.1" + default: '127.0.0.1' setting :nfs_shares, - description: "Use synced folders backed by NFS", + description: 'Use synced folders backed by NFS', help: "Enter 'yes' or 'no'. NFS is faster, but unsupported on Windows and with some encrypted filesystems on Linux", default: defined?(Vagrant::Util::Platform) ? !Vagrant::Util::Platform.windows? : true, coercion: ->(_setting, new) { !!(new.to_s =~ /^(true|t|yes|y|1)$/i) } setting :nfs_cache, - description: "Use cachefilesd to speed up NFS file access (EXPERIMENTAL)", + description: 'Use cachefilesd to speed up NFS file access (EXPERIMENTAL)', help: "Enter 'yes' or 'no'. If your VM is currently running, reload it after changing this setting.", default: false, coercion: ->(_setting, new) { !!(new.to_s =~ /^(true|t|yes|y|1)$/i) } setting :forward_agent, - description: "Enable agent forwarding over SSH connections by default", + description: 'Enable agent forwarding over SSH connections by default', help: "Enter 'yes' or 'no'. Agent forwarding requires an SSH agent running on the host computer.", default: false, coercion: ->(_setting, new) { !!(new.to_s =~ /^(true|t|yes|y|1)$/i) } @@ -60,7 +60,7 @@ coercion: ->(setting, new) { setting.value.merge(Hash[new.map { |kv| kv.map(&:to_i) }]) } setting :forward_x11, - description: "Enable X11 forwarding over SSH connections by default", + description: 'Enable X11 forwarding over SSH connections by default', help: "Enter 'yes' or 'no'. X11 forwarding enables GUI applications to be run on the guest.", default: true, coercion: ->(_setting, new) { !!(new.to_s =~ /^(true|t|yes|y|1)$/i) } diff --git a/lib/mediawiki-vagrant/setup.rb b/lib/mediawiki-vagrant/setup.rb index 3116f35..271c9fd 100644 --- a/lib/mediawiki-vagrant/setup.rb +++ b/lib/mediawiki-vagrant/setup.rb @@ -1,5 +1,5 @@ -require "optparse" -require "rubygems" +require 'optparse' +require 'rubygems' module MediaWikiVagrant # Assists with the setup of MediaWiki-Vagrant. @@ -9,7 +9,7 @@ # mediawiki-vagrant plugin. # class Setup - PLUGINS = ["vagrant-vbguest"] + PLUGINS = ['vagrant-vbguest'] class ExecutionError < RuntimeError attr_reader :command, :status @@ -30,16 +30,16 @@ # def initialize(invocation) @silent = false - @directory = File.expand_path("..", invocation) + @directory = File.expand_path('..', invocation) @options = OptionParser.new do |parser| parser.banner = "Usage: #{invocation}" - parser.on("-s", "--silent", "Run silently with no prompts or output") do + parser.on('-s', '--silent', 'Run silently with no prompts or output') do @silent = true end - parser.on_tail("-h", "--help", "Show this help message.") do + parser.on_tail('-h', '--help', 'Show this help message.') do puts parser exit end @@ -63,7 +63,7 @@ begin install_plugin(gem_path) ensure - Dir["mediawiki-vagrant-*.gem"].each { |gem| File.unlink(gem) } + Dir['mediawiki-vagrant-*.gem'].each { |gem| File.unlink(gem) } end # Configure required settings @@ -78,7 +78,7 @@ # Builds mediawiki-vagrant from the bundled gemspec. # def build_gem - spec = Gem::Specification.load(File.join(@directory, "mediawiki-vagrant.gemspec")) + spec = Gem::Specification.load(File.join(@directory, 'mediawiki-vagrant.gemspec')) # Support older versions of RubyGems as best we can if defined?(Gem::Builder) @@ -95,7 +95,7 @@ pwd = Dir.pwd verbose = Gem.configuration.verbose - Dir.chdir(File.expand_path("..", spec.loaded_from)) + Dir.chdir(File.expand_path('..', spec.loaded_from)) Gem.configuration.verbose = false Gem::Builder.new(spec).build @@ -108,7 +108,7 @@ # (>= 2.0). # def build_gem_using_package(spec) - require "rubygems/package" + require 'rubygems/package' package = Gem::Package.new(spec.file_name) package.spec = spec @@ -120,20 +120,20 @@ # Prompts the user to configure required settings. # def configure_settings - vagrant("config", "--required") { |pipe| pipe.each_char { |c| print c } } + vagrant('config', '--required') { |pipe| pipe.each_char { |c| print c } } end # Installs the given Vagrant plugin. # def install_plugin(name) notify "Installing plugin #{name}" - vagrant("plugin", "install", name) + vagrant('plugin', 'install', name) end # Currently installed Vagrant plugins. # def installed_plugins - @installed_plugins ||= vagrant("plugin", "list") do |pipe| + @installed_plugins ||= vagrant('plugin', 'list') do |pipe| pipe.each_line.with_object([]) do |line, plugins| line.match(/^([\w\-]+) \([\w\.]+\)/) { |m| plugins << m[1] } end @@ -145,7 +145,7 @@ # def notify(message_or_io, level = 0) unless @silent - prefix = ("-" * level) + (level > 0 ? " " : "") + prefix = ('-' * level) + (level > 0 ? ' ' : '') message_or_io.each_line { |line| puts "#{prefix}#{line}" } end end @@ -159,11 +159,11 @@ # Executes the vagrant commands with the given arguments. # def vagrant(*args, &blk) - command = ["vagrant"] + args + command = ['vagrant'] + args blk ||= proc { |pipe| notify pipe, 1 } result = IO.popen(command, err: [:child, :out], &blk) - raise ExecutionError.new(command.join(" "), $?) unless $?.success? + raise ExecutionError.new(command.join(' '), $?) unless $?.success? result end -- To view, visit https://gerrit.wikimedia.org/r/240664 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I512044e683c671373c935708dbd65788465a19da Gerrit-PatchSet: 3 Gerrit-Project: mediawiki/vagrant Gerrit-Branch: master Gerrit-Owner: Zfilipin <zfili...@wikimedia.org> Gerrit-Reviewer: BryanDavis <bda...@wikimedia.org> Gerrit-Reviewer: Dduvall <dduv...@wikimedia.org> Gerrit-Reviewer: Hashar <has...@free.fr> Gerrit-Reviewer: Mattflaschen <mflasc...@wikimedia.org> Gerrit-Reviewer: Ori.livneh <o...@wikimedia.org> Gerrit-Reviewer: Yuvipanda <yuvipa...@wikimedia.org> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits