transpec 1.13.1 → 2.0.0

data/lib/transpec/syntax/example_group.rb

@@ -2,16 +2,34 @@
 
 require 'transpec/syntax'
 require 'transpec/syntax/mixin/context_sensitive'
+require 'transpec/syntax/mixin/metadata'
 require 'transpec/syntax/mixin/monkey_patch'
+require 'transpec/syntax/mixin/rspec_rails'
 require 'transpec/rspec_dsl'
 
 module Transpec
   class Syntax
     class ExampleGroup < Syntax
-      include Mixin::ContextSensitive, Mixin::MonkeyPatch, RSpecDSL
+      include Mixin::ContextSensitive, Mixin::Metadata, Mixin::MonkeyPatch, Mixin::RSpecRails,
+              RSpecDSL, Util
+
+      DIRECTORY_TO_TYPE_MAP = {
+        'controllers' => :controller,
+        'helpers'     => :helper,
+        'mailers'     => :mailer,
+        'models'      => :model,
+        'requests'    => :request,
+        'integration' => :request,
+        'api'         => :request,
+        'routing'     => :routing,
+        'views'       => :view,
+        'features'    => :feature
+      }
 
       def dynamic_analysis_target?
-        super && receiver_node.nil? && EXAMPLE_GROUP_METHODS.include?(method_name)
+        return false unless super
+        return false if receiver_node && const_name(receiver_node) != 'RSpec'
+        EXAMPLE_GROUP_METHODS.include?(method_name)
       end
 
       def should_be_in_example_group_context?
@@ -19,19 +37,103 @@ module Transpec
       end
 
       def convert_to_non_monkey_patch!
+        return if receiver_node
         insert_before(expression_range, 'RSpec.')
-        register_record
+        report.records << NonMonkeyPatchDescribeRecord.new(self)
+      end
+
+      def add_explicit_type_metadata!
+        return unless rspec_rails?
+        return unless method_name == :describe
+        return if explicit_type_metadata?
+
+        type = implicit_type_metadata
+        return unless type
+
+        code = ', '
+        code << if metadata_hash_style == :arrow
+                  ":type => #{type.inspect}"
+                else
+                  "type: #{type.inspect}"
+                end
+
+        insert_after(arg_node.loc.expression, code)
+
+        report.records << ExplicitTypeMetadataRecord.new(self)
+      end
+
+      def implicit_type_metadata
+        dirs = file_path.split('/')
+        return nil unless dirs.first == 'spec'
+        DIRECTORY_TO_TYPE_MAP[dirs[1]]
+      end
+
+      private
+
+      def explicit_type_metadata?
+        metadata_key_nodes.any? do |node|
+          next false unless node.sym_type?
+          key = node.children.first
+          key == :type
+        end
+      end
+
+      def file_path
+        expression_range.source_buffer.name
+      end
+
+      def metadata_hash_style
+        symbol_key_nodes = metadata_key_nodes.select(&:sym_type?)
+
+        has_colon_separator_pair = symbol_key_nodes.any? do |sym_node|
+          !sym_node.loc.expression.source.start_with?(':')
+        end
+
+        if has_colon_separator_pair
+          :colon
+        else
+          :arrow
+        end
+      end
+
+      class NonMonkeyPatchDescribeRecord < Record
+        attr_reader :example_group
+
+        def initialize(example_group)
+          @example_group = example_group
+        end
+
+        def build_original_syntax
+          base_syntax
+        end
+
+        def build_converted_syntax
+          "RSpec.#{base_syntax}"
+        end
+
+        def base_syntax
+          "#{example_group.method_name} 'something' { }"
+        end
       end
 
-      def register_record
-        original_syntax = method_name.to_s
-        converted_syntax = "RSpec.#{method_name}"
+      class ExplicitTypeMetadataRecord < Record
+        attr_reader :example_group
 
-        [original_syntax, converted_syntax].each do |syntax|
-          syntax << " 'something' { }"
+        def initialize(example_group)
+          @example_group = example_group
         end
 
-        @report.records << Record.new(original_syntax, converted_syntax)
+        def build_original_syntax
+          "describe 'some #{type}' { }"
+        end
+
+        def build_converted_syntax
+          "describe 'some #{type}', :type => #{type.inspect} { }"
+        end
+
+        def type
+          example_group.implicit_type_metadata
+        end
       end
     end
   end

data/lib/transpec/syntax/have/dynamic_analysis.rb

@@ -30,7 +30,7 @@ module Transpec
             rewriter.register_request(target_node, key, code, target_type)
 
             key = :project_requires_collection_matcher?
-            code = 'defined?(RSpec::Rails) || defined?(RSpec::CollectionMatchers)'
+            code = 'defined?(RSpec::CollectionMatchers)'
             rewriter.register_request(target_node, key, code, :context)
           end
         end

data/lib/transpec/syntax/mixin/metadata.rb

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+require 'active_support/concern'
+require 'transpec/syntax/mixin/send'
+
+module Transpec
+  class Syntax
+    module Mixin
+      module Metadata
+        extend ActiveSupport::Concern
+        include Send
+
+        def metadata_nodes
+          arg_nodes[1..-1] || []
+        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
+      end
+    end
+  end
+end

data/lib/transpec/syntax/mixin/rspec_rails.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+require 'active_support/concern'
+
+module Transpec
+  class Syntax
+    module Mixin
+      module RSpecRails
+        extend ActiveSupport::Concern
+
+        included do
+          define_dynamic_analysis do |rewriter|
+            rewriter.register_request(node, :rspec_rails?, 'defined?(RSpec::Rails)', :context)
+          end
+        end
+
+        def rspec_rails?
+          if runtime_data.present?(node, :rspec_rails?)
+            runtime_data[node, :rspec_rails?]
+          else
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/transpec/syntax/rspec_configure.rb

@@ -1,17 +1,18 @@
 # coding: utf-8
 
 require 'transpec/syntax'
+require 'transpec/syntax/mixin/rspec_rails'
 require 'transpec/syntax/mixin/send'
 require 'transpec/util'
 
 module Transpec
   class Syntax
     class RSpecConfigure < Syntax
-      require 'transpec/syntax/rspec_configure/configuration_modification'
+      require 'transpec/syntax/rspec_configure/config_modification'
       require 'transpec/syntax/rspec_configure/expectations'
       require 'transpec/syntax/rspec_configure/mocks'
 
-      include Mixin::Send, ConfigurationModification
+      include Mixin::Send, Mixin::RSpecRails, ConfigModification
 
       define_dynamic_analysis do |rewriter|
         code = "TranspecAnalysis.global_data[:rspec_configure_run_order] ||= 0\n" \
@@ -25,7 +26,17 @@ module Transpec
       end
 
       def expose_dsl_globally=(boolean)
-        set_configuration!(:expose_dsl_globally, boolean)
+        set_config!(:expose_dsl_globally, boolean)
+      end
+
+      def infer_spec_type_from_file_location!
+        return if infer_spec_type_from_file_location?
+        return unless rspec_rails?
+        add_config!(:infer_spec_type_from_file_location!)
+      end
+
+      def infer_spec_type_from_file_location?
+        !find_config_node(:infer_spec_type_from_file_location!).nil?
       end
 
       def expectations

data/lib/transpec/syntax/rspec_configure/{configuration_modification.rb → config_modification.rb}

@@ -6,7 +6,7 @@ require 'ast'
 module Transpec
   class Syntax
     class RSpecConfigure
-      module ConfigurationModification
+      module ConfigModification
         include Util, ::AST::Sexp
 
         def block_node
@@ -15,27 +15,27 @@ module Transpec
 
         private
 
-        def set_configuration!(config_name, value)
-          setter_node = find_configuration_node("#{config_name}=")
+        def set_config!(config_name, value)
+          setter_node = find_config_node("#{config_name}=")
 
           if setter_node
             arg_node = setter_node.children[2]
             source_rewriter.replace(arg_node.loc.expression, value.to_s)
           else
-            add_configuration!(config_name, value)
+            add_config!(config_name, value)
           end
         end
 
-        def find_configuration_node(configuration_method_name)
+        def find_config_node(config_method_name)
           return nil unless block_node
 
-          configuration_method_name = configuration_method_name.to_sym
+          config_method_name = config_method_name.to_sym
 
           block_node.each_descendent_node.find do |node|
             next unless node.send_type?
             receiver_node, method_name, = *node
             next unless receiver_node == s(:lvar, block_arg_name)
-            method_name == configuration_method_name
+            method_name == config_method_name
           end
         end
 
@@ -44,20 +44,23 @@ module Transpec
           first_block_arg_name(block_node)
         end
 
-        module ConfigurationAddition
-          def add_configuration!(config_name, value)
-            lines = generate_configuration_lines(config_name, value)
+        # TODO: Refactor this to remove messy overrides in Framework.
+        module ConfigAddition
+          def add_config!(config_name, value = nil)
+            lines = generate_config_lines(config_name, value)
             lines.unshift('') unless empty_block_body?
             lines.map! { |line| line + "\n" }
 
             insertion_position = beginning_of_line_range(block_node_to_insert_code.loc.end)
             source_rewriter.insert_before(insertion_position, lines.join(''))
 
-            block_node_to_insert_code.metadata[:added_configuration] = true
+            block_node_to_insert_code.metadata[:added_config] = true
           end
 
-          def generate_configuration_lines(config_name, value)
-            [body_indentation + "#{config_variable_name}.#{config_name} = #{value}"]
+          def generate_config_lines(config_name, value = nil)
+            line = body_indentation + "#{config_variable_name}.#{config_name}"
+            line << " = #{value}" unless value.nil?
+            [line]
           end
 
           def config_variable_name
@@ -75,11 +78,11 @@ module Transpec
           def empty_block_body?
             block_node = block_node_to_insert_code
             (block_node.loc.end.line - block_node.loc.begin.line <= 1) &&
-              !block_node.metadata[:added_configuration]
+              !block_node.metadata[:added_config]
           end
         end
 
-        include ConfigurationAddition
+        include ConfigAddition
       end
     end
   end

data/lib/transpec/syntax/rspec_configure/framework.rb

@@ -1,12 +1,12 @@
 # coding: utf-8
 
-require 'transpec/syntax/rspec_configure/configuration_modification'
+require 'transpec/syntax/rspec_configure/config_modification'
 
 module Transpec
   class Syntax
     class RSpecConfigure
       class Framework
-        include ConfigurationModification
+        include ConfigModification
 
         attr_reader :rspec_configure, :source_rewriter
 
@@ -34,7 +34,7 @@ module Transpec
           fail NotImplementedError
         end
 
-        def generate_configuration_lines(config_name, value)
+        def generate_config_lines(config_name, value = nil)
           lines = super
 
           unless block_node
@@ -86,7 +86,7 @@ module Transpec
           indentation_of_line(rspec_configure.node) + (' ' * 2)
         end
 
-        module SyntaxConfiguration
+        module SyntaxConfig
           def syntaxes
             return [] unless syntaxes_node
 
@@ -107,7 +107,7 @@ module Transpec
               fail ArgumentError, 'Syntaxes must be either an array or a symbol.'
             end
 
-            set_configuration!(:syntax, syntaxes.inspect)
+            set_config!(:syntax, syntaxes.inspect)
           end
 
           private
@@ -115,7 +115,7 @@ module Transpec
           def syntaxes_node
             return @syntaxes_node if instance_variable_defined?(:@syntaxes_node)
 
-            syntax_setter_node = find_configuration_node(:syntax=)
+            syntax_setter_node = find_config_node(:syntax=)
 
             @syntaxes_node = if syntax_setter_node
                                syntax_setter_node.children[2]
@@ -127,7 +127,7 @@ module Transpec
           class UnknownSyntaxError < StandardError; end
         end
 
-        include SyntaxConfiguration
+        include SyntaxConfig
       end
     end
   end

data/lib/transpec/syntax/rspec_configure/mocks.rb

@@ -11,7 +11,7 @@ module Transpec
         end
 
         def yield_receiver_to_any_instance_implementation_blocks=(boolean)
-          set_configuration!(:yield_receiver_to_any_instance_implementation_blocks, boolean)
+          set_config!(:yield_receiver_to_any_instance_implementation_blocks, boolean)
         end
       end
     end

data/lib/transpec/version.rb

@@ -3,9 +3,9 @@
 module Transpec
   # http://semver.org/
   module Version
-    MAJOR = 1
-    MINOR = 13
-    PATCH = 1
+    MAJOR = 2
+    MINOR = 0
+    PATCH = 0
 
     def self.to_s
       [MAJOR, MINOR, PATCH].join('.')

data/spec/transpec/commit_message_spec.rb

@@ -55,7 +55,7 @@ module Transpec
         end
 
         it 'has conversion summary' do
-          body_lines[3..-1].join('').should == <<-END.gsub(/^\s+\|/, '')
+          body_lines[3..-3].join('').should == <<-END.gsub(/^\s+\|/, '')
             |* 2 conversions
             |    from: obj.should
             |      to: expect(obj).to
@@ -65,6 +65,14 @@ module Transpec
             |      to: allow(obj).to receive(:message)
           END
         end
+
+        it 'has blank line after the summary' do
+          body_lines[-2].chomp.should be_empty
+        end
+
+        it 'has the URL at the last line' do
+          body_lines[-1].chomp.should == 'See also: https://github.com/yujinakayama/transpec#supported-conversions'
+        end
       end
     end
   end

data/spec/transpec/{configuration_spec.rb → config_spec.rb}

@@ -1,14 +1,15 @@
 # coding: utf-8
 
 require 'spec_helper'
-require 'transpec/configuration'
+require 'transpec/config'
 
 module Transpec
-  describe Configuration do
-    subject(:configuration) { Configuration.new }
+  describe Config do
+    subject(:config) { Config.new }
 
     context 'by default' do
       [
+        [:forced?,                                                false],
         [:convert_should?,                                        true],
         [:convert_oneliner?,                                      true],
         [:convert_should_receive?,                                true],
@@ -17,19 +18,19 @@ 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],
+        [:convert_stub_with_hash_to_allow_to_receive_and_return?, false],
         [:skip_dynamic_analysis?,                                 false],
         [:negative_form_of_to,                                    'not_to'],
         [:boolean_matcher_type,                                   :conditional],
-        [:form_of_be_falsey,                                      'be_falsey']
+        [:form_of_be_falsey,                                      'be_falsey'],
+        [:add_receiver_arg_to_any_instance_implementation_block?, true],
+        [:add_explicit_type_metadata_to_example_group?,           true],
+        [:parenthesize_matcher_arg?,                              true]
       ].each do |attribute, value|
         describe "##{attribute}" do
-          subject { configuration.send(attribute) }
+          subject { config.send(attribute) }
 
           it "is #{value.inspect}" do
             should == value
@@ -42,8 +43,8 @@ module Transpec
       ['not_to', 'to_not'] .each do |form|
         context "when #{form.inspect} is passed" do
           it "sets #{form.inspect}" do
-            configuration.negative_form_of_to = form
-            configuration.negative_form_of_to.should == form
+            config.negative_form_of_to = form
+            config.negative_form_of_to.should == form
           end
         end
       end
@@ -51,7 +52,7 @@ module Transpec
       context 'when a form other than "not_to" or "to_not" is passed' do
         it 'raises error' do
           lambda do
-            configuration.negative_form_of_to = 'foo'
+            config.negative_form_of_to = 'foo'
           end.should raise_error(ArgumentError)
         end
       end
@@ -61,8 +62,8 @@ module Transpec
       [:conditional, :exact] .each do |type|
         context "when #{type.inspect} is passed" do
           it "sets #{type.inspect}" do
-            configuration.boolean_matcher_type = type
-            configuration.boolean_matcher_type.should == type
+            config.boolean_matcher_type = type
+            config.boolean_matcher_type.should == type
           end
         end
       end
@@ -70,7 +71,7 @@ module Transpec
       context 'when a type other than :conditional or :exact is passed' do
         it 'raises error' do
           lambda do
-            configuration.boolean_matcher_type = :foo
+            config.boolean_matcher_type = :foo
           end.should raise_error(ArgumentError)
         end
       end
@@ -80,8 +81,8 @@ module Transpec
       ['be_falsey', 'be_falsy'] .each do |form|
         context "when #{form.inspect} is passed" do
           it "sets #{form.inspect}" do
-            configuration.form_of_be_falsey = form
-            configuration.form_of_be_falsey.should == form
+            config.form_of_be_falsey = form
+            config.form_of_be_falsey.should == form
           end
         end
       end
@@ -89,7 +90,7 @@ module Transpec
       context 'when a form other than "be_falsey" or "be_falsy" is passed' do
         it 'raises error' do
           lambda do
-            configuration.form_of_be_falsey = 'foo'
+            config.form_of_be_falsey = 'foo'
           end.should raise_error(ArgumentError)
         end
       end