transpec 2.3.3 → 2.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 585693816f02d6ca49a0a8a4e0ccec79e5514b96
-  data.tar.gz: 082314811f1021acf7036e0bccd4f88c99348f07
+  metadata.gz: 86662f1a0e4d74de2c72d36a51b77e8a64b28636
+  data.tar.gz: a6fda615ce95a0808a127d6bf9412665accc3b7d
 SHA512:
-  metadata.gz: e7c2c4e9b46e0a3e70939acbcda80531511edab54637e75ff1e070e88490e648f36ff69a55dd86af680d0b355c67537f2e86747e392b86d3e1889bfb8e40fc54
-  data.tar.gz: 648882d9a093d0be7abc399922f3d1deadef1af0386e0028fd25b7cfc0f7aee5c71af05e050940c3e12d7bb34e8e5013f1523d1dd06a68b6737fc3531b96a286
+  metadata.gz: 062e9dcef16a3c208fef5fdc439b0e9a1fec8b99eb43dd32a6afc9f2a446c2c9e45f89472728686515e194ebecf3709b505c939edf68454c65dae01f63be81d4
+  data.tar.gz: e153260bbd9c687c0281a37eb82b8e6b376fa2961601580186bf26074957fa2948e30f6ea3acbf9bf2cad415af33aacdc675f27b3bb678f182a466ce0c3e1789

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Development
 
+## v2.3.4
+
+* Detect whether RSpec configuration `config.raise_errors_for_deprecations!` which interferes with Transpec's dynamic analysis is enabled in the user's specs and abort processing if so. ([#80](https://github.com/yujinakayama/transpec/issues/80))
+
 ## v2.3.3
 
 * Fix failure on dynamic analysis when there's a RSpec-like method invocation in a context that undefines `Object` methods (e.g. `after` callback in [factory_girl definition context](https://github.com/thoughtbot/factory_girl/blob/v4.4.0/lib/factory_girl/definition_proxy.rb#L3-L7)). ([#66](https://github.com/yujinakayama/transpec/issues/66))

data/CONTRIBUTING.md

@@ -4,10 +4,11 @@ If you're going to report an issue or submit a pull request, please follow these
 
 ## Reporting an Issue
 
-* Provide the problematic code or the project's URL.
-* Include the version of Ruby you're using (`ruby --version`).
-* Include the version of Transpec you're using (`transpec --version`).
-* Include complete command-line options you passed to `transpec`.
+* Provide the following information:
+    * The problematic code or the project's URL
+    * The version of Ruby you're using (`ruby --version`)
+    * The version of Transpec you're using (`transpec --version`)
+    * The complete command-line options you passed to `transpec`
 
 ## Pull Requests
 

data/Guardfile

@@ -1,17 +1,17 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
+
+ignore %r{^\.cache/}
 
 # This group allows to skip running RuboCop if RSpec failed,
 # like Red > Green (RSpec) > Refactor (RuboCop).
 group :red_green_refactor, halt_on_fail: true do
-  guard :rspec, all_on_start: true, cmd: 'bundle exec rspec --format Fuubar' do
+  guard :rspec, cmd: 'bundle exec rspec --format Fuubar' do
     watch(%r{^spec/.+_spec\.rb$})
     watch(%r{^lib/(.+)\.rb$})        { |m| "spec/#{m[1]}_spec.rb" }
     watch('spec/spec_helper.rb')     { "spec" }
     watch(%r{^spec/support/.+\.rb$}) { "spec" }
   end
 
-  guard :rubocop, cli: '--format fuubar' do
+  guard :rubocop, all_on_start: false, cli: '--format fuubar' do
     watch(%r{.+\.rb$})
     watch(%r{.+\.rake$})
     watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }

data/README.md

@@ -407,11 +407,14 @@ end
 * `expect` is defined on `RSpec::Matchers` module which is included by `RSpec::Core::ExampleGroup` class, so you can use `expect` only where `self` is an instance of `RSpec::Core::ExampleGroup` (i.e. in `it` blocks, `:each` hook blocks or included module methods) or other classes that explicitly include `RSpec::Matchers`.
 
 With the above example, in the context of `1.should == 1`, the `self` is an instance of `MyAwesomeTestRunner`.
-Transpec tracks contexts and skips conversion if the target syntax cannot be converted in a case like this.
+Transpec tracks contexts and skips conversion if the syntax cannot be converted in a case like this.
 
 ### Solution
 
-Include or extend `RSpec::Matchers` module to make `expect` available in the context:
+Include or extend any of the following module to make RSpec syntax available in the context:
+
+* `RSpec::Matchers` for `expect(obj).to some_matcher`
+* `RSpec::Mocks::ExampleMethods` for `expect/allow(obj).to receive(:message)`
 
 ```ruby
   class MyAwesomeTestRunner

data/README.md.erb

@@ -391,11 +391,14 @@ end
 * `expect` is defined on `RSpec::Matchers` module which is included by `RSpec::Core::ExampleGroup` class, so you can use `expect` only where `self` is an instance of `RSpec::Core::ExampleGroup` (i.e. in `it` blocks, `:each` hook blocks or included module methods) or other classes that explicitly include `RSpec::Matchers`.
 
 With the above example, in the context of `1.should == 1`, the `self` is an instance of `MyAwesomeTestRunner`.
-Transpec tracks contexts and skips conversion if the target syntax cannot be converted in a case like this.
+Transpec tracks contexts and skips conversion if the syntax cannot be converted in a case like this.
 
 ### Solution
 
-Include or extend `RSpec::Matchers` module to make `expect` available in the context:
+Include or extend any of the following module to make RSpec syntax available in the context:
+
+* `RSpec::Matchers` for `expect(obj).to some_matcher`
+* `RSpec::Mocks::ExampleMethods` for `expect/allow(obj).to receive(:message)`
 
 ```ruby
   class MyAwesomeTestRunner

data/lib/transpec/cli.rb

@@ -34,12 +34,8 @@ module Transpec
         return false
       end
 
-      begin
-        process(paths)
-      rescue DynamicAnalyzer::AnalysisError
-        warn_dynamic_analysis_error
-        return false
-      end
+      done = process(paths)
+      return false unless done
 
       display_summary
       generate_commit_message
@@ -49,10 +45,9 @@ module Transpec
     end
 
     def process(paths)
-      runtime_data = nil
-
       unless config.skip_dynamic_analysis?
         runtime_data = run_dynamic_analysis(paths)
+        return false unless runtime_data
       end
 
       spec_suite = SpecSuite.new(paths, runtime_data)
@@ -65,6 +60,26 @@ module Transpec
       spec_suite.specs.each do |spec|
         convert_spec(spec, spec_suite)
       end
+
+      true
+    end
+
+    def run_dynamic_analysis(paths)
+      runtime_data = nil
+
+      puts 'Copying the project for dynamic analysis...'
+
+      DynamicAnalyzer.new(rspec_command: config.rspec_command) do |analyzer|
+        puts "Running dynamic analysis with command #{analyzer.rspec_command.inspect}..."
+        runtime_data = analyzer.analyze(paths)
+      end
+
+      puts
+
+      runtime_data
+    rescue DynamicAnalyzer::AnalysisError => error
+      warn "\n" + error.message.color(:red)
+      return nil
     end
 
     def convert_spec(spec, spec_suite)
@@ -96,21 +111,6 @@ module Transpec
       end
     end
 
-    def run_dynamic_analysis(paths)
-      runtime_data = nil
-
-      puts 'Copying the project for dynamic analysis...'
-
-      DynamicAnalyzer.new(rspec_command: config.rspec_command) do |analyzer|
-        puts "Running dynamic analysis with command #{analyzer.rspec_command.inspect}..."
-        runtime_data = analyzer.analyze(paths)
-      end
-
-      puts
-
-      runtime_data
-    end
-
     def display_summary
       puts
 
@@ -145,13 +145,6 @@ module Transpec
       puts "Done! Now run #{'rspec'.bright} and check if everything is green."
     end
 
-    def warn_dynamic_analysis_error
-      warn 'Failed running dynamic analysis. ' \
-           'Transpec runs your specs in a copied project directory. ' \
-           'If your project requires some special setup or commands to run specs, ' \
-           'use -c/--rspec-command option.'
-    end
-
     def warn_syntax_error(error)
       warn "Syntax error at #{error.diagnostic.location}. Skipping the file.".color(:red)
     end

data/lib/transpec/dynamic_analyzer/runtime_data.rb

@@ -18,6 +18,9 @@ module Transpec
       end
 
       def initialize(data = CompatibleOpenStruct.new)
+        error_message = data[RUNTIME_DATA_ERROR_MESSAGE_KEY]
+        fail AnalysisError, error_message if error_message
+
         @data = data
       end
 
@@ -29,7 +32,7 @@ module Transpec
       end
 
       def run?(node)
-        self[node]
+        !self[node].nil?
       end
 
       def present?(node, key)

data/lib/transpec/dynamic_analyzer/transpec_analysis_helper.rb.erb

@@ -31,16 +31,44 @@ module <%= ANALYSIS_MODULE %>
     object
   end
 
-  at_exit do
+  def error_message=(message)
+    data[<%= RUNTIME_DATA_ERROR_MESSAGE_KEY.inspect %>] = message
+  end
+
+  def validate_rspec_configuration!(config)
+    deprecation_stream_name = config.deprecation_stream.class.name
+
+    if deprecation_stream_name.start_with?('RSpec::Core::Formatters::DeprecationFormatter')
+      self.error_message = 'Aborted dynamic analysis. ' \
+                           'Disable `RSpec.configure { |c| c.raise_errors_for_deprecations! }` ' \
+                           "in your spec because it interferes with Transpec's dynamic analysis."
+      save_result
+      exit(1)
+    end
+  end
+
+  def save_result
     # Use JSON rather than Marshal so that:
     # * Unknown third-party class information won't be serialized.
     #   (Such objects are stored as a string.)
     # * Singleton method information won't be serialized.
     #   (With Marshal.load, `singleton can't be dumped (TypeError)` will be raised.)
     require 'json'
+
     path = File.join(@base_path, '<%= RESULT_FILE %>')
+
     File.open(path, 'w') do |file|
       JSON.dump(data, file)
     end
   end
+
+  at_exit do
+    save_result
+  end
+end
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    Transpec.validate_rspec_configuration!(config)
+  end
 end

data/lib/transpec/dynamic_analyzer.rb

@@ -12,8 +12,9 @@ require 'English'
 
 module Transpec
   class DynamicAnalyzer
-    ANALYSIS_MODULE = 'TranspecAnalysis'
+    ANALYSIS_MODULE = 'Transpec'
     ANALYSIS_METHOD = 'analyze'
+    RUNTIME_DATA_ERROR_MESSAGE_KEY = :error_message
     HELPER_TEMPLATE_FILE = 'transpec_analysis_helper.rb.erb'
     RESULT_FILE = 'transpec_analysis_result.json'
 
@@ -52,16 +53,14 @@ module Transpec
 
     private
 
-    def in_copied_project
+    def in_copied_project(&block)
       return yield if @in_copied_project
 
       @in_copied_project = true
 
       Dir.mktmpdir do |tmpdir|
         copied_project_path = DirectoryCloner.copy_recursively(project.path, tmpdir)
-        Dir.chdir(copied_project_path) do
-          yield
-        end
+        Dir.chdir(copied_project_path, &block)
       end
     ensure
       @in_copied_project = false
@@ -115,8 +114,12 @@ module Transpec
       File.open(RESULT_FILE) do |file|
         RuntimeData.load(file)
       end
-    rescue
-      raise AnalysisError
+    rescue Errno::ENOENT
+      message = 'Failed running dynamic analysis. ' \
+                'Transpec runs your specs in a copied project directory. ' \
+                'If your project requires some special setup or commands to run specs, ' \
+                'use -c/--rspec-command option.'
+      raise AnalysisError, message
     end
 
     class AnalysisError < StandardError; end

data/lib/transpec/syntax/rspec_configure.rb

@@ -3,6 +3,7 @@
 require 'transpec/syntax'
 require 'transpec/syntax/mixin/rspec_rails'
 require 'transpec/syntax/mixin/send'
+require 'transpec/dynamic_analyzer'
 require 'transpec/util'
 
 module Transpec
@@ -15,8 +16,9 @@ module Transpec
       include Mixin::Send, Mixin::RSpecRails, ConfigModification
 
       define_dynamic_analysis do |rewriter|
-        code = "TranspecAnalysis.temporary_data[:rspec_configure_run_order] ||= 0\n" \
-               'TranspecAnalysis.temporary_data[:rspec_configure_run_order] += 1'
+        run_order = "#{DynamicAnalyzer::ANALYSIS_MODULE}.temporary_data[:rspec_configure_run_order]"
+        code = "#{run_order} ||= 0\n" \
+               "#{run_order} += 1"
         rewriter.register_request(node, :run_order, code)
       end
 

data/lib/transpec/version.rb

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

data/spec/transpec/cli_spec.rb

@@ -134,7 +134,6 @@ module Transpec
 
       context "when the project's RSpec dependency is older than the required version" do
         before do
-          Git.stub(:command_available?).and_return(false)
           cli.project.stub(:rspec_version).and_return(RSpecVersion.new('2.13.0'))
         end
 
@@ -148,19 +147,10 @@ module Transpec
 
       context 'when analysis error is raised in the dynamic analysis' do
         before do
-          Git.stub(:command_available?).and_return(false)
           DynamicAnalyzer.any_instance.stub(:analyze).and_raise(DynamicAnalyzer::AnalysisError)
         end
 
         include_examples 'aborts processing'
-
-        it 'suggests using -c/--rspec-command option' do
-          cli.should_receive(:warn) do |message|
-            message.should include('use -c/--rspec-command')
-          end
-
-          cli.run(args)
-        end
       end
 
       context 'when a syntax error is raised while processing files' do

data/spec/transpec/dynamic_analyzer/rewriter_spec.rb

@@ -22,7 +22,7 @@ module Transpec
         # rubocop:disable LineLength
         let(:expected_source) do
           <<-'END'
-            TranspecAnalysis.analyze((TranspecAnalysis.analyze((subject), self, "(string)_12_19", { :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 be(foo)), self, "(string)_12_34", { :expect_available? => [:context, "self.class.ancestors.any? { |a| a.name.start_with?('RSpec::') } && respond_to?(:expect)"] })
+            Transpec.analyze((Transpec.analyze((subject), self, "(string)_12_19", { :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 be(foo)), self, "(string)_12_34", { :expect_available? => [:context, "self.class.ancestors.any? { |a| a.name.start_with?('RSpec::') } && respond_to?(:expect)"] })
           END
         end
         # rubocop:enable LineLength
@@ -43,7 +43,7 @@ module Transpec
           # rubocop:disable LineLength
           let(:expected_source) do
             <<-'END'
-              TranspecAnalysis.analyze((TranspecAnalysis.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)"] }) =~ TranspecAnalysis.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
@@ -65,7 +65,7 @@ module Transpec
           # rubocop:disable LineLength
           let(:expected_source) do
             <<-'END'
-              TranspecAnalysis.analyze((expect { do_something }), self, "(string)_14_20", { :expect_source_location => [:context, "method(:expect).source_location"], :expect_example_method_defined_by_user? => [:context, "owner = method(:expect).owner\nowner != RSpec::Core::ExampleGroup &&\n  owner.ancestors.include?(RSpec::Core::ExampleGroup)"] }).to throw_symbol
+              Transpec.analyze((expect { do_something }), self, "(string)_14_20", { :expect_source_location => [:context, "method(:expect).source_location"], :expect_example_method_defined_by_user? => [:context, "owner = method(:expect).owner\nowner != RSpec::Core::ExampleGroup &&\n  owner.ancestors.include?(RSpec::Core::ExampleGroup)"] }).to throw_symbol
             END
           end
           # rubocop:enable LineLength
@@ -85,7 +85,7 @@ module Transpec
           # rubocop:disable LineLength
           let(:expected_source) do
             <<-'END'
-              TranspecAnalysis.analyze((double 'something'), self, "(string)_14_32", { :double_source_location => [:context, "method(:double).source_location"], :double_example_method_defined_by_user? => [:context, "owner = method(:double).owner\nowner != RSpec::Core::ExampleGroup &&\n  owner.ancestors.include?(RSpec::Core::ExampleGroup)"] })
+              Transpec.analyze((double 'something'), self, "(string)_14_32", { :double_source_location => [:context, "method(:double).source_location"], :double_example_method_defined_by_user? => [:context, "owner = method(:double).owner\nowner != RSpec::Core::ExampleGroup &&\n  owner.ancestors.include?(RSpec::Core::ExampleGroup)"] })
             END
           end
           # rubocop:enable LineLength

data/spec/transpec/dynamic_analyzer_spec.rb

@@ -149,7 +149,8 @@ module Transpec
         let(:source) { 'exit!' }
 
         it 'raises AnalysisError' do
-          -> { dynamic_analyzer.analyze }.should raise_error(DynamicAnalyzer::AnalysisError)
+          -> { dynamic_analyzer.analyze }
+            .should raise_error(DynamicAnalyzer::AnalysisError, /Failed running dynamic analysis/)
         end
       end
 
@@ -248,6 +249,50 @@ module Transpec
         end
       end
 
+      context 'when a deprecated syntax is used with `RSpec.configure { |c| c.raise_errors_for_deprecations! }`' do
+        include CacheHelper
+
+        around do |example|
+          with_cached_dir('rspec-2.99-project') do |cached|
+            unless cached
+              create_file('Gemfile', <<-END)
+                source 'https://rubygems.org'
+                gem 'rspec', '~> 2.99'
+              END
+
+              Project.new.with_bundler_clean_env do
+                `bundle install --path vendor/bundle`
+              end
+
+              create_file('spec/spec_helper.rb', <<-END)
+                RSpec.configure do |config|
+                  config.raise_errors_for_deprecations!
+                end
+              END
+            end
+
+            example.run
+          end
+        end
+
+        let(:source) do
+          <<-END
+            require 'spec_helper'
+
+            describe 'example' do
+              it 'is deprecated syntax' do
+                mock('something')
+              end
+            end
+          END
+        end
+
+        it 'raises AnalysisError with a warning message about `raise_errors_for_deprecations!`' do
+          -> { dynamic_analyzer.analyze }
+            .should raise_error(DynamicAnalyzer::AnalysisError, /raise_errors_for_deprecations!/)
+        end
+      end
+
       runtime_data_cache = {}
 
       subject(:runtime_data) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transpec
 version: !ruby/object:Gem::Version
-  version: 2.3.3
+  version: 2.3.4
 platform: ruby
 authors:
 - Yuji Nakayama
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-08 00:00:00.000000000 Z
+date: 2014-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser