rubocop-rspec 0.18.1 → 1.0.rc1

data/spec/rubocop/cop/rspec_multiple_describes_spec.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::RSpecMultipleDescribes do
+  subject(:cop) { described_class.new }
+
+  it 'finds multiple top level describes with class and method' do
+    inspect_source(cop, ["describe MyClass, '.do_something' do; end",
+                         "describe MyClass, '.do_something_else' do; end"])
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line).sort).to eq([1])
+    expect(cop.messages).to eq(['Do not use multiple top level describes - ' \
+                                'try to nest them.'])
+  end
+
+  it 'finds multiple top level describes only with class' do
+    inspect_source(cop, ['describe MyClass do; end',
+                         'describe MyOtherClass do; end'])
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line).sort).to eq([1])
+    expect(cop.messages).to eq(['Do not use multiple top level describes - ' \
+                                'try to nest them.'])
+  end
+
+  it 'skips single top level describe' do
+    inspect_source(cop, ["require 'spec_helper'",
+                         '',
+                         'describe MyClass do; end'])
+    expect(cop.offenses).to be_empty
+  end
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 1.0.rc1
 platform: ruby
 authors:
 - Ian MacLeod
+- Nils Gemeinhardt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-05 00:00:00.000000000 Z
+date: 2014-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,25 +17,33 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.19'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.19'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.19'
 description: |2
       Code style checking for RSpec files.
       A plugin for the RuboCop code style enforcing & linting tool.
 email:
 - ian@nevir.net
+- git@nilsgemeinhardt.de
 executables: []
 extensions: []
 extra_rdoc_files:
 - MIT-LICENSE.md
 - README.md
 files:
+- CHANGELOG.md
 - config/default.yml
 - coverage/assets/0.8.0/application.css
 - coverage/assets/0.8.0/application.js
@@ -63,8 +72,15 @@ files:
 - coverage/index.html
 - Gemfile
 - Gemfile.lock
-- lib/rubocop/cop/rspec/unit_spec_naming.rb
+- lib/rubocop/cop/rspec_describe_class.rb
+- lib/rubocop/cop/rspec_describe_method.rb
+- lib/rubocop/cop/rspec_described_class.rb
+- lib/rubocop/cop/rspec_example_wording.rb
+- lib/rubocop/cop/rspec_file_name.rb
+- lib/rubocop/cop/rspec_instance_variable.rb
+- lib/rubocop/cop/rspec_multiple_describes.rb
 - lib/rubocop/rspec/inject.rb
+- lib/rubocop/rspec/top_level_describe.rb
 - lib/rubocop/rspec/version.rb
 - lib/rubocop-rspec.rb
 - MIT-LICENSE.md
@@ -72,10 +88,17 @@ files:
 - pkg/rubocop-rspec-0.17.0.gem
 - pkg/rubocop-rspec-0.18.0.gem
 - pkg/rubocop-rspec-0.18.1.gem
+- pkg/rubocop-rspec-1.0.rc1.gem
 - Rakefile
 - README.md
 - rubocop-rspec.gemspec
-- spec/rubocop/cop/rspec/unit_spec_naming_spec.rb
+- spec/rubocop/cop/rspec_describe_class_spec.rb
+- spec/rubocop/cop/rspec_describe_method_spec.rb
+- spec/rubocop/cop/rspec_described_class_spec.rb
+- spec/rubocop/cop/rspec_example_wording_spec.rb
+- spec/rubocop/cop/rspec_file_name_spec.rb
+- spec/rubocop/cop/rspec_instance_variable_spec.rb
+- spec/rubocop/cop/rspec_multiple_describes_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/nevir/rubocop-rspec
 licenses:
@@ -92,9 +115,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.3
@@ -102,5 +125,11 @@ signing_key:
 specification_version: 4
 summary: Code style checking for RSpec files
 test_files:
-- spec/rubocop/cop/rspec/unit_spec_naming_spec.rb
+- spec/rubocop/cop/rspec_describe_class_spec.rb
+- spec/rubocop/cop/rspec_describe_method_spec.rb
+- spec/rubocop/cop/rspec_described_class_spec.rb
+- spec/rubocop/cop/rspec_example_wording_spec.rb
+- spec/rubocop/cop/rspec_file_name_spec.rb
+- spec/rubocop/cop/rspec_instance_variable_spec.rb
+- spec/rubocop/cop/rspec_multiple_describes_spec.rb
 - spec/spec_helper.rb

data/lib/rubocop/cop/rspec/unit_spec_naming.rb

@@ -1,144 +0,0 @@
-# encoding: utf-8
-
-module Rubocop
-  module Cop
-    module RSpec
-      # This cop checks that RSpec unit tests conform to a consistent naming
-      # scheme - both for the describe call, and the file path.
-      #
-      # Disabled by default. Generally, you want to scope it to your project's
-      # unit spec paths:
-      #
-      #   UnitSpecNaming:
-      #     Enabled: true
-      #     Include:
-      #       - 'spec/rubocop/*'
-      #
-      class UnitSpecNaming < Cop
-        DESCRIBE_CLASS_MSG = 'The first argument to describe should be the ' \
-                             'class or module being tested.'
-
-        METHOD_STRING_MSG = 'The second argument to describe should be the ' \
-                            "method being tested. '#instance' or '.class'"
-
-        CLASS_SPEC_MSG = 'Class unit spec should have a path ending with %s'
-
-        METHOD_SPEC_MSG = 'Unit spec should have a path matching %s'
-
-        METHOD_STRING_MATCHER = /^[\#\.].+/
-
-        def on_send(node)
-          return unless top_level_describe? node
-          _receiver, _method_name, *args = *node
-          # Ignore non-string args (RSpec metadata)
-          args = [args.first] + args[1..-1].select { |a| a.type == :str }
-
-          if cop_config['EnforceDescribeStatement']
-            enforce_describe_statement(node, args)
-          end
-
-          if offences.size == 0 && cop_config['EnforceFilenames']
-            enforce_filename(node, args)
-          end
-        end
-
-        private
-
-        def enforce_describe_statement(node, args)
-          check_described_class(node, args.first)
-          check_described_method(node, args[1])
-        end
-
-        def enforce_filename(node, args)
-          path_parts = const_name(args.first).split('::').map do |part|
-            camel_to_underscore(part)
-          end
-
-          if !args[1]
-            check_class_spec(node, path_parts)
-          else
-            method_str = args[1].children.first if args[1]
-            path_parts << 'class_methods' if method_str.start_with? '.'
-            check_method_spec(node, path_parts, method_str)
-          end
-        end
-
-        def check_described_class(node, first_arg)
-          if !first_arg || first_arg.type != :const
-            add_offence(first_arg || node, :expression, DESCRIBE_CLASS_MSG)
-          end
-        end
-
-        def check_described_method(node, second_arg)
-          return unless second_arg
-
-          unless METHOD_STRING_MATCHER =~ second_arg.children.first
-            add_offence(second_arg, :expression, METHOD_STRING_MSG)
-          end
-        end
-
-        def check_class_spec(node, path_parts)
-          spec_path = File.join(path_parts) + '_spec.rb'
-          unless source_filename.end_with? spec_path
-            add_offence(node, :expression, format(CLASS_SPEC_MSG, spec_path))
-          end
-        end
-
-        def check_method_spec(node, path_parts, method_str)
-          matcher_parts = path_parts.dup
-          # Strip out symbols; it's not worth enforcing a vocabulary for them.
-          matcher_parts << method_str[1..-1].gsub(/\W+/, '*') + '_spec.rb'
-
-          glob_matcher = File.join(matcher_parts)
-          unless source_filename =~ regexp_from_glob(glob_matcher)
-            message = format(METHOD_SPEC_MSG, glob_matcher)
-            add_offence(node, :expression, message)
-          end
-        end
-
-        def top_level_describe?(node)
-          _receiver, method_name, *_args = *node
-          return false unless method_name == :describe
-
-          root_node = processed_source.ast
-          top_level_nodes = describe_statement_children(root_node)
-          # If we have no top level describe statements, we need to check any
-          # blocks on the top level (e.g. after a require).
-          if top_level_nodes.size == 0
-            top_level_nodes = node_children(root_node).map do |child|
-              describe_statement_children(child) if child.type == :block
-            end.flatten.compact
-          end
-
-          top_level_nodes.include? node
-        end
-
-        def describe_statement_children(node)
-          node_children(node).select do |element|
-            element.type == :send && element.children[1] == :describe
-          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
-
-        def node_children(node)
-          node.children.select { |e| e.is_a? Parser::AST::Node }
-        end
-      end
-    end
-  end
-end

data/spec/rubocop/cop/rspec/unit_spec_naming_spec.rb

@@ -1,137 +0,0 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
-describe Rubocop::Cop::RSpec::UnitSpecNaming, :config do
-  subject(:cop) { described_class.new(config) }
-
-  context 'describe statement enforcement' do
-    let(:cop_config) { { 'EnforceFilenames' => false } }
-
-    it 'checks first-line describe statements' do
-      inspect_source(cop,
-                     ['describe "bad describe" do; end'])
-      expect(cop.offences.size).to eq(1)
-    end
-
-    it 'checks describe statements after a require' do
-      inspect_source(cop,
-                     ["require 'spec_helper'",
-                      'describe "bad describe" do; end'])
-      expect(cop.offences.size).to eq(1)
-    end
-
-    it 'ignores nested describe statements' do
-      inspect_source(cop,
-                     ['describe Some::Class do',
-                      '  describe "bad describe" do; end',
-                      'end'])
-      expect(cop.offences).to eq([])
-    end
-
-    it "doesn't blow up on single-line describes" do
-      inspect_source(cop,
-                     ['describe Some::Class'])
-      expect(cop.offences).to eq([])
-    end
-
-    it 'checks class method naming' do
-      inspect_source(cop,
-                     ["describe Some::Class, '.asdf' do; end"])
-      expect(cop.offences).to eq([])
-    end
-
-    it 'checks instance method naming' do
-      inspect_source(cop,
-                     ["describe Some::Class, '#fdsa' do; end"])
-      expect(cop.offences).to eq([])
-    end
-
-    it 'enforces non-method names' do
-      inspect_source(cop,
-                     ["describe Some::Class, 'nope' do; end"])
-      expect(cop.offences.size).to eq(1)
-    end
-  end
-
-  context 'filename enforcement' do
-    let(:cop_config) { { 'EnforceDescribeStatement' => false } }
-
-    it 'checks class specs' do
-      inspect_source(cop,
-                     ['describe Some::Class do; end'],
-                     'some/class_spec.rb')
-      expect(cop.offences).to eq([])
-    end
-
-    it 'handles CamelCaps class names' do
-      inspect_source(cop,
-                     ['describe MyClass do; end'],
-                     'my_class_spec.rb')
-      expect(cop.offences).to eq([])
-    end
-
-    it 'handles ACRONYMClassNames' do
-      inspect_source(cop,
-                     ['describe ABCOne::Two do; end'],
-                     'abc_one/two_spec.rb')
-      expect(cop.offences).to eq([])
-    end
-
-    it 'handles ALLCAPS class names' do
-      inspect_source(cop,
-                     ['describe ALLCAPS do; end'],
-                     'allcaps_spec.rb')
-      expect(cop.offences).to eq([])
-    end
-
-    it 'checks instance methods' do
-      inspect_source(cop,
-                     ["describe Some::Class, '#inst' do; end"],
-                     'some/class/inst_spec.rb')
-      expect(cop.offences).to eq([])
-    end
-
-    it 'checks class methods' do
-      inspect_source(cop,
-                     ["describe Some::Class, '.inst' do; end"],
-                     'some/class/class_methods/inst_spec.rb')
-      expect(cop.offences).to eq([])
-    end
-
-    it 'ignores non-alphanumeric characters' do
-      inspect_source(cop,
-                     ["describe Some::Class, '#pred?' do; end"],
-                     'some/class/pred_spec.rb')
-      expect(cop.offences).to eq([])
-    end
-
-    it 'allows flexibility with predicates' do
-      inspect_source(cop,
-                     ["describe Some::Class, '#thing?' do; end"],
-                     'some/class/thing_predicate_spec.rb')
-      expect(cop.offences).to eq([])
-    end
-
-    it 'allows flexibility with operators' do
-      inspect_source(cop,
-                     ["describe MyClass, '#<=>' do; end"],
-                     'my_class/spaceship_operator_spec.rb')
-      expect(cop.offences).to eq([])
-    end
-
-    it 'checks the path' do
-      inspect_source(cop,
-                     ["describe MyClass, '#foo' do; end"],
-                     'my_clas/foo_spec.rb')
-      expect(cop.offences.size).to eq(1)
-    end
-
-    it 'checks class spec paths' do
-      inspect_source(cop,
-                     ['describe MyClass do; end'],
-                     'my_clas_spec.rb')
-      expect(cop.offences.size).to eq(1)
-    end
-  end
-end