with_model 2.2.0 → 2.3.1

data/spec/with_model_spec.rb

@@ -96,7 +96,9 @@ describe "a temporary ActiveRecord model created with with_model" do
     shadowing_example_ran = false
 
     context "with the with_model block" do
-      with_model :MyConst
+      with_model :MyConst do
+        table
+      end
 
       after do
         shadowing_example_ran = true
@@ -116,16 +118,20 @@ describe "a temporary ActiveRecord model created with with_model" do
   end
 
   describe "with a plural name" do
-    with_model :BlogPosts
+    with_model :BlogPosts do
+      table
+    end
 
     it "does not singularize the constant name" do
       expect(BlogPosts).to be
-      expect(-> { BlogPost }).to raise_error(NameError)
+      expect { BlogPost }.to raise_error(NameError)
     end
   end
 
   describe "with a name containing capital letters" do
-    with_model :BlogPost
+    with_model :BlogPost do
+      table
+    end
 
     it "tableizes the table name" do
       expect(BlogPost.table_name).to match(/_blog_posts_/)
@@ -134,7 +140,9 @@ describe "a temporary ActiveRecord model created with with_model" do
   end
 
   describe "with a name with underscores" do
-    with_model :blog_post
+    with_model :blog_post do
+      table
+    end
 
     it "constantizes the name" do
       expect(BlogPost).to be
@@ -149,7 +157,9 @@ describe "a temporary ActiveRecord model created with with_model" do
   describe "with a name which is namespaced" do
     before { stub_const("Stuff", Module.new) }
 
-    with_model :"Stuff::BlogPost"
+    with_model :"Stuff::BlogPost" do
+      table
+    end
 
     it "creates the model in the namespace" do
       expect(defined?(BlogPost)).to be_falsey
@@ -159,6 +169,7 @@ describe "a temporary ActiveRecord model created with with_model" do
 
   describe "using the constant in the model block" do
     with_model :BlogPost do
+      table
       model do
         raise "I am not myself!" unless self == BlogPost
       end
@@ -180,13 +191,14 @@ describe "a temporary ActiveRecord model created with with_model" do
     before { stub_const("AMixin", mixin) }
 
     with_model :WithAMixin do
+      table
       model do
         include AMixin
       end
     end
 
     it "has the mixin" do
-      expect(-> { WithAMixin.new.foo }).not_to raise_error
+      expect { WithAMixin.new.foo }.not_to raise_error
       expect(WithAMixin.include?(AMixin)).to be true
     end
   end
@@ -207,8 +219,10 @@ describe "a temporary ActiveRecord model created with with_model" do
     before { stub_const("AMixin", mixin) }
 
     with_model :WithAClassEval do
+      table
       model do
         include AMixin
+
         def my_method
         end
       end
@@ -238,8 +252,13 @@ describe "a temporary ActiveRecord model created with with_model" do
     end
   end
 
+  # Omitting `table` is deprecated, but still supported for the rest of 2.x.
+  # These three contexts are its only coverage, so they keep omitting it and
+  # silence the warning rather than adopting the replacement spelling.
   context "without a block" do
-    with_model :BlogPost
+    WithModel.deprecator.silence do
+      with_model :BlogPost
+    end
 
     it "acts like a normal ActiveRecord model" do
       record = BlogPost.create!
@@ -256,7 +275,9 @@ describe "a temporary ActiveRecord model created with with_model" do
   end
 
   context "with an empty block" do
-    with_model(:BlogPost) {}
+    WithModel.deprecator.silence do
+      with_model(:BlogPost) {}
+    end
 
     it "acts like a normal ActiveRecord model" do
       record = BlogPost.create!
@@ -303,7 +324,9 @@ describe "a temporary ActiveRecord model created with with_model" do
   end
 
   context "without a table or model block" do
-    with_model :BlogPost
+    WithModel.deprecator.silence do
+      with_model :BlogPost
+    end
 
     it "acts like a normal ActiveRecord model" do
       expect(BlogPost.columns.map(&:name)).to eq ["id"]

data/test/declaration_order_test.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+# Models are created in declaration order and destroyed in reverse, so each one
+# can depend on the ones above it for as long as it exists. Both halves of that
+# are tested here.
+#
+# The model block is evaluated when the model is created, so a model that
+# refers to another one by constant can only work if the model it refers to
+# was created first.
+class DeclarationOrderTest < Minitest::Test
+  with_model :Author do
+    table do |t|
+      t.string "name"
+    end
+  end
+
+  with_model :Book do
+    table do |t|
+      t.integer "author_id"
+    end
+
+    model do
+      belongs_to :author, class_name: Author.name
+    end
+  end
+
+  with_model :Shelf do
+    table do |t|
+      t.string "name"
+    end
+  end
+
+  # `to_table` because `foreign_key: true` would infer a table name from the
+  # column rather than asking the model, and with_model's table names are
+  # generated.
+  with_model :Jar do
+    table do |t|
+      t.references "shelf", foreign_key: {to_table: Shelf.table_name}
+    end
+  end
+
+  def test_a_model_can_refer_to_one_declared_above_it
+    author = Author.create!(name: "Ursula K. Le Guin")
+    book = Book.create!(author: author)
+
+    assert_equal author, book.reload.author
+  end
+
+  # The assertion for teardown order is that this test finishes cleanly. A
+  # referenced table cannot be dropped while a row still points at it, so tearing
+  # these down in declaration order raises ActiveRecord::InvalidForeignKey after
+  # the body has already passed.
+  def test_a_table_can_point_at_one_declared_above_it
+    shelf = Shelf.create!(name: "pantry")
+    jar = Jar.create!(shelf_id: shelf.id)
+
+    assert_equal shelf.id, jar.reload.shelf_id
+  end
+end

data/test/spec_dsl_test.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+# The README offers Minitest::Spec as well as Minitest::Test. Minitest::Spec
+# inherits from Minitest::Test, so extending Minitest::Test reaches describe
+# blocks too, and with_model needs no separate wiring for them.
+describe "with_model in a spec-style suite" do
+  with_model :Sofa do
+    table do |t|
+      t.string "type"
+      t.string "fabric"
+    end
+  end
+
+  with_model :Loveseat, superclass: :Sofa do
+    table(false)
+  end
+
+  it "creates the models a describe block declares" do
+    assert_empty Sofa.all, "another test's rows outlived it"
+
+    Loveseat.create!(fabric: "tweed")
+
+    assert_equal Sofa.table_name, Loveseat.table_name
+    assert_instance_of Loveseat, Sofa.first
+  end
+
+  # Every describe is its own subclass of the one around it, so a nested block
+  # inherits the models declared above it and can add more of its own.
+  describe "and a nested describe" do
+    with_model :Ottoman do
+      table do |t|
+        t.string "name"
+      end
+    end
+
+    it "sees the models from both levels" do
+      assert_empty Sofa.all, "another test's rows outlived it"
+
+      Ottoman.create!(name: "pouf")
+      Loveseat.create!(fabric: "velvet")
+
+      assert_equal 1, Ottoman.count
+      assert_equal 1, Sofa.count
+    end
+  end
+end

data/test/sti_test.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+# Stands in for an application's own model, the usual reason to want single table
+# inheritance: its table is created once and outlives every test here, so a
+# with_model child's rows cannot be disposed of by dropping the table.
+module AppModels
+  class Cupboard < ActiveRecord::Base
+  end
+end
+
+ActiveRecord::Base.connection.create_table AppModels::Cupboard.table_name, force: true do |t|
+  t.string "type"
+  t.string "name"
+end
+
+# A with_model parent and an STI child in the same test case. The child's
+# superclass is resolved per-example, so this only works if the parent is
+# created before the child and destroyed after it.
+class StiTest < Minitest::Test
+  with_model :Vehicle do
+    table do |t|
+      t.string "type"
+      t.string "name"
+    end
+  end
+
+  with_model :Truck, superclass: -> { Vehicle } do
+    table(false)
+  end
+
+  with_model :Chest, superclass: "AppModels::Cupboard" do
+    table(false)
+  end
+
+  def test_the_child_shares_the_parents_table
+    assert_equal Vehicle.table_name, Truck.table_name
+  end
+
+  def test_the_child_stores_its_own_type
+    truck = Truck.create!(name: "Ford F-150")
+
+    assert_equal "Truck", truck.reload.type
+    assert_instance_of Truck, Vehicle.first
+  end
+
+  # Rows in a table the child does not own have to be deleted when it goes away,
+  # since nothing else will: Cupboard's table is still standing afterwards, and a
+  # row naming a class that no longer exists makes it unloadable. Both tests write
+  # one and first insist the table is empty, so whichever minitest happens to run
+  # second fails if the rows survived teardown - whatever order the seed picks.
+  def test_the_childs_rows_do_not_outlive_it
+    assert_empty AppModels::Cupboard.all, "a previous test's rows outlived it"
+
+    Chest.create!(name: "sideboard")
+
+    assert_equal 1, AppModels::Cupboard.count
+  end
+
+  def test_the_childs_rows_leave_the_superclass_loadable
+    assert_empty AppModels::Cupboard.all, "a previous test's rows outlived it"
+
+    Chest.create!(name: "wardrobe")
+
+    assert_instance_of Chest, AppModels::Cupboard.first
+  end
+end

data/test/test_helper.rb

@@ -7,6 +7,8 @@ require "minitest/autorun"
 
 WithModel.runner = :minitest
 
+WithModel.deprecator.behavior = :raise
+
 Minitest::Test.class_eval do
   extend WithModel
 end

data/with_model.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 3.1"
+  spec.required_ruby_version = ">= 3.3"
 
-  spec.add_dependency "activerecord", ">= 7.0"
+  spec.add_dependency "activerecord", ">= 7.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: with_model
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Case Commons, LLC
@@ -9,7 +9,7 @@ authors:
 - Andrew Marshall
 bindir: bin
 cert_chain: []
-date: 2025-02-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.2'
 description: Dynamically build a model within an RSpec context
 email:
 - casecommons-dev@googlegroups.com
@@ -42,6 +42,7 @@ files:
 - ".rspec"
 - ".yardopts"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
@@ -49,9 +50,12 @@ files:
 - lib/with_model.rb
 - lib/with_model/constant_stubber.rb
 - lib/with_model/descendants_tracker.rb
+- lib/with_model/invalid_superclass.rb
 - lib/with_model/methods.rb
+- lib/with_model/missing_superclass.rb
 - lib/with_model/model.rb
 - lib/with_model/model/dsl.rb
+- lib/with_model/null_table.rb
 - lib/with_model/table.rb
 - lib/with_model/version.rb
 - spec/active_record_behaviors_spec.rb
@@ -59,7 +63,11 @@ files:
 - spec/descendants_tracking_spec.rb
 - spec/readme_spec.rb
 - spec/spec_helper.rb
+- spec/table_false_spec.rb
 - spec/with_model_spec.rb
+- test/declaration_order_test.rb
+- test/spec_dsl_test.rb
+- test/sti_test.rb
 - test/test_helper.rb
 - test/with_model_test.rb
 - with_model.gemspec
@@ -75,14 +83,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 4.0.18
 specification_version: 4
 summary: Dynamically build a model within an RSpec context
 test_files: []