rubocop-rspec 1.15.1 → 1.16.0

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # This cop checks void `expect()`.
+      #
+      # @example
+      #   # bad
+      #   expect(something)
+      #
+      #   # good
+      #   expect(something).to be(1)
+      class VoidExpect < Cop
+        MSG = 'Do not use `expect()` without `.to` or `.not_to`. ' \
+              'Chain the methods or remove it.'.freeze
+
+        def_node_matcher :expect?, <<-PATTERN
+          (send nil :expect ...)
+        PATTERN
+
+        def_node_matcher :expect_block?, <<-PATTERN
+          (block #expect? (args) _body)
+        PATTERN
+
+        def on_send(node)
+          return unless expect?(node)
+          check_expect(node)
+        end
+
+        def on_block(node)
+          return unless expect_block?(node)
+          check_expect(node)
+        end
+
+        private
+
+        def check_expect(node)
+          return unless void?(node)
+          add_offense(node, :expression)
+        end
+
+        def void?(expect)
+          parent = expect.parent
+          return true unless parent
+          return true if parent.begin_type?
+          return true if parent.block_type? && parent.children[2] == expect
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/align_let_brace.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    # Shared behavior for aligning braces for single line lets
+    class AlignLetBrace
+      extend NodePattern::Macros
+
+      def_node_matcher :let?, Language::Helpers::ALL.block_pattern.freeze
+
+      def initialize(root, token)
+        @root  = root
+        @token = token
+      end
+
+      def offending_tokens
+        single_line_lets.reject do |let|
+          target_column_for(let) == let_token(let).column
+        end
+      end
+
+      def indent_for(node)
+        ' ' * (target_column_for(node) - let_token(node).column)
+      end
+
+      private
+
+      def let_token(node)
+        node.loc.public_send(token)
+      end
+
+      def target_column_for(let)
+        let_group_for(let).map { |member| let_token(member).column }.max
+      end
+
+      def let_group_for(let)
+        adjacent_let_chunks.detect do |chunk|
+          chunk.any? do |member|
+            member == let && member.loc.line == let.loc.line
+          end
+        end
+      end
+
+      def adjacent_let_chunks
+        last_line = nil
+
+        single_line_lets.chunk do |node|
+          line      = node.loc.line
+          last_line = (line if last_line.nil? || last_line + 1 == line)
+          last_line.nil?
+        end.map(&:last)
+      end
+
+      def single_line_lets
+        @single_line_lets ||=
+          root.each_node(:block).select do |node|
+            let?(node) && node.single_line?
+          end
+      end
+
+      attr_reader :root, :token
+    end
+  end
+end

data/lib/rubocop/rspec/config_formatter.rb

@@ -4,7 +4,8 @@ module RuboCop
   module RSpec
     # Builds a YAML config file from two config hashes
     class ConfigFormatter
-      NAMESPACE = 'RSpec'.freeze
+      NAMESPACES = /^(#{Regexp.union('RSpec', 'FactoryGirl')})/
+      STYLE_GUIDE_BASE_URL = 'http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/'.freeze
 
       def initialize(config, descriptions)
         @config       = config
@@ -12,19 +13,21 @@ module RuboCop
       end
 
       def dump
-        YAML.dump(unified_config).gsub(/^#{NAMESPACE}/, "\n#{NAMESPACE}")
+        YAML.dump(unified_config).gsub(NAMESPACES, "\n\\1")
       end
 
       private
 
       def unified_config
         cops.each_with_object(config.dup) do |cop, unified|
-          unified[cop] = config.fetch(cop).merge(descriptions.fetch(cop))
+          unified[cop] = config.fetch(cop)
+            .merge(descriptions.fetch(cop))
+            .merge('StyleGuide' => STYLE_GUIDE_BASE_URL + cop)
         end
       end
 
       def cops
-        (descriptions.keys + config.keys).uniq.grep(/\A#{NAMESPACE}/)
+        (descriptions.keys | config.keys).grep(NAMESPACES)
       end
 
       attr_reader :config, :descriptions

data/lib/rubocop/rspec/description_extractor.rb

@@ -19,7 +19,7 @@ module RuboCop
 
       # Decorator of a YARD code object for working with documented rspec cops
       class CodeObject
-        COP_NAMESPACE = 'RuboCop::Cop::RSpec'.freeze
+        RSPEC_NAMESPACE = 'RuboCop::Cop::RSpec'.freeze
 
         def initialize(yardoc)
           @yardoc = yardoc
@@ -54,7 +54,7 @@ module RuboCop
         end
 
         def rspec_cop_namespace?
-          documented_constant.start_with?(COP_NAMESPACE)
+          documented_constant.start_with?(RSPEC_NAMESPACE)
         end
 
         def documented_constant

data/lib/rubocop/rspec/example_group.rb

@@ -10,8 +10,9 @@ module RuboCop
       #
       #   Selectors which indicate that we should stop searching
       #
-      def_node_matcher :scope_change?,
-                       (ExampleGroups::ALL + SharedGroups::ALL).block_pattern
+      def_node_matcher :scope_change?, (
+        ExampleGroups::ALL + SharedGroups::ALL + Includes::ALL
+      ).block_pattern
 
       # @!method hook(node)
       #
@@ -20,6 +21,12 @@ module RuboCop
         (block {$(send nil #{Hooks::ALL.node_pattern_union} ...)} ...)
       PATTERN
 
+      def_node_matcher :subject, Subject::ALL.block_pattern
+
+      def subjects
+        subjects_in_scope(node)
+      end
+
       def examples
         examples_in_scope(node).map(&Example.public_method(:new))
       end
@@ -30,6 +37,22 @@ module RuboCop
 
       private
 
+      def subjects_in_scope(node)
+        node.each_child_node.flat_map do |child|
+          find_subjects(child)
+        end
+      end
+
+      def find_subjects(node)
+        return [] if scope_change?(node)
+
+        if subject(node)
+          [node]
+        else
+          subjects_in_scope(node)
+        end
+      end
+
       def hooks_in_scope(node)
         node.each_child_node.flat_map do |child|
           find_hooks(child)

data/lib/rubocop/rspec/factory_girl.rb

@@ -0,0 +1,7 @@
+module RuboCop
+  module RSpec
+    # RuboCop FactoryGirl project namespace
+    module FactoryGirl
+    end
+  end
+end

data/lib/rubocop/rspec/language.rb

@@ -106,13 +106,18 @@ module RuboCop
         ALL = SelectorSet.new(%i[subject subject!])
       end
 
+      module Expectations
+        ALL = SelectorSet.new(%i[expect is_expected expect_any_instance_of])
+      end
+
       ALL =
         ExampleGroups::ALL +
         SharedGroups::ALL  +
         Examples::ALL      +
         Hooks::ALL         +
         Helpers::ALL       +
-        Subject::ALL
+        Subject::ALL       +
+        Expectations::ALL
     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 = '1.15.1'.freeze
+      STRING = '1.16.0'.freeze
     end
   end
 end

data/rubocop-rspec.gemspec

@@ -34,13 +34,10 @@ Gem::Specification.new do |spec|
   spec.test_files = spec.files.grep(%r{^spec/})
   spec.extra_rdoc_files = ['MIT-LICENSE.md', 'README.md']
 
-  spec.add_runtime_dependency 'rubocop', '>= 0.42.0'
+  spec.add_runtime_dependency 'rubocop', '>= 0.49.0'
 
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '>= 3.4'
   spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'anima'
-  spec.add_development_dependency 'concord'
-  spec.add_development_dependency 'adamantium'
   spec.add_development_dependency 'yard'
 end

data/spec/project/default_config_spec.rb

@@ -4,14 +4,18 @@ RSpec.describe 'config/default.yml' do
   end
 
   let(:cop_names) do
-    glob = SpecHelper::ROOT.join('lib', 'rubocop', 'cop', 'rspec', '*.rb')
-
+    namespaces = {
+      'rspec' => 'RSpec',
+      'factory_girl' => 'FactoryGirl'
+    }
+    glob = SpecHelper::ROOT.join('lib', 'rubocop', 'cop',
+                                 'rspec', '{,factory_girl/}*.rb')
     cop_names =
       Pathname.glob(glob).map do |file|
         file_name = file.basename('.rb').to_s
         cop_name  = file_name.gsub(/(^|_)(.)/) { Regexp.last_match(2).upcase }
-
-        "RSpec/#{cop_name}"
+        namespace = namespaces[file.dirname.basename.to_s]
+        "#{namespace}/#{cop_name}"
       end
 
     cop_names - %w[RSpec/Cop]

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

@@ -0,0 +1,62 @@
+RSpec.describe RuboCop::Cop::RSpec::AlignLeftLetBrace do
+  subject(:cop) { described_class.new }
+
+  it 'registers offense for unaligned braces' do
+    expect_offense(<<-RUBY)
+      let(:foo) { bar }
+                ^ Align left let brace
+      let(:hi) { baz }
+               ^ Align left let brace
+      let(:blahblah) { baz }
+
+      let(:thing) { ignore_this }
+      let(:other) {
+        ignore_this_too
+      }
+
+      describe 'blah' do
+        let(:blahblah) { baz }
+        let(:blah) { thing }
+                   ^ Align left let brace
+        let(:a) { thing }
+                ^ Align left let brace
+      end
+    RUBY
+  end
+
+  offensive_source = <<-RUBY
+    let(:foo) { bar }
+    let(:hi) { baz }
+    let(:blahblah) { baz }
+
+    let(:thing) { ignore_this }
+    let(:other) {
+      ignore_this_too
+    }
+
+    describe 'blah' do
+      let(:long_name) { thing }
+      let(:blah) { thing }
+      let(:a) { thing }
+    end
+  RUBY
+
+  corrected_source = <<-RUBY
+    let(:foo)      { bar }
+    let(:hi)       { baz }
+    let(:blahblah) { baz }
+
+    let(:thing) { ignore_this }
+    let(:other) {
+      ignore_this_too
+    }
+
+    describe 'blah' do
+      let(:long_name) { thing }
+      let(:blah)      { thing }
+      let(:a)         { thing }
+    end
+  RUBY
+
+  include_examples 'autocorrect', offensive_source, corrected_source
+end

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

@@ -0,0 +1,62 @@
+RSpec.describe RuboCop::Cop::RSpec::AlignRightLetBrace do
+  subject(:cop) { described_class.new }
+
+  it 'registers offense for unaligned braces' do
+    expect_offense(<<-RUBY)
+      let(:foo)      { a }
+                         ^ Align right let brace
+      let(:hi)       { ab }
+                          ^ Align right let brace
+      let(:blahblah) { abcd }
+
+      let(:thing) { ignore_this }
+      let(:other) {
+        ignore_this_too
+      }
+
+      describe 'blah' do
+        let(:blahblah) { a }
+                           ^ Align right let brace
+        let(:blah)     { bc }
+                            ^ Align right let brace
+        let(:a)        { abc }
+      end
+    RUBY
+  end
+
+  offensive_source = <<-RUBY
+    let(:foo)      { a }
+    let(:hi)       { ab }
+    let(:blahblah) { abcd }
+
+    let(:thing) { ignore_this }
+    let(:other) {
+      ignore_this_too
+    }
+
+    describe 'blah' do
+      let(:blahblah) { a }
+      let(:blah)     { bc }
+      let(:a)        { abc }
+    end
+  RUBY
+
+  corrected_source = <<-RUBY
+    let(:foo)      { a    }
+    let(:hi)       { ab   }
+    let(:blahblah) { abcd }
+
+    let(:thing) { ignore_this }
+    let(:other) {
+      ignore_this_too
+    }
+
+    describe 'blah' do
+      let(:blahblah) { a   }
+      let(:blah)     { bc  }
+      let(:a)        { abc }
+    end
+  RUBY
+
+  include_examples 'autocorrect', offensive_source, corrected_source
+end

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

@@ -2,7 +2,7 @@ RSpec.describe RuboCop::Cop::RSpec::AnyInstance do
   subject(:cop) { described_class.new }
 
   it 'finds `allow_any_instance_of` instead of an instance double' do
-    expect_violation(<<-RUBY)
+    expect_offense(<<-RUBY)
       before do
         allow_any_instance_of(Object).to receive(:foo)
         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid stubbing using `allow_any_instance_of`.
@@ -11,7 +11,7 @@ RSpec.describe RuboCop::Cop::RSpec::AnyInstance do
   end
 
   it 'finds `expect_any_instance_of` instead of an instance double' do
-    expect_violation(<<-RUBY)
+    expect_offense(<<-RUBY)
       before do
         expect_any_instance_of(Object).to receive(:foo)
         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid stubbing using `expect_any_instance_of`.
@@ -20,7 +20,7 @@ RSpec.describe RuboCop::Cop::RSpec::AnyInstance do
   end
 
   it 'finds old `any_instance` syntax instead of an instance double' do
-    expect_violation(<<-RUBY)
+    expect_offense(<<-RUBY)
       before do
         Object.any_instance.should_receive(:foo)
         ^^^^^^^^^^^^^^^^^^^ Avoid stubbing using `any_instance`.