minispec-rails 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f28f329c71a0112785204c37f8e24ba0f52047c5
-  data.tar.gz: c911b14e1d51c3f8fe9855f1ee29bf4b9c209e00
+  metadata.gz: 1bddc2b8c861fc92f800d54f42f9eeeb99af55e5
+  data.tar.gz: ba50defe08cfa578e94e2c6d7cd54c8bfda11da0
 SHA512:
-  metadata.gz: ce7a560b47a5b94064bf630d0f137449dce7c7e83e4433985002f962e84f2469bcb4fca15e22e3b9e4cdd5d7377a9f67f6f6b2d7aaee58094220cdf4b74ec56c
-  data.tar.gz: 8dd819bbf7ce173dde14bfdec6cbf837adee06ad7e79d7a8ac97110ea7aaf4611db5614a32b85b66d44addd283be1564392357ee150d3170ce644ed6386e7ce3
+  metadata.gz: 500dd921bdffec8a3e4d9efb0e69f93db7c1cc51bcf7473c6bb93ee736bba6ff894987632478b286b4c420d6bce0bc0599a4331fd2093c122257edc130ce1c06
+  data.tar.gz: 8d5f6ccdb8a145db948e552fa265feee962ece3c9f7ad0be4ee4db40ee77cde3fd880688cdd0412a6cc3dc11ca94b021390bda740403543a8a9a4ebecbc9d5d2

data/README.md

@@ -6,19 +6,25 @@ Use Minitest::Spec in Rails.
 
 There are plenty out there, and I'm sure they all work just fine.
 I have personally never used any of them because it was never a big deal to insert Minitest::Spec into any Rails project manually with just a few lines of code.
-The fewer gems/lines of code there are, the better.
-But obviously that's not very helpful to anyone who just wants it to work with a simple `gem blah`, done (including me).
+Fewer gems/lines of code your project = better.
+But I still want the convenience of a gem to get projects started quickly.
+
+This gem gets you PURE minitest spec in a whopping 50 lines of code, and that's counting blank lines, comments, requires, and a (hopefully temporary) workaround for system tests.
+There's no fancy tricks going on here.
+This is plain jane minitest.
+What you get is PURE spec awesomeness.
+And by "PURE" I mean just `describe`s. No more defining classes on your own.
 
 ## Goals
 
-* Get running in Rails with Minitest::Spec with minimal lines of code.
+* Get running in Rails with Minitest::Spec with minimal lines of code both in installation and the gem itself.
 
-## Not Goals
+## NOT Goals
 
-* Help with migrating from "Rails style" to Spec style. I don't recommend anyone convert any test suite to spec style for the sake of converting. You really don't gain all that much.
-* Support multiple styles. You're probably here to use Spec style, so use Spec style. Why would you want to mix and match?
-* Support old Rails versions. Since I don't recommend converting, I don't see a big use case for supporting older Rails versions.
-* (for now at least) Rails generators. I personally don't find them all that useful. If there is enough demand for it, I might do it, but in the interest of keeping this gem small, I'm going to skip them.
+* **Help with migrating from "Rails style" to Spec style.** I don't recommend anyone convert any test suite to spec style for the sake of converting. You really don't gain all that much by converting.
+* **Support multiple styles (i.e. unit and spec).** You're probably here to use Spec style, so use Spec style. Why would you want to mix and match? Don't define test classes. Use `describe`.
+* **Support old Rails versions.** Since I don't recommend converting, it doesn't seem worth it to support older Rails versions. I'm not going to explicitly define a minimum Rails version requirement, but for development I'm going to start with 5.1.1 (see the example app).
+* **(for now at least) Rails generators.** I personally don't find them all that useful. If there is enough demand for it and/or someone contributes it, I might do it, but in the interest of keeping this gem small, I'm going to skip them.
 
 ## Installation
 
@@ -39,33 +45,43 @@ Or install it yourself as:
 ## Usage
 
 Once this gem is required, you can immediately start using it to `describe` your tests.
-There is 1 exception: SystemTests.
-In order to lazy-load, just require the workaround before defining `ApplicationSystemTestCase`:
+There is 1 exception: system tests (see below).
+
+### Spec Types
+
+The key to getting the right type of test is to describe the right thing.
+
+| Test subclass                   | describe example                  |
+| ------------------------------- | --------------------------------- |
+| ActionDispatch::IntegrationTest | `describe MyController`           |
+| ActiveJob::TestCase             | `describe MyJob`                  |
+| ActionMailer::TestCase          | `describe MyMailer`               |
+| ActionDispatch::SystemTestCase  | `describe 'Admin system'`         |
+| ActionDispatch::IntegrationTest | `describe 'Customer integration'` |
+| ActiveSupport::TestCase         | `describe 'AnythingElse'`         |
+
+### Example app
+
+See the [example rails app](https://github.com/ordinaryzelig/minispec-rails-example).
+
+### System tests
+
+Require this before defining `ApplicationSystemTestCase` (see lib/minispec/rails/system_test.rb):
 
 ```ruby
 # test/application_system_test_case.rb.
 require "test_helper"
-require 'minispec/rails/system_test' # Add this line here.
+require 'minispec/rails/system_test' # <- Add this line here.
 
 class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
   driven_by :selenium, using: :chrome, screen_size: [1400, 1400]
 end
 ```
 
-### Spec Types
-
-* `describe` any AbstractController::Base subclass, the test will be a subclass of ActionDispatch::IntegrationTest.
-* `describe` any ActiveJob::Base subclass, the test will be a subclass of ActiveJob::TestCase.
-* `describe` any ActionMailer::Base subclass, the test will be a subclass of ActiveJob::TestCase.
-* `describe` any String, the test will be a subclass of ActionDispatch::SystemTestCase.
-* `describe` anything else, the test will be a subclass of ActiveSupport::TestCase.
-
-See the [example rails app](https://github.com/ordinaryzelig/minispec-rails-example).
-
 ## TODO
 
 * Ask Rails to add `run_load_hooks` for ActionDispatch::SystemTestCase so we can lazy load like the others.
-* Custom file types? I like file types like `spec/models/my_model.spec.rb`. But maybe later.
+* Custom file types? I like file types with extensions like `spec/models/my_model.spec.rb`.
 
 ## License
 

data/lib/minispec/rails.rb

@@ -14,7 +14,8 @@ module Minispec
 
     ActiveSupport.on_load(:action_dispatch_integration_test) do
       Minitest::Spec.register_spec_type(ActionDispatch::IntegrationTest) do |desc|
-        desc.is_a?(Class) && desc < AbstractController::Base
+        (desc.is_a?(Class) && desc < AbstractController::Base) ||
+          (desc.to_s =~ /integration$/i)
       end
     end
 

data/lib/minispec/rails/system_test.rb

@@ -7,7 +7,7 @@ ActionDispatch::SystemTestCase.extend(
       super
       unless Minitest::Spec::TYPES.find { |matcher, type| type == ApplicationSystemTestCase }
         Minitest::Spec.register_spec_type(ApplicationSystemTestCase) do |desc|
-          desc.is_a?(String)
+          desc.to_s =~ /system$/i
         end
       end
     end

data/lib/minispec/rails/version.rb

@@ -1,5 +1,5 @@
 module Minispec
   module Rails
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minispec-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jared Ning
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-13 00:00:00.000000000 Z
+date: 2017-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler