transpec 1.9.3 → 1.10.0

data/lib/transpec/configuration.rb

@@ -13,6 +13,7 @@ module Transpec
       [:convert_stub,                                          true],
       [:convert_have_items,                                    true],
       [:convert_its,                                           true],
+      [:convert_pending,                                       true],
       [:convert_deprecated_method,                             true],
       [:parenthesize_matcher_arg,                              true],
       [:add_receiver_arg_to_any_instance_implementation_block, true],

data/lib/transpec/conversion_error.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+require 'transpec/annotatable'
+
+module Transpec
+  class ConversionError < StandardError
+    include Annotatable
+  end
+
+  class ContextError < ConversionError
+    def initialize(original_syntax, target_syntax, source_range)
+      message = build_message(original_syntax, target_syntax)
+      super(message, source_range)
+    end
+
+    private
+
+    def build_message(original_syntax, target_syntax)
+      "Cannot convert #{original_syntax} into #{target_syntax} " +
+      "since #{target_syntax} is not available in the context."
+    end
+  end
+end

data/lib/transpec/converter.rb

@@ -9,18 +9,17 @@ require 'transpec/syntax'
 Transpec::Syntax.require_all
 
 module Transpec
-  class Converter < BaseRewriter
-    attr_reader :configuration, :rspec_version, :runtime_data, :report, :context_errors
+  class Converter < BaseRewriter # rubocop:disable ClassLength
+    attr_reader :configuration, :rspec_version, :runtime_data, :report
 
     alias_method :convert_file!, :rewrite_file!
     alias_method :convert, :rewrite
 
-    def initialize(configuration = nil, rspec_version = nil, runtime_data = nil, report = nil)
+    def initialize(configuration = nil, rspec_version = nil, runtime_data = nil)
       @configuration = configuration || Configuration.new
       @rspec_version = rspec_version || Transpec.current_rspec_version
       @runtime_data = runtime_data
-      @report = report || Report.new
-      @context_errors = []
+      @report = Report.new
     end
 
     def process(ast, source_rewriter)
@@ -32,9 +31,9 @@ module Transpec
 
     def dispatch_node(node, source_rewriter)
       Syntax.standalone_syntaxes.each do |syntax_class|
-        next unless syntax_class.conversion_target_node?(node, @runtime_data)
+        next unless syntax_class.conversion_target_node?(node, runtime_data)
 
-        syntax = syntax_class.new(node, source_rewriter, @runtime_data, @report)
+        syntax = syntax_class.new(node, source_rewriter, runtime_data, report)
 
         handler_name = "process_#{syntax_class.snake_case_name}"
         send(handler_name, syntax)
@@ -42,15 +41,15 @@ module Transpec
         break
       end
     rescue OverlappedRewriteError # rubocop:disable HandleExceptions
-    rescue ContextError => error
-      @context_errors << error
+    rescue ConversionError => error
+      report.conversion_errors << error
     end
 
     def process_should(should)
-      if @configuration.convert_should?
+      if configuration.convert_should?
         should.expectize!(
-          @configuration.negative_form_of_to,
-          @configuration.parenthesize_matcher_arg?
+          configuration.negative_form_of_to,
+          configuration.parenthesize_matcher_arg?
         )
       end
 
@@ -59,22 +58,22 @@ module Transpec
     end
 
     def process_oneliner_should(oneliner_should)
-      negative_form = @configuration.negative_form_of_to
-      parenthesize = @configuration.parenthesize_matcher_arg?
+      negative_form = configuration.negative_form_of_to
+      parenthesize = configuration.parenthesize_matcher_arg?
 
       # TODO: Referencing oneliner_should.have_matcher.project_requires_collection_matcher?
       #   from this converter is considered bad design.
-      should_convert_have_items = @configuration.convert_have_items? &&
+      should_convert_have_items = configuration.convert_have_items? &&
                                   oneliner_should.have_matcher &&
                                   !oneliner_should.have_matcher.project_requires_collection_matcher?
 
       if should_convert_have_items
-        if @configuration.convert_should?
+        if configuration.convert_should?
           oneliner_should.convert_have_items_to_standard_expect!(negative_form, parenthesize)
         else
           oneliner_should.convert_have_items_to_standard_should!
         end
-      elsif @configuration.convert_oneliner? && @rspec_version.oneliner_is_expected_available?
+      elsif configuration.convert_oneliner? && rspec_version.oneliner_is_expected_available?
         oneliner_should.expectize!(negative_form, parenthesize)
       end
 
@@ -93,79 +92,89 @@ module Transpec
 
     def process_should_receive(should_receive)
       if should_receive.useless_expectation?
-        if @configuration.convert_deprecated_method?
-          if @configuration.convert_stub?
-            should_receive.allowize_useless_expectation!(@configuration.negative_form_of_to)
+        if configuration.convert_deprecated_method?
+          if configuration.convert_stub?
+            should_receive.allowize_useless_expectation!(configuration.negative_form_of_to)
           else
             should_receive.stubize_useless_expectation!
           end
-        elsif @configuration.convert_should_receive?
-          should_receive.expectize!(@configuration.negative_form_of_to)
+        elsif configuration.convert_should_receive?
+          should_receive.expectize!(configuration.negative_form_of_to)
         end
-      elsif @configuration.convert_should_receive?
-        should_receive.expectize!(@configuration.negative_form_of_to)
+      elsif configuration.convert_should_receive?
+        should_receive.expectize!(configuration.negative_form_of_to)
       end
 
       process_messaging_host(should_receive)
     end
 
     def process_double(double)
-      double.convert_to_double! if @configuration.convert_deprecated_method?
+      double.convert_to_double! if configuration.convert_deprecated_method?
     end
 
     def process_method_stub(method_stub)
-      if @configuration.convert_stub?
+      if configuration.convert_stub?
         if !method_stub.hash_arg? ||
-           @rspec_version.receive_messages_available? ||
-           @configuration.convert_stub_with_hash_to_stub_and_return?
-          method_stub.allowize!(@rspec_version)
-        elsif @configuration.convert_deprecated_method?
+           rspec_version.receive_messages_available? ||
+           configuration.convert_stub_with_hash_to_stub_and_return?
+          method_stub.allowize!(rspec_version)
+        elsif configuration.convert_deprecated_method?
           method_stub.convert_deprecated_method!
         end
-      elsif @configuration.convert_deprecated_method?
+      elsif configuration.convert_deprecated_method?
         method_stub.convert_deprecated_method!
       end
 
-      method_stub.remove_no_message_allowance! if @configuration.convert_deprecated_method?
+      method_stub.remove_no_message_allowance! if configuration.convert_deprecated_method?
 
       process_messaging_host(method_stub)
     end
 
     def process_be_boolean(be_boolean)
-      return unless @rspec_version.be_truthy_available?
-      return unless @configuration.convert_deprecated_method?
+      return unless rspec_version.be_truthy_available?
+      return unless configuration.convert_deprecated_method?
 
-      case @configuration.boolean_matcher_type
+      case configuration.boolean_matcher_type
       when :conditional
-        be_boolean.convert_to_conditional_matcher!(@configuration.form_of_be_falsey)
+        be_boolean.convert_to_conditional_matcher!(configuration.form_of_be_falsey)
       when :exact
         be_boolean.convert_to_exact_matcher!
       end
     end
 
     def process_be_close(be_close)
-      be_close.convert_to_be_within! if @configuration.convert_deprecated_method?
+      be_close.convert_to_be_within! if configuration.convert_deprecated_method?
     end
 
     def process_raise_error(raise_error)
       return unless raise_error
-      if @configuration.convert_deprecated_method?
+      if configuration.convert_deprecated_method?
         raise_error.remove_error_specification_with_negative_expectation!
       end
     end
 
     def process_its(its)
-      its.convert_to_describe_subject_it! if @configuration.convert_its?
+      its.convert_to_describe_subject_it! if configuration.convert_its?
     end
 
     def process_example(example)
-      return unless @rspec_version.yielded_example_available?
-      example.convert! if @configuration.convert_deprecated_method?
+      return if !rspec_version.rspec_2_99? || !configuration.convert_pending?
+      example.convert_pending_to_skip!
+    end
+
+    def process_pending(pending)
+      return if !rspec_version.rspec_2_99? || !configuration.convert_pending?
+      pending.convert_deprecated_syntax!
+    end
+
+    def process_current_example(current_example)
+      return unless rspec_version.yielded_example_available?
+      current_example.convert! if configuration.convert_deprecated_method?
     end
 
     def process_matcher_definition(matcher_definition)
-      return unless @rspec_version.non_should_matcher_protocol_available?
-      matcher_definition.convert_deprecated_method! if @configuration.convert_deprecated_method?
+      return unless rspec_version.non_should_matcher_protocol_available?
+      matcher_definition.convert_deprecated_method! if configuration.convert_deprecated_method?
     end
 
     def process_rspec_configure(rspec_configure)
@@ -177,7 +186,7 @@ module Transpec
         rspec_configure.mocks.syntaxes = :expect
       end
 
-      if rspec_version.migration_term_of_any_instance_implementation_block? &&
+      if rspec_version.rspec_2_99? &&
            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
@@ -185,8 +194,8 @@ module Transpec
     end
 
     def process_have(have)
-      return if !have || !@configuration.convert_have_items?
-      have.convert_to_standard_expectation!(@configuration.parenthesize_matcher_arg)
+      return if !have || !configuration.convert_have_items?
+      have.convert_to_standard_expectation!(configuration.parenthesize_matcher_arg)
     end
 
     def process_messaging_host(messaging_host)
@@ -202,22 +211,22 @@ module Transpec
 
     def process_any_instance_block(messaging_host)
       return unless messaging_host
-      return unless rspec_version.migration_term_of_any_instance_implementation_block?
+      return unless rspec_version.rspec_2_99?
       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?
+      return false unless configuration.convert_should?
       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?
+      return false if !configuration.convert_should_receive? &&
+                      !configuration.convert_stub?
       rspec_configure.mocks.syntaxes == [:should]
     rescue Syntax::RSpecConfigure::Framework::UnknownSyntaxError
       false

data/lib/transpec/dynamic_analyzer.rb

@@ -13,7 +13,7 @@ require 'English'
 
 module Transpec
   class DynamicAnalyzer
-    ANALYSIS_METHOD = 'transpec_analysis'
+    ANALYSIS_METHOD = 'transpec_analyze'
     HELPER_FILE = 'transpec_analysis_helper.rb'
     RESULT_FILE = 'transpec_analysis_result.json'
     HELPER_SOURCE = <<-END
@@ -26,16 +26,6 @@ module Transpec
           @data ||= {}
         end
 
-        def self.node_id(filename, begin_pos, end_pos)
-          absolute_path = File.expand_path(filename)
-          relative_path = Pathname.new(absolute_path).relative_path_from(base_pathname).to_s
-          [relative_path, begin_pos, end_pos].join('_')
-        end
-
-        def self.base_pathname
-          @base_pathname ||= Pathname.new(@base_path)
-        end
-
         at_exit do
           # Use JSON rather than Marshal so that:
           # * Unknown third-party class information won't be serialized.
@@ -50,28 +40,22 @@ module Transpec
         end
       end
 
-      def #{ANALYSIS_METHOD}(object, context, analysis_codes, filename, begin_pos, end_pos)
-        pair_array = analysis_codes.map do |key, (target_type, code)|
+      def #{ANALYSIS_METHOD}(object, context, node_id, analysis_codes)
+        node_data = {}
+
+        analysis_codes.each do |key, (target_type, code)|
           target = case target_type
                    when :object  then object
                    when :context then context
                    end
 
-          eval_data = {}
-
           begin
-            eval_data[:result] = target.instance_eval(code)
-          rescue Exception => error
-            eval_data[:error] = error
+            node_data[key] = target.instance_eval(code)
+          rescue Exception
           end
-
-          [key, eval_data]
         end
 
-        object_data = Hash[pair_array]
-
-        id = TranspecAnalysis.node_id(filename, begin_pos, end_pos)
-        TranspecAnalysis.data[id] = object_data
+        TranspecAnalysis.data[node_id] = node_data
 
         object
       end
@@ -93,7 +77,7 @@ module Transpec
     end
 
     def default_rspec_command
-      if @project.require_bundler?
+      if project.require_bundler?
         'bundle exec rspec'
       else
         'rspec'
@@ -128,9 +112,9 @@ module Transpec
       @in_copied_project = true
 
       Dir.mktmpdir do |tmpdir|
-        copy_recursively(@project.path, tmpdir)
-        @copied_project_path = File.join(tmpdir, @project.basename)
-        Dir.chdir(@copied_project_path) do
+        copy_recursively(project.path, tmpdir)
+        copied_project_path = File.join(tmpdir, project.basename)
+        Dir.chdir(copied_project_path) do
           yield
         end
       end
@@ -139,7 +123,7 @@ module Transpec
     end
 
     def run_rspec(paths)
-      @project.with_bundler_clean_env do
+      project.with_bundler_clean_env do
         ENV['SPEC_OPTS'] = ['-r', "./#{HELPER_FILE}"].shelljoin
 
         command = "#{rspec_command} #{paths.shelljoin}"

data/lib/transpec/dynamic_analyzer/rewriter.rb

@@ -54,11 +54,11 @@ module Transpec
 
       def process_requests(source_rewriter)
         requests.each do |node, analysis_codes|
-          inject_analysis_method(node, analysis_codes, source_rewriter)
+          inject_analysis_code(node, analysis_codes, source_rewriter)
         end
       end
 
-      def inject_analysis_method(node, analysis_codes, source_rewriter)
+      def inject_analysis_code(node, analysis_codes, source_rewriter)
         front, rear = build_wrapper_codes(node, analysis_codes)
 
         source_range = if (block_node = block_node_taken_by_method(node))
@@ -73,15 +73,8 @@ module Transpec
       end
 
       def build_wrapper_codes(node, analysis_codes)
-        source_range = node.loc.expression
-
         front = "#{ANALYSIS_METHOD}(("
-
-        rear = format(
-          '), self, %s, __FILE__, %d, %d)',
-          hash_literal(analysis_codes), source_range.begin_pos, source_range.end_pos
-        )
-
+        rear = format('), self, %s, %s)', node_id(node).inspect, hash_literal(analysis_codes))
         [front, rear]
       end
 

data/lib/transpec/dynamic_analyzer/runtime_data.rb

@@ -1,5 +1,6 @@
 # coding: utf-8
 
+require 'transpec/util'
 require 'json'
 require 'ostruct'
 require 'pathname'
@@ -7,6 +8,8 @@ require 'pathname'
 module Transpec
   class DynamicAnalyzer
     class RuntimeData
+      include Util
+
       attr_reader :data
 
       def self.load(string_or_io)
@@ -19,16 +22,21 @@ module Transpec
         @data = data
       end
 
-      def [](node)
-        @data[node_id(node)]
+      def [](node, key = nil)
+        node_data = data[node_id(node)]
+        return nil unless node_data
+        return node_data unless key
+        node_data[key]
+      end
+
+      def run?(node)
+        !self[node].nil?
       end
 
-      def node_id(node)
-        source_range = node.loc.expression
-        source_buffer = source_range.source_buffer
-        absolute_path = File.expand_path(source_buffer.name)
-        relative_path = Pathname.new(absolute_path).relative_path_from(Pathname.pwd).to_s
-        [relative_path, source_range.begin_pos, source_range.end_pos].join('_')
+      def present?(node, key)
+        node_data = self[node]
+        return false unless node_data
+        node_data.respond_to?(key)
       end
 
       class CompatibleOpenStruct < OpenStruct

data/lib/transpec/file_finder.rb

@@ -12,7 +12,7 @@ module Transpec
           file_paths.concat(ruby_files_in_directory(path))
         elsif File.file?(path)
           file_paths << path
-        elsif !File.exists?(path)
+        elsif !File.exist?(path)
           fail ArgumentError, "No such file or directory #{path.inspect}"
         end
       end