minitest-spec-rails 3.0.7 → 3.1.0

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+*.log

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.8.7
+  - 1.9.3
+before_install:
+  - gem update --system 1.8.25
+  - gem install bundler
+  - bundle --version

data/CHANGELOG.md

@@ -1,4 +1,50 @@
 
+## 4.3.8
+
+* Less coupling to ActiveRecord ORM, works for MongoDB now. Thanks @kimsuelim
+
+
+## v4.3.7
+
+* Fix helper test bug where calling methods in first context block blew up. Fixes #13.
+
+
+## v4.3.6
+
+* Only require the freedom patches and autorun when Rails.env.test?
+
+
+## v4.3.5
+
+* Make sure #described_class works in ActiveSupport::TestCase class level.
+
+
+## v4.3.4
+
+* Add mini_should support and talk about matchers.
+
+
+## v4.3.3
+
+* Fix MiniTest::Unit::TestCase hack for Rails 4, ignore in Rails 3.
+
+
+## v4.3.2
+
+* Way better support for controller_class, mailer_class, and helper_class reflection.
+
+
+## v4.3.1
+
+* Eager load controller_class, mailer_class, and helper_class.
+
+
+## v4.3.0
+
+* All new MiniTest::Spec for Rails!!! Tested to the hilt!!!
+* Track MiniTest's major/minior version number.
+
+
 ## v3.0.7
 
 * Must use MiniTest version ~> 2.1. As 3.x will not work.

data/Gemfile

@@ -1,2 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
+
 gemspec
+

data/Guardfile

@@ -0,0 +1,7 @@
+guard 'minitest' do
+  watch(%r|^lib/minitest-spec-rails/init/(.*)\.rb|)  { |m| "test/cases/#{m[1]}_test.rb" }
+  watch(%r|^test/test_helper\.rb|)                   { "test" }
+  watch(%r|^test/test_helper_dummy\.rb|)             { "test" }
+  watch(%r|^test/cases/(.*)_test\.rb|)
+  watch(%r|^test/dummy_tests/(.*)_test\.rb|)
+end

data/README.md

@@ -1,66 +1,220 @@
-# MiniTest::Spec For Rails
 
-This gem makes it easy to use the MiniTest Spec DSL in Rails 3 application tests.
+<img src="http://cdn.metaskills.net/minitest-spec-rails.png" width="233" height="154" />
 
-# Advantages
+# Make Rails Use MiniTest::Spec!
 
-With minitest-spec-rails, we have a working solution by replacing MiniTest::Spec as the superclass for ActiveSupport::TestCase. This solution is simple and does not require you to recreate a new test case in your test_helper.rb or to use generators supplied by gems like minitest-rails.
 
-MinitTest::Spec is built on top of MiniTest::Unit which a replacement for Test::Unit, so is stable and consistent. It's easy to change an existing Rails application from Test Unit to MiniTest::Spec simply installing this gem. As Rails evolves to leverage MiniTest::Spec, your test case code will not have to change at both the class definition and internals. 
+Rails 4 was on its way to using MiniTest::Spec as the superclass for ActiveSupport::TestCase. But in one of many reversals, the work was [pulled by this commit](http://github.com/rails/rails/commit/b22c527e65a41da59dbfcb078968069c6fae5086). DHH says that [Rails is omakase](http://david.heinemeierhansson.com/2012/rails-is-omakase.html) and I am cool with that. But since Ruby is wide open for us to change it and we are free in DHH's words to "freedom patch" what we see fit, we can fix Rails.
 
-# How it works
+The minitest-spec-rails gem makes it easy to use the MiniTest::Spec DSL within your existing Rails 3 or 4 test suite. It does this by forcing ActiveSupport::TestCase to subclass MiniTest::Spec.
 
-This gem makes Test::Unit::TestCase a subclass of of MiniTest::Spec with a simple shim. The gem tricks ActiveSupport::TestCase to use MiniTest::Spec instead. The gem includes any monkey patches to make using MiniTest::Spec a drop in behavior change for any Rails 3.x project.
+[![Gem Version](https://badge.fury.io/rb/minitest-spec-rails.png)](http://badge.fury.io/rb/minitest-spec-rails)
+[![Build Status](https://secure.travis-ci.org/metaskills/minitest-spec-rails.png)](http://travis-ci.org/metaskills/minitest-spec-rails)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/metaskills/minitest-spec-rails)
 
-Full Details here:
 
-http://metaskills.net/2011/03/26/using-minitest-spec-with-rails/
+## Usage
 
-# Styles
+Existing or new Rails 3 or 4 applications that use the default Rails testing structure can simply drop in the minitest-spec-gem and start writing their tests in the new spec DSL. Since MinitTest::Spec is built on top of MiniTest::Unit, a replacement for Test::Unit, all of your existing tests will continue to work.
 
-This <a href="http://cheat.errtheblog.com/s/minitest/1">cheat sheet</a> shows the Test::Unit assert methods and the MiniTest::Spec methods. Remember, MiniTest::Spec is build on top of MiniTest::Unit which is a Test::Unit replacement. That means you can mix and match styles as you upgrade from Test::Unit to a more modern style.
+### How is this different than MiniTest::Rails?
 
-Test::Unit Style:
+To start off both Mike Moore (@blowmage) and I have worked together and we both LOVE MiniTest::Spec. Both projects aim to advocate MiniTest and make Rails integration as easy as possible. However, there are a few key differences in our projects. Some of these differences may go away in time too. As always, choose the tool you think fits your needs. So how, is minitest-spec-rails different than [minitest-rails](https://github.com/blowmage/minitest-rails)?
 
-    assert_equal 100, foo
+  * We aim to leverage existing Rails test directories and files!
+  * No special test helper and/or generators.
+  * Easy migration path for existing Rails applications.
+  * How we go about freedom patching Rails.
 
-MiniTest::Spec Style:
+So the goal of this project is to make Rails 3 or 4 applications just work as if rails-core had decided to support MiniTest::Spec all along. We believe that eventually that day will come and when it does, all your tests will still work! So bundle up and get started!
 
-    foo.must_equal 100
+```ruby
+gem 'minitest-spec-rails'
+```
 
-There are a few missing assertions available in Test::Unit that are changed or no longer available in MiniTest.
 
-  * The method <code>assert_raise</code> is renamed <code>assert_raises</code>.
-  * There is no method <code>assert_nothing_raised</code>. There are good reasons for this on Ryan's blog.
+## Test Styles
 
-# Alternate MiniTest::Spec Describe
+This <a href="http://cheat.errtheblog.com/s/minitest">cheat sheet</a> shows both the MiniTest::Unit assertions along with the MiniTest::Spec assertion syntax. Remember, MiniTest::Spec is build on top of MiniTest::Unit which is a Test::Unit replacement. That means you can mix and match styles as you upgrade from Test::Unit to a more modern style. For example, both of these would work in MiniTest::Spec and are interchangeable.
 
-It is also possible to change the style of your test files and their super classes. In these examples below, the gem will take care of setting your super class and proper setups.
+```ruby
+# MiniTest::Unit Assertion Style:
+assert_equal 100, foo
 
-    # ./test/unit/post_test.rb
-    require 'test_helper'
-    describe Post do
-      it "must be valid" do
-        @post.must_be :valid?
-      end
-    end
+# MiniTest::Spec Assertion Style:
+foo.must_equal 100
+```
+
+All existing Rails test cases that subclass ActiveSupport::TestCase will continue to work and I personally suggest that you still **use the subclass convention** vs the outer describe test case convention. However either will work.
+
+```ruby
+require 'test_helper'
+class UserTest < ActiveSupport::TestCase
+  let(:user_ken)   { User.create! :email => 'ken@metaskills.net' }
+  it 'works' do
+    user_ken.must_be_instance_of User
+  end
+end
+```
+
+```ruby
+require 'test_helper'
+describe User do
+  # This will work too.
+end
+```
+
+Just for reference, here is a full list of each of Rails test case classes and the matching describe alternative if one exists. Remember, names are important when using the describe syntax. So you can not have a mailer named `FooBar` and expect it to work with the outer describe spec style since there is no way to map the spec type based on an existing naming convention.
+
+```ruby
+# Model Test
+class UserTest < ActiveSupport::TestCase
+end
+describe User do
+end
+
+# Controller Test
+class UsersControllerTest < ActionController::TestCase
+end
+describe UsersController do
+end
+
+# Integration Tests - Must use subclass style!
+class IntegrationTest < ActionDispatch::IntegrationTest
+end
+
+# Mailer Test
+class UserMailerTest < ActionMailer::TestCase
+end
+describe UserMailer do
+end
 
-    # ./test/functional/posts_controller_test.rb
-    require 'test_helper'
-    describe PostController do
-      describe "on GET to :show" do
-        before do
-          get :show, id: "1"
-        end
-        it "returns a post object " do
-          post = assigns(:post)
-          post.wont_be_nil
-        end
-      end
+# View Helper Test
+class UsersHelperTest < ActionView::TestCase
+end
+describe UsersHelper do
+end
+```
+
+
+## Extras
+
+We have baked in a few extra methods behind the scenes to minitest-spec-rails. Most directly support our needs to reflect on described classes, however, they may be useful to you too when meta-programming on top of minitest-spec-rails.
+
+### #described_class
+The `described_class` method is available both via a class method and an instance method in any Rails test case. It is guaranteed to work despite the described level too. This allows class level macros to be build, much like Shoulda. Remember, it can only do this if you follow Rails naming conventions for your tests.
+
+```ruby
+class UserTest < ActiveSupport::TestCase
+  described_class # => User(id: integer, email: string)
+  it 'works here' do
+    described_class # => User(id: integer, email: string)
+  end
+  describe 'and' do
+    it 'works here too' do
+      described_class # => User(id: integer, email: string)
     end
+  end
+end
+```
+
+### mini_shoulda
+
+If you are migrating away from Shoulda, then minitest-spec-rails' mini_shoulda feature will help. To enable it, set the following configuration in your test environment file.
+
+```ruby
+# In config/environments/test.rb
+config.minitest_spec_rails.mini_shoulda = true
+```
+
+Doing so only enables a few aliases that allow the Shoulda `context`, `should`, and `should_eventually` methods. The following code demonstrates the full features of the mini_shoulda implementation. It basically replaces the shell of [should-context](https://github.com/thoughtbot/shoulda-context) in a few lines of code.
+
+```ruby
+class PostTests < ActiveSupport::TestCase
+  setup    { @post = Post.create! :title => 'Test Title', :body => 'Test body' }
+  teardown { Post.delete_all }
+  should 'work' do
+    @post.must_be_instance_of Post
+  end
+  context 'with a user' do
+    should_eventually 'have a user' do
+      # ...
+    end
+  end
+end
+```
+
+If you are in the assertions provided by shoulda-context like `assert_same_elements`, then you may want to consider copying them [from here](https://github.com/thoughtbot/shoulda-context/blob/master/lib/shoulda/context/assertions.rb) and including them in `MiniTest::Spec` yourself. I personally recommend just replacing these assertions with something more modern. A few examples are below.
+
+```ruby
+assert_same_elements a, b  # From
+a.sort.must_equal b.sort   # To
+
+assert_does_not_contain a, b  # From
+a.wont_include b              # To
+```
+
+### Matchers
+
+**I highly suggest that you stay away from matchers** since MiniTest::Spec gives you all the tools you need to write good tests. Staying away from matchers will make your code's tests live longer. So my advice is to stay away from things like `.should ==` and just write `.must_equal` instead. However, if matchers are really your thing, I recommend the [minitest-matchers](https://github.com/zenspider/minitest-matchers) gem. You can also check out the [valid_attribute](https://github.com/bcardarella/valid_attribute) gem built on top of minitest-matchers.
+
+```ruby
+describe Post do
+  subject { Post.new }
+  it { must have_valid(:title).when("Hello") }
+  it { wont have_valid(:title).when("", nil, "Bad") }
+end
+```
+
+
+## Gotchas
+
+### Assertion Methods
+
+If you are upgrading from Test::Unit, there are a few missing assertions that have been renamed or are no longer available within MiniTest.
+
+* The method `assert_raise` is renamed `assert_raises`.
+* There is no method `assert_nothing_raised`. There are good reasons for this on [Ryan's blog entry](http://blog.zenspider.com/blog/2012/01/assert_nothing_tested.html).
+
+### Mocha
+
+If you are using [Mocha](https://github.com/freerange/mocha) for mocking and stubbing, please update to the latest, 0.13.1 or higher so it is compatible with the latest MiniTest. If you do not like the deprecation warnings in older versions of Rails, just add this below the `require 'rails/all'` within your `application.rb` file :)
+
+```ruby
+require 'mocha/deprecation'
+Mocha::Deprecation.mode = :disabled
+```
+
+### Rails 3.0.x
+
+If you are using minitest-spec-rails with Rails 3.0, then your controller and mailer tests will need to use the `tests` interface for the assertions to be setup correctly within sub `describe` blocks. I think this is a bug with `class_attribute` within Rails 3.0 only. So use the following patterns.
+
+```ruby
+class UsersControllerTest < ActionController::TestCase
+  tests UsersController
+end
+class UserMailerTest < ActionMailer::TestCase
+  tests UserMailer
+end
+```
+
+
+## Contributing
+
+The minitest-spec-rails gem is fully tested from Rails 3.0 to 4 and upward. We run our tests on [Travis CI](http://travis-ci.org/metaskills/minitest-spec-rails) in both Ruby 1.8 and 1.9. If you detect a problem, open up a github issue or fork the repo and help out. After you fork or clone the repository, the following commands will get you up and running on the test suite. 
+
+```shell
+$ bundle install
+$ bundle exec rake appraisal:setup
+$ bundle exec rake appraisal test
+```
 
-# Issues
+We use the [appraisal](https://github.com/thoughtbot/appraisal) gem from Thoughtbot to help us generate the individual gemfiles for each Rails version and to run the tests locally against each generated Gemfile. The `rake appraisal test` command actually runs our test suite against all Rails versions in our `Appraisal` file. If you want to run the tests for a specific Rails version, use `rake -T` for a list. For example, the following command will run the tests for Rails 3.2 only.
 
-If there are any issues using this in Rails 3 outside the normal few assertions that change from Test::Unit to MiniTest::Unit, please open an issue here on github.
+```shell
+$ bundle exec rake appraisal:rails32 test
+```
 
+Our current build status is:
+[![Build Status](https://secure.travis-ci.org/metaskills/minitest-spec-rails.png)](http://travis-ci.org/metaskills/minitest-spec-rails)
 

data/Rakefile

@@ -1,13 +1,11 @@
-require 'bundler'
+require 'rubygems'
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 
-Bundler::GemHelper.install_tasks
-
-Rake::TestTask.new do |t|
+Rake::TestTask.new   do |t|
   t.libs = ['lib','test']
   t.test_files = Dir.glob("test/**/*_test.rb").sort
   t.verbose = true
 end
 
-task :default => [:test]
-
+task :default => :test

data/lib/minitest-spec-rails.rb

@@ -1,4 +1,10 @@
+module MiniTestSpecRails
+end
+
+require 'rubygems'
+require 'active_support/all'
+require 'active_support/test_case'
 require 'minitest/spec'
-require 'test/unit/testcase'
 require 'minitest-spec-rails/version'
-require 'minitest-spec-rails/test_case'
+require 'minitest-spec-rails/dsl'
+require 'minitest-spec-rails/rails' if Rails.env.test?

data/lib/minitest-spec-rails/dsl.rb

@@ -0,0 +1,52 @@
+module MiniTestSpecRails
+  module DSL
+
+    RAILS_TEST_CASES = []
+
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    module ClassMethods  
+
+      def before(type = nil, &block)
+        setup { self.instance_eval(&block) }
+      end
+
+      def after(type = nil, &block)
+        teardown { self.instance_eval(&block) }
+      end
+
+      def rails_test_cases
+        RAILS_TEST_CASES
+      end
+
+      def register_rails_test_case(test_case)
+        return if RAILS_TEST_CASES.include?(test_case)
+        RAILS_TEST_CASES.unshift(test_case)
+      end
+
+      def describing_class
+        ancestors.detect { |a| Class === a && rails_test_cases.include?(a.superclass) }
+      end
+
+      def described_class
+        begin
+          describing_class.name.gsub(/Test$/, '').constantize
+        rescue NameError
+          nil
+        end
+      end
+      
+    end
+
+    def describing_class
+      self.class.describing_class
+    end
+
+    def described_class
+      self.class.described_class
+    end
+    
+  end
+end

data/lib/minitest-spec-rails/init/action_controller.rb

@@ -0,0 +1,24 @@
+module MiniTestSpecRails
+  module Init
+    module ActionControllerBehavior
+
+      def self.included(klass)
+        klass.class_eval do
+          register_spec_type(/Controller( ?Test)?\z/i, self)
+          register_spec_type(self) { |desc| Class === desc && desc < self }
+          register_rails_test_case self
+        end
+      end
+
+      private
+
+      def setup_controller_request_and_response
+        describing_class.tests described_class
+        super
+      end
+
+    end
+  end
+end
+
+ActionController::TestCase.send :include, MiniTestSpecRails::Init::ActionControllerBehavior