transpec 2.2.5 → 2.3.0

data/lib/transpec/syntax/rspec_configure.rb

@@ -25,7 +25,7 @@ module Transpec
         const_name(receiver_node) == 'RSpec' && method_name == :configure && parent_node.block_type?
       end
 
-      def expose_dsl_globally=(boolean)
+      def expose_dsl_globally=(value)
         comment = <<-END.gsub(/^\s+\|/, '').chomp
           |Setting this config option `false` removes rspec-core's monkey patching of the
           |top level methods like `describe`, `shared_examples_for` and `shared_context`
@@ -35,7 +35,7 @@ module Transpec
           |
           |https://relishapp.com/rspec/rspec-core/v/3-0/docs/configuration/global-namespace-dsl
         END
-        set_config!(:expose_dsl_globally, boolean, comment)
+        set_config_value!(:expose_dsl_globally, value, comment)
       end
 
       def infer_spec_type_from_file_location!
@@ -69,12 +69,43 @@ module Transpec
         !find_config_node(:infer_spec_type_from_file_location!).nil?
       end
 
+      def convert_deprecated_options!(rspec_version) # rubocop:disable MethodLength
+        replace_config!(:backtrace_clean_patterns,  :backtrace_exclusion_patterns)
+        replace_config!(:backtrace_clean_patterns=, :backtrace_exclusion_patterns=)
+        replace_config!(:color_enabled=, :color=)
+
+        if rspec_version.config_output_stream_available?
+          replace_config!(:output,  :output_stream)
+          replace_config!(:output=, :output_stream=)
+          replace_config!(:out,     :output_stream)
+          replace_config!(:out=,    :output_stream=)
+        end
+
+        if rspec_version.config_pattern_available?
+          replace_config!(:filename_pattern,  :pattern)
+          replace_config!(:filename_pattern=, :pattern=)
+        end
+
+        if rspec_version.config_backtrace_formatter_available?
+          replace_config!(:backtrace_cleaner,  :backtrace_formatter)
+          replace_config!(:backtrace_cleaner=, :backtrace_formatter=)
+        end
+
+        if rspec_version.config_predicate_color_enabled_available?
+          replace_config!(:color?, :color_enabled?)
+        end
+
+        if rspec_version.config_predicate_warnings_available?
+          replace_config!(:warnings, :warnings?)
+        end
+      end
+
       def expectations
-        @expectations ||= Expectations.new(self, source_rewriter)
+        @expectations ||= Expectations.new(self)
       end
 
       def mocks
-        @mocks ||= Mocks.new(self, source_rewriter)
+        @mocks ||= Mocks.new(self)
       end
 
       alias_method :block_node, :parent_node

data/lib/transpec/syntax/should.rb

@@ -42,13 +42,7 @@ module Transpec
         replace(should_range, positive? ? 'to' : negative_form)
 
         @current_syntax_type = :expect
-        add_record(negative_form)
-      end
-
-      private
-
-      def expect_available?
-        syntax_available?(__method__)
+        add_record(RecordBuilder.build(self, negative_form))
       end
 
       def proc_subject?
@@ -59,28 +53,49 @@ module Transpec
         receiver_node.nil? && method_name == :expect
       end
 
+      def name_of_subject_method_taking_block
+        range_of_subject_method_taking_block.source
+      end
+
+      private
+
+      def expect_available?
+        syntax_available?(__method__)
+      end
+
       def range_of_subject_method_taking_block
         send_node = subject_node.children.first
         send_node.loc.expression
       end
 
-      def add_record(negative_form_of_to)
-        if proc_subject?
-          original_syntax = "#{range_of_subject_method_taking_block.source} { }.should"
-          converted_syntax = 'expect { }.'
-        else
-          original_syntax = 'obj.should'
-          converted_syntax = 'expect(obj).'
+      class RecordBuilder < Transpec::RecordBuilder
+        attr_reader :should, :negative_form_of_to
+
+        def initialize(should, negative_form_of_to)
+          @should = should
+          @negative_form_of_to = negative_form_of_to
         end
 
-        if positive?
-          converted_syntax << 'to'
-        else
-          original_syntax << '_not'
-          converted_syntax << negative_form_of_to
+        def old_syntax
+          syntax = if should.proc_subject?
+                     "#{should.name_of_subject_method_taking_block} { }.should"
+                   else
+                     'obj.should'
+                   end
+
+          syntax << '_not' unless should.positive?
+          syntax
         end
 
-        report.records << Record.new(original_syntax, converted_syntax)
+        def new_syntax
+          syntax = if should.proc_subject?
+                     'expect { }.'
+                   else
+                     'expect(obj).'
+                   end
+
+          syntax << (should.positive? ? 'to' : negative_form_of_to)
+        end
       end
     end
   end

data/lib/transpec/syntax/should_receive.rb

@@ -51,7 +51,8 @@ module Transpec
         end
 
         convert_to_syntax!('expect', negative_form)
-        add_record(ExpectRecord, negative_form)
+
+        add_record(ExpectRecordBuilder.build(self, negative_form))
       end
 
       def allowize_useless_expectation!(negative_form = 'not_to')
@@ -64,7 +65,7 @@ module Transpec
         convert_to_syntax!('allow', negative_form)
         remove_no_message_allowance!
 
-        add_record(AllowRecord, negative_form)
+        add_record(AllowRecordBuilder.build(self, negative_form))
       end
 
       def stubize_useless_expectation!
@@ -73,15 +74,17 @@ module Transpec
         replace(selector_range, 'stub')
         remove_no_message_allowance!
 
-        add_record(StubRecord)
+        add_record(StubRecordBuilder.build(self))
       end
 
       def remove_useless_and_return!
-        super && add_record(MonkeyPatchUselessAndReturnRecord)
+        return unless super
+        add_record(Mixin::UselessAndReturn::MonkeyPatchRecordBuilder.build(self))
       end
 
       def add_receiver_arg_to_any_instance_implementation_block!
-        super && add_record(MonkeyPatchAnyInstanceBlockRecord)
+        return unless super
+        add_record(Mixin::AnyInstanceBlock::MonkeyPatchRecordBuilder.build(self))
       end
 
       private
@@ -158,11 +161,9 @@ module Transpec
         end
       end
 
-      def add_record(record_class, negative_form_of_to = nil)
-        report.records << record_class.new(self, negative_form_of_to)
-      end
+      class ExpectBaseRecordBuilder < RecordBuilder
+        attr_reader :should_receive, :negative_form_of_to
 
-      class ExpectBaseRecord < Record
         def initialize(should_receive, negative_form_of_to)
           @should_receive = should_receive
           @negative_form_of_to = negative_form_of_to
@@ -172,58 +173,60 @@ module Transpec
           fail NotImplementedError
         end
 
-        def build_original_syntax
-          syntax = if @should_receive.any_instance?
+        def old_syntax
+          syntax = if should_receive.any_instance?
                      'Klass.any_instance.'
                    else
                      'obj.'
                    end
-          syntax << "#{@should_receive.method_name}(:message)"
+          syntax << "#{should_receive.method_name}(:message)"
         end
 
-        def build_converted_syntax
-          syntax = if @should_receive.any_instance?
+        def new_syntax
+          syntax = if should_receive.any_instance?
                      "#{syntax_name}_any_instance_of(Klass)."
                    else
                      "#{syntax_name}(obj)."
                    end
-          syntax << (@should_receive.positive? ? 'to' : @negative_form_of_to)
+          syntax << (should_receive.positive? ? 'to' : negative_form_of_to)
           syntax << ' receive(:message)'
         end
       end
 
-      class ExpectRecord < ExpectBaseRecord
+      class ExpectRecordBuilder < ExpectBaseRecordBuilder
         def syntax_name
           'expect'
         end
       end
 
-      class AllowRecord < ExpectBaseRecord
+      class AllowRecordBuilder < ExpectBaseRecordBuilder
         def syntax_name
           'allow'
         end
 
-        def build_original_syntax
+        def old_syntax
           syntax = super
-          syntax << '.any_number_of_times' if @should_receive.any_number_of_times?
-          syntax << '.at_least(0)' if @should_receive.at_least_zero?
+          syntax << '.any_number_of_times' if should_receive.any_number_of_times?
+          syntax << '.at_least(0)' if should_receive.at_least_zero?
           syntax
         end
       end
 
-      class StubRecord < Record
-        def initialize(should_receive, *)
+      class StubRecordBuilder < RecordBuilder
+        attr_reader :should_receive
+
+        def initialize(should_receive)
           @should_receive = should_receive
         end
 
-        def build_original_syntax
-          syntax = "obj.#{@should_receive.method_name}(:message)"
-          syntax << '.any_number_of_times' if @should_receive.any_number_of_times?
-          syntax << '.at_least(0)' if @should_receive.at_least_zero?
+        def old_syntax
+          syntax = "obj.#{should_receive.method_name}(:message)"
+          syntax << '.any_number_of_times' if should_receive.any_number_of_times?
+          syntax << '.at_least(0)' if should_receive.at_least_zero?
           syntax
         end
 
-        def build_converted_syntax
+        def new_syntax
           'obj.stub(:message)'
         end
       end

data/lib/transpec/syntax.rb

@@ -189,5 +189,15 @@ module Transpec
     def inspect
       "#<#{self.class}: #{node.type}>"
     end
+
+    def add_record(*args)
+      record = if args.first.is_a?(Record)
+                 args.first
+               else
+                 Record.new(*args)
+               end
+
+      report.records << record
+    end
   end
 end

data/lib/transpec/version.rb

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

data/spec/integration/configuration_modification_spec.rb

@@ -16,7 +16,7 @@ module Transpec
     end
 
     context 'when there are multiple RSpec.configure in the spec suite' do
-      before do
+      it 'adds new options only to the one that was run first' do
         create_file('spec/spec_helper.rb', <<-END)
           RSpec.configure do |config|
           end
@@ -39,9 +39,7 @@ module Transpec
             end
           end
         END
-      end
 
-      it 'modifies only the one that was run first' do
         cli.project.stub(:rspec_version).and_return(RSpecVersion.new('2.99.0'))
         cli.run([])
 
@@ -67,6 +65,48 @@ module Transpec
           end
         END
       end
+
+      it 'converts deprecated options in all RSpec.configure' do
+        create_file('spec/spec_helper.rb', <<-END)
+          RSpec.configure do |config|
+            config.color_enabled = true
+          end
+        END
+
+        create_file('spec/unit/spec_helper.rb', <<-END)
+          require 'spec_helper'
+
+          RSpec.configure do |config|
+            config.color_enabled = true
+          end
+        END
+
+        create_file('spec/unit/unit_spec.rb', <<-END)
+          require 'unit/spec_helper'
+
+          describe 'example' do
+            it 'is true' do
+              expect(true).to be true
+            end
+          end
+        END
+
+        cli.run([])
+
+        File.read('spec/spec_helper.rb').should == <<-END
+          RSpec.configure do |config|
+            config.color = true
+          end
+        END
+
+        File.read('spec/unit/spec_helper.rb').should == <<-END
+          require 'spec_helper'
+
+          RSpec.configure do |config|
+            config.color = true
+          end
+        END
+      end
     end
 
     describe 'yield_receiver_to_any_instance_implementation_blocks' do

data/spec/transpec/record_spec.rb

@@ -5,28 +5,123 @@ 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' }
-
-    [
-      :original_syntax,
-      :original_syntax_type,
-      :converted_syntax,
-      :converted_syntax_type
-    ].each do |method|
-      it "forbids override of ##{method}" do
-        lambda do
-          Class.new(Record) do
-            define_method(method) {}
-          end
-        end.should raise_error(/override/)
+    subject(:record) { Record.new(old_syntax, new_syntax, options) }
+    let(:old_syntax) { 'obj.should' }
+    let(:new_syntax) { 'expect(obj).to' }
+    let(:options) { {} }
+
+    describe '.new' do
+      context 'when invalid type is passed' do
+        it 'raises error' do
+          lambda do
+            Record.new('foo', 'bar', type: :unknown_type)
+          end.should raise_error(/invalid type/i)
+        end
+      end
+    end
+
+    describe '#type' do
+      subject { record.type }
+
+      context 'when it has both old and new syntaxes' do
+        let(:old_syntax) { 'obj.should' }
+        let(:new_syntax) { 'expect(obj).to' }
+        it { should == :conversion }
+      end
+
+      context 'when it has only new syntax' do
+        let(:old_syntax) { nil }
+        let(:new_syntax) { 'expect(obj).to' }
+        it { should == :addition }
+      end
+
+      context 'when it has only old syntax' do
+        let(:old_syntax) { 'obj.should' }
+        let(:new_syntax) { nil }
+        it { should == :removal }
+      end
+
+      context 'when the type is specified explicitly' do
+        let(:old_syntax) { 'foo = true' }
+        let(:new_syntax) { 'foo = false' }
+        let(:options) { { type: :modification } }
+        it { should == :modification }
       end
     end
 
     describe '#to_s' do
-      it 'returns "`original syntax` -> `converted syntax`"' do
-        report.to_s.should == '`obj.should` -> `expect(obj).to`'
+      subject { record.to_s }
+
+      context "when it's a conversion" do
+        let(:old_syntax) { 'obj.should' }
+        let(:new_syntax) { 'expect(obj).to' }
+
+        it 'returns "Conversion from `old syntax` to `new syntax`"' do
+          record.to_s.should == 'Conversion from `obj.should` to `expect(obj).to`'
+        end
+      end
+
+      context "when it's an addition" do
+        let(:old_syntax) { nil }
+        let(:new_syntax) { 'expect(obj).to' }
+
+        it 'returns "Addition of `new syntax`"' do
+          record.to_s.should == 'Addition of `expect(obj).to`'
+        end
+      end
+
+      context "when it's a removal" do
+        let(:old_syntax) { 'obj.should' }
+        let(:new_syntax) { nil }
+
+        it 'returns "Removal of `old syntax`"' do
+          record.to_s.should == 'Removal of `obj.should`'
+        end
+      end
+    end
+  end
+
+  describe RecordBuilder do
+    describe '.build' do
+      builder_class = Class.new(RecordBuilder) do
+        attr_reader :some_attr
+
+        def initialize(some_attr)
+          @some_attr = some_attr
+        end
+
+        def old_syntax
+          "obj.should be #{some_attr}"
+        end
+
+        def new_syntax
+          "expect(obj).to be #{some_attr}"
+        end
+
+        def type
+          :modification
+        end
+
+        def annotation
+          'some annotation'
+        end
+      end
+
+      let(:record) { builder_class.build('something') }
+
+      it 'returns an instance of Record' do
+        record.should be_a(Record)
+      end
+
+      {
+        old_syntax: 'obj.should be something',
+        new_syntax: 'expect(obj).to be something',
+              type: :modification,
+        annotation: 'some annotation'
+      }.each do |attribute, value|
+        it "sets builder's ##{attribute} value to record's ##{attribute}" do
+          record.send(attribute).should == value
+        end
       end
     end
   end

data/spec/transpec/report_spec.rb

@@ -10,9 +10,11 @@ module Transpec
     subject(:report) { Report.new }
 
     before do
-      report.records << Record.new('obj.stub(:message)', 'allow(obj).to receive(:message)', double('annotation'))
+      options = { annotation: double('annotation') }
+      report.records << Record.new('obj.stub(:message)', 'allow(obj).to receive(:message)', options)
       report.records << Record.new('obj.should', 'expect(obj).to')
-      report.records << Record.new('obj.should', 'expect(obj).to', double('annotation'))
+      report.records << Record.new('obj.should', 'expect(obj).to', options)
+      report.records << Record.new(nil, 'RSpec.configure { |c| c.infer_spec_type_from_file_location! }')
       report.conversion_errors << ContextError.new('#should', '#expect', double('range'))
     end
 
@@ -20,7 +22,7 @@ module Transpec
       subject(:unique_record_counts) { report.unique_record_counts }
 
       it 'returns counts for unique records' do
-        unique_record_counts.size.should == 2
+        unique_record_counts.size.should == 3
       end
 
       it 'returns hash with record as key and count as value' do
@@ -35,7 +37,7 @@ module Transpec
       end
 
       it 'is sorted by count in descending order' do
-        unique_record_counts.values.should == [2, 1]
+        unique_record_counts.values.should == [2, 1, 1]
       end
     end
 
@@ -48,6 +50,8 @@ module Transpec
           |1 conversion
           |  from: obj.stub(:message)
           |    to: allow(obj).to receive(:message)
+          |1 addition
+          |    of: RSpec.configure { |c| c.infer_spec_type_from_file_location! }
         END
       end
 
@@ -61,6 +65,9 @@ module Transpec
             |1 conversion
             |  from: obj.stub(:message)
             |    to: allow(obj).to receive(:message)
+            |
+            |1 addition
+            |    of: RSpec.configure { |c| c.infer_spec_type_from_file_location! }
           END
         end
       end
@@ -74,6 +81,8 @@ module Transpec
             |- 1 conversion
             |    from: obj.stub(:message)
             |      to: allow(obj).to receive(:message)
+            |- 1 addition
+            |      of: RSpec.configure { |c| c.infer_spec_type_from_file_location! }
           END
         end
       end
@@ -81,7 +90,7 @@ module Transpec
 
     describe '#stats' do
       it 'returns stats string' do
-        report.stats.should == '3 conversions, 1 incomplete, 2 warnings, 0 errors'
+        report.stats.should == '4 conversions, 1 incomplete, 2 warnings, 0 errors'
       end
     end
 
@@ -102,7 +111,7 @@ module Transpec
       end
 
       it 'concats records' do
-        concated_report.should have(4).records
+        concated_report.should have(5).records
       end
 
       it 'concats conversion errors' do

data/spec/transpec/rspec_version_spec.rb

@@ -26,6 +26,7 @@ module Transpec
     [
       :be_truthy_available?,
       :yielded_example_available?,
+      :config_output_stream_available?,
       :yielding_receiver_to_any_instance_implementation_block_available?
     ].each do |method|
       include_examples 'version comparisons', method, [
@@ -59,6 +60,10 @@ module Transpec
     end
 
     [
+      :config_pattern_available?,
+      :config_backtrace_formatter_available?,
+      :config_predicate_color_enabled_available?,
+      :config_predicate_warnings_available?,
       :implicit_spec_type_disablement_available?
     ].each do |method|
       include_examples 'version comparisons', method, [

data/spec/transpec/syntax/be_boolean_spec.rb

@@ -44,8 +44,8 @@ module Transpec
           end
 
           it 'adds record `be_true` -> `be_truthy`' do
-            record.original_syntax.should  == 'be_true'
-            record.converted_syntax.should == 'be_truthy'
+            record.old_syntax.should == 'be_true'
+            record.new_syntax.should == 'be_truthy'
           end
         end
 
@@ -75,8 +75,8 @@ module Transpec
           end
 
           it 'adds record `be_false` -> `be_falsey`' do
-            record.original_syntax.should  == 'be_false'
-            record.converted_syntax.should == 'be_falsey'
+            record.old_syntax.should == 'be_false'
+            record.new_syntax.should == 'be_falsey'
           end
 
           context 'and "be_falsy" is passed' do
@@ -97,8 +97,8 @@ module Transpec
             end
 
             it 'adds record `be_false` -> `be_falsy`' do
-              record.original_syntax.should  == 'be_false'
-              record.converted_syntax.should == 'be_falsy'
+              record.old_syntax.should == 'be_false'
+              record.new_syntax.should == 'be_falsy'
             end
           end
         end
@@ -135,8 +135,8 @@ module Transpec
           end
 
           it 'adds record `be_true` -> `be true`' do
-            record.original_syntax.should  == 'be_true'
-            record.converted_syntax.should == 'be true'
+            record.old_syntax.should == 'be_true'
+            record.new_syntax.should == 'be true'
           end
         end
 
@@ -166,8 +166,8 @@ module Transpec
           end
 
           it 'adds record `be_false` -> `be false`' do
-            record.original_syntax.should  == 'be_false'
-            record.converted_syntax.should == 'be false'
+            record.old_syntax.should == 'be_false'
+            record.new_syntax.should == 'be false'
           end
         end
       end

data/spec/transpec/syntax/be_close_spec.rb

@@ -41,8 +41,8 @@ module Transpec
 
           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)'
+            record.old_syntax.should == 'be_close(expected, delta)'
+            record.new_syntax.should == 'be_within(delta).of(expected)'
           end
         end
       end