transpec 2.2.2 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ed03b5875402e2f2a94f50eb8ebdd856f61aa84
-  data.tar.gz: e81942f93e064ebac963ff6d17090bbe2e0b05f8
+  metadata.gz: 33c531039bdc9609412069c33d3e89135b4b2f86
+  data.tar.gz: 8b4956401c3985d33cc37f6738141702eb9e6e86
 SHA512:
-  metadata.gz: 26f7db5953c2390bcd8da34b50b8a7c99252a032fdf8027de238de7f186f585e41c82cb0f749588709ff754ca7dd1b7c6df641cd0dd6a7a1b3a7a062d49ed328
-  data.tar.gz: f936d2b514378479df192efe6980d56865477ab749f1e593878f1b98b285d22d3cf26ebf8ff888e1b1107699e2b13c05e0ed94cefcbcffb54640f3eaea2d13b1
+  metadata.gz: af7da633d3f8f61ca7966e1b86ac732bf037e47e78e7241270daadad59582fcaec334bfd37d9426ae817618c1474afc6fe9e488b12aca349fa6ccb615c5e11eb
+  data.tar.gz: e796cfb5e29b16ac5a636e0400771d4398d96a302676bfc4d7c19ad152d757d880348e5367a88c7f9e4835e7f8d560d9e589c31229705df020987234500e45a6

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Development
 
+## v2.2.3
+
+* Handle `its(:attr) { should have(n).items }`. ([#68](https://github.com/yujinakayama/transpec/pull/68))
+
 ## v2.2.2
 
 * Fix error on dynamic analysis when the project have `.rspec` file containing some `--require` options and the required file contains some RSpec API.

data/lib/transpec/syntax/example.rb

@@ -2,13 +2,14 @@
 
 require 'transpec/syntax'
 require 'transpec/syntax/mixin/context_sensitive'
+require 'transpec/syntax/mixin/examplish'
 require 'transpec/syntax/mixin/metadata'
 require 'transpec/rspec_dsl'
 
 module Transpec
   class Syntax
     class Example < Syntax
-      include Mixin::ContextSensitive, Mixin::Metadata, RSpecDSL
+      include Mixin::ContextSensitive, Mixin::Examplish, Mixin::Metadata, RSpecDSL
 
       def dynamic_analysis_target?
         super && receiver_node.nil? && EXAMPLE_METHODS.include?(method_name)
@@ -23,6 +24,10 @@ module Transpec
         convert_pending_metadata_to_skip!
       end
 
+      def description?
+        !arg_node.nil?
+      end
+
       private
 
       def convert_pending_selector_to_skip!

data/lib/transpec/syntax/its.rb

@@ -1,13 +1,14 @@
 # coding: utf-8
 
 require 'transpec/syntax'
+require 'transpec/syntax/mixin/examplish'
 require 'transpec/syntax/mixin/send'
 require 'transpec/util'
 
 module Transpec
   class Syntax
     class Its < Syntax
-      include Mixin::Send, Util
+      include Mixin::Examplish, Mixin::Send, Util
 
       define_dynamic_analysis do |rewriter|
         key = :project_requires_its?
@@ -24,15 +25,20 @@ module Transpec
       end
 
       def convert_to_describe_subject_it!
-        front, rear = build_wrapper_codes
-
-        insert_before(beginning_of_line_range(block_node), front)
+        insert_before(beginning_of_line_range(block_node), front_code)
+        insert_before(expression_range, additional_indentation_for_it)
         replace(range_from_its_to_front_of_block, 'it ')
-        insert_after(block_node.loc.expression, rear)
+        insert_after(block_node.loc.expression, rear_code)
+
+        increment_block_base_indentation!
 
         add_record
       end
 
+      def insert_blank_line_above!
+        insert_before(line_range(node), "\n")
+      end
+
       def attribute_expression
         @attribute_expression ||= AttributeExpression.new(attribute_node)
       end
@@ -47,27 +53,42 @@ module Transpec
         node.parent_node
       end
 
+      def description?
+        false
+      end
+
       private
 
-      def build_wrapper_codes
-        front = ''
-        rear = ''
+      def front_code
+        code = ''
 
-        front << "\n" if !previous_line_is_blank? &&
-                         previous_and_current_line_are_same_indentation_level?
+        if !previous_line_is_blank? && previous_and_current_line_are_same_indentation_level?
+          code << "\n"
+        end
 
         attributes.each_with_index do |attribute, index|
-          indentation = base_indentation + '  ' * index
+          indentation = block_base_indentation + '  ' * index
+          code << indentation + "describe #{attribute.description} do\n"
+          code << indentation + "  subject { super()#{attribute.selector} }\n"
+        end
+
+        code
+      end
 
-          front << indentation + "describe #{attribute.description} do\n"
-          front << indentation + "  subject { super()#{attribute.selector} }\n"
+      def rear_code
+        code = ''
 
-          rear = "\n#{indentation}end" + rear
+        attributes.size.downto(1) do |level|
+          indentation = block_base_indentation + '  ' * (level - 1)
+          code << "\n"
+          code << "#{indentation}end"
         end
 
-        front << '  ' * attributes.size
+        code
+      end
 
-        [front, rear]
+      def additional_indentation_for_it
+        '  ' * attributes.size
       end
 
       def previous_line_is_blank?
@@ -76,7 +97,7 @@ module Transpec
       end
 
       def previous_and_current_line_are_same_indentation_level?
-        indentation_of_line(previous_line_source) == base_indentation
+        indentation_of_line(previous_line_source) == block_base_indentation
       end
 
       def previous_line_source
@@ -85,8 +106,13 @@ module Transpec
         nil
       end
 
-      def base_indentation
-        @base_indentation ||= indentation_of_line(node)
+      # TODO: This is an ad-hoc solution for nested indentation manipulations.
+      def block_base_indentation
+        block_node.metadata[:indentation] ||= indentation_of_line(node)
+      end
+
+      def increment_block_base_indentation!
+        block_node.metadata[:indentation] = block_base_indentation + '  '
       end
 
       def range_from_its_to_front_of_block

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

@@ -0,0 +1,73 @@
+# coding: utf-8
+
+require 'active_support/concern'
+require 'transpec/syntax/mixin/send'
+require 'transpec/util'
+
+module Transpec
+  class Syntax
+    module Mixin
+      module BlockOwner
+        extend ActiveSupport::Concern
+
+        def convert_singleline_block_to_multiline!
+          return unless block_has_body? # TODO
+
+          has_inserted_linefeed = false
+
+          if block_beginning_line == block_body_line
+            replace(range_between_block_begin_and_body, "\n#{block_base_indentation}  ")
+            has_inserted_linefeed = true
+          end
+
+          if block_end_line == block_body_line
+            replace(range_between_block_body_and_end, "\n#{block_base_indentation}")
+            has_inserted_linefeed = true
+          end
+
+          if has_inserted_linefeed
+            replace(block_node.loc.begin, 'do')
+            replace(block_node.loc.end, 'end')
+          end
+        end
+
+        def block_base_indentation
+          Util.indentation_of_line(block_node)
+        end
+
+        def block_has_body?
+          !block_body_node.nil?
+        end
+
+        def block_body_node
+          block_node.children[2]
+        end
+
+        def block_beginning_line
+          block_node.loc.begin.line
+        end
+
+        def block_body_line
+          block_body_node.loc.expression.line
+        end
+
+        def block_end_line
+          block_node.loc.end.line
+        end
+
+        def range_between_block_begin_and_body
+          block_node.loc.begin.end.join(block_body_node.loc.expression.begin)
+        end
+
+        def range_between_block_body_and_end
+          block_body_node.loc.expression.end.join(block_node.loc.end.begin)
+        end
+
+        def block_body_range
+          block_body_node = block_node.children[2]
+          block_body_node.loc.expression
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+require 'active_support/concern'
+require 'transpec/syntax/mixin/block_owner'
+
+module Transpec
+  class Syntax
+    module Mixin
+      module Examplish
+        extend ActiveSupport::Concern
+        include Mixin::BlockOwner
+
+        def block_node
+          parent_node.block_type? ? parent_node : nil
+        end
+
+        def insert_description!(description)
+          fail 'This example already has description' if description?
+          insert_before(block_node.loc.begin, "'#{description}' ")
+        end
+      end
+    end
+  end
+end

data/lib/transpec/syntax/oneliner_should.rb

@@ -2,7 +2,7 @@
 
 require 'transpec/syntax'
 require 'transpec/syntax/mixin/should_base'
-require 'transpec/rspec_dsl'
+require 'transpec/syntax/example'
 require 'transpec/util'
 require 'active_support/inflector/methods'
 require 'active_support/inflector/inflections'
@@ -24,6 +24,16 @@ module Transpec
         super && receiver_node.nil? && [:should, :should_not].include?(method_name)
       end
 
+      def conversion_target?
+        return false unless dynamic_analysis_target?
+        return true unless runtime_data.run?(send_analysis_target_node)
+        return false unless defined_in_rspec_source?
+        # #should inside of #its is dynamically defined in MemoizedHelper,
+        # so it cannot be differentiated from user-defined methods by the dynamic analysis in Send.
+        # https://github.com/rspec/rspec-core/blob/v2.14.8/lib/rspec/core/memoized_helpers.rb#L439
+        !example_method_defined_by_user? || in_its?
+      end
+
       def expectize!(negative_form = 'not_to')
         replacement = 'is_expected.'
         replacement << (positive? ? 'to' : negative_form)
@@ -60,9 +70,26 @@ module Transpec
         report.records << OnelinerShouldHaveRecord.new(self, have_matcher, negative_form)
       end
 
-      def example_has_description?
-        send_node = example_block_node.children.first
-        send_node.children[2]
+      def example
+        return @example if instance_variable_defined?(:@example)
+
+        @example = nil
+
+        node.each_ancestor_node do |node|
+          next unless node.block_type?
+          send_node = node.children[0]
+
+          found = Syntax.all_syntaxes.find do |syntax_class|
+            next unless syntax_class.ancestors.include?(Mixin::Examplish)
+            syntax = syntax_class.new(send_node, source_rewriter, runtime_data)
+            next unless syntax.conversion_target?
+            @example = syntax
+          end
+
+          break if found
+        end
+
+        @example
       end
 
       def build_description(size)
@@ -91,53 +118,17 @@ module Transpec
           fail 'This one-liner #should does not have #have matcher!'
         end
 
-        unless example_has_description?
-          insert_before(example_block_node.loc.begin, "'#{generated_description}' ")
-        end
-
-        indentation = indentation_of_line(example_block_node)
-
-        unless linefeed_at_beginning_of_block?
-          replace(left_curly_and_whitespaces_range, "do\n#{indentation}  ")
-        end
-
-        unless linefeed_at_end_of_block?
-          replace(whitespaces_and_right_curly_range, "\n#{indentation}end")
-        end
-      end
-
-      def example_block_node
-        return @example_block_node if instance_variable_defined?(:@example_block_node)
-
-        @example_block_node = node.each_ancestor_node.find do |node|
-          next false unless node.block_type?
-          send_node = node.children.first
-          receiver_node, method_name, = *send_node
-          next false if receiver_node
-          EXAMPLE_METHODS.include?(method_name)
+        unless example.description?
+          example.insert_description!(build_description(have_matcher.size_source))
         end
-      end
-
-      def generated_description
-        build_description(have_matcher.size_source)
-      end
 
-      def linefeed_at_beginning_of_block?
-        beginning_to_body_range = example_block_node.loc.begin.join(expression_range.begin)
-        beginning_to_body_range.source.include?("\n")
-      end
-
-      def linefeed_at_end_of_block?
-        body_to_end_range = expression_range.end.join(example_block_node.loc.end)
-        body_to_end_range.source.include?("\n")
-      end
+        example.convert_singleline_block_to_multiline!
 
-      def left_curly_and_whitespaces_range
-        expand_range_to_adjacent_whitespaces(example_block_node.loc.begin, :end)
+        example.insert_blank_line_above! if in_its?
       end
 
-      def whitespaces_and_right_curly_range
-        expand_range_to_adjacent_whitespaces(example_block_node.loc.end, :begin)
+      def in_its?
+        example.is_a?(Its)
       end
 
       def add_record(negative_form_of_to)
@@ -170,9 +161,9 @@ module Transpec
         private
 
         def build_original_syntax
-          syntax = should.example_has_description? ? "it '...' do" : 'it {'
+          syntax = should.example.description? ? "it '...' do" : 'it {'
           syntax << " #{should.method_name} #{have.method_name}(n).#{original_items} "
-          syntax << (should.example_has_description? ? 'end' : '}')
+          syntax << (should.example.description? ? 'end' : '}')
         end
 
         def build_converted_syntax
@@ -185,7 +176,7 @@ module Transpec
         end
 
         def converted_description
-          if should.example_has_description?
+          if should.example.description?
             "it '...' do"
           else
             "it '#{should.build_description('n')}' do"

data/lib/transpec/syntax/pending.rb

@@ -1,13 +1,14 @@
 # coding: utf-8
 
 require 'transpec/syntax'
+require 'transpec/syntax/mixin/block_owner'
 require 'transpec/syntax/mixin/context_sensitive'
 require 'transpec/util'
 
 module Transpec
   class Syntax
     class Pending < Syntax
-      include Mixin::ContextSensitive, Util
+      include Mixin::BlockOwner, Mixin::ContextSensitive, Util
 
       def dynamic_analysis_target?
         super && receiver_node.nil? && method_name == :pending
@@ -69,22 +70,6 @@ module Transpec
         block_node_taken_by_method(node)
       end
 
-      def block_body_node
-        block_node.children[2]
-      end
-
-      def block_beginning_line
-        block_node.loc.begin.line
-      end
-
-      def block_body_line
-        block_body_node.loc.expression.line
-      end
-
-      def block_end_line
-        block_node.loc.end.line
-      end
-
       def range_between_pending_and_body
         expression_range.end.join(block_body_node.loc.expression.begin)
       end

data/lib/transpec/version.rb

@@ -5,7 +5,7 @@ module Transpec
   module Version
     MAJOR = 2
     MINOR = 2
-    PATCH = 2
+    PATCH = 3
 
     def self.to_s
       [MAJOR, MINOR, PATCH].join('.')

data/spec/{acceptance → integration}/conversion_spec.rb

@@ -79,6 +79,37 @@ module Transpec
       it 'is converted properly' do
         converted_source.should == expected_source
       end
+
+      context 'with #its' do
+        let(:source) do
+          <<-END
+            describe 'example' do
+              subject { 'foo' }
+              its(:chars) { should have(3).items }
+            end
+          END
+        end
+
+        let(:expected_source) do
+          <<-END
+            describe 'example' do
+              subject { 'foo' }
+
+              describe '#chars' do
+                subject { super().chars }
+
+                it 'has 3 items' do
+                  expect(subject.size).to eq(3)
+                end
+              end
+            end
+          END
+        end
+
+        it 'is converted properly' do
+          converted_source.should == expected_source
+        end
+      end
     end
 
     describe 'one-liner expectation with operator matcher' do

data/spec/transpec/dynamic_analyzer_spec.rb

@@ -161,6 +161,21 @@ module Transpec
         end
       end
 
+      context 'when rspec is run via rake task' do
+        before do
+          create_file('Rakefile', <<-END)
+            require 'rspec/core/rake_task'
+            RSpec::Core::RakeTask.new(:spec)
+          END
+        end
+
+        let(:rspec_command) { 'rake spec' }
+
+        it 'does not raise error' do
+          -> { dynamic_analyzer.analyze }.should_not raise_error
+        end
+      end
+
       context 'when there is a .rspec file containing `--require spec_helper`' do
         before do
           create_file('.rspec', '--require spec_helper')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transpec
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.2.3
 platform: ruby
 authors:
 - Yuji Nakayama
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-10 00:00:00.000000000 Z
+date: 2014-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -295,7 +295,9 @@ files:
 - lib/transpec/syntax/matcher_definition.rb
 - lib/transpec/syntax/method_stub.rb
 - lib/transpec/syntax/mixin/any_instance_block.rb
+- lib/transpec/syntax/mixin/block_owner.rb
 - lib/transpec/syntax/mixin/context_sensitive.rb
+- lib/transpec/syntax/mixin/examplish.rb
 - lib/transpec/syntax/mixin/expect_base.rb
 - lib/transpec/syntax/mixin/expectizable.rb
 - lib/transpec/syntax/mixin/matcher_owner.rb
@@ -324,8 +326,8 @@ files:
 - lib/transpec/util.rb
 - lib/transpec/version.rb
 - spec/.rubocop.yml
-- spec/acceptance/configuration_modification_spec.rb
-- spec/acceptance/conversion_spec.rb
+- spec/integration/configuration_modification_spec.rb
+- spec/integration/conversion_spec.rb
 - spec/spec_helper.rb
 - spec/support/cache_helper.rb
 - spec/support/file_helper.rb
@@ -408,8 +410,8 @@ specification_version: 4
 summary: The RSpec syntax converter
 test_files:
 - spec/.rubocop.yml
-- spec/acceptance/configuration_modification_spec.rb
-- spec/acceptance/conversion_spec.rb
+- spec/integration/configuration_modification_spec.rb
+- spec/integration/conversion_spec.rb
 - spec/spec_helper.rb
 - spec/support/cache_helper.rb
 - spec/support/file_helper.rb