temping 3.10.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3f37e4189f710e304a6ec94e01d8691f84482b31
-  data.tar.gz: ea35560ebafd11b1249279607720f55a87efc25b
+SHA256:
+  metadata.gz: 2a53e8767ff6d35d29a1a09b566783d4bd7a17d03487444f76b8ebb54f1bba47
+  data.tar.gz: 976fe40bc7e41f5656dc4d33bb1eddb96b23bcbdd21ab750ec419cabd14faa82
 SHA512:
-  metadata.gz: ab0d022c53993e077864c178b90c788bc383560c379ce9f74c6c15f43896b7803d68340846b88f51c7a3aeb8433879f74c192a45a1e95902632b1ced28316782
-  data.tar.gz: 9b0d042c72114558ee70d33ea7bbce9a4611a309f1c75dcc494040f035b25daa9728290a61c6bc1f1cb58b338238bab72537bbde9eca40d6f6ce02b7bf856278
+  metadata.gz: 16a3f8ad76398efd927a43070f1b5345e2b5e9dfd7d7717bd2b7989880bd500942c9019dc6e0a286bc87db73d438c1397139f6495ef8b05ba615c3aa6bf4795e
+  data.tar.gz: ec9dde98c39afc8c990dd7ce740e35e4e1d8d1355fb31a30cc1612fc7cb85221e2f4dac62e9188e343d8093ed1ba2220301911ce0c48cb587914808a6232dd70

data/lib/temping/model_factory.rb

@@ -0,0 +1,69 @@
+class Temping::ModelFactory
+  DEFAULT_OPTIONS = {temporary: true}
+
+  def initialize(name, namespace, options = {}, &block)
+    @name = name
+    @namespace = namespace
+    @options = options
+    klass.class_eval(&block) if block
+    klass.reset_column_information
+  end
+
+  def klass
+    @klass ||= @namespace.const_get(@name)
+  rescue NameError
+    @klass = build
+  end
+
+  private
+
+  def build
+    Class.new(parent_class_name).tap do |klass|
+      @namespace.const_set(@name, klass)
+      klass.primary_key = @options[:primary_key] || :id
+      create_table(@options.except(:parent_class))
+      add_methods
+      klass.namespace = @namespace
+    end
+  end
+
+  def parent_class_name
+    @options.fetch(:parent_class, default_parent_class_name)
+  end
+
+  def default_parent_class_name
+    if defined?(ApplicationRecord)
+      ApplicationRecord
+    else
+      ActiveRecord::Base
+    end
+  end
+
+  def create_table(options = {})
+    connection.create_table(table_name, **DEFAULT_OPTIONS.merge(options))
+  end
+
+  def add_methods
+    class << klass
+      attr_accessor :namespace
+
+      def with_columns
+        connection.change_table(table_name) do |table|
+          yield(table)
+        end
+      end
+
+      def table_exists?
+        true
+      end
+    end
+  end
+
+  def connection
+    klass.connection
+  end
+
+  def table_name
+    klass.table_name
+  end
+end

data/lib/temping/namespace_factory.rb

@@ -0,0 +1,24 @@
+class Temping::NamespaceFactory
+  def initialize(name)
+    @name = name
+  end
+
+  def klass
+    @klass ||= @name.split("::").reduce(Object) { |parent, name_part| build(parent, name_part) }
+  end
+
+  private
+
+  def build(parent, name_part)
+    parent.const_get(name_part)
+  rescue NameError
+    parent.const_set(
+      name_part,
+      Module.new do
+        def self.defined_by_temping?
+          true
+        end
+      end
+    )
+  end
+end

data/lib/temping.rb

@@ -1,94 +1,149 @@
 require "active_record"
 require "active_support/core_ext/string"
 
+class Temping; end
+
+require "temping/namespace_factory"
+require "temping/model_factory"
+
 class Temping
-  @model_klasses = []
+  @namespaces = []
+  @models = []
 
   class << self
-    def create(model_name, options = {}, &block)
-      factory = ModelFactory.new(model_name.to_s.classify, options, &block)
-      klass = factory.klass
-      @model_klasses << klass
-      klass
+    # Create a new temporary ActiveRecord model with a name specified by `name`.
+    #
+    # Provided `options` are all passed to the inner `create_table` call so anything
+    # acceptable by `create_table` method can be passed here.
+    # In addition `options` can include `parent_class` key to specify parent class for the model.
+    # When `block` is passed, it is evaluated in the context of the class. This means anything you
+    # do in an ActiveRecord model class body can be accomplished in `block` including method
+    # definitions, validations, module includes, etc.
+    # Additional database columns can be specified via `with_columns` method inside `block`,
+    # which uses Rails migration syntax.
+    def create(name, options = {}, &block)
+      namespace_name, model_name = split_name(name)
+      namespace = namespace_name ? NamespaceFactory.new(namespace_name).klass : Object
+      @namespaces << namespace if namespace_name
+      model = ModelFactory.new(model_name, namespace, options, &block).klass
+      @models << model
+      model
     end
 
+    # Completely destroy everything created by Temping.
+    #
+    # This includes:
+    # * removing all the records in the models created by Temping and dropping their tables
+    # from the database;
+    # * undefining model constants so they cannot be pointed to anymore in the code.
     def teardown
-      if @model_klasses.any?
-        @model_klasses.each do |klass|
-          if Object.const_defined?(klass.name)
-            klass.connection.drop_table(klass.table_name)
-            Object.send(:remove_const, klass.name)
-          end
-        end
-        @model_klasses.clear
-        ActiveSupport::Dependencies::Reference.clear!
+      if @models.any?
+        teardown_models
+        teardown_namespaces
+        ActiveSupport::Dependencies::Reference.clear! if ActiveRecord::VERSION::MAJOR < 7
       end
     end
 
+    # Destroy all records from each of the models created by Temping.
+    #
+    # This does not undefine the models themselves or drop their tables.
+    # This method is an alternative to `teardown` if you want to keep the models and tables.
     def cleanup
-      @model_klasses.each(&:destroy_all)
+      @models.reverse_each(&:destroy_all)
     end
-  end
 
-  class ModelFactory
-    def initialize(model_name, options = {}, &block)
-      @model_name = model_name
-      @options = options
-      klass.class_eval(&block) if block_given?
-      klass.reset_column_information
-    end
+    # Split the provided name finding the namespace (if any) and the model name without namespace.
+    def split_name(name)
+      classified_name = name.to_s.classify
+      name_parts = classified_name.split("::")
+      namespace_name = name_parts[0...-1].join("::")
+      return [nil, classified_name] if namespace_name.empty?
 
-    def klass
-      @klass ||= Object.const_get(@model_name)
-    rescue NameError
-      @klass = build
+      [namespace_name, name_parts.last]
     end
+    private :split_name
 
-    private
-
-    def build
-      Class.new(@options.fetch(:parent_class, default_parent_class)).tap do |klass|
-        Object.const_set(@model_name, klass)
-
-        klass.primary_key = @options[:primary_key] || :id
-        create_table(@options)
-        add_methods
+    # Iterate over `@models`, undefine model constants, drop tables, and remove the constants
+    # from the array one by one starting with the models defined last. (Models defined later
+    # can point to older models by using foreign keys so they have to be removed first).
+    def teardown_models
+      @models.reverse_each do |model|
+        model_name_without_namespace = model.name.split("::").last
+        if model.namespace.const_defined?(model_name_without_namespace)
+          model.connection.drop_table(model.table_name)
+          model.namespace.send(:remove_const, model_name_without_namespace)
+        end
       end
+      @models.clear
     end
+    private :teardown_models
 
-    def default_parent_class
-      if ActiveRecord::VERSION::MAJOR > 4 && defined?(ApplicationRecord)
-        ApplicationRecord
-      else
-        ActiveRecord::Base
+    # Iterate over `@namespaces`, undefine modules and remove them from the array one by one
+    # starting with the deepest ones first.
+    def teardown_namespaces
+      @namespaces.select! { |namespace| namespace_still_defined?(namespace) }
+      until @namespaces.empty?
+        namespace, index = @namespaces.each_with_index.max_by { |n, _i| n.name.split("::").length }
+        parts = namespace.name.split("::")
+        parent = (parts.length == 1) ? Object : parts[0...-1].join("::").constantize
+        parent.send(:remove_const, parts.last) if namespace_removable?(namespace, parts, parent)
+        delete_or_trim_in_namespaces(parent, parts, index)
       end
     end
+    private :teardown_namespaces
 
-    DEFAULT_OPTIONS = { :temporary => true }
-    def create_table(options = {})
-      connection.create_table(table_name, DEFAULT_OPTIONS.merge(options))
-    end
-
-    def add_methods
-      class << klass
-        def with_columns
-          connection.change_table(table_name) do |table|
-            yield(table)
-          end
-        end
+    # Check if namespace is still defined.
+    # It could be already removed if it were inside a model created by Temping.
+    # Since `@models` are teared down first, it means that in such a case all modules that were
+    # inside that model are no longer defined.
+    def namespace_still_defined?(namespace)
+      parent = Object
+      outer_namespace_parts = []
+      namespace.to_s.split("::").each do |part|
+        return false unless parent.const_defined?(part)
 
-        def table_exists?
-          true
-        end
+        outer_namespace_parts.push(part)
+        parent = outer_namespace_parts.join("::").constantize
       end
+      true
     end
+    private :namespace_still_defined?
 
-    def connection
-      klass.connection
+    # Namespace can be removed only if it's still defined and if it was created by Temping,
+    # we use `defined_by_temping?` to indicate the latter.
+    def namespace_removable?(namespace, parts, parent)
+      parent.const_defined?(parts.last) && namespace.defined_by_temping?
+    rescue NoMethodError
+      false
     end
+    private :namespace_removable?
+
+    # Clean `@namespaces` array by either removing current namespace or replacing it with its
+    # parent.
+    #
+    # Case 1: @namespaces = [A, B, C, D]; index = 3
+    # This is an outer-most module, we just remove it from `@namespaces`.
+    #
+    # Case 2: @namespaces = [A::B, A::B::C, A::D]; index = 1
+    # Once we remove C from A::B::C, it becomes A::B, but we already have A::B, so just remove it.
+    #
+    # Case 3: @namespaces = [A::B, A::D]; index = 1
+    # Once we remove D from A::D, it becomes A, replace A::D with A.
+    def delete_or_trim_in_namespaces(parent, parts, index)
+      is_last_module = parts.length == 1
+      if is_last_module
+        @namespaces.delete_at(index)
+        return
+      end
+
+      parent_already_in_namespaces = @namespaces.include?(parent)
+      if parent_already_in_namespaces
+        @namespaces.delete_at(index)
+        return
+      end
 
-    def table_name
-      klass.table_name
+      @namespaces[index] = parent
     end
+    private :delete_or_trim_in_namespaces
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: temping
 version: !ruby/object:Gem::Version
-  version: 3.10.0
+  version: 4.1.0
 platform: ruby
 authors:
 - John Pignata
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-09-27 00:00:00.000000000 Z
+date: 2023-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,110 +16,184 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '7.1'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.10
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.10
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.2
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.2
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.18
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.18
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 10.0.4
+        version: 0.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 10.0.4
-description: 
+        version: 0.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description:
 email: john@pignata.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/temping.rb
+- lib/temping/model_factory.rb
+- lib/temping/namespace_factory.rb
 homepage: http://github.com/jpignata/temping
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -127,16 +201,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Create temporary table-backed ActiveRecord models for use in tests
 test_files: []