Revamp the minitesting bundled configuration so it uses Rack::Test (

#954)

* Revamp the minitesting bundled configuration so it uses Rack::Test and the Roda server

* Use more appropriate log level setting

* Remove hardcoded `roda_app.rb` file path, other serveer Zeitwerk optimizations

Fixes #688

* Add support for Minitest expectations to Bridgetown tests

- also add  "intuitive" expectations like `expect(something) == "to equal this"`
- remove RSpec Mocks library and replace with Minitest mocks and stubs

* Move expectations so that Bridgetown::Test can access it too

* Set ENV var so expectations aren't polluting Object

* Include full Spec DSL in `Bridgetown::Test`

transition some "shoulda" style tests to Minitest spec syntax

* use extend rather than include

* fix whitespace

* Relocate server autoload code to a new module

* Add information about spec-style tests, link to cheat sheet

* remove spurious method

Gemfile

@@ -15,10 +15,10 @@ group :test do
   gem "minitest"
   gem "minitest-profile"
   gem "minitest-reporters"
+  gem "minitest-stub_any_instance"
   gem "nokogiri", "~> 1.7"
   gem "nokolexbor"
   gem "rack-test"
-  gem "rspec-mocks"
   gem "rubocop-bridgetown", "~> 0.6", require: false
   gem "shoulda"
   gem "simplecov"

Gemfile.lock

@@ -135,6 +135,7 @@ GEM
       builder
       minitest (>= 5.0)
       ruby-progressbar
+    minitest-stub_any_instance (1.0.3)
     net-http (0.6.0)
       uri
     nokogiri (1.17.2)
@@ -181,10 +182,6 @@ GEM
     roda (3.87.0)
       rack
     rouge (4.5.1)
-    rspec-mocks (3.13.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.2)
     rubocop (1.69.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
@@ -270,11 +267,11 @@ DEPENDENCIES
   minitest
   minitest-profile
   minitest-reporters
+  minitest-stub_any_instance
   nokogiri (~> 1.7)
   nokolexbor
   rack-test
   rake (~> 13.0)
-  rspec-mocks
   rubocop-bridgetown (~> 0.6)
   shoulda
   simplecov

bridgetown-builder/test/helper.rb

@@ -2,3 +2,5 @@
 
 require_relative "../../bridgetown-core/test/helper.rb"
 require_relative "../lib/bridgetown-builder.rb"
+
+Bridgetown::Builder # fix autoload weirdness when running certain tests

bridgetown-builder/test/test_filters_dsl.rb

@@ -31,25 +31,25 @@ def build
 end
 
 class TestFilterDSL < BridgetownUnitTest
-  context "adding a Liquid filter" do
-    setup do
+  describe "adding a Liquid filter" do
+    before do
       @site = Site.new(site_configuration)
       @builder = FiltersBuilder.new("FiltersDSL", @site).build_with_callbacks
     end
 
-    should "output the filter result" do
+    it "output the filter result" do
       content = "2 times 2 equals {{ 2 | multiply_by_2 }}"
       result = Liquid::Template.parse(content).render
       assert_equal "2 times 2 equals 4", result
     end
 
-    should "output the filter result based on argument" do
+    it "output the filter result based on argument" do
       content = "5 times 10 equals {{ 5 | multiply_by_anything:10 }}"
       result = Liquid::Template.parse(content).render
       assert_equal "5 times 10 equals 50", result
     end
 
-    should "support optional arguments" do
+    it "support optional arguments" do
       content = "5 times 10 equals {{ 5 | multiply_and_optionally_add:10 }}"
       result = Liquid::Template.parse(content).render
       assert_equal "5 times 10 equals 50", result
@@ -59,13 +59,13 @@ class TestFilterDSL < BridgetownUnitTest
       assert_equal "5 times 10 plus 3 equals 53", result
     end
 
-    should "allow access to local builder scope" do
+    it "allow access to local builder scope" do
       content = "root_dir: {{ 'is' | site_config }}"
       result = Liquid::Template.parse(content).render
       assert_equal "root_dir: is #{@site.root_dir}", result
     end
 
-    should "allow access to filters scope" do
+    it "allow access to filters scope" do
       content = "Scope? {{ 'howdy howdy' | within_filters_scope }}"
       result = Liquid::Template.parse(content).render({}, registers: { site: @site })
       assert_equal "Scope? Within Filters Scope: howdy-howdy #{@site.root_dir} 1", result

bridgetown-builder/test/test_generators.rb

@@ -23,8 +23,8 @@ def build
 end
 
 class TestGenerators < BridgetownUnitTest
-  context "creating a generator" do
-    should "be loaded on site setup" do
+  describe "creating a generator" do
+    it "be loaded on site setup" do
       @builders = [GeneratorBuilder, GeneratorBuilder2].sort
       @site = Site.new(site_configuration)
       @site.signals[:site_metadata] = { title: "Initial Value" }

bridgetown-builder/test/test_helpers_dsl.rb

@@ -19,18 +19,19 @@ def method_based(something)
 class TestHelpers < BridgetownUnitTest
   attr_reader :site
 
-  context "adding helpers" do
-    setup do
+  describe "adding helpers" do
+    before do
       @site = Site.new(site_configuration)
       @builder = HelpersBuilder.new("HelpersBuilder", @site).build_with_callbacks
+      self.class.instance_variable_set(:@name, "TestHelpers") # reset so this works:
       @resource = Bridgetown::Model::Base.build(self, :posts, "im-a-post.md", {
         title: "I'm a post!",
         date: "2019-05-01",
       }).as_resource_in_collection
       @erb_view = Bridgetown::ERBView.new(@resource)
     end
 
-    should "allow execution with provided helpers scope" do
+    it "allow execution with provided helpers scope" do
       content = "This is the <%= block_helper page.data[:title] %> helper"
       tmpl = Tilt::ErubiTemplate.new(
         outvar: "@_erbout"
@@ -41,7 +42,7 @@ class TestHelpers < BridgetownUnitTest
                    "Bridgetown::Site helper", result
     end
 
-    should "work with methods" do
+    it "work with methods" do
       content = "This is the <%= method_based page.data[:title] %> helper"
       tmpl = Tilt::ErubiTemplate.new(
         outvar: "@_erbout"

bridgetown-builder/test/test_hooks.rb

@@ -38,13 +38,13 @@ def run_after
 end
 
 class TestHooks < BridgetownUnitTest
-  context "builder hooks" do
-    setup do
+  describe "builder hooks" do
+    before do
       @site = Site.new(site_configuration)
       @builder = HooksBuilder.new("Hooks Test", @site).build_with_callbacks
     end
 
-    should "be triggered" do
+    it "be triggered" do
       @site.reset
       @site.loaders_manager.unload_loaders
       @site.setup
@@ -55,12 +55,12 @@ class TestHooks < BridgetownUnitTest
     end
   end
 
-  context "SiteBuilder" do
-    setup do
+  describe "SiteBuilder" do
+    before do
       @site = Site.new(site_configuration)
     end
 
-    should "be loaded" do
+    it "be loaded" do
       @site.reset
       @site.loaders_manager.unload_loaders
       @site.setup

bridgetown-builder/test/test_http_dsl.rb

@@ -55,13 +55,13 @@ def test_redirect
 end
 
 class TestHTTPDSL < BridgetownUnitTest
-  context "dsl for http requests" do
-    setup do
+  describe "dsl for http requests" do
+    before do
       @site = Site.new(site_configuration)
       @builder = HTTPBuilder.new("Hooks Test", @site).build_with_callbacks
     end
 
-    should "add data from external API" do
+    it "add data from external API" do
       @builder.stubs.get("/test.json") do |_env|
         [
           200,
@@ -74,7 +74,7 @@ class TestHTTPDSL < BridgetownUnitTest
       assert_equal "received", @site.config[:received_data]["data"]["was"].first
     end
 
-    should "not add data from bad external API" do
+    it "not add data from bad external API" do
       @builder.stubs.get("/test_bad.json") do |_env|
         [
           200,
@@ -92,7 +92,7 @@ class TestHTTPDSL < BridgetownUnitTest
                       "Faraday::ParsingError The response from /test_bad.json did not contain valid JSON"
     end
 
-    should "not parse JSON if parse_json is false" do
+    it "not parse JSON if parse_json is false" do
       @builder.stubs.get("/test_not_parsing.html") do |_env|
         [
           200,
@@ -106,7 +106,7 @@ class TestHTTPDSL < BridgetownUnitTest
       assert_equal '[1, 2, ["three"]]', @site.config[:received_data]
     end
 
-    should "redirect automatically" do
+    it "redirect automatically" do
       @builder.stubs.get("/test.json") do |_env|
         [
           200,
@@ -126,7 +126,7 @@ class TestHTTPDSL < BridgetownUnitTest
       assert_equal "received", @site.config[:received_data]["data"]["was"].first
     end
 
-    should "correctly pass headers to the GET request" do
+    it "correctly pass headers to the GET request" do
       @builder.stubs.get("/test_headers.json") do |env|
         [
           200,
@@ -140,7 +140,7 @@ class TestHTTPDSL < BridgetownUnitTest
       assert_equal "hello, world", @site.config[:received_headers]["X-Test"]
     end
 
-    should "allows passing parameters to the GET request" do
+    it "allows passing parameters to the GET request" do
       @builder.stubs.get("/test_parameters.json") do |env|
         [
           200,

bridgetown-builder/test/test_inspectors.rb

@@ -15,8 +15,9 @@ def functions # stub to get hooks working
 
   attr_reader :site
 
-  context "a resource after being transformed" do
-    setup do
+  describe "a resource after being transformed" do
+    before do
+      self.class.instance_variable_set(:@name, "TestInspectors") # reset
       @site = Site.new(site_configuration)
       @_test_functions = []
 
@@ -35,12 +36,12 @@ def functions # stub to get hooks working
       end
     end
 
-    teardown do
+    after do
       @_html_inspectors = nil
       @_xml_inspectors = nil
     end
 
-    should "allow manipulation via Nokogiri" do
+    it "allow manipulation via Nokogiri" do
       add_resource :posts, "html-inspectors.md" do
         title "I'm a Markdown post!"
         content <<~MARKDOWN
@@ -56,7 +57,7 @@ def functions # stub to get hooks working
                    resource.output.strip
     end
 
-    should "bypass inspectors with special front matter variable" do
+    it "bypass inspectors with special front matter variable" do
       add_resource :posts, "html-inspectors-bypass.md" do
         title "I'm a Markdown post!"
         bypass_inspectors true
@@ -73,7 +74,7 @@ def functions # stub to get hooks working
                    resource.output.strip
     end
 
-    should "not mess up non-HTML resources" do
+    it "not mess up non-HTML resources" do
       add_resource :posts, "no-html-inspectors.json" do
         content <<~JSON
           { a: 1, b: "2" }
@@ -88,7 +89,7 @@ def functions # stub to get hooks working
                    resource.output.strip
     end
 
-    should "work with XML resources too" do
+    it "work with XML resources too" do
       add_resource :pages, "sample-feed.atom" do
         content <<~XML
           <?xml version="1.0" encoding="utf-8"?>
@@ -122,8 +123,9 @@ def functions # stub to get hooks working
     end
   end
 
-  context "a resource to transform using Nokolexbor" do
-    setup do
+  describe "a resource to transform using Nokolexbor" do
+    before do
+      self.class.instance_variable_set(:@name, "TestInspectors") # reset
       @site = Site.new(site_configuration({ "html_inspector_parser" => "nokolexbor" }))
       @_test_functions = []
 
@@ -142,12 +144,12 @@ def functions # stub to get hooks working
       end
     end
 
-    teardown do
+    after do
       @_html_inspectors = nil
       @_xml_inspectors = nil
     end
 
-    should "allow manipulation via Nokolexbor" do
+    it "allow manipulation via Nokolexbor" do
       add_resource :posts, "html-inspectors.md" do
         title "I'm a Markdown post!"
         content <<~MARKDOWN

bridgetown-builder/test/test_method_symbols.rb

@@ -28,13 +28,13 @@ def reset_hook(site)
 end
 
 class TestMethodSymbols < BridgetownUnitTest
-  context "adding tags, filters, generators, and hooks using method symbols" do
-    setup do
+  describe "adding tags, filters, generators, and hooks using method symbols" do
+    before do
       @site = Site.new(site_configuration)
       @builder = MethodSymbolsBuilder.new("MethodSymbols", @site).build_with_callbacks
     end
 
-    should "load generator on site generate" do
+    it "load generator on site generate" do
       @site.reset
       @site.signals[:site_metadata] = { title: "Initial Value in Method Symbols" }
       @site.loaders_manager.unload_loaders
@@ -46,19 +46,19 @@ class TestMethodSymbols < BridgetownUnitTest
       assert_equal "Test Title in Method Symbols", @site.metadata[:title]
     end
 
-    should "work with tags" do
+    it "work with tags" do
       content = "This is the {% upcase_tag yay %}upcase{% endupcase_tag %} tag"
       result = Liquid::Template.parse(content).render
       assert_equal "This is the UPCASEYAY tag", result
     end
 
-    should "output the filter result" do
+    it "output the filter result" do
       content = "5 times 10 equals {{ 5 | multiply_by_anything:10 }}"
       result = Liquid::Template.parse(content).render
       assert_equal "5 times 10 equals 50", result
     end
 
-    should "trigger hook" do
+    it "trigger hook" do
       @site.reset
       assert @site.config[:after_reset_hook_ran]
     end