transpec 1.8.0 → 1.9.0

data/lib/transpec/syntax/operator_matcher.rb

@@ -8,16 +8,22 @@ require 'ast'
 module Transpec
   class Syntax
     class OperatorMatcher < Syntax
-      include Mixin::Send, Util, ::AST::Sexp
+      extend ::AST::Sexp
+      include Mixin::Send, Util
 
       OPERATORS = [:==, :===, :<, :<=, :>, :>=, :=~].freeze
+      BE_NODE = s(:send, nil, :be)
 
       def self.standalone?
         false
       end
 
-      def self.target_method?(receiver_node, method_name)
-        !receiver_node.nil? && OPERATORS.include?(method_name)
+      def self.target_node?(node, runtime_data = nil)
+        node = node.parent_node if node == BE_NODE
+        receiver_node, method_name, *_ = *node
+        return false if receiver_node.nil?
+        return false unless OPERATORS.include?(method_name)
+        check_target_node_dynamically(node, runtime_data)
       end
 
       add_dynamic_analysis_request do |rewriter|
@@ -26,6 +32,16 @@ module Transpec
         end
       end
 
+      def initialize(node, source_rewriter = nil, runtime_data = nil, report = nil)
+        operator_node = if node == BE_NODE
+                          node.parent_node
+                        else
+                          node
+                        end
+
+        super(operator_node, source_rewriter, runtime_data, report)
+      end
+
       def convert_operator!(parenthesize_arg = true)
         case method_name
         when :==
@@ -126,7 +142,7 @@ module Transpec
       end
 
       def be_node
-        if receiver_node == s(:send, nil, :be)
+        if receiver_node == BE_NODE
           receiver_node
         else
           nil

data/lib/transpec/syntax/receive.rb

@@ -3,12 +3,12 @@
 require 'transpec/syntax'
 require 'transpec/syntax/mixin/send'
 require 'transpec/syntax/mixin/owned_matcher'
-require 'transpec/syntax/mixin/any_instance_block'
+require 'transpec/syntax/mixin/messaging_host'
 
 module Transpec
   class Syntax
     class Receive < Syntax
-      include Mixin::Send, Mixin::OwnedMatcher, Mixin::AnyInstanceBlock
+      include Mixin::Send, Mixin::OwnedMatcher, Mixin::MessagingHost
 
       attr_reader :expectation
 
@@ -16,13 +16,16 @@ module Transpec
         receiver_node.nil? && method_name == :receive
       end
 
+      def remove_useless_and_return!
+        removed = super
+        return unless removed
+        @report.records << ReceiveUselessAndReturnRecord.new(self)
+      end
+
       def add_receiver_arg_to_any_instance_implementation_block!
         added = super
         return unless added
-        @report.records << Record.new(
-          "#{@expectation.method_name}(Klass).to receive(:message) { |arg| }",
-          "#{@expectation.method_name}(Klass).to receive(:message) { |instance, arg| }"
-        )
+        @report.records << ReceiveAnyInstanceBlockRecord.new(self)
       end
 
       def any_instance?
@@ -33,6 +36,18 @@ module Transpec
         return unless any_instance?
         super || @expectation.block_node
       end
+
+      class ReceiveAnyInstanceBlockRecord < AnyInstanceBlockRecord
+        def base_syntax
+          "#{@host.expectation.method_name}(Klass).to receive(:message)"
+        end
+      end
+
+      class ReceiveUselessAndReturnRecord < UselessAndReturnRecord
+        def base_syntax
+          "#{@host.expectation.method_name_for_instance}(obj).to receive(:message)"
+        end
+      end
     end
   end
 end

data/lib/transpec/syntax/should_receive.rb

@@ -3,14 +3,13 @@
 require 'transpec/syntax'
 require 'transpec/syntax/mixin/expectizable'
 require 'transpec/syntax/mixin/monkey_patch_any_instance'
-require 'transpec/syntax/mixin/allow_no_message'
-require 'transpec/syntax/mixin/any_instance_block'
+require 'transpec/syntax/mixin/messaging_host'
+require 'transpec/util'
 
 module Transpec
   class Syntax
     class ShouldReceive < Syntax
-      include Mixin::Expectizable, Mixin::MonkeyPatchAnyInstance, Mixin::AnyInstanceBlock,
-              Mixin::AllowNoMessage
+      include Mixin::Expectizable, Mixin::MonkeyPatchAnyInstance, Mixin::MessagingHost, Util
 
       alias_method :useless_expectation?, :allow_no_message?
 
@@ -61,7 +60,7 @@ module Transpec
         end
 
         convert_to_syntax!('allow', negative_form)
-        remove_allowance_for_no_message!
+        remove_no_message_allowance!
 
         register_record(AllowRecord, negative_form)
       end
@@ -70,13 +69,17 @@ module Transpec
         return unless useless_expectation?
 
         replace(selector_range, 'stub')
-        remove_allowance_for_no_message!
+        remove_no_message_allowance!
 
         register_record(StubRecord)
       end
 
+      def remove_useless_and_return!
+        super && register_record(MonkeyPatchUselessAndReturnRecord)
+      end
+
       def add_receiver_arg_to_any_instance_implementation_block!
-        super && register_record(AnyInstanceBlockRecord)
+        super && register_record(MonkeyPatchAnyInstanceBlockRecord)
       end
 
       private
@@ -112,7 +115,7 @@ module Transpec
       def broken_block_nodes
         @broken_block_nodes ||= [
           block_node_taken_by_with_method_with_no_normal_args,
-          block_node_following_message_expectation_method
+          block_node_followed_by_fluent_method
         ].compact.uniq
       end
 
@@ -128,7 +131,7 @@ module Transpec
       #   (args
       #     (arg :block_arg)) nil)
       def block_node_taken_by_with_method_with_no_normal_args
-        each_chained_method_node do |chained_node, child_node|
+        each_backward_chained_node(node, :child_as_second_arg) do |chained_node, child_node|
           next unless chained_node.block_type?
           return nil unless child_node.children[1] == :with
           return nil if child_node.children[2]
@@ -146,8 +149,8 @@ module Transpec
       #       (sym :method_name))
       #     (args
       #       (arg :block_arg)) nil) :once)
-      def block_node_following_message_expectation_method
-        each_chained_method_node do |chained_node, child_node|
+      def block_node_followed_by_fluent_method
+        each_backward_chained_node(node, :child_as_second_arg) do |chained_node, child_node|
           next unless chained_node.send_type?
           return child_node if child_node.block_type?
         end

data/lib/transpec/util.rb

@@ -74,6 +74,52 @@ module Transpec
       parent_node
     end
 
+    def each_forward_chained_node(origin_node, mode = nil)
+      return to_enum(__method__, origin_node, mode) unless block_given?
+
+      yield origin_node if mode == :include_origin
+
+      parent_node = origin_node
+
+      loop do
+        child_node = parent_node.children.first
+
+        return unless child_node
+        return unless [:send, :block].include?(child_node.type)
+
+        if mode == :parent_as_second_arg
+          yield child_node, parent_node
+        else
+          yield child_node
+        end
+
+        parent_node = child_node
+      end
+
+      nil
+    end
+
+    def each_backward_chained_node(origin_node, mode = nil)
+      return to_enum(__method__, origin_node, mode) unless block_given?
+
+      yield origin_node if mode == :include_origin
+
+      origin_node.each_ancestor_node.reduce(origin_node) do |child_node, parent_node|
+        return unless [:send, :block].include?(parent_node.type)
+        return unless parent_node.children.first.equal?(child_node)
+
+        if mode == :child_as_second_arg
+          yield parent_node, child_node
+        else
+          yield parent_node
+        end
+
+        parent_node
+      end
+
+      nil
+    end
+
     def indentation_of_line(arg)
       line = case arg
              when AST::Node             then arg.loc.expression.source_line

data/lib/transpec/version.rb

@@ -4,7 +4,7 @@ module Transpec
   # http://semver.org/
   module Version
     MAJOR = 1
-    MINOR = 8
+    MINOR = 9
     PATCH = 0
 
     def self.to_s

data/spec/transpec/converter_spec.rb

@@ -367,7 +367,7 @@ module Transpec
 
     describe '#process_expect' do
       let(:expect_object) { double('expect_object', receive_matcher: receive_object).as_null_object }
-      let(:receive_object) { double('receive_object') }
+      let(:receive_object) { double('receive_object').as_null_object }
 
       context 'when Configuration#convert_have_items? is true' do
         before { configuration.convert_have_items = true }
@@ -400,6 +400,11 @@ module Transpec
         end
       end
 
+      it "invokes #process_useless_and_return with the expect's #receive matcher" do
+        converter.should_receive(:process_useless_and_return).with(receive_object)
+        converter.process_expect(expect_object)
+      end
+
       it "invokes #process_any_instance_block with the expect's #receive matcher" do
         converter.should_receive(:process_any_instance_block).with(receive_object)
         converter.process_expect(expect_object)
@@ -408,7 +413,12 @@ module Transpec
 
     describe '#process_allow' do
       let(:allow_object) { double('allow_object', receive_matcher: receive_object).as_null_object }
-      let(:receive_object) { double('receive_object') }
+      let(:receive_object) { double('receive_object').as_null_object }
+
+      it "invokes #process_useless_and_return with the allow's #receive matcher" do
+        converter.should_receive(:process_useless_and_return).with(receive_object)
+        converter.process_allow(allow_object)
+      end
 
       it "invokes #process_any_instance_block with the allow's #receive matcher" do
         converter.should_receive(:process_any_instance_block).with(receive_object)
@@ -573,9 +583,14 @@ module Transpec
         end
       end
 
+      it 'invokes #process_useless_and_return with the should_receive' do
+        converter.should_receive(:process_useless_and_return).with(should_receive_object)
+        converter.process_should_receive(should_receive_object)
+      end
+
       it 'invokes #process_any_instance_block with the should_receive' do
         converter.should_receive(:process_any_instance_block).with(should_receive_object)
-        converter.process_allow(should_receive_object)
+        converter.process_should_receive(should_receive_object)
       end
     end
 
@@ -610,16 +625,16 @@ module Transpec
         end
       end
 
-      shared_examples 'invokes MethodStub#remove_allowance_for_no_message!' do
-        it 'invokes MethodStub#remove_allowance_for_no_message!' do
-          method_stub_object.should_receive(:remove_allowance_for_no_message!)
+      shared_examples 'invokes MethodStub#remove_no_message_allowance!' do
+        it 'invokes MethodStub#remove_no_message_allowance!' do
+          method_stub_object.should_receive(:remove_no_message_allowance!)
           converter.process_method_stub(method_stub_object)
         end
       end
 
-      shared_examples 'does not invoke MethodStub#remove_allowance_for_no_message!' do
-        it 'does not invoke MethodStub#remove_allowance_for_no_message!' do
-          method_stub_object.should_not_receive(:remove_allowance_for_no_message!)
+      shared_examples 'does not invoke MethodStub#remove_no_message_allowance!' do
+        it 'does not invoke MethodStub#remove_no_message_allowance!' do
+          method_stub_object.should_not_receive(:remove_no_message_allowance!)
           converter.process_method_stub(method_stub_object)
         end
       end
@@ -634,7 +649,7 @@ module Transpec
             before { method_stub_object.stub(:hash_arg?).and_return(false) }
             include_examples 'invokes MethodStub#allowize!'
             include_examples 'does not invoke MethodStub#convert_deprecated_method!'
-            include_examples 'invokes MethodStub#remove_allowance_for_no_message!'
+            include_examples 'invokes MethodStub#remove_no_message_allowance!'
           end
 
           context 'and MethodStub#hash_arg? is true' do
@@ -647,14 +662,14 @@ module Transpec
                 before { rspec_version.stub(:receive_messages_available?).and_return(true) }
                 include_examples 'invokes MethodStub#allowize!'
                 include_examples 'does not invoke MethodStub#convert_deprecated_method!'
-                include_examples 'invokes MethodStub#remove_allowance_for_no_message!'
+                include_examples 'invokes MethodStub#remove_no_message_allowance!'
               end
 
               context 'and RSpecVersion#receive_messages_available? is false' do
                 before { rspec_version.stub(:receive_messages_available?).and_return(false) }
                 include_examples 'invokes MethodStub#allowize!'
                 include_examples 'does not invoke MethodStub#convert_deprecated_method!'
-                include_examples 'invokes MethodStub#remove_allowance_for_no_message!'
+                include_examples 'invokes MethodStub#remove_no_message_allowance!'
               end
             end
 
@@ -665,14 +680,14 @@ module Transpec
                 before { rspec_version.stub(:receive_messages_available?).and_return(true) }
                 include_examples 'invokes MethodStub#allowize!'
                 include_examples 'does not invoke MethodStub#convert_deprecated_method!'
-                include_examples 'invokes MethodStub#remove_allowance_for_no_message!'
+                include_examples 'invokes MethodStub#remove_no_message_allowance!'
               end
 
               context 'and RSpecVersion#receive_messages_available? is false' do
                 before { rspec_version.stub(:receive_messages_available?).and_return(false) }
                 include_examples 'does not invoke MethodStub#allowize!'
                 include_examples 'invokes MethodStub#convert_deprecated_method!'
-                include_examples 'invokes MethodStub#remove_allowance_for_no_message!'
+                include_examples 'invokes MethodStub#remove_no_message_allowance!'
               end
             end
           end
@@ -686,7 +701,7 @@ module Transpec
 
           include_examples 'invokes MethodStub#allowize!'
           include_examples 'does not invoke MethodStub#convert_deprecated_method!'
-          include_examples 'does not invoke MethodStub#remove_allowance_for_no_message!'
+          include_examples 'does not invoke MethodStub#remove_no_message_allowance!'
         end
       end
 
@@ -698,7 +713,7 @@ module Transpec
 
           include_examples 'does not invoke MethodStub#allowize!'
           include_examples 'invokes MethodStub#convert_deprecated_method!'
-          include_examples 'invokes MethodStub#remove_allowance_for_no_message!'
+          include_examples 'invokes MethodStub#remove_no_message_allowance!'
         end
 
         context 'and Configuration#convert_deprecated_method? is false' do
@@ -706,13 +721,18 @@ module Transpec
 
           include_examples 'does not invoke MethodStub#allowize!'
           include_examples 'does not invoke MethodStub#convert_deprecated_method!'
-          include_examples 'does not invoke MethodStub#remove_allowance_for_no_message!'
+          include_examples 'does not invoke MethodStub#remove_no_message_allowance!'
         end
       end
 
+      it 'invokes #process_useless_and_return with the method stub' do
+        converter.should_receive(:process_useless_and_return).with(method_stub_object)
+        converter.process_method_stub(method_stub_object)
+      end
+
       it 'invokes #process_any_instance_block with the method stub' do
         converter.should_receive(:process_any_instance_block).with(method_stub_object)
-        converter.process_allow(method_stub_object)
+        converter.process_method_stub(method_stub_object)
       end
     end
 
@@ -1047,6 +1067,28 @@ module Transpec
       end
     end
 
+    describe '#process_useless_and_return' do
+      let(:messaging_host) { double('messaging host').as_null_object }
+
+      context 'when Configuration#convert_deprecated_method? returns true' do
+        before { configuration.convert_deprecated_method = true }
+
+        it 'invokes #remove_useless_and_return!' do
+          messaging_host.should_receive(:remove_useless_and_return!)
+          converter.process_useless_and_return(messaging_host)
+        end
+      end
+
+      context 'when Configuration#convert_deprecated_method? returns false' do
+        before { configuration.convert_deprecated_method = false }
+
+        it 'does nothing' do
+          messaging_host.should_not_receive(:remove_useless_and_return!)
+          converter.process_useless_and_return(messaging_host)
+        end
+      end
+    end
+
     describe '#process_any_instance_block' do
       let(:messaging_host) { double('messaging host').as_null_object }
 

data/spec/transpec/syntax/expect_spec.rb

@@ -27,37 +27,69 @@ module Transpec
       end
 
       describe '#matcher_node' do
-        context 'when the matcher is taking a block' do
+        let(:matcher_name) { expect_object.matcher_node.children[1] }
+
+        context 'when the matcher is not taking a block' do
           let(:source) do
             <<-END
               describe 'example' do
                 it 'is empty' do
-                  expect(subject).to receive(:foo) { }
+                  expect(subject).to be_empty
                 end
               end
             END
           end
 
           it 'returns send node of the matcher' do
-            method_name = expect_object.matcher_node.children[1]
-            method_name.should == :receive
+            matcher_name.should == :be_empty
           end
         end
 
-        context 'when the matcher is not taking a block' do
+        context 'when the matcher is taking a block' do
           let(:source) do
             <<-END
               describe 'example' do
-                it 'is empty' do
-                  expect(subject).to be_empty
+                it 'receives :foo' do
+                  expect(subject).to receive(:foo) { }
                 end
               end
             END
           end
 
           it 'returns send node of the matcher' do
-            method_name = expect_object.matcher_node.children[1]
-            method_name.should == :be_empty
+            matcher_name.should == :receive
+          end
+        end
+
+        context 'when the matcher is chained by another method' do
+          let(:source) do
+            <<-END
+              describe 'example' do
+                it 'receives :foo twice' do
+                  expect(subject).to receive(:foo).twice
+                end
+              end
+            END
+          end
+
+          it 'returns the first node of the chain' do
+            matcher_name.should == :receive
+          end
+        end
+
+        context 'when the matcher is chained by another method that is taking a block' do
+          let(:source) do
+            <<-END
+              describe 'example' do
+                it 'receives :foo twice' do
+                  expect(subject).to receive(:foo).twice { }
+                end
+              end
+            END
+          end
+
+          it 'returns the first node of the chain' do
+            matcher_name.should == :receive
           end
         end
       end