rom-factory 0.4.0 → 0.5.0

data/lib/rom/factory/factories.rb

@@ -4,28 +4,56 @@ require 'dry/core/inflector'
 require 'rom/factory/dsl'
 
 module ROM::Factory
+  # In-memory builder API
+  #
+  # @api public
   class Structs
+    # @!attribute [r] registry
+    #   @return [Hash<Symbol=>Builder>]
     attr_reader :registry
 
+    # @api private
     def initialize(registry)
       @registry = registry
     end
 
+    # Build an in-memory struct
+    #
+    # @example create a struct with default attributes
+    #   MyFactory[:user]
+    #
+    # @example create a struct with some attributes overridden
+    #   MyFactory.structs[:user, name: "Jane"]
+    #
+    # @param [Symbol] name The name of the registered factory
+    # @param [Hash] attrs An optional hash with attributes
+    #
+    # @return [ROM::Struct]
+    #
+    # @api public
     def [](name, attrs = {})
       registry[name].create(attrs)
     end
   end
 
+  # A registry with all configured factories
+  #
+  # @api public
   class Factories
     extend Dry::Configurable
 
     setting :rom
 
     class << self
+      # @!attribute [r] registry
+      #   @return [Hash<Symbol=>Builder>]
       attr_reader :registry
 
+      # @!attribute [r] structs
+      #   @return [Structs] In-memory struct builder instance
       attr_reader :structs
 
+      # @api private
       def inherited(klass)
         registry = {}
         klass.instance_variable_set(:'@registry', registry)
@@ -33,6 +61,68 @@ module ROM::Factory
         super
       end
 
+      # Define a new builder
+      #
+      # @example a simple builder
+      #   MyFactory.define(:user) do |f|
+      #     f.name "Jane"
+      #     f.email "jane@doe.org"
+      #   end
+      #
+      # @example a builder using auto-generated fake values
+      #   MyFactory.define(:user) do |f|
+      #     f.name { fake(:name) }
+      #     f.email { fake(:internet, :email) }
+      #   end
+      #
+      # @example a builder using sequenced values
+      #   MyFactory.define(:user) do |f|
+      #     f.sequence(:name) { |n| "user-#{n}" }
+      #   end
+      #
+      # @example a builder using values from other attribute(s)
+      #   MyFactory.define(:user) do |f|
+      #     f.name "Jane"
+      #     f.email { |name| "#{name.downcase}@rom-rb.org" }
+      #   end
+      #
+      # @example a builder with "belongs-to" association
+      #   MyFactory.define(:group) do |f|
+      #     f.name "Admins"
+      #   end
+      #
+      #   MyFactory.define(:user) do |f|
+      #     f.name "Jane"
+      #     f.association(:group)
+      #   end
+      #
+      # @example a builder with "has-many" association
+      #   MyFactory.define(:group) do |f|
+      #     f.name "Admins"
+      #     f.association(:users, count: 2)
+      #   end
+      #
+      #   MyFactory.define(:user) do |f|
+      #     f.sequence(:name) { |n| "user-#{n}" }
+      #   end
+      #
+      # @example a builder which extends another builder
+      #   MyFactory.define(:user) do |f|
+      #     f.name "Jane"
+      #     f.admin false
+      #   end
+      #
+      #   MyFactory.define(admin: :user) do |f|
+      #     f.admin true
+      #   end
+      #
+      # @param [Symbol, Hash<Symbol=>Symbol>] spec Builder identifier, can point to a parent builder too
+      # @param [Hash] opts Additional options
+      # @option opts [Symbol] relation An optional relation name (defaults to pluralized builder name)
+      #
+      # @return [ROM::Factory::Builder]
+      #
+      # @api public
       def define(spec, **opts, &block)
         name, parent = spec.is_a?(Hash) ? spec.flatten(1) : spec
 
@@ -52,16 +142,42 @@ module ROM::Factory
         registry[name] = builder
       end
 
+      # Create and persist a new struct
+      #
+      # @example create a struct with default attributes
+      #   MyFactory[:user]
+      #
+      # @example create a struct with some attributes overridden
+      #   MyFactory[:user, name: "Jane"]
+      #
+      # @param [Symbol] name The name of the registered factory
+      # @param [Hash] attrs An optional hash with attributes
+      #
+      # @return [ROM::Struct]
+      #
+      # @api public
+      def [](name, attrs = {})
+        registry[name].persistable.create(attrs)
+      end
+
+      # @api private
+      def for_relation(relation)
+        registry.fetch(infer_factory_name(relation.name.to_sym))
+      end
+
+      # @api private
+      def infer_factory_name(name)
+        ::Dry::Core::Inflector.singularize(name).to_sym
+      end
+
+      # @api private
       def infer_relation(name)
         ::Dry::Core::Inflector.pluralize(name).to_sym
       end
 
+      # @api private
       def extend_builder(name, parent, &block)
-        DSL.new(name, schema: parent.schema, relation: parent.relation, factories: self, &block).call
-      end
-
-      def [](name, attrs = {})
-        registry[name].persistable.create(attrs)
+        DSL.new(name, attributes: parent.attributes, relation: parent.relation, factories: self, &block).call
       end
     end
   end

data/lib/rom/factory/tuple_evaluator.rb

@@ -0,0 +1,104 @@
+module ROM
+  module Factory
+    # @api private
+    class TupleEvaluator
+      # @api private
+      attr_reader :attributes
+
+      # @api private
+      attr_reader :relation
+
+      # @api private
+      attr_reader :model
+
+      # @api private
+      attr_reader :sequence
+
+      # @api private
+      def initialize(attributes, relation)
+        @attributes = attributes
+        @relation = relation.with(auto_struct: true)
+        @model = @relation.combine(*assoc_names).mapper.model
+        @sequence = 0
+      end
+
+      # @api private
+      def defaults(attrs)
+        evaluate(attrs).merge(attrs)
+      end
+
+      # @api private
+      def struct(attrs)
+        model.new(struct_attrs.merge(defaults(attrs)))
+      end
+
+      # @api private
+      def persist_associations(tuple, parent)
+        assoc_names.each do |name|
+          assoc = tuple[name]
+          assoc.(parent) if assoc.is_a?(Proc)
+        end
+      end
+
+      # @api private
+      def assoc_names
+        attributes.associations.map(&:name)
+      end
+
+      # @api private
+      def has_associations?
+        assoc_names.size > 0
+      end
+
+      # @api private
+      def primary_key
+        relation.primary_key
+      end
+
+      private
+
+      # @api private
+      def evaluate(attrs)
+        evaluate_values(attrs).merge(evaluate_associations(attrs))
+      end
+
+      # @api private
+      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)
+
+          if result
+            h.update(result)
+          end
+        end
+      end
+
+      # @api private
+      def evaluate_associations(attrs)
+        attributes.associations.each_with_object({}) do |assoc, h|
+          if assoc.dependency?(relation)
+            h[assoc.name] = -> parent { assoc.call(parent) }
+          else
+            result = assoc.(attrs)
+            h.update(result) if result
+          end
+        end
+      end
+
+      # @api private
+      def struct_attrs
+        relation.schema.
+          reject(&:primary_key?).
+          map { |attr| [attr.name, nil] }.
+          to_h.
+          merge(primary_key => next_id)
+      end
+
+      # @api private
+      def next_id
+        @sequence += 1
+      end
+    end
+  end
+end

data/lib/rom/factory/version.rb

@@ -1,5 +1,5 @@
 module ROM
   module Factory
-    VERSION = '0.4.0'.freeze
+    VERSION = '0.5.0'.freeze
   end
 end

data/rom-factory.gemspec

@@ -27,8 +27,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "dry-configurable", "~> 0.1"
-  spec.add_dependency "dry-core", "~> 0.2"
-  spec.add_dependency "dry-struct", "~> 0.2"
+  spec.add_dependency "dry-configurable", "~> 0.7"
+  spec.add_dependency "dry-core", "~> 0.3", ">= 0.3.1"
+  spec.add_dependency "dry-struct", "~> 0.3"
+  spec.add_dependency "rom-core", "~> 4.0"
   spec.add_dependency "faker", "~> 1.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rom-factory
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Janis Miezitis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-03 00:00:00.000000000 Z
+date: 2017-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -17,42 +17,62 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: dry-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: dry-struct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rom-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
@@ -78,21 +98,27 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmarks/basic.rb
 - lib/rom-factory.rb
 - lib/rom/factory.rb
+- lib/rom/factory/attribute_registry.rb
+- lib/rom/factory/attributes.rb
+- lib/rom/factory/attributes/association.rb
 - lib/rom/factory/attributes/callable.rb
-- lib/rom/factory/attributes/regular.rb
 - lib/rom/factory/attributes/sequence.rb
+- lib/rom/factory/attributes/value.rb
 - lib/rom/factory/builder.rb
+- lib/rom/factory/builder/persistable.rb
 - lib/rom/factory/dsl.rb
 - lib/rom/factory/factories.rb
-- lib/rom/factory/struct.rb
+- lib/rom/factory/tuple_evaluator.rb
 - lib/rom/factory/version.rb
 - rom-factory.gemspec
 homepage: https://github.com/rom-rb/rom-factory
@@ -116,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.9
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: ROM based builder library to make your specs awesome. DSL partially inspired

data/lib/rom/factory/attributes/regular.rb

@@ -1,13 +0,0 @@
-module ROM::Factory
-  module Attributes
-    class Regular
-      def initialize(value)
-        @value = value
-      end
-
-      def call
-        @value
-      end
-    end
-  end
-end

data/lib/rom/factory/struct.rb

@@ -1,21 +0,0 @@
-require 'dry/struct'
-require 'dry/core/cache'
-require 'dry/core/class_builder'
-
-module ROM::Factory
-  class Struct < Dry::Struct
-    extend Dry::Core::Cache
-
-    def self.define(name, schema)
-      fetch_or_store(schema) do
-        id = Dry::Core::Inflector.classify(Dry::Core::Inflector.singularize(name))
-
-        Dry::Core::ClassBuilder.new(name: "ROM::Factory::Struct[#{id}]", parent: self).call do |klass|
-          schema.each do |attr|
-            klass.attribute attr.name, attr.type
-          end
-        end
-      end
-    end
-  end
-end