transpec 1.6.1 → 1.7.0

data/lib/transpec/ast/node.rb

@@ -5,6 +5,46 @@ require 'parser'
 module Transpec
   module AST
     class Node < Parser::AST::Node
+      TYPES = %w(
+        true false nil
+        int float
+        str dstr
+        sym dsym
+        xstr
+        regexp regopt
+        array splat
+        hash pair kwsplat
+        irange erange
+        self
+        lvar ivar cvar gvar
+        nth_ref back_ref
+        const cbase
+        defined?
+        lvasgn ivasgn cvasgn gvasgn
+        casgn
+        masgn mlhs
+        op_asgn or_asgn and_asgn
+        module class sclass
+        def defs undef
+        alias
+        args
+        arg optarg restarg blockarg shadowarg kwarg kwoptarg kwrestarg
+        send
+        super zsuper
+        yield
+        block block_pass
+        and or not
+        if
+        case when
+        while until while_post until_post for
+        break next redo return
+        begin
+        rescue resbody ensure retry
+        preexe postexe
+        iflipflop eflipflop
+        match_current_line match_with_lvasgn
+      ).map(&:to_sym).freeze
+
       attr_reader :metadata
 
       def initialize(type, children = [], properties = {})
@@ -19,6 +59,13 @@ module Transpec
         end
       end
 
+      TYPES.each do |node_type|
+        method_name = "#{node_type.to_s.gsub(/\W/, '')}_type?"
+        define_method(method_name) do
+          type == node_type
+        end
+      end
+
       def parent_node
         @mutable_attributes[:parent_node]
       end

data/lib/transpec/cli.rb

@@ -111,7 +111,7 @@ module Transpec
       Git.write_commit_message(commit_message.to_s)
 
       puts
-      puts 'A commit message that describes the conversion summary was generated to'.color(:cyan)
+      puts 'A commit message which describes the conversion summary was generated to'.color(:cyan)
       puts '.git/COMMIT_EDITMSG. To use the message, type the following command for'.color(:cyan)
       puts 'the next commit:'.color(:cyan)
       puts '    git commit -eF .git/COMMIT_EDITMSG'

data/lib/transpec/commit_message.rb

@@ -17,10 +17,20 @@ module Transpec
         |Convert specs to RSpec #{@rspec_version} syntax with Transpec
         |
         |This conversion is done by Transpec #{Transpec::Version} with the following command:
-        |    transpec #{@cli_args.join(' ')}
+        |    transpec #{smart_cli_args}
         |
         |#{conversion_summary}
       END
     end
+
+    def smart_cli_args
+      @cli_args.map do |arg|
+        if arg.include?(' ')
+          arg.inspect
+        else
+          arg
+        end
+      end.join(' ')
+    end
   end
 end

data/lib/transpec/configuration.rb

@@ -7,16 +7,17 @@ module Transpec
     BOOLEAN_MATCHER_TYPES = [:conditional, :exact].freeze
 
     PREDICATES = [
-      [:convert_should,            true],
-      [:convert_oneliner,          true],
-      [:convert_should_receive,    true],
-      [:convert_stub,              true],
-      [:convert_have_items,        true],
-      [:convert_its,               true],
-      [:convert_deprecated_method, true],
-      [:parenthesize_matcher_arg,  true],
-      [:forced,                    false],
-      [:skip_dynamic_analysis,     false]
+      [:convert_should,                                        true],
+      [:convert_oneliner,                                      true],
+      [:convert_should_receive,                                true],
+      [:convert_stub,                                          true],
+      [:convert_have_items,                                    true],
+      [:convert_its,                                           true],
+      [:convert_deprecated_method,                             true],
+      [:parenthesize_matcher_arg,                              true],
+      [:add_receiver_arg_to_any_instance_implementation_block, true],
+      [:forced,                                                false],
+      [:skip_dynamic_analysis,                                 false]
     ].freeze
 
     PREDICATES.each do |predicate, _|

data/lib/transpec/converter.rb

@@ -54,10 +54,7 @@ module Transpec
         )
       end
 
-      if should.have_matcher && @configuration.convert_have_items?
-        parenthesize_matcher_arg = @configuration.parenthesize_matcher_arg
-        should.have_matcher.convert_to_standard_expectation!(parenthesize_matcher_arg)
-      end
+      process_have(should.have_matcher)
     end
 
     def process_oneliner_should(oneliner_should)
@@ -82,10 +79,12 @@ module Transpec
     end
 
     def process_expect(expect)
-      if expect.have_matcher && @configuration.convert_have_items?
-        parenthesize_matcher_arg = @configuration.parenthesize_matcher_arg
-        expect.have_matcher.convert_to_standard_expectation!(parenthesize_matcher_arg)
-      end
+      process_have(expect.have_matcher)
+      process_any_instance_block(expect.receive_matcher)
+    end
+
+    def process_allow(allow)
+      process_any_instance_block(allow.receive_matcher)
     end
 
     def process_should_receive(should_receive)
@@ -102,6 +101,8 @@ module Transpec
       elsif @configuration.convert_should_receive?
         should_receive.expectize!(@configuration.negative_form_of_to)
       end
+
+      process_any_instance_block(should_receive)
     end
 
     def process_double(double)
@@ -116,6 +117,8 @@ module Transpec
       end
 
       method_stub.remove_allowance_for_no_message! if @configuration.convert_deprecated_method?
+
+      process_any_instance_block(method_stub)
     end
 
     def process_be_boolean(be_boolean)
@@ -156,26 +159,45 @@ module Transpec
 
     def process_rspec_configure(rspec_configure)
       if need_to_modify_expectation_syntax_configuration?(rspec_configure)
-        rspec_configure.modify_expectation_syntaxes!(:expect)
+        rspec_configure.expectations.syntaxes = :expect
       end
 
       if need_to_modify_mock_syntax_configuration?(rspec_configure)
-        rspec_configure.modify_mock_syntaxes!(:expect)
+        rspec_configure.mocks.syntaxes = :expect
       end
+
+      if rspec_version.migration_term_of_any_instance_implementation_block? &&
+           configuration.convert_deprecated_method?
+        should_yield = configuration.add_receiver_arg_to_any_instance_implementation_block?
+        rspec_configure.mocks.yield_receiver_to_any_instance_implementation_blocks = should_yield
+      end
+    end
+
+    def process_have(have)
+      return if !have || !@configuration.convert_have_items?
+      have.convert_to_standard_expectation!(@configuration.parenthesize_matcher_arg)
+    end
+
+    def process_any_instance_block(messaging_host)
+      return unless messaging_host
+      return unless rspec_version.migration_term_of_any_instance_implementation_block?
+      return unless configuration.convert_deprecated_method?
+      return unless configuration.add_receiver_arg_to_any_instance_implementation_block?
+      messaging_host.add_receiver_arg_to_any_instance_implementation_block!
     end
 
     def need_to_modify_expectation_syntax_configuration?(rspec_configure)
       return false unless @configuration.convert_should?
-      rspec_configure.expectation_syntaxes == [:should]
-    rescue Syntax::RSpecConfigure::UnknownSyntaxError
+      rspec_configure.expectations.syntaxes == [:should]
+    rescue Syntax::RSpecConfigure::Framework::UnknownSyntaxError
       false
     end
 
     def need_to_modify_mock_syntax_configuration?(rspec_configure)
       return false if !@configuration.convert_should_receive? &&
                       !@configuration.convert_stub?
-      rspec_configure.mock_syntaxes == [:should]
-    rescue Syntax::RSpecConfigure::UnknownSyntaxError
+      rspec_configure.mocks.syntaxes == [:should]
+    rescue Syntax::RSpecConfigure::Framework::UnknownSyntaxError
       false
     end
   end

data/lib/transpec/dynamic_analyzer/rewriter.rb

@@ -61,8 +61,8 @@ module Transpec
       def inject_analysis_method(node, analysis_codes, source_rewriter)
         front, rear = build_wrapper_codes(node, analysis_codes)
 
-        source_range = if taking_block?(node)
-                         node.parent_node.loc.expression
+        source_range = if (block_node = block_node_taken_by_method(node))
+                         block_node.loc.expression
                        else
                          node.loc.expression
                        end

data/lib/transpec/option_parser.rb

@@ -6,6 +6,8 @@ require 'transpec/version'
 require 'optparse'
 require 'rainbow'
 
+# rubocop:disable ClassLength
+
 module Transpec
   class OptionParser
     CONFIG_ATTRS_FOR_KEEP_TYPES = {
@@ -80,6 +82,10 @@ module Transpec
         @configuration.form_of_be_falsey = type.include?('falsy') ? 'be_falsy' : 'be_falsey'
       end
 
+      define_option('-a', '--no-yield-any-instance') do
+        @configuration.add_receiver_arg_to_any_instance_implementation_block = false
+      end
+
       define_option('-p', '--no-parentheses-matcher-arg') do
         @configuration.parenthesize_matcher_arg = false
       end
@@ -151,6 +157,11 @@ module Transpec
           "  #{'true,false'.bright}    (exact equality)",
           "Default: #{'truthy,falsey'.bright}"
         ],
+        '-a' => [
+          'Suppress yielding receiver instances to',
+          "#{'any_instance'.underline} implementation blocks as the",
+          'first block argument.'
+        ],
         '-p' => [
           'Suppress parenthesizing arguments of matchers',
           "when converting #{'should'.underline} with operator matcher",

data/lib/transpec/report.rb

@@ -49,12 +49,19 @@ module Transpec
 
     private
 
+    def rainbow
+      @rainbow ||=  Rainbow.new
+    end
+
+    def colorize(string, *args)
+      rainbow.wrap(string).color(*args)
+    end
+
     def without_color
-      # TODO: Consider using another coloring gem that does not depend global state.
-      original_coloring_state = Rainbow.enabled
-      Rainbow.enabled = false
+      original_coloring_state = rainbow.enabled
+      rainbow.enabled = false
       value = yield
-      Rainbow.enabled = original_coloring_state
+      rainbow.enabled = original_coloring_state
       value
     end
 
@@ -66,9 +73,9 @@ module Transpec
                       ''
                     end
 
-      text = entry_prefix + pluralize(count, 'conversion').color(:cyan) + "\n"
-      text << indentation + '  ' + 'from: '.color(:cyan) + record.original_syntax + "\n"
-      text << indentation + '    ' + 'to: '.color(:cyan) + record.converted_syntax + "\n"
+      text = entry_prefix + colorize(pluralize(count, 'conversion'), :cyan) + "\n"
+      text << indentation + '  ' + colorize('from: ', :cyan) + record.original_syntax + "\n"
+      text << indentation + '    ' + colorize('to: ', :cyan) + record.converted_syntax + "\n"
     end
 
     def convertion_and_incomplete_stats
@@ -76,7 +83,7 @@ module Transpec
 
       text = pluralize(records.count, 'conversion') + ', '
       text << pluralize(context_errors.count, 'incomplete') + ', '
-      text.color(color)
+      colorize(text, color)
     end
 
     def error_stats
@@ -88,7 +95,7 @@ module Transpec
                 :yellow
               end
 
-      pluralize(syntax_errors.count, 'error').color(color)
+      colorize(pluralize(syntax_errors.count, 'error'), color)
     end
 
     def pluralize(number, thing, options = {})

data/lib/transpec/rspec_version.rb

@@ -43,9 +43,18 @@ module Transpec
 
     define_feature :be_truthy,                   '2.99.0.beta1'
     define_feature :yielded_example,             '2.99.0.beta1'
+    define_feature :yielding_receiver_to_any_instance_implementation_block, '2.99.0.beta1'
     define_feature :oneliner_is_expected,        '2.99.0.beta2', except: '3.0.0.beta1'
     define_feature :receive_messages,            '3.0.0.beta1'
     define_feature :receive_message_chain,       '3.0.0.beta2'
     define_feature :non_should_matcher_protocol, '3.0.0.beta2'
+
+    ANY_INSTANCE_IMPLEMENTATION_BLOCK_MIGRATION_BEGIN = new('2.99.0.beta1')
+    ANY_INSTANCE_IMPLEMENTATION_BLOCK_MIGRATION_EXCLUSIVE_END = new('3.0.0.beta1')
+
+    def migration_term_of_any_instance_implementation_block?
+      self >= ANY_INSTANCE_IMPLEMENTATION_BLOCK_MIGRATION_BEGIN &&
+        self < ANY_INSTANCE_IMPLEMENTATION_BLOCK_MIGRATION_EXCLUSIVE_END
+    end
   end
 end

data/lib/transpec/static_context_inspector.rb

@@ -85,7 +85,7 @@ module Transpec
       return false unless TWISTED_SCOPE_TYPES.include?(node.parent_node.type)
       scope_node = node.parent_node
       return true if node.equal?(scope_node.children[0])
-      scope_node.type == :class && node.equal?(scope_node.children[1])
+      scope_node.class_type? && node.equal?(scope_node.children[1])
     end
 
     def scope_type(node)
@@ -95,7 +95,7 @@ module Transpec
       when :block
         special_block_type(node)
       when :defs
-        if node.children.first.type == :self
+        if node.children.first.self_type?
           nil
         else
           node.type
@@ -132,8 +132,8 @@ module Transpec
       return :around if method_name == :around
 
       if arg_node && [:sym, :str].include?(arg_node.type)
-         hook_arg = arg_node.children.first.to_sym
-         return :all_before_after if hook_arg == :all
+        hook_arg = arg_node.children.first.to_sym
+        return :all_before_after if hook_arg == :all
       end
 
       :each_before_after

data/lib/transpec/syntax/allow.rb

@@ -0,0 +1,20 @@
+# coding: utf-8
+
+require 'transpec/syntax'
+require 'transpec/syntax/mixin/expect_base'
+
+module Transpec
+  class Syntax
+    class Allow < Syntax
+      include Mixin::ExpectBase
+
+      def self.target_method?(receiver_node, method_name)
+        receiver_node.nil? && [:allow, :allow_any_instance_of].include?(method_name)
+      end
+
+      def any_instance?
+        method_name == :allow_any_instance_of
+      end
+    end
+  end
+end

data/lib/transpec/syntax/example.rb

@@ -38,7 +38,7 @@ module Transpec
         return @block_node if instance_variable_defined?(:@block_node)
 
         @block_node ||= @node.each_ancestor_node.find do |ancestor_node|
-          next false unless ancestor_node.type == :block
+          next false unless ancestor_node.block_type?
           method_name = method_name_of_block_node(ancestor_node)
           METHODS_YIELD_EXAMPLE.include?(method_name)
         end

data/lib/transpec/syntax/expect.rb

@@ -1,35 +1,20 @@
 # coding: utf-8
 
 require 'transpec/syntax'
-require 'transpec/syntax/mixin/send'
+require 'transpec/syntax/mixin/expect_base'
 require 'transpec/syntax/mixin/have_matcher_owner'
 
 module Transpec
   class Syntax
     class Expect < Syntax
-      include Mixin::Send, Mixin::HaveMatcherOwner
+      include Mixin::ExpectBase, Mixin::HaveMatcherOwner
 
       def self.target_method?(receiver_node, method_name)
-        receiver_node.nil? && method_name == :expect
+        receiver_node.nil? && [:expect, :expect_any_instance_of].include?(method_name)
       end
 
-      def current_syntax_type
-        :expect
-      end
-
-      def positive?
-        to_method_name = parent_node.children[1]
-        to_method_name == :to
-      end
-
-      def matcher_node
-        parent_node.children[2]
-      end
-
-      alias_method :subject_node, :arg_node
-
-      def subject_range
-        subject_node.loc.expression
+      def any_instance?
+        method_name == :expect_any_instance_of
       end
     end
   end

data/lib/transpec/syntax/its.rb

@@ -24,7 +24,7 @@ module Transpec
 
         front, rear = build_wrapper_codes
 
-        insert_before(beginning_of_line_range, front)
+        insert_before(beginning_of_line_range(block_node), front)
         replace(expression_range, 'it')
         insert_after(block_node.loc.expression, rear)
 
@@ -92,12 +92,6 @@ module Transpec
         @base_indentation ||= indentation_of_line(@node)
       end
 
-      def beginning_of_line_range
-        block_range = block_node.loc.expression
-        begin_pos = block_range.begin_pos - block_range.column
-        Parser::Source::Range.new(block_range.source_buffer, begin_pos, begin_pos)
-      end
-
       def register_record
         @report.records << Record.new(original_syntax, converted_syntax)
       end
@@ -124,7 +118,7 @@ module Transpec
         end
 
         def brackets?
-          @node.type == :array
+          @node.array_type?
         end
 
         def literal?