transpec 1.10.4 → 1.11.0

data/spec/transpec/dynamic_analyzer/rewriter_spec.rb

@@ -10,8 +10,8 @@ module Transpec
 
       subject(:rewriter) { Rewriter.new }
 
-      describe '#rewrite' do
-        subject { rewriter.rewrite(source) }
+      describe '#rewrite_source' do
+        subject { rewriter.rewrite_source(source) }
 
         let(:source) do
           <<-END
@@ -43,7 +43,7 @@ module Transpec
           # rubocop:disable LineLength
           let(:expected_source) do
             <<-'END'
-              transpec_analyze((transpec_analyze((subject), self, "(string)_14_21", { :should_source_location => [:object, "method(:should).source_location"], :should_example_method_defined_by_user? => [:object, "owner = method(:should).owner\nowner != RSpec::Core::ExampleGroup &&\n  owner.ancestors.include?(RSpec::Core::ExampleGroup)"] }).should), self, "(string)_14_28", { :"=~_source_location" => [:object, "method(:=~).source_location"], :"=~_example_method_defined_by_user?" => [:object, "owner = method(:=~).owner\nowner != RSpec::Core::ExampleGroup &&\n  owner.ancestors.include?(RSpec::Core::ExampleGroup)"], :expect_available? => [:context, "self.class.ancestors.any? { |a| a.name.start_with?('RSpec::') } && respond_to?(:expect)"] }) =~ transpec_analyze((<<-HEREDOC.gsub('foo', 'bar')), self, "(string)_32_61", { :enumerable_arg? => [:object, "is_a?(Enumerable)"] })
+              transpec_analyze((transpec_analyze((subject), self, "(string)_14_21", { :should_source_location => [:object, "method(:should).source_location"], :should_example_method_defined_by_user? => [:object, "owner = method(:should).owner\nowner != RSpec::Core::ExampleGroup &&\n  owner.ancestors.include?(RSpec::Core::ExampleGroup)"] }).should), self, "(string)_14_28", { :expect_available? => [:context, "self.class.ancestors.any? { |a| a.name.start_with?('RSpec::') } && respond_to?(:expect)"], :"=~_source_location" => [:object, "method(:=~).source_location"], :"=~_example_method_defined_by_user?" => [:object, "owner = method(:=~).owner\nowner != RSpec::Core::ExampleGroup &&\n  owner.ancestors.include?(RSpec::Core::ExampleGroup)"] }) =~ transpec_analyze((<<-HEREDOC.gsub('foo', 'bar')), self, "(string)_32_61", { :enumerable_arg? => [:object, "is_a?(Enumerable)"] })
               foo
               HEREDOC
             END

data/spec/transpec/dynamic_analyzer_spec.rb

@@ -92,7 +92,10 @@ module Transpec
 
       context 'when no path is passed' do
         it 'rewrites all files in the "spec" directory' do
-          DynamicAnalyzer::Rewriter.any_instance.should_receive(:rewrite_file!).with(file_path)
+          DynamicAnalyzer::Rewriter.any_instance.should_receive(:rewrite_file!) do |spec|
+            spec.path.should == file_path
+          end
+
           dynamic_analyzer.analyze
         end
       end
@@ -103,7 +106,10 @@ module Transpec
         end
 
         it 'rewrites only files in the passed paths' do
-          DynamicAnalyzer::Rewriter.any_instance.should_receive(:rewrite_file!).with(file_path)
+          DynamicAnalyzer::Rewriter.any_instance.should_receive(:rewrite_file!) do |spec|
+            spec.path.should == file_path
+          end
+
           dynamic_analyzer.analyze([file_path])
         end
       end

data/spec/transpec/option_parser_spec.rb

@@ -101,6 +101,32 @@ module Transpec
         end
       end
 
+      describe '-v/--convert option' do
+        [
+          ['stub_with_hash', :convert_stub_with_hash_to_allow_to_receive_and_return?],
+          ['example_group',  :convert_example_group?]
+        ].each do |cli_type, config_attr|
+          context "when #{cli_type.inspect} is specified" do
+            let(:args) { ['--convert', cli_type] }
+
+            it "sets Configuration##{config_attr} true" do
+              parser.parse(args)
+              configuration.send(config_attr).should be_true
+            end
+          end
+        end
+
+        context 'when unknown type is specified' do
+          let(:args) { ['--convert', 'unknown'] }
+
+          it 'raises error' do
+            -> { parser.parse(args) }.should raise_error(ArgumentError) { |error|
+              error.message.should == 'Unknown syntax type "unknown"'
+            }
+          end
+        end
+      end
+
       describe '-n/--negative-form option' do
         ['not_to', 'to_not'].each do |form|
           context "when #{form.inspect} is specified" do
@@ -159,9 +185,21 @@ module Transpec
       describe '-t/--convert-stub-with-hash option' do
         let(:args) { ['--convert-stub-with-hash'] }
 
-        it 'sets Configuration#convert_stub_with_hash_to_stub_and_return? true' do
+        before do
+          parser.stub(:warn)
+        end
+
+        it 'sets Configuration#convert_stub_with_hash_to_allow_to_receive_and_return? true' do
+          parser.parse(args)
+          configuration.convert_stub_with_hash_to_allow_to_receive_and_return?.should be_true
+        end
+
+        it 'is deprecated' do
+          parser.should_receive(:warn) do |message|
+            message.should =~ /--convert-stub-with-hash.+deprecated/i
+          end
+
           parser.parse(args)
-          configuration.convert_stub_with_hash_to_stub_and_return?.should be_true
         end
       end
 
@@ -212,9 +250,9 @@ module Transpec
         parser.help
       end
 
-      it 'does not exceed 80 characters in each line' do
+      it 'does not exceed 100 characters in each line' do
         help_text.each_line do |line|
-          line.chomp.length.should <= 80
+          line.chomp.length.should <= 100
         end
       end
 

data/spec/transpec/processed_source_spec.rb

@@ -0,0 +1,67 @@
+# coding: utf-8
+
+require 'spec_helper'
+require 'transpec/processed_source'
+
+module Transpec
+  describe ProcessedSource do
+    describe '.parse_file' do
+      include FileHelper
+      include_context 'isolated environment'
+
+      let(:spec_path) { 'spec/example_spec.rb' }
+
+      before do
+        create_file(spec_path, "puts 'foo'")
+      end
+
+      it 'parses the file and returns processed source' do
+        processed_source = ProcessedSource.parse_file(spec_path)
+        processed_source.path.should == spec_path
+        processed_source.ast.should_not be_nil
+      end
+    end
+
+    describe '.parse' do
+      it 'parses the source and returns processed source' do
+        processed_source = ProcessedSource.parse("puts 'foo'")
+        processed_source.ast.should_not be_nil
+      end
+
+      context 'when a file path is passed' do
+        let(:spec_path) { 'spec/example_spec.rb' }
+
+        it 'sets the path to the instance' do
+          processed_source = ProcessedSource.parse("puts 'foo'", spec_path)
+          processed_source.path.should == spec_path
+        end
+      end
+
+      context 'when no file path is passed' do
+        it 'does not set the path to the instance' do
+          processed_source = ProcessedSource.parse("puts 'foo'")
+          processed_source.path.should be_nil
+        end
+      end
+
+      context 'when the file has invalid source' do
+        it 'sets syntax error to the instance' do
+          processed_source = ProcessedSource.parse('<')
+          processed_source.syntax_error.should be_a(Parser::SyntaxError)
+        end
+      end
+    end
+
+    describe '#to_s' do
+      it 'returns the original source' do
+        source = [
+          "puts 'foo'",
+          "puts 'bar'"
+        ].join("\n")
+
+        processed_source = ProcessedSource.parse(source)
+        processed_source.to_s.should == source
+      end
+    end
+  end
+end

data/spec/transpec/rspec_version_spec.rb

@@ -54,7 +54,9 @@ module Transpec
       ]
     end
 
-    [:receive_messages_available?].each do |method|
+    [
+      :receive_messages_available?
+    ].each do |method|
       include_examples 'version comparisons', method, [
         ['2.14.0',       false],
         ['2.99.0.beta1', false],
@@ -66,7 +68,11 @@ module Transpec
       ]
     end
 
-    [:receive_message_chain_available?, :non_should_matcher_protocol_available?].each do |method|
+    [
+      :receive_message_chain_available?,
+      :non_should_matcher_protocol_available?,
+      :non_monkey_patch_example_group_available?
+    ].each do |method|
       include_examples 'version comparisons', method, [
         ['2.14.0',       false],
         ['2.99.0.beta1', false],

data/spec/transpec/spec_suite_spec.rb

@@ -0,0 +1,107 @@
+# coding: utf-8
+
+require 'spec_helper'
+require 'transpec/spec_suite'
+require 'transpec/dynamic_analyzer'
+
+module Transpec
+  describe SpecSuite do
+    include FileHelper
+    include_context 'isolated environment'
+
+    subject(:spec_suite) { SpecSuite.new(base_paths, runtime_data) }
+    let(:runtime_data) { nil }
+    let(:base_paths) { [] }
+
+    describe '#need_to_modify_yield_receiver_to_any_instance_implementation_blocks_config?' do
+      subject do
+        spec_suite.need_to_modify_yield_receiver_to_any_instance_implementation_blocks_config?
+      end
+
+      context "when there's an any_instance block to convert" do
+        before do
+          create_file('spec/example_spec.rb', <<-END)
+            describe 'example' do
+              it 'responds to #message' do
+                Object.any_instance.stub(:message) do |arg|
+                end
+              end
+            end
+          END
+        end
+
+        it { should be_true }
+      end
+
+      context "when there's no any_instance block to convert" do
+        before do
+          create_file('spec/example_spec.rb', <<-END)
+            describe 'example' do
+              it 'responds to #message' do
+                Object.any_instance.stub(:message) do
+                end
+              end
+            end
+          END
+        end
+
+        it { should be_false }
+      end
+    end
+
+    describe '#main_rspec_configure_node?' do
+      before do
+        create_file('spec/spec_helper.rb', <<-END)
+          RSpec.configure do |config|
+          end
+        END
+
+        create_file('spec/unit/spec_helper.rb', <<-END)
+          require 'spec_helper'
+
+          RSpec.configure do |config|
+          end
+        END
+
+        create_file('spec/unit/unit_spec.rb', <<-END)
+          require 'unit/spec_helper'
+        END
+      end
+
+      context 'without runtime information' do
+        it 'returns true for every node' do
+          spec_suite.specs.each do |spec|
+            spec.ast.each_node do |node|
+              spec_suite.main_rspec_configure_node?(node).should be_true
+            end
+          end
+        end
+      end
+
+      context 'with runtime information' do
+        let(:runtime_data) { Transpec::DynamicAnalyzer.new(silent: true).analyze(base_paths) }
+
+        let(:main_rspec_configure_node) do
+          spec_suite.specs.each do |spec|
+            next unless spec.path == 'spec/spec_helper.rb'
+            spec.ast.each_node do |node|
+              return node if node.send_type? && node.children[1] == :configure
+            end
+          end
+          fail 'Main RSpec.configure node not found!'
+        end
+
+        it 'returns true only for the main RSpec.configure node' do
+          spec_suite.main_rspec_configure_node?(main_rspec_configure_node).should be_true
+
+          spec_suite.specs.each do |spec|
+            spec.ast.each_node do |node|
+              next if node.equal?(main_rspec_configure_node)
+              spec_suite.main_rspec_configure_node?(node).should be_false
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/transpec/syntax/allow_spec.rb

@@ -65,36 +65,18 @@ module Transpec
       describe '#receive_matcher' do
         subject { allow_object.receive_matcher }
 
-        context 'when it is taking #receive matcher' do
-          let(:source) do
-            <<-END
-              describe 'example' do
-                it 'receives :foo' do
-                  allow(subject).to receive(:foo)
-                end
+        let(:source) do
+          <<-END
+            describe 'example' do
+              it 'receives :foo' do
+                allow(subject).to receive(:foo)
               end
-            END
-          end
-
-          it 'returns an instance of Receive' do
-            should be_an(Receive)
-          end
+            end
+          END
         end
 
-        context 'when it is taking any other matcher' do
-          let(:source) do
-            <<-END
-              describe 'example' do
-                it 'is empty' do
-                  allow(subject).to be_empty
-                end
-              end
-            END
-          end
-
-          it 'returns nil' do
-            should be_nil
-          end
+        it 'returns an instance of Receive' do
+          should be_an(Receive)
         end
       end
 

data/spec/transpec/syntax/example_group_spec.rb

@@ -0,0 +1,172 @@
+# coding: utf-8
+
+require 'spec_helper'
+require 'transpec/syntax/example_group'
+
+module Transpec
+  class Syntax
+    describe ExampleGroup do
+      include_context 'parsed objects'
+      include_context 'syntax object', ExampleGroup, :example_group
+
+      let(:record) { example_group.report.records.first }
+
+      describe '#convert_to_non_monkey_patch!' do
+        context 'when it is in top level scope' do
+          [
+            :describe,
+            :shared_examples,
+            :shared_context,
+            :share_examples_for,
+            :shared_examples_for
+          ].each do |method|
+            context "with expression `#{method} 'something' do ... end`" do
+              let(:source) do
+                <<-END
+                  #{method} 'something' do
+                  end
+                END
+              end
+
+              let(:expected_source) do
+                <<-END
+                  RSpec.#{method} 'something' do
+                  end
+                END
+              end
+
+              it "converts to `RSpec.#{method} 'something' do ... end`" do
+                example_group.convert_to_non_monkey_patch!
+                rewritten_source.should == expected_source
+              end
+
+              it "adds record `#{method} 'something' { }` -> `RSpec.#{method} 'something' { }`" do
+                example_group.convert_to_non_monkey_patch!
+                record.original_syntax.should  == "#{method} 'something' { }"
+                record.converted_syntax.should == "RSpec.#{method} 'something' { }"
+              end
+            end
+          end
+        end
+
+        context 'when the #describe is in a module' do
+          let(:source) do
+            <<-END
+              module SomeModule
+                describe 'something' do
+                end
+              end
+            END
+          end
+
+          let(:expected_source) do
+            <<-END
+              module SomeModule
+                RSpec.describe 'something' do
+                end
+              end
+            END
+          end
+
+          it 'converts' do
+            example_group.convert_to_non_monkey_patch!
+            rewritten_source.should == expected_source
+          end
+        end
+
+        shared_context 'multiple #describes' do
+          before do
+            ast.each_node do |node|
+              example_group = described_class.new(node, source_rewriter, runtime_data)
+              next unless example_group.conversion_target?
+              example_group.convert_to_non_monkey_patch!
+            end
+          end
+        end
+
+        context 'when #describes are nested' do
+          include_context 'multiple #describes'
+
+          let(:source) do
+            <<-END
+              describe 'something' do
+                describe '#some_method' do
+                end
+              end
+            END
+          end
+
+          let(:expected_source) do
+            <<-END
+              RSpec.describe 'something' do
+                describe '#some_method' do
+                end
+              end
+            END
+          end
+
+          it 'converts only the outermost #describe' do
+            rewritten_source.should == expected_source
+          end
+        end
+
+        context 'when logical-inner #describe is placed outside of the outer #describe in source' do
+          include_context 'multiple #describes'
+
+          let(:source) do
+            <<-END
+              inner_proc = proc do
+                describe 'inner' do
+                end
+              end
+
+              describe 'outer' do
+                instance_eval(&inner_proc)
+              end
+            END
+          end
+
+          context 'without runtime information' do
+            let(:expected_source) do
+              <<-END
+              inner_proc = proc do
+                RSpec.describe 'inner' do
+                end
+              end
+
+              RSpec.describe 'outer' do
+                instance_eval(&inner_proc)
+              end
+              END
+            end
+
+            it 'unfortunately converts both #describe' do
+              rewritten_source.should == expected_source
+            end
+          end
+
+          context 'with runtime information' do
+            include_context 'dynamic analysis objects'
+
+            let(:expected_source) do
+              <<-END
+              inner_proc = proc do
+                describe 'inner' do
+                end
+              end
+
+              RSpec.describe 'outer' do
+                instance_eval(&inner_proc)
+              end
+              END
+            end
+
+            it 'properly converts only the outermost #describe' do
+              rewritten_source.should == expected_source
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/transpec/syntax/expect_spec.rb

@@ -151,72 +151,36 @@ module Transpec
       describe '#have_matcher' do
         subject { expect_object.have_matcher }
 
-        context 'when it is taking #have matcher' do
-          let(:source) do
-            <<-END
-              describe 'example' do
-                it 'has 2 items' do
-                  expect(subject).to have(2).items
-                end
+        let(:source) do
+          <<-END
+            describe 'example' do
+              it 'has 2 items' do
+                expect(subject).to have(2).items
               end
-            END
-          end
-
-          it 'returns an instance of Have' do
-            should be_an(Have)
-          end
+            end
+          END
         end
 
-        context 'when it is taking any other matcher' do
-          let(:source) do
-            <<-END
-              describe 'example' do
-                it 'is empty' do
-                  expect(subject).to be_empty
-                end
-              end
-            END
-          end
-
-          it 'returns nil' do
-            should be_nil
-          end
+        it 'returns an instance of Have' do
+          should be_an(Have)
         end
       end
 
       describe '#receive_matcher' do
         subject { expect_object.receive_matcher }
 
-        context 'when it is taking #receive matcher' do
-          let(:source) do
-            <<-END
-              describe 'example' do
-                it 'receives :foo' do
-                  expect(subject).to receive(:foo)
-                end
+        let(:source) do
+          <<-END
+            describe 'example' do
+              it 'receives :foo' do
+                expect(subject).to receive(:foo)
               end
-            END
-          end
-
-          it 'returns an instance of Receive' do
-            should be_an(Receive)
-          end
+            end
+          END
         end
 
-        context 'when it is taking any other matcher' do
-          let(:source) do
-            <<-END
-              describe 'example' do
-                it 'is empty' do
-                  expect(subject).to be_empty
-                end
-              end
-            END
-          end
-
-          it 'returns nil' do
-            should be_nil
-          end
+        it 'returns an instance of Receive' do
+          should be_an(Receive)
         end
       end