transpec 1.3.1 → 1.4.0

data/lib/transpec/util.rb

@@ -2,12 +2,29 @@
 
 module Transpec
   module Util
+    EXAMPLE_GROUP_METHODS = %w(
+      describe context
+      shared_examples shared_context share_examples_for shared_examples_for
+    ).map(&:to_sym).freeze
+
+    EXAMPLE_METHODS = %w(
+      example it specify
+      focus focused fit
+      pending xexample xit xspecify
+    ).map(&:to_sym).freeze
+
+    HOOK_METHODS = %w(before after around).map(&:to_sym).freeze
+
+    HELPER_METHODS = %w(subject subject! let let!).map(&:to_sym).freeze
+
     LITERAL_TYPES = %w(
       true false nil
       int float
       str sym regexp
     ).map(&:to_sym).freeze
 
+    WHITESPACES = [' ', "\t"].freeze
+
     module_function
 
     def proc_literal?(node)
@@ -86,5 +103,42 @@ module Transpec
         false
       end
     end
+
+    def expand_range_to_adjacent_whitespaces(range, direction = :both)
+      source = range.source_buffer.source
+      begin_pos = if [:both, :begin].include?(direction)
+                    find_consecutive_whitespace_position(source, range.begin_pos, :downto)
+                  else
+                    range.begin_pos
+                  end
+
+      end_pos = if [:both, :end].include?(direction)
+                  find_consecutive_whitespace_position(source, range.end_pos - 1, :upto) + 1
+                else
+                  range.end_pos
+                end
+
+      Parser::Source::Range.new(range.source_buffer, begin_pos, end_pos)
+    end
+
+    def find_consecutive_whitespace_position(source, origin, method)
+      from, to = case method
+                 when :upto
+                   [origin + 1, source.length - 1]
+                 when :downto
+                   [origin - 1, 0]
+                 else
+                   fail "Invalid method #{method}"
+                 end
+
+      from.send(method, to).reduce(origin) do |previous_position, position|
+        character = source[position]
+        if WHITESPACES.include?(character)
+          position
+        else
+          return previous_position
+        end
+      end
+    end
   end
 end

data/lib/transpec/version.rb

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

data/spec/support/shared_context.rb

@@ -1,30 +1,31 @@
 # coding: utf-8
 
-require 'transpec/dynamic_analyzer'
-require 'transpec/ast/builder'
-require 'transpec/syntax/should'
-require 'transpec/syntax/expect'
-require 'parser'
-require 'parser/current'
-require 'tmpdir'
-
 # This context requires `source` to be defined with #let.
 shared_context 'parsed objects' do
   let(:source_buffer) do
+    require 'parser'
     buffer = Parser::Source::Buffer.new('(string)')
     buffer.source = source
     buffer
   end
 
   let(:ast) do
+    require 'transpec/ast/builder'
+    require 'parser/current'
     builder = Transpec::AST::Builder.new
     parser = Parser::CurrentRuby.new(builder)
     parser.parse(source_buffer)
   end
 
-  let(:source_rewriter) { Parser::Source::Rewriter.new(source_buffer) }
+  let(:source_rewriter) do
+    require 'parser'
+    Parser::Source::Rewriter.new(source_buffer)
+  end
 
   let(:rewritten_source) { source_rewriter.process }
+
+  # Include 'dynamic analysis objects' after this context so that this nil will be overridden.
+  let(:runtime_data) { nil }
 end
 
 # This context requires `source` to be defined with #let.
@@ -34,6 +35,7 @@ shared_context 'dynamic analysis objects' do
   let(:source_path) { 'spec/example_spec.rb' }
 
   let(:source_buffer) do
+    require 'parser'
     buffer = Parser::Source::Buffer.new(source_path)
     buffer.source = source
     buffer
@@ -42,6 +44,8 @@ shared_context 'dynamic analysis objects' do
   runtime_data_cache = {}
 
   let(:runtime_data) do
+    require 'transpec/dynamic_analyzer'
+
     if runtime_data_cache[source]
       runtime_data_cache[source]
     else
@@ -52,30 +56,16 @@ shared_context 'dynamic analysis objects' do
   end
 end
 
-shared_context 'should object' do
-  let(:should_object) do
-    ast.each_node do |node|
-      next unless Transpec::Syntax::Should.target_node?(node)
-      return Transpec::Syntax::Should.new(node, source_rewriter, runtime_data)
-    end
-
-    fail 'No should node is found!'
-  end
-
-  let(:runtime_data) { nil }
-end
-
-shared_context 'expect object' do
-  let(:expect_object) do
+# This context depends on the context 'parsed objects'.
+shared_context 'syntax object' do |syntax_class, name|
+  let(name) do
     ast.each_node do |node|
-      next unless Transpec::Syntax::Expect.target_node?(node)
-      return Transpec::Syntax::Expect.new(node, source_rewriter, runtime_data)
+      next unless syntax_class.target_node?(node)
+      return syntax_class.new(node, source_rewriter, runtime_data)
     end
 
-    fail 'No expect node is found!'
+    fail "No #{syntax_class.name} node is found!"
   end
-
-  let(:runtime_data) { nil }
 end
 
 shared_context 'isolated environment' do
@@ -89,6 +79,8 @@ shared_context 'isolated environment' do
 end
 
 shared_context 'inside of git repository' do
+  require 'tmpdir'
+
   around do |example|
     Dir.mkdir('repo')
     Dir.chdir('repo') do

data/spec/transpec/ast/node_spec.rb

@@ -43,7 +43,7 @@ module Transpec
           end
         end
 
-        context 'when the node has parent' do
+        context 'when the node does not have parent' do
           it 'returns nil' do
             ast.parent_node.should be_nil
           end

data/spec/transpec/commit_message_spec.rb

@@ -26,37 +26,43 @@ module Transpec
 
       let(:lines) { commit_message.to_s.lines.to_a }
 
-      it 'has concise summary at first line' do
-        lines[0].chomp.should == 'Convert specs to the latest RSpec syntax with Transpec'
+      describe 'first line' do
+        it 'has concise summary' do
+          lines[0].chomp.should == 'Convert specs to the latest RSpec syntax with Transpec'
+        end
       end
 
-      it 'has blank line at second line' do
-        lines[1].chomp.should be_empty
+      describe 'second line' do
+        it 'has blank line' do
+          lines[1].chomp.should be_empty
+        end
       end
 
       let(:body_lines) { lines[2..-1] }
 
-      it 'has Transpec description at the beginning of the body'  do
-        body_lines[0].chomp
-          .should match(/^This conversion is done by Transpec \d+\.\d+\.\d+ with the following command:$/)
-        body_lines[1].chomp
-          .should ==     '    transpec --force --generate-commit-message'
-      end
+      describe 'body' do
+        it 'has Transpec description at the beginning'  do
+          body_lines[0].chomp
+            .should match(/^This conversion is done by Transpec \d+\.\d+\.\d+ with the following command:$/)
+          body_lines[1].chomp
+            .should ==     '    transpec --force --generate-commit-message'
+        end
 
-      it 'has blank line after the preface in the body' do
-        body_lines[2].chomp.should be_empty
-      end
+        it 'has blank line after the preface' do
+          body_lines[2].chomp.should be_empty
+        end
 
-      it 'has conversion summary in the body' do
-        body_lines[3..-1].join('').should == <<-END.gsub(/^\s+\|/, '')
-          |* 2 conversions
-          |    from: obj.should
-          |      to: expect(obj).to
-          |
-          |* 1 conversion
-          |    from: obj.stub(:message)
-          |      to: allow(obj).to receive(:message)
-        END
+        it 'has conversion summary' do
+          body_lines[3..-1].join('').should == <<-END.gsub(/^\s+\|/, '')
+            |* 2 conversions
+            |    from: obj.should
+            |      to: expect(obj).to
+            |
+            |* 1 conversion
+            |    from: obj.stub(:message)
+            |      to: allow(obj).to receive(:message)
+          END
+        end
       end
     end
   end

data/spec/transpec/configuration_spec.rb

@@ -10,6 +10,7 @@ module Transpec
     context 'by default' do
       [
         [:convert_should?,            true],
+        [:convert_oneliner?,          true],
         [:convert_should_receive?,    true],
         [:convert_stub?,              true],
         [:convert_have_items?,        true],

data/spec/transpec/converter_spec.rb

@@ -210,15 +210,179 @@ module Transpec
       end
     end
 
+    describe '#process_oneliner_should' do
+      let(:should_object) { double('oneliner_should_object').as_null_object }
+
+      shared_examples 'does nothing' do
+        it 'does nothing' do
+          should_object.should_not_receive(:expectize!)
+          should_object.should_not_receive(:convert_have_items_to_standard_should!)
+          should_object.should_not_receive(:convert_have_items_to_standard_expect!)
+          converter.process_oneliner_should(should_object)
+        end
+      end
+
+      shared_examples 'invokes OnelinerShould#expectize! if available' do
+        context 'when RSpecVersion#one_liner_is_expected_available? returns true' do
+          before { rspec_version.stub(:one_liner_is_expected_available?).and_return(true) }
+
+          it 'invokes OnelinerShould#expectize!' do
+            should_object.should_receive(:expectize!)
+            converter.process_oneliner_should(should_object)
+          end
+        end
+
+        context 'when RSpecVersion#one_liner_is_expected_available? returns false' do
+          before { rspec_version.stub(:one_liner_is_expected_available?).and_return(false) }
+          include_examples 'does nothing'
+        end
+      end
+
+      shared_examples 'converts to standard expecatations' do
+        context 'and Configuration#convert_should? is true' do
+          before { configuration.convert_should = true }
+
+          it 'invokes OnelinerShould#convert_have_items_to_standard_expect!' do
+            should_object.should_receive(:convert_have_items_to_standard_expect!)
+            converter.process_oneliner_should(should_object)
+          end
+        end
+
+        context 'and Configuration#convert_should? is false' do
+          before { configuration.convert_should = false }
+
+          it 'invokes OnelinerShould#convert_have_items_to_standard_should!' do
+            should_object.should_receive(:convert_have_items_to_standard_should!)
+            converter.process_oneliner_should(should_object)
+          end
+        end
+      end
+
+      context 'when Configuration#convert_oneliner? is true' do
+        before { configuration.convert_oneliner = true }
+
+        context 'and the OnelinerShould has #have matcher' do
+          before do
+            should_object.stub(:have_matcher).and_return(double('have_matcher').as_null_object)
+          end
+
+          context 'and Configuration#convert_have_items? is true' do
+            before { configuration.convert_have_items = true }
+
+            context 'and Have#project_requires_collection_matcher? is true' do
+              before do
+                should_object.have_matcher
+                  .stub(:project_requires_collection_matcher?).and_return(true)
+              end
+              include_examples 'invokes OnelinerShould#expectize! if available'
+            end
+
+            context 'and Have#project_requires_collection_matcher? is false' do
+              before do
+                should_object.have_matcher
+                  .stub(:project_requires_collection_matcher?).and_return(false)
+              end
+              include_examples 'converts to standard expecatations'
+            end
+          end
+
+          context 'and Configuration#convert_have_items? is false' do
+            before { configuration.convert_have_items = false }
+            include_examples 'invokes OnelinerShould#expectize! if available'
+          end
+        end
+
+        context 'and the OnelinerShould does not have #have matcher' do
+          before do
+            should_object.stub(:have_matcher).and_return(nil)
+          end
+
+          context 'and Configuration#convert_have_items? is true' do
+            before { configuration.convert_have_items = true }
+            include_examples 'invokes OnelinerShould#expectize! if available'
+          end
+
+          context 'and Configuration#convert_have_items? is false' do
+            before { configuration.convert_have_items = false }
+            include_examples 'invokes OnelinerShould#expectize! if available'
+          end
+        end
+      end
+
+      context 'when Configuration#convert_oneliner? is false' do
+        before { configuration.convert_oneliner = false }
+
+        context 'and the OnelinerShould has #have matcher' do
+          before do
+            should_object.stub(:have_matcher).and_return(double('have_matcher').as_null_object)
+          end
+
+          context 'and Configuration#convert_have_items? is true' do
+            before { configuration.convert_have_items = true }
+
+            context 'and Have#project_requires_collection_matcher? is true' do
+              before do
+                should_object.have_matcher
+                  .stub(:project_requires_collection_matcher?).and_return(true)
+              end
+              include_examples 'does nothing'
+            end
+
+            context 'and Have#project_requires_collection_matcher? is false' do
+              before do
+                should_object.have_matcher
+                  .stub(:project_requires_collection_matcher?).and_return(false)
+              end
+              include_examples 'converts to standard expecatations'
+            end
+          end
+
+          context 'and Configuration#convert_have_items? is false' do
+            before { configuration.convert_have_items = false }
+            include_examples 'does nothing'
+          end
+        end
+
+        context 'and the OnelinerShould does not have #have matcher' do
+          before do
+            should_object.stub(:have_matcher).and_return(nil)
+          end
+
+          context 'and Configuration#convert_have_items? is true' do
+            before { configuration.convert_have_items = true }
+            include_examples 'does nothing'
+          end
+
+          context 'and Configuration#convert_have_items? is false' do
+            before { configuration.convert_have_items = false }
+            include_examples 'does nothing'
+          end
+        end
+      end
+    end
+
     describe '#process_expect' do
       let(:expect_object) { double('expect_object').as_null_object }
 
       context 'when Configuration#convert_have_items? is true' do
         before { configuration.convert_have_items = true }
 
-        it 'invokes Have#convert_to_standard_expectation!' do
-          expect_object.have_matcher.should_receive(:convert_to_standard_expectation!)
-          converter.process_expect(expect_object)
+        context 'and Configuration#parenthesize_matcher_arg is true' do
+          before { configuration.parenthesize_matcher_arg = true }
+
+          it 'invokes Have#convert_to_standard_expectation! with true' do
+            expect_object.have_matcher.should_receive(:convert_to_standard_expectation!).with(true)
+            converter.process_expect(expect_object)
+          end
+        end
+
+        context 'and Configuration#parenthesize_matcher_arg is false' do
+          before { configuration.parenthesize_matcher_arg = false }
+
+          it 'invokes Have#convert_to_standard_expectation! with false' do
+            expect_object.have_matcher.should_receive(:convert_to_standard_expectation!).with(false)
+            converter.process_expect(expect_object)
+          end
         end
       end
 
@@ -394,8 +558,8 @@ module Transpec
       let(:method_stub_object) { double('method_stub_object').as_null_object }
 
       shared_examples 'invokes MethodStub#allowize!' do
-        it 'invokes MethodStub#allowize! with #receive_messages availability' do
-          method_stub_object.should_receive(:allowize!).with(rspec_version.receive_messages_available?)
+        it 'invokes MethodStub#allowize! with RSpecVersion' do
+          method_stub_object.should_receive(:allowize!).with(rspec_version)
           converter.process_method_stub(method_stub_object)
         end
       end
@@ -627,6 +791,45 @@ module Transpec
       end
     end
 
+    describe '#process_example' do
+      let(:example_object) { double('example_object').as_null_object }
+
+      context 'when RSpecVersion#yielded_example_available? returns true' do
+        before { rspec_version.stub(:yielded_example_available?).and_return(true) }
+
+        context 'when Configuration#convert_deprecated_method? is true' do
+          before { configuration.convert_deprecated_method = true }
+
+          it 'invokes Example#convert!' do
+            example_object.should_receive(:convert!)
+            converter.process_example(example_object)
+          end
+        end
+
+        context 'when Configuration#convert_deprecated_method? is false' do
+          before { configuration.convert_deprecated_method = false }
+
+          it 'does not invoke Its#convert_to_describe_subject_it!' do
+            example_object.should_not_receive(:convert!)
+            converter.process_example(example_object)
+          end
+        end
+      end
+
+      context 'when RSpecVersion#yielded_example_available? returns false' do
+        before { rspec_version.stub(:yielded_example_available?).and_return(false) }
+
+        context 'when Configuration#convert_deprecated_method? is true' do
+          before { configuration.convert_deprecated_method = true }
+
+          it 'does nothing' do
+            example_object.should_not_receive(:convert!)
+            converter.process_example(example_object)
+          end
+        end
+      end
+    end
+
     describe '#process_rspec_configure' do
       let(:rspec_configure) { double('rspec_configure').as_null_object }