transpec 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 007748d38ffe681cd54d6fb29dd4da70bffccf38
-  data.tar.gz: 5b5a23a5033dbcbfec53203adb25ced1cd416a26
+  metadata.gz: 9f6772bb858f284cf44c824055979f1cd8fe9cb4
+  data.tar.gz: e960ba822a50bf10dbb7dc615c330ea8cf8eab9e
 SHA512:
-  metadata.gz: 64b41185ba3851b1597ac8c4698674ff92d5b4111169d8f9d3ac2f5afe6a101ceeda41c3cea2c62042f936397b85afb7e8d669868ccd67e0af7db8868d29df2b
-  data.tar.gz: 65a49706d64224c8f6f4421b6db6def9f2e727ff01e04b82ec9f2240e21c0ef75903a63b355850235e5522ba1f5beb1c3b16710af507205cf49b6e27a6c25712
+  metadata.gz: aa0839b39a340d7cf14bb18d2b00051550559f7d677afda0cf859ef3f28afc535372ddb56793cb6421b3cd0fe39bf7c9d0466a01a98418e657578604c940dbb2
+  data.tar.gz: 9421dfa5e886e1f9057506adf5c8e6f87c393ecad4ec793ad84108d22bb4472e29bef9405b17098b2ce1ceba9a654fdd987541dd7081cd12f5d97e0e38efc60c

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Master
 
+## v0.2.0
+
+* Display conversion summary at the end
+* Add `-m/--commit-message` option that allows to generate commit message automatically
+
 ## v0.1.3
 
 * Avoid confusing `Excon.stub` with RSpec's `stub` ([#4](https://github.com/yujinakayama/transpec/issues/4))

data/README.md

@@ -105,11 +105,11 @@ Before converting your specs:
 * Run `rspec` and check if all the specs pass.
 * Ensure the Git repository is clean. (You don't want to mix up your changes and Transpec's changes, right?)
 
-Then, run `transpec` with no arguments in the project root directory:
+Then, run `transpec` (using `--commit-message` is recommended) in the project root directory:
 
 ```bash
 $ cd some-project
-$ transpec
+$ transpec --commit-message
 Processing spec/spec_helper.rb
 Processing spec/spec_spec.rb
 Processing spec/support/file_helper.rb
@@ -120,7 +120,22 @@ Processing spec/transpec/ast/scope_stack_spec.rb
 
 This will convert and overwrite all spec files in the `spec` directory.
 
-After the conversion, run `rspec` again and check if all pass.
+After the conversion, run `rspec` again and check whether all pass:
+
+```bash
+$ bundle exec rspec
+# ...
+843 examples, 0 failures
+```
+
+If all pass, commit the changes with auto-generated message:
+
+```bash
+$ git add -u
+$ git commit -eF .git/COMMIT_EDITMSG
+```
+
+And you are done!
 
 ## Options
 
@@ -139,6 +154,17 @@ Processing spec/spec_spec.rb
 Processing spec/support/file_helper.rb
 ```
 
+### `-m/--commit-message`
+
+Generate commit message that describes conversion summary.
+Currently only Git is supported.
+
+When you commit, you need to run the following command to use the generated message:
+
+```bash
+$ git commit -eF .git/COMMIT_EDITMSG
+```
+
 ### `-d/--disable`
 
 Disable specific conversions.
@@ -408,3 +434,9 @@ Tested on MRI 1.9, MRI 2.0 and JRuby in 1.9 mode.
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## License
+
+Copyright (c) 2013 Yuji Nakayama
+
+See the [LICENSE.txt](LICENSE.txt) for details.

data/README.md.erb

@@ -78,11 +78,11 @@ Before converting your specs:
 * Run `rspec` and check if all the specs pass.
 * Ensure the Git repository is clean. (You don't want to mix up your changes and Transpec's changes, right?)
 
-Then, run `transpec` with no arguments in the project root directory:
+Then, run `transpec` (using `--commit-message` is recommended) in the project root directory:
 
 ```bash
 $ cd some-project
-$ transpec
+$ transpec --commit-message
 Processing spec/spec_helper.rb
 Processing spec/spec_spec.rb
 Processing spec/support/file_helper.rb
@@ -93,7 +93,22 @@ Processing spec/transpec/ast/scope_stack_spec.rb
 
 This will convert and overwrite all spec files in the `spec` directory.
 
-After the conversion, run `rspec` again and check if all pass.
+After the conversion, run `rspec` again and check whether all pass:
+
+```bash
+$ bundle exec rspec
+# ...
+843 examples, 0 failures
+```
+
+If all pass, commit the changes with auto-generated message:
+
+```bash
+$ git add -u
+$ git commit -eF .git/COMMIT_EDITMSG
+```
+
+And you are done!
 
 ## Options
 
@@ -112,6 +127,17 @@ Processing spec/spec_spec.rb
 Processing spec/support/file_helper.rb
 ```
 
+### `-m/--commit-message`
+
+Generate commit message that describes conversion summary.
+Currently only Git is supported.
+
+When you commit, you need to run the following command to use the generated message:
+
+```bash
+$ git commit -eF .git/COMMIT_EDITMSG
+```
+
 ### `-d/--disable`
 
 Disable specific conversions.
@@ -404,3 +430,9 @@ Tested on MRI 1.9, MRI 2.0 and JRuby in 1.9 mode.
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## License
+
+Copyright (c) 2013 Yuji Nakayama
+
+See the [LICENSE.txt](LICENSE.txt) for details.

data/lib/transpec/cli.rb

@@ -1,7 +1,9 @@
 # coding: utf-8
 
 require 'transpec/configuration'
+require 'transpec/commit_message'
 require 'transpec/git'
+require 'transpec/report'
 require 'transpec/rewriter'
 require 'transpec/version'
 require 'optparse'
@@ -17,8 +19,9 @@ module Transpec
              deprecated: :replace_deprecated_method=
     }
 
-    attr_reader :configuration, :forced
+    attr_reader :configuration, :forced, :generates_commit_message
     alias_method :forced?, :forced
+    alias_method :generates_commit_message?, :generates_commit_message
 
     def self.run(args = ARGV)
       new.run(args)
@@ -27,6 +30,8 @@ module Transpec
     def initialize
       @configuration = Configuration.new
       @forced = false
+      @generates_commit_message = false
+      @report = Report.new
     end
 
     def run(args)
@@ -48,7 +53,8 @@ module Transpec
         process_file(file_path)
       end
 
-      # TODO: Print summary
+      display_summary
+      generate_commit_message if generates_commit_message?
 
       true
     rescue => error
@@ -59,13 +65,16 @@ module Transpec
     def process_file(file_path)
       puts "Processing #{file_path}"
 
-      rewriter = Rewriter.new(@configuration)
+      rewriter = Rewriter.new(@configuration, @report)
       rewriter.rewrite_file!(file_path)
 
-      rewriter.errors.each do |error|
+      @report.invalid_context_errors.concat(rewriter.invalid_context_errors)
+
+      rewriter.invalid_context_errors.each do |error|
         warn_not_in_example_group_context_error(error)
       end
     rescue Parser::SyntaxError => error
+      @report.syntax_errors << error
       warn_syntax_error(error)
     end
 
@@ -82,6 +91,18 @@ module Transpec
         @forced = true
       end
 
+      parser.on(
+        '-m', '--commit-message',
+        'Generate commit message that describes',
+        'conversion summary. Only Git is supported.'
+      ) do
+        unless Git.inside_of_repository?
+          fail '-m/--commit-message option is specified but not in a Git repository'
+        end
+
+        @generates_commit_message = true
+      end
+
       parser.on(
         '-d', '--disable TYPE[,TYPE...]',
         'Disable specific conversions.',
@@ -179,6 +200,31 @@ module Transpec
       fail 'The current Git repository is not clean. Aborting.'
     end
 
+    def display_summary
+      puts
+
+      unless @report.records.empty?
+        puts 'Summary:'
+        puts
+        puts @report.colored_summary
+        puts
+      end
+
+      puts @report.colored_stats
+    end
+
+    def generate_commit_message
+      return if @report.records.empty?
+
+      commit_message = CommitMessage.new(@report, ARGV)
+      Git.write_commit_message(commit_message.to_s)
+
+      puts
+      puts 'Commit message was generated to .git/COMMIT_EDITMSG.'.color(:cyan)
+      puts 'Use the following command for the next commit:'.color(:cyan)
+      puts '    git commit -eF .git/COMMIT_EDITMSG'
+    end
+
     def warn_syntax_error(error)
       warn "Syntax error at #{error.diagnostic.location}. Skipping the file.".color(:red)
     end

data/lib/transpec/commit_message.rb

@@ -0,0 +1,25 @@
+# coding: utf-8
+
+require 'transpec/version'
+
+module Transpec
+  class CommitMessage
+    def initialize(report, cli_args = [])
+      @report = report
+      @cli_args = cli_args
+    end
+
+    def to_s
+      conversion_summary = @report.summary(bullet: '*', separate_by_blank_line: true)
+
+      <<-END.gsub(/^\s+\|/, '').chomp
+        |Convert specs to latest RSpec syntax with Transpec
+        |
+        |This conversion is done by Transpec #{Transpec::Version} with the following command:
+        |    transpec #{@cli_args.join(' ')}
+        |
+        |#{conversion_summary}
+      END
+    end
+  end
+end

data/lib/transpec/git.rb

@@ -3,6 +3,7 @@
 module Transpec
   module Git
     GIT = 'git'
+    COMMIT_MESSAGE_FILE_PATH = File.join('.git', 'COMMIT_EDITMSG')
 
     module_function
 
@@ -14,11 +15,28 @@ module Transpec
     end
 
     def inside_of_repository?
+      fail '`git` command is not available' unless command_available?
       system("#{GIT} rev-parse --is-inside-work-tree > /dev/null 2> /dev/null")
     end
 
     def clean?
+      fail_unless_inside_of_repository
       `#{GIT} status --porcelain`.empty?
     end
+
+    def repository_root
+      fail_unless_inside_of_repository
+      `#{GIT} rev-parse --show-toplevel`.chomp
+    end
+
+    def write_commit_message(message)
+      fail_unless_inside_of_repository
+      file_path = File.join(repository_root, COMMIT_MESSAGE_FILE_PATH)
+      File.write(file_path, message)
+    end
+
+    def fail_unless_inside_of_repository
+      fail 'The current working directory is not a Git repository' unless inside_of_repository?
+    end
   end
 end

data/lib/transpec/record.rb

@@ -0,0 +1,28 @@
+# coding: utf-8
+
+module Transpec
+  class Record
+    attr_reader :original_syntax, :converted_syntax
+
+    def initialize(original_syntax, converted_syntax)
+      @original_syntax = original_syntax
+      @converted_syntax = converted_syntax
+    end
+
+    def ==(other)
+      self.class == other.class &&
+        @original_syntax == other.original_syntax &&
+        @converted_syntax == other.converted_syntax
+    end
+
+    alias_method :eql?, :==
+
+    def hash
+      @original_syntax.hash ^ @converted_syntax.hash
+    end
+
+    def to_s
+      "`#{original_syntax}` -> `#{converted_syntax}`"
+    end
+  end
+end

data/lib/transpec/report.rb

@@ -0,0 +1,109 @@
+# coding: utf-8
+
+require 'rainbow'
+
+module Transpec
+  class Report
+    attr_reader :records, :invalid_context_errors, :syntax_errors
+
+    def initialize
+      @records = []
+      @invalid_context_errors = []
+      @syntax_errors = []
+    end
+
+    def unique_record_counts
+      record_counts = Hash.new(0)
+
+      records.each do |record|
+        record_counts[record] += 1
+      end
+
+      Hash[record_counts.sort_by { |record, count| -count }]
+    end
+
+    def colored_summary(options = nil)
+      options ||= { bullet: nil, separate_by_blank_line: false }
+
+      summary = ''
+
+      unique_record_counts.each do |record, count|
+        summary << "\n" if options[:separate_by_blank_line] && !summary.empty?
+        summary << format_record(record, count, options[:bullet])
+      end
+
+      summary
+    end
+
+    def summary(options = nil)
+      without_color { colored_summary(options) }
+    end
+
+    def colored_stats
+      convertion_and_incomplete_stats + error_stats
+    end
+
+    def stats
+      without_color { colored_stats }
+    end
+
+    private
+
+    def without_color
+      # TODO: Consider using another coloring gem that does not depend global state.
+      original_coloring_state = Sickill::Rainbow.enabled
+      Sickill::Rainbow.enabled = false
+      value = yield
+      Sickill::Rainbow.enabled = original_coloring_state
+      value
+    end
+
+    def format_record(record, count, bullet = nil)
+      entry_prefix = bullet ? bullet + ' ' : ''
+      indentation = if bullet
+                      ' ' * entry_prefix.length
+                    else
+                      ''
+                    end
+
+      text = entry_prefix + pluralize(count, 'conversion').color(:cyan) + "\n"
+      text << indentation + '  ' + 'from: '.color(:cyan) + record.original_syntax + "\n"
+      text << indentation + '    ' + 'to: '.color(:cyan) + record.converted_syntax + "\n"
+    end
+
+    def convertion_and_incomplete_stats
+      color = invalid_context_errors.empty? ? :green : :yellow
+
+      text = pluralize(records.count, 'conversion') + ', '
+      text << pluralize(invalid_context_errors.count, 'incomplete') + ', '
+      text.color(color)
+    end
+
+    def error_stats
+      color = if !syntax_errors.empty?
+                :red
+              elsif invalid_context_errors.empty?
+                :green
+              else
+                :yellow
+              end
+
+      pluralize(syntax_errors.count, 'error').color(color)
+    end
+
+    def pluralize(number, thing, options = {})
+      text = ''
+
+      if number == 0 && options[:no_for_zero]
+        text = 'no'
+      else
+        text << number.to_s
+      end
+
+      text << " #{thing}"
+      text << 's' unless number == 1
+
+      text
+    end
+  end
+end