transpec 1.13.1 → 2.0.0

data/lib/transpec/commit_message.rb

@@ -20,6 +20,8 @@ module Transpec
         |    transpec #{smart_cli_args}
         |
         |#{conversion_summary}
+        |
+        |See also: https://github.com/yujinakayama/transpec#supported-conversions
       END
     end
 

data/lib/transpec/{configuration.rb → config.rb}

@@ -1,12 +1,13 @@
 # coding: utf-8
 
 module Transpec
-  class Configuration
+  class Config
     NEGATIVE_FORMS_OF_TO = ['not_to', 'to_not'].freeze
     FORMS_OF_BE_FALSEY = ['be_falsey', 'be_falsy'].freeze
     BOOLEAN_MATCHER_TYPES = [:conditional, :exact].freeze
 
     PREDICATES = [
+      [:forced,                                                false],
       [:convert_should,                                        true],
       [:convert_oneliner,                                      true],
       [:convert_should_receive,                                true],
@@ -15,13 +16,13 @@ module Transpec
       [:convert_its,                                           true],
       [:convert_pending,                                       true],
       [:convert_deprecated_method,                             true],
-      [:parenthesize_matcher_arg,                              true],
-      [:add_receiver_arg_to_any_instance_implementation_block, true],
-      [:convert_stub_with_hash_to_allow_to_receive_and_return, false],
       [:convert_example_group,                                 false],
       [:convert_hook_scope,                                    false],
-      [:forced,                                                false],
-      [:skip_dynamic_analysis,                                 false]
+      [:convert_stub_with_hash_to_allow_to_receive_and_return, false],
+      [:skip_dynamic_analysis,                                 false],
+      [:add_receiver_arg_to_any_instance_implementation_block, true],
+      [:add_explicit_type_metadata_to_example_group,           true],
+      [:parenthesize_matcher_arg,                              true]
     ].freeze
 
     PREDICATES.each do |predicate, _|

data/lib/transpec/converter.rb

@@ -1,7 +1,7 @@
 # coding: utf-8
 
 require 'transpec/base_rewriter'
-require 'transpec/configuration'
+require 'transpec/config'
 require 'transpec/report'
 require 'transpec/rspec_version'
 require 'transpec/spec_suite'
@@ -13,15 +13,15 @@ module Transpec
   class Converter < BaseRewriter # rubocop:disable ClassLength
     include Syntax::Dispatcher
 
-    attr_reader :spec_suite, :configuration, :rspec_version, :report
+    attr_reader :spec_suite, :config, :rspec_version, :report
 
     alias_method :convert_file!, :rewrite_file!
     alias_method :convert_source, :rewrite_source
     alias_method :convert, :rewrite
 
-    def initialize(spec_suite = nil, configuration = nil, rspec_version = nil)
+    def initialize(spec_suite = nil, config = nil, rspec_version = nil)
       @spec_suite = spec_suite || SpecSuite.new
-      @configuration = configuration || Configuration.new
+      @config = config || Config.new
       @rspec_version = rspec_version || Transpec.required_rspec_version
       @report = Report.new
     end
@@ -44,161 +44,172 @@ module Transpec
     end
 
     def process_should(should)
-      return unless configuration.convert_should?
-      should.expectize!(configuration.negative_form_of_to)
+      return unless config.convert_should?
+      should.expectize!(config.negative_form_of_to)
     end
 
     def process_oneliner_should(oneliner_should)
-      negative_form = configuration.negative_form_of_to
-      should_convert_have_items = configuration.convert_have_items? &&
+      negative_form = config.negative_form_of_to
+      should_convert_have_items = config.convert_have_items? &&
                                   oneliner_should.have_matcher.conversion_target?
 
       if should_convert_have_items
-        if configuration.convert_should?
+        if config.convert_should?
           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?
+      elsif config.convert_oneliner? && rspec_version.oneliner_is_expected_available?
         oneliner_should.expectize!(negative_form)
       end
     end
 
     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 config.convert_deprecated_method?
+          if config.convert_stub?
+            should_receive.allowize_useless_expectation!(config.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 config.convert_should_receive?
+          should_receive.expectize!(config.negative_form_of_to)
         end
-      elsif configuration.convert_should_receive?
-        should_receive.expectize!(configuration.negative_form_of_to)
+      elsif config.convert_should_receive?
+        should_receive.expectize!(config.negative_form_of_to)
       end
     end
 
     def process_double(double)
-      double.convert_to_double! if configuration.convert_deprecated_method?
+      double.convert_to_double! if config.convert_deprecated_method?
     end
 
     def process_method_stub(method_stub)
-      if configuration.convert_stub?
+      if config.convert_stub?
         if !method_stub.hash_arg? ||
            rspec_version.receive_messages_available? ||
-           configuration.convert_stub_with_hash_to_allow_to_receive_and_return?
+           config.convert_stub_with_hash_to_allow_to_receive_and_return?
           method_stub.allowize!(rspec_version)
-        elsif configuration.convert_deprecated_method?
+        elsif config.convert_deprecated_method?
           method_stub.convert_deprecated_method!
         end
-      elsif configuration.convert_deprecated_method?
+      elsif config.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 config.convert_deprecated_method?
     end
 
     def process_operator(operator)
-      return unless configuration.convert_should?
+      return unless config.convert_should?
       return if operator.expectation.is_a?(Syntax::OnelinerShould) &&
         !rspec_version.oneliner_is_expected_available?
-      operator.convert_operator!(configuration.parenthesize_matcher_arg?)
+      operator.convert_operator!(config.parenthesize_matcher_arg?)
     end
 
     def process_be_boolean(be_boolean)
       return unless rspec_version.be_truthy_available?
-      return unless configuration.convert_deprecated_method?
+      return unless config.convert_deprecated_method?
 
-      case configuration.boolean_matcher_type
+      case config.boolean_matcher_type
       when :conditional
-        be_boolean.convert_to_conditional_matcher!(configuration.form_of_be_falsey)
+        be_boolean.convert_to_conditional_matcher!(config.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 config.convert_deprecated_method?
     end
 
     def process_raise_error(raise_error)
       return unless raise_error
-      if configuration.convert_deprecated_method?
+      if config.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 config.convert_its?
     end
 
     def process_example(example)
-      return if !rspec_version.rspec_2_99? || !configuration.convert_pending?
+      return if !rspec_version.rspec_2_99? || !config.convert_pending?
       example.convert_pending_to_skip!
     end
 
     def process_pending(pending)
-      return if !rspec_version.rspec_2_99? || !configuration.convert_pending?
+      return if !rspec_version.rspec_2_99? || !config.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?
+      current_example.convert! if config.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?
+      matcher_definition.convert_deprecated_method! if config.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?
+      if rspec_version.non_monkey_patch_example_group_available? && config.convert_example_group?
+        example_group.convert_to_non_monkey_patch!
+      end
+
+      if rspec_version.implicit_spec_type_disablement_available? &&
+         config.add_explicit_type_metadata_to_example_group?
+        example_group.add_explicit_type_metadata!
+      end
     end
 
     def process_rspec_configure(rspec_configure)
       return unless spec_suite.main_rspec_configure_node?(rspec_configure.node)
 
       if rspec_version.non_monkey_patch_example_group_available? &&
-         configuration.convert_example_group?
+         config.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?
+        should_yield = config.add_receiver_arg_to_any_instance_implementation_block?
         rspec_configure.mocks.yield_receiver_to_any_instance_implementation_blocks = should_yield
       end
+
+      if rspec_version.implicit_spec_type_disablement_available? &&
+         !config.add_explicit_type_metadata_to_example_group?
+        rspec_configure.infer_spec_type_from_file_location!
+      end
     end
 
     def process_have(have)
-      return if !have || !configuration.convert_have_items?
-      have.convert_to_standard_expectation!(configuration.parenthesize_matcher_arg)
+      return if !have || !config.convert_have_items?
+      have.convert_to_standard_expectation!(config.parenthesize_matcher_arg)
     end
 
     def process_hook(hook)
-      return if !configuration.convert_hook_scope? || !rspec_version.hook_scope_alias_available?
+      return if !config.convert_hook_scope? || !rspec_version.hook_scope_alias_available?
       hook.convert_scope_name!
     end
 
     def process_useless_and_return(messaging_host)
       return unless messaging_host
-      return unless configuration.convert_deprecated_method?
+      return unless config.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.rspec_2_99?
-      return unless configuration.convert_deprecated_method?
-      return unless configuration.add_receiver_arg_to_any_instance_implementation_block?
+      return unless config.convert_deprecated_method?
+      return unless config.add_receiver_arg_to_any_instance_implementation_block?
       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? &&
+      rspec_version.rspec_2_99? && config.convert_deprecated_method? &&
         spec_suite.need_to_modify_yield_receiver_to_any_instance_implementation_blocks_config?
     end
   end

data/lib/transpec/option_parser.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-require 'transpec/configuration'
+require 'transpec/config'
 require 'transpec/git'
 require 'transpec/version'
 require 'optparse'
@@ -28,14 +28,14 @@ module Transpec
 
     VALID_BOOLEAN_MATCHER_TYPES = %w(truthy,falsey truthy,falsy true,false)
 
-    attr_reader :configuration
+    attr_reader :config
 
     def self.available_conversion_types
       CONFIG_ATTRS_FOR_KEEP_TYPES.keys
     end
 
-    def initialize(configuration = Configuration.new)
-      @configuration = configuration
+    def initialize(config = Config.new)
+      @config = config
       setup_parser
     end
 
@@ -55,11 +55,11 @@ module Transpec
       @parser = create_parser
 
       define_option('-f', '--force') do
-        configuration.forced = true
+        config.forced = true
       end
 
       define_option('-c', '--rspec-command COMMAND') do |command|
-        configuration.rspec_command = command
+        config.rspec_command = command
       end
 
       define_option('-k', '--keep TYPE[,TYPE...]') do |types|
@@ -71,11 +71,11 @@ module Transpec
       end
 
       define_option('-s', '--skip-dynamic-analysis') do
-        configuration.skip_dynamic_analysis = true
+        config.skip_dynamic_analysis = true
       end
 
       define_option('-n', '--negative-form FORM') do |form|
-        configuration.negative_form_of_to = form
+        config.negative_form_of_to = form
       end
 
       define_option('-b', '--boolean-matcher TYPE') do |type|
@@ -83,16 +83,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'
+        config.boolean_matcher_type = type.include?('truthy') ? :conditional : :exact
+        config.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
+        config.add_receiver_arg_to_any_instance_implementation_block = false
+      end
+
+      define_option('-t', '--no-explicit-spec-type') do
+        config.add_explicit_type_metadata_to_example_group = false
       end
 
       define_option('-p', '--no-parentheses-matcher-arg') do
-        configuration.parenthesize_matcher_arg = false
+        config.parenthesize_matcher_arg = false
       end
 
       define_option('--no-color') do
@@ -144,7 +148,7 @@ module Transpec
           "  *its* (to `describe '#attr' { subject { }; it { } }`)",
           '  *pending* (to `skip`)',
           '  *deprecated* (all other deprecated syntaxes to latest syntaxes)',
-          'These are all converted by default.'
+          'These conversions are enabled by default.'
         ],
         '-v' => [
           'Enable specific conversions that are disabled by default.',
@@ -172,6 +176,10 @@ module Transpec
           'Suppress yielding receiver instances to `any_instance`',
           'implementation blocks as the first block argument.'
         ],
+        '-t' => [
+          'Suppress adding explicit `:type` metadata to example groups in a',
+          'project using rspec-rails.'
+        ],
         '-p' => [
           'Suppress parenthesizing arguments of matchers when converting',
           '`should` with operator matcher to `expect` with non-operator matcher.',
@@ -199,17 +207,7 @@ module Transpec
     end
 
     def convert_deprecated_options(raw_args)
-      raw_args.each_with_object([]) do |arg, args|
-        case arg
-        when '-m', '--generate-commit-message'
-          deprecate('-m/--generate-commit-message option')
-        when '-t', '--convert-stub-with-hash'
-          deprecate('-t/--convert-stub-with-hash', '`--convert stub_with_hash`')
-          args.concat(%w(--convert stub_with_hash))
-        else
-          args << arg
-        end
-      end
+      raw_args.dup
     end
 
     def deprecate(subject, alternative = nil)
@@ -222,7 +220,7 @@ module Transpec
       inputted_types.split(',').each do |type|
         config_attr = type_to_attr_map[type.to_sym]
         fail ArgumentError, "Unknown syntax type #{type.inspect}" unless config_attr
-        configuration.send(config_attr, boolean)
+        config.send(config_attr, boolean)
       end
     end
   end

data/lib/transpec/rspec_version.rb

@@ -44,9 +44,15 @@ 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 :skip,                           '2.99.0.beta2', except: '3.0.0.beta1'
+
+    define_feature :implicit_spec_type_disablement, '2.99.0.rc1',
+                   except: ['3.0.0.beta1', '3.0.0.beta2']
+
     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'
     define_feature :non_monkey_patch_example_group, '3.0.0.beta2'

data/lib/transpec/spec_suite.rb

@@ -10,8 +10,6 @@ module Transpec
   class SpecSuite
     include Syntax::Dispatcher
 
-    ANALYSIS_TARGET_CLASSES = [Syntax::Mixin::AnyInstanceBlock]
-
     attr_reader :runtime_data
 
     def initialize(base_paths = [], runtime_data = nil)
@@ -21,10 +19,8 @@ module Transpec
     end
 
     def specs
-      @specs ||= begin
-        FileFinder.find(@base_paths).map do |path|
-          ProcessedSource.parse_file(path)
-        end
+      @specs ||= FileFinder.find(@base_paths).map do |path|
+        ProcessedSource.parse_file(path)
       end
     end
 

data/lib/transpec/syntax/example.rb

@@ -2,12 +2,13 @@
 
 require 'transpec/syntax'
 require 'transpec/syntax/mixin/context_sensitive'
+require 'transpec/syntax/mixin/metadata'
 require 'transpec/rspec_dsl'
 
 module Transpec
   class Syntax
     class Example < Syntax
-      include Mixin::ContextSensitive, RSpecDSL
+      include Mixin::ContextSensitive, Mixin::Metadata, RSpecDSL
 
       def dynamic_analysis_target?
         super && receiver_node.nil? && EXAMPLE_METHODS.include?(method_name)
@@ -22,16 +23,6 @@ module Transpec
         convert_pending_metadata_to_skip!
       end
 
-      def metadata_key_nodes
-        metadata_nodes.each_with_object([]) do |node, key_nodes|
-          if node.hash_type?
-            key_nodes.concat(node.children.map { |pair_node| pair_node.children.first })
-          else
-            key_nodes << node
-          end
-        end
-      end
-
       private
 
       def convert_pending_selector_to_skip!
@@ -69,10 +60,6 @@ module Transpec
         end
       end
 
-      def metadata_nodes
-        arg_nodes[1..-1] || []
-      end
-
       def register_record(original_syntax, converted_syntax)
         report.records << Record.new(original_syntax, converted_syntax)
       end