transpec 1.10.2 → 1.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f63ab80111ffedb4a472083d734b97e3546a2378
-  data.tar.gz: e14e5cae27aa6e42915b8c82d3062122e156b711
+  metadata.gz: 81c1501cb0bedfa4aa3c8a489b27cff42d227aa0
+  data.tar.gz: bebe4a68c3997619529e74e6bcdca7cda64fe5c1
 SHA512:
-  metadata.gz: 017fccc8bed755513a5efaafcc11e32233457fc0cc87e40ba0606458898f48ce97a23127e783944193aff0d8ace73428858e0c8cffded85f857a93da15649a44
-  data.tar.gz: 22b1175c44bcc0f151c2d5bf307aabc866650190be0fc690e4aa7fd1b8ebaac78ec344c7e42109e4ea68334222eb28b2b8b2481bffba865b5284710d813e1a15
+  metadata.gz: 63483d99b750ee2ac2db638fdbe1b654151bb0960609595243b49083238117fca9d975710221aa34ea5e57aa53ec65d6b09c7a51b06685f890220ca09692de45
+  data.tar.gz: 0c99b74e4fdfef91915484fc71a6f5579625849c9f7cd3ea82fb12d254109c13f77cd3721908e69d7ca362cf5879150fc75ae7d1e328b0c8619b602b348af7f2

data/CHANGELOG.md

@@ -2,9 +2,13 @@
 
 ## Development
 
+## v1.10.3
+
+* Suggest using `-c/--rspec-command` option and exit gracefully when dynamic analysis failed ([#52](https://github.com/yujinakayama/transpec/issues/52))
+
 ## v1.10.2
 
-* Fix a bug where `expect(an_array + another_array).to have(2).items` was converted to `expect((an_array +(another_array).size).to eq(2)`
+* Fix a bug where `expect(an_array + another_array).to have(2).items` was converted to `expect(an_array +(another_array).size).to eq(2)`
 
 ## v1.10.1
 

data/Guardfile

@@ -4,14 +4,14 @@
 # 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' do
+  guard :rspec, all_on_start: true, 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 do
+  guard :rubocop, cli: '--format fuubar' do
     watch(%r{.+\.rb$})
     watch(%r{.+\.rake$})
     watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }

data/README.md

@@ -144,7 +144,8 @@ After the conversion, run `rspec` again and check whether everything is green:
 $ bundle exec rspec
 ```
 
-If it's green, commit the changes with an auto-generated message that describes the conversion summary:
+If it's green, commit the changes with an auto-generated message
+that describes the conversion summary and helps your team members to understand the new syntax:
 
 ```bash
 $ git commit -aeF .git/COMMIT_EDITMSG

data/README.md.erb

@@ -118,7 +118,8 @@ After the conversion, run `rspec` again and check whether everything is green:
 $ bundle exec rspec
 ```
 
-If it's green, commit the changes with an auto-generated message that describes the conversion summary:
+If it's green, commit the changes with an auto-generated message
+that describes the conversion summary and helps your team members to understand the new syntax:
 
 ```bash
 $ git commit -aeF .git/COMMIT_EDITMSG

data/lib/transpec/cli.rb

@@ -47,12 +47,7 @@ module Transpec
       runtime_data = nil
 
       unless configuration.skip_dynamic_analysis?
-        puts 'Copying the project for dynamic analysis...'
-        DynamicAnalyzer.new(rspec_command: configuration.rspec_command) do |analyzer|
-          puts "Running dynamic analysis with command #{analyzer.rspec_command.inspect}..."
-          runtime_data = analyzer.analyze(paths)
-        end
-        puts
+        runtime_data = run_dynamic_analysis(paths)
       end
 
       FileFinder.find(paths).each do |file_path|
@@ -83,11 +78,32 @@ module Transpec
       end
 
       if project.rspec_version < Transpec.required_rspec_version
-        fail "Your project must have rspec gem dependency #{Transpec.required_rspec_version} " +
+        fail "Your project must have rspec gem dependency #{Transpec.required_rspec_version} " \
              "or later but currently it's #{project.rspec_version}. Aborting."
       end
     end
 
+    def run_dynamic_analysis(paths)
+      runtime_data = nil
+
+      puts 'Copying the project for dynamic analysis...'
+
+      DynamicAnalyzer.new(rspec_command: configuration.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
+      warn 'Failed running dynamic analysis. ' \
+           'Transpec needs to run your specs in a copied project directory for dynamic analysis. ' \
+           'If your project requires some special setup or commands to run specs, ' \
+           'use -c/--rspec-command option.'
+      exit(1)
+    end
+
     def display_summary
       puts
 

data/lib/transpec/conversion_error.rb

@@ -16,7 +16,7 @@ module Transpec
     private
 
     def build_message(original_syntax, target_syntax)
-      "Cannot convert #{original_syntax} into #{target_syntax} " +
+      "Cannot convert #{original_syntax} into #{target_syntax} " \
       "since #{target_syntax} is not available in the context."
     end
   end

data/lib/transpec/dynamic_analyzer.rb

@@ -86,22 +86,18 @@ module Transpec
 
     def analyze(paths = [])
       in_copied_project do
-        rewriter = Rewriter.new
-
-        FileFinder.find(paths).each do |file_path|
-          begin
-            rewriter.rewrite_file!(file_path)
-          rescue Parser::SyntaxError # rubocop:disable HandleExceptions
-            # Syntax errors will be reported in CLI with Converter.
-          end
-        end
+        rewrite_specs(paths)
 
         File.write(HELPER_FILE, HELPER_SOURCE)
 
         run_rspec(paths)
 
-        File.open(RESULT_FILE) do |file|
-          RuntimeData.load(file)
+        begin
+          File.open(RESULT_FILE) do |file|
+            RuntimeData.load(file)
+          end
+        rescue
+          raise AnalysisError
         end
       end
     end
@@ -154,6 +150,18 @@ module Transpec
 
     private
 
+    def rewrite_specs(paths)
+      rewriter = Rewriter.new
+
+      FileFinder.find(paths).each do |file_path|
+        begin
+          rewriter.rewrite_file!(file_path)
+        rescue Parser::SyntaxError # rubocop:disable HandleExceptions
+          # Syntax errors will be reported in CLI with Converter.
+        end
+      end
+    end
+
     def copy(source, destination)
       if File.symlink?(source)
         File.symlink(File.readlink(source), destination)
@@ -175,5 +183,7 @@ module Transpec
         File.chmod(source_mode, destination) unless File.symlink?(destination)
       end
     end
+
+    class AnalysisError < StandardError; end
   end
 end

data/lib/transpec/file_finder.rb

@@ -20,7 +20,7 @@ module Transpec
 
     def base_paths(paths)
       if paths.empty?
-        if Dir.exists?('spec')
+        if Dir.exist?('spec')
           ['spec']
         else
           fail ArgumentError, 'Specify target files or directories.'

data/lib/transpec/version.rb

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

data/spec/transpec/cli_spec.rb

@@ -148,6 +148,28 @@ module Transpec
         end
       end
 
+      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
+
+        it 'suggests using -c/--rspec-command option' do
+          cli.stub(:exit)
+
+          cli.should_receive(:warn) do |message|
+            message.should include('-c/--rspec-command')
+          end
+
+          cli.run(args)
+        end
+
+        it 'exits with status 1' do
+          cli.should_receive(:exit).with(1)
+          cli.run(args)
+        end
+      end
+
       context 'when a syntax error is raised while processing files' do
         let(:args) { [invalid_syntax_file_path, valid_syntax_file_path] }
         let(:invalid_syntax_file_path) { 'invalid_example.rb' }

data/spec/transpec/dynamic_analyzer_spec.rb

@@ -137,8 +137,8 @@ module Transpec
       context 'when analysis result data file is not found' do
         let(:source) { 'exit!' }
 
-        it 'raises error' do
-          -> { dynamic_analyzer.analyze }.should raise_error
+        it 'raises AnalysisError' do
+          -> { dynamic_analyzer.analyze }.should raise_error(DynamicAnalyzer::AnalysisError)
         end
       end
 

data/spec/transpec/syntax/be_boolean_spec.rb

@@ -18,7 +18,7 @@ module Transpec
 
         let(:arg) { 'be_falsey' }
 
-        context 'when it is `be_true`' do
+        context 'with expression `be_true`' do
           let(:source) do
             <<-END
               describe 'example' do
@@ -39,7 +39,7 @@ module Transpec
             END
           end
 
-          it 'converts into `be_truthy`' do
+          it 'converts to `be_truthy`' do
             rewritten_source.should == expected_source
           end
 
@@ -49,7 +49,7 @@ module Transpec
           end
         end
 
-        context 'when it is `be_false`' do
+        context 'with expression `be_false`' do
           let(:source) do
             <<-END
               describe 'example' do
@@ -70,7 +70,7 @@ module Transpec
             END
           end
 
-          it 'converts into `be_falsey`' do
+          it 'converts to `be_falsey`' do
             rewritten_source.should == expected_source
           end
 
@@ -92,7 +92,7 @@ module Transpec
               END
             end
 
-            it 'converts into `be_falsy`' do
+            it 'converts to `be_falsy`' do
               rewritten_source.should == expected_source
             end
 
@@ -109,7 +109,7 @@ module Transpec
           be_boolean_object.convert_to_exact_matcher!
         end
 
-        context 'when it is `be_true`' do
+        context 'with expression `be_true`' do
           let(:source) do
             <<-END
               describe 'example' do
@@ -130,7 +130,7 @@ module Transpec
             END
           end
 
-          it 'converts into `be true`' do
+          it 'converts to `be true`' do
             rewritten_source.should == expected_source
           end
 
@@ -140,7 +140,7 @@ module Transpec
           end
         end
 
-        context 'when it is `be_false`' do
+        context 'with expression `be_false`' do
           let(:source) do
             <<-END
               describe 'example' do
@@ -161,7 +161,7 @@ module Transpec
             END
           end
 
-          it 'converts into `be false`' do
+          it 'converts to `be false`' do
             rewritten_source.should == expected_source
           end
 

data/spec/transpec/syntax/be_close_spec.rb

@@ -14,7 +14,7 @@ module Transpec
           be_close_object.convert_to_be_within!
         end
 
-        context 'when it is `be_close(expected, delta)` form' do
+        context 'with expression `be_close(expected, delta)`' do
           let(:source) do
             <<-END
               describe 'example' do
@@ -35,7 +35,7 @@ module Transpec
             END
           end
 
-          it 'converts into `be_within(delta).of(expected)` form' do
+          it 'converts to `be_within(delta).of(expected)` form' do
             rewritten_source.should == expected_source
           end
 

data/spec/transpec/syntax/current_example_spec.rb

@@ -17,7 +17,7 @@ module Transpec
         end
 
         (RSpecDSL::EXAMPLE_METHODS + RSpecDSL::HOOK_METHODS).each do |method|
-          context "when it is `#{method} do example end` form" do
+          context "with expression `#{method} do example end`" do
             let(:source) do
               <<-END
                 describe 'example' do
@@ -38,7 +38,7 @@ module Transpec
               END
             end
 
-            it "converts into `#{method} do |example| example end` form" do
+            it "converts to `#{method} do |example| example end` form" do
               rewritten_source.should == expected_source
             end
 
@@ -50,7 +50,7 @@ module Transpec
         end
 
         RSpecDSL::HELPER_METHODS.each do |method|
-          context "when it is `#{method}(:name) do example end` form" do
+          context "with expression `#{method}(:name) do example end`" do
             let(:source) do
               <<-END
                 describe 'example' do
@@ -71,7 +71,7 @@ module Transpec
               END
             end
 
-            it "converts into `#{method}(:name) do |example| example end` form" do
+            it "converts to `#{method}(:name) do |example| example end` form" do
               rewritten_source.should == expected_source
             end
 
@@ -82,7 +82,7 @@ module Transpec
           end
         end
 
-        context 'when it is `after { example }` form' do
+        context 'with expression `after { example }`' do
           let(:source) do
             <<-END
               describe 'example' do
@@ -103,12 +103,12 @@ module Transpec
             END
           end
 
-          it 'converts into `after { |example| example }` form' do
+          it 'converts to `after { |example| example }` form' do
             rewritten_source.should == expected_source
           end
         end
 
-        context 'when it is `after do running_example end` form' do
+        context 'with expression `after do running_example end`' do
           let(:source) do
             <<-END
               describe 'example' do
@@ -129,7 +129,7 @@ module Transpec
             END
           end
 
-          it 'converts into `after do |example| example end` form' do
+          it 'converts to `after do |example| example end` form' do
             rewritten_source.should == expected_source
           end
         end
@@ -173,7 +173,7 @@ module Transpec
           end
         end
 
-        context 'when it is `around do |ex| example end` form' do
+        context 'with expression `around do |ex| example end`' do
           let(:source) do
             <<-END
               describe 'example' do
@@ -194,12 +194,12 @@ module Transpec
             END
           end
 
-          it 'converts into `around do |ex| ex end` form' do
+          it 'converts to `around do |ex| ex end` form' do
             rewritten_source.should == expected_source
           end
         end
 
-        context "when it is `example 'it does something' do do_something end` form", :no_auto_convert do
+        context "with expression `example 'it does something' do do_something end`", :no_auto_convert do
           let(:source) do
             <<-END
               describe 'example' do
@@ -215,7 +215,7 @@ module Transpec
           end
         end
 
-        context 'when it is `def helper_method example; end` form' do
+        context 'with expression `def helper_method example; end`' do
           let(:source) do
             <<-END
               module Helper
@@ -252,7 +252,7 @@ module Transpec
             END
           end
 
-          it 'converts into `def helper_method RSpec.current_example; end` form' do
+          it 'converts to `def helper_method RSpec.current_example; end` form' do
             rewritten_source.should == expected_source
           end
 

data/spec/transpec/syntax/double_spec.rb

@@ -117,7 +117,7 @@ module Transpec
         end
 
         [:mock, :stub].each do |method|
-          context "when it is ##{method}" do
+          context "with expression `#{method}('something')`" do
             let(:source) do
               <<-END
                 describe 'example' do
@@ -140,7 +140,7 @@ module Transpec
               END
             end
 
-            it 'replaces with #double' do
+            it "converts to `#{method}('something')`" do
               rewritten_source.should == expected_source
             end
 
@@ -152,7 +152,7 @@ module Transpec
           end
         end
 
-        context 'when it is #double' do
+        context "with expression `double('something')`" do
           let(:source) do
             <<-END
               describe 'example' do

data/spec/transpec/syntax/example_spec.rb

@@ -70,7 +70,7 @@ module Transpec
       describe '#metadata_key_nodes' do
         subject { example_object.metadata_key_nodes }
 
-        context 'when it is `it { }` form' do
+        context 'with expression `it { }`' do
           let(:source) do
             <<-END
               describe 'example' do
@@ -84,7 +84,7 @@ module Transpec
           end
         end
 
-        context "when it is `it 'description' { }` form" do
+        context "with expression `it 'description' { }`" do
           let(:source) do
             <<-END
               describe 'example' do
@@ -100,7 +100,7 @@ module Transpec
           end
         end
 
-        context "when it is `it 'description', :foo { }` form" do
+        context "with expression `it 'description', :foo { }`" do
           let(:source) do
             <<-END
               describe 'example' do
@@ -116,7 +116,7 @@ module Transpec
           end
         end
 
-        context "when it is `it 'description', foo: true { }` form" do
+        context "with expression `it 'description', foo: true { }`" do
           let(:source) do
             <<-END
               describe 'example' do
@@ -132,7 +132,7 @@ module Transpec
           end
         end
 
-        context "when it is `it 'description', :foo, :bar, baz: true { }` form" do
+        context "with expression `it 'description', :foo, :bar, baz: true { }`" do
           let(:source) do
             <<-END
               describe 'example' do
@@ -154,7 +154,7 @@ module Transpec
           example_object.convert_pending_to_skip!
         end
 
-        context "when it is `pending 'is an example' { }` form" do
+        context "with expression `pending 'is an example' { }`" do
           let(:source) do
             <<-END
               describe 'example' do
@@ -175,7 +175,7 @@ module Transpec
             END
           end
 
-          it "converts into `skip 'is an example' { }` form" do
+          it "converts to `skip 'is an example' { }` form" do
             rewritten_source.should == expected_source
           end
 
@@ -185,7 +185,7 @@ module Transpec
           end
         end
 
-        context "when it is `it 'is an example' { }` form" do
+        context "with expression `it 'is an example' { }`" do
           let(:source) do
             <<-END
               describe 'example' do
@@ -201,7 +201,7 @@ module Transpec
           end
         end
 
-        context "when it is `it 'is an example', :pending { }` form" do
+        context "with expression `it 'is an example', :pending { }`" do
           let(:source) do
             <<-END
               describe 'example' do
@@ -222,7 +222,7 @@ module Transpec
             END
           end
 
-          it "converts into `it 'is an example', :skip { }` form" do
+          it "converts to `it 'is an example', :skip { }` form" do
             rewritten_source.should == expected_source
           end
 
@@ -232,7 +232,7 @@ module Transpec
           end
         end
 
-        context "when it is `it 'description', :pending => true { }` form" do
+        context "with expression `it 'description', :pending => true { }`" do
           let(:source) do
             <<-END
               describe 'example' do
@@ -253,7 +253,7 @@ module Transpec
             END
           end
 
-          it "converts into `it 'description', :skip => true { }` form" do
+          it "converts to `it 'description', :skip => true { }` form" do
             rewritten_source.should == expected_source
           end
 
@@ -263,7 +263,7 @@ module Transpec
           end
         end
 
-        context "when it is `it 'description', pending: true { }` form" do
+        context "with expression `it 'description', pending: true { }`" do
           let(:source) do
             <<-END
               describe 'example' do
@@ -284,7 +284,7 @@ module Transpec
             END
           end
 
-          it "converts into `it 'description', skip: true { }` form" do
+          it "converts to `it 'description', skip: true { }` form" do
             rewritten_source.should == expected_source
           end