rubocop 0.24.1 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df336e05887bac795bd4e9c4f04e3bc3749a154c
-  data.tar.gz: fad8eb6558bbf7656b4be594a3c4995b566ae4b9
+  metadata.gz: 162efdd3846932b1d519b27addb56f9581f28e5a
+  data.tar.gz: 0baf6fe4303cda3f842984b1ce7e7ee25b5e08b6
 SHA512:
-  metadata.gz: a8c03f04da1bb7f176f622482ac3f4244f736b8318fcc334c680faa752eb063eaac721949849c582d313b71c9fbb0903d82c4f6fd5df2b0b62574f8e7a154c36
-  data.tar.gz: b5d740c5335105d5256e3b59396776139c79ffd3857072761c00a630eb575df01478a4d98f6980b517c58cf9e32d6897fc9d3018d192f2cfa23d247f67a56837
+  metadata.gz: 6aa5d6a37649a89e441f5db7b9c02e4fcc033d52e457e9afcd8927906c1443d1cf6122adaf1af7c344f9f2154694bd33e0f9e71548ace50e7d30441baf9bd972
+  data.tar.gz: 828617aef1af7dc5260680d67633fef8135d2d884307b9b566a6b193f685fe061d0c47a1b12ef5f90ffe8bf42266a5d087ff518389c0400605bc4347795c2351

data/.rubocop_todo.yml

@@ -1,20 +1,24 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-05-17 17:36:04 +0200 using RuboCop version 0.21.0.
+# on 2014-07-27 10:46:47 +0200 using RuboCop version 0.24.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 7
+# Offense count: 8
 # Configuration parameters: CountComments.
-Style/ClassLength:
-  Max: 129
+Metrics/ClassLength:
+  Max: 131
 
-# Offense count: 24
-Style/CyclomaticComplexity:
+# Offense count: 30
+Metrics/CyclomaticComplexity:
   Max: 10
 
-# Offense count: 115
+# Offense count: 124
 # Configuration parameters: CountComments.
-Style/MethodLength:
+Metrics/MethodLength:
   Max: 21
+
+# Offense count: 22
+Metrics/PerceivedComplexity:
+  Max: 11

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
   - 2.1
@@ -10,6 +9,7 @@ rvm:
 matrix:
   allow_failures:
     - rvm: ruby-head
+    - rvm: rbx-2
 before_install: gem update --remote bundler
 script:
   - bundle exec rspec

data/CHANGELOG.md

@@ -2,6 +2,45 @@
 
 ## master (unreleased)
 
+## 0.25.0 (15/08/2014)
+
+### New features
+
+* [#1259](https://github.com/bbatsov/rubocop/issues/1259): Allow AndOr cop to autocorrect by adding method call parenthesis. ([@vrthra][])
+* [#1232](https://github.com/bbatsov/rubocop/issues/1232): Add EnforcedStyle option to cop `AndOr` to restrict it to conditionals. ([@vrthra][])
+* [#835](https://github.com/bbatsov/rubocop/issues/835): New cop `PercentQLiterals` checks if use of `%Q` and `%q` matches configuration. ([@jonas054][])
+* [#835](https://github.com/bbatsov/rubocop/issues/835): New cop `BarePercentLiterals` checks if usage of `%()` or `%Q()` matches configuration. ([@jonas054][])
+* [#1079](https://github.com/bbatsov/rubocop/pull/1079): New cop `MultilineBlockLayout` checks if a multiline block has an extpression on the same line as the start of the block. ([@barunio][])
+* [#1217](https://github.com/bbatsov/rubocop/pull/1217): `Style::EmptyLinesAroundAccessModifier` cop does auto-correction. ([@tamird][])
+* [#1220](https://github.com/bbatsov/rubocop/issues/1220): New cop `PerceivedComplexity` is similar to `CyclomaticComplexity`, but reports when methods have a high complexity for a human reader. ([@jonas054][])
+* `Debugger` cop now checks for `binding.pry_remote`. ([@yous][])
+* [#1238](https://github.com/bbatsov/rubocop/issues/1238): Add `MinBodyLength` option to `Next` cop. ([@bbatsov][])
+* [#1241](https://github.com/bbatsov/rubocop/issues/1241): `TrailingComma` cop does auto-correction. ([@yous][])
+* [#1078](https://github.com/bbatsov/rubocop/pull/1078): New cop `BlockEndNewline` checks if the end statement of a multiline block is on its own line. ([@barunio][])
+* [#1078](https://github.com/bbatsov/rubocop/pull/1078): `BlockAlignment` cop does auto-correction. ([@barunio][])
+
+### Changes
+
+* [#1220](https://github.com/bbatsov/rubocop/issues/1220): New namespace `Metrics` created and some `Style` cops moved there. ([@jonas054][])
+* Drop support for Ruby 1.9.2 in accordance with [the end of the security maintenance extension](https://www.ruby-lang.org/en/news/2014/07/01/eol-for-1-8-7-and-1-9-2/). ([@yujinakayama][])
+
+### Bugs fixed
+
+* [#1251](https://github.com/bbatsov/rubocop/issues/1251): Fix `PercentLiteralDelimiters` auto-correct indentation error. ([@hannestyden][])
+* [#1197](https://github.com/bbatsov/rubocop/issues/1197): Fix false positive for new lambda syntax in `SpaceInsideBlockBraces`. ([@jonas054][])
+* [#1201](https://github.com/bbatsov/rubocop/issues/1201): Fix error at anonymous keyword splat arguments in some variable cops. ([@yujinakayama][])
+* Fix false positive in `UnneededPercentQ` for `/%Q(something)/`. ([@jonas054][])
+* Fix `SpacesInsideBrackets` for `Hash#[]` calls with spaces after left bracket. ([@mcls][])
+* [#1210](https://github.com/bbatsov/rubocop/issues/1210): Fix false positive in `UnneededPercentQ` for `%Q(\t")`. ([@jonas054][])
+* Fix false positive in `UnneededPercentQ` for heredoc strings with `%q`/`%Q`. ([@jonas054][])
+* [#1214](https://github.com/bbatsov/rubocop/issues/1214): Don't destroy code in `AlignHash` autocorrect. ([@jonas054][])
+* [#1219](https://github.com/bbatsov/rubocop/issues/1219): Don't report bad alignment for `end` or `}` in `BlockAlignment` if it doesn't begin its line. ([@jonas054][])
+* [#1227](https://github.com/bbatsov/rubocop/issues/1227): Don't permanently change yamler as it can affect other apps. ([@jonas054][])
+* [#1184](https://github.com/bbatsov/rubocop/issues/1184): Fix a false positive in `Output` cop. ([@bbatsov][])
+* [#1256](https://github.com/bbatsov/rubocop/issues/1256): Ignore block-pass in `TrailingComma`. ([@tamird][])
+* [#1255](https://github.com/bbatsov/rubocop/issues/1255): Compare without context in `AutocorrectUnlessChangingAST`. ([@jonas054][])
+* [#1262](https://github.com/bbatsov/rubocop/issues/1262): Handle regexp and backtick literals in `VariableInterpolation`. ([@bbatsov][])
+
 ## 0.24.1 (03/07/2014)
 
 ### Bugs fixed
@@ -1014,3 +1053,6 @@
 [@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

data/Gemfile

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 source 'http://rubygems.org'
 
 gemspec

data/README.md

@@ -20,11 +20,18 @@ Most aspects of its behavior can be tweaked via various
 Apart from reporting problems in your code, RuboCop can also
 automatically fix some of the problems for you.
 
+**This documentation tracks the `master` branch of RuboCop. Some of
+the features and settings discussed here might not be available in
+older releases (including the current stable release). Please, consult
+the relevant git repo branch if you need documentation for a specific RuboCop
+release.**
+
 - [Installation](#installation)
 - [Basic Usage](#basic-usage)
     - [Cops](#cops)
         - [Style](#style)
         - [Lint](#lint)
+        - [Metrics](#metrics)
         - [Rails](#rails)
 - [Configuration](#configuration)
     - [Inheritance](#inheritance)
@@ -178,6 +185,14 @@ enabled lint cops plus a selection of other cops.
 
 Disabling any of the lint cops is generally a bad idea.
 
+#### Metrics
+
+Metrics cops deal with properties of the source code that can be measured,
+such as class length, method length, etc. Generally speaking, they have a
+configuration parameter called `Max` and when running
+`rubocop --auto-gen-config`, this parameter will be set to the highest value
+found for the inspected code.
+
 #### Rails
 
 Rails cops are specific to the Ruby on Rails framework. Unlike style
@@ -188,6 +203,13 @@ specifically:
 $ rubocop -R
 ```
 
+or add the following directive to your `.rubocop.yml`:
+
+```yaml
+AllCops:
+  RunRailsCops: true
+```
+
 ## Configuration
 
 The behavior of RuboCop can be controlled via the
@@ -207,7 +229,7 @@ inherit_from: ../.rubocop.yml
 Style/Encoding:
   Enabled: false
 
-Style/LineLength:
+Metrics/LineLength:
   Max: 99
 ```
 
@@ -311,7 +333,7 @@ Rails/DefaultScope:
 Specific cops can be disabled by setting `Enabled` to `false` for that specific cop.
 
 ```yaml
-Style/LineLength:
+Metrics/LineLength:
   Enabled: false
 ```
 
@@ -319,7 +341,7 @@ Cops can customize their severity level. All cops support the `Severity` param.
 Allowed params are `refactor`, `convention`, `warning`, `error` and `fatal`.
 
 ```yaml
-Style/CyclomaticComplexity:
+Metrics/CyclomaticComplexity:
   Severity: warning
 ```
 
@@ -339,9 +361,9 @@ One or more individual cops can be disabled locally in a section of a
 file by adding a comment such as
 
 ```ruby
-# rubocop:disable Style/LineLength, Style/StringLiterals
+# rubocop:disable Metrics/LineLength, Style/StringLiterals
 [...]
-# rubocop:enable Style/LineLength, Style/StringLiterals
+# rubocop:enable Metrics/LineLength, Style/StringLiterals
 ```
 
 You can also disable *all* cops with
@@ -583,7 +605,6 @@ $ rubocop --format offenses
 
 RuboCop supports the following Ruby implementations:
 
-* MRI 1.9.2 ([until June 2014](https://www.ruby-lang.org/en/news/2013/12/17/maintenance-of-1-8-7-and-1-9-2/))
 * MRI 1.9.3
 * MRI 2.0
 * MRI 2.1

data/bin/rubocop

@@ -1,22 +1,17 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
 
-if RUBY_VERSION >= '1.9.2'
-  $LOAD_PATH.unshift(File.dirname(File.realpath(__FILE__)) + '/../lib')
+$LOAD_PATH.unshift(File.dirname(File.realpath(__FILE__)) + '/../lib')
 
-  require 'rubocop'
-  require 'benchmark'
+require 'rubocop'
+require 'benchmark'
 
-  cli = RuboCop::CLI.new
-  result = 0
+cli = RuboCop::CLI.new
+result = 0
 
-  time = Benchmark.realtime do
-    result = cli.run
-  end
-
-  puts "Finished in #{time} seconds" if cli.options[:debug]
-  exit result
-else
-  puts 'RuboCop supports only Ruby 1.9.2+'
-  exit(-1)
+time = Benchmark.realtime do
+  result = cli.run
 end
+
+puts "Finished in #{time} seconds" if cli.options[:debug]
+exit result

data/config/default.yml

@@ -10,7 +10,16 @@ AllCops:
   # Include gemspec and Rakefile
   Include:
     - '**/*.gemspec'
+    - '**/*.podspec'
+    - '**/*.jbuilder'
+    - '**/*.rake'
+    - '**/Gemfile'
     - '**/Rakefile'
+    - '**/Capfile'
+    - '**/Guardfile'
+    - '**/Podfile'
+    - '**/Thorfile'
+    - '**/Vagrantfile'
   Exclude:
     - 'vendor/**/*'
   # By default, the rails cops are not run. Override in project or home
@@ -107,8 +116,21 @@ Style/AlignParameters:
     - with_first_parameter
     - with_fixed_indentation
 
-Style/BlockNesting:
-  Max: 3
+Style/AndOr:
+  # Whether `and` and `or` are banned only in conditionals (conditionals)
+  # or completely (always).
+  EnforcedStyle: always
+  SupportedStyles:
+    - always
+    - conditionals
+
+
+# Checks if usage of %() or %Q() matches configuration.
+Style/BarePercentLiterals:
+  EnforcedStyle: bare_percent
+  SupportedStyles:
+    - percent_q
+    - bare_percent
 
 Style/BracesAroundHashParameters:
   EnforcedStyle: no_braces
@@ -150,10 +172,6 @@ Style/ClassCheck:
   SupportedStyles:
     - is_a?
     - kind_of?
-    
-Style/ClassLength:
-  CountComments: false  # count full line comments?
-  Max: 100
 
 # Align with the style guide.
 Style/CollectionMethods:
@@ -179,10 +197,6 @@ Style/CommentAnnotation:
     - HACK
     - REVIEW
 
-# Avoid complex methods.
-Style/CyclomaticComplexity:
-  Max: 6
-
 # Multi-line method chaining should be done with leading dots.
 Style/DotPosition:
   EnforcedStyle: leading
@@ -208,6 +222,9 @@ Style/FileName:
     - '**/Rakefile'
     - '**/Gemfile'
     - '**/Capfile'
+    - '**/Vagrantfile'
+    - '**/Podfile'
+    - '**/Thorfile'
 
 # Checks use of for or each in multiline loops.
 Style/For:
@@ -262,15 +279,14 @@ Style/LambdaCall:
     - call
     - braces
 
-Style/LineLength:
-  Max: 80
-  AllowURI: true
-
 Style/Next:
   # With `always` all conditions at the end of an iteration needs to be
-  # replace by next - with `skip_modifier_ifs` the modifier if like this one
+  # replaced by next - with `skip_modifier_ifs` the modifier if like this one
   # are ignored: [1, 2].each { |a| return 'yes' if a == 1 }
   EnforcedStyle: skip_modifier_ifs
+  # `MinBodyLength` defines the number of lines of the a body of an if / unless
+  # needs to have to trigger this cop
+  MinBodyLength: 3
   SupportedStyles:
     - skip_modifier_ifs
     - always
@@ -290,10 +306,6 @@ Style/MethodDefParentheses:
     - require_parentheses
     - require_no_parentheses
 
-Style/MethodLength:
-  CountComments: false  # count full line comments?
-  Max: 10
-
 Style/MethodName:
   EnforcedStyle: snake_case
   SupportedStyles:
@@ -303,10 +315,6 @@ Style/MethodName:
 Style/NumericLiterals:
   MinDigits: 5
 
-Style/ParameterLists:
-  Max: 5
-  CountKeywordArgs: true
-
 # Allow safe assignment in conditions.
 Style/ParenthesesAroundCondition:
   AllowSafeAssignment: true
@@ -323,6 +331,12 @@ Style/PercentLiteralDelimiters:
     '%W': ()
     '%x': ()
 
+Style/PercentQLiterals:
+  EnforcedStyle: lower_case_q
+  SupportedStyles:
+    - lower_case_q # Use %q when possible, %Q when necessary
+    - upper_case_q # Always use %Q
+
 Style/PredicateName:
   NamePrefixBlacklist:
     - is_
@@ -335,7 +349,6 @@ Style/RaiseArgs:
     - compact # raise Exception.new(msg)
     - exploded # raise Exception, msg
 
-
 Style/RedundantReturn:
   # When true allows code like `return x, y`.
   AllowMultipleReturnValues: false
@@ -356,7 +369,6 @@ Style/SignalException:
     - only_fail
     - semantic
 
-
 Style/SingleLineBlockParams:
   Methods:
     - reduce:
@@ -463,6 +475,34 @@ Style/WhileUntilModifier:
 Style/WordArray:
   MinSize: 0
 
+##################### Metrics ##################################
+
+Metrics/BlockNesting:
+  Max: 3
+
+Metrics/ClassLength:
+  CountComments: false  # count full line comments?
+  Max: 100
+
+# Avoid complex methods.
+Metrics/CyclomaticComplexity:
+  Max: 6
+
+Metrics/LineLength:
+  Max: 80
+  AllowURI: true
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 10
+
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: true
+
+Metrics/PerceivedComplexity:
+  Max: 7
+
 ##################### Lint ##################################
 
 # Allow safe assignment in conditions.
@@ -509,6 +549,13 @@ Rails/HasAndBelongsToMany:
   Include:
     - app/models/**/*.rb
 
+Rails/Output:
+  Include:
+    - app/**/*.rb
+    - config/**/*.rb
+    - db/**/*.rb
+    - lib/**/*.rb
+    
 Rails/ReadWriteAttribute:
   Include:
     - app/models/**/*.rb

data/config/enabled.yml

@@ -54,12 +54,16 @@ Style/BeginBlock:
   Description: 'Avoid the use of BEGIN blocks.'
   Enabled: true
 
+Style/BarePercentLiterals:
+  Description: 'Checks if usage of %() or %Q() matches configuration.'
+  Enabled: true
+
 Style/BlockComments:
   Description: 'Do not use block comments.'
   Enabled: true
 
-Style/BlockNesting:
-  Description: 'Avoid excessive block nesting'
+Style/BlockEndNewline:
+  Description: 'Put end statement of multiline block on its own line.'
   Enabled: true
 
 Style/Blocks:
@@ -97,10 +101,6 @@ Style/ClassCheck:
   Description: 'Enforces consistent use of `Object#is_a?` or `Object#kind_of?`.'
   Enabled: true
 
-Style/ClassLength:
-  Description: 'Avoid classes longer than 100 lines of code.'
-  Enabled: true
-
 Style/ClassMethods:
   Description: 'Use self when defining module/class methods.'
   Enabled: true
@@ -131,10 +131,6 @@ Style/ConstantName:
   Description: 'Constants should use SCREAMING_SNAKE_CASE.'
   Enabled: true
 
-Style/CyclomaticComplexity:
-  Description: 'Avoid complex methods.'
-  Enabled: true
-
 Style/DefWithParentheses:
   Description: 'Use def with parentheses when there are arguments.'
   Enabled: true
@@ -271,10 +267,6 @@ Style/LineEndConcatenation:
                  line end.
   Enabled: true
 
-Style/LineLength:
-  Description: 'Limit lines to 80 characters.'
-  Enabled: true
-
 Style/MethodCallParentheses:
   Description: 'Do not use parentheses for method calls with no arguments.'
   Enabled: true
@@ -285,10 +277,6 @@ Style/MethodDefParentheses:
                  parentheses.
   Enabled: true
 
-Style/MethodLength:
-  Description: 'Avoid methods longer than 10 lines of code.'
-  Enabled: true
-
 Style/MethodName:
   Description: 'Use the configured style when naming methods.'
   Enabled: true
@@ -301,6 +289,10 @@ Style/MultilineBlockChain:
   Description: 'Avoid multi-line chains of blocks.'
   Enabled: true
 
+Style/MultilineBlockLayout:
+  Description: 'Ensures newlines after multiline block do statements.'
+  Enabled: true
+
 Style/MultilineIfThen:
   Description: 'Never use then for multi-line if/unless.'
   Enabled: true
@@ -357,10 +349,6 @@ Style/OpMethod:
   Description: 'When defining binary operators, name the argument other.'
   Enabled: true
 
-Style/ParameterLists:
-  Description: 'Avoid parameter lists longer than three or four parameters.'
-  Enabled: true
-
 Style/ParenthesesAroundCondition:
   Description: >-
                  Don't use parentheses around the condition of an
@@ -371,6 +359,10 @@ Style/PercentLiteralDelimiters:
   Description: 'Use `%`-literal delimiters consistently'
   Enabled: true
 
+Style/PercentQLiterals:
+  Description: 'Checks if uses of %Q/%q match the configured preference.'
+  Enabled: true
+
 Style/PerlBackrefs:
   Description: 'Avoid Perl-style regex back references.'
   Enabled: true
@@ -416,7 +408,9 @@ Style/RescueModifier:
   Enabled: true
 
 Style/SelfAssignment:
-  Description: 'Checks for places where self-assignment shorthand should have been used.'
+  Description: >-
+                 Checks for places where self-assignment shorthand should have
+                 been used.
   Enabled: true
 
 Style/Semicolon:
@@ -595,6 +589,40 @@ Style/WordArray:
   Description: 'Use %w or %W for arrays of words.'
   Enabled: true
 
+#################### Metrics ################################
+
+Metrics/BlockNesting:
+  Description: 'Avoid excessive block nesting'
+  Enabled: true
+
+Metrics/ClassLength:
+  Description: 'Avoid classes longer than 100 lines of code.'
+  Enabled: true
+
+Metrics/CyclomaticComplexity:
+  Description: >-
+                 A complexity metric that is strongy correlated to the number
+                 of test cases needed to validate a method.
+  Enabled: true
+
+Metrics/LineLength:
+  Description: 'Limit lines to 80 characters.'
+  Enabled: true
+
+Metrics/MethodLength:
+  Description: 'Avoid methods longer than 10 lines of code.'
+  Enabled: true
+
+Metrics/ParameterLists:
+  Description: 'Avoid parameter lists longer than three or four parameters.'
+  Enabled: true
+
+Metrics/PerceivedComplexity:
+  Description: >-
+                 A complexity metric geared towards measuring complexity for a
+                 human reader.
+  Enabled: true
+
 #################### Lint ################################
 ### Warnings
 
@@ -619,7 +647,9 @@ Lint/BlockAlignment:
   Enabled: true
 
 Lint/ConditionPosition:
-  Description: 'Checks for condition placed in a confusing position relative to the keyword.'
+  Description: >-
+                 Checks for condition placed in a confusing position relative to
+                 the keyword.
   Enabled: true
 
 Lint/Debugger:
@@ -781,7 +811,9 @@ Rails/Output:
   Enabled: true
 
 Rails/ReadWriteAttribute:
-  Description: 'Checks for read_attribute(:attr) and write_attribute(:attr, val).'
+  Description: >-
+                 Checks for read_attribute(:attr) and
+                 write_attribute(:attr, val).
   Enabled: true
 
 Rails/ScopeArgs: