rubocop 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59160d74a2b79a8d6402bca657745ea9aadaf27c
-  data.tar.gz: 074abc5e163cfff8ad8c3f11fc61bbf309be6515
+  metadata.gz: 821a707cffadfcc5e7996087447ced23fb3d3767
+  data.tar.gz: 0c2efc8203808c7b7b04fdf94c6c5d587b2fdcaa
 SHA512:
-  metadata.gz: 84391e7848783db7aeaf55918c3ef7c93819f7329a1d22cbaf1cc072d62b02494d1e9a87b71d0fa79f620cf3368be3f96b314d69f5f6633962714be57126c58a
-  data.tar.gz: aedd8920e0a1ab20d364c149283f9954c4f15b33054de3e53edfd3364817a1af23c852167256fd1e3c95f38da49398c63a780b270581df077cff12026f3b892e
+  metadata.gz: 19fab984add9357970945fd82006ac71069958b117979b0fef6d3aade60111eec6c10d213e73a82a180a3cf87225d2a4db6341827f36d556b57570a4147c6613
+  data.tar.gz: 6c222ea27957f3cb861fd3ccf31a0795a8a8cd46b0e2d5712aa0d5bebe92a5cfa442f275599ab7810d739019941a4f2cc961c2269548dfa13fd0d7e1744ee391

data/.rubocop.yml

@@ -1,269 +1,7 @@
-# This is the default configuration file with all checking enabled. It is also
-# the configuration used to check the rubocop source code.
+# This is the configuration used to check the rubocop source code.
 
-# Use UTF-8 as the source file encoding.
-Encoding:
-  Enabled: true
+inherit_from: config/default.yml
 
-# Limit lines to 80 characters.
-LineLength:
-  Enabled: true
-  Max: 79
-
-# Avoid methods longer than 10 lines of code 
+# Avoid methods longer than 30 lines of code
 MethodLength:
-  Enabled: true
-  CountComments: false  # count full line comments?
-  Max: 65
-
-# No hard tabs.
-Tab:
-  Enabled: true
-
-# Avoid trailing whitespace.
-TrailingWhitespace:
-  Enabled: true
-
-# Indent when as deep as case.
-Indentation:
-  Enabled: true
-
-# Use empty lines between defs.
-EmptyLines:
-  Enabled: true
-
-# Use spaces around operators.
-SpaceAroundOperators:
-  Enabled: true
-
-# Use spaces around { and before }.
-SpaceAroundBraces:
-  Enabled: true
-
-# No spaces after ( or before ).
-SpaceInsideParens:
-  Enabled: true
-
-# No spaces after [ or before ].
-SpaceInsideBrackets:
-  Enabled: true
-
-# Use spaces after commas.
-SpaceAfterComma:
-  Enabled: true
-
-# Use spaces after semicolons.
-SpaceAfterSemicolon:
-  Enabled: true
-
-# Use spaces after colons.
-SpaceAfterColon:
-  Enabled: true
-
-# Prefer symbols instead of strings as hash keys.
-HashSyntax:
-  Enabled: true
-
-# Use Unix-style line endings.
-EndOfLine:
-  Enabled: true
-
-# Add underscores to large numeric literals to improve their readability.
-NumericLiterals:
-  Enabled: true
-
-# Align the parameters of a method call if they span more than one line.
-AlignParameters:
-  Enabled: true
-
-# Use def with parentheses when there are arguments.
-DefWithParentheses:
-  Enabled: true
-
-# Omit the parentheses when the method doesn't accept any arguments.
-DefWithoutParentheses:
-  Enabled: true
-
-# Never use if x; .... Use the ternary operator instead.
-IfWithSemicolon:
-  Enabled: true
-
-# Never use then for multi-line if/unless.
-MultilineIfThen:
-  Enabled: true
-
-# Favor the ternary operator(?:) over if/then/else/end constructs.
-OneLineConditional:
-  Enabled: true
-
-# Avoid using {...} for multi-line blocks (multiline chaining is always ugly).
-MultilineBlocks:
-  Enabled: true
-
-# Prefer {...} over do...end for single-line blocks.
-SingleLineBlocks:
-  Enabled: true
-
-# Avoid parameter lists longer than three or four parameters.
-ParameterLists:
-  Enabled: true
-
-# Prefer ' strings when you don't need string interpolation or special symbols.
-StringLiterals:
-  Enabled: true
-
-# Avoid multi-line ?: (the ternary operator); use if/unless instead.
-MultilineTernaryOperator:
-  Enabled: true
-
-# Use one expression per branch in a ternary operator.
-NestedTernaryOperator:
-  Enabled: true
-
-# Never use unless with else. Rewrite these with the positive case first.
-UnlessElse:
-  Enabled: true
-
-# Use &&/|| for boolean expressions, and/or for control flow.
-AmpersandsPipesVsAndOr:
-  Enabled: true
-
-# Use when x then ... for one-line cases.
-WhenThen:
-  Enabled: true
-
-# Favor modifier if/unless usage when you have a single-line body.
-IfUnlessModifier:
-  Enabled: true
-
-# Favor modifier while/until usage when you have a single-line body.
-WhileUntilModifier:
-  Enabled: true
-
-# Favor unless over if for negative conditions (or control flow or).
-FavorUnlessOverNegatedIf:
-  Enabled: true
-
-# Favor until over while for negative conditions.
-FavorUntilOverNegatedWhile:
-  Enabled: true
-
-# Use spaces around the = operator when assigning default values in def params.
-SpaceAroundEqualsInParameterDefault:
-  Enabled: true
-
-# Use the new lambda literal syntax.
-NewLambdaLiteral:
-  Enabled: true
-
-# Don't use parentheses around the condition of an if/unless/while.
-ParenthesesAroundCondition:
-  Enabled: true
-
-# Use snake_case for symbols, methods and variables.
-MethodAndVariableSnakeCase:
-  Enabled: true
-
-# Use CamelCase for classes and modules.
-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
-
-# Prefer each over for.
-AvoidFor:
-  Enabled: true
-
-# Avoid Perl-style global variables.
-AvoidPerlisms:
-  Enabled: true
-
-# Avoid Perl-style regex back references.
-AvoidPerlBackrefs:
-  Enabled: true
-
-# Avoid the use of class variables.
-AvoidClassVars:
-  Enabled: true
-
-# Symbol literals should use snake_case.
-SymbolSnakeCase:
-  Enabled: true
-
-# Don't interpolate global, instance and class variables directly in strings.
-VariableInterpolation:
-  Enabled: true
-
-# Don't use semicolons to terminate expressions.
-Semicolon:
-  Enabled: true
-
-# Use sprintf instead of %
-FavorSprintf:
-  Enabled: true
-
-# Use alias_method instead of alias.
-Alias:
-  Enabled: true
-
-# Avoid using rescue in its modifier form.
-RescueModifier:
-  Enabled: true
-
-# Avoid the use of %q, %Q, %s and %x.
-PercentLiterals:
-  Enabled: true
-
-# Prefer () as delimiters for all % literals.
-BraceAfterPercent:
-  Enabled: true
-
-# Never use return in an ensure block.
-EnsureReturn:
-  Enabled: true
-
-# Don't suppress exception.
-HandleExceptions:
-  Enabled: true
-
-# Use only ascii symbols in identifiers.
-AsciiIdentifiers:
-  Enabled: true
-
-# Use only ascii symbols in comments.
-AsciiComments:
-  Enabled: true
-
-# Avoid rescuing the Exception class.
-RescueException:
-  Enabled: true
-
-# Prefer array literal to Array.new.
-ArrayLiteral:
-  Enabled: true
-
-# Prefer hash {} literail to Hash.new.
-HashLiteral:
-  Enabled: true
-
-# When defining binary operators, name the argument other.
-OpMethod:
-  Enabled: true
-
-# Name reduce arguments |a, e| (accumulator, element)
-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:
-  Enabled: true
+  Max: 30

data/CHANGELOG.md

@@ -6,25 +6,67 @@
 
 ### Bugs fixed
 
+## 0.7.0 (05/11/2013)
+
+### New features
+
+* Added ability to include or exclude files/directories through `.rubocop.yml`
+* Added option --only for running a single cop.
+* Relax semicolon rule for one line methods, classes and modules
+* Configuration files, such as `.rubocop.yml`, can now include configuration from other files through the `inherit_from` directive. All configuration files implicitly inherit from `config/default.yml`.
+* New cop `ClassMethods` checks for uses for class/module names in definitions of class/module methods
+* New cop `SingleLineMethods` checks for methods implemented on a single line
+* New cop `FavorJoin` checks for usages of `Array#*` with a string argument
+* New cop `BlockComments` tracks uses of block comments(`=begin/=end` comments)
+* New cop `EmptyLines` tracks consecutive blank lines
+* New cop `WordArray` tracks arrays of words.
+* [#108](https://github.com/bbatsov/rubocop/issues/108) New cop `SpaceInsideHashLiteralBraces` checks for spaces inside hash literal braces - style is configurable
+* New cop `LineContinuation` tracks uses of the line continuation character (`\`)
+* New cop `SymbolArray` tracks arrays of symbols.
+* Print warnings for unrecognized names in configuration files.
+* New cop `TrivialAccessors` tracks method definitions that could be automatically generated with `attr_*` methods.
+* New cop `LeadingCommentSpace` checks for missing space after `#` in comments.
+* New cop `ColonMethodCall` tracks uses of `::` for method calls.
+* New cop `AvoidGlobalVars` tracks uses of non built-in global variables.
+* New cop `SpaceAfterControlKeyword` tracks missing spaces after `if/elsif/case/when/until/unless/while`.
+* New cop `Not` tracks uses of the `not` keyword.
+* New cop `Eval` tracks uses of the `eval` function.
+
+### Bugs fixed
+
+* [#101](https://github.com/bbatsov/rubocop/issues/101) `SpaceAroundEqualsInParameterDefault` doesn't work properly with empty string
+* Fix `BraceAfterPercent` for `%W`, `%i` and `%I` and added more tests
+* Fix a false positive in the `Alias` cop. `:alias` is no longer treated as keyword
+* `ArrayLiteral` now properly detects `Array.new`
+* `HashLiteral` now properly detects `Hash.new`
+* `VariableInterpolation` now detects regexp back references and doesn't crash.
+* Don't generate pathnames like some/project//some.rb
+* [#151](https://github.com/bbatsov/rubocop/issues/151) Don't print the unrecognized cop warning several times for the same `.rubocop.yml`
+
+### Misc
+
+* Renamed `Indentation` cop to `CaseIndentation` to avoid confusion
+* Renamed `EmptyLines` cop to `EmptyLineBetweenDefs` to avoid confusion
+
 ## 0.6.1 (04/28/2013)
 
 ### New features
 
-* Split AsciiIdentifiersAndComments cop in two separate cops
+* Split `AsciiIdentifiersAndComments` cop in two separate cops
 
 ### Bugs fixed
 
-* [#90](https://github.com/bbatsov/rubocop/issues/90) Two cops crash when scanning code using super
-* [#93](https://github.com/bbatsov/rubocop/issues/93) Issue with whitespace?': undefined method
+* [#90](https://github.com/bbatsov/rubocop/issues/90) Two cops crash when scanning code using `super`
+* [#93](https://github.com/bbatsov/rubocop/issues/93) Issue with `whitespace?': undefined method`
 * [#97](https://github.com/bbatsov/rubocop/issues/97) Build fails
-* [#100](https://github.com/bbatsov/rubocop/issues/100) OpMethod cop doesn't work if method arg is not in braces
-* SymbolSnakeCase now tracks Ruby 1.9 hash labels as well as regular symbols
+* [#100](https://github.com/bbatsov/rubocop/issues/100) `OpMethod` cop doesn't work if method arg is not in braces
+* `SymbolSnakeCase` now tracks Ruby 1.9 hash labels as well as regular symbols
 
 ### Misc
 
 * [#88](https://github.com/bbatsov/rubocop/issues/88) Abort gracefully when interrupted with Ctrl-C
 * No longer crashes on bugs within cops. Now problematic checks are skipped and a message is displayed.
-* Replaced Term::ANSIColor with Rainbow.
+* Replaced `Term::ANSIColor` with `Rainbow`.
 * Add an option to disable colors in the output.
 * Cop names are now displayed alongside messages when `-d/--debug` is passed.
 
@@ -53,7 +95,7 @@
 ### Bugs fixed
 
 * [#62](https://github.com/bbatsov/rubocop/issues/62) - Config files in ancestor directories are ignored if another exists in home directory
-* [#65](https://github.com/bbatsov/rubocop/issues/65) - Suggests to convert symbols :==, :<=> and the like to snake_case
+* [#65](https://github.com/bbatsov/rubocop/issues/65) - Suggests to convert symbols `:==`, `:<=>` and the like to snake_case
 * [#66](https://github.com/bbatsov/rubocop/issues/66) - Does not crash on unreadable or unparseable files
 * [#70](https://github.com/bbatsov/rubocop/issues/70) - Support `alias` with bareword arguments
 * [#64](https://github.com/bbatsov/rubocop/issues/64) - Performance issue with Bundler

data/README.md

@@ -46,6 +46,7 @@ Command flag       | Description
 `-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
 
 ## Configuration
 
@@ -55,11 +56,13 @@ configuration file. The file can be placed either in your home folder
 or in some project folder.
 
 RuboCop will start looking for the configuration file in the directory
-it was started in and continue its way up to the home folder.
+where the inspected file is and continue its way up to the root folder.
 
 The file has the following format:
 
-```yml
+```yaml
+inherit_from: ../.rubocop.yml
+
 Encoding:
   Enabled: true
 
@@ -71,6 +74,34 @@ LineLength:
 It allows to enable/disable certain cops (checks) and to alter their
 behavior if they accept any parameters.
 
+The optional `inherit_from` directive is used to include configuration
+from one or more files. This makes it possible to have the common
+project settings in the `.rubocop.yml` file at the project root, and
+then only the deviations from those rules in the subdirectories. The
+included files can be given with absolute paths or paths relative to
+the file where they are referenced. The settings after an
+`inherit_from` directive override any settings in the included
+file(s). When multiple files are included, the first file in the list
+has the lowest precedence and the last one has the highest. The format
+for multiple inclusion is:
+
+```yaml
+inherit_from:
+  - ../.rubocop.yml
+  - ../conf/.rubocop.yml
+```
+
+### Defaults
+
+The file `config/default.yml` under the RuboCop home directory
+contains the default settings that all configurations inherit
+from. Project and personal `.rubocop.yml` files need only make
+settings that are different from the default ones. If there is no
+`.rubocop.yml` file in the project or home direcotry,
+`config/default.yml` will be used.
+
+### Disabling Cops within Source Code
+
 One or more individual cops can be disabled locally in a section of a
 file by adding a comment such as
 
@@ -95,6 +126,33 @@ comment.
 for x in (0..19) # rubocop:disable AvoidFor
 ```
 
+### Including/Excluding files
+
+RuboCop checks all files recursively within the directory it is run
+on.  However, it does not recognize some files as Ruby(only files
+ending with `.rb` or extensionless files with a `#!.*ruby` declaration
+are automatically detected) files, and if you'd like it to check these
+you'll need to manually pass them in.  Files and directories can be
+also be ignored through `.rubocop.yml`.
+
+Here is an example that might be used for a Rails project:
+
+```yaml
+AllCops:
+  Includes:
+    - Rakefile
+    - config.ru
+  Excludes:
+    - db/**
+    - config/**
+    - script/**
+
+# other configuration
+# ...
+```
+
+Note: Files and directories are specified relative to the `.rubocop.yml` file.
+
 ## Compatibility
 
 Unfortunately every major Ruby implementation has its own code
@@ -120,6 +178,15 @@ RuboCop and uses it by default when available.
 The [vim-rubocop](https://github.com/ngmy/vim-rubocop) plugin runs
 RuboCop and displays the results in Vim.
 
+There's also a RuboCop checker in
+[syntastic](https://github.com/scrooloose/syntastic).
+
+### Sublime Text 2
+
+If you're a ST2 user you might find the
+[Sublime RuboCop plugin](https://github.com/pderichs/sublime_rubocop)
+useful.
+
 ### Other Editors
 
 Here's one great opportunity to contribute to RuboCop - implement
@@ -154,6 +221,12 @@ priority right now. Writing a new cop is a great way to dive into RuboCop!
 Of course, bug reports and suggestions for improvements are always
 welcome. GitHub pull requests are even better! :-)
 
+## Mailing List
+
+If you're interested in everything regarding RuboCop's development,
+consider joining its
+[Google Group](https://groups.google.com/forum/?fromgroups#!forum/rubocop).
+
 ## Changelog
 
 RuboCop's changelog is available [here](CHANGELOG.md).