transpec 1.10.4 → 1.11.0

data/lib/transpec/cli.rb

@@ -4,10 +4,10 @@ require 'transpec/commit_message'
 require 'transpec/configuration'
 require 'transpec/converter'
 require 'transpec/dynamic_analyzer'
-require 'transpec/file_finder'
 require 'transpec/option_parser'
 require 'transpec/project'
 require 'transpec/report'
+require 'transpec/spec_suite'
 require 'rainbow'
 require 'rainbow/ext/string' unless String.method_defined?(:color)
 
@@ -34,7 +34,12 @@ module Transpec
         return false
       end
 
-      process(paths)
+      begin
+        process(paths)
+      rescue DynamicAnalyzer::AnalysisError
+        warn_dynamic_analysis_error
+        return false
+      end
 
       display_summary
       generate_commit_message
@@ -50,16 +55,23 @@ module Transpec
         runtime_data = run_dynamic_analysis(paths)
       end
 
-      FileFinder.find(paths).each do |file_path|
-        convert_file(file_path, runtime_data)
+      spec_suite = SpecSuite.new(paths, runtime_data)
+      # Actually #analyze does not need to be invoked here, but doing this will avoid long freeze
+      # while conversion of files.
+      puts 'Aggregating spec suite data...'
+      spec_suite.analyze
+      puts
+
+      spec_suite.specs.each do |spec|
+        convert_spec(spec, spec_suite)
       end
     end
 
-    def convert_file(file_path, runtime_data = nil)
-      puts "Converting #{file_path}"
+    def convert_spec(spec, spec_suite)
+      puts "Converting #{spec.path}"
 
-      converter = Converter.new(configuration, project.rspec_version, runtime_data)
-      converter.convert_file!(file_path)
+      converter = Converter.new(spec_suite, configuration, project.rspec_version)
+      converter.convert_file!(spec)
 
       warn_annotations(converter.report)
       report << converter.report
@@ -96,12 +108,6 @@ module Transpec
       puts
 
       runtime_data
-    rescue DynamicAnalyzer::AnalysisError
-      warn 'Failed running dynamic analysis. ' \
-           'Transpec needs to run your specs in a copied project directory for dynamic analysis. ' \
-           'If your project requires some special setup or commands to run specs, ' \
-           'use -c/--rspec-command option.'
-      exit(1)
     end
 
     def display_summary
@@ -138,6 +144,13 @@ module Transpec
       puts "Done! Now run #{'rspec'.bright} and check if everything is green."
     end
 
+    def warn_dynamic_analysis_error
+      warn 'Failed running dynamic analysis. ' \
+           'Transpec runs your specs in a copied project directory. ' \
+           'If your project requires some special setup or commands to run specs, ' \
+           'use -c/--rspec-command option.'
+    end
+
     def warn_syntax_error(error)
       warn "Syntax error at #{error.diagnostic.location}. Skipping the file.".color(:red)
     end

data/lib/transpec/configuration.rb

@@ -17,7 +17,8 @@ module Transpec
       [:convert_deprecated_method,                             true],
       [:parenthesize_matcher_arg,                              true],
       [:add_receiver_arg_to_any_instance_implementation_block, true],
-      [:convert_stub_with_hash_to_stub_and_return,             false],
+      [:convert_stub_with_hash_to_allow_to_receive_and_return, false],
+      [:convert_example_group,                                 false],
       [:forced,                                                false],
       [:skip_dynamic_analysis,                                 false]
     ].freeze

data/lib/transpec/converter.rb

@@ -4,24 +4,30 @@ require 'transpec/base_rewriter'
 require 'transpec/configuration'
 require 'transpec/report'
 require 'transpec/rspec_version'
+require 'transpec/spec_suite'
 require 'transpec/syntax'
 
 Transpec::Syntax.require_all
 
 module Transpec
   class Converter < BaseRewriter # rubocop:disable ClassLength
-    attr_reader :configuration, :rspec_version, :runtime_data, :report
+    attr_reader :spec_suite, :configuration, :rspec_version, :report
 
     alias_method :convert_file!, :rewrite_file!
+    alias_method :convert_source, :rewrite_source
     alias_method :convert, :rewrite
 
-    def initialize(configuration = nil, rspec_version = nil, runtime_data = nil)
+    def initialize(spec_suite = nil, configuration = nil, rspec_version = nil)
+      @spec_suite = spec_suite || SpecSuite.new
       @configuration = configuration || Configuration.new
       @rspec_version = rspec_version || Transpec.required_rspec_version
-      @runtime_data = runtime_data
       @report = Report.new
     end
 
+    def runtime_data
+      spec_suite.runtime_data
+    end
+
     def process(ast, source_rewriter)
       return unless ast
       ast.each_node do |node|
@@ -33,10 +39,7 @@ module Transpec
       Syntax.standalone_syntaxes.each do |syntax_class|
         syntax = syntax_class.new(node, source_rewriter, runtime_data, report)
         next unless syntax.conversion_target?
-
-        handler_name = "process_#{syntax_class.snake_case_name}"
-        send(handler_name, syntax)
-
+        dispatch_syntax(syntax)
         break
       end
     rescue OverlappedRewriteError # rubocop:disable HandleExceptions
@@ -44,49 +47,41 @@ module Transpec
       report.conversion_errors << error
     end
 
-    def process_should(should)
-      if configuration.convert_should?
-        should.expectize!(
-          configuration.negative_form_of_to,
-          configuration.parenthesize_matcher_arg?
-        )
+    def dispatch_syntax(syntax)
+      handler_name = "process_#{syntax.class.snake_case_name}"
+      send(handler_name, syntax)
+
+      syntax.dependent_syntaxes.each do |dependent_syntax|
+        next unless dependent_syntax.conversion_target?
+        dispatch_syntax(dependent_syntax)
       end
+    end
 
-      process_have(should.have_matcher)
-      process_raise_error(should.raise_error_matcher)
+    def process_should(should)
+      return unless configuration.convert_should?
+      should.expectize!(configuration.negative_form_of_to)
     end
 
     def process_oneliner_should(oneliner_should)
       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? &&
-                                  oneliner_should.have_matcher &&
-                                  !oneliner_should.have_matcher.project_requires_collection_matcher?
+                                  oneliner_should.have_matcher.conversion_target?
 
       if should_convert_have_items
         if configuration.convert_should?
-          oneliner_should.convert_have_items_to_standard_expect!(negative_form, parenthesize)
+          oneliner_should.convert_have_items_to_standard_expect!(negative_form)
         else
           oneliner_should.convert_have_items_to_standard_should!
         end
       elsif configuration.convert_oneliner? && rspec_version.oneliner_is_expected_available?
-        oneliner_should.expectize!(negative_form, parenthesize)
+        oneliner_should.expectize!(negative_form)
       end
-
-      process_raise_error(oneliner_should.raise_error_matcher)
     end
 
     def process_expect(expect)
-      process_have(expect.have_matcher)
-      process_raise_error(expect.raise_error_matcher)
-      process_messaging_host(expect.receive_matcher)
     end
 
     def process_allow(allow)
-      process_messaging_host(allow.receive_matcher)
     end
 
     def process_should_receive(should_receive)
@@ -115,7 +110,7 @@ module Transpec
       if configuration.convert_stub?
         if !method_stub.hash_arg? ||
            rspec_version.receive_messages_available? ||
-           configuration.convert_stub_with_hash_to_stub_and_return?
+           configuration.convert_stub_with_hash_to_allow_to_receive_and_return?
           method_stub.allowize!(rspec_version)
         elsif configuration.convert_deprecated_method?
           method_stub.convert_deprecated_method!
@@ -129,6 +124,17 @@ module Transpec
       process_messaging_host(method_stub)
     end
 
+    def process_operator(operator)
+      return unless configuration.convert_should?
+      return if operator.expectation.is_a?(Syntax::OnelinerShould) &&
+        !rspec_version.oneliner_is_expected_available?
+      operator.convert_operator!(configuration.parenthesize_matcher_arg?)
+    end
+
+    def process_receive(receive)
+      process_messaging_host(receive)
+    end
+
     def process_be_boolean(be_boolean)
       return unless rspec_version.be_truthy_available?
       return unless configuration.convert_deprecated_method?
@@ -176,7 +182,14 @@ module Transpec
       matcher_definition.convert_deprecated_method! if configuration.convert_deprecated_method?
     end
 
+    def process_example_group(example_group)
+      return unless rspec_version.non_monkey_patch_example_group_available?
+      example_group.convert_to_non_monkey_patch! if configuration.convert_example_group?
+    end
+
     def process_rspec_configure(rspec_configure)
+      return unless spec_suite.main_rspec_configure_node?(rspec_configure.node)
+
       if need_to_modify_expectation_syntax_configuration?(rspec_configure)
         rspec_configure.expectations.syntaxes = :expect
       end
@@ -185,8 +198,12 @@ module Transpec
         rspec_configure.mocks.syntaxes = :expect
       end
 
-      if rspec_version.rspec_2_99? &&
-           configuration.convert_deprecated_method?
+      if rspec_version.non_monkey_patch_example_group_available? &&
+         configuration.convert_example_group?
+        rspec_configure.expose_dsl_globally = false
+      end
+
+      if need_to_modify_yield_receiver_to_any_instance_implementation_blocks_config?
         should_yield = configuration.add_receiver_arg_to_any_instance_implementation_block?
         rspec_configure.mocks.yield_receiver_to_any_instance_implementation_blocks = should_yield
       end
@@ -216,6 +233,11 @@ module Transpec
       messaging_host.add_receiver_arg_to_any_instance_implementation_block!
     end
 
+    def need_to_modify_yield_receiver_to_any_instance_implementation_blocks_config?
+      rspec_version.rspec_2_99? && configuration.convert_deprecated_method? &&
+        spec_suite.need_to_modify_yield_receiver_to_any_instance_implementation_blocks_config?
+    end
+
     def need_to_modify_expectation_syntax_configuration?(rspec_configure)
       return false unless configuration.convert_should?
       rspec_configure.expectations.syntaxes == [:should]

data/lib/transpec/dynamic_analyzer/helper.rb.erb

@@ -0,0 +1,44 @@
+module TranspecAnalysis
+  @base_path = Dir.pwd
+
+  def self.global_data
+    @data ||= {}
+  end
+
+  def self.node_data
+    @data ||= {}
+  end
+
+  at_exit do
+    # Use JSON rather than Marshal so that:
+    # * Unknown third-party class information won't be serialized.
+    #   (Such objects are stored as a string.)
+    # * Singleton method information won't be serialized.
+    #   (With Marshal.load, `singleton can't be dumped (TypeError)` will be raised.)
+    require 'json'
+    path = File.join(@base_path, '<%= RESULT_FILE %>')
+    File.open(path, 'w') do |file|
+      JSON.dump(node_data, file)
+    end
+  end
+end
+
+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
+
+    begin
+      node_data[key] = target.instance_eval(code)
+    rescue Exception
+    end
+  end
+
+  TranspecAnalysis.node_data[node_id] = node_data
+
+  object
+end

data/lib/transpec/dynamic_analyzer/node_util.rb

@@ -0,0 +1,17 @@
+# coding: utf-8
+
+require 'pathname'
+
+module Transpec
+  class DynamicAnalyzer
+    module NodeUtil
+      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('_')
+      end
+    end
+  end
+end

data/lib/transpec/dynamic_analyzer/rewriter.rb

@@ -2,15 +2,16 @@
 
 require 'transpec/base_rewriter'
 require 'transpec/dynamic_analyzer'
-require 'transpec/syntax'
+require 'transpec/dynamic_analyzer/node_util'
 require 'transpec/util'
+require 'transpec/syntax'
 
 Transpec::Syntax.require_all
 
 module Transpec
   class DynamicAnalyzer
     class Rewriter < BaseRewriter
-      include Util
+      include NodeUtil, Util
 
       EVAL_TARGET_TYPES = [:object, :context]
 
@@ -46,12 +47,19 @@ module Transpec
         ast.each_node do |node|
           Syntax.standalone_syntaxes.each do |syntax_class|
             syntax = syntax_class.new(node)
-            next unless syntax.dynamic_analysis_target?
-            syntax.register_dynamic_analysis_request(self)
+            collect_requests_of_syntax(syntax)
           end
         end
       end
 
+      def collect_requests_of_syntax(syntax)
+        return unless syntax.dynamic_analysis_target?
+        syntax.register_dynamic_analysis_request(self)
+        syntax.dependent_syntaxes.each do |dependent_syntax|
+          collect_requests_of_syntax(dependent_syntax)
+        end
+      end
+
       def process_requests(source_rewriter)
         requests.each do |node, analysis_codes|
           inject_analysis_code(node, analysis_codes, source_rewriter)

data/lib/transpec/dynamic_analyzer/runtime_data.rb

@@ -1,14 +1,13 @@
 # coding: utf-8
 
-require 'transpec/util'
+require 'transpec/dynamic_analyzer/node_util'
 require 'json'
 require 'ostruct'
-require 'pathname'
 
 module Transpec
   class DynamicAnalyzer
     class RuntimeData
-      include Util
+      include NodeUtil
 
       attr_reader :data
 
@@ -30,7 +29,7 @@ module Transpec
       end
 
       def run?(node)
-        !self[node].nil?
+        self[node]
       end
 
       def present?(node, key)

data/lib/transpec/dynamic_analyzer.rb

@@ -2,13 +2,14 @@
 
 require 'transpec/dynamic_analyzer/rewriter'
 require 'transpec/dynamic_analyzer/runtime_data'
-require 'transpec/file_finder'
 require 'transpec/project'
+require 'transpec/spec_suite'
 require 'tmpdir'
 require 'find'
 require 'pathname'
 require 'fileutils'
 require 'shellwords'
+require 'erb'
 require 'English'
 
 module Transpec
@@ -16,50 +17,6 @@ module Transpec
     ANALYSIS_METHOD = 'transpec_analyze'
     HELPER_FILE = 'transpec_analysis_helper.rb'
     RESULT_FILE = 'transpec_analysis_result.json'
-    HELPER_SOURCE = <<-END
-      require 'pathname'
-
-      module TranspecAnalysis
-        @base_path = Dir.pwd
-
-        def self.data
-          @data ||= {}
-        end
-
-        at_exit do
-          # Use JSON rather than Marshal so that:
-          # * Unknown third-party class information won't be serialized.
-          #   (Such objects are stored as a string.)
-          # * Singleton method information won't be serialized.
-          #   (With Marshal.load, `singleton can't be dumped (TypeError)` will be raised.)
-          require 'json'
-          path = File.join(@base_path, '#{RESULT_FILE}')
-          File.open(path, 'w') do |file|
-            JSON.dump(data, file)
-          end
-        end
-      end
-
-      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
-
-          begin
-            node_data[key] = target.instance_eval(code)
-          rescue Exception
-          end
-        end
-
-        TranspecAnalysis.data[node_id] = node_data
-
-        object
-      end
-    END
 
     attr_reader :project, :rspec_command, :silent
     alias_method :silent?, :silent
@@ -88,7 +45,7 @@ module Transpec
       in_copied_project do
         rewrite_specs(paths)
 
-        File.write(HELPER_FILE, HELPER_SOURCE)
+        File.write(HELPER_FILE, helper_source)
 
         run_rspec(paths)
 
@@ -153,15 +110,20 @@ module Transpec
     def rewrite_specs(paths)
       rewriter = Rewriter.new
 
-      FileFinder.find(paths).each do |file_path|
-        begin
-          rewriter.rewrite_file!(file_path)
-        rescue Parser::SyntaxError # rubocop:disable HandleExceptions
-          # Syntax errors will be reported in CLI with Converter.
-        end
+      spec_suite = SpecSuite.new(paths)
+
+      spec_suite.specs.each do |spec|
+        next if spec.syntax_error
+        rewriter.rewrite_file!(spec)
       end
     end
 
+    def helper_source
+      erb_path = File.join(File.dirname(__FILE__), 'dynamic_analyzer', 'helper.rb.erb')
+      erb = ERB.new(File.read(erb_path), nil)
+      erb.result(binding)
+    end
+
     def copy(source, destination)
       if File.symlink?(source)
         File.symlink(File.readlink(source), destination)