rom-factory 0.10.2 → 0.12.0

data/lib/rom/factory/builder/persistable.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'delegate'
+require "delegate"
 
 module ROM
   module Factory
@@ -21,11 +21,10 @@ module ROM
         end
 
         # @api private
-        def create(*args)
-          traits, attrs = builder.extract_tuple(args)
-
-          tuple = tuple(*traits, attrs)
+        def create(*traits, **attrs)
           validate_keys(traits, attrs)
+
+          tuple = tuple(*traits, **attrs)
           persisted = persist(tuple)
 
           if tuple_evaluator.has_associations?(traits)
@@ -43,13 +42,29 @@ module ROM
 
         # @api private
         def persist(attrs)
-          relation.with(auto_struct: !tuple_evaluator.has_associations?).command(:create).call(attrs)
+          result = relation
+            .with(auto_struct: !tuple_evaluator.has_associations?)
+            .command(:create)
+            .call(attrs)
+
+          # Handle PK values generated by the factory
+          if pk? && (pks = attrs.values_at(*primary_key_names)).compact.size == primary_key_names.size
+            relation.by_pk(*pks).one!
+          elsif result
+            result
+          else
+            relation.where(attrs).one!
+          end
         end
 
         # @api private
         def primary_key_names
           relation.schema.primary_key.map(&:name)
         end
+
+        def pk?
+          primary_key_names.any?
+        end
       end
     end
   end

data/lib/rom/factory/builder.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
-require 'dry/core/constants'
-
-require 'rom/struct'
-require 'rom/initializer'
-require 'rom/factory/tuple_evaluator'
-require 'rom/factory/builder/persistable'
+require "rom/struct"
+require "rom/initializer"
+require "rom/factory/tuple_evaluator"
+require "rom/factory/builder/persistable"
 
 module ROM::Factory
   # @api private
@@ -30,19 +28,20 @@ module ROM::Factory
     #   @return [Module] Custom struct namespace
     option :struct_namespace, reader: false
 
-    # @api private
-    def tuple(*args)
-      traits, attrs = extract_tuple(args)
+    # @!attribute [r] factories
+    #   @return [Module] Factories with other builders
+    option :factories, reader: true, optional: true
 
+    # @api private
+    def tuple(*traits, **attrs)
       tuple_evaluator.defaults(traits, attrs)
     end
 
     # @api private
-    def struct(*args)
-      traits, attrs = extract_tuple(args)
+    def struct(*traits, **attrs)
       validate_keys(traits, attrs, allow_associations: true)
 
-      tuple_evaluator.struct(*args)
+      tuple_evaluator.struct(*traits, **attrs)
     end
     alias_method :create, :struct
 
@@ -62,7 +61,11 @@ module ROM::Factory
 
     # @api private
     def tuple_evaluator
-      @__tuple_evaluator__ ||= TupleEvaluator.new(attributes, tuple_evaluator_relation, traits)
+      @__tuple_evaluator__ ||= TupleEvaluator.new(
+        attributes,
+        tuple_evaluator_relation,
+        traits
+      )
     end
 
     # @api private
@@ -75,18 +78,13 @@ module ROM::Factory
       tuple_evaluator.relation
     end
 
-    # @api private
-    def extract_tuple(args)
-      tuple_evaluator.extract_tuple(args)
-    end
-
     # @api private
     def validate_keys(traits, tuple, allow_associations: false)
       schema_keys = relation.schema.attributes.map(&:name)
       assoc_keys = tuple_evaluator.assoc_names(traits)
       unknown_keys = tuple.keys - schema_keys - assoc_keys
 
-      unknown_keys = unknown_keys - relation.schema.associations.to_h.keys if allow_associations
+      unknown_keys -= relation.schema.associations.to_h.keys if allow_associations
 
       raise UnknownFactoryAttributes, unknown_keys unless unknown_keys.empty?
     end

data/lib/rom/factory/constants.rb

@@ -10,7 +10,7 @@ module ROM
 
     class UnknownFactoryAttributes < StandardError
       def initialize(attrs)
-        super("Unknown attributes: #{attrs.join(', ')}")
+        super("Unknown attributes: #{attrs.join(", ")}")
       end
     end
   end

data/lib/rom/factory/dsl.rb

@@ -1,26 +1,30 @@
 # frozen_string_literal: true
 
-require 'faker'
-require 'dry/core/inflector'
+require "faker"
 
-require 'rom/factory/builder'
-require 'rom/factory/attribute_registry'
-require 'rom/factory/attributes'
+require "rom/factory/builder"
+require "rom/factory/attribute_registry"
+require "rom/factory/attributes"
 
 module ROM
   module Factory
+    extend ::Dry::Core::Cache
+
     class << self
       # @api private
-      def fake(type, *args)
-        api = ::Faker.const_get(::Dry::Core::Inflector.classify(type.to_s))
+      def fake(*args, **options)
+        api = fetch_or_store(:faker, *args) do
+          *ns, method_name = args
 
-        if args[0].is_a?(Symbol)
-          api.public_send(*args)
-        else
-          api.public_send(type, *args)
+          const = ns.reduce(::Faker) do |obj, name|
+            obj.const_get(::Dry::Core::Inflector.camelize(name))
+          end
+
+          const.method(method_name)
         end
+
+        api.(**options)
       end
-      ruby2_keywords(:fake) if respond_to?(:ruby2_keywords, true)
     end
 
     # Factory builder DSL
@@ -33,7 +37,7 @@ module ROM
       attr_reader :_traits
 
       # @api private
-      def initialize(name, attributes: AttributeRegistry.new, relation:, factories:, struct_namespace:)
+      def initialize(name, relation:, factories:, struct_namespace:, attributes: AttributeRegistry.new)
         @_name = name
         @_relation = relation
         @_factories = factories
@@ -46,7 +50,13 @@ module ROM
 
       # @api private
       def call
-        ::ROM::Factory::Builder.new(_attributes, _traits, relation: _relation, struct_namespace: _struct_namespace)
+        ::ROM::Factory::Builder.new(
+          _attributes,
+          _traits,
+          relation: _relation,
+          struct_namespace: _struct_namespace,
+          factories: _factories
+        )
       end
 
       # Delegate to a builder and persist a struct
@@ -83,28 +93,36 @@ module ROM
       #
       #   @param [Symbol] type The value type to generate
       #
-      # @overload fake(api, type)
+      # @overload fake(genre, type)
       #   @example
       #     f.email { fake(:internet, :email) }
       #
-      #   @param [Symbol] api The faker API identifier ie. :internet, :product etc.
+      #   @param [Symbol] genre The faker API identifier ie. :internet, :product etc.
       #   @param [Symbol] type The value type to generate
       #
-      # @overload fake(api, type, *args)
+      # @overload fake(genre, type, **options)
       #   @example
-      #     f.email { fake(:number, :between, 10, 100) }
+      #     f.email { fake(:number, :between, from: 10, to: 100) }
       #
-      #   @param [Symbol] api The faker API identifier ie. :internet, :product etc.
+      #   @param [Symbol] genre The faker API identifier ie. :internet, :product etc.
       #   @param [Symbol] type The value type to generate
-      #   @param [Array] args Additional arguments
+      #   @param [Hash] options Additional arguments
+      #
+      # @overload fake(genre, subgenre, type, **options)
+      #   @example
+      #     f.quote { fake(:books, :dune, :quote, character: 'stilgar') }
+      #
+      #   @param [Symbol] genre The Faker genre of API i.e. :books, :creature, :games etc
+      #   @param [Symbol] subgenre The subgenre of API i.e. :dune, :bird, :myst etc
+      #   @param [Symbol] type the value type to generate
+      #   @param [Hash] options Additional arguments
       #
-      # @see https://github.com/stympy/faker/tree/master/doc
+      # @see https://github.com/faker-ruby/faker/tree/master/doc
       #
       # @api public
-      def fake(*args)
-        ::ROM::Factory.fake(*args)
+      def fake(type, *args, **options)
+        ::ROM::Factory.fake(type, *args, **options)
       end
-      ruby2_keywords(:fake) if respond_to?(:ruby2_keywords, true)
 
       def trait(name, parents = [], &block)
         _traits[name] = DSL.new(
@@ -136,7 +154,7 @@ module ROM
         assoc = _relation.associations[name]
 
         if assoc.is_a?(::ROM::SQL::Associations::OneToOne) && options.fetch(:count, 1) > 1
-          ::Kernel.raise ::ArgumentError, 'count cannot be greater than 1 on a OneToOne'
+          ::Kernel.raise ::ArgumentError, "count cannot be greater than 1 on a OneToOne"
         end
 
         builder = -> { _factories.for_relation(assoc.target) }

data/lib/rom/factory/factories.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 
-require 'dry/configurable'
-require 'dry/core/inflector'
-
-require 'rom/initializer'
-require 'rom/struct'
-require 'rom/factory/dsl'
-require 'rom/factory/registry'
+require "rom/initializer"
+require "rom/struct"
+require "rom/factory/dsl"
+require "rom/factory/registry"
 
 module ROM::Factory
   # In-memory builder API
@@ -42,7 +39,7 @@ module ROM::Factory
     #
     # @api public
     def [](name, *traits, **attrs)
-      registry[name].struct_namespace(struct_namespace).create(*traits, attrs)
+      registry[name].struct_namespace(struct_namespace).create(*traits, **attrs)
     end
   end
 
@@ -147,7 +144,7 @@ module ROM::Factory
             name,
             relation: relation,
             factories: self,
-            struct_namespace: builder_sturct_namespace(namespace),
+            struct_namespace: builder_struct_namespace(namespace),
             &block
           ).call
         end
@@ -164,13 +161,14 @@ module ROM::Factory
     #   MyFactory[:user, name: "Jane"]
     #
     # @param [Symbol] name The name of the registered factory
-    # @param [Hash] attrs An optional hash with attributes
+    # @param [Array<Symbol>] traits List of traits to apply
+    # @param [Hash] attrs optional attributes to override the defaults
     #
     # @return [ROM::Struct]
     #
     # @api public
-    def [](name, *args)
-      registry[name].struct_namespace(struct_namespace).persistable.create(*args)
+    def [](name, *traits, **attrs)
+      registry[name].struct_namespace(struct_namespace).persistable.create(*traits, **attrs)
     end
 
     # Return in-memory struct builder
@@ -204,8 +202,8 @@ module ROM::Factory
     end
 
     # @api private
-    def builder_sturct_namespace(ns)
-      ns ? { namespace: ns, overridable: false } : { namespace: struct_namespace, overridable: true }
+    def builder_struct_namespace(ns)
+      ns ? {namespace: ns, overridable: false} : {namespace: struct_namespace, overridable: true}
     end
 
     # @api private
@@ -226,7 +224,7 @@ module ROM::Factory
     # @api private
     def extend_builder(name, parent, relation_name, ns, &block)
       namespace = parent.options[:struct_namespace]
-      namespace = builder_sturct_namespace(ns) if ns
+      namespace = builder_struct_namespace(ns) if ns
       relation = rom.relations.fetch(relation_name) { parent.relation }
       DSL.new(
         name,

data/lib/rom/factory/registry.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rom/factory/constants'
+require "rom/factory/constants"
 
 module ROM
   module Factory
@@ -28,7 +28,7 @@ module ROM
       # @api private
       def [](name)
         elements.fetch(name) do
-          raise FactoryNotDefinedError.new(name)
+          raise FactoryNotDefinedError, name
         end
       end
     end

data/lib/rom/factory/sequences.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require 'singleton'
+require "concurrent/map"
+require "singleton"
 
 module ROM
   module Factory
@@ -24,12 +25,12 @@ module ROM
 
       # @api private
       def next(key)
-        registry[key] += 1
+        registry.compute(key) { |v| (v || 0).succ }
       end
 
       # @api private
       def reset
-        @registry = Concurrent::Map.new { |h, k| h[k] = 0 }
+        @registry = Concurrent::Map.new
         self
       end
     end

data/lib/rom/factory/tuple_evaluator.rb

@@ -1,11 +1,34 @@
 # frozen_string_literal: true
 
-require 'rom/factory/sequences'
+require "rom/factory/sequences"
 
 module ROM
   module Factory
     # @api private
     class TupleEvaluator
+      class TupleEvaluatorError < StandardError
+        attr_reader :original_exception
+
+        def initialize(relation, original_exception, attrs, traits, assoc_attrs)
+          super(<<~STR)
+            Failed to build attributes for #{relation.name}
+
+            Attributes:
+              #{attrs.inspect}
+
+            Associations:
+              #{assoc_attrs}
+
+            Traits:
+              #{traits.inspect}
+
+            Original exception: #{original_exception.message}
+          STR
+
+          set_backtrace(original_exception.backtrace)
+        end
+      end
+
       # @api private
       attr_reader :attributes
 
@@ -15,9 +38,6 @@ module ROM
       # @api private
       attr_reader :traits
 
-      # @api private
-      attr_reader :model
-
       # @api private
       attr_reader :sequence
 
@@ -26,18 +46,21 @@ module ROM
         @attributes = attributes
         @relation = relation.with(auto_struct: true)
         @traits = traits
-        @model = @relation.combine(*assoc_names).mapper.model
         @sequence = Sequences[relation]
       end
 
+      def model(traits, combine: assoc_names(traits))
+        @relation.combine(*combine).mapper.model
+      end
+
       # @api private
-      def defaults(traits, attrs, opts = EMPTY_HASH)
-        evaluate(traits, attrs, opts).merge(attrs)
+      def defaults(traits, attrs, **opts)
+        mergeable_attrs = select_mergeable_attrs(traits, attrs)
+        evaluate(traits, attrs, opts).merge(mergeable_attrs)
       end
 
       # @api private
-      def struct(*args)
-        traits, attrs = extract_tuple(args)
+      def struct(*traits, **attrs)
         merged_attrs = struct_attrs.merge(defaults(traits, attrs, persist: false))
         is_callable = proc { |_name, value| value.respond_to?(:call) }
 
@@ -45,21 +68,41 @@ module ROM
         attributes = merged_attrs.reject(&is_callable)
 
         materialized_callables = {}
-        callables.each do |_name, callable|
+        callables.each_value do |callable|
           materialized_callables.merge!(callable.call(attributes, persist: false))
         end
 
         attributes.merge!(materialized_callables)
 
-        associations = assoc_names
-          .map { |key| [key, attributes[key]] if attributes.key?(key) }
-          .compact
+        assoc_attrs = attributes.slice(*assoc_names(traits)).merge(
+          assoc_names(traits)
+            .select { |key|
+              build_assoc?(key, attributes)
+            }
+            .map { |key|
+              [key, build_assoc_attrs(key, attributes[relation.primary_key], attributes[key])]
+            }
           .to_h
+        )
+
+        model_attrs = relation.output_schema[attributes]
+        model_attrs.update(assoc_attrs)
+
+        model(traits).new(**model_attrs)
+      rescue StandardError => e
+        raise TupleEvaluatorError.new(relation, e, attrs, traits, assoc_attrs)
+      end
 
-        attributes = relation.output_schema[attributes]
-        attributes.update(associations)
+      def build_assoc?(name, attributes)
+        attributes.key?(name) && attributes[name] != [] && !attributes[name].nil?
+      end
 
-        model.new(attributes)
+      def build_assoc_attrs(key, fk, value)
+        if value.is_a?(Array)
+          value.map { |el| build_assoc_attrs(key, fk, el) }
+        else
+          {attributes[key].foreign_key => fk}.merge(value.to_h)
+        end
       end
 
       # @api private
@@ -76,10 +119,15 @@ module ROM
       end
 
       def assocs(traits_names = [])
-        traits
+        found_assocs = traits
           .values_at(*traits_names)
+          .compact
           .map(&:associations).flat_map(&:elements)
           .inject(AttributeRegistry.new(attributes.associations.elements), :<<)
+
+        exclude = traits_names.select { |t| t.is_a?(Hash) }.reduce(:merge) || EMPTY_HASH
+
+        found_assocs.reject { |a| exclude[a.name] == false }
       end
 
       # @api private
@@ -92,28 +140,17 @@ module ROM
         relation.primary_key
       end
 
-      # @api private
-      def extract_tuple(args)
-        if !args.empty? && args.last.is_a?(::Hash)
-          *traits, attrs = args
-
-          [traits, attrs]
-        else
-          [args, EMPTY_HASH]
-        end
-      end
-
       private
 
       # @api private
       def evaluate(traits, attrs, opts)
-        evaluate_values(attrs, opts)
-          .merge(evaluate_associations(attrs, opts))
+        evaluate_values(attrs)
+          .merge(evaluate_associations(traits, attrs, opts))
           .merge(evaluate_traits(traits, attrs, opts))
       end
 
       # @api private
-      def evaluate_values(attrs, opts)
+      def evaluate_values(attrs)
         attributes.values.tsort.each_with_object({}) do |attr, h|
           deps = attr.dependency_names.map { |k| h[k] }.compact
           result = attr.(attrs, *deps)
@@ -124,33 +161,38 @@ module ROM
         end
       end
 
-      def evaluate_traits(traits, attrs, opts)
-        return {} if traits.empty?
+      def evaluate_traits(trait_list, attrs, opts)
+        return {} if trait_list.empty?
+
+        traits = trait_list.map { |v| v.is_a?(Hash) ? v : {v => true} }.reduce(:merge)
 
-        traits_attrs = self.traits.values_at(*traits).flat_map(&:elements)
+        traits_attrs = self.traits.select { |key, _value| traits[key] }.values.flat_map(&:elements)
         registry = AttributeRegistry.new(traits_attrs)
-        self.class.new(registry, relation).defaults([], attrs, opts)
+
+        self.class.new(registry, relation).defaults([], attrs, **opts)
       end
 
       # @api private
-      def evaluate_associations(attrs, opts)
-        attributes.associations.each_with_object({}) do |assoc, h|
-          if assoc.dependency?(relation)
-            h[assoc.name] = ->(parent, call_opts) do
+      def evaluate_associations(traits, attrs, opts)
+        assocs(traits).associations.each_with_object({}) do |assoc, memo|
+          if attrs.key?(assoc.name) && attrs[assoc.name].nil?
+            memo
+          elsif assoc.dependency?(relation)
+            memo[assoc.name] = ->(parent, call_opts) do
               assoc.call(parent, **opts, **call_opts)
             end
           else
             result = assoc.(attrs, **opts)
-            h.update(result) if result
+            memo.update(result) if result
           end
         end
       end
 
       # @api private
       def struct_attrs
-        struct_attrs = relation.schema.
-          reject(&:primary_key?).
-          map { |attr| [attr.name, nil] }.to_h
+        struct_attrs = relation.schema
+          .reject(&:primary_key?)
+          .map { |attr| [attr.name, nil] }.to_h
 
         if primary_key
           struct_attrs.merge(primary_key => next_id)
@@ -163,6 +205,13 @@ module ROM
       def next_id
         sequence.()
       end
+
+      def select_mergeable_attrs(traits, attrs)
+        unmergeable = assocs(traits).select(&:through?).map do |a|
+          Dry::Core::Inflector.singularize(a.assoc.target.name.to_sym).to_sym
+        end
+        attrs.dup.delete_if { |key, _| unmergeable.include?(key) }
+      end
     end
   end
 end

data/lib/rom/factory/version.rb

@@ -2,6 +2,6 @@
 
 module ROM
   module Factory
-    VERSION = '0.10.2'
+    VERSION = "0.12.0"
   end
 end

data/lib/rom/factory.rb

@@ -1,14 +1,17 @@
 # frozen_string_literal: true
 
-require 'dry/core/class_builder'
-require 'rom/factory/factories'
+require "dry/core"
+require "dry/configurable"
+require "dry/struct"
+
+require "rom/factory/factories"
 
 module ROM
   # Main ROM::Factory API
   #
   # @api public
   module Factory
-    DEFAULT_NAME = 'Factories'.freeze
+    DEFAULT_NAME = "Factories"
 
     # Configure a new factory
     #
@@ -23,8 +26,8 @@ module ROM
     #
     # @api public
     def self.configure(name = DEFAULT_NAME, &block)
-      klass = Dry::Core::ClassBuilder.new(name: name, parent: Factories).call do |klass|
-        klass.configure(&block)
+      klass = Dry::Core::ClassBuilder.new(name: name, parent: Factories).call do |c|
+        c.configure(&block)
       end
 
       klass.new(klass.config.rom)

data/lib/rom-factory.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require 'rom/factory'
+require "rom/factory"

data/project.yml

@@ -1,2 +1,3 @@
 name: rom-factory
+custom_ci: true
 codacy_id: 5fd26fae687549218458879b1a607e18