rubocop 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4147b39dd3f54752faac528951caeb3ccc5492b5
-  data.tar.gz: 5f2818160c6acc8a895a30094b123d795695122d
+  metadata.gz: e1d53b4bf428418ce94f9957624298881e744d48
+  data.tar.gz: a8da381882375f2f62d9209a0c8b27bfae1647fe
 SHA512:
-  metadata.gz: e2ff5ec56e71894fea1e05c25ec54fc1bcb942bf97309a7f1724723ad484abc17dced861d3c3d82018d09c189746d95115e210aaa5666b6e9262202dd48dc4c9
-  data.tar.gz: 9039f3082e26b30e4c379ab0ee7263b78eed367dd46ab7170d71049ef621a79b3561e28e0a10d199e795cda699e64e21dd15e28442e56797a19db17f39dd78e9
+  metadata.gz: e77ffc73a8976e35a4fe77c8c95c84b9f15e46e83b43f559808736c236b6dbbdf07467c627e3fcce1f3ff730aa75b03222482d00d3da0122efeb3e163fe1fdd9
+  data.tar.gz: 100c16f188ae13fdbcb70393b966b559a839325a6c0531c2628385910567d6383059d8c049e2fff43857f32f16b319cd15994f3adf13704877daf239f5e62b93

data/.rubocop.yml

@@ -1,12 +1,3 @@
 # This is the configuration used to check the rubocop source code.
 
-inherit_from: config/default.yml
-
-MethodLength:
-  Max: 22
-
-ClassLength:
-  Max: 140
-
-CyclomaticComplexity:
-  Max: 12
+inherit_from: rubocop-todo.yml

data/.travis.yml

@@ -2,8 +2,9 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0-rc1
   - jruby-19mode
-  - rbx-19mode
+  - rbx-2.1.1
 script:
   - bundle exec rspec
   - bundle exec rubocop

data/CHANGELOG.md

@@ -2,6 +2,52 @@
 
 ## master (unreleased)
 
+## 0.16.0 (25/12/2013)
+
+### New features
+
+* [#612](https://github.com/bbatsov/rubocop/pull/612): `BracesAroundHashParameters` cop does auto-correction. ([@dblock][])
+* [#614](https://github.com/bbatsov/rubocop/pull/614): `ParenthesesAroundCondition` cop does auto-correction. ([@dblock][])
+* [#624](https://github.com/bbatsov/rubocop/pull/624): `EmptyLines` cop does auto-correction. ([@dblock][])
+* New Rails cop `DefaultScope` ensures `default_scope` is called properly with a block argument. ([@bbatsov][])
+* All cops now support the `Include` param, which specifies the files on which they should operate. ([@bbatsov][])
+* All cops now support the `Exclude` param, which specifies the files on which they should not operate. ([@bbatsov][])
+* [#631](https://github.com/bbatsov/rubocop/issues/631): `IndentationWidth` cop now detects inconsistent indentation between lines that should have the same indentation. ([@jonas054][])
+* [#649](https://github.com/bbatsov/rubocop/pull/649): `EmptyLinesAroundBody` cop does auto-correction. ([@dblock][])
+* [#657](https://github.com/bbatsov/rubocop/pull/657): `Alias` cop does auto-correction. ([@dblock][])
+* Rake task now support setting formatters. ([@pmenglund][])
+* [#653](https://github.com/bbatsov/rubocop/issues/653): `CaseIndentation` cop is now configurable with parameters `IndentWhenRelativeTo` and `IndentOneStep`. ([@jonas054][])
+* [#654](https://github.com/bbatsov/rubocop/pull/654): `For` cop is now configurable to enforce either `each` (default) or `for`. ([@jonas054][])
+* [#661](https://github.com/bbatsov/rubocop/issue/661): `EndAlignment` cop is now configurable for alignment with `keyword` (default) or `variable`. ([@jonas054][])
+* Allow to overwrite the severity of a cop with the new `Severity` param. ([@codez][])
+* New cop `FlipFlop` checks for flip flops. ([@agrimm][])
+* [#577](https://github.com/bbatsov/rubocop/issues/577): Introduced `MethodDefParentheses` to allow for for requiring either parentheses or no parentheses in method definitions. Replaces `DefWithoutParentheses`. ([@skanev][])
+* [#693](https://github.com/bbatsov/rubocop/pull/693): Generation of parameter values (i.e., not only `Enabled: false`) in `rubocop-todo.yml` by the `--auto-gen-config` option is now supported for some cops. ([@jonas054][])
+* New cop `AccessorMethodName` checks accessor method names for non-idiomatic names like `get_attribute` and `set_attribute`. ([@bbatsov][])
+* New cop `PredicateName` checks the names of predicate methods for non-idiomatic names like `is_something`, `has_something`, etc. ([@bbatsov][])
+
+### Changes
+
+* Removed `SymbolNames` as it was generating way too many false positives. ([@bbatsov][])
+* Renamed `ReduceArguments` to `SingleLineBlockParams` and made it configurable. ([@bbatsov][])
+
+### Bugs fixed
+
+* Handle properly heredocs in `StringLiterals` cop. ([@bbatsov][])
+* Fix `SpaceAroundOperators` to not report missing space around operator for `def self.method *args`. ([@jonas054][])
+* Properly handle `['AllCops']['Includes']` and `['AllCops']['Excludes']` when passing config via `-c`. ([@fancyremarker][], [@codez][])
+* [#611](https://github.com/bbatsov/rubocop/pull/611): Fix crash when loading an empty config file ([@sinisterchipmunk][])
+* Fix `DotPosition` cop with `trailing` style for method calls on same line. ([@vonTronje][])
+* [#627](https://github.com/bbatsov/rubocop/pull/627): Fix counting of slashes in complicated regexps in `RegexpLiteral` cop. ([@jonas054][])
+* [#638](https://github.com/bbatsov/rubocop/issues/638): Fix bug in auto-correct that changes `each{ |x|` to `each d o |x|`. ([@jonas054][])
+* [#418](https://github.com/bbatsov/rubocop/issues/418): Stop searching for configuration files above the work directory of the isolated environment when running specs. ([@jonas054][])
+* Fix error on implicit match conditionals (e.g. `if /pattern/; end`) in `MultilineIfThen`. ([@agrimm][])
+* [#651](https://github.com/bbatsov/rubocop/issues/651): Handle properly method arguments in `RedundantSelf`. ([@bbatsov][])
+* [#628](https://github.com/bbatsov/rubocop/issues/628): Allow `self.Foo` in `RedundantSelf` cop. ([@chulkilee][])
+* [#668](https://github.com/bbatsov/rubocop/issues/668): Fix crash in `EndOfLine` that occurs when default encoding is `US_ASCII` and an inspected file has non-ascii characters. ([@jonas054][])
+* [#664](https://github.com/bbatsov/rubocop/issues/664): Accept oneline while when condition has local variable assignment. ([@emou][])
+* Fix auto-correct for `MethodDefParentheses` when parentheses are required. ([@skanev][])
+
 ## 0.15.0 (06/11/2013)
 
 ### New features
@@ -557,3 +603,12 @@
 [@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

data/Gemfile

@@ -3,5 +3,8 @@ source 'http://rubygems.org'
 gemspec
 
 group :test do
+  gem 'rubysl', platform: :rbx
+  gem 'rubinius-developer_tools', platform: :rbx
+  gem 'racc', platform: :rbx
   gem 'coveralls', require: false
 end

data/README.md

@@ -213,6 +213,41 @@ subdirectories. This is different from all other parameters, who
 follow RuboCop's general principle that configuration for an inspected
 file is taken from the nearest `.rubocop.yml`, searching upwards.
 
+Cops can be run only on specific sets of files when that's needed (for
+instance you might want to run some Rails model checks only on files,
+which paths match `app/models/*.rb`). All cops support the
+`Include` param.
+
+```yaml
+DefaultScope:
+  Include:
+    - app/models
+```
+
+Cops can also exclude only specific sets of files when that's needed (for
+instance you might want to run some cop only on a specific file). All cops support the
+`Exclude` param.
+
+```yaml
+DefaultScope:
+  Exclude:
+    - app/models/problematic.rb
+```
+
+Specific cops can be disabled by setting `Enabled` to `false` for that specific cop.
+
+```yaml
+LineLength:
+  Enabled: false
+```
+
+Cops can customize their severity level. All cops support the `Severity` param.
+
+```yaml
+CyclomaticComplexity:
+  Severity: warning
+```
+
 ### Automatically Generated Configuration
 
 If you have a code base with an overwhelming amount of offences, it can be a
@@ -486,6 +521,8 @@ require 'rubocop/rake_task'
 desc 'Run RuboCop on the lib directory'
 Rubocop::RakeTask.new(:rubocop) do |task|
   task.patterns = ['lib/**/*.rb']
+  # only show the files with failures
+  task.formatters = ['files']
   # don't abort rake on failure
   task.fail_on_error = false
 end

data/config/default.yml

@@ -18,8 +18,10 @@ AllCops:
 
 # Indent private/protected/public as deep as method definitions
 AccessModifierIndentation:
-  # supported styles are "indent" and "outdent"
   EnforcedStyle: indent
+  SupportedStyles:
+    - outdent
+    - indent
 
 # Align the elements of a hash literal if they span more than one line.
 AlignHash:
@@ -56,8 +58,16 @@ BlockNesting:
   Max: 3
 
 BracesAroundHashParameters:
-  # Valid values are: braces, no_braces
   EnforcedStyle: no_braces
+  SupportedStyles:
+    - braces
+    - no_braces
+
+# Indentation of `when`.
+CaseIndentation:
+  # Valid values are: case, end
+  IndentWhenRelativeTo: case
+  IndentOneStep: false
 
 ClassLength:
   CountComments: false  # count full line comments?
@@ -95,28 +105,57 @@ EmptyLineBetweenDefs:
   # need an empty line between them.
   AllowAdjacentOneLineDefs: false
 
+# Align ends correctly.
+EndAlignment:
+  # Valid valued are: keyword, variable
+  # The value `keyword` means that `end` should be aligned with the matching
+  # keyword (if, while, etc.).
+  # The value `variable` means that in assignments, `end` should be aligned
+  # with the start of the variable on the left hand side of `=`. In all other
+  # situations, `end` should still be aligned with the keyword.
+  AlignWith: keyword
+
+# Checks use of for or each in multiline loops.
+For:
+  EnforcedStyle: each
+  SupportedStyles:
+    - for
+    - each
+
 # Built-in global variables are allowed by default.
 GlobalVars:
   AllowedVariables: []
 
 HashSyntax:
-  # Valid values are: ruby19, hash_rockets
   EnforcedStyle: ruby19
+  SupportedStyles:
+    - ruby19
+    - hash_rockets
 
 LambdaCall:
-  # Valid values are: call, braces
   EnforcedStyle: call
+  SupportedStyles:
+    - call
+    - braces
 
 LineLength:
   Max: 79
 
+MethodDefParentheses:
+  EnforcedStyle: require_parentheses
+  SupportedStyles:
+    - require_parentheses
+    - require_no_parentheses
+
 MethodLength:
   CountComments: false  # count full line comments?
   Max: 10
 
 MethodName:
-  # Valid values are: snake_case, camelCase
   EnforcedStyle: snake_case
+  SupportedStyles:
+    - snake_case
+    - camelCase
 
 NumericLiterals:
   MinDigits: 5
@@ -136,11 +175,18 @@ ParameterLists:
 ParenthesesAroundCondition:
   AllowSafeAssignment: true
 
+PredicateName:
+  NamePrefixBlacklist:
+    - is_
+    - has_
+    - have_
+
 RaiseArgs:
-  # Valid values are: compact and exploded
-  # exploded: raise Exception, msg
-  # compact: raise Exception.new(msg)
   EnforcedStyle: exploded
+  SupportedStyles:
+    - compact # raise Exception.new(msg)
+    - exploded # raise Exception, msg
+
 
 RedundantReturn:
   # When true allows code like `return x, y`.
@@ -154,32 +200,48 @@ Semicolon:
   AllowAsExpressionSeparator: false
 
 SignalException:
-  # Valid values are: semantic, only_raise and only_fail
   EnforcedStyle: semantic
+  SupportedStyles:
+    - only_raise
+    - only_fail
+    - semantic
+
+
+SingleLineBlockParams:
+  Methods:
+    - reduce: 
+        - a
+        - e
+    - inject:
+        - a
+        - e
 
 SingleLineMethods:
   AllowIfMethodIsEmpty: true
 
 StringLiterals:
-  # Valid values (denoting the preferred quote delimiters) are:
-  # single_quotes, double_quotes
   EnforcedStyle: single_quotes
+  SupportedStyles:
+    - single_quotes
+    - double_quotes
 
 SpaceAroundBlockBraces:
-  # Valid values are: space_inside_braces, no_space_inside_braces
   EnforcedStyle: space_inside_braces
+  SupportedStyles:
+    - space_inside_braces
+    - no_space_inside_braces
   # Valid values are: space, no_space
   EnforcedStyleForEmptyBraces: no_space
   # Space between { and |. Overrides EnforcedStyle if there is a conflict.
   SpaceBeforeBlockParameters: true
 
 SpaceInsideHashLiteralBraces:
-  # Valid values (for both parameters) are: space, no_space
   EnforcedStyle: space
   EnforcedStyleForEmptyBraces: no_space
+  SupportedStyles:
+    - space
+    - no_space
 
-SymbolName:
-  AllowCamelCase: true
 
 # TrivialAccessors doesn't require exact name matches and doesn't allow
 # predicated methods by default.
@@ -206,8 +268,29 @@ TrivialAccessors:
     - to_sym
 
 VariableName:
-  # Valid values are: snake_case, camelCase
   EnforcedStyle: snake_case
+  SupportedStyles:
+    - snake_case
+    - camelCase
 
 WordArray:
   MinSize: 0
+
+##################### Rails ##################################
+
+DefaultScope:
+  IncludePaths:
+    - app/models
+
+HasAndBelongsToMany:
+  IncludePaths:
+    - app/models
+
+ReadAttribute:
+  IncludePaths:
+    - app/models
+
+Validation:
+  IncludePaths:
+    - app/models
+

data/config/enabled.yml

@@ -4,6 +4,10 @@ AccessModifierIndentation:
   Description: Check indentation of private/protected visibility modifiers.
   Enabled: true
 
+AccessorMethodName:
+  Description: Check the naming of accessor methods for get_/set_.
+  Enabled: true
+
 Alias:
   Description: 'Use alias_method instead of alias.'
   Enabled: true
@@ -66,7 +70,7 @@ CaseEquality:
   Enabled: true
 
 CaseIndentation:
-  Description: 'Indent when as deep as case.'
+  Description: 'Indentation of when in a case/when/[else/]end.'
   Enabled: true
 
 CharacterLiteral:
@@ -109,12 +113,6 @@ DefWithParentheses:
   Description: 'Use def with parentheses when there are arguments.'
   Enabled: true
 
-DefWithoutParentheses:
-  Description: >
-                 Omit the parentheses when the method doesn't accept
-                 any arguments.
-  Enabled: true
-
 Documentation:
   Description: 'Document classes and non-namespace modules.'
   Enabled: true
@@ -189,8 +187,12 @@ FinalNewline:
   Description: 'Checks for a final newline in a source file.'
   Enabled: true
 
+FlipFlop:
+  Description: 'Checks for flip flops'
+  Enabled: true
+
 For:
-  Description: 'Prefer each over for.'
+  Description: 'Checks use of for or each in multiline loops.'
   Enabled: true
 
 GlobalVars:
@@ -251,6 +253,12 @@ MethodCallParentheses:
   Description: 'Do not use parentheses for method calls with no arguments.'
   Enabled: true
 
+MethodDefParentheses:
+  Description: >
+                 Checks if the method definitions have or don't have
+                 parentheses.
+  Enabled: true
+
 MethodLength:
   Description: 'Avoid methods longer than 10 lines of code.'
   Enabled: true
@@ -319,6 +327,10 @@ PerlBackrefs:
   Description: 'Avoid Perl-style regex back references.'
   Enabled: true
 
+PredicateName:
+  Description: 'Check the names of predicate methods.'
+  Enabled: true
+
 Proc:
   Description: 'Use proc instead of Proc.new.'
   Enabled: true
@@ -327,10 +339,6 @@ RaiseArgs:
   Description: 'Checks the arguments passed to raise/fail.'
   Enabled: true
 
-ReduceArguments:
-  Description: 'Name reduce arguments |a, e| (accumulator, element)'
-  Enabled: true
-
 RedundantBegin:
   Description: "Don't use begin blocks when they are not needed."
   Enabled: true
@@ -371,6 +379,10 @@ SignalException:
   Description: 'Checks for proper usage of fail and raise.'
   Enabled: true
 
+SingleLineBlockParams:
+  Description: 'Enforces the names of some block params.'
+  Enabled: true
+
 SingleLineMethods:
   Description: 'Avoid single-line methods.'
   Enabled: true
@@ -442,10 +454,6 @@ StringLiterals:
   Description: 'Checks if uses of quotes match the configured preference.'
   Enabled: true
 
-SymbolName:
-  Description: 'Symbol literals should use snake_case.'
-  Enabled: true
-
 Tab:
   Description: 'No hard tabs.'
   Enabled: true
@@ -575,6 +583,10 @@ Void:
 
 ##################### Rails ##################################
 
+DefaultScope:
+  Description: 'Checks if the argument passed to default_scope is a block.'
+  Enabled: true
+
 HasAndBelongsToMany:
   Description: 'Prefer has_many :through to has_and_belongs_to_many.'
   Enabled: true