rubocop-rspec 0.18.1 → 1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c8a34ad0b9b0eeb621b444a9ea0ca5108fe7bbd
-  data.tar.gz: eae429b50571f8ae18345d3ce6bf647158bc13bc
+  metadata.gz: 49fdb4caa58a78596796faa90d973ac516dffa1f
+  data.tar.gz: 10a46ce312058c7611a916851dcb40c0b49205f2
 SHA512:
-  metadata.gz: a1df19a332dde5e17d88cc1ce1829248d937a19d548c56a38f48f700f65346a927b6f6182b6e2adb194706b69895594b0937bb2b76de17f7a3f8ba85c219accc
-  data.tar.gz: 90aa18dabf7f24951b73ff0deaa1d06f99448eed62f563c342b389d7dc4e65bb50a46cc669bc05a1da582fef5842c35eb84e2c69468cd55dbb58bab189638b15
+  metadata.gz: 3e27e4fb551f7c7354f3cda21bf1f3236e1f205bb1dbc69d2f30a21fb8b635bafbfac8555eb4723b5d33e437385b311d1fcb23019ec4dc439198f7752b5ae090
+  data.tar.gz: 778915e1974fae1b074d478e3a90bc9323fd199becbb17ff88d36c6f703df0e6fc48a9873381d26e28fae7f631ffa3f5bf7432afd335a7f4e55c6ba38a3b86fb

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Change log
+
+## 1.0.rc1
+
+* Update code to work with rubocop >= 0.19 ([@geniou][])
+* Split `UnitSpecNaming` cop into `RSpecDescribeClass`,
+  `RSpecDescribeMethod` and `RSpecFileName` and enabled them all by
+  default. ([@geniou][])
+* Add `RSpecExampleWording` cop to prevent to use of should at the
+  beginning of the spec description. ([@geniou][])
+* Fix `RSpecFileName` cop for non-class specs. ([@geniou][])
+* Adapt `RSpecFileName` cop to commen naming convention and skip spec
+  with multiple top level describes. ([@geniou][])
+* Add `RSpecMultipleDescribes` cop to check for multiple top level
+  describes. ([@geniou][])
+* Add `RSpecDescribedClass` to promote the use of `described_class`.
+  ([@geniou][])
+* Add `RSpecInstanceVariable` cop to check for the usage of instance
+  variables. ([@geniou][])
+
+<!-- Contributors -->
+
+[@geniou]: https://github.com/geniou
+[@nevir]: https://github.com/nevir

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    rubocop-rspec (0.18.1)
-      rubocop (~> 0.18)
+    rubocop-rspec (1.0.rc1)
+      rubocop (~> 0.19, >= 0.19)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (1.1.0)
+    ast (2.0.0)
     columnize (0.3.6)
     coveralls (0.7.0)
       multi_json (~> 1.3)
@@ -27,8 +27,8 @@ GEM
     json (1.8.1)
     mime-types (2.1)
     multi_json (1.8.4)
-    parser (2.1.4)
-      ast (~> 1.1)
+    parser (2.1.9)
+      ast (>= 1.1, < 3.0)
       slop (~> 3.4, >= 3.4.5)
     powerpack (0.0.9)
     racc (1.4.11)
@@ -54,11 +54,13 @@ GEM
       rubinius-debugger (~> 2.0)
       rubinius-profiler (~> 2.0)
     rubinius-profiler (2.0.1)
-    rubocop (0.18.1)
+    rubocop (0.21.0)
       json (>= 1.7.7, < 2)
-      parser (~> 2.1.3)
+      parser (~> 2.1.9)
       powerpack (~> 0.0.6)
       rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.5.1)
     rubysl (2.0.15)
       rubysl-abbrev (~> 2.0)
       rubysl-base64 (~> 2.0)
@@ -266,7 +268,7 @@ GEM
       multi_json
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
-    slop (3.4.7)
+    slop (3.5.0)
     term-ansicolor (1.2.2)
       tins (~> 0.8)
     thor (0.18.1)

data/README.md

@@ -29,6 +29,25 @@ end
 ```
 
 
+The Cops
+--------
+
+**WARNING: Cop names are under flux and will likely change in the near future.**
+We're hoping to [introduce namespaces](bbatsov/rubocop#1097) into the mix.
+
+All cops are located under [`lib/rubocop/cop`](lib/rubocop/cop), and contain
+examples/documentation.
+
+In your `.rubocop.yml`, you may treat the RSpec cops just like any other cop.
+For example:
+
+```yaml
+RSpecFileName:
+  Exclude:
+  - spec/my_poorly_named_spec_file.rb
+```
+
+
 License
 -------
 

data/config/default.yml

@@ -1,5 +1,27 @@
-UnitSpecNaming:
-  Description: 'Check that RSpec unit tests conform to a naming scheme.'
-  Enabled: false
-  EnforceDescribeStatement: true
-  EnforceFilenames: true
+RSpecDescribeClass:
+  Description: 'Check that the first argument to the top level describe is the tested class or module.'
+  Enabled: true
+
+RSpecDescribedClass:
+  Description: 'Use `described_class` for tested class / module'
+  Enabled: true
+
+RSpecDescribeMethod:
+  Description: 'Checks that the second argument to top level describe is the tested method name.'
+  Enabled: true
+
+RSpecExampleWording:
+  Description: 'Do not use should when describing your tests.'
+  Enabled: true
+
+RSpecMultipleDescribes:
+  Description: 'Checks for multiple top level describes.'
+  Enabled: true
+
+RSpecInstanceVariable:
+  Description: 'Checks for the usage of instance variables.'
+  Enabled: true
+
+RSpecFileName:
+  Description: 'Checks the file and folder naming of the spec file.'
+  Enabled: true

data/lib/rubocop-rspec.rb

@@ -4,10 +4,15 @@ require 'rubocop'
 
 require 'rubocop/rspec/version'
 require 'rubocop/rspec/inject'
+require 'rubocop/rspec/top_level_describe'
 
 Rubocop::RSpec::Inject.defaults!
 
-# We are housing ourselves directly into RuboCop's module structure. This is
-# less than ideal, but until RuboCop directly supports plugins, we can avoid
-# breaking too many assumptions.
-require 'rubocop/cop/rspec/unit_spec_naming'
+# cops
+require 'rubocop/cop/rspec_describe_class'
+require 'rubocop/cop/rspec_describe_method'
+require 'rubocop/cop/rspec_described_class'
+require 'rubocop/cop/rspec_example_wording'
+require 'rubocop/cop/rspec_file_name'
+require 'rubocop/cop/rspec_instance_variable'
+require 'rubocop/cop/rspec_multiple_describes'

data/lib/rubocop/cop/rspec_describe_class.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    # Check that the first argument to the top level describe is the tested
+    # class or module.
+    #
+    # @example
+    #   # bad
+    #   describe 'Do something' do
+    #   end
+    #
+    #   # good
+    #   describe TestedClass do
+    #   end
+    class RSpecDescribeClass < Cop
+      include RSpec::TopLevelDescribe
+
+      MESSAGE = 'The first argument to describe should be the class or ' \
+                'module being tested.'
+
+      def on_top_level_describe(_node, args)
+        return if args.first && args.first.type == :const
+        add_offense(args.first, :expression, MESSAGE)
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec_describe_method.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    # Checks that the second argument to the top level describe is the tested
+    # method name.
+    #
+    # @example
+    #   # bad
+    #   describe MyClass, 'do something' do
+    #   end
+    #
+    #   # good
+    #   describe MyClass, '#my_instance_method' do
+    #   end
+    #
+    #   describe MyClass, '.my_class_method' do
+    #   end
+    class RSpecDescribeMethod < Cop
+      include RSpec::TopLevelDescribe
+
+      MESSAGE = 'The second argument to describe should be the method being ' \
+                "tested. '#instance' or '.class'"
+      METHOD_STRING_MATCHER = /^[\#\.].+/
+
+      def on_top_level_describe(_node, args)
+        second_arg = args[1]
+        return unless second_arg
+        return if METHOD_STRING_MATCHER =~ second_arg.children.first
+
+        add_offense(second_arg, :expression, MESSAGE)
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec_described_class.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    # If the first argument of describe is a class, the class is exposed to
+    # each example via described_class - this should be used instead of
+    # repeating the class.
+    #
+    # @example
+    #   # bad
+    #   describe MyClass do
+    #     subject { MyClass.do_something }
+    #   end
+    #
+    #   # good
+    #   describe MyClass do
+    #     subject { described_class.do_something }
+    #   end
+    class RSpecDescribedClass < Cop
+      include RSpec::TopLevelDescribe
+
+      MESSAGE = 'Use `described_class` instead of `%s`'
+
+      def on_block(node)
+        method, _args, body = *node
+        return unless top_level_describe?(method)
+
+        _receiver, method_name, object = *method
+        return unless method_name == :describe
+        return unless object && object.type == :const
+
+        inspect_children(body, object)
+      end
+
+      private
+
+      def inspect_children(node, object)
+        return unless node.is_a? Parser::AST::Node
+        return if scope_change?(node) || node.type == :const
+
+        node.children.each do |child|
+          if child == object
+            name =  object.loc.expression.source
+            add_offense(child, :expression, format(MESSAGE, name))
+            break
+          end
+          inspect_children(child, object)
+        end
+      end
+
+      def scope_change?(node)
+        [:def, :class, :module].include?(node.type)
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec_example_wording.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    # Do not use should when describing your tests.
+    # see: http://betterspecs.org/#should
+    #
+    # @example
+    #   # bad
+    #   it 'should find nothing' do
+    #   end
+    #
+    #   # good
+    #   it 'finds nothing' do
+    #   end
+    class RSpecExampleWording < Cop
+      MSG = 'Do not use should when describing your tests.'
+
+      def on_block(node)
+        method, _, _ = *node
+        _, method_name, *args = *method
+
+        return unless method_name == :it
+
+        arguments = *(args.first)
+        message = arguments.first.to_s
+        return unless message.start_with?('should')
+
+        add_offense(method, :selector, MSG)
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec_file_name.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    # Checks the path of the spec file and enforces that it reflects the
+    # described class/module.
+    #
+    # @example
+    #   class/method_spec.rb
+    #   class_spec.rb
+    class RSpecFileName < Cop
+      include RSpec::TopLevelDescribe
+
+      MESSAGE = 'Spec path should end with `%s`'
+      METHOD_STRING_MATCHER = /^[\#\.].+/
+
+      def on_top_level_describe(node, args)
+        return unless single_top_level_describe?
+        object = const_name(args.first)
+        return unless object
+
+        glob_matcher = matcher(object, args[1])
+        return if source_filename =~ regexp_from_glob(glob_matcher)
+
+        add_offense(node, :expression, format(MESSAGE, glob_matcher))
+      end
+
+      private
+
+      def matcher(object, method)
+        method_string = method ? method.children.first.gsub(/\W+/, '') : nil
+        path = [File.join(path_parts(object)), method_string].compact.join('_')
+        "#{path}*_spec.rb"
+      end
+
+      def path_parts(object)
+        object.split('::').map do |part|
+          camel_to_underscore(part)
+        end
+      end
+
+      def source_filename
+        processed_source.buffer.name
+      end
+
+      def camel_to_underscore(string)
+        string.dup.tap do |result|
+          result.gsub!(/([^A-Z])([A-Z]+)/,       '\\1_\\2')
+          result.gsub!(/([A-Z]{2,})([A-Z][^A-Z]+)/, '\\1_\\2')
+          result.downcase!
+        end
+      end
+
+      def regexp_from_glob(glob)
+        Regexp.new(glob.gsub('.', '\\.').gsub('*', '.*') + '$')
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec_instance_variable.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    # When you have to assign a variable instead of using an instance variable,
+    # use let.
+    #
+    # @example
+    #   # bad
+    #   describe MyClass do
+    #     before { @foo = [] }
+    #     it { expect(@foo).to be_emtpy }
+    #   end
+    #
+    #   # good
+    #   describe MyClass do
+    #     let(:foo) { [] }
+    #     it { expect(foo).to be_emtpy }
+    #   end
+    class RSpecInstanceVariable < Cop
+      MESSAGE = 'Use `let` instead of an instance variable'
+      EXAMPLE_GROUP_METHODS = [
+        :example_group, :describe, :context, :xdescribe, :xcontext, :fdescribe,
+        :fcontext, :shared_examples, :shared_context, :share_examples_for,
+        :shared_examples_for, :feature
+      ]
+
+      def on_block(node)
+        method, _args, _body = *node
+        _receiver, method_name, _object = *method
+        @in_spec = true if EXAMPLE_GROUP_METHODS.include?(method_name)
+      end
+
+      def on_ivar(node)
+        add_offense(node, :expression, MESSAGE) if @in_spec
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec_multiple_describes.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    # Checks for multiple top level describes. They should be nested if it is
+    # for the same class or module or seperated into different files.
+    #
+    # @example
+    #   # bad
+    #   describe MyClass, '.do_someting' do
+    #   end
+    #   describe MyClass, '.do_someting_else' do
+    #   end
+    #
+    #   #good
+    #   describe MyClass
+    #     describe '.do_someting' do
+    #     end
+    #     describe '.do_someting_else' do
+    #     end
+    #   end
+    class RSpecMultipleDescribes < Cop
+      include RSpec::TopLevelDescribe
+
+      MESSAGE = 'Do not use multiple top level describes - try to nest them.'
+
+      def on_top_level_describe(node, _args)
+        return if single_top_level_describe?
+        return unless top_level_nodes.first == node
+
+        add_offense(node, :expression, MESSAGE)
+      end
+    end
+  end
+end