transpec 1.9.3 → 1.10.0

data/lib/transpec/git.rb

@@ -10,7 +10,7 @@ module Transpec
     def command_available?
       ENV['PATH'].split(File::PATH_SEPARATOR).any? do |path|
         git_path = File.join(path, GIT)
-        File.exists?(git_path)
+        File.exist?(git_path)
       end
     end
 

data/lib/transpec/option_parser.rb

@@ -18,6 +18,7 @@ module Transpec
                 stub: :convert_stub=,
           have_items: :convert_have_items=,
                  its: :convert_its=,
+             pending: :convert_pending=,
           deprecated: :convert_deprecated_method=
     }
 
@@ -51,27 +52,27 @@ module Transpec
       @parser = create_parser
 
       define_option('-f', '--force') do
-        @configuration.forced = true
+        configuration.forced = true
       end
 
       define_option('-s', '--skip-dynamic-analysis') do
-        @configuration.skip_dynamic_analysis = true
+        configuration.skip_dynamic_analysis = true
       end
 
       define_option('-c', '--rspec-command COMMAND') do |command|
-        @configuration.rspec_command = command
+        configuration.rspec_command = command
       end
 
       define_option('-k', '--keep TYPE[,TYPE...]') do |types|
         types.split(',').each do |type|
           config_attr = CONFIG_ATTRS_FOR_KEEP_TYPES[type.to_sym]
           fail ArgumentError, "Unknown syntax type #{type.inspect}" unless config_attr
-          @configuration.send(config_attr, false)
+          configuration.send(config_attr, false)
         end
       end
 
       define_option('-n', '--negative-form FORM') do |form|
-        @configuration.negative_form_of_to = form
+        configuration.negative_form_of_to = form
       end
 
       define_option('-b', '--boolean-matcher TYPE') do |type|
@@ -79,20 +80,20 @@ module Transpec
           types = VALID_BOOLEAN_MATCHER_TYPES.map(&:inspect).join(', ')
           fail ArgumentError, "Boolean matcher type must be any of #{types}"
         end
-        @configuration.boolean_matcher_type = type.include?('truthy') ? :conditional : :exact
-        @configuration.form_of_be_falsey = type.include?('falsy') ? 'be_falsy' : 'be_falsey'
+        configuration.boolean_matcher_type = type.include?('truthy') ? :conditional : :exact
+        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
+        configuration.add_receiver_arg_to_any_instance_implementation_block = false
       end
 
       define_option('-t', '--convert-stub-with-hash') do
-        @configuration.convert_stub_with_hash_to_stub_and_return = true
+        configuration.convert_stub_with_hash_to_stub_and_return = true
       end
 
       define_option('-p', '--no-parentheses-matcher-arg') do
-        @configuration.parenthesize_matcher_arg = false
+        configuration.parenthesize_matcher_arg = false
       end
 
       define_option('--no-color') do
@@ -145,6 +146,7 @@ module Transpec
           "  #{'stub'.bright}  (to #{'allow(obj).to receive'.underline})",
           "  #{'have_items'.bright} (to #{'expect(obj.size).to eq(n)'.underline})",
           "  #{'its'.bright} (to #{'describe { subject { }; it { } }'.underline})",
+          "  #{'pending'.bright} (to #{'skip'.underline})",
           "  #{'deprecated'.bright} (e.g. from #{'mock'.underline} to #{'double'.underline})",
           'These are all converted by default.'
         ],

data/lib/transpec/project.rb

@@ -12,11 +12,11 @@ module Transpec
     end
 
     def basename
-      File.basename(@path)
+      File.basename(path)
     end
 
     def require_bundler?
-      gemfile_path = File.join(@path, 'Gemfile')
+      gemfile_path = File.join(path, 'Gemfile')
       File.exist?(gemfile_path)
     end
 
@@ -44,7 +44,7 @@ module Transpec
 
       output = nil
 
-      Dir.chdir(@path) do
+      Dir.chdir(path) do
         with_bundler_clean_env do
           IO.popen(command) do |io|
             output = io.read

data/lib/transpec/record.rb

@@ -1,12 +1,15 @@
 # coding: utf-8
 
+require 'transpec/annotatable'
+
 module Transpec
   class Record
-    attr_reader :original_syntax, :converted_syntax
+    attr_reader :original_syntax, :converted_syntax, :annotation
 
-    def initialize(original_syntax, converted_syntax)
+    def initialize(original_syntax, converted_syntax, annotation = nil)
       @original_syntax = original_syntax
       @converted_syntax = converted_syntax
+      @annotation = annotation
     end
 
     def ==(other)
@@ -25,4 +28,18 @@ module Transpec
       "`#{original_syntax}` -> `#{converted_syntax}`"
     end
   end
+
+  class Annotation
+    include Annotatable
+  end
+
+  class AccuracyAnnotation < Annotation
+    def initialize(source_range)
+      message = "The `#{source_range.source}` has been converted " \
+                'but it might possibly be incorrect ' \
+                'due to a lack of runtime information. ' \
+                "It's recommended to review the change carefully."
+      super(message, source_range)
+    end
+  end
 end

data/lib/transpec/report.rb

@@ -4,14 +4,21 @@ require 'rainbow'
 
 module Transpec
   class Report
-    attr_reader :records, :context_errors, :syntax_errors
+    attr_reader :records, :conversion_errors, :syntax_errors
 
     def initialize
       @records = []
-      @context_errors = []
+      @conversion_errors = []
       @syntax_errors = []
     end
 
+    def <<(other)
+      records.concat(other.records)
+      conversion_errors.concat(other.conversion_errors)
+      syntax_errors.concat(other.syntax_errors)
+      self
+    end
+
     def unique_record_counts
       record_counts = Hash.new(0)
 
@@ -40,7 +47,15 @@ module Transpec
     end
 
     def colored_stats
-      convertion_and_incomplete_stats + error_stats
+      base_color = if !conversion_errors.empty?
+                     :magenta
+                   elsif annotation_count.nonzero?
+                     :yellow
+                   else
+                     :green
+                   end
+
+      convertion_incomplete_caution_stats(base_color) + error_stats(base_color)
     end
 
     def stats
@@ -78,21 +93,18 @@ module Transpec
       text << indentation + '    ' + colorize('to: ', :cyan) + record.converted_syntax + "\n"
     end
 
-    def convertion_and_incomplete_stats
-      color = context_errors.empty? ? :green : :yellow
-
+    def convertion_incomplete_caution_stats(color)
       text = pluralize(records.count, 'conversion') + ', '
-      text << pluralize(context_errors.count, 'incomplete') + ', '
+      text << pluralize(conversion_errors.count, 'incomplete') + ', '
+      text << pluralize(annotation_count, 'caution') + ', '
       colorize(text, color)
     end
 
-    def error_stats
-      color = if !syntax_errors.empty?
-                :red
-              elsif context_errors.empty?
-                :green
+    def error_stats(base_color)
+      color = if syntax_errors.empty?
+                base_color
               else
-                :yellow
+                :red
               end
 
       colorize(pluralize(syntax_errors.count, 'error'), color)
@@ -112,5 +124,9 @@ module Transpec
 
       text
     end
+
+    def annotation_count
+      records.count(&:annotation)
+    end
   end
 end

data/lib/transpec/rspec_version.rb

@@ -34,27 +34,27 @@ module Transpec
     end
 
     def <=>(other)
-      @gem_version <=> other.gem_version
+      gem_version <=> other.gem_version
     end
 
     def to_s
-      @gem_version.to_s
+      gem_version.to_s
     end
 
     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 :skip,                        '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')
+    RSPEC_2_99 = new('2.99.0.beta1')
+    RSPEC_3_0  = 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
+    def rspec_2_99?
+      RSPEC_2_99 <= self && self < RSPEC_3_0
     end
   end
 end

data/lib/transpec/static_context_inspector.rb

@@ -48,10 +48,6 @@ module Transpec
       end
     end
 
-    def inside_of_example_group?
-      scopes.include?(:example_group)
-    end
-
     def non_monkey_patch_expectation_available?
       return @expectation_available if instance_variable_defined?(:@expectation_available)
       @expectation_available = match_scopes(NON_MONKEY_PATCH_EXPECTATION_AVAILABLE_CONTEXT)
@@ -72,7 +68,7 @@ module Transpec
     def valid_ancestor_nodes
       valid_nodes = []
 
-      self_and_ancestor_nodes = [@node] + @node.ancestor_nodes
+      self_and_ancestor_nodes = [node] + node.ancestor_nodes
 
       self_and_ancestor_nodes.each_cons(2) do |child, parent|
         valid_nodes << parent unless belong_to_direct_outer_scope?(child)

data/lib/transpec/syntax.rb

@@ -1,9 +1,10 @@
 # coding: utf-8
 
-require 'transpec/context_error'
-require 'transpec/static_context_inspector'
+require 'transpec/conversion_error'
+require 'transpec/dynamic_analyzer/runtime_data'
 require 'transpec/record'
 require 'transpec/report'
+require 'transpec/static_context_inspector'
 require 'active_support/concern'
 
 module Transpec
@@ -37,19 +38,19 @@ module Transpec
       private
 
       def remove(range)
-        @source_rewriter.remove(range)
+        source_rewriter.remove(range)
       end
 
       def insert_before(range, content)
-        @source_rewriter.insert_before(range, content)
+        source_rewriter.insert_before(range, content)
       end
 
       def insert_after(range, content)
-        @source_rewriter.insert_after(range, content)
+        source_rewriter.insert_after(range, content)
       end
 
       def replace(range, content)
-        @source_rewriter.replace(range, content)
+        source_rewriter.replace(range, content)
       end
     end
   end
@@ -114,26 +115,20 @@ module Transpec
     def initialize(node, source_rewriter = nil, runtime_data = nil, report = nil)
       @node = node
       @source_rewriter = source_rewriter
-      @runtime_data = runtime_data
+      @runtime_data = runtime_data || DynamicAnalyzer::RuntimeData.new
       @report = report || Report.new
     end
 
     def static_context_inspector
-      @static_context_inspector ||= StaticContextInspector.new(@node)
+      @static_context_inspector ||= StaticContextInspector.new(node)
     end
 
     def parent_node
-      @node.parent_node
+      node.parent_node
     end
 
     def expression_range
-      @node.loc.expression
-    end
-
-    private
-
-    def runtime_node_data(node)
-      @runtime_data && @runtime_data[node]
+      node.loc.expression
     end
   end
 end

data/lib/transpec/syntax/be_boolean.rb

@@ -31,7 +31,7 @@ module Transpec
       private
 
       def register_record(converted_syntax)
-        @report.records << Record.new(method_name.to_s, converted_syntax)
+        report.records << Record.new(method_name.to_s, converted_syntax)
       end
     end
   end

data/lib/transpec/syntax/be_close.rb

@@ -29,7 +29,7 @@ module Transpec
       private
 
       def register_record
-        @report.records << Record.new('be_close(expected, delta)', 'be_within(delta).of(expected)')
+        report.records << Record.new('be_close(expected, delta)', 'be_within(delta).of(expected)')
       end
     end
   end

data/lib/transpec/syntax/current_example.rb

@@ -0,0 +1,88 @@
+# coding: utf-8
+
+require 'transpec/syntax'
+require 'transpec/syntax/mixin/send'
+require 'transpec/rspec_dsl'
+require 'transpec/util'
+
+module Transpec
+  class Syntax
+    class CurrentExample < Syntax
+      include Mixin::Send, RSpecDSL, Util
+
+      METHODS_YIELD_EXAMPLE = (EXAMPLE_METHODS + HOOK_METHODS + HELPER_METHODS).freeze
+
+      def self.check_target_node_statically(node)
+        super(node) && Util.block_node_taken_by_method(node).nil?
+      end
+
+      def self.target_method?(receiver_node, method_name)
+        receiver_node.nil? && [:example, :running_example].include?(method_name)
+      end
+
+      def convert!
+        if block_node
+          insert_after(block_node.loc.begin, " |#{block_arg_name}|") unless block_has_argument?
+          replace(selector_range, block_arg_name.to_s) unless method_name == block_arg_name
+          block_node.metadata[:added_example_block_arg] = true
+        else
+          replace(selector_range, 'RSpec.current_example')
+        end
+
+        register_record
+      end
+
+      private
+
+      def block_has_argument?
+        block_arg_node || block_node.metadata[:added_example_block_arg]
+      end
+
+      def block_node
+        return @block_node if instance_variable_defined?(:@block_node)
+
+        @block_node ||= node.each_ancestor_node.find do |ancestor_node|
+          next false unless ancestor_node.block_type?
+          method_name = method_name_of_block_node(ancestor_node)
+          METHODS_YIELD_EXAMPLE.include?(method_name)
+        end
+      end
+
+      def block_method_name
+        method_name_of_block_node(block_node)
+      end
+
+      def block_arg_node
+        args_node = block_node.children[1]
+        args_node.children.first
+      end
+
+      def block_arg_name
+        if block_arg_node
+          block_arg_node.children.first
+        else
+          :example
+        end
+      end
+
+      def method_name_of_block_node(block_node)
+        send_node = block_node.children.first
+        send_node.children[1]
+      end
+
+      def register_record
+        if block_node
+          prefix = "#{block_method_name}"
+          prefix << '(:name)' if HELPER_METHODS.include?(block_method_name)
+          original_syntax = "#{prefix} { example }"
+          converted_syntax = "#{prefix} { |example| example }"
+        else
+          original_syntax = 'def helper_method example; end'
+          converted_syntax = 'def helper_method RSpec.current_example; end'
+        end
+
+        report.records << Record.new(original_syntax, converted_syntax)
+      end
+    end
+  end
+end