rubocop 0.8.3 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16a44d3f2a1c8900c26a3ba3214544b7378ca909
-  data.tar.gz: 3fc50a37f128c6cfa72042efdec81b70e079c5d8
+  metadata.gz: 35c6cb48366134b80f6d3f42fc1486a99ed49a7f
+  data.tar.gz: d4375b85c570dee03df158ca32485af07784cf3e
 SHA512:
-  metadata.gz: 5def319561b99d969fa010de14d328c068db9ce06e4f739ceeaf32352903846ffc4eb010879ae44530bd666e5fc6a5aedc8cbcc1c2a20ae1b6432196e5ff406e
-  data.tar.gz: ca0b6434723e9bacebe3ff866775311d4f0ad04c15342288e7f00454f617ebfd24c3d4d7768aa3746cf97c7fd401a814efeede7a57c4f8b32b61f0aaf03701d8
+  metadata.gz: f48afa6ead4a29e196af51a92e1c5d248fe02272782edbe0b3d18e866a5707d1b0d1bd258c137ca751ab9fdc08dff713e9cb2c830679a8b987d8294cee561ffc
+  data.tar.gz: 5fb1c77cb3960f39e1b7edbd5b6babfe8227b6801feff13f3ab04a0768693916275f30c77a083d934b69f02733fe87da15c720b55fd11b4d22632b8bb9e1b4a1

data/.travis.yml

@@ -5,7 +5,3 @@ rvm:
   - jruby-19mode
   - rbx-19mode
 script: bundle exec rspec
-matrix:
-  allow_failures:
-    - rvm: jruby-19mode
-    - rvm: rbx-19mode

data/.yardopts

@@ -0,0 +1,2 @@
+--markup markdown
+--hide-void-return

data/CHANGELOG.md

@@ -2,16 +2,85 @@
 
 ## master (unreleased)
 
+## 0.9.0 (01/07/2013)
+
 ### New features
 
-* New cop `BlockNesting` checks for excessive block nesting
+* Introduced formatter feature, enables custom formatted output and multiple outputs.
+* Added progress formatter and now it's the default. (`--format progress`)
+* Added JSON formatter. (`--format json`)
+* Added clang style formatter showing the offending source
+  code. (`--format clang`). The `clang` formatter marks a whole range
+  rather than just the starting position, to indicate more clearly
+  where the problem is.
+* Added `-f`/`--format` option to specify formatter.
+* Added `-o`/`--out` option to specify output file for each formatter.
+* Added `-r/--require` option to inject external Ruby code into RuboCop.
+* Added `-V/--verbose-version` option that displays Parser version and Ruby version as well.
+* Added `-R/--rails` option that enables extra Rails-specific cops.
+* Added support for auto-correction of some offences with `-a`/`--auto-correct`.
+* New cop `CaseEquality` checks for explicit use of `===`
+* New cop `AssignmentInCondition` checks for assignment in conditions.
+* New cop `EndAlignment` tracks misaligned `end` keywords.
+* New cop `Void` tracks uses of literals/variables/operators in possibly void context.
+* New cop `Documentation` checks for top level class/module doc comments.
+* New cop `UnreachableCode` tracks unreachable code segments.
+* New cop `MethodCallParentheses` tracks unwanted braces in method calls.
+* New cop `UnusedLocalVariable` tracks unused local variables for each scope.
+* New cop `ShadowingOuterLocalVariable` tracks use of the same name as outer local variables for block arguments or block local variables.
+* New cop `WhileUntilDo` tracks uses of `do` with multi-line `while/until`.
+* New cop `CharacterLiteral` tracks uses of character literals (`?x`).
+* New cop `EndInMethod` tracks uses of `END` in method definitions.
+* New cop `LiteralInCondition` tracks uses of literals in the conditions of `if/while/until`.
+* New cop `BeginBlock` tracks uses of `BEGIN` blocks.
+* New cop `EndBlock` tracks uses of `END` blocks.
+* New cop `DotPosition` tracks the dot position in multi-line method calls.
+* New cop `Attr` tracks uses of `Module#attr`.
 
 ### Changes
 
+* Deprecated `-e`/`--emacs` option. (Use `--format emacs` instead)
+* Made `progress` formatter the default.
+* Most formatters (`progress`, `simple` and `clang`) now print relative file paths if the paths are under the current working directory.
+* Migrate all cops to new namespaces. `Rubocop::Cop::Lint` is for cops that emit warnings. `Rubocop::Cop::Style` is for cops that do not belong in other namespaces.
+* Merge `FavorPercentR` and `PercentR` into one cop called `RegexpLiteral`, and add configuration parameter `MaxSlashes`.
+* Add `CountKeywordArgs` configuration option to `ParameterLists` cop.
+
+### Bugs fixed
+
+* [#239](https://github.com/bbatsov/rubocop/issues/239) - fixed double quotes false positives
+* [#233](https://github.com/bbatsov/rubocop/issues/233) - report syntax cop offences
+* Fix off-by-one error in favor_modifier.
+* [#229](https://github.com/bbatsov/rubocop/issues/229) - recognize a line with CR+LF as a blank line in AccessControl cop.
+* [#235](https://github.com/bbatsov/rubocop/issues/235) - handle multiple constant assignment in ConstantName cop
+* [#246](https://github.com/bbatsov/rubocop/issues/246) - correct handling of unicode escapes within double quotes
+* Fix crashes in Blocks, CaseEquality, CaseIndentation, ClassAndModuleCamelCase, ClassMethods, CollectionMethods, and ColonMethodCall.
+* [#263](https://github.com/bbatsov/rubocop/issues/263) - do not check for space around operators called with method syntax
+* [#271](https://github.com/bbatsov/rubocop/issues/271) - always allow line breaks inside hash literal braces
+* [#270](https://github.com/bbatsov/rubocop/issues/270) - fixed a false positive in ParenthesesAroundCondition
+* [#288](https://github.com/bbatsov/rubocop/issues/288) - get config parameter AllCops/Excludes from highest config file in path
+* [#276](https://github.com/bbatsov/rubocop/issues/276) - let columns start at 1 instead of 0 in all output of column numbers
+* [#292](https://github.com/bbatsov/rubocop/issues/292) - don't check non-regular files (like sockets, etc)
+* Fix crashes in WordArray on arrays of character literals such as `[?\r, ?\n]`
+* Fix crashes in Documentation on empty modules
+
+## 0.8.3 (18/06/2013)
+
+### Bug fixes
+
+* Lock Parser dependency to version 2.0.0.beta5.
+
+## 0.8.2 (06/05/2013)
+
+### New features
+
+* New cop `BlockNesting` checks for excessive block nesting
+
 ### Bug fixes
 
 * Correct calculation of whether a modifier version of a conditional statement will fit.
 * Fix an error in `MultilineIfThen` cop that occurred in some special cases.
+* [#231](https://github.com/bbatsov/rubocop/issues/231) - fix a false positive for modifier if
 
 ## 0.8.1 (05/30/2013)
 

data/README.md

@@ -39,14 +39,19 @@ For more details check the available command-line options:
 $ rubocop -h
 ```
 
-Command flag       | Description
--------------------|------------------------------------------------------------
-`-v/--version`     | Displays the current version and exits
-`-d/--debug`       | Displays some extra debug output
-`-e/--emacs`       | Output the results in Emacs format
-`-c/--config`      | Run with specified config file
-`-s/--silent`      | Suppress the final summary
-`--only`           | Run only the specified cop
+Command flag           | Description
+-----------------------|------------------------------------------------------------
+`-v/--version`         | Displays the current version and exits
+`-V/--verbose-version` | Displays the current version plus the version of Parser and Ruby
+`-d/--debug`           | Displays some extra debug output
+`-c/--config`          | Run with specified config file
+`-f/--format`          | Choose a formatter
+`-o/--out`             | Write output to a file instead of STDOUT
+`-r/--require`         | Require Ruby file
+`-R/--rails`           | Run extra Rails cops
+`-a/--auto-correct`    | Auto-correct certain offences.
+`-s/--silent`          | Suppress the final summary
+`--only`               | Run only the specified cop
 
 ## Configuration
 
@@ -151,7 +156,92 @@ AllCops:
 # ...
 ```
 
-Note: Files and directories are specified relative to the `.rubocop.yml` file.
+Note: Files and directories are specified relative to the
+`.rubocop.yml` file. The `Excludes` parameter is special. It is valid
+for the directory tree starting where it is defined. It is not
+shadowed by the setting of `Excludes` in other `.rubocop.yml` files in
+subdirectories.
+
+## Formatters
+
+### JSON Formatter
+
+You can get RuboCop's inspection result in JSON format by passing `--format json` option in command line.
+The JSON structure is like the following example:
+
+```javascript
+{
+  "metadata": {
+    "rubocop_version": "0.9.0",
+    "ruby_engine": "ruby",
+    "ruby_version": "2.0.0",
+    "ruby_patchlevel": "195",
+    "ruby_platform": "x86_64-darwin12.3.0"
+  },
+  "files": [{
+      "path": "lib/foo.rb",
+      "offences": []
+    }, {
+      "path": "lib/bar.rb",
+      "offences": [{
+          "severity": "convention",
+          "message": "Line is too long. [81/79]",
+          "cop_name": "LineLength",
+          "location": {
+            "line": 546,
+            "column": 80
+          }
+        }, {
+          "severity": "warning",
+          "message": "Unreachable code detected.",
+          "cop_name": "UnreachableCode",
+          "location": {
+            "line": 15,
+            "column": 9
+          }
+        }
+      ]
+    }
+  ],
+  "summary": {
+    "offence_count": 2,
+    "target_file_count": 2,
+    "inspected_file_count": 2
+  }
+}
+```
+
+### Custom Formatters
+
+You can customize RuboCop's output format with custom formatter.
+
+#### Creating Custom Formatter
+
+To implement a custom formatter, you need to subclass
+`Rubocop::Formatter::BaseFormatter` and override some methods,
+or implement all formatter API methods by duck typing.
+
+Please see the documents below for more formatter API details.
+
+* [Rubocop::Formatter::BaseFormatter](http://rubydoc.info/gems/rubocop/Rubocop/Formatter/BaseFormatter)
+* [Rubocop::Cop::Offence](http://rubydoc.info/gems/rubocop/Rubocop/Cop/Offence)
+* [Parser::Source::Range](http://rubydoc.info/github/whitequark/parser/Parser/Source/Range)
+
+#### Using Custom Formatter in Command Line
+
+You can tell RuboCop to use your custom formatter with a combination of
+`--format` and `--require` option.
+For example, when you have defined `MyCustomFormatter` in
+`./path/to/my_custom_formatter.rb`, you would type this command:
+
+```bash
+$ rubocop --require ./path/to/my_custom_formatter --format MyCustomFormatter
+```
+
+Note: The path passed to `--require` is directly passed to `Kernel.require`.
+If your custom formatter file is not in `$LOAD_PATH`,
+you need to specify the path as relative path prefixed with `./` explicitly,
+or absolute path.
 
 ## Compatibility
 
@@ -204,8 +294,8 @@ all the people who have contributed to the development of RuboCop.
 I'm extremely grateful to each and every one of them!
 
 I'd like to single out [Jonas Arvidsson](https://github.com/jonas054)
-for his many excellent code contributions as well as valuable feedback
-and ideas!
+and [Yuji Nakayama](https://github.com/yujinakayama) for their many
+excellent code contributions as well as valuable feedback and ideas!
 
 If you'd like to contribute to RuboCop, please take the time to go
 through our short

data/config/default.yml

@@ -22,9 +22,10 @@ MethodLength:
   CountComments: false  # count full line comments?
   Max: 10
 
-# Avoid parameter lists longer than four parameters.
+# Avoid parameter lists longer than five parameters.
 ParameterLists:
-  Max: 4
+  Max: 5
+  CountKeywordArgs: true
 
 # Don't use semicolons to terminate expressions.
 Semicolon:
@@ -48,3 +49,10 @@ SymbolName:
 # Avoid more than `Max` levels of nesting.
 BlockNesting:
   Max: 3
+
+# Use %r for regular expressions matching more than `MaxSlashes` '/'
+# characters.
+# Use %r only for regular expressions matching more than `MaxSlashes` '/'
+# character.
+RegexpLiteral:
+  MaxSlashes: 1

data/config/enabled.yml

@@ -173,10 +173,6 @@ MethodAndVariableSnakeCase:
 ClassAndModuleCamelCase:
   Enabled: true
 
-# Causes Ruby to check the syntax of the script and exit without executing.
-Syntax:
-  Enabled: true
-
 # Preferred collection methods.
 CollectionMethods:
   Enabled: true
@@ -261,12 +257,11 @@ OpMethod:
 ReduceArguments:
   Enabled: true
 
-# Use %r only for regular expressions matching more than one '/' character.
-PercentR:
-  Enabled: true
-
-# Use %r for regular expressions matching more than one '/' character.
-FavorPercentR:
+# Use %r for regular expressions matching more than `MaxSlashes` '/'
+# characters.
+# Use %r only for regular expressions matching more than `MaxSlashes` '/'
+# character.
+RegexpLiteral:
   Enabled: true
 
 # Use self when defining module/class methods.
@@ -297,7 +292,7 @@ TrivialAccessors:
 LeadingCommentSpace:
   Enabled: true
 
-# Do not use :: for method invocation.
+# Do not use :: for method call.
 ColonMethodCall:
   Enabled: true
 
@@ -328,3 +323,82 @@ Loop:
 # Avoid excessive block nesting
 BlockNesting:
   Enabled: true
+
+# Avoid explicit use of the case equality operator(===).
+CaseEquality:
+  Enabled: true
+
+# Document classes and non-namespace modules.
+Documentation:
+  Enabled: true
+
+# Do not use parentheses for method calls with no arguments.
+MethodCallParentheses:
+  Enabled: true
+
+# Checks for redundant do after while or until.
+WhileUntilDo:
+  Enabled: true
+
+# Checks for uses of character literals.
+CharacterLiteral:
+  Enabled: true
+
+# Avoid the use of BEGIN blocks.
+BeginBlock:
+  Enabled: true
+
+# Avoid the use of END blocks.
+EndBlock:
+  Enabled: true
+
+## Warnings
+
+# Don't use assignment in conditions.
+AssignmentInCondition:
+  Enabled: true
+  AllowSafeAssignment: true
+
+# Align ends correctly.
+EndAlignment:
+  Enabled: true
+  BlockAlignSchema: StartOfAssignment
+
+# Possible use of operator/literal/variable in void context.
+Void:
+  Enabled: true
+
+# Unreachable code.
+UnreachableCode:
+  Enabled: true
+
+# Unused local variable.
+UnusedLocalVariable:
+  Enabled: true
+
+# Do not use the same name as outer local variable
+# for block arguments or block local variables.
+ShadowingOuterLocalVariable:
+  Enabled: true
+
+# END blocks should not be placed inside method definitions.
+EndInMethod:
+  Enabled: true
+
+# Checks of literals used in conditions.
+LiteralInCondition:
+  Enabled: true
+
+# Checks the position of the dot in multi-line method calls.
+DotPosition:
+  Enabled: true
+
+# Checks for uses of Module#attr.
+Attr:
+  Enabled: true
+
+## Rails
+
+# Use sexy validations.
+Validation:
+  Enabled: true

data/lib/rubocop.rb

@@ -6,82 +6,106 @@ require 'parser/current'
 require 'ast/sexp'
 
 require 'rubocop/cop/util'
+require 'rubocop/cop/variable_inspector'
 require 'rubocop/cop/offence'
 require 'rubocop/cop/cop'
-require 'rubocop/cop/encoding'
-require 'rubocop/cop/line_length'
-require 'rubocop/cop/line_continuation'
-require 'rubocop/cop/syntax'
-require 'rubocop/cop/tab'
-require 'rubocop/cop/trailing_whitespace'
-require 'rubocop/cop/case_indentation'
-require 'rubocop/cop/empty_line_between_defs'
-require 'rubocop/cop/empty_lines'
-require 'rubocop/cop/surrounding_space'
-require 'rubocop/cop/space_after_comma_etc'
-require 'rubocop/cop/space_after_control_keyword'
-require 'rubocop/cop/hash_syntax'
-require 'rubocop/cop/end_of_line'
-require 'rubocop/cop/numeric_literals'
-require 'rubocop/cop/align_parameters'
-require 'rubocop/cop/def_parentheses'
-require 'rubocop/cop/if_then_else'
-require 'rubocop/cop/blocks'
-require 'rubocop/cop/parameter_lists'
-require 'rubocop/cop/string_literals'
-require 'rubocop/cop/ternary_operator'
-require 'rubocop/cop/unless_else'
-require 'rubocop/cop/and_or'
-require 'rubocop/cop/when_then'
-require 'rubocop/cop/favor_modifier'
-require 'rubocop/cop/favor_unless_over_negated_if'
-require 'rubocop/cop/lambda'
-require 'rubocop/cop/proc'
-require 'rubocop/cop/parentheses_around_condition'
-require 'rubocop/cop/method_and_variable_snake_case'
-require 'rubocop/cop/class_and_module_camel_case'
-require 'rubocop/cop/collection_methods'
-require 'rubocop/cop/avoid_for'
-require 'rubocop/cop/avoid_perlisms'
-require 'rubocop/cop/avoid_perl_backrefs'
-require 'rubocop/cop/avoid_global_vars'
-require 'rubocop/cop/avoid_class_vars'
-require 'rubocop/cop/symbol_name'
-require 'rubocop/cop/constant_name'
-require 'rubocop/cop/variable_interpolation'
-require 'rubocop/cop/semicolon'
-require 'rubocop/cop/favor_sprintf'
-require 'rubocop/cop/favor_join'
-require 'rubocop/cop/alias'
-require 'rubocop/cop/rescue_modifier'
-require 'rubocop/cop/ensure_return'
-require 'rubocop/cop/handle_exceptions'
-require 'rubocop/cop/rescue_exception'
-require 'rubocop/cop/ascii_identifiers'
-require 'rubocop/cop/ascii_comments'
-require 'rubocop/cop/block_comments'
-require 'rubocop/cop/empty_literal'
-require 'rubocop/cop/method_length'
-require 'rubocop/cop/op_method'
-require 'rubocop/cop/reduce_arguments'
-require 'rubocop/cop/percent_r'
-require 'rubocop/cop/favor_percent_r'
-require 'rubocop/cop/class_methods'
-require 'rubocop/cop/single_line_methods'
-require 'rubocop/cop/word_array'
-require 'rubocop/cop/symbol_array'
-require 'rubocop/cop/trivial_accessors'
-require 'rubocop/cop/leading_comment_space'
-require 'rubocop/cop/colon_method_call'
-require 'rubocop/cop/not'
-require 'rubocop/cop/eval'
-require 'rubocop/cop/access_control'
-require 'rubocop/cop/loop'
-require 'rubocop/cop/block_nesting'
 
-require 'rubocop/report/report'
-require 'rubocop/report/plain_text'
-require 'rubocop/report/emacs_style'
+require 'rubocop/cop/lint/assignment_in_condition'
+require 'rubocop/cop/lint/end_alignment'
+require 'rubocop/cop/lint/end_in_method'
+require 'rubocop/cop/lint/ensure_return'
+require 'rubocop/cop/lint/eval'
+require 'rubocop/cop/lint/handle_exceptions'
+require 'rubocop/cop/lint/literal_in_condition'
+require 'rubocop/cop/lint/loop'
+require 'rubocop/cop/lint/rescue_exception'
+require 'rubocop/cop/lint/shadowing_outer_local_variable'
+require 'rubocop/cop/lint/unreachable_code'
+require 'rubocop/cop/lint/unused_local_variable'
+require 'rubocop/cop/lint/void'
+
+require 'rubocop/cop/style/access_control'
+require 'rubocop/cop/style/alias'
+require 'rubocop/cop/style/align_parameters'
+require 'rubocop/cop/style/and_or'
+require 'rubocop/cop/style/ascii_comments'
+require 'rubocop/cop/style/ascii_identifiers'
+require 'rubocop/cop/style/attr'
+require 'rubocop/cop/style/avoid_class_vars'
+require 'rubocop/cop/style/avoid_for'
+require 'rubocop/cop/style/avoid_global_vars'
+require 'rubocop/cop/style/avoid_perl_backrefs'
+require 'rubocop/cop/style/avoid_perlisms'
+require 'rubocop/cop/style/begin_block'
+require 'rubocop/cop/style/block_comments'
+require 'rubocop/cop/style/block_nesting'
+require 'rubocop/cop/style/blocks'
+require 'rubocop/cop/style/character_literal'
+require 'rubocop/cop/style/case_equality'
+require 'rubocop/cop/style/case_indentation'
+require 'rubocop/cop/style/class_and_module_camel_case'
+require 'rubocop/cop/style/class_methods'
+require 'rubocop/cop/style/collection_methods'
+require 'rubocop/cop/style/colon_method_call'
+require 'rubocop/cop/style/constant_name'
+require 'rubocop/cop/style/def_parentheses'
+require 'rubocop/cop/style/documentation'
+require 'rubocop/cop/style/dot_position'
+require 'rubocop/cop/style/empty_line_between_defs'
+require 'rubocop/cop/style/empty_lines'
+require 'rubocop/cop/style/empty_literal'
+require 'rubocop/cop/style/encoding'
+require 'rubocop/cop/style/end_block'
+require 'rubocop/cop/style/end_of_line'
+require 'rubocop/cop/style/favor_join'
+require 'rubocop/cop/style/favor_modifier'
+require 'rubocop/cop/style/favor_sprintf'
+require 'rubocop/cop/style/favor_unless_over_negated_if'
+require 'rubocop/cop/style/hash_syntax'
+require 'rubocop/cop/style/if_then_else'
+require 'rubocop/cop/style/lambda'
+require 'rubocop/cop/style/leading_comment_space'
+require 'rubocop/cop/style/line_continuation'
+require 'rubocop/cop/style/line_length'
+require 'rubocop/cop/style/method_and_variable_snake_case'
+require 'rubocop/cop/style/method_call_parentheses'
+require 'rubocop/cop/style/method_length'
+require 'rubocop/cop/style/not'
+require 'rubocop/cop/style/numeric_literals'
+require 'rubocop/cop/style/op_method'
+require 'rubocop/cop/style/parameter_lists'
+require 'rubocop/cop/style/parentheses_around_condition'
+require 'rubocop/cop/style/proc'
+require 'rubocop/cop/style/reduce_arguments'
+require 'rubocop/cop/style/regexp_literal'
+require 'rubocop/cop/style/rescue_modifier'
+require 'rubocop/cop/style/semicolon'
+require 'rubocop/cop/style/single_line_methods'
+require 'rubocop/cop/style/space_after_comma_etc'
+require 'rubocop/cop/style/space_after_control_keyword'
+require 'rubocop/cop/style/string_literals'
+require 'rubocop/cop/style/surrounding_space'
+require 'rubocop/cop/style/symbol_array'
+require 'rubocop/cop/style/symbol_name'
+require 'rubocop/cop/style/tab'
+require 'rubocop/cop/style/ternary_operator'
+require 'rubocop/cop/style/trailing_whitespace'
+require 'rubocop/cop/style/trivial_accessors'
+require 'rubocop/cop/style/unless_else'
+require 'rubocop/cop/style/variable_interpolation'
+require 'rubocop/cop/style/when_then'
+require 'rubocop/cop/style/while_until_do'
+require 'rubocop/cop/style/word_array'
+
+require 'rubocop/cop/rails/validation'
+
+require 'rubocop/formatter/base_formatter'
+require 'rubocop/formatter/simple_text_formatter'
+require 'rubocop/formatter/emacs_style_formatter'
+require 'rubocop/formatter/clang_style_formatter'
+require 'rubocop/formatter/progress_formatter'
+require 'rubocop/formatter/json_formatter'
+require 'rubocop/formatter/formatter_set'
 
 require 'rubocop/config'
 require 'rubocop/config_store'