Add Rubocop style standards to build.

- Move custom excludes and non-ideal settings to .rubocop_todo.yml
- Inherit the todo file from the main rubocop config
- Add generic description about matcher module.

  We should consider moving the individual generator methods into this
  module. This will allow us to properly document the matchers as in
  rspec-expectations. We can also apply autoload if necessary at that
  point.

Author: cupakromer

.rubocop.yml

@@ -0,0 +1,97 @@
+inherit_from: .rubocop_todo.yml
+
+AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+# "Use alias_method instead of alias"
+# We're fine with `alias`.
+Alias:
+  Enabled: false
+
+AlignParameters:
+  EnforcedStyle: with_first_parameter
+
+# "Avoid the use of the case equality operator ==="
+# We prefer using `Class#===` over `Object#is_a?` because `Class#===`
+# is less likely to be monkey patched than `is_a?` on a user object.
+CaseEquality:
+  Enabled: false
+
+CollectionMethods:
+  PreferredMethods:
+    reduce: 'inject'
+
+# We use YARD to enforce documentation. It works better than rubocop's
+# enforcement...rubocop complains about the places we re-open
+# `RSpec::Expectations` and `RSpec::Matchers` w/o having doc commments.
+Documentation:
+  Enabled: false
+
+# We still support 1.8.7 which requires trailing dots
+DotPosition:
+  EnforcedStyle: trailing
+
+DoubleNegation:
+  Enabled: false
+
+# each_with_object is unavailable on 1.8.7 so we have to disable this one.
+EachWithObject:
+  Enabled: false
+
+Encoding:
+  EnforcedStyle: when_needed
+
+FormatString:
+  EnforcedStyle: percent
+
+# As long as we support ruby 1.8.7 we have to use hash rockets.
+HashSyntax:
+  EnforcedStyle: hash_rockets
+
+# We can't use the new lambda syntax, since we still support 1.8.7.
+Lambda:
+  Enabled: false
+
+# Who cares what we all the argument for binary operator methods?
+OpMethod:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  ()      # double-quoted string
+    '%i': '[]'    # array of symbols
+    '%q': ()      # single-quoted string
+    '%Q': ()      # double-quoted string
+    '%r': '{}'    # regular expression pattern
+    '%s': ()      # a symbol
+    '%w': '[]'    # array of single-quoted strings
+    '%W': '[]'    # array of double-quoted strings
+    '%x': ()      # a shell command as a string
+
+# We have too many special cases where we allow generator methods or prefer a
+# prefixed predicate due to it's improved readability.
+PredicateName:
+  Enabled: false
+
+# On 1.8 `proc` is `lambda`, so we use `Proc.new` to ensure we get real procs
+# on all supported versions.
+# http://batsov.com/articles/2014/02/04/the-elements-of-style-in-ruby-number-12-proc-vs-proc-dot-new/
+Proc:
+  Enabled: false
+
+RedundantReturn:
+  AllowMultipleReturnValues: true
+
+# We haven't adopted the `fail` to signal exceptions vs `raise` for re-raises
+# convention.
+SignalException:
+  Enabled: false
+
+# We don't care about single vs double qoutes.
+StringLiterals:
+  Enabled: false
+
+TrivialAccessors:
+  AllowDSLWriters: true
+  AllowPredicates: true
+  ExactNameMatch: true

.rubocop_todo.yml

@@ -0,0 +1,53 @@
+# Warns when the class is excessively long.
+ClassLength:
+  Max: 100
+
+# Over time we'd like to get this down, but this is what we're at now.
+CyclomaticComplexity:
+  Max: 10
+
+# Over time we'd like to get this down, but this is what we're at now.
+LineLength:
+  Max: 186
+
+# Over time we'd like to get this down, but this is what we're at now.
+MethodLength:
+  Max: 50
+
+################################################################################
+# Individual File Exclusions
+################################################################################
+
+AllCops:
+  Exclude:
+    # Templates are really ERB which Rubocop does not parse
+    - 'lib/generators/rspec/*/templates/**/*'
+
+FileName:
+  Exclude:
+    # I'm not sure why yet but we break convention for this one file
+    - lib/rspec-rails.rb
+
+GuardClause:
+  Exclude:
+    # This is getting triggered since the `unless` clause is the last
+    # statement, which doesn't matter since it's the initializer. If it's
+    # possible to break this up cleanly we can remove this exclude
+    - lib/rspec/rails/matchers/have_http_status.rb
+
+HandleExceptions:
+  Exclude:
+    # RSpec is tightly coupled to capybara right now, this should be
+    # re-evaluted in the future. For now we allow the empty rescue
+    - lib/rspec/rails/vendor/capybara.rb
+
+IfUnlessModifier:
+  Exclude:
+    # Allow single line statement as the style matches the remainder of the file
+    - lib/rspec/rails/vendor/capybara.rb
+
+PerlBackrefs:
+  Exclude:
+    # We probably can refactor the backref out, but for now excluding it since
+    # we can't use named matches in 1.8.7
+    - lib/generators/rspec/scaffold/scaffold_generator.rb

Gemfile

@@ -33,6 +33,8 @@ if RUBY_VERSION <= '1.8.7'
   gem 'rubyzip', '< 1.0'
 end
 
+gem 'rubocop', "~> 0.23.0", :platform => [:ruby_19, :ruby_20, :ruby_21]
+
 custom_gemfile = File.expand_path("../Gemfile-custom", __FILE__)
 eval_gemfile custom_gemfile if File.exist?(custom_gemfile)
 

Rakefile

@@ -142,3 +142,10 @@ end
 
 task :build => :verify_private_key_present
 
+if RUBY_VERSION.to_f > 1.8
+  require 'rubocop/rake_task'
+  desc 'Run RuboCop on the lib directory'
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    task.patterns = ['lib/**/*.rb']
+  end
+end

lib/generators/rspec.rb

@@ -27,10 +27,10 @@ module Generators
     class GeneratedAttribute
       def input_type
         @input_type ||= if type == :text
-          "textarea"
-        else
-          "input"
-        end
+                          "textarea"
+                        else
+                          "input"
+                        end
       end
     end
   end

lib/generators/rspec/install/install_generator.rb

@@ -6,7 +6,6 @@ module Rspec
   module Generators
     # @private
     class InstallGenerator < ::Rails::Generators::Base
-
       desc <<DESC
 Description:
     Copy rspec files to your application.

lib/generators/rspec/model/model_generator.rb

@@ -4,19 +4,32 @@ module Rspec
   module Generators
     # @private
     class ModelGenerator < Base
-      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+      argument :attributes,
+               :type => :array,
+               :default => [],
+               :banner => "field:type field:type"
       class_option :fixture, :type => :boolean
 
       def create_model_spec
-        template 'model_spec.rb', File.join('spec/models', class_path, "#{file_name}_spec.rb")
+        template_file = File.join(
+          'spec/models',
+          class_path,
+          "#{file_name}_spec.rb"
+        )
+        template 'model_spec.rb', template_file
       end
 
       hook_for :fixture_replacement
 
       def create_fixture_file
-        if options[:fixture] && options[:fixture_replacement].nil?
-          template 'fixtures.yml', File.join('spec/fixtures', "#{table_name}.yml")
-        end
+        return unless missing_fixture_replacement?
+        template 'fixtures.yml', File.join('spec/fixtures', "#{table_name}.yml")
+      end
+
+    private
+
+      def missing_fixture_replacement?
+        options[:fixture] && options[:fixture_replacement].nil?
       end
     end
   end