transpec 0.1.3 → 0.2.0

data/spec/transpec/record_spec.rb

@@ -0,0 +1,18 @@
+# coding: utf-8
+
+require 'spec_helper'
+require 'transpec/record'
+
+module Transpec
+  describe Record do
+    subject(:report) { Record.new(original_syntax, converted_syntax) }
+    let(:original_syntax) { 'obj.should' }
+    let(:converted_syntax) { 'expect(obj).to' }
+
+    describe '#to_s' do
+      it 'returns "`original syntax` -> `converted syntax`"' do
+        report.to_s.should == '`obj.should` -> `expect(obj).to`'
+      end
+    end
+  end
+end

data/spec/transpec/report_spec.rb

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+require 'spec_helper'
+require 'transpec/report'
+require 'transpec/record'
+require 'transpec/syntax'
+
+module Transpec
+  describe Report do
+    subject(:report) { Report.new }
+
+    before do
+      report.records << Record.new('obj.stub(:message)', 'allow(obj).to receive(:message)')
+      report.records << Record.new('obj.should', 'expect(obj).to')
+      report.records << Record.new('obj.should', 'expect(obj).to')
+      report.invalid_context_errors <<
+        Syntax::InvalidContextError.new(double('range'), '#should', '#expect')
+    end
+
+    describe '#unique_record_counts' do
+      subject(:unique_record_counts) { report.unique_record_counts }
+
+      it 'returns counts for unique records' do
+        unique_record_counts.size.should == 2
+      end
+
+      it 'returns hash with record as key and count as value' do
+        unique_record_counts.each do |record, count|
+          case record
+          when Record.new('obj.stub(:message)', 'allow(obj).to receive(:message)')
+            count.should == 1
+          when Record.new('obj.should', 'expect(obj).to')
+            count.should == 2
+          end
+        end
+      end
+
+      it 'is sorted by count in descending order' do
+        unique_record_counts.values.should == [2, 1]
+      end
+    end
+
+    describe '#summary' do
+      it 'returns summary string' do
+        report.summary.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
+
+      context 'when :separate_by_blank_line option is enabled' do
+        it 'separates conversion entries by blank line' do
+          report.summary(separate_by_blank_line: true).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
+
+      context 'when :bullet option is specified' do
+        it 'adds the bullet for each conversion entry' do
+          report.summary(bullet: '-').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
+
+    describe '#stats' do
+      it 'returns stats string' do
+        report.stats.should == '3 conversions, 1 incomplete, 0 errors'
+      end
+    end
+  end
+end

data/spec/transpec/rewriter_spec.rb

@@ -68,6 +68,11 @@ module Transpec
         it 'rewrites all targets properly' do
           should == expected_source
         end
+
+        it 'adds records for only completed conversions' do
+          rewriter.rewrite(source)
+          rewriter.report.records.count.should == 2
+        end
       end
 
       context 'when the source has a monkey-patched expectation outside of example group context' do

data/spec/transpec/syntax/be_close_spec.rb

@@ -21,6 +21,10 @@ module Transpec
       end
 
       describe '#convert_to_be_within!' do
+        before do
+          be_close_object.convert_to_be_within!
+        end
+
         context 'when it is `be_close(expected, delta)` form' do
           let(:source) do
             <<-END
@@ -39,9 +43,14 @@ module Transpec
           end
 
           it 'converts into `be_within(delta).of(expected)` form' do
-            be_close_object.convert_to_be_within!
             rewritten_source.should == expected_source
           end
+
+          it 'adds record "`be_close(expected, delta)` -> `be_within(delta).of(expected)`"' do
+            record = be_close_object.report.records.first
+            record.original_syntax.should  == 'be_close(expected, delta)'
+            record.converted_syntax.should == 'be_within(delta).of(expected)'
+          end
         end
       end
     end

data/spec/transpec/syntax/double_spec.rb

@@ -63,6 +63,12 @@ module Transpec
             it 'replaces with #double' do
               rewritten_source.should == expected_source
             end
+
+            it "adds record \"`#{method}('something')` -> `double('something')`\"" do
+              record = double_object.report.records.first
+              record.original_syntax.should  == "#{method}('something')"
+              record.converted_syntax.should == "double('something')"
+            end
           end
         end
 
@@ -79,6 +85,10 @@ module Transpec
           it 'does nothing' do
             rewritten_source.should == source
           end
+
+          it 'reports nothing' do
+            double_object.report.records.should be_empty
+          end
         end
       end
     end

data/spec/transpec/syntax/matcher_spec.rb

@@ -13,6 +13,8 @@ module Transpec
         Matcher.new(should_object.matcher_node, source_rewriter)
       end
 
+      let(:record) { matcher.report.records.first }
+
       describe '#method_name' do
         context 'when it is operator matcher' do
           let(:source) do
@@ -89,6 +91,11 @@ module Transpec
             rewritten_source.should == expected_source
           end
 
+          it 'adds record "`== expected` -> `eq(expected)`"' do
+            record.original_syntax.should == '== expected'
+            record.converted_syntax.should == 'eq(expected)'
+          end
+
           # Operator methods allow their argument to be in the next line,
           # but non-operator methods do not.
           #
@@ -189,6 +196,11 @@ module Transpec
           it 'converts into `eq(1)` form' do
             rewritten_source.should == expected_source
           end
+
+          it 'adds record "`== expected` -> `eq(expected)`"' do
+            record.original_syntax.should == '== expected'
+            record.converted_syntax.should == 'eq(expected)'
+          end
         end
 
         context 'when it is `be.==(1)` form' do
@@ -314,6 +326,11 @@ module Transpec
             it "converts into `be #{operator} 1` form" do
               rewritten_source.should == expected_source
             end
+
+            it "adds record \"`#{operator} expected` -> `be #{operator} expected`\"" do
+              record.original_syntax.should == "#{operator} expected"
+              record.converted_syntax.should == "be #{operator} expected"
+            end
           end
 
           context "when it is `be #{operator} 1` form" do
@@ -328,6 +345,10 @@ module Transpec
             it 'does nothing' do
               rewritten_source.should == source
             end
+
+            it 'reports nothing' do
+              matcher.report.records.should be_empty
+            end
           end
         end
 
@@ -351,6 +372,11 @@ module Transpec
           it 'converts into `match(/pattern/)` form' do
             rewritten_source.should == expected_source
           end
+
+          it 'adds record "`=~ /pattern/` -> `match(/pattern/)`"' do
+            record.original_syntax.should == '=~ /pattern/'
+            record.converted_syntax.should == 'match(/pattern/)'
+          end
         end
 
         context 'when it is `=~/pattern/` form' do
@@ -417,6 +443,11 @@ module Transpec
           it 'converts into `match_array([1, 2])` form' do
             rewritten_source.should == expected_source
           end
+
+          it 'adds record "`=~ [1, 2]` -> `match_array([1, 2])`"' do
+            record.original_syntax.should == '=~ [1, 2]'
+            record.converted_syntax.should == 'match_array([1, 2])'
+          end
         end
 
         context 'when it is `=~[1, 2]` form' do

data/spec/transpec/syntax/method_stub_spec.rb

@@ -20,6 +20,8 @@ module Transpec
         fail 'No method stub node is found!'
       end
 
+      let(:record) { method_stub_object.report.records.first }
+
       describe '.target_node?' do
         let(:send_node) do
           ast.each_descendent_node do |node|
@@ -91,6 +93,7 @@ module Transpec
       describe '#allowize!' do
         before do
           method_stub_object.context.stub(:in_example_group?).and_return(true)
+          method_stub_object.allowize!
         end
 
         [:stub, :stub!].each do |method|
@@ -112,9 +115,13 @@ module Transpec
             end
 
             it 'converts into `allow(subject).to receive(:method)` form' do
-              method_stub_object.allowize!
               rewritten_source.should == expected_source
             end
+
+            it "adds record \"`obj.#{method}(:message)` -> `allow(obj).to receive(:message)`\"" do
+              record.original_syntax.should  == "obj.#{method}(:message)"
+              record.converted_syntax.should == 'allow(obj).to receive(:message)'
+            end
           end
 
           context "when it is `subject.#{method}(:method).and_return(value)` form" do
@@ -135,7 +142,6 @@ module Transpec
             end
 
             it 'converts into `allow(subject).to receive(:method).and_return(value)` form' do
-              method_stub_object.allowize!
               rewritten_source.should == expected_source
             end
           end
@@ -158,7 +164,6 @@ module Transpec
             end
 
             it 'converts into `allow(subject).to receive(:method).and_raise(RuntimeError)` form' do
-              method_stub_object.allowize!
               rewritten_source.should == expected_source
             end
           end
@@ -191,7 +196,6 @@ module Transpec
             end
 
             it 'keeps the style as far as possible' do
-              method_stub_object.allowize!
               rewritten_source.should == expected_source
             end
           end
@@ -214,9 +218,14 @@ module Transpec
             end
 
             it 'converts into `allow(subject).to receive(:method).and_return(value)` form' do
-              method_stub_object.allowize!
               rewritten_source.should == expected_source
             end
+
+            it 'adds record ' +
+               "\"`obj.#{method}(:message => value)` -> `allow(obj).to receive(:message).and_return(value)`\"" do
+              record.original_syntax.should  == "obj.#{method}(:message => value)"
+              record.converted_syntax.should == 'allow(obj).to receive(:message).and_return(value)'
+            end
           end
 
           context "when it is `subject.#{method}(method: value)` form" do
@@ -237,9 +246,14 @@ module Transpec
             end
 
             it 'converts into `allow(subject).to receive(:method).and_return(value)` form' do
-              method_stub_object.allowize!
               rewritten_source.should == expected_source
             end
+
+            it 'adds record ' +
+               "\"`obj.#{method}(:message => value)` -> `allow(obj).to receive(:message).and_return(value)`\"" do
+              record.original_syntax.should  == "obj.#{method}(:message => value)"
+              record.converted_syntax.should == 'allow(obj).to receive(:message).and_return(value)'
+            end
           end
 
           context "when it is `subject.#{method}(:a_method => a_value, b_method => b_value)` form" do
@@ -262,10 +276,15 @@ module Transpec
 
             it 'converts into `allow(subject).to receive(:a_method).and_return(a_value)` ' +
                'and `allow(subject).to receive(:b_method).and_return(b_value)` form' do
-              method_stub_object.allowize!
               rewritten_source.should == expected_source
             end
 
+            it 'adds record ' +
+               "\"`obj.#{method}(:message => value)` -> `allow(obj).to receive(:message).and_return(value)`\"" do
+              record.original_syntax.should  == "obj.#{method}(:message => value)"
+              record.converted_syntax.should == 'allow(obj).to receive(:message).and_return(value)'
+            end
+
             context 'when the statement continues over multi lines' do
               let(:source) do
                 <<-END
@@ -291,7 +310,6 @@ module Transpec
               end
 
               it 'keeps the style except around the hash' do
-                method_stub_object.allowize!
                 rewritten_source.should == expected_source
               end
             end
@@ -309,9 +327,12 @@ module Transpec
             end
 
             it 'does nothing' do
-              method_stub_object.allowize!
               rewritten_source.should == source
             end
+
+            it 'reports nothing' do
+              method_stub_object.report.records.should be_empty
+            end
           end
         end
 
@@ -334,9 +355,14 @@ module Transpec
             end
 
             it 'converts into `allow_any_instance_of(SomeClass).to receive(:method)` form' do
-              method_stub_object.allowize!
               rewritten_source.should == expected_source
             end
+
+            it "adds record \"`SomeClass.any_instance.#{method}(:message)` " +
+               '-> `allow_any_instance_of(obj).to receive(:message)`"' do
+              record.original_syntax.should  == "SomeClass.any_instance.#{method}(:message)"
+              record.converted_syntax.should == 'allow_any_instance_of(SomeClass).to receive(:message)'
+            end
           end
         end
 
@@ -351,24 +377,12 @@ module Transpec
             end
 
             it 'does nothing' do
-              method_stub_object.allowize!
               rewritten_source.should == source
             end
-          end
-        end
-
-        context 'when already replaced deprecated method' do
-          let(:source) do
-            <<-END
-              it 'responds to #foo' do
-                subject.stub!(:foo)
-              end
-            END
-          end
 
-          it 'raises error' do
-            method_stub_object.replace_deprecated_method!
-            -> { method_stub_object.allowize! }.should raise_error
+            it 'reports nothing' do
+              method_stub_object.report.records.should be_empty
+            end
           end
         end
       end
@@ -376,6 +390,7 @@ module Transpec
       describe '#replace_deprecated_method!' do
         before do
           method_stub_object.context.stub(:in_example_group?).and_return(true)
+          method_stub_object.replace_deprecated_method!
         end
 
         [
@@ -400,9 +415,14 @@ module Transpec
             end
 
             it "replaces with ##{replacement_method}" do
-              method_stub_object.replace_deprecated_method!
               rewritten_source.should == expected_source
             end
+
+            it 'adds record ' +
+               "\"`obj.#{method}(:message)` -> `obj.#{replacement_method}(:message)`\"" do
+              record.original_syntax.should  == "obj.#{method}(:message)"
+              record.converted_syntax.should == "obj.#{replacement_method}(:message)"
+            end
           end
         end
 
@@ -420,24 +440,12 @@ module Transpec
             end
 
             it 'does nothing' do
-              method_stub_object.replace_deprecated_method!
               rewritten_source.should == source
             end
-          end
-        end
 
-        context 'when already allowized' do
-          let(:source) do
-            <<-END
-              it 'responds to #foo' do
-                subject.stub!(:foo)
-              end
-            END
-          end
-
-          it 'raises error' do
-            method_stub_object.allowize!
-            -> { method_stub_object.replace_deprecated_method! }.should raise_error
+            it 'reports nothing' do
+              method_stub_object.report.records.should be_empty
+            end
           end
         end
       end
@@ -495,6 +503,10 @@ module Transpec
       end
 
       describe '#remove_allowance_for_no_message!' do
+        before do
+          method_stub_object.remove_allowance_for_no_message!
+        end
+
         context 'when it is `subject.stub(:method).any_number_of_times` form' do
           let(:source) do
             <<-END
@@ -513,7 +525,6 @@ module Transpec
           end
 
           it 'removes `.any_number_of_times`' do
-            method_stub_object.remove_allowance_for_no_message!
             rewritten_source.should == expected_source
           end
         end
@@ -536,7 +547,6 @@ module Transpec
           end
 
           it 'removes `.at_least(0)`' do
-            method_stub_object.remove_allowance_for_no_message!
             rewritten_source.should == expected_source
           end
         end
@@ -551,7 +561,6 @@ module Transpec
           end
 
           it 'does nothing' do
-            method_stub_object.remove_allowance_for_no_message!
             rewritten_source.should == source
           end
         end