transpec 1.8.0 → 1.9.0

data/lib/transpec/cli.rb

@@ -49,7 +49,7 @@ module Transpec
       unless @configuration.skip_dynamic_analysis?
         puts 'Copying the project for dynamic analysis...'
         DynamicAnalyzer.new(rspec_command: @configuration.rspec_command) do |analyzer|
-          puts "Running dynamic analysis with command \"#{analyzer.rspec_command}\"..."
+          puts "Running dynamic analysis with command #{analyzer.rspec_command.inspect}..."
           runtime_data = analyzer.analyze(paths)
         end
         puts

data/lib/transpec/converter.rb

@@ -80,11 +80,11 @@ module Transpec
 
     def process_expect(expect)
       process_have(expect.have_matcher)
-      process_any_instance_block(expect.receive_matcher)
+      process_messaging_host(expect.receive_matcher)
     end
 
     def process_allow(allow)
-      process_any_instance_block(allow.receive_matcher)
+      process_messaging_host(allow.receive_matcher)
     end
 
     def process_should_receive(should_receive)
@@ -102,7 +102,7 @@ module Transpec
         should_receive.expectize!(@configuration.negative_form_of_to)
       end
 
-      process_any_instance_block(should_receive)
+      process_messaging_host(should_receive)
     end
 
     def process_double(double)
@@ -122,9 +122,9 @@ module Transpec
         method_stub.convert_deprecated_method!
       end
 
-      method_stub.remove_allowance_for_no_message! if @configuration.convert_deprecated_method?
+      method_stub.remove_no_message_allowance! if @configuration.convert_deprecated_method?
 
-      process_any_instance_block(method_stub)
+      process_messaging_host(method_stub)
     end
 
     def process_be_boolean(be_boolean)
@@ -184,6 +184,17 @@ module Transpec
       have.convert_to_standard_expectation!(@configuration.parenthesize_matcher_arg)
     end
 
+    def process_messaging_host(messaging_host)
+      process_useless_and_return(messaging_host)
+      process_any_instance_block(messaging_host)
+    end
+
+    def process_useless_and_return(messaging_host)
+      return unless messaging_host
+      return unless configuration.convert_deprecated_method?
+      messaging_host.remove_useless_and_return!
+    end
+
     def process_any_instance_block(messaging_host)
       return unless messaging_host
       return unless rspec_version.migration_term_of_any_instance_implementation_block?

data/lib/transpec/syntax/allow.rb

@@ -12,6 +12,10 @@ module Transpec
         receiver_node.nil? && [:allow, :allow_any_instance_of].include?(method_name)
       end
 
+      def method_name_for_instance
+        :allow
+      end
+
       def any_instance?
         method_name == :allow_any_instance_of
       end

data/lib/transpec/syntax/expect.rb

@@ -13,6 +13,10 @@ module Transpec
         receiver_node.nil? && [:expect, :expect_any_instance_of].include?(method_name)
       end
 
+      def method_name_for_instance
+        :expect
+      end
+
       def any_instance?
         method_name == :expect_any_instance_of
       end

data/lib/transpec/syntax/have.rb

@@ -20,11 +20,9 @@ module Transpec
 
       attr_reader :expectation
 
-      def self.target_method?(have_node, items_method_name)
-        return false unless have_node
-        have_receiver_node, have_method_name, *_ = *have_node
-        return false if have_receiver_node
-        [:have, :have_exactly, :have_at_least, :have_at_most].include?(have_method_name)
+      def self.target_method?(receiver_node, method_name)
+        receiver_node.nil? &&
+          [:have, :have_exactly, :have_at_least, :have_at_most].include?(method_name)
       end
 
       add_dynamic_analysis_request do |rewriter|
@@ -34,7 +32,7 @@ module Transpec
       def convert_to_standard_expectation!(parenthesize_matcher_arg = true)
         return if project_requires_collection_matcher?
         replace(@expectation.subject_range, replacement_subject_source) if explicit_subject?
-        replace(expression_range, replacement_matcher_source(parenthesize_matcher_arg))
+        replace(matcher_range, replacement_matcher_source(parenthesize_matcher_arg))
         register_record if explicit_subject?
       end
 
@@ -42,16 +40,13 @@ module Transpec
         @expectation.respond_to?(:subject_node)
       end
 
-      def have_node # rubocop:disable PredicateName
-        node.children.first
-      end
+      alias_method :have_node, :node
+      alias_method :items_node, :parent_node
 
       def size_node
         have_node.children[2]
       end
 
-      alias_method :items_node, :node
-
       def items_method_has_arguments?
         items_node.children.size > 2
       end
@@ -107,10 +102,10 @@ module Transpec
         if subject_is_owner_of_collection?
           if collection_accessor_is_private?
             source << ".send(#{collection_accessor.inspect}"
-            source << ", #{args_range.source}" if items_method_has_arguments?
+            source << ", #{collection_accessor_args_body_source}" if items_method_has_arguments?
             source << ')'
           else
-            source << ".#{collection_accessor}#{parentheses_range.source}"
+            source << ".#{collection_accessor}#{collection_accessor_args_parentheses_source}"
           end
         end
         source << ".#{query_method}"
@@ -164,6 +159,22 @@ module Transpec
         end
       end
 
+      def matcher_range
+        expression_range.join(items_node.loc.expression)
+      end
+
+      def collection_accessor_args_parentheses_source
+        map = items_node.loc
+        range = map.selector.end.join(map.expression.end)
+        range.source
+      end
+
+      def collection_accessor_args_body_source
+        arg_nodes = items_node.children[2..-1]
+        range = arg_nodes.first.loc.expression.begin.join(arg_nodes.last.loc.expression.end)
+        range.source
+      end
+
       def register_record
         @report.records << HaveRecord.new(self)
       end

data/lib/transpec/syntax/method_stub.rb

@@ -2,15 +2,14 @@
 
 require 'transpec/syntax'
 require 'transpec/syntax/mixin/monkey_patch_any_instance'
-require 'transpec/syntax/mixin/any_instance_block'
-require 'transpec/syntax/mixin/allow_no_message'
+require 'transpec/syntax/mixin/messaging_host'
 require 'transpec/util'
 require 'English'
 
 module Transpec
   class Syntax
     class MethodStub < Syntax
-      include Mixin::MonkeyPatchAnyInstance, Mixin::AnyInstanceBlock, Mixin::AllowNoMessage, Util
+      include Mixin::MonkeyPatchAnyInstance, Mixin::MessagingHost, Util
 
       # rubocop:disable LineLength
       CLASSES_DEFINING_OWN_STUB_METHOD = [
@@ -84,6 +83,16 @@ module Transpec
         register_record(:deprecated)
       end
 
+      def remove_no_message_allowance!
+        return unless allow_no_message?
+        super
+        register_record(:no_message_allowance)
+      end
+
+      def remove_useless_and_return!
+        super && register_record(:useless_and_return)
+      end
+
       def add_receiver_arg_to_any_instance_implementation_block!
         super && register_record(:any_instance_block)
       end
@@ -163,9 +172,13 @@ module Transpec
       def register_record(conversion_type)
         record_class = case conversion_type
                        when :deprecated
-                         DeprecatedRecord
+                         DeprecatedMethodRecord
+                       when :no_message_allowance
+                         NoMessageAllowanceRecord
+                       when :useless_and_return
+                         MonkeyPatchUselessAndReturnRecord
                        when :any_instance_block
-                         AnyInstanceBlockRecord
+                         MonkeyPatchAnyInstanceBlockRecord
                        else
                          AllowRecord
                        end
@@ -207,7 +220,7 @@ module Transpec
         end
       end
 
-      class DeprecatedRecord < Record
+      class DeprecatedMethodRecord < Record
         def initialize(method_stub, *)
           @method_stub = method_stub
         end
@@ -223,6 +236,29 @@ module Transpec
           syntax << '(:message)'
         end
       end
+
+      class NoMessageAllowanceRecord < Record
+        def initialize(method_stub, *)
+          @method_stub = method_stub
+        end
+
+        def original_syntax
+          syntax = base_syntax
+          syntax << '.any_number_of_times' if @method_stub.any_number_of_times?
+          syntax << '.at_least(0)' if @method_stub.at_least_zero?
+          syntax
+        end
+
+        def converted_syntax
+          base_syntax
+        end
+
+        private
+
+        def base_syntax
+          "obj.#{@method_stub.method_name}(:message)"
+        end
+      end
     end
   end
 end

data/lib/transpec/syntax/mixin/any_instance_block.rb

@@ -2,6 +2,7 @@
 
 require 'active_support/concern'
 require 'transpec/syntax/mixin/send'
+require 'transpec/util'
 
 module Transpec
   class Syntax
@@ -24,9 +25,7 @@ module Transpec
 
         def any_instance_block_node
           return unless any_instance?
-          each_chained_method_node do |node, _|
-            return node if node.block_type?
-          end
+          Util.each_backward_chained_node(node).find(&:block_type?)
         end
 
         class AnyInstanceBlockRecord < Record
@@ -35,11 +34,21 @@ module Transpec
           end
 
           def original_syntax
-            "Klass.any_instance.#{@host.method_name}(:message) { |arg| }"
+            "#{base_syntax} { |arg| }"
           end
 
           def converted_syntax
-            "Klass.any_instance.#{@host.method_name}(:message) { |instance, arg| }"
+            "#{base_syntax} { |instance, arg| }"
+          end
+
+          def base_syntax
+            fail NotImplementedError
+          end
+        end
+
+        class MonkeyPatchAnyInstanceBlockRecord < AnyInstanceBlockRecord
+          def base_syntax
+            "Klass.any_instance.#{@host.method_name}(:message)"
           end
         end
       end

data/lib/transpec/syntax/mixin/expect_base.rb

@@ -27,6 +27,10 @@ module Transpec
           :expect
         end
 
+        def method_name_for_instance
+          fail NotImplementedError
+        end
+
         def positive?
           to_method_name = to_node.children[1]
           to_method_name == :to
@@ -34,11 +38,8 @@ module Transpec
 
         def matcher_node
           to_arg_node = to_node.children[2]
-          if to_arg_node.block_type?
-            to_arg_node.children.first
-          else
-            to_arg_node
-          end
+          Util.each_forward_chained_node(to_arg_node, :include_origin)
+            .select(&:send_type?).to_a.last
         end
 
         def block_node

data/lib/transpec/syntax/mixin/messaging_host.rb

@@ -0,0 +1,17 @@
+# coding: utf-8
+
+require 'active_support/concern'
+require 'transpec/syntax/mixin/any_instance_block'
+require 'transpec/syntax/mixin/no_message_allowance'
+require 'transpec/syntax/mixin/useless_and_return'
+
+module Transpec
+  class Syntax
+    module Mixin
+      module MessagingHost
+        extend ActiveSupport::Concern
+        include Mixin::AnyInstanceBlock, Mixin::NoMessageAllowance, Mixin::UselessAndReturn
+      end
+    end
+  end
+end

data/lib/transpec/syntax/mixin/{allow_no_message.rb → no_message_allowance.rb}

@@ -2,12 +2,13 @@
 
 require 'active_support/concern'
 require 'transpec/syntax/mixin/send'
+require 'transpec/util'
 require 'ast'
 
 module Transpec
   class Syntax
     module Mixin
-      module AllowNoMessage
+      module NoMessageAllowance
         extend ActiveSupport::Concern
         include Send, ::AST::Sexp
 
@@ -15,7 +16,7 @@ module Transpec
           any_number_of_times? || at_least_zero?
         end
 
-        def remove_allowance_for_no_message!
+        def remove_no_message_allowance!
           remove_any_number_of_times!
           remove_at_least_zero!
         end
@@ -47,14 +48,14 @@ module Transpec
         end
 
         def any_number_of_times_node
-          each_chained_method_node do |chained_node|
+          Util.each_backward_chained_node(node) do |chained_node|
             method_name = chained_node.children[1]
             return chained_node if method_name == :any_number_of_times
           end
         end
 
         def at_least_zero_node
-          each_chained_method_node do |chained_node|
+          Util.each_backward_chained_node(node) do |chained_node|
             _, method_name, arg_node = *chained_node
             next unless method_name == :at_least
             return chained_node if arg_node == s(:int, 0)

data/lib/transpec/syntax/mixin/send.rb

@@ -107,19 +107,6 @@ module Transpec
         def range_after_arg
           arg_range.end.join(expression_range.end)
         end
-
-        def each_chained_method_node
-          return to_enum(__method__) unless block_given?
-
-          @node.each_ancestor_node.reduce(@node) do |child_node, parent_node|
-            return unless [:send, :block].include?(parent_node.type)
-            return unless parent_node.children.first == child_node
-            yield parent_node, child_node
-            parent_node
-          end
-
-          nil
-        end
       end
     end
   end

data/lib/transpec/syntax/mixin/should_base.rb

@@ -4,6 +4,7 @@ require 'active_support/concern'
 require 'transpec/syntax/mixin/send'
 require 'transpec/syntax/mixin/have_matcher_owner'
 require 'transpec/syntax/operator_matcher'
+require 'transpec/util'
 
 module Transpec
   class Syntax
@@ -25,7 +26,12 @@ module Transpec
         end
 
         def matcher_node
-          arg_node || parent_node
+          if arg_node
+            Util.each_forward_chained_node(arg_node, :include_origin)
+              .select(&:send_type?).to_a.last
+          else
+            parent_node
+          end
         end
 
         def should_range

data/lib/transpec/syntax/mixin/useless_and_return.rb

@@ -0,0 +1,79 @@
+# coding: utf-8
+
+require 'active_support/concern'
+require 'transpec/syntax/mixin/send'
+require 'transpec/util'
+
+module Transpec
+  class Syntax
+    module Mixin
+      module UselessAndReturn
+        extend ActiveSupport::Concern
+        include Send
+
+        def remove_useless_and_return!
+          return unless useless_and_return?
+          map = and_return_node.loc
+          and_return_range = map.dot.join(map.expression.end)
+          remove(and_return_range)
+          true
+        end
+
+        def useless_and_return?
+          return false unless and_return?
+          arg_node = and_return_node.children[2]
+          arg_node.nil?
+        end
+
+        def and_return_with_block?
+          block_node = Util.block_node_taken_by_method(and_return_node)
+          !block_node.nil?
+        end
+
+        def and_return?
+          !and_return_node.nil?
+        end
+
+        def and_return_node
+          return @and_return_node if instance_variable_defined?(:@and_return_node)
+
+          @and_return_node = Util.each_backward_chained_node(node) do |chained_node|
+            method_name = chained_node.children[1]
+            break chained_node if method_name == :and_return
+          end
+        end
+
+        class UselessAndReturnRecord < Record
+          def initialize(host, *)
+            @host = host
+          end
+
+          def original_syntax
+            syntax = base_syntax
+            syntax << '.and_return'
+            syntax << ' { value }' if @host.and_return_with_block?
+            syntax
+          end
+
+          def converted_syntax
+            syntax = base_syntax
+            syntax << ' { value }' if @host.and_return_with_block?
+            syntax
+          end
+
+          private
+
+          def base_syntax
+            fail NotImplementedError
+          end
+        end
+
+        class MonkeyPatchUselessAndReturnRecord < UselessAndReturnRecord
+          def base_syntax
+            "obj.#{@host.method_name}(:message)"
+          end
+        end
+      end
+    end
+  end
+end