rubocop 0.4.0 → 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c61251297391f7ee7286eb0e4482e975a42122f
+  data.tar.gz: 4375f2e36ceaa75510f7e4cdece56d3f1e22700f
+SHA512:
+  metadata.gz: 9a6ed60555b7fbc888b9a68190c79bb525ece1e3623e1025fe833016e13b635b947b0cf49fab267ab4bf886bb0c8438bea130011a8c9dd8efa3e6e863b218b8f
+  data.tar.gz: 2f4161c9a52973931d695f900045b46b55e56d62debac661ab25308b031e383906cf33b107f8cf8f6701dba4c251cf9bac7ae49f32550aaca278bae7d556d688

data/.gitignore

@@ -0,0 +1,50 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+Gemfile.lock
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.rubocop.yml

@@ -1,129 +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.
 
-Encoding:
-  Enabled: true
+inherit_from: config/default.yml
 
-LineLength:
-  Enabled: true
-  Max: 79
-
-Tab:
-  Enabled: true
-
-TrailingWhitespace:
-  Enabled: true
-
-Indentation:
-  Enabled: true
-
-EmptyLines:
-  Enabled: true
-
-SpaceAroundOperators:
-  Enabled: true
-
-SpaceAroundBraces:
-  Enabled: true
-
-SpaceInsideParens:
-  Enabled: true
-
-SpaceInsideBrackets:
-  Enabled: true
-
-SpaceAfterComma:
-  Enabled: true
-
-SpaceAfterSemicolon:
-  Enabled: true
-
-SpaceAfterColon:
-  Enabled: true
-
-HashSyntax:
-  Enabled: true
-
-EndOfLine:
-  Enabled: true
-
-NumericLiterals:
-  Enabled: true
-
-AlignParameters:
-  Enabled: true
-
-DefWithParentheses:
-  Enabled: true
-
-DefWithoutParentheses:
-  Enabled: true
-
-IfWithSemicolon:
-  Enabled: true
-
-MultilineIfThen:
-  Enabled: true
-
-OneLineConditional:
-  Enabled: true
-
-MultilineBlocks:
-  Enabled: true
-
-SingleLineBlocks:
-  Enabled: true
-
-ParameterLists:
-  Enabled: true
-
-StringLiterals:
-  Enabled: true
-
-MultilineTernaryOperator:
-  Enabled: true
-
-NestedTernaryOperator:
-  Enabled: true
-
-UnlessElse:
-  Enabled: true
-
-AmpersandsPipesVsAndOr:
-  Enabled: true
-
-WhenThen:
-  Enabled: true
-
-IfUnlessModifier:
-  Enabled: true
-
-WhileUntilModifier:
-  Enabled: true
-
-FavorUnlessOverNegatedIf:
-  Enabled: true
-
-FavorUntilOverNegatedWhile:
-  Enabled: true
-
-SpaceAroundEqualsInParameterDefault:
-  Enabled: true
-
-NewLambdaLiteral:
-  Enabled: true
-
-ParenthesesAroundCondition:
-  Enabled: true
-
-MethodAndVariableSnakeCase:
-  Enabled: true
-
-ClassAndModuleCamelCase:
-  Enabled: true
-
-Syntax:
-  Enabled: true
-
-CollectionMethods:
-  Enabled: true
+# Avoid methods longer than 30 lines of code
+MethodLength:
+  Max: 30

data/.travis.yml

@@ -2,4 +2,10 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-script: bundle exec rspec
+  - jruby-19mode
+  - rbx-19mode
+script: bundle exec rspec
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
+    - rvm: rbx-19mode

data/CHANGELOG.md

@@ -0,0 +1,157 @@
+# Changelog
+
+## master (unreleased)
+
+### New features
+
+### Changes
+
+### Bugs fixed
+
+## 0.8.0 (05/28/2012)
+
+### Changes
+
+* Folded `ArrayLiteral` and `HashLiteral` into `EmptyLiteral` cop
+* The maximum number of params `ParameterLists` accepts in now configurable
+* Reworked `SymbolSnakeCase` into `SymbolName`, which has an option `AllowCamelCase` enabled by default.
+* Migrated from `Ripper` to the portable [Parser](https://github.com/whitequark/parser).
+
+### New features
+
+* New cop `ConstantName` checks for constant which are not using `SCREAMING_SNAKE_CASE`.
+* New cop `AccessControl` checks private/protected indentation and surrounding blank lines.
+* New cop `Loop` checks for `begin/end/while(until)` and suggests the use of `Kernel#loop`.
+
+## 0.7.2 (05/13/2013)
+
+### Bugs fixed
+
+* [#155](https://github.com/bbatsov/rubocop/issues/155) 'Do not use semicolons to terminate expressions.' is not implemented correctly
+* `OpMethod` now handles definition of unary operators without crashing.
+* `SymbolSnakeCase` now handles aliasing of operators without crashing.
+* `RescueException` now handles the splat operator `*` in a `rescue` clause without crashing.
+* [#159](https://github.com/bbatsov/rubocop/issues/159) AvoidFor cop misses many violations
+
+## 0.7.1 (05/11/2013)
+
+### Bugs fixed
+
+* Added missing files to the gemspec
+
+## 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
+
+### 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`
+* [#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
+
+### 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`.
+* Add an option to disable colors in the output.
+* Cop names are now displayed alongside messages when `-d/--debug` is passed.
+
+## 0.6.0 (04/23/2013)
+
+### New features
+
+* New cop `ReduceArguments` tracks argument names in reduce calls
+* New cop `MethodLength` tracks number of LOC (lines of code) in methods
+* New cop `RescueModifier` tracks uses of `rescue` in modifier form.
+* New cop `PercentLiterals` tracks uses of `%q`, `%Q`, `%s` and `%x`.
+* New cop `BraceAfterPercent` tracks uses of % literals with
+  delimiters other than ().
+* Support for disabling cops locally in a file with rubocop:disable comments.
+* New cop `EnsureReturn` tracks usages of `return` in `ensure` blocks.
+* New cop `HandleExceptions` tracks suppressed exceptions.
+* New cop `AsciiIdentifiersAndComments` tracks uses of non-ascii
+  characters in identifiers and comments.
+* New cop `RescueException` tracks uses of rescuing the `Exception` class.
+* New cop `ArrayLiteral` tracks uses of Array.new.
+* New cop `HashLiteral` tracks uses of Hash.new.
+* New cop `OpMethod` tracks the argument name in operator methods.
+* New cop `PercentR` tracks uses of %r literals with zero or one slash in the regexp.
+* New cop `FavorPercentR` tracks uses of // literals with more than one slash in the regexp.
+
+### 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
+* [#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
+* [#75](https://github.com/bbatsov/rubocop/issues/75) - Make it clear that some global variables require the use of the English library
+* [#79](https://github.com/bbatsov/rubocop/issues/79) - Ternary operator missing whitespace detection
+
+### Misc
+
+* Dropped Jeweler for gem release management since it's no longer
+  actively maintained.
+* Handle pluralization properly in the final summary.
+
+## 0.5.0 (04/17/2013)
+
+### New features
+
+* New cop `FavorSprintf` that checks for usages of `String#%`
+* New cop `Semicolon` that checks for usages of `;` as expression separator
+* New cop `VariableInterpolation` that checks for variable interpolation in double quoted strings
+* New cop `Alias` that checks for uses of the keyword `alias`
+* Automatically detect extensionless Ruby files with shebangs when search for Ruby source files in a directory
+
+### Bugs fixed
+
+* [#59](https://github.com/bbatsov/rubocop/issues/59) - Interpolated variables not enclosed in braces are not noticed
+* [#42](https://github.com/bbatsov/rubocop/issues/42) - Received malformed format string ArgumentError from rubocop

data/CONTRIBUTING.md

@@ -1,9 +1,16 @@
-# Contributing to Rubocop
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+# Contributing to RuboCop
+
+* Check out the latest master to make sure the feature hasn't been
+  implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't
+  requested it and/or contributed it.
 * Fork the project.
 * Start a feature/bugfix branch.
 * Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+* Make sure to add tests for it. This is important so I don't break it
+  in a future version unintentionally.
+* Update the [Changelog](CHANGELOG.md) accordingly.
+* Please try not to mess with the Rakefile, version, or history. If
+  you want to have your own version, or is otherwise necessary, that
+  is fine, but please isolate to its own commit so I can cherry-pick
+  around it.

data/Gemfile

@@ -1,12 +1,7 @@
 source 'http://rubygems.org'
 
-gem 'term-ansicolor'
+gemspec
 
-group :development do
-  gem 'rake'
-  gem 'rspec'
-  gem 'yard'
-  gem 'bundler'
-  gem 'jeweler'
-  gem 'simplecov'
+group :test do
+  gem 'coveralls', require: false
 end

data/README.md

@@ -1,8 +1,12 @@
 [![Gem Version](https://badge.fury.io/rb/rubocop.png)](http://badge.fury.io/rb/rubocop)
 [![Build Status](https://travis-ci.org/bbatsov/rubocop.png?branch=master)](https://travis-ci.org/bbatsov/rubocop)
+[![Coverage Status](https://coveralls.io/repos/bbatsov/rubocop/badge.png?branch=master)](https://coveralls.io/r/bbatsov/rubocop)
 
 # RuboCop
 
+> Role models are important. <br/>
+> -- Officer Alex J. Murphy / RoboCop
+
 **RuboCop** is a Ruby code style checker based on the
 [Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide).
 
@@ -23,7 +27,7 @@ in the current folder:
 $ rubocop
 ```
 
-Alternatively you can `rubocop` a list of files and folders to check:
+Alternatively you can pass `rubocop` a list of files and folders to check:
 
 ```bash
 $ rubocop app spec lib/something.rb
@@ -41,7 +45,8 @@ Command flag       | Description
 `-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
+`-s/--silent`      | Suppress the final summary
+`--only`           | Run only the specified cop
 
 ## Configuration
 
@@ -51,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
 
@@ -67,14 +74,158 @@ 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 directory,
+`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
+
+```ruby
+# rubocop:disable LineLength, StringLiterals
+[...]
+# rubocop:enable LineLength, StringLiterals
+```
+
+You can also disable *all* cops with
+
+```ruby
+# rubocop:disable all
+[...]
+# rubocop:enable all
+```
+
+One or more cops can be disabled on a single line with an end-of-line
+comment.
+
+```ruby
+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
+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
-analysis tooling, which makes the development of a portable code
-analyzer a daunting task.
+RuboCop supported only MRI 1.9 & MRI 2.0 prior to version 0.8. After
+RuboCop 0.8, JRuby and Rubinius in 1.9 modes are also supported.
+
+## Editor integration
+
+### Emacs
+
+[rubocop.el](https://github.com/bbatsov/rubocop-emacs) is a simple
+Emacs interface for RuboCop. It allows you to run RuboCop inside Emacs
+and quickly jump between problems in your code.
+
+[flycheck](https://github.com/lunaryorn/flycheck) > 0.9 also supports
+RuboCop and uses it by default when available.
+
+### Vim
+
+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
+RuboCop integration for your favorite editor.
+
+## Guard integration
+
+If you're fond of [Guard](https://github.com/guard/guard) you might
+like
+[guard-rubocop](https://github.com/yujinakayama/guard-rubocop). It
+allows you to automatically check Ruby code style with RuboCop when
+files are modified.
+
+## Contributors
+
+Here's a [list](https://github.com/bbatsov/rubocop/contributors) of
+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!
+
+If you'd like to contribute to RuboCop, please take the time to go
+through our short
+[contribution guidelines](CONTRIBUTING.md).
+
+Converting more of the Ruby Style Guide into RuboCop cops is our top
+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 currently supports MRI 1.9 and MRI 2.0. Support for JRuby and
-Rubinius is not planned at this point.
+RuboCop's changelog is available [here](CHANGELOG.md).
 
 ## Copyright
 

data/Rakefile

@@ -2,29 +2,15 @@
 
 require 'rubygems'
 require 'bundler'
+require 'bundler/gem_tasks'
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  $stderr.puts 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "rubocop"
-  gem.homepage = "http://github.com/bbatsov/rubocop"
-  gem.license = "MIT"
-  gem.summary = %Q{Automatic Ruby code style checking tool.}
-  gem.description = %Q{Automatic Ruby code style checking tool. Aims to enforce the community-driven Ruby Style Guide.}
-  gem.email = "bozhidar@batsov.com"
-  gem.authors = ["Bozhidar Batsov"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
 require 'rspec/core'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
@@ -37,7 +23,7 @@ task :coverage do
   Rake::Task['spec'].execute
 end
 
-task :default => :spec
+task default: :spec
 
 require 'yard'
 YARD::Rake::YardocTask.new

data/bin/rubocop

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