Upgrade RuboCop 0.35.1 -> 0.36.0 for Travis builds

sds · sds · commit 9893350643d0 · 2016-01-19T17:16:57.000-08:00
This required a number of fixes to address new cops introduced in
version 0.36.0.
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -54,6 +54,9 @@ Style/FormatString:
 Style/GuardClause:
   Enabled: false
 
+Style/IndentArray:
+  Enabled: false
+
 Style/IfUnlessModifier:
   Enabled: false
 
@@ -63,6 +66,9 @@ Style/IfUnlessModifier:
 Style/Lambda:
   Enabled: false
 
+Style/MultilineMethodCallIndentation:
+  Enabled: false
+
 Style/MultilineOperationIndentation:
   Enabled: false
 
@@ -98,12 +104,15 @@ Style/SignalException:
 Style/SingleLineBlockParams:
   Enabled: false
 
-Style/SingleSpaceBeforeFirstArg:
+Style/SpaceBeforeFirstArg:
   Exclude:
     - '*.gemspec'
 
 Style/SpecialGlobalVars:
   Enabled: false
 
-Style/TrailingComma:
+Style/TrailingCommaInArguments:
+  Enabled: false
+
+Style/TrailingCommaInLiteral:
   Enabled: false
diff --git a/Gemfile b/Gemfile
@@ -4,6 +4,6 @@ source 'https://rubygems.org'
 gem 'coveralls'
 
 # Pin RuboCop for Travis builds.
-gem 'rubocop', '0.35.1'
+gem 'rubocop', '0.36.0'
 
 gemspec
diff --git a/lib/overcommit/configuration.rb b/lib/overcommit/configuration.rb
@@ -19,7 +19,6 @@ def initialize(hash, options = {})
     def ==(other)
       super || @hash == other.hash
     end
-    alias_method :eql?, :==
 
     # Access the configuration as if it were a hash.
     #
diff --git a/lib/overcommit/constants.rb b/lib/overcommit/constants.rb
@@ -1,10 +1,10 @@
 # Global application constants.
 module Overcommit
-  HOME = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
-  CONFIG_FILE_NAME = '.overcommit.yml'
+  HOME = File.expand_path(File.join(File.dirname(__FILE__), '..', '..')).freeze
+  CONFIG_FILE_NAME = '.overcommit.yml'.freeze
 
-  HOOK_DIRECTORY = File.join(HOME, 'lib', 'overcommit', 'hook')
+  HOOK_DIRECTORY = File.join(HOME, 'lib', 'overcommit', 'hook').freeze
 
-  REPO_URL = 'https://github.com/brigade/overcommit'
-  BUG_REPORT_URL = "#{REPO_URL}/issues"
+  REPO_URL = 'https://github.com/brigade/overcommit'.freeze
+  BUG_REPORT_URL = "#{REPO_URL}/issues".freeze
 end
diff --git a/lib/overcommit/hook/base.rb b/lib/overcommit/hook/base.rb
@@ -11,7 +11,7 @@ def to_s
   end
 
   # Possible types of messages.
-  MESSAGE_TYPES = [:error, :warning]
+  MESSAGE_TYPES = [:error, :warning].freeze
 
   # Functionality common to all hooks.
   class Base # rubocop:disable Metrics/ClassLength
diff --git a/lib/overcommit/hook/commit_msg/capitalized_subject.rb b/lib/overcommit/hook/commit_msg/capitalized_subject.rb
@@ -5,7 +5,7 @@ def run
       return :pass if empty_message?
 
       first_letter = commit_message_lines[0].to_s.match(/^[[:punct:]]*(.)/)[1]
-      unless first_letter.match(/[[:upper:]]/)
+      unless first_letter =~ /[[:upper:]]/
         return :warn, 'Subject should start with a capital letter'
       end
 
diff --git a/lib/overcommit/hook/pre_commit/berksfile_check.rb b/lib/overcommit/hook/pre_commit/berksfile_check.rb
@@ -4,7 +4,7 @@ module Overcommit::Hook::PreCommit
   #
   # @see http://berkshelf.com/
   class BerksfileCheck < Base
-    LOCK_FILE = 'Berksfile.lock'
+    LOCK_FILE = 'Berksfile.lock'.freeze
 
     def run
       # Ignore if Berksfile.lock is not tracked by git
diff --git a/lib/overcommit/hook/pre_commit/bundle_check.rb b/lib/overcommit/hook/pre_commit/bundle_check.rb
@@ -4,7 +4,7 @@ module Overcommit::Hook::PreCommit
   #
   # @see http://bundler.io/
   class BundleCheck < Base
-    LOCK_FILE = 'Gemfile.lock'
+    LOCK_FILE = 'Gemfile.lock'.freeze
 
     def run
       # Ignore if Gemfile.lock is not tracked by git
diff --git a/lib/overcommit/hook_signer.rb b/lib/overcommit/hook_signer.rb
@@ -5,7 +5,7 @@ class HookSigner
 
     # We don't want to include the skip setting as it is set by Overcommit
     # itself
-    IGNORED_CONFIG_KEYS = %w[skip]
+    IGNORED_CONFIG_KEYS = %w[skip].freeze
 
     # @param hook_name [String] name of the hook
     # @param config [Overcommit::Configuration]
diff --git a/lib/overcommit/message_processor.rb b/lib/overcommit/message_processor.rb
@@ -6,10 +6,10 @@ module Overcommit
   # output tuple from an array of {Overcommit::Hook::Message}s, respecting the
   # configuration settings for the given hook.
   class MessageProcessor
-    ERRORS_MODIFIED_HEADER = 'Errors on modified lines:'
-    WARNINGS_MODIFIED_HEADER = 'Warnings on modified lines:'
-    ERRORS_UNMODIFIED_HEADER = "Errors on lines you didn't modify:"
-    WARNINGS_UNMODIFIED_HEADER = "Warnings on lines you didn't modify:"
+    ERRORS_MODIFIED_HEADER = 'Errors on modified lines:'.freeze
+    WARNINGS_MODIFIED_HEADER = 'Warnings on modified lines:'.freeze
+    ERRORS_UNMODIFIED_HEADER = "Errors on lines you didn't modify:".freeze
+    WARNINGS_UNMODIFIED_HEADER = "Warnings on lines you didn't modify:".freeze
 
     # @param hook [Overcommit::Hook::Base]
     # @param unmodified_lines_setting [String] how to treat messages on
diff --git a/lib/overcommit/os.rb b/lib/overcommit/os.rb
@@ -27,10 +27,10 @@ def linux?
       private
 
       def host_os
-        @os ||= ::RbConfig::CONFIG['host_os']
+        @os ||= ::RbConfig::CONFIG['host_os'].freeze
       end
     end
 
-    SEPARATOR = self.windows? ? '\\' : File::SEPARATOR
+    SEPARATOR = (windows? ? '\\' : File::SEPARATOR).freeze
   end
 end
diff --git a/lib/overcommit/version.rb b/lib/overcommit/version.rb
@@ -1,4 +1,4 @@
 # Defines the gem version.
 module Overcommit
-  VERSION = '0.30.0'
+  VERSION = '0.30.0'.freeze
 end
diff --git a/spec/overcommit/command_splitter_spec.rb b/spec/overcommit/command_splitter_spec.rb
@@ -75,7 +75,7 @@
     end
 
     context 'with splittable arguments well over the limit' do
-      let(:splittable_args) { 15.times.map { |i| (i + 1).to_s } }
+      let(:splittable_args) { Array.new(15) { |i| (i + 1).to_s } }
 
       it 'executes multiple commands with the appropriately split arguments' do
         Overcommit::Subprocess.should_receive(:spawn).with(%w[cmd 1 2 3 4 5 6 7],
diff --git a/spec/overcommit/hook/pre_commit/scalastyle_spec.rb b/spec/overcommit/hook/pre_commit/scalastyle_spec.rb
@@ -88,7 +88,6 @@
 
     context 'with a runtime error' do
       before do
-        # rubocop:disable Metrics/LineLength
         result.stub(stdout: '', stderr: normalize_indent(<<-ERR))
           Exception in thread "main" java.io.FileNotFoundException: scalastyle-config.xml (No such file or directory)
                   at java.io.FileInputStream.open0(Native Method)
@@ -103,7 +102,6 @@
                   at org.scalastyle.Main$.main(Main.scala:95)
                   at org.scalastyle.Main.main(Main.scala)
         ERR
-        # rubocop:enable Metrics/LineLength
       end
 
       it { should fail_hook }
diff --git a/spec/overcommit/hook/pre_push/r_spec_spec.rb b/spec/overcommit/hook/pre_push/r_spec_spec.rb
@@ -26,7 +26,6 @@
 
     context 'with a runtime error' do
       before do
-        # rubocop:disable Metrics/LineLength
         result.stub(stdout: '', stderr: <<-EOS)
           /home/user/.rbenv/gems/2.2.0/gems/rspec-core-3.2.2/lib/rspec/core/configuration.rb:1226:in `load': /home/user/dev/github/overcommit/spec/overcommit/hook/pre_push/rspec_spec.rb:49: can't find string "EOS" anywhere before EOF (SyntaxError)
           /home/user/dev/overcommit/spec/overcommit/hook/pre_push/rspec_spec.rb:29: syntax error, unexpected end-of-input
@@ -41,15 +40,13 @@
             from /home/user/.rbenv/versions/2.2.1/bin/rspec:23:in `load'
             from /home/user/.rbenv/versions/2.2.1/bin/rspec:23:in `<main>'
         EOS
-        # rubocop:enable Metrics/LineLength
       end
 
       it { should fail_hook }
     end
 
     context 'with a test failure' do
       before do
-        # rubocop:disable Metrics/LineLength
         result.stub(stderr: '', stdout: <<-EOS)
           .FF
 
@@ -73,7 +70,6 @@
           rspec ./spec/overcommit/hook/pre_push/rspec_spec.rb:45 # Overcommit::Hook::PrePush::RSpec when rspec exits unsuccessfully with a runtime error should fail
           rspec ./spec/overcommit/hook/pre_push/rspec_spec.rb:57 # Overcommit::Hook::PrePush::RSpec when rspec exits unsuccessfully with a test failure should fail
         EOS
-        # rubocop:enable Metrics/LineLength
       end
 
       it { should fail_hook }
diff --git a/spec/overcommit/utils_spec.rb b/spec/overcommit/utils_spec.rb
@@ -192,9 +192,10 @@
       subject { described_class.execute(arguments, args: splittable_args) }
 
       it 'invokes CommandSplitter.execute' do
-        Overcommit::CommandSplitter.should_receive(:execute).
-                                    with(arguments, args: splittable_args).
-                                    and_return(double(status: 0, stdout: '', stderr: ''))
+        Overcommit::CommandSplitter.
+          should_receive(:execute).
+          with(arguments, args: splittable_args).
+          and_return(double(status: 0, stdout: '', stderr: ''))
         subject
       end
 
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -11,7 +11,8 @@
 require 'overcommit'
 require 'tempfile'
 
-hook_types = Dir[File.join(Overcommit::HOOK_DIRECTORY, '*')].
+hook_types =
+  Dir[File.join(Overcommit::HOOK_DIRECTORY, '*')].
   select { |f| File.directory?(f) }.
   reject { |f| File.basename(f) == 'shared' }.
   sort
diff --git a/spec/support/git_spec_helpers.rb b/spec/support/git_spec_helpers.rb
@@ -4,7 +4,12 @@
 module GitSpecHelpers
   module_function
 
-  def repo(options = {}, &block)
+  # Creates an empty git repository, allowing you to execute a block where
+  # the current working directory is set to that repository's root directory.
+  #
+  # @param options [Hash]
+  # @return [String] path of the repository
+  def repo(options = {})
     directory('some-repo') do
       `git init --template="#{options[:template_dir]}"`
 
@@ -13,26 +18,30 @@ def repo(options = {}, &block)
       `git config --local user.email "overcommit@example.com"`
       `git config --local rerere.enabled 0` # Don't record resolutions in tests
 
-      block.call if block_given?
+      yield if block_given?
     end
   end
 
   # Creates a directory (with an optional specific name) in a temporary
   # directory which will automatically be destroyed.
+  #
+  # @param name [String] base name of the directory
+  # @return [String] path of the directory that was created
   def directory(name = 'some-dir', &block)
     tmpdir = Dir.mktmpdir.tap do |path|
       Dir.chdir(path) do
         Dir.mkdir(name)
-        Dir.chdir(name) do
-          block.call if block_given?
-        end
+        Dir.chdir(name, &block) if block_given?
       end
     end
 
     File.join(tmpdir, name)
   end
 
+  # Returns a random git object hash.
+  #
+  # @return [String]
   def random_hash
-    40.times.map { (65 + rand(26)).chr }.join
+    Array.new(40) { (65 + rand(26)).chr }.join
   end
 end
diff --git a/spec/support/shell_helpers.rb b/spec/support/shell_helpers.rb
@@ -20,10 +20,10 @@ def touch(file)
   #
   # @param options [Hash]
   # @raise [Timeout::TimeoutError] timeout has elapsed before condition holds
-  def wait_until(options = {}, &block)
+  def wait_until(options = {})
     Timeout.timeout(options.fetch(:timeout, 1)) do
       loop do
-        return if block.call
+        return if yield
         sleep options.fetch(:check_interval, 0.1)
       end
     end

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,6 @@ def initialize(hash, options = {})`
`19`	`19`	`def ==(other)`
`20`	`20`	`super \|\| @hash == other.hash`
`21`	`21`	`end`
`22`		`- alias_method :eql?, :==`
`23`	`22`
`24`	`23`	`# Access the configuration as if it were a hash.`
`25`	`24`	`#`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ module Overcommit::Hook::PreCommit`
`4`	`4`	`#`
`5`	`5`	`# @see http://berkshelf.com/`
`6`	`6`	`class BerksfileCheck < Base`
`7`		`- LOCK_FILE = 'Berksfile.lock'`
	`7`	`+ LOCK_FILE = 'Berksfile.lock'.freeze`
`8`	`8`
`9`	`9`	`def run`
`10`	`10`	`# Ignore if Berksfile.lock is not tracked by git`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ module Overcommit::Hook::PreCommit`
`4`	`4`	`#`
`5`	`5`	`# @see http://bundler.io/`
`6`	`6`	`class BundleCheck < Base`
`7`		`- LOCK_FILE = 'Gemfile.lock'`
	`7`	`+ LOCK_FILE = 'Gemfile.lock'.freeze`
`8`	`8`
`9`	`9`	`def run`
`10`	`10`	`# Ignore if Gemfile.lock is not tracked by git`