minitest-rails 3.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b4d24ef4761098d8b1b988493155fb73ba0c480a
-  data.tar.gz: a6c181821e2331d20f05698fb632650c61d50db3
+SHA256:
+  metadata.gz: 921cfaa469ddecc9a13aa20c02dc2fd9bffa5eafa5bf605713604d95b0e1b9b1
+  data.tar.gz: c431d89abcec70990467b4f756f2fdbf2d057df7c9e1ebb717bb08100e3bc936
 SHA512:
-  metadata.gz: 25066c06f3a6097e3a026b8576f3dc69a1b38988f37640f4ecb59868775d54ebfa67e7ff5150b74b12cd60fa28d1f22c17f236bbffbf7ad087c4a07937200892
-  data.tar.gz: 567cda05348d00933ff39b9175011b58315a83ac4c7959df168ed8264c7bce9d2b54fc1d46b086a742268f007c99fb06a0678ad86cf7e209837206a96f7ab1c2
+  metadata.gz: bff8982d4743945a7795de1db69a27e3335fa4406b3a83d16ad6b6654005efdd6412982c093d3d7cfab366b045d03def59e00d411aa42717e85cf89cf0783db6
+  data.tar.gz: 6960f3757941914a3667c3f6e588305c3622f05a646216c4da5904ee4794f549fe32caf4e3d088e9ae33fe41ddc7d8a7d4b84fd6cb5cf0a7e7b04d20fa59a336

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changes
+
+### 5.0.0 / upcoming...
+
+* ...

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Mike Moore
+Copyright (c) 2019 Mike Moore
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,94 @@
+# minitest-rails
+
+Minitest integration for Rails 5.0
+
+[![Build Status](https://secure.travis-ci.org/blowmage/minitest-rails.png)](http://travis-ci.org/blowmage/minitest-rails)
+[![Code Climate](https://codeclimate.com/github/blowmage/minitest-rails.png)](https://codeclimate.com/github/blowmage/minitest-rails)
+
+## Install
+
+`gem install minitest-rails`
+
+This installs the following gems:
+
+* `minitest`
+
+## Configure
+
+Create a new rails app:
+
+`rails new MyApp`
+
+### Update Gemfile
+
+This version is for Rails 5.0 applications. Update your application to use the
+gem by adding the following to your Gemfile:
+
+```ruby
+gem "minitest-rails", "~> 5.0.0"
+```
+
+### Installing
+
+Next run the installation generator with the following:
+
+`rails generate minitest:install`
+
+This will add the `test_helper.rb` file to the `test` directory.
+
+## Usage
+
+This project aims to enable Minitest within the Rails TestCase classes.
+Your test will continue to inherit from `ActiveSupport::TestCase`, which will now support the spec DSL.
+You can generate test files using the `Minitest::Spec` DSL with the standard model, controller, resource, and other generators:
+
+`rails generate model User`
+
+And you can specify generating the tests without the `Minitest::Spec` DSL on any of the generators by providing the `--no-spec` option:
+
+`rails generate model User --no-spec`
+
+And you can specify not generating the fixture for a model by providing the `--skip-fixture` option:
+
+`rails generate model User --skip-fixture`
+
+You can also set these as defaults by adding the following to the `config/application.rb` file:
+
+```ruby
+config.generators do |g|
+  g.test_framework :minitest, spec: false, fixture: false
+end
+```
+
+## Running Tests
+
+To run your tests use the `rails test` that ship with rails.
+
+## Get Involved
+
+Join the mailing list to get help or offer suggestions.
+
+https://groups.google.com/group/minitest-rails
+
+## License
+
+Copyright (c) 2019 Mike Moore
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/UPDATING.md

@@ -0,0 +1,31 @@
+# Updating from previous versions
+
+If you are upgrading from previous versions, then there are some subtle changes that you should be aware of. Do you see a change that is not listed in this document? Then please [open an issue](https://github.com/blowmage/minitest-rails/issues/new) to add it.
+
+## Spec DSL
+
+The `describe` block should be passed the actual constant and not a string of the constant's name. This works:
+
+```ruby
+describe WidgetsController do
+```
+
+But this does not:
+
+```ruby
+describe "WidgetsController" do
+```
+
+If you want to pass a string, then you must provide an additional description to tell the Spec DSL what test class to use:
+
+```ruby
+describe "WidgetsController", :controller do
+```
+
+## Expectations
+
+The signature for the expectation `must_change` has changed from earlier versions of minitest-rails. This is because the expectation used to refer to the `assert_difference` assertion, but not refers to the `assert_changes` assertion added in Rails 5.1. The expectation for the `assert_difference` assertion is now `must_differ`.
+
+## Versioning
+
+The minitest-rails gem now follows Rails versioning. This means minitest-rails 6.0.x works for rails 6.0.x, and minitest-rails 6.1.x will work for rails 6.1.x.

data/lib/generators/minitest.rb

@@ -1,17 +1,30 @@
-require 'rails/generators/named_base'
+# frozen_string_literal: true
+
+require "rails/generators/named_base"
 
 module Minitest
   module Generators
     class Base < ::Rails::Generators::NamedBase #:nodoc:
       class_option :spec, type: :boolean, default: true,
                           desc: "Use Minitest::Spec DSL"
+      class_option :spec_expectation_monad, type: :string, default: "value",
+                                            desc: "Spec DSL's expectation value mondad (options: value, expect, _)"
 
       def self.default_source_root
-        File.expand_path(File.join(File.dirname(__FILE__), 'minitest', generator_name, 'templates'))
+        File.expand_path(File.join(File.dirname(__FILE__), "minitest", generator_name, "templates"))
       end
 
-      def show_helper
-        "#{singular_table_name}_url(#{singular_table_name})"
+      def test_file_type
+        return "spec" if options[:spec]
+
+        "test"
+      end
+
+      def spec_expectation_monad
+        monad = options[:spec_expectation_monad]
+        return monad if %w[value expect _].include? monad
+
+        "value"
       end
     end
   end

data/lib/generators/minitest/controller/controller_generator.rb

@@ -1,18 +1,15 @@
+# frozen_string_literal: true
+
 require "generators/minitest"
 
-module Minitest
-  module Generators
-    class ControllerGenerator < Base
+module Minitest # :nodoc:
+  module Generators # :nodoc:
+    class ControllerGenerator < Base # :nodoc:
       argument :actions, type: :array, default: [], banner: "action action"
       check_class_collision suffix: "ControllerTest"
 
       def create_test_files
-        if options[:spec]
-          template_file = "controller_spec.rb"
-        else
-          template_file = "controller_test.rb"
-        end
-        template template_file,
+        template "functional_#{test_file_type}.rb",
                  File.join("test/controllers", class_path, "#{file_name}_controller_test.rb")
       end
     end

data/lib/generators/minitest/controller/templates/{controller_spec.rb → functional_spec.rb.tt}

@@ -7,14 +7,14 @@ describe <%= class_name %>Controller do
 
 <% end -%>
 <% if actions.empty? -%>
-  # it "must be a real test" do
-  #   flunk "Need real tests"
+  # it "does a thing" do
+  #   <%= spec_expectation_monad %>(1+1).must_equal 2
   # end
 <% else -%>
 <% actions.each do |action| -%>
-  it "should get <%= action %>" do
+  it "must get <%= action %>" do
     get <%= url_helper_prefix %>_<%= action %>_url
-    value(response).must_be :success?
+    must_respond_with :success
   end
 
 <% end -%>

data/lib/generators/minitest/controller/templates/{controller_test.rb → functional_test.rb.tt}

@@ -7,12 +7,12 @@ class <%= class_name %>ControllerTest < ActionDispatch::IntegrationTest
 
 <% end -%>
 <% if actions.empty? -%>
-  # def test_sanity
-  #   flunk "Need real tests"
+  # def test_truth
+  #   assert true
   # end
 <% else -%>
 <% actions.each do |action| -%>
-  def test_<%= action %>
+  def test_get_<%= action %>
     get <%= url_helper_prefix %>_<%= action %>_url
     assert_response :success
   end

data/lib/generators/minitest/generator/generator_generator.rb

@@ -2,22 +2,17 @@ require "generators/minitest"
 
 module Minitest
   module Generators
-    class GeneratorGenerator < Base
+    class GeneratorGenerator < Base # :nodoc:
       check_class_collision suffix: "GeneratorTest"
 
       class_option :namespace, type: :boolean, default: true,
                                desc: "Namespace generator under lib/generators/name"
 
       def create_generator_files
-        if options[:spec]
-          template_file = "generator_spec.rb"
-        else
-          template_file = "generator_test.rb"
-        end
-        template template_file, File.join("test/lib/generators", class_path, "#{file_name}_generator_test.rb")
+        template "generator_#{test_file_type}.rb", File.join("test/lib/generators", class_path, "#{file_name}_generator_test.rb")
       end
 
-      protected
+      private
 
       def generator_path
         if options[:namespace]

data/lib/generators/minitest/generator/templates/{generator_spec.rb → generator_spec.rb.tt}

@@ -3,11 +3,11 @@ require "<%= generator_path %>"
 
 <% module_namespacing do -%>
 describe <%= class_name %>Generator do
+  #tests <%= class_name %>Generator
   destination Rails.root.join("tmp/generators")
   setup :prepare_destination
 
-  # it "generator runs without errors" do
-  #   # No error raised? It passes.
+  # it "runs without errors" do
   #   run_generator ["arguments"]
   # end
 end

data/lib/generators/minitest/generator/templates/{generator_test.rb → generator_test.rb.tt}

@@ -7,8 +7,7 @@ class <%= class_name %>GeneratorTest < Rails::Generators::TestCase
   destination Rails.root.join("tmp/generators")
   setup :prepare_destination
 
-  # def test_generator_runs
-  #   # No error raised? It passes.
+  # def test_generator_runs_without_errors
   #   run_generator ["arguments"]
   # end
 end

data/lib/generators/minitest/helper/helper_generator.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require "generators/minitest"
 
-module Minitest
-  module Generators
-    class HelperGenerator < Base
+module Minitest # :nodoc:
+  module Generators # :nodoc:
+    class HelperGenerator < Base # :nodoc:
       # Rails does not generate anything here.
     end
   end

data/lib/generators/minitest/install/install_generator.rb

@@ -1,21 +1,32 @@
-require 'rails/generators'
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/app_base"
 
 module Minitest
   module Generators
-    class InstallGenerator < ::Rails::Generators::Base
+    class InstallGenerator < ::Rails::Generators::AppBase
       class_option :skip_active_record, type: :boolean, default: false, desc: "Skip Active Record files"
 
-      desc <<DESC
-Description:
-    Copy minitest files to your application.
-DESC
+      desc <<~DESC
+        Description:
+            Copy minitest files to your application.
+      DESC
 
       def self.source_root
-        @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+        @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), "templates"))
       end
 
       def copy_minitest_files
-        template 'test_helper.rb', File.join("test", "test_helper.rb")
+        empty_directory_with_keep_file "test/fixtures"
+        empty_directory_with_keep_file "test/fixtures/files"
+        empty_directory_with_keep_file "test/controllers"
+        empty_directory_with_keep_file "test/mailers"
+        empty_directory_with_keep_file "test/models"
+        empty_directory_with_keep_file "test/helpers"
+        empty_directory_with_keep_file "test/integration"
+
+        template "test/test_helper.rb"
       end
     end
   end

data/lib/generators/minitest/install/templates/test/test_helper.rb.tt

@@ -0,0 +1,16 @@
+ENV["RAILS_ENV"] ||= "test"
+require_relative "../config/environment"
+require "rails/test_help"
+require "minitest/rails"
+
+# Consider setting MT_NO_EXPECTATIONS to not add expectations to Object.
+# ENV["MT_NO_EXPECTATIONS"] = true
+
+class ActiveSupport::TestCase
+<% unless options[:skip_active_record] -%>
+  # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
+  fixtures :all
+
+<% end -%>
+  # Add more helper methods to be used by all tests here...
+end

data/lib/generators/minitest/integration/integration_generator.rb

@@ -1,17 +1,20 @@
+# frozen_string_literal: true
+
 require "generators/minitest"
 
-module Minitest
-  module Generators
-    class IntegrationGenerator < Base
+module Minitest # :nodoc:
+  module Generators # :nodoc:
+    class IntegrationGenerator < Base # :nodoc:
       check_class_collision suffix: "Test"
 
       def create_test_files
-        if options[:spec]
-          template_file = "integration_spec.rb"
-        else
-          template_file = "integration_test.rb"
-        end
-        template template_file, File.join("test/integration", class_path, "#{file_name}_test.rb")
+        template "integration_#{test_file_type}.rb", File.join("test/integration", class_path, "#{file_name}_test.rb")
+      end
+
+      private
+
+      def file_name
+        @_file_name ||= super.sub(/_test\z/i, "")
       end
     end
   end

data/lib/generators/minitest/integration/templates/integration_spec.rb.tt

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+<% module_namespacing do -%>
+describe "<%= human_name %>", :integration do
+  # it "does a thing" do
+  #   <%= spec_expectation_monad %>(1+1).must_equal 2
+  # end
+end
+<% end -%>

data/lib/generators/minitest/integration/templates/integration_test.rb.tt

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+<% module_namespacing do -%>
+class <%= class_name %>Test < ActionDispatch::IntegrationTest
+  # def test_truth
+  #   assert true
+  # end
+end
+<% end -%>

data/lib/generators/minitest/job/job_generator.rb

@@ -1,17 +1,20 @@
+# frozen_string_literal: true
+
 require "generators/minitest"
 
-module Minitest
-  module Generators
-    class JobGenerator < Base
+module Minitest # :nodoc:
+  module Generators # :nodoc:
+    class JobGenerator < Base # :nodoc:
       check_class_collision suffix: "JobTest"
 
-      def create_test_files
-        if options[:spec]
-          template_file = "job_spec.rb"
-        else
-          template_file = "job_test.rb"
-        end
-        template template_file, File.join("test/jobs", class_path, "#{file_name}_job_test.rb")
+      def create_test_file
+        template "unit_#{test_file_type}.rb", File.join("test/jobs", class_path, "#{file_name}_job_test.rb")
+      end
+
+      private
+
+      def file_name
+        @_file_name ||= super.sub(/_job\z/i, "")
       end
     end
   end