rubocop-rspec 0.18.1 → 1.0.rc1

data/lib/rubocop/rspec/top_level_describe.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+module Rubocop
+  module RSpec
+    # Helper methods for top level describe cops
+    module TopLevelDescribe
+      def on_send(node)
+        return unless respond_to?(:on_top_level_describe)
+        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 }
+
+        on_top_level_describe(node, args)
+      end
+
+      private
+
+      def top_level_describe?(node)
+        _receiver, method_name, *_args = *node
+        return false unless method_name == :describe
+
+        top_level_nodes.include?(node)
+      end
+
+      def top_level_nodes
+        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 nodes.size == 0
+          nodes = node_children(root_node).map do |child|
+            describe_statement_children(child) if child.type == :block
+          end.flatten.compact
+        end
+
+        nodes
+      end
+
+      def root_node
+        processed_source.ast
+      end
+
+      def single_top_level_describe?
+        top_level_nodes.count == 1
+      end
+
+      def describe_statement_children(node)
+        node_children(node).select do |element|
+          element.type == :send && element.children[1] == :describe
+        end
+      end
+
+      def node_children(node)
+        node.children.select { |e| e.is_a? Parser::AST::Node }
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/version.rb

@@ -4,7 +4,7 @@ module Rubocop
   module RSpec
     # Version information for the RSpec RuboCop plugin.
     module Version
-      STRING = '0.18.1'
+      STRING = '1.0.rc1'
     end
   end
 end

data/rubocop-rspec.gemspec

@@ -11,8 +11,8 @@ Gem::Specification.new do |spec|
     A plugin for the RuboCop code style enforcing & linting tool.
   end_description
   spec.homepage = 'http://github.com/nevir/rubocop-rspec'
-  spec.authors = ['Ian MacLeod']
-  spec.email = ['ian@nevir.net']
+  spec.authors = ['Ian MacLeod', 'Nils Gemeinhardt']
+  spec.email = ['ian@nevir.net', 'git@nilsgemeinhardt.de']
   spec.licenses = ['MIT']
 
   spec.version = Rubocop::RSpec::Version::STRING
@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
   spec.test_files = spec.files.grep(/^spec\//)
   spec.extra_rdoc_files = ['MIT-LICENSE.md', 'README.md']
 
-  spec.add_runtime_dependency('rubocop', '~> 0.18')
+  spec.add_runtime_dependency('rubocop', '~> 0.19', '>= 0.19')
 end

data/spec/rubocop/cop/rspec_describe_class_spec.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::RSpecDescribeClass do
+  subject(:cop) { described_class.new }
+
+  it 'checks first-line describe statements' do
+    inspect_source(cop, ['describe "bad describe" do; end'])
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line).sort).to eq([1])
+    expect(cop.messages).to eq(['The first argument to describe should be ' \
+                                'the class or module being tested.'])
+  end
+
+  it 'checks describe statements after a require' do
+    inspect_source(cop, ["require 'spec_helper'",
+                         'describe "bad describe" do; end'])
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line).sort).to eq([2])
+    expect(cop.messages).to eq(['The first argument to describe should be ' \
+                                'the class or module being tested.'])
+  end
+
+  it 'ignores nested describe statements' do
+    inspect_source(cop, ['describe Some::Class do',
+                         '  describe "bad describe" do; end',
+                         'end'])
+    expect(cop.offenses).to be_empty
+  end
+
+  it "doesn't blow up on single-line describes" do
+    inspect_source(cop, ['describe Some::Class'])
+    expect(cop.offenses).to be_empty
+  end
+end

data/spec/rubocop/cop/rspec_describe_method_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::RSpecDescribeMethod do
+  subject(:cop) { described_class.new }
+
+  it 'enforces non-method names' do
+    inspect_source(cop, ["describe Some::Class, 'nope' do; end"])
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line).sort).to eq([1])
+    expect(cop.messages)
+    .to eq(['The second argument to describe should be the method being ' \
+            "tested. '#instance' or '.class'"])
+  end
+
+  it 'skips methods starting with a . or #' do
+    inspect_source(cop, ["describe Some::Class, '.asdf' do; end",
+                         "describe Some::Class, '#fdsa' do; end"])
+    expect(cop.offenses).to be_empty
+  end
+end

data/spec/rubocop/cop/rspec_described_class_spec.rb

@@ -0,0 +1,113 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::RSpecDescribedClass do
+  subject(:cop) { described_class.new }
+
+  it 'checks for the use of the described class' do
+    inspect_source(cop, ['describe MyClass do',
+                         '  subject { MyClass.do_something }',
+                         '  before { MyClass.do_something }',
+                         'end'])
+    expect(cop.offenses.size).to eq(2)
+    expect(cop.offenses.map(&:line).sort).to eq([2, 3])
+    expect(cop.messages)
+      .to eq(['Use `described_class` instead of `MyClass`'] * 2)
+    expect(cop.highlights).to eq(['MyClass'] * 2)
+  end
+
+  it 'ignores described class as string' do
+    inspect_source(cop, ['describe MyClass do',
+                         '  subject { "MyClass" }',
+                         'end'])
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'ignores describes that do not referece to a class' do
+    inspect_source(cop, ['describe "MyClass" do',
+                         '  subject { "MyClass" }',
+                         'end'])
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'ignores if the scope is changing' do
+    inspect_source(cop, ['describe MyClass do',
+                         '  include MyClass',
+                         'end'])
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line).sort).to eq([2])
+    expect(cop.messages)
+      .to eq(['Use `described_class` instead of `MyClass`'])
+    expect(cop.highlights).to eq(['MyClass'])
+  end
+
+  it 'ignores class if the scope is changing' do
+    inspect_source(cop, ['describe MyClass do',
+                         '  def method',
+                         '    include MyClass',
+                         '  end',
+                         '  class OtherClass',
+                         '    include MyClass',
+                         '  end',
+                         '  module MyModle',
+                         '    include MyClass',
+                         '  end',
+                         'end'])
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'only takes class from top level describes' do
+    inspect_source(cop, ['describe MyClass do',
+                         '  describe MyClass::Foo do',
+                         '    subject { MyClass::Foo }',
+                         '    let(:foo) { MyClass }',
+                         '  end',
+                         'end'])
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line).sort).to eq([4])
+    expect(cop.messages)
+      .to eq(['Use `described_class` instead of `MyClass`'])
+    expect(cop.highlights).to eq(['MyClass'])
+  end
+
+  it 'ignores subclasses' do
+    inspect_source(cop, ['describe MyClass do',
+                         '  subject { MyClass::SubClass }',
+                         'end'])
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'ignores if namespace is not matching' do
+    inspect_source(cop, ['describe MyNamespace::MyClass do',
+                         '  subject { ::MyClass }',
+                         '  let(:foo) { MyClass }',
+                         'end'])
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'checks for the use of described class with namespace' do
+    inspect_source(cop, ['describe MyNamespace::MyClass do',
+                         '  subject { MyNamespace::MyClass }',
+                         'end'])
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line).sort).to eq([2])
+    expect(cop.messages)
+      .to eq(['Use `described_class` instead of `MyNamespace::MyClass`'])
+    expect(cop.highlights).to eq(['MyNamespace::MyClass'])
+  end
+
+  it 'checks for the use of described class with module' do
+    pending 'TODO'
+    inspect_source(cop, ['module MyNamespace',
+                         '  describe MyClass do',
+                         '    subject { MyNamespace::MyClass }',
+                         '  end',
+                         'end'])
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line).sort).to eq([2])
+    expect(cop.messages)
+      .to eq(['Use `described_class` instead of `MyNamespace::MyClass`'])
+    expect(cop.highlights).to eq(['MyNamespace::MyClass'])
+  end
+end

data/spec/rubocop/cop/rspec_example_wording_spec.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::RSpecExampleWording do
+  subject(:cop) { described_class.new }
+
+  it 'finds description with `should` at the beginning' do
+    inspect_source(cop, ["it 'should do something' 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 should when describing your tests.'])
+    expect(cop.highlights).to eq(['it'])
+  end
+
+  it 'skips descriptions without `should` at the beginning' do
+    inspect_source(cop, ["it 'finds no should ' \\",
+                         "   'here' do",
+                         'end'])
+    expect(cop.offenses).to be_empty
+  end
+end

data/spec/rubocop/cop/rspec_file_name_spec.rb

@@ -0,0 +1,122 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::RSpecFileName do
+  subject(:cop) { described_class.new }
+
+  it 'checks the path' do
+    inspect_source(cop,
+                   ["describe MyClass, 'foo' do; end"],
+                   'wrong_path_foo_spec.rb')
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line).sort).to eq([1])
+    expect(cop.messages)
+      .to eq(['Spec path should end with `my_class_foo*_spec.rb`'])
+  end
+
+  it 'checks the path' do
+    inspect_source(cop,
+                   ["describe MyClass, '#foo' do; end"],
+                   'wrong_class_foo_spec.rb')
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line).sort).to eq([1])
+    expect(cop.messages)
+      .to eq(['Spec path should end with `my_class_foo*_spec.rb`'])
+  end
+
+  it 'checks class spec paths' do
+    inspect_source(cop,
+                   ['describe MyClass do; end'],
+                   'wrong_class_spec.rb')
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line).sort).to eq([1])
+    expect(cop.messages)
+      .to eq(['Spec path should end with `my_class*_spec.rb`'])
+  end
+
+  it 'skips specs that do not describe a class / method' do
+    inspect_source(cop,
+                   ["describe 'Test something' do; end"],
+                   'some/class_spec.rb')
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'skips specs that do have multiple top level describes' do
+    inspect_source(cop,
+                   ["describe MyClass, 'do_this' do; end",
+                    "describe MyClass, 'do_that' do; end"],
+                   'some/class_spec.rb')
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'checks class specs' do
+    inspect_source(cop,
+                   ['describe Some::Class do; end'],
+                   'some/class_spec.rb')
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'handles CamelCaps class names' do
+    inspect_source(cop,
+                   ['describe MyClass do; end'],
+                   'my_class_spec.rb')
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'handles ACRONYMClassNames' do
+    inspect_source(cop,
+                   ['describe ABCOne::Two do; end'],
+                   'abc_one/two_spec.rb')
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'handles ALLCAPS class names' do
+    inspect_source(cop,
+                   ['describe ALLCAPS do; end'],
+                   'allcaps_spec.rb')
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'checks instance methods' do
+    inspect_source(cop,
+                   ["describe Some::Class, '#inst' do; end"],
+                   'some/class_inst_spec.rb')
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'checks methods' do
+    inspect_source(cop,
+                   ["describe Some::Class, 'inst' do; end"],
+                   'some/class_inst_spec.rb')
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'checks class methods' do
+    inspect_source(cop,
+                   ["describe Some::Class, '.inst' do; end"],
+                   'some/class_inst_spec.rb')
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'ignores non-alphanumeric characters' do
+    inspect_source(cop,
+                   ["describe Some::Class, '#pred?' do; end"],
+                   'some/class_pred_spec.rb')
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'allows flexibility with predicates' do
+    inspect_source(cop,
+                   ["describe Some::Class, '#thing?' do; end"],
+                   'some/class_thing_predicate_spec.rb')
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'allows flexibility with operators' do
+    inspect_source(cop,
+                   ["describe MyClass, '#<=>' do; end"],
+                   'my_class_spaceship_operator_spec.rb')
+    expect(cop.offenses).to be_empty
+  end
+end

data/spec/rubocop/cop/rspec_instance_variable_spec.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::RSpecInstanceVariable do
+  subject(:cop) { described_class.new }
+
+  it 'finds an instance variable inside a describe' do
+    inspect_source(cop, ['describe MyClass do',
+                         '  before { @foo = [] }',
+                         '  it { expect(@foo).to be_emtpy }',
+                         'end'])
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line).sort).to eq([3])
+    expect(cop.messages).to eq(['Use `let` instead of an instance variable'])
+  end
+
+  it 'finds an instance variable inside a shared example' do
+    inspect_source(cop, ["shared_examples 'shared example' do",
+                         '  it { expect(@foo).to be_emtpy }',
+                         'end'])
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line).sort).to eq([2])
+    expect(cop.messages).to eq(['Use `let` instead of an instance variable'])
+  end
+
+  it 'ignores an instance variable without describe' do
+    inspect_source(cop, ['@foo = []',
+                         '@foo.empty?'])
+    expect(cop.offenses).to be_empty
+  end
+end