transpec 0.1.3 → 0.2.0

data/lib/transpec/version.rb

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

data/spec/.rubocop.yml

@@ -8,7 +8,7 @@ Void:
 
 # Lengthen for long descriptions.
 LineLength:
-  Max: 110
+  Max: 120
 
 # raise_error matcher always requires {} form block.
 Blocks:

data/spec/support/shared_context.rb

@@ -50,3 +50,13 @@ shared_context 'isolated environment' do
     end
   end
 end
+
+shared_context 'inside of git repository' do
+  around do |example|
+    Dir.mkdir('repo')
+    Dir.chdir('repo') do
+      `git init`
+      example.run
+    end
+  end
+end

data/spec/transpec/cli_spec.rb

@@ -25,20 +25,40 @@ module Transpec
       end
     end
 
+    describe '#generates_commit_message?' do
+      subject { cli.generates_commit_message? }
+
+      context 'by default' do
+        it { should be_false }
+      end
+    end
+
     describe '#run' do
+      include_context 'isolated environment'
+
+      subject { cli.run(args) }
+
+      let(:args) { [file_path] }
+      let(:file_path) { 'spec/example_spec.rb' }
+      let(:file_content) do
+        <<-END
+          describe 'something' do
+            it 'is 1' do
+              1.should == 1
+            end
+          end
+        END
+      end
+
       before do
         cli.stub(:puts)
         cli.stub(:warn)
-        cli.stub(:target_files).and_return(args)
+        create_file(file_path, file_content)
       end
 
-      subject { cli.run(args) }
-      let(:args) { ['some_file.rb'] }
-      let(:rewriter) { double('rewriter').as_null_object }
-
       shared_examples 'rewrites files' do
         it 'rewrites files' do
-          rewriter.should_receive(:rewrite_file!)
+          cli.should_receive(:process_file)
           cli.run(args)
         end
 
@@ -47,15 +67,7 @@ module Transpec
         end
       end
 
-      shared_context 'stubbed rewriter' do
-        before do
-          Rewriter.stub(:new).and_return(rewriter)
-        end
-      end
-
       context 'when git is available' do
-        include_context 'stubbed rewriter'
-
         before { Git.stub(:command_available?).and_return(true) }
 
         context 'and inside of a repository' do
@@ -68,7 +80,7 @@ module Transpec
               before { cli.stub(:forced?).and_return(false) }
 
               it 'aborts processing' do
-                rewriter.should_not_receive(:rewrite_file!)
+                cli.should_not_receive(:process_file)
                 cli.run(args).should be_false
               end
 
@@ -100,14 +112,11 @@ module Transpec
       end
 
       context 'when git is not available' do
-        include_context 'stubbed rewriter'
         before { Git.stub(:command_available?).and_return(false) }
         include_examples 'rewrites files'
       end
 
       context 'when a syntax error is raised while processing files' do
-        include_context 'isolated environment'
-
         let(:args) { [invalid_syntax_file_path, valid_syntax_file_path] }
         let(:invalid_syntax_file_path) { 'invalid_example.rb' }
         let(:valid_syntax_file_path) { 'valid_example.rb' }
@@ -133,30 +142,23 @@ module Transpec
       end
 
       context 'when any other error is raised while running' do
-        include_context 'stubbed rewriter'
-
-        before do
-          cli.stub(:parse_options).and_raise(ArgumentError, 'No such file or directory - non-existent-file')
-        end
+        let(:args) { ['non-existent-file'] }
 
         it 'return false' do
           should be_false
         end
 
         it 'prints message of the exception' do
-          cli.should_receive(:warn).with('No such file or directory - non-existent-file')
-          cli.run([])
+          cli.should_receive(:warn).with(/No such file or directory/)
+          cli.run(args)
         end
       end
 
       context 'when no target paths are specified' do
-        include_context 'isolated environment'
-        include_context 'stubbed rewriter'
-
         let(:args) { [] }
 
         context 'and there is "spec" directory' do
-          before { Dir.mkdir('spec') }
+          let(:file_path) { 'spec/example_spec.rb' }
 
           it 'targets files in the "spec" directoy' do
             cli.should_receive(:target_files).with(['spec'])
@@ -165,11 +167,35 @@ module Transpec
         end
 
         context 'and there is not "spec" directory' do
+          let(:file_path) { 'example_spec.rb' }
+
           it 'aborts' do
             should be_false
           end
         end
       end
+
+      context 'when -m/--commit-message option is specified' do
+        include_context 'inside of git repository'
+
+        let(:args) { ['--force', '--commit-message', file_path] }
+
+        context 'and any conversion is done' do
+          it 'writes commit message to .git/COMMIT_EDITMSG' do
+            cli.run(args)
+            File.read('.git/COMMIT_EDITMSG').should start_with('Convert specs')
+          end
+        end
+
+        context 'and no conversion is done' do
+          let(:file_content) { '' }
+
+          it 'does not writes commit message' do
+            cli.run(args)
+            File.exist?('.git/COMMIT_EDITMSG').should be_false
+          end
+        end
+      end
     end
 
     describe '#process_file' do
@@ -232,6 +258,27 @@ module Transpec
         end
       end
 
+      describe '-m/--commit-message option' do
+        include_context 'isolated environment'
+
+        let(:args) { ['--commit-message'] }
+
+        context 'when inside of git repository' do
+          include_context 'inside of git repository'
+
+          it 'sets #generates_commit_message? true' do
+            cli.parse_options(args)
+            cli.generates_commit_message?.should be_true
+          end
+        end
+
+        context 'when not inside of git repository' do
+          it 'raises error' do
+            -> { cli.parse_options(args) }.should raise_error(/not in a Git repository/)
+          end
+        end
+      end
+
       describe '-d/--disable option' do
         [
           ['expect_to_matcher', :convert_to_expect_to_matcher?],

data/spec/transpec/commit_message_spec.rb

@@ -0,0 +1,63 @@
+# coding: utf-8
+
+require 'spec_helper'
+require 'transpec/commit_message'
+require 'transpec/report'
+require 'transpec/record'
+
+module Transpec
+  describe CommitMessage do
+    subject(:commit_message) { CommitMessage.new(report, cli_args) }
+    let(:report) { Report.new }
+    let(:cli_args) { %w(--force --commit-message) }
+
+    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')
+    end
+
+    describe '#to_s' do
+      it 'wraps lines within 72 characters' do
+        commit_message.to_s.each_line do |line|
+          line.chomp.size.should <= 72
+        end
+      end
+
+      let(:lines) { commit_message.to_s.lines.to_a }
+
+      it 'has concise summary at first line' do
+        lines[0].chomp.should == 'Convert specs to latest RSpec syntax with Transpec'
+      end
+
+      it 'has blank line at second line' do
+        lines[1].chomp.should be_empty
+      end
+
+      let(:body_lines) { lines[2..-1] }
+
+      it 'has Transpec description at the beginning of the body'  do
+        body_lines[0].chomp
+          .should match(/^This conversion is done by Transpec \d+\.\d+\.\d+ with the following command:$/)
+        body_lines[1].chomp
+          .should ==     '    transpec --force --commit-message'
+      end
+
+      it 'has blank line after the preface in the body' do
+        body_lines[2].chomp.should be_empty
+      end
+
+      it 'has conversion summary in the body' do
+        body_lines[3..-1].join('').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
+end

data/spec/transpec/configuration_spec.rb

@@ -43,7 +43,7 @@ module Transpec
 
       context 'when a form other than "not_to" or "to_not" is passed' do
         it 'raises error' do
-          proc do
+          lambda do
             configuration.negative_form_of_to = 'foo'
           end.should raise_error(ArgumentError)
         end

data/spec/transpec/git_spec.rb

@@ -20,66 +20,142 @@ module Transpec
       end
     end
 
-    shared_context 'inside of git repository' do
-      around do |example|
-        Dir.mkdir('repo')
-        Dir.chdir('repo') do
-          `git init`
-          example.run
-        end
-      end
-    end
-
     describe '.inside_of_repository?' do
       subject { Git.inside_of_repository? }
 
-      context 'when the current directory is inside of git repository' do
-        include_context 'inside of git repository'
-        it { should be_true }
+      context 'when git command is avaialable' do
+        context 'and the current directory is inside of git repository' do
+          include_context 'inside of git repository'
+          it { should be_true }
+        end
+
+        context 'and the current directory is not inside of git repository' do
+          it { should be_false }
+        end
       end
 
-      context 'when the current directory is not inside of git repository' do
-        it { should be_false }
+      context 'when git command is not avaialable' do
+        before { Git.stub(:command_available?).and_return(false) }
+
+        it 'raises error' do
+          -> { Git.inside_of_repository? }.should raise_error(/command is not available/)
+        end
       end
     end
 
     describe '.clean?' do
-      include_context 'inside of git repository'
-
       subject { Git.clean? }
 
-      before do
-        File.write('foo', 'This is a sample file')
-        `git add .`
-        `git commit -m 'Initial commit'`
-      end
+      context 'when inside of git repository' do
+        include_context 'inside of git repository'
 
-      context 'when there are no changes' do
-        it { should be_true }
+        before do
+          File.write('foo', 'This is a sample file')
+          `git add .`
+          `git commit -m 'Initial commit'`
+        end
+
+        context 'and there are no changes' do
+          it { should be_true }
+        end
+
+        context 'and there is an untracked file' do
+          before { File.write('bar', 'This is an untracked file') }
+          it { should be_false }
+        end
+
+        context 'and there is a deleted file' do
+          before { File.delete('foo') }
+          it { should be_false }
+        end
+
+        context 'and there is a not staged change' do
+          before { File.write('foo', 'This is modified content') }
+          it { should be_false }
+        end
+
+        context 'and there is a staged change' do
+          before do
+            File.write('foo', 'This is modified content')
+            `git add .`
+          end
+
+          it { should be_false }
+        end
       end
 
-      context 'when there is an untracked file' do
-        before { File.write('bar', 'This is an untracked file') }
-        it { should be_false }
+      context 'when not inside of git repository' do
+        it 'raises error' do
+          -> { Git.clean? }.should raise_error(/is not a Git repository/)
+        end
       end
+    end
 
-      context 'when there is a deleted file' do
-        before { File.delete('foo') }
-        it { should be_false }
+    describe '.repository_root' do
+      context 'when inside of git repository' do
+        include_context 'inside of git repository'
+
+        context 'and the current working directory is the repository root' do
+          it 'returns the repository root path' do
+            Git.repository_root.should == File.expand_path('.')
+          end
+        end
+
+        context 'and the current working directory is not the repository root' do
+          around do |example|
+            Dir.mkdir('dir')
+            Dir.chdir('dir') do
+              example.run
+            end
+          end
+
+          it 'returns the repository root path' do
+            Git.repository_root.should == File.expand_path('..')
+          end
+        end
       end
 
-      context 'when there is a not staged change' do
-        before { File.write('foo', 'This is modified content') }
-        it { should be_false }
+      context 'when not inside of git repository' do
+        it 'raises error' do
+          -> { Git.repository_root }.should raise_error(/is not a Git repository/)
+        end
       end
+    end
 
-      context 'when there is a staged change' do
-        before do
-          File.write('foo', 'This is modified content')
-          `git add .`
+    describe '.write_commit_message' do
+      let(:message) { 'This is the commit message.' }
+
+      context 'when inside of git repository' do
+        include_context 'inside of git repository'
+
+        context 'and there is .git directory in the current working directory' do
+          it 'writes the message to .git/COMMIT_EDITMSG' do
+            Git.write_commit_message(message)
+            File.read('.git/COMMIT_EDITMSG').should == message
+          end
         end
 
-        it { should be_false }
+        context 'and there is not .git directory in the current working directory' do
+          around do |example|
+            Dir.mkdir('dir')
+            Dir.chdir('dir') do
+              example.run
+            end
+          end
+
+          it 'writes the message to .git/COMMIT_EDITMSG in repository root directory' do
+            Git.write_commit_message(message)
+            File.read('../.git/COMMIT_EDITMSG').should == message
+          end
+        end
+      end
+
+      context 'when not inside of git repository' do
+        it 'raises error' do
+          lambda do
+            Git.write_commit_message(message)
+          end.should raise_error(/is not a Git repository/)
+        end
       end
     end
   end