rubocop 0.33.0 → 0.34.0

data/lib/rubocop/runner.rb

@@ -3,7 +3,7 @@
 module RuboCop
   # This class handles the processing of files, which includes dealing with
   # formatters and letting cops inspect the files.
-  class Runner
+  class Runner # rubocop:disable Metrics/ClassLength
     # An exception indicating that the inspection loop got stuck correcting
     # offenses back and forth.
     class InfiniteCorrectionLoop < Exception
@@ -27,7 +27,11 @@ module RuboCop
 
     def run(paths)
       target_files = find_target_files(paths)
-      inspect_files(target_files)
+      if @options[:list_target_files]
+        list_files(target_files)
+      else
+        inspect_files(target_files)
+      end
     end
 
     def abort
@@ -58,26 +62,36 @@ module RuboCop
 
       all_passed
     ensure
+      ResultCache.cleanup(@config_store, @options[:debug]) if cached_run?
       formatter_set.finished(inspected_files.freeze)
       formatter_set.close_output_files
     end
 
+    def list_files(paths)
+      paths.each do |path|
+        puts PathUtil.relative_path(path)
+      end
+    end
+
     def process_file(file)
       puts "Scanning #{file}" if @options[:debug]
 
-      processed_source = ProcessedSource.from_file(file)
-      file_info = {
-        cop_disabled_line_ranges: processed_source.disabled_line_ranges,
-        comments: processed_source.comments,
-        cli_options: @options,
-        config_store: @config_store
-      }
-
-      formatter_set.file_started(file, file_info)
-
-      offenses = do_inspection_loop(file, processed_source)
+      cache = ResultCache.new(file, @options, @config_store) if cached_run?
+      if cache && cache.valid?
+        offenses, disabled_line_ranges, comments = cache.load
+        file_started(file, disabled_line_ranges, comments)
+      else
+        processed_source = get_processed_source(file)
+        file_started(file, processed_source.disabled_line_ranges,
+                     processed_source.comments)
+        offenses = do_inspection_loop(file, processed_source)
+        if cache
+          cache.save(offenses, processed_source.disabled_line_ranges,
+                     processed_source.comments)
+        end
+      end
 
-      formatter_set.file_finished(file, offenses.compact.sort.freeze)
+      offenses = formatter_set.file_finished(file, offenses.compact.sort.freeze)
 
       offenses
     rescue InfiniteCorrectionLoop => e
@@ -85,6 +99,27 @@ module RuboCop
       raise
     end
 
+    def file_started(file, disabled_line_ranges, comments)
+      formatter_set.file_started(file,
+                                 cop_disabled_line_ranges: disabled_line_ranges,
+                                 comments: comments,
+                                 cli_options: @options,
+                                 config_store: @config_store)
+    end
+
+    def cached_run?
+      @cached_run ||=
+        (@options[:cache] == 'true' ||
+         @options[:cache] != 'false' &&
+         @config_store.for(Dir.pwd)['AllCops']['UseCache']) &&
+        # When running --auto-gen-config, there's some processing done in the
+        # cops related to calculating the Max parameters for Metrics cops. We
+        # need to do that processing and can not use caching.
+        !@options[:auto_gen_config] &&
+        # Auto-correction needs a full run. It can not use cached results.
+        !@options[:auto_correct]
+    end
+
     def do_inspection_loop(file, processed_source)
       offenses = []
 
@@ -111,7 +146,7 @@ module RuboCop
         # loop if we find any.
         break unless updated_source_file
 
-        processed_source = ProcessedSource.from_file(file)
+        processed_source = get_processed_source(file)
       end
 
       offenses
@@ -209,5 +244,10 @@ module RuboCop
         RuboCop::Cop::Severity.new(name)
       end
     end
+
+    def get_processed_source(file)
+      return ProcessedSource.new(@options[:stdin], file) if @options[:stdin]
+      ProcessedSource.from_file(file)
+    end
   end
 end

data/lib/rubocop/target_finder.rb

@@ -118,7 +118,7 @@ module RuboCop
 
     def ruby_executable?(file)
       return false unless File.extname(file).empty?
-      first_line = File.open(file) { |f| f.readline }
+      first_line = File.open(file, &:readline)
       first_line =~ /#!.*ruby/
     rescue EOFError, ArgumentError => e
       warn "Unprocessable file #{file}: #{e.class}, #{e.message}" if debug?

data/lib/rubocop/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '0.33.0'
+    STRING = '0.34.0'
 
     MSG = '%s (using Parser %s, running on %s %s %s)'
 

data/relnotes/v0.34.0.md

@@ -0,0 +1,182 @@
+Apart from the usual myriad of bugfixes, improvements and new cops,
+this version introduces a results caching functionality. This
+functionality will speed up tremendously consecutive RuboCop runs on
+the same codebase.
+
+Another news to share with you - the project now has a crowdfunding
+campaign [here](https://salt.bountysource.com/). If you like RuboCop
+you might consider supporting its development.
+
+Enjoy!
+
+### New features
+
+* [#2143](https://github.com/bbatsov/rubocop/pull/2143): New cop `Performance/CaseWhenSplat` will identify and rearange `case` `when` statements that contain a `when` condition with a splat. ([@rrosenblum][])
+* New cop `Lint/DuplicatedKey` checks for duplicated keys in hashes, which Ruby 2.2 warns against. ([@sliuu][])
+* [#2106](https://github.com/bbatsov/rubocop/issues/2106): Add `SuspiciousParamNames` option to `Style/OptionHash`. ([@wli][])
+* [#2193](https://github.com/bbatsov/rubocop/pull/2193): `Style/Next` supports more `Enumerable` methods. ([@rrosenblum][])
+* [#2179](https://github.com/bbatsov/rubocop/issues/2179): Add `--list-target-files` option to CLI, which prints the files which will be inspected. ([@maxjacobson][])
+* New cop `Style/MutableConstant` checks for assignment of mutable objects to constants. ([@bbatsov][])
+* New cop `Style/RedudantFreeze` checks for usages of `Object#freeze` on immutable objects. ([@bbatsov][])
+* [#1924](https://github.com/bbatsov/rubocop/issues/1924): New option `--cache` and configuration parameter `AllCops: UseCache` turn result caching on (default) or off. ([@jonas054][])
+* [#2204](https://github.com/bbatsov/rubocop/pull/2204): New cop `Style/StringMethods` will check for preferred method `to_sym` over `intern`. ([@imtayadeway][])
+
+### Changes
+
+* [#1351](https://github.com/bbatsov/rubocop/issues/1351): Allow class emitter methods in `Style/MethodName`. ([@jonas054][])
+* [#2126](https://github.com/bbatsov/rubocop/pull/2126): `Style/RescueModifier` can now auto-correct. ([@rrosenblum][])
+* [#2109](https://github.com/bbatsov/rubocop/issues/2109): Allow alignment with a token on the nearest line with same indentation in `Style/ExtraSpacing`. ([@jonas054][])
+* `Lint/EndAlignment` handles the `case` keyword. ([@lumeet][])
+* [#2146](https://github.com/bbatsov/rubocop/pull/2146): Add STDIN support. ([@caseywebdev][])
+* [#2175](https://github.com/bbatsov/rubocop/pull/2175): Files that are excluded from a cop (e.g. using the `Exclude:` config option) are no longer being processed by that cop. ([@bquorning][])
+* `Rails/ActionFilter` now handles complete list of methods found in the Rails 4.2 [release notes](https://github.com/rails/rails/blob/4115a12da1409c753c747fd4bab6e612c0c6e51a/guides/source/4_2_release_notes.md#notable-changes-1). ([@MGerrior][])
+* [*2138](https://github.com/bbatsov/rubocop/issues/2138): Change the offense in `Style/Next` to highlight the condition instead of the iteration. ([@rrosenblum][])
+* `Style/EmptyLineBetweenDefs` now handles class methods as well. ([@unmanbearpig][])
+* Improve handling of `super` in `Style/SymbolProc`. ([@lumeet][])
+* `Style/SymbolProc` is applied to methods receiving arguments. ([@lumeet][])
+* [#1839](https://github.com/bbatsov/rubocop/issues/1839): Remove Rainbow monkey patching of String which conflicts with other gems like colorize. ([@daviddavis][])
+* `Style/HashSyntax` is now a bit faster when checking Ruby 1.9 syntax hash keys. ([@bquorning][])
+* `Lint/DeprecatedClassMethods` is now a whole lot faster. ([@bquorning][])
+* `Lint/BlockAlignment`, `Style/IndentationWidth`, and `Style/MultilineOperationIndentation` are now quite a bit faster. ([@bquorning][])
+
+### Bug Fixes
+
+* [#2123](https://github.com/bbatsov/rubocop/pull/2123): Fix handing of dynamic widths `Lint/FormatParameterMismatch`. ([@edmz][])
+* [#2116](https://github.com/bbatsov/rubocop/pull/2116): Fix named params (using hash) `Lint/FormatParameterMismatch`. ([@edmz][])
+* [#2135](https://github.com/bbatsov/rubocop/issues/2135): Ignore `super` and `zsuper` nodes in `Style/SymbolProc`. ([@bbatsov][])
+* [#2165](https://github.com/bbatsov/rubocop/issues/2165): Fix a NPE in `Style/Alias`. ([@bbatsov][])
+* [#2168](https://github.com/bbatsov/rubocop/issues/2168): Fix a NPE in `Rails/TimeZone`. ([@bbatsov][])
+* [#2169](https://github.com/bbatsov/rubocop/issues/2169): Fix a NPE in `Rails/Date`. ([@bbatsov][])
+* [#2105](https://github.com/bbatsov/rubocop/pull/2105): Fix a warning that was thrown when enabling `Style/OptionHash`. ([@wli][])
+* [#2107](https://github.com/bbatsov/rubocop/pull/2107): Fix auto-correct of `Style/ParallelAssignment` for nested expressions. ([@rrosenblum][])
+* [#2111](https://github.com/bbatsov/rubocop/issues/2111): Deal with byte order mark in `Style/InitialIndentation`. ([@jonas054][])
+* [#2113](https://github.com/bbatsov/rubocop/issues/2113): Handle non-string tokens in `Style/ExtraSpacing`. ([@jonas054][])
+* [#2129](https://github.com/bbatsov/rubocop/issues/2129): Handle empty interpolations in `Style/SpaceInsideStringInterpolation`. ([@lumeet][])
+* [#2119](https://github.com/bbatsov/rubocop/issues/2119): Do not raise an error in `Style/RescueEnsureAlignment` and `Style/RescueModifier` when processing an excluded file. ([@rrosenblum][])
+* [#2149](https://github.com/bbatsov/rubocop/issues/2149): Do not register an offense in `Rails/Date` when `Date#to_time` is called with a time zone argument. ([@maxjacobson][])
+* Do not register a `Rails/TimeZone` offense when using Time.new safely. ([@maxjacobson][])
+* [#2124](https://github.com/bbatsov/rubocop/issues/2124): Fix bug in `Style/EmptyLineBetweenDefs` when there are only comments between method definitions. ([@lumeet][])
+* [#2154](https://github.com/bbatsov/rubocop/issues/2154): `Performance/StringReplacement` can auto-correct replacements with backslash in them. ([@rrosenblum][])
+* [#2009](https://github.com/bbatsov/rubocop/issues/2009): Fix bug in `RuboCop::ConfigLoader.load_file` when `safe_yaml` is required. ([@eitoball][])
+* [#2155](https://github.com/bbatsov/rubocop/issues/2155): Configuration `EndAlignment: AlignWith: variable` only applies when the operands of `=` are on the same line. ([@jonas054][])
+* Fix bug in `Style/IndentationWidth` when `rescue` or `ensure` is preceded by an empty body. ([@lumeet][])
+* [#2183](https://github.com/bbatsov/rubocop/issues/2183): Fix bug in `Style/BlockDelimiters` when auto-correcting adjacent braces. ([@lumeet][])
+* [#2199](https://github.com/bbatsov/rubocop/issues/2199): Make `rubocop` exit with error when there are only `Lint/UnneededDisable` offenses. ([@jonas054][])
+* Fix handling of empty parentheses when auto-correcting in `Style/SymbolProc`. ([@lumeet][])
+
+[@bbatsov]: https://github.com/bbatsov
+[@jonas054]: https://github.com/jonas054
+[@yujinakayama]: https://github.com/yujinakayama
+[@dblock]: https://github.com/dblock
+[@nevir]: https://github.com/nevir
+[@daviddavis]: https://github.com/daviddavis
+[@sds]: https://github.com/sds
+[@fancyremarker]: https://github.com/fancyremarker
+[@sinisterchipmunk]: https://github.com/sinisterchipmunk
+[@vonTronje]: https://github.com/vonTronje
+[@agrimm]: https://github.com/agrimm
+[@pmenglund]: https://github.com/pmenglund
+[@chulkilee]: https://github.com/chulkilee
+[@codez]: https://github.com/codez
+[@emou]: https://github.com/emou
+[@skanev]: http://github.com/skanev
+[@claco]: http://github.com/claco
+[@rifraf]: http://github.com/rifraf
+[@scottmatthewman]: https://github.com/scottmatthewman
+[@ma2gedev]: http://github.com/ma2gedev
+[@jeremyolliver]: https://github.com/jeremyolliver
+[@hannestyden]: https://github.com/hannestyden
+[@geniou]: https://github.com/geniou
+[@jkogara]: https://github.com/jkogara
+[@tmorris-fiksu]: https://github.com/tmorris-fiksu
+[@mockdeep]: https://github.com/mockdeep
+[@hiroponz]: https://github.com/hiroponz
+[@tamird]: https://github.com/tamird
+[@fshowalter]: https://github.com/fshowalter
+[@cschramm]: https://github.com/cschramm
+[@bquorning]: https://github.com/bquorning
+[@bcobb]: https://github.com/bcobb
+[@irrationalfab]: https://github.com/irrationalfab
+[@tommeier]: https://github.com/tommeier
+[@sfeldon]: https://github.com/sfeldon
+[@biinari]: https://github.com/biinari
+[@barunio]: https://github.com/barunio
+[@molawson]: https://github.com/molawson
+[@wndhydrnt]: https://github.com/wndhydrnt
+[@ggilder]: https://github.com/ggilder
+[@salbertson]: https://github.com/salbertson
+[@camilleldn]: https://github.com/camilleldn
+[@mcls]: https://github.com/mcls
+[@yous]: https://github.com/yous
+[@vrthra]: https://github.com/vrthra
+[@SkuliOskarsson]: https://github.com/SkuliOskarsson
+[@jspanjers]: https://github.com/jspanjers
+[@sch1zo]: https://github.com/sch1zo
+[@smangelsdorf]: https://github.com/smangelsdorf
+[@mvz]: https://github.com/mvz
+[@jfelchner]: https://github.com/jfelchner
+[@janraasch]: https://github.com/janraasch
+[@jcarbo]: https://github.com/jcarbo
+[@oneamtu]: https://github.com/oneamtu
+[@toy]: https://github.com/toy
+[@Koronen]: https://github.com/Koronen
+[@blainesch]: https://github.com/blainesch
+[@marxarelli]: https://github.com/marxarelli
+[@katieschilling]: https://github.com/katieschilling
+[@kakutani]: https://github.com/kakutani
+[@rrosenblum]: https://github.com/rrosenblum
+[@mattjmcnaughton]: https://github.com/mattjmcnaughton
+[@huerlisi]: https://github.com/huerlisi
+[@volkert]: https://github.com/volkert
+[@lumeet]: https://github.com/lumeet
+[@mmozuras]: https://github.com/mmozuras
+[@d4rk5eed]: https://github.com/d4rk5eed
+[@cshaffer]: https://github.com/cshaffer
+[@eitoball]: https://github.com/eitoball
+[@iainbeeston]: https://github.com/iainbeeston
+[@pimterry]: https://github.com/pimterry
+[@palkan]: https://github.com/palkan
+[@jdoconnor]: https://github.com/jdoconnor
+[@meganemura]: https://github.com/meganemura
+[@zvkemp]: https://github.com/zvkemp
+[@vassilevsky]: https://github.com/vassilevsky
+[@gerry3]: https://github.com/gerry3
+[@ypresto]: https://github.com/ypresto
+[@clowder]: https://github.com/clowder
+[@mudge]: https://github.com/mudge
+[@mzp]: https://github.com/mzp
+[@bankair]: https://github.com/bankair
+[@crimsonknave]: https://github.com/crimsonknave
+[@renuo]: https://github.com/renuo
+[@sdeframond]: https://github.com/sdeframond
+[@til]: https://github.com/til
+[@carhartl]: https://github.com/carhartl
+[@dylandavidson]: https://github.com/dylandavidson
+[@tmr08c]: https://github.com/tmr08c
+[@hbd225]: https://github.com/hbd225
+[@l8nite]: https://github.com/l8nite
+[@sumeet]: https://github.com/sumeet
+[@ojab]: https://github.com/ojab
+[@chastell]: https://github.com/chastell
+[@glasnt]: https://github.com/glasnt
+[@crazydog115]: https://github.com/crazydog115
+[@RGBD]: https://github.com/RGBD
+[@panthomakos]: https://github.com/panthomakos
+[@matugm]: https://github.com/matugm
+[@m1foley]: https://github.com/m1foley
+[@tejasbubane]: https://github.com/tejasbubane
+[@bmorrall]: https://github.com/bmorrall
+[@fphilipe]: https://github.com/fphilipe
+[@gotrevor]: https://github.com/gotrevor
+[@awwaiid]: https://github.com/awwaiid
+[@segiddins]: https://github.com/segiddins
+[@urbanautomaton]: https://github.com/urbanautomaton.com
+[@unmanbearpig]: https://github.com/unmanbearpig
+[@maxjacobson]: https://github.com/maxjacobson
+[@sliuu]: https://github.com/sliuu
+[@edmz]: https://github.com/edmz
+[@syndbg]: https://github.com/syndbg
+[@wli]: https://github.com/wli
+[@caseywebdev]: https://github.com/caseywebdev
+[@MGerrior]: https://github.com/MGerrior
+[@imtayadeway]: https://github.com/imtayadeway

data/rubocop.gemspec

@@ -47,5 +47,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency('rspec', '~> 3.2.0')
   s.add_development_dependency('yard', '~> 0.8')
   s.add_development_dependency('bundler', '~> 1.3')
-  s.add_development_dependency('simplecov', '~> 0.7')
+  s.add_development_dependency('simplecov', '~> 0.10')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 0.33.0
+  version: 0.34.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-05 00:00:00.000000000 Z
+date: 2015-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.10'
 description: |2
       Automatic Ruby code style checking tool.
       Aims to enforce the community-driven Ruby Style Guide.
@@ -208,6 +208,7 @@ files:
 - lib/rubocop/cop/lint/def_end_alignment.rb
 - lib/rubocop/cop/lint/deprecated_class_methods.rb
 - lib/rubocop/cop/lint/duplicate_methods.rb
+- lib/rubocop/cop/lint/duplicated_key.rb
 - lib/rubocop/cop/lint/each_with_object_argument.rb
 - lib/rubocop/cop/lint/else_layout.rb
 - lib/rubocop/cop/lint/empty_ensure.rb
@@ -266,6 +267,7 @@ files:
 - lib/rubocop/cop/mixin/end_keyword_alignment.rb
 - lib/rubocop/cop/mixin/if_node.rb
 - lib/rubocop/cop/mixin/method_complexity.rb
+- lib/rubocop/cop/mixin/method_preference.rb
 - lib/rubocop/cop/mixin/min_body_length.rb
 - lib/rubocop/cop/mixin/negative_conditional.rb
 - lib/rubocop/cop/mixin/on_method_def.rb
@@ -282,6 +284,7 @@ files:
 - lib/rubocop/cop/mixin/surrounding_space.rb
 - lib/rubocop/cop/mixin/unused_argument.rb
 - lib/rubocop/cop/offense.rb
+- lib/rubocop/cop/performance/case_when_splat.rb
 - lib/rubocop/cop/performance/count.rb
 - lib/rubocop/cop/performance/detect.rb
 - lib/rubocop/cop/performance/flat_map.rb
@@ -389,6 +392,7 @@ files:
 - lib/rubocop/cop/style/multiline_if_then.rb
 - lib/rubocop/cop/style/multiline_operation_indentation.rb
 - lib/rubocop/cop/style/multiline_ternary_operator.rb
+- lib/rubocop/cop/style/mutable_constant.rb
 - lib/rubocop/cop/style/negated_if.rb
 - lib/rubocop/cop/style/negated_while.rb
 - lib/rubocop/cop/style/nested_ternary_operator.rb
@@ -411,6 +415,7 @@ files:
 - lib/rubocop/cop/style/raise_args.rb
 - lib/rubocop/cop/style/redundant_begin.rb
 - lib/rubocop/cop/style/redundant_exception.rb
+- lib/rubocop/cop/style/redundant_freeze.rb
 - lib/rubocop/cop/style/redundant_return.rb
 - lib/rubocop/cop/style/redundant_self.rb
 - lib/rubocop/cop/style/regexp_literal.rb
@@ -446,6 +451,7 @@ files:
 - lib/rubocop/cop/style/special_global_vars.rb
 - lib/rubocop/cop/style/string_literals.rb
 - lib/rubocop/cop/style/string_literals_in_interpolation.rb
+- lib/rubocop/cop/style/string_methods.rb
 - lib/rubocop/cop/style/struct_inheritance.rb
 - lib/rubocop/cop/style/symbol_array.rb
 - lib/rubocop/cop/style/symbol_literal.rb
@@ -493,6 +499,7 @@ files:
 - lib/rubocop/path_util.rb
 - lib/rubocop/processed_source.rb
 - lib/rubocop/rake_task.rb
+- lib/rubocop/result_cache.rb
 - lib/rubocop/runner.rb
 - lib/rubocop/string_util.rb
 - lib/rubocop/target_finder.rb
@@ -524,6 +531,7 @@ files:
 - relnotes/v0.32.0.md
 - relnotes/v0.32.1.md
 - relnotes/v0.33.0.md
+- relnotes/v0.34.0.md
 - rubocop.gemspec
 homepage: http://github.com/bbatsov/rubocop
 licenses: