minitest_to_rspec 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a26f82f0b35b670823cd1027ac1ac80246a6f8c0
-  data.tar.gz: 87a546ab111b4ce7828d965e191adf172694c25f
+  metadata.gz: dfbca8efedaf7c52597ad002776c9a91913ef953
+  data.tar.gz: f0338aab60ec0ed5c47a73b4da8efe10d219a7b7
 SHA512:
-  metadata.gz: 0d3cc07d13814998342715165ae6d440b3afc1ebbfcb7ae47c4a080b3ffe04064ba40e22f33549e3670f846a0782d6f3ea5e7e47e176af2e0fc87ec2ec0cd309
-  data.tar.gz: b92b4a90f78b704aa546c8ac8a9ce99fff05206fe9e41cd46896e0347390aee43771c4efc53208464001e8d51f9bc9b6b8734b59de2d609b76d5efc624516a7e
+  metadata.gz: 5c19ee604832c47a8a2b29bf04f80a339e0542fd34d282d2fca7faa571cfdce424d556bc66c607413e9a8b48024b7714561d30b89a4b5f4cc0a4d149615f3a6e
+  data.tar.gz: c84d8763c6788a1e7f781256d7fdd84f673fe995fbd08aad97d26c51f770cce2bd607430c09ade0e9243b01cbe7ff2b3c85b708b3e1d28aa13b4c7a4f35aa93e

data/CHANGELOG.md

@@ -4,10 +4,27 @@ Change Log
 This project follows [semver 2.0.0][1] and the recommendations
 of [keepachangelog.com][2].
 
-Road Map
---------
+0.3.0
+-----
+
+### Added
+- Converts
+  - `setup` and `teardown` to `before` and `after`
+  - `assert_raise`, `assert_raises`
+- CLI option: `--rails`
+  - Prints `rails_helper` instead of `spec_helper`
+  - Adds `:type` metadata, eg. `:type => :controller`
+    - So far, only supports `:model` and `:controller`
+- Experimental
+  - Limited conversion of mocha to rspec-mocks
+    - returns
+    - stub
+    - stub_everything
+    - stubs
+  - Ruby 1.9 hash syntax (See [ruby2ruby PR 37][3])
 
-More assertions. Contributions welcome.
+### Fixed
+- Improved error message for class definition using module shorthand
 
 0.2.1
 -----
@@ -28,3 +45,4 @@ Initial release.  11 assertions are supported.
 
 [1]: http://semver.org/spec/v2.0.0.html
 [2]: http://keepachangelog.com/
+[3]: https://github.com/seattlerb/ruby2ruby/pull/37

data/README.md

@@ -4,6 +4,9 @@ Converts [minitest][8] files to [rspec][9].
 
 [![Build Status][1]][2] [![Code Climate][3]][4] [![Test Coverage][7]][4]
 
+Uses [ruby_parser][14], [sexp_processor][15], and [ruby2ruby][16],
+in that order.  Thank you, [Ryan Davis][17]!
+
 Example
 -------
 
@@ -11,6 +14,8 @@ Input:
 
 ```ruby
 require 'test_helper'
+
+# This comment will be discarded!
 class BananaTest < ActiveSupport::TestCase
   test "is delicious" do
     assert Banana.new.delicious?
@@ -27,6 +32,8 @@ RSpec.describe(Banana) do
 end
 ```
 
+[RubyParser][14] discards all comments.
+
 The code style is whatever [ruby2ruby][6] feels like printing,
 and is not configurable.  The goal is not style, but to get to
 rspec quickly.
@@ -38,7 +45,7 @@ Usage
 
 ```bash
 gem install minitest_to_rspec
-minitest_to_rspec source_file target_file
+minitest_to_rspec --rails source_file target_file
 ```
 
 ### Ruby
@@ -56,19 +63,30 @@ Selected assertions from minitest, Test::Unit, and ActiveSupport.
 See [doc/supported_assertions.md][5] for rationale.  Contributions
 are welcome.
 
-Assertion                   | Arity
---------------------------- | -----
-assert                      |
-assert_difference           | 1
-assert_difference           | 2
-assert_equal                |
-assert_match                |
-assert_nil                  |
-assert_no_difference        |
-[assert_nothing_raised][10] |
-assert_raises               |
-refute                      |
-refute_equal                |
+Assertion                   | Arity | Source
+--------------------------- | ----- | ------
+assert                      |       |
+assert_difference           | 1,2   |
+assert_equal                |       |
+assert_match                |       |
+assert_nil                  |       |
+[assert_no_difference][12]  |       | ActiveSupport
+[assert_nothing_raised][10] |       | Test::Unit
+[assert_raise][11]          | 0..2  | Test::Unit
+[assert_raises][13]         | 0..2  | Minitest
+refute                      |       |
+refute_equal                |       |
+
+Supported Mocha
+---------------
+
+Mocha                 | Arity | Block | Notes
+--------------------- | ----- | ----- | -------
+[stub][19]            | 0,1,2 | no    |
+[stub_everything][18] | 0,1,2 | no    | Uses `as_null_object`, not the same.
+[stubs][20]           | 1     | n/a   |
+
+Notably not yet supported: `expects`, `any_instance`
 
 [1]: https://travis-ci.org/jaredbeck/minitest_to_rspec.svg
 [2]: https://travis-ci.org/jaredbeck/minitest_to_rspec
@@ -80,3 +98,13 @@ refute_equal                |
 [8]: https://github.com/jaredbeck/minitest_to_rspec/blob/master/doc/minitest.md
 [9]: https://github.com/jaredbeck/minitest_to_rspec/blob/master/doc/rspec.md
 [10]: http://www.rubydoc.info/gems/test-unit/3.0.9/Test/Unit/Assertions#assert_nothing_raised-instance_method
+[11]: http://ruby-doc.org/stdlib-2.1.0/libdoc/test/unit/rdoc/Test/Unit/Assertions.html#method-i-assert_raise
+[12]: http://api.rubyonrails.org/classes/ActiveSupport/Testing/Assertions.html#method-i-assert_no_difference
+[13]: http://www.rubydoc.info/gems/minitest/5.5.1/Minitest/Assertions#assert_raises-instance_method
+[14]: https://github.com/seattlerb/ruby_parser
+[15]: https://github.com/seattlerb/sexp_processor
+[16]: https://github.com/seattlerb/ruby2ruby
+[17]: https://github.com/zenspider
+[18]: http://www.rubydoc.info/github/floehopper/mocha/Mocha/API:stub_everything
+[19]: http://www.rubydoc.info/github/floehopper/mocha/Mocha/API#stub-instance_method
+[20]: http://www.rubydoc.info/github/floehopper/mocha/Mocha/ObjectMethods#stubs-instance_method

data/bin/minitest_to_rspec

@@ -7,17 +7,23 @@ module MinitestToRspec
     E_USAGE = 1
     E_FILE_NOT_FOUND = 2
     E_FILE_ALREADY_EXISTS = 3
+    E_CONVERT_FAIL = 4
 
     def initialize(args)
       check_usage(args)
-      @source = args[0]
-      @target = args[1]
+      @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
@@ -37,18 +43,30 @@ module MinitestToRspec
     end
 
     def check_usage(args)
-      unless args.length == 2
+      unless (2..3).cover?(args.length)
         print_usage
         exit(E_USAGE)
       end
     end
 
     def converter
-      Converter.new
+      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 source_file target_file"
+      $stderr.puts "Usage: minitest_to_rspec --rails source_file target_file"
     end
 
     def read_source

data/doc/code_style.md

@@ -0,0 +1,32 @@
+Code Style
+==========
+
+The code style is whatever [ruby2ruby][1] feels like printing,
+and is not configurable.  The goal is not style, but to get to
+rspec quickly.
+
+To clean up the style a bit afterwards, here are some tips.
+
+1. Remove parenthesis around `describe` and `it` arguments.
+
+```
+Find: (context|describe|it)\((['"])(.*)['"]\) do
+Replace: $1 $2$3$2 do
+```
+
+1. Convert `be_truthy` to [predicate matchers][2].
+
+```
+Find: expect\((.*).valid\?\)\.to\(be_truthy\)
+Replace: expect($1).to be_valid
+```
+
+And the negated variant:
+
+```
+Find: expect\(\(not (.*).valid\?\)\)\.to\(be_truthy\)
+Replace: expect($1).to be_invalid
+```
+
+[1]: https://github.com/seattlerb/ruby2ruby
+[2]: https://relishapp.com/rspec/rspec-expectations/v/3-2/docs/built-in-matchers/predicate-matchers

data/lib/minitest_to_rspec/converter.rb

@@ -1,12 +1,13 @@
 require "ruby_parser"
 require "ruby2ruby"
 require_relative "processor"
+require_relative "errors"
 
 module MinitestToRspec
   class Converter
-    def initialize
-      @processor = Processor.new
-      @ruby2ruby = Ruby2Ruby.new
+    def initialize(options)
+      @options = options
+      @processor = Processor.new(@options[:rails])
     end
 
     def convert(input)
@@ -51,7 +52,15 @@ module MinitestToRspec
     # Given an AST representing an rspec file, returns a string
     # of ruby code.
     def render(exp)
-      @ruby2ruby.process(exp)
+      ruby2ruby.process(exp)
+    end
+
+    # Try to specify ruby 1.9 hash_syntax if ruby2ruby supports it.
+    # https://github.com/seattlerb/ruby2ruby/pull/37
+    def ruby2ruby
+      Ruby2Ruby.new(hash_syntax: :ruby19)
+    rescue ArgumentError
+      Ruby2Ruby.new
     end
   end
 end

data/lib/minitest_to_rspec/errors.rb

@@ -1,3 +1,16 @@
 module MinitestToRspec
-  class NotImplemented < StandardError; end
+  class Error < StandardError; end
+  class ProcessingError < Error; end
+  class NotImplemented < Error; end
+
+  class ModuleShorthandError < NotImplemented
+    DEFAULT_MESSAGE = <<-EOS
+Unsupported class definition: Module shorthand (A::B::C) is not supported.
+Please convert your class definition to use nested modules and try again.
+    EOS
+
+    def initialize(msg = nil)
+      super(msg || DEFAULT_MESSAGE)
+    end
+  end
 end

data/lib/minitest_to_rspec/exp/base.rb

@@ -0,0 +1,12 @@
+require_relative "../sexp_assertions"
+
+module MinitestToRspec
+  module Exp
+
+    # Classes inheriting `Base` are simple data objects
+    # representing the S-expressions they are named after.
+    class Base
+      include SexpAssertions
+    end
+  end
+end

data/lib/minitest_to_rspec/exp/call.rb

@@ -1,14 +1,14 @@
+require_relative "base"
+
 module MinitestToRspec
   module Exp
 
     # Data object.  Represents a `:call` s-expression.
-    class Call
+    class Call < Base
       attr_reader :original
 
       def initialize(exp)
-        unless exp.sexp_type == :call
-          raise ArgumentError, "Expected call, got #{exp.sexp_type}"
-        end
+        assert_sexp_type(:call, exp)
         @exp = exp.dup
         @original = exp.dup
       end
@@ -26,13 +26,21 @@ module MinitestToRspec
           exp.sexp_type == :call && new(exp).assert_nothing_raised?
         end
 
+        def assert_raise?(exp)
+          exp.sexp_type == :call && new(exp).assert_raise?
+        end
+
         def assert_raises?(exp)
           exp.sexp_type == :call && new(exp).assert_raises?
         end
+
+        def method_name?(exp, name)
+          exp.sexp_type == :call && new(exp).method_name == name
+        end
       end
 
       def arguments
-        @exp[3..-1]
+        @exp[3..-1] || []
       end
 
       def argument_types
@@ -54,10 +62,12 @@ module MinitestToRspec
         method_name == :assert_nothing_raised && arguments.empty?
       end
 
+      def assert_raise?
+        method_name == :assert_raise && raise_error_args?
+      end
+
       def assert_raises?
-        method_name == :assert_raises &&
-          arguments.length == 1 &&
-          arguments[0].sexp_type == :const
+        method_name == :assert_raises && raise_error_args?
       end
 
       def method_name
@@ -68,6 +78,18 @@ module MinitestToRspec
         arguments.length == 1 && string?(arguments[0])
       end
 
+      # Returns true if arguments can be processed into RSpec's `raise_error`
+      # matcher.  When the last argument is a string, it represents the
+      # assertion failure message, which will be discarded later.
+      def raise_error_args?
+        arg_types = arguments.map(&:sexp_type)
+        [[], [:str], [:const], [:const, :str]].include?(arg_types)
+      end
+
+      def receiver
+        @exp[1]
+      end
+
       def require_test_helper?
         method_name == :require &&
           one_string_argument? &&

data/lib/minitest_to_rspec/exp/calls/returns.rb

@@ -0,0 +1,47 @@
+module MinitestToRspec
+  module Exp
+    module Calls
+
+      # Represents a call to `returns`, the stubbing method
+      # from `mocha`.
+      class Returns < Call
+        def initialize(exp)
+          @exp = exp
+        end
+
+        # The message recipient
+        def msg_recipient
+          stubs_call.receiver
+        end
+
+        def known_variant?
+          receiver_is_call_to_stubs? &&
+            !values.empty? &&
+            message.sexp_type == :lit
+        end
+
+        def message
+          stubs_call.arguments[0]
+        end
+
+        # The return values
+        def values
+          arguments
+        end
+
+        private
+
+        def receiver_is_call_to_stubs?
+          r = receiver
+          !r.nil? &&
+            r.sexp_type == :call &&
+            Call.new(r).method_name == :stubs
+        end
+
+        def stubs_call
+          Call.new(receiver)
+        end
+      end
+    end
+  end
+end

data/lib/minitest_to_rspec/exp/iter.rb

@@ -1,13 +1,12 @@
+require_relative "base"
+
 module MinitestToRspec
   module Exp
 
     # Data object.  Represents an `:iter` s-expression.
-    class Iter
-
+    class Iter < Base
       def initialize(exp)
-        unless exp.sexp_type == :iter
-          raise ArgumentError, "Expected iter, got #{exp.sexp_type}"
-        end
+        assert_sexp_type(:iter, exp)
         @exp = exp.dup
       end
 
@@ -27,14 +26,50 @@ module MinitestToRspec
         !empty? && Exp::Call.assert_nothing_raised?(@exp[1])
       end
 
+      def assert_raise?
+        !empty? && Exp::Call.assert_raise?(@exp[1])
+      end
+
       def assert_raises?
         !empty? && Exp::Call.assert_raises?(@exp[1])
       end
 
+      def block
+        @exp[3]
+      end
+
+      def call
+        @exp[1]
+      end
+
+      # Not to be confused with block arguments.
+      def call_arguments
+        call_obj.arguments
+      end
+
+      def call_obj
+        Exp::Call.new(call)
+      end
+
+      # Enumerates children, skipping the base `call` and
+      # starting with the block arguments, then each `:call` in
+      # the block.
+      def each
+        @exp[2..-1].each do |e| yield(e) end
+      end
+
       def empty?
         @exp.length == 1 # just the sexp_type
       end
 
+      def setup?
+        !empty? && Exp::Call.method_name?(@exp[1], :setup)
+      end
+
+      def teardown?
+        !empty? && Exp::Call.method_name?(@exp[1], :teardown)
+      end
+
       def sexp
         @exp
       end