fabrication 2.27.0 → 2.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96b935d9bd47864641229df13dda6eda91c99ffdf692495edf1c71703d8edc0b
-  data.tar.gz: 6b7c6d1c90ecb94b06b8464ea0bcf2127ba5cf28d1a1adac8cad483cb2a8c4f4
+  metadata.gz: 38d9550f8e85412ca21c540ad7f850a61f9f511dce7048487c8cfc49f965922d
+  data.tar.gz: a2e732f74342b3342584483af9b2a446f4bf42fea8af50edbf1d792203e4d16b
 SHA512:
-  metadata.gz: cb0b172c07aeb2922312926e2fe62cd55f406c098d4b4d4e1c5e19bf38ea965022c1c4aa06a1c16898aa4abf443bef327bf9e48aa177a9e73a446bb568b5b3d9
-  data.tar.gz: 45328d26eb07c9be1f95eb0648535233680379a6c014878202cdfd3707eb6fa522cea77d9d2317bd4418458ce58c846e74105300f5f244e8cab95d4001abe85a
+  metadata.gz: bc4ed3c24fcd1d18ffff850a98d35fafe5408e2b166d234944a82d34e272a9a1fa1da1dff5df6677f7d083ac7cade969f10dcdc95e2fe8cb2b45d3f1719096e8
+  data.tar.gz: 28ad7426b1426f3b1f284bf1cf172397b83734b3865f91d64e755995da846f5bf4efc4629e90ee7a800c309e9f39898fac5ff3c87ab2607e7c0a6290d57490f8

data/lib/fabrication/config.rb

@@ -1,3 +1,5 @@
+require 'logger'
+
 module Fabrication
   module Config
     extend self
@@ -14,14 +16,22 @@ module Fabrication
               nil
     end
 
+    attr_writer :logger, :sequence_start
+
+    def logger
+      @logger ||= Logger.new($stdout).tap do |logger|
+        logger.level = Logger::WARN
+      end
+    end
+
     def fabricator_path
       @fabricator_path ||= ['test/fabricators', 'spec/fabricators']
     end
     alias fabricator_paths fabricator_path
 
     def fabricator_dir
-      puts 'DEPRECATION WARNING: Fabrication::Config.fabricator_dir has been ' \
-           'replaced by Fabrication::Config.fabricator_path'
+      Support.log_deprecation('Fabrication::Config.fabricator_dir has been ' \
+                              'replaced by Fabrication::Config.fabricator_path')
       fabricator_path
     end
 
@@ -30,13 +40,11 @@ module Fabrication
     end
 
     def fabricator_dir=(folders)
-      puts 'DEPRECATION WARNING: Fabrication::Config.fabricator_dir has been ' \
-           'replaced by Fabrication::Config.fabricator_path'
+      Support.log_deprecation('Fabrication::Config.fabricator_dir has been ' \
+                              'replaced by Fabrication::Config.fabricator_path')
       self.fabricator_path = folders
     end
 
-    attr_writer :sequence_start
-
     def sequence_start
       @sequence_start ||= 0
     end
@@ -67,8 +75,10 @@ module Fabrication
     end
 
     def register_with_steps=(value)
-      puts 'DEPRECATION WARNING: Fabrication::Config.register_with_steps has been ' \
-           'deprecated. Please regenerate your cucumber steps with `rails g fabrication:cucumber_steps'
+      Support.log_deprecation(
+        'Fabrication::Config.register_with_steps has been deprecated. ' \
+        'Please regenerate your cucumber steps with `rails g fabrication:cucumber_steps'
+      )
 
       return unless value
 

data/lib/fabrication/cucumber/step_fabricator.rb

@@ -1,3 +1,5 @@
+require 'singleton'
+
 module Fabrication
   module Cucumber
     class StepFabricator
@@ -85,17 +87,23 @@ module Fabrication
       end
     end
 
-    module Fabrications
+    class Fabrications
+      include Singleton
+
       def self.fabrications
-        @fabrications ||= {}
+        instance.fabrications
       end
 
       def self.[](fabricator)
-        fabrications[fabricator.to_sym]
+        instance.fabrications[fabricator.to_sym]
       end
 
       def self.[]=(fabricator, fabrication)
-        fabrications[fabricator.to_sym] = fabrication
+        instance.fabrications[fabricator.to_sym] = fabrication
+      end
+
+      def fabrications
+        @fabrications ||= {}
       end
     end
   end

data/lib/fabrication/generator/active_record.rb

@@ -11,10 +11,10 @@ module Fabrication
       end
 
       def build_instance
-        self._instance = if _klass.respond_to?(:protected_attributes)
-                           _klass.new(_attributes, without_protection: true)
+        self._instance = if resolved_class.respond_to?(:protected_attributes)
+                           resolved_class.new(_attributes, without_protection: true)
                          else
-                           _klass.new(_attributes)
+                           resolved_class.new(_attributes)
                          end
       end
     end

data/lib/fabrication/generator/base.rb

@@ -1,7 +1,7 @@
 module Fabrication
   module Generator
     class Base
-      def self.supports?(_klass)
+      def self.supports?(_resolved_class)
         true
       end
 
@@ -11,6 +11,9 @@ module Fabrication
         if callbacks[:initialize_with]
           build_instance_with_constructor_override(callbacks[:initialize_with])
         elsif callbacks[:on_init]
+          Fabrication::Support.log_deprecation(
+            'The on_init callback has been replaced by initialize_with. Please see the documentation for usage'
+          )
           build_instance_with_init_callback(callbacks[:on_init])
         else
           build_instance
@@ -19,18 +22,29 @@ module Fabrication
         _instance
       end
 
-      def create(attributes = [], callbacks = [])
+      def create(attributes = [], callbacks = {})
         build(attributes, callbacks)
-        execute_callbacks(callbacks[:before_validation])
-        execute_callbacks(callbacks[:after_validation])
-        execute_callbacks(callbacks[:before_save])
+        execute_deprecated_callbacks(callbacks, :before_validation, :before_create)
+        execute_deprecated_callbacks(callbacks, :after_validation, :before_create)
+        execute_deprecated_callbacks(callbacks, :before_save, :before_create)
         execute_callbacks(callbacks[:before_create])
         persist
         execute_callbacks(callbacks[:after_create])
-        execute_callbacks(callbacks[:after_save])
+        execute_deprecated_callbacks(callbacks, :after_save, :after_create)
         _instance
       end
 
+      def execute_deprecated_callbacks(callbacks, callback_type, replacement_callback)
+        if callbacks[callback_type]
+          Fabrication::Support.log_deprecation(
+            "Using #{callback_type} is deprecated but you can replace it " \
+            "with #{replacement_callback} with the same result."
+          )
+        end
+
+        execute_callbacks(callbacks[callback_type])
+      end
+
       def execute_callbacks(callbacks)
         callbacks&.each { |callback| _instance.instance_exec(_instance, _transient_attributes, &callback) }
       end
@@ -59,12 +73,12 @@ module Fabrication
       end
 
       def build_instance_with_init_callback(callback)
-        self._instance = _klass.new(*callback.call(_transient_attributes))
+        self._instance = resolved_class.new(*callback.call(_transient_attributes))
         set_attributes
       end
 
       def build_instance
-        self._instance = _klass.new
+        self._instance = resolved_class.new
         set_attributes
       end
 
@@ -74,8 +88,8 @@ module Fabrication
         end
       end
 
-      def initialize(klass)
-        self._klass = klass
+      def initialize(resolved_class)
+        self.resolved_class = resolved_class
       end
 
       def respond_to_missing?(method_name, _include_private = false)
@@ -86,20 +100,31 @@ module Fabrication
         _attributes.fetch(method_name) { super }
       end
 
+      def _klass
+        Fabrication::Support.log_deprecation(
+          'The `_klass` method in fabricator definitions has been replaced by `resolved_class`'
+        )
+
+        resolved_class
+      end
+
       protected
 
-      attr_accessor :_klass, :_instance, :_transient_attributes
+      attr_accessor :resolved_class, :_instance
 
       def _attributes
         @_attributes ||= {}
       end
 
+      def _transient_attributes
+        @_transient_attributes ||= {}
+      end
+
       def persist
         _instance.save! if _instance.respond_to?(:save!)
       end
 
       def process_attributes(attributes)
-        self._transient_attributes = ({})
         attributes.each do |attribute|
           _attributes[attribute.name] = attribute.processed_value(_attributes)
           _transient_attributes[attribute.name] = _attributes[attribute.name] if attribute.transient?

data/lib/fabrication/generator/data_mapper.rb

@@ -6,7 +6,7 @@ module Fabrication
       end
 
       def build_instance
-        self._instance = _klass.new(_attributes)
+        self._instance = resolved_class.new(_attributes)
       end
 
       protected

data/lib/fabrication/generator/mongoid.rb

@@ -6,10 +6,10 @@ module Fabrication
       end
 
       def build_instance
-        self._instance = if _klass.respond_to?(:protected_attributes)
-                           _klass.new(_attributes, without_protection: true)
+        self._instance = if resolved_class.respond_to?(:protected_attributes)
+                           resolved_class.new(_attributes, without_protection: true)
                          else
-                           _klass.new(_attributes)
+                           resolved_class.new(_attributes)
                          end
       end
     end

data/lib/fabrication/generator/sequel.rb

@@ -11,14 +11,11 @@ module Fabrication
       end
 
       def set_attributes
-        _attributes.each do |key, value|
-          if (reflection = _klass.association_reflections[key]) && value.is_a?(Array)
-            _instance.associations[key] = value
-            _instance.after_save_hook do
-              value.each { |o| _instance.send(reflection.add_method, o) }
-            end
+        _attributes.each do |field_name, value|
+          if value.is_a?(Array) && (association = association_for(field_name))
+            set_association(association, field_name, value)
           else
-            _instance.send("#{key}=", value)
+            set_attribute(field_name, value)
           end
         end
       end
@@ -29,8 +26,23 @@ module Fabrication
 
       private
 
+      def association_for(field_name)
+        resolved_class.association_reflections[field_name]
+      end
+
+      def set_attribute(field_name, value)
+        _instance.send("#{field_name}=", value)
+      end
+
+      def set_association(association, field_name, value)
+        _instance.associations[field_name] = value
+        _instance.after_save_hook do
+          value.each { |o| _instance.send(association.add_method, o) }
+        end
+      end
+
       def load_instance_hooks
-        klass = _klass.respond_to?(:cti_base_model) ? _klass.cti_models.first : _klass
+        klass = resolved_class.respond_to?(:cti_base_model) ? resolved_class.cti_models.first : resolved_class
         klass.plugin :instance_hooks unless klass.new.respond_to? :after_save_hook
       end
     end

data/lib/fabrication/schematic/attribute.rb

@@ -43,8 +43,8 @@ module Fabrication
 
       private
 
-      def execute(*args, &block)
-        Fabrication::Schematic::Runner.new(klass).instance_exec(*args, &block)
+      def execute(...)
+        Fabrication::Schematic::Runner.new(klass).instance_exec(...)
       end
 
       def process_count

data/lib/fabrication/sequencer.rb

@@ -1,8 +1,21 @@
+require 'singleton'
+
 module Fabrication
   class Sequencer
+    include Singleton
+
     DEFAULT = :_default
 
     def self.sequence(name = DEFAULT, start = nil, &block)
+      instance.sequence(name, start, &block)
+    end
+
+    def self.clear
+      instance.sequences.clear
+      instance.sequence_blocks.clear
+    end
+
+    def sequence(name = DEFAULT, start = nil, &block)
       idx = sequences[name] ||= start || Fabrication::Config.sequence_start
       if block
         sequence_blocks[name] = block.to_proc
@@ -13,15 +26,15 @@ module Fabrication
       end
     end
 
-    def self.sequences
+    def sequences
       @sequences ||= {}
     end
 
-    def self.sequence_blocks
+    def sequence_blocks
       @sequence_blocks ||= {}
     end
 
-    def self.reset
+    def reset
       Fabrication::Config.sequence_start = nil
       @sequences = nil
       @sequence_blocks = nil

data/lib/fabrication/support.rb

@@ -1,79 +1,68 @@
 module Fabrication
-  class Support
-    class << self
-      def fabricatable?(name)
-        Fabrication.manager[name] || class_for(name)
-      end
+  module Support
+    extend self
 
-      def class_for(class_or_to_s)
-        class_name = variable_name_to_class_name(class_or_to_s)
-        constantize(class_name)
-      rescue NameError => e
-        raise Fabrication::UnfabricatableError.new(class_or_to_s, e)
-      end
+    def fabricatable?(name)
+      Fabrication.manager[name] || class_for(name)
+    end
 
-      def constantize(camel_cased_word)
-        names = camel_cased_word.split('::')
-        Object.const_get(camel_cased_word) if names.empty?
-        names.shift if names.size > 1 && names.first.empty?
-        names.inject(Object) do |constant, name|
-          if constant == Object
-            constant.const_get(name)
-          else
-            candidate = constant.const_get(name)
-            next candidate if constant.const_defined?(name, false)
-            next candidate unless Object.const_defined?(name)
+    def log_deprecation(message)
+      Config.logger.warn("[DEPRECATION][fabrication] #{message}")
+    end
 
-            constant = constant.ancestors.inject do |const, ancestor|
-              break const    if ancestor == Object
-              break ancestor if ancestor.const_defined?(name, false)
+    def class_for(class_or_to_s)
+      constantize(variable_name_to_class_name(class_or_to_s))
+    rescue NameError => e
+      raise Fabrication::UnfabricatableError.new(class_or_to_s, e)
+    end
 
-              const
-            end
-            constant.const_get(name, false)
-          end
-        end
-      end
+    def constantize(camel_cased_word)
+      return camel_cased_word if camel_cased_word.is_a?(Class)
 
-      def extract_options!(args)
-        args.last.is_a?(::Hash) ? args.pop : {}
+      camel_cased_word.to_s.split('::').reduce(Object) do |resolved_class, class_part|
+        resolved_class.const_get(class_part)
       end
+    end
 
-      def variable_name_to_class_name(name)
-        name_string = name.to_s
+    def extract_options!(args)
+      args.last.is_a?(::Hash) ? args.pop : {}
+    end
 
-        if name_string.respond_to?(:camelize)
-          name_string.camelize
-        else
-          name_string.gsub(%r{/(.?)}) do
-            "::#{Regexp.last_match(1).upcase}"
-          end.gsub(/(?:^|_)(.)/) { Regexp.last_match(1).upcase }
-        end
-      end
+    def variable_name_to_class_name(name)
+      name_string = name.to_s
 
-      def find_definitions
-        puts 'DEPRECATION WARNING: Fabrication::Support.find_definitions has been replaced ' \
-             'by Fabrication.manager.load_definitions and will be removed in 3.0.0.'
-        Fabrication.manager.load_definitions
+      if name_string.respond_to?(:camelize)
+        name_string.camelize
+      else
+        name_string
+          .gsub(%r{/(.?)}) { "::#{Regexp.last_match(1).upcase}" }
+          .gsub(/(?:^|_)(.)/) { Regexp.last_match(1).upcase }
       end
+    end
 
-      def hash_class
-        @hash_class ||= defined?(HashWithIndifferentAccess) ? HashWithIndifferentAccess : Hash
-      end
+    def find_definitions
+      log_deprecation('Fabrication::Support.find_definitions has been replaced by ' \
+                      'Fabrication.manager.load_definitions and will be removed in 3.0.0.')
 
-      def singularize(string)
-        string.singularize
-      rescue StandardError
-        string.end_with?('s') ? string[0..-2] : string
-      end
+      Fabrication.manager.load_definitions
+    end
 
-      def underscore(string)
-        string.gsub(/::/, '/')
-              .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-              .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-              .tr('-', '_')
-              .downcase
-      end
+    def hash_class
+      @hash_class ||= defined?(HashWithIndifferentAccess) ? HashWithIndifferentAccess : Hash
+    end
+
+    def singularize(string)
+      string.singularize
+    rescue StandardError
+      string.end_with?('s') ? string[0..-2] : string
+    end
+
+    def underscore(string)
+      string.gsub(/::/, '/')
+            .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+            .tr('-', '_')
+            .downcase
     end
   end
 end

data/lib/fabrication/transform.rb

@@ -1,37 +1,39 @@
+require 'singleton'
+
 module Fabrication
   class Transform
+    include Singleton
+
     class << self
       def apply_to(schematic, attributes_hash)
         Fabrication.manager.load_definitions if Fabrication.manager.empty?
-        attributes_hash.inject({}) { |h, (k, v)| h.update(k => apply_transform(schematic, k, v)) }
+        attributes_hash.inject({}) { |h, (k, v)| h.update(k => instance.apply_transform(schematic, k, v)) }
       end
 
       def clear_all
-        @transforms = nil
-        @overrides = nil
+        instance.transforms.clear
+        instance.overrides.clear
       end
 
       def define(attribute, transform)
-        transforms[attribute] = transform
+        instance.transforms[attribute] = transform
       end
 
       def only_for(schematic, attribute, transform)
-        overrides[schematic] = (overrides[schematic] || {}).merge!(attribute => transform)
+        instance.overrides[schematic] = (instance.overrides[schematic] || {}).merge!(attribute => transform)
       end
+    end
 
-      private
-
-      def overrides
-        @overrides ||= {}
-      end
+    def overrides
+      @overrides ||= {}
+    end
 
-      def apply_transform(schematic, attribute, value)
-        overrides.fetch(schematic, transforms)[attribute].call(value)
-      end
+    def apply_transform(schematic, attribute, value)
+      overrides.fetch(schematic, transforms)[attribute].call(value)
+    end
 
-      def transforms
-        @transforms ||= Hash.new(->(value) { value })
-      end
+    def transforms
+      @transforms ||= Hash.new(->(value) { value })
     end
   end
 end

data/lib/fabrication/version.rb

@@ -1,3 +1,3 @@
 module Fabrication
-  VERSION = '2.27.0'.freeze
+  VERSION = '2.30.0'.freeze
 end

data/lib/fabrication.rb

@@ -31,7 +31,6 @@ module Fabrication
 
   module Generator
     autoload :ActiveRecord,  'fabrication/generator/active_record'
-    autoload :ActiveRecord4, 'fabrication/generator/active_record_4'
     autoload :DataMapper,    'fabrication/generator/data_mapper'
     autoload :Mongoid,       'fabrication/generator/mongoid'
     autoload :Sequel,        'fabrication/generator/sequel'
@@ -40,7 +39,7 @@ module Fabrication
 
   def self.clear_definitions
     manager.clear
-    Sequencer.sequences.clear
+    Sequencer.clear
   end
 
   def self.configure(&block)
@@ -48,12 +47,12 @@ module Fabrication
   end
 
   def self.manager
-    @manager ||= Fabrication::Schematic::Manager.instance
+    Fabrication::Schematic::Manager.instance
   end
 
   def self.schematics
-    puts 'DEPRECATION WARNING: Fabrication.schematics has been replaced by '\
-         'Fabrication.manager and will be removed in 3.0.0.'
+    Support.log_deprecation('Fabrication.schematics has been replaced by ' \
+                            'Fabrication.manager and will be removed in 3.0.0.')
     manager
   end
 end

data/lib/rails/generators/fabrication/cucumber_steps/cucumber_steps_generator.rb

@@ -8,7 +8,7 @@ module Fabrication
       end
 
       def self.source_root
-        @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+        File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
       end
     end
   end

data/lib/rails/generators/fabrication/model/model_generator.rb

@@ -19,7 +19,7 @@ module Fabrication
       end
 
       def self.source_root
-        @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+        File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
       end
 
       private
@@ -33,6 +33,8 @@ module Fabrication
         end
       rescue StandardError
         # no table? no problem!
+      rescue LoadError
+        # cannot find model file. This means it was already destroyed, so just continue.
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fabrication
 version: !ruby/object:Gem::Version
-  version: 2.27.0
+  version: 2.30.0
 platform: ruby
 authors:
 - Paul Elliott
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-03 00:00:00.000000000 Z
+date: 2022-07-25 00:00:00.000000000 Z
 dependencies: []
 description: Fabrication is an object generation framework for ActiveRecord, Mongoid,
   DataMapper, Sequel, or any other Ruby object.
@@ -70,14 +70,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Generates object instances for test suites, seed files, etc.