minitest_to_rspec 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a27f05346fd70cc99e4153026b9fbbfec34c534
-  data.tar.gz: 56cb0bab1016ecde051d2fcb92f6142d2009c063
+  metadata.gz: f7af6cefcb0786c8e45326f8620a786ad8f2fe89
+  data.tar.gz: 67ca2d184a2ea2b98dda827c70e3a5fbaf44dfbe
 SHA512:
-  metadata.gz: f17804b35926a1820f7f521b421bf27a6840afa78a7c6fef1e3ceb97523b19d451ea749b7af3445904448f0a76d805faba95291a49b4b44251486ad0707dbe95
-  data.tar.gz: aee5ab8d4f585ac6a3798002400072278e0abf3b1d28a90fb6dcaf599424308b6d9d5907e75ef02b247f416827281fe7c713d6661a76395aa700d9482bde8870
+  metadata.gz: 71242e74b6d2c4801191aa11e85214c8ab28b2390e265a9b043c22b64fa05a9ff2e238164c601081a6c89a347e1ae8b840e27541d495fc81f132527f6820c613
+  data.tar.gz: d86f72884d87dba2b95b07132ab0e1a20ce463a4723056ff16c4292c0df2330bbc55e3552e45523521fff6e1ff99aa219b15d9a6f224fe798b8fe49c425a8205

data/CHANGELOG.md

@@ -4,6 +4,14 @@ Change Log
 This project follows [semver 2.0.0][1] and the recommendations
 of [keepachangelog.com][2].
 
+0.5.0
+-----
+
+### Changed
+- Executable
+  - Renamed from `minitest_to_rspec` to `mt2rspec`
+  - The `target_file` argument is now optional
+
 0.4.0
 -----
 

data/README.md

@@ -4,9 +4,9 @@ Converts [minitest][8] files to [rspec][9].
 
 [![Build Status][1]][2] [![Code Climate][3]][4] [![Test Coverage][7]][4]
 
-Selected assertions from [Test::Unit][26], [minitest][8], and
-[ActiveSupport][27] are converted to [rspec-expectations][25].
-Selected methods from [mocha][28] are converted to [rspec-mocks][24].
+- Selected assertions from [Test::Unit][26], [minitest][8],
+  and [ActiveSupport][27] are converted to [rspec-expectations][25].
+- Selected methods from [mocha][28] are converted to [rspec-mocks][24].
 
 Example
 -------
@@ -46,8 +46,9 @@ Usage
 ### CLI
 
 ```bash
-gem install minitest_to_rspec
-bundle exec minitest_to_rspec --rails source_file target_file
+gem install mt2rspec
+bundle exec mt2rspec [--rails] source_file [target_file]
+bundle exec mt2rspec --help
 ```
 
 ### Ruby

data/bin/mt2rspec

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require "minitest_to_rspec/cli"
+MinitestToRspec::CLI.new(ARGV).run

data/lib/minitest_to_rspec/cli.rb

@@ -0,0 +1,98 @@
+require "minitest_to_rspec"
+require "trollop"
+
+# https://github.com/ManageIQ/trollop/issues/57
+module Trollop
+  def self.educate_without_exiting
+    @last_parser.educate($stderr)
+  end
+end
+
+module MinitestToRspec
+  class CLI
+    E_USAGE               = 1.freeze
+    E_FILE_NOT_FOUND      = 2.freeze
+    E_FILE_ALREADY_EXISTS = 3.freeze
+    E_CONVERT_FAIL        = 4.freeze
+
+    BANNER = <<EOS.freeze
+Usage: mt2rspec --rails source_file [target_file]
+
+Reads source_file, writes target_file.  If target_file is omitted,
+its location will be inferred.  For example, test/fruit/banana_test.rb
+implies spec/fruit/banana_spec.rb.
+
+Options:
+EOS
+
+    OPT_RAILS = <<EOS.gsub(/\n/, " ").freeze
+Requires rails_helper instead of spec_helper.
+Passes :type metadatum to RSpec.describe.
+EOS
+
+    attr_reader :rails, :source, :target
+
+    def initialize(args)
+      opts = Trollop::options(args) do
+        version MinitestToRspec::VERSION
+        banner BANNER
+        opt :rails, OPT_RAILS, short: :none
+      end
+
+      @rails = opts[:rails]
+      case args.length
+      when 2
+        @source, @target = args
+      when 1
+        @source = args[0]
+        @target = infer_target_from @source
+      else
+        Trollop.educate_without_exiting
+        exit(E_USAGE)
+      end
+    end
+
+    def run
+      assert_file_exists(source)
+      assert_file_does_not_exist(target)
+      write_target(converter.convert(read_source))
+    rescue Error => e
+      $stderr.puts "Failed to convert: #{e}"
+      exit E_CONVERT_FAIL
+    end
+
+    private
+
+    def assert_file_exists(file)
+      unless File.exist?(file)
+        $stderr.puts "File not found: #{file}"
+        exit(E_FILE_NOT_FOUND)
+      end
+    end
+
+    def assert_file_does_not_exist(file)
+      if File.exist?(file)
+        $stderr.puts "File already exists: #{file}"
+        exit(E_FILE_ALREADY_EXISTS)
+      end
+    end
+
+    def converter
+      Converter.new(rails: rails)
+    end
+
+    def infer_target_from(source)
+      source.
+        gsub(/\Atest/, "spec").
+        gsub(/_test.rb\Z/, "_spec.rb")
+    end
+
+    def read_source
+      File.read(source)
+    end
+
+    def write_target(str)
+      File.write(target, str)
+    end
+  end
+end

data/lib/minitest_to_rspec/exp/klass.rb

@@ -11,6 +11,14 @@ module MinitestToRspec
         assert_valid_name
       end
 
+      def action_controller_test_case?
+        lineage?(parent, [:ActionController, :TestCase])
+      end
+
+      def active_support_test_case?
+        lineage?(parent, [:ActiveSupport, :TestCase])
+      end
+
       # Raise an error if we don't know now to process the name
       # of this class.  Specifically, classes with module-shorthand.
       def assert_valid_name
@@ -23,8 +31,12 @@ module MinitestToRspec
         end
       end
 
+      def block?
+        !block.empty?
+      end
+
       def block
-        @exp[3..-1] || []
+        @_block ||= @exp[3..-1] || []
       end
 
       # Returns the name of the class.  Examples:
@@ -46,7 +58,31 @@ module MinitestToRspec
       # - Inherit Bar::Foo #=> s(:colon2, s(:const, :Bar), :Foo)
       #
       def parent
-        @exp[2]
+        @_parent ||= @exp[2]
+      end
+
+      # Returns true if `@exp` inherits from, e.g. ActiveSupport::TestCase.
+      # TODO: Other test case parent classes.
+      def test_case?
+        return false unless sexp_type?(:colon2, parent)
+        active_support_test_case? ||
+          action_controller_test_case?
+      end
+
+      private
+
+      def ancestor_name(exp, index)
+        assert_sexp_type(:colon2, exp)
+        ancestor = exp[index + 1]
+        sexp_type?(:const, ancestor) ? ancestor[1] : ancestor
+      end
+
+      def lineage?(exp, names)
+        assert_sexp_type(:colon2, exp)
+        exp.length == names.length + 1 &&
+          names.each_with_index.all? { |name, ix|
+            name.to_sym == ancestor_name(exp, ix).to_sym
+          }
       end
     end
   end

data/lib/minitest_to_rspec/subprocessors/klass.rb

@@ -16,37 +16,16 @@ module MinitestToRspec
       end
 
       def process
-        result = build_root(@exp.name, @exp.parent)
-        block = build_block(@exp.block)
-        result.push(block) if block.length > 1
-        result
+        sexp = head
+        sexp << block if @exp.block?
+        sexp
       end
 
       private
 
-      def action_controller_test_case?(exp)
-        lineage?(exp, [:ActionController, :TestCase])
-      end
-
-      def active_support_test_case?(exp)
-        lineage?(exp, [:ActiveSupport, :TestCase])
-      end
-
-      def ancestor_name(exp, index)
-        assert_sexp_type(:colon2, exp)
-        ancestor = exp[index + 1]
-        sexp_type?(:const, ancestor) ? ancestor[1] : ancestor
-      end
-
-      # Returns the root of the result: either an :iter representing
-      # an `RSpec.describe` or, if it's not a test case, a :class.
-      def build_root(name, parent)
-        if parent && test_case?(parent)
-          md = rspec_describe_metadata(parent)
-          rspec_describe_block(name, md)
-        else
-          s(:class, name, parent)
-        end
+      # Returns a :block S-expression, the contents of the class.
+      def block
+        s(:block) + @exp.block.map { |line| full_process(line) }
       end
 
       # Given a `test_class_name` like `BananaTest`, returns the
@@ -55,34 +34,20 @@ module MinitestToRspec
         test_class_name.to_s.gsub(/Test\Z/, "").to_sym
       end
 
-      def lineage?(exp, names)
-        assert_sexp_type(:colon2, exp)
-        exp.length == names.length + 1 &&
-          names.each_with_index.all? { |name, ix|
-            name.to_sym == ancestor_name(exp, ix).to_sym
-          }
-      end
-
-      def rspec_describe(arg, metadata)
-        call = s(:call, s(:const, :RSpec), :describe, arg)
-        unless metadata.nil?
-          call << metadata
+      # Returns the head of the output Sexp.  If it's a test case,
+      # an :iter representing an `RSpec.describe`.  Otherwise, a :class.
+      def head
+        if @exp.test_case?
+          rspec_describe_block
+        else
+          s(:class, @exp.name, @exp.parent)
         end
-        call
       end
 
-      # Returns a S-expression representing a call to RSpec.describe
-      def rspec_describe_block(name, metadata)
-        const = s(:const, described_class(name))
-        s(:iter, rspec_describe(const, metadata), s(:args))
-      end
-
-      def rspec_describe_metadata(exp)
-        if @rails
-          s(:hash, s(:lit, :type), s(:lit, rdm_type(exp)))
-        else
-          nil
-        end
+      # Returns an S-expression representing the
+      # RDM (RSpec Describe Metadata) hash
+      def rdm
+        s(:hash, s(:lit, :type), s(:lit, rdm_type))
       end
 
       # Returns the RDM (RSpec Describe Metadata) type.
@@ -98,25 +63,24 @@ module MinitestToRspec
       # > http://bit.ly/1G5w7CJ
       #
       # TODO: Obviously, they're not all supported yet.
-      def rdm_type(exp)
-        if action_controller_test_case?(exp)
+      def rdm_type
+        if @exp.action_controller_test_case?
           :controller
         else
           :model
         end
       end
 
-      # "Fully" process `lines`, a collection of Sexp representing
-      # the contents of the class.
-      def build_block(lines)
-        s(:block) + lines.map { |line| full_process(line) }
+      def rspec_describe
+        const = s(:const, described_class(@exp.name))
+        call = s(:call, s(:const, :RSpec), :describe, const)
+        call << rdm if @rails
+        call
       end
 
-      # TODO: Obviously, there are other test case parent classes
-      # not supported yet.
-      def test_case?(exp)
-        assert_sexp_type(:colon2, exp)
-        active_support_test_case?(exp) || action_controller_test_case?(exp)
+      # Returns a S-expression representing a call to RSpec.describe
+      def rspec_describe_block
+        s(:iter, rspec_describe, s(:args))
       end
     end
   end

data/lib/minitest_to_rspec/version.rb

@@ -1,3 +1,3 @@
 module MinitestToRspec
-  VERSION = "0.4.0"
+  VERSION = "0.5.0".freeze
 end

data/minitest_to_rspec.gemspec

@@ -6,7 +6,7 @@ require 'minitest_to_rspec/version'
 Gem::Specification.new do |spec|
   spec.name = "minitest_to_rspec"
   spec.version = MinitestToRspec::VERSION
-  spec.executables << 'minitest_to_rspec'
+  spec.executables << 'mt2rspec'
   spec.authors = ["Jared Beck"]
   spec.email = ["jared@jaredbeck.com"]
 
@@ -27,6 +27,7 @@ ruby2ruby.
 
   spec.add_runtime_dependency "ruby_parser", "~> 3.6"
   spec.add_runtime_dependency "ruby2ruby", "~> 2.1"
+  spec.add_runtime_dependency "trollop", "~> 2.1"
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "cane", "~> 2.6"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest_to_rspec
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jared Beck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-25 00:00:00.000000000 Z
+date: 2015-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_parser
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -143,7 +157,7 @@ description: |
 email:
 - jared@jaredbeck.com
 executables:
-- minitest_to_rspec
+- mt2rspec
 extensions: []
 extra_rdoc_files: []
 files:
@@ -157,12 +171,13 @@ files:
 - README.md
 - Rakefile
 - bin/console
-- bin/minitest_to_rspec
+- bin/mt2rspec
 - doc/code_style.md
 - doc/minitest.md
 - doc/rspec.md
 - doc/supported_assertions.md
 - lib/minitest_to_rspec.rb
+- lib/minitest_to_rspec/cli.rb
 - lib/minitest_to_rspec/converter.rb
 - lib/minitest_to_rspec/errors.rb
 - lib/minitest_to_rspec/exp/base.rb

data/bin/minitest_to_rspec

@@ -1,82 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'minitest_to_rspec'
-
-module MinitestToRspec
-  class CLI
-    E_USAGE = 1
-    E_FILE_NOT_FOUND = 2
-    E_FILE_ALREADY_EXISTS = 3
-    E_CONVERT_FAIL = 4
-
-    def initialize(args)
-      check_usage(args)
-      @target = args.pop
-      @source = args.pop
-      @rails = false
-      parse_options(args)
-    end
-
-    def run
-      assert_file_exists(@source)
-      assert_file_does_not_exist(@target)
-      write_target(converter.convert(read_source))
-    rescue Error => e
-      $stderr.puts "Failed to convert: #{e}"
-      exit E_CONVERT_FAIL
-    end
-
-    private
-
-    def assert_file_exists(file)
-      unless File.exist?(file)
-        $stderr.puts "File not found: #{file}"
-        exit(E_FILE_NOT_FOUND)
-      end
-    end
-
-    def assert_file_does_not_exist(file)
-      if File.exist?(file)
-        $stderr.puts "File already exists: #{file}"
-        exit(E_FILE_ALREADY_EXISTS)
-      end
-    end
-
-    def check_usage(args)
-      unless (2..3).cover?(args.length)
-        print_usage
-        exit(E_USAGE)
-      end
-    end
-
-    def converter
-      Converter.new(rails: @rails)
-    end
-
-    def parse_options(args)
-      raise ArgumentError unless args.length <= 1
-      args.each do |arg|
-        case arg
-        when "--rails"
-          @rails = true
-        else
-          raise ArgumentError, "Unexpected option: #{arg}"
-        end
-      end
-    end
-
-    def print_usage
-      $stderr.puts "Usage: minitest_to_rspec --rails source_file target_file"
-    end
-
-    def read_source
-      File.read(@source)
-    end
-
-    def write_target(str)
-      File.write(@target, str)
-    end
-  end
-end
-
-MinitestToRspec::CLI.new(ARGV).run