with_model 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22f429a5cb8e986623de65004594810d642f7ca21b0bf24a0a1257defa40add9
-  data.tar.gz: a7a0cbbe47ba722b1359a438c18692a7927ff957c88cd0e0919ac3ab4ac65e92
+  metadata.gz: 8a9994ddf84f8fe654f6670173ea2cf6d8a739c1033bc17ca9765001fc0f8f50
+  data.tar.gz: f432e1faa7d071b4219dadf9f64a4d7202d67d2fcb0c95b01157848be12252d5
 SHA512:
-  metadata.gz: 63d816a1fe0782ee315073325b6eb59b468bc87c7899f3a124c181cc6542ee9c31d55768a3e2af8234ec6ffad9bb92037b012da5328128e835fce4a74d7a6b15
-  data.tar.gz: 6da66d3cbf860d19d5a2c661e01e75ff7aef341d78d64d12055d5c28ebc5e7401ea5c095b6b006da1c01bcb4b2100bf524681a63292ccf791cff7def6a987115
+  metadata.gz: 7654d570583cea72d142bf0d70416d539704198f7ca9d447fb52b1917e016f05622a4d7f53a03ca6c3002d61ce3a2301ddae4ee6982312ff0c3e5d2b57fa4f7c
+  data.tar.gz: b90401f8f508ab719cddd294dd5bcc104c09e075df83f55e65e4884cfc0202ed38a1240a8098dc2443fbeba3c6957d392ec17bf717e121d82922e6bdefc128ec

data/.gitignore

@@ -1,18 +1,5 @@
-*.gem
-*.rbc
-.bundle
-.config
 .yardoc
-.idea/
 Gemfile.lock
-InstalledFiles
-_yardoc
 coverage
 doc/
-lib/bundler/man
 pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+### 2.1.1
+
+- Don't fail erroneously when running the after hook when the before hook failed
+- Improve documentation
+
+### 2.1.0
+
+- Support creating constant in an existing namespace (#26)
+- Prefer keyword arguments over manually-validated hash argument
+- Improve documentation
+- Remove support for obsolete Ruby
+- Internal cleanup
+
 ### 2.0.0
 
 - Require Ruby 2.1 or later

data/README.md

@@ -2,6 +2,7 @@
 
 [![Gem Version](https://img.shields.io/gem/v/with_model.svg?style=flat)](https://rubygems.org/gems/with_model)
 [![Build Status](https://secure.travis-ci.org/Casecommons/with_model.svg?branch=master)](https://travis-ci.org/Casecommons/with_model)
+[![API Documentation](https://img.shields.io/badge/yard-api%20docs-lightgrey.svg)](https://www.rubydoc.info/gems/with_model)
 
 `with_model` dynamically builds an ActiveRecord model (with table) before each test in a group and destroys it afterwards.
 
@@ -161,9 +162,18 @@ end
 
 ## Requirements
 
-- Ruby 2.1+
-- RSpec or minitest/spec
-- ActiveRecord 4.2+
+See the [gemspec metadata](https://rubygems.org/gems/with_model) for dependency requirements. RSpec and minitest are indirect dependencies, and `with_model` should support any maintained version of both.
+
+## Thread-safety
+
+- A unique table name is used for tables generated via `with_model`/`WithModel::Model.new`. This allows `with_model` (when limited to this API) to run concurrently (in processes or threads) with a single database schema. While there is a possibility of collision, it is very small.
+- A user-supplied table name is used for tables generated via `with_table`/`WithModel::Table.new`. This may cause collisions at runtime if tests are run concurrently against a single database schema, unless the caller takes care to ensure the table names passed as arguments are unique across threads/processes.
+- Generated models are created in stubbed constants, which are global; no guarantee is made to the uniqueness of a constant, and this may be unsafe.
+- Generated classes are ActiveRecord subclasses:
+  - This library makes no guarantee is made as to the thread-safety of creating ActiveRecord subclasses concurrently.
+  - This library makes no guarantee is made as to the thread-safety of cleaning up ActiveRecord/ActiveSupport’s internals which are polluted upon class creation.
+
+In general, `with_model` is not guaranteed to be thread-safe, but is, in certain usages, safe to use concurrently across multiple processes with a single database schema.
 
 ## Versioning
 

data/lib/with_model.rb

@@ -6,6 +6,10 @@ require 'with_model/table'
 require 'with_model/version'
 
 module WithModel
+  # @param name The constant name (as a symbol) to assign the model class to.
+  # @param scope Passed to `before`/`after` in the test context.
+  # @param options Passed to {WithModel::Model#initialize}.
+  # @param block Yielded an instance of {WithModel::Model::DSL}.
   def with_model(name, scope: nil, **options, &block)
     model = Model.new name, options
     dsl = Model::DSL.new model
@@ -20,6 +24,10 @@ module WithModel
     end
   end
 
+  # @param name The table name (as a symbol) to create.
+  # @param scope Passed to `before`/`after` in the test context.
+  # @param options Passed to {WithModel::Table#initialize}.
+  # @param block Passed to {WithModel::Table#initialize} (like {WithModel::Model::DSL#table}).
   def with_table(name, scope: nil, **options, &block)
     table = Table.new name, options, &block
 

data/lib/with_model/constant_stubber.rb

@@ -19,9 +19,11 @@ module WithModel
     end
 
     def unstub_const
-      @namespace.__send__ :remove_const, basename
-      @namespace.const_set basename, @original_value if @original_value
-      @namespace = nil
+      if @namespace
+        @namespace.__send__ :remove_const, basename
+        @namespace.const_set basename, @original_value if @original_value
+        @namespace = nil
+      end
       @original_value = nil
     end
 

data/lib/with_model/methods.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 module WithModel
+  # Extended into all ActiveRecord models created by with_model.
   module Methods
+    # Since model classes not created by with_model won't have this
+    # method, one should instead test `respond_to?(:with_model?)`.
     def with_model?
       true
     end

data/lib/with_model/model.rb

@@ -8,9 +8,14 @@ require 'with_model/methods'
 require 'with_model/table'
 
 module WithModel
+  # In general, direct use of this class should be avoided. Instead use
+  # either the {WithModel high-level API} or {WithModel::Model::DSL low-level API}.
   class Model
     attr_writer :model_block, :table_block, :table_options
 
+    # @param name The constant name (as a symbol) to assign the model class to.
+    # @param superclass The superclass for the created class. Should
+    #   have `ActiveRecord::Base` as an ancestor.
     def initialize(name, superclass: ActiveRecord::Base)
       @name = name.to_sym
       @model_block = nil

data/lib/with_model/model/dsl.rb

@@ -3,6 +3,7 @@
 module WithModel
   class Model
     class DSL
+      # @param model [WithModel::Model] The Model to mutate via this DSL.
       def initialize(model)
         @model = model
       end

data/lib/with_model/table.rb

@@ -3,20 +3,28 @@
 require 'active_record'
 
 module WithModel
+  # In general, direct use of this class should be avoided. Instead use
+  # either the {WithModel high-level API} or {WithModel::Model::DSL low-level API}.
   class Table
+    # @param name The name of the table to create.
+    # @param options Passed to ActiveRecord `create_table`.
+    # @param block Passed to ActiveRecord `create_table`.
+    # @see https://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/SchemaStatements.html#method-i-create_table
     def initialize(name, options = {}, &block)
       @name = name.freeze
       @options = options.freeze
       @block = block
     end
 
+    # Creates the table with the initialized options. Drops the table if
+    # it already exists.
     def create
       connection.drop_table(@name) if exists?
       connection.create_table(@name, @options, &@block)
     end
 
     def destroy
-      ActiveRecord::Base.connection.drop_table(@name)
+      connection.drop_table(@name)
     end
 
     private

data/lib/with_model/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WithModel
-  VERSION = '2.1.0'
+  VERSION = '2.1.1'
 end

data/spec/constant_stubber_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module WithModel
+  describe ConstantStubber do
+    it 'allows calling unstub_const multiple times' do
+      stubber = described_class.new('Foo')
+      stubber.stub_const(1)
+      stubber.unstub_const
+      stubber.unstub_const
+    end
+
+    it 'allows calling unstub_const without stub_const' do
+      stubber = described_class.new('Foo')
+      stubber.unstub_const
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: with_model
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Case Commons, LLC
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-09 00:00:00.000000000 Z
+date: 2018-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -116,6 +116,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -130,6 +131,7 @@ files:
 - lib/with_model/table.rb
 - lib/with_model/version.rb
 - spec/active_record_behaviors_spec.rb
+- spec/constant_stubber_spec.rb
 - spec/readme_spec.rb
 - spec/spec_helper.rb
 - spec/with_model_spec.rb
@@ -154,12 +156,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Dynamically build a model within an RSpec context
 test_files:
 - spec/active_record_behaviors_spec.rb
+- spec/constant_stubber_spec.rb
 - spec/readme_spec.rb
 - spec/spec_helper.rb
 - spec/with_model_spec.rb