rom-factory 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b0e9af2bccde24058817960957099aa19a54cda9
-  data.tar.gz: f99643318992b7df49913638a47043086a992519
+SHA256:
+  metadata.gz: f5b3b45c040487ccf89d27457241ba3b117e51ed1a346e089d0da8f6bb223fb1
+  data.tar.gz: c56f6cac0fd002de3cb4b34e272704086cf4fd196e66e3931c82c9a17fbccfe1
 SHA512:
-  metadata.gz: 6f8a9de64072548a7e3597000b27898d4a6041f6e999be10837ef917a56ae0bade2437bc8cd85b260e9bee006e8f7042ceb6792e65e22e602dd356bea54d6c59
-  data.tar.gz: a809541e1f0bb8a36b8c6b7ee7c3f41f0e36c9964bb70aebd072cfc1c78658fb8b4d31e46b912bcfbae5e5a629d57e3d9c8ba4139c6c6fc636efc0198033161e
+  metadata.gz: decd39e777394bdc13022f9ae17c2a340bf325d66950c7487b6ffc60505e4b1097d437fc9e0a8cda287ac2e47aef71145ea5191d26b8d8d6fa6ecb9581e0fdd9
+  data.tar.gz: 2c2d34cfe48bcc3909b3599ea8fa241ae974c4993e021bcfdededbdba5a5c0f62e4a91a393033173ba649fcb74e3ded0458562d426c2b3b948275b1cc5639da6

data/.codeclimate.yml

@@ -0,0 +1,6 @@
+engines:
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+    - lib/**

data/.travis.yml

@@ -10,8 +10,9 @@ script: "bundle exec rake spec"
 after_success:
   - '[ -d coverage ] && bundle exec codeclimate-test-reporter'
 rvm:
-  - 2.3.4
-  - 2.4.1
+  - 2.5.0
+  - 2.4.2
+  - 2.3.6
   - jruby-9.1.13.0
 env:
   global:

data/CHANGELOG.md

@@ -1,4 +1,20 @@
-## 0.5.0 to-be-released
+## 0.6.0 2018-01-31
+
+### Added
+
+* Support for factories with custom struct namespaces (solnic)
+
+### Changed
+
+* Accessing a factory which is not defined will result in `FactoryNotDefinedError` exception (GustavoCaso + solnic)
+
+### Fixed
+
+* Using dependent attributes with sequences works correctly, ie `f.sequence(:login) { |i, name| "name-#{i}"}` (solnic)
+
+[Compare v0.5.0...v0.6.0](https://github.com/rom-rb/rom-factory/compare/v0.5.0...v0.6.0)
+
+## 0.5.0 2017-10-24
 
 ### Added
 

data/Gemfile

@@ -3,29 +3,21 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake', '~> 12.0'
-gem 'simplecov', require: false, platform: :mri
-gem 'codeclimate-test-reporter', require: false, platform: :mri
-
 gem 'rspec', '~> 3.0'
 
 group :test do
   gem 'rom-sql', '~> 2.1'
   gem 'inflecto'
   gem 'pry-byebug', platforms: :mri
-  gem 'pry', platforms: %i(jruby rbx)
-  gem 'codeclimate-test-reporter', require: false
-  gem 'simplecov', require: false
-
-  if RUBY_ENGINE == 'rbx'
-    gem 'pg', '~> 0.18.0', platforms: :rbx
-  else
-    gem 'pg', platforms: :mri
-  end
+  gem 'pry', platforms: :jruby
+  gem 'codeclimate-test-reporter'
+  gem 'simplecov'
 
-  gem 'mysql2', platforms: [:mri, :rbx]
+  gem 'pg', '~> 0.21', platforms: :mri
+  gem 'mysql2', platforms: :mri
   gem 'jdbc-postgres', platforms: :jruby
   gem 'jdbc-mysql', platforms: :jruby
-  gem 'sqlite3', '~> 1.3', platforms: [:mri, :rbx]
+  gem 'sqlite3', '~> 1.3', platforms: :mri
   gem 'jdbc-sqlite3', platforms: :jruby
 end
 
@@ -37,7 +29,6 @@ end
 group :benchmarks do
   gem 'activerecord'
   gem 'benchmark-ips'
-  gem 'factory_girl'
+  gem 'factory_bot'
   gem 'fabrication'
-  gem 'pg', platforms: :mri
 end

data/benchmarks/basic.rb

@@ -1,7 +1,7 @@
 require 'rom-factory'
 require 'rom-core'
 require 'active_record'
-require 'factory_girl'
+require 'factory_bot'
 require 'fabrication'
 require 'benchmark/ips'
 
@@ -33,7 +33,7 @@ end
 
 ActiveRecord::Base.establish_connection(DATABASE_URL)
 
-FactoryGirl.define do
+FactoryBot.define do
   factory(:user) do
     first_name "John"
     last_name  "Doe"
@@ -54,9 +54,9 @@ Benchmark.ips do |x|
     end
   end
 
-  x.report('factory_girl') do
+  x.report('factory_bot') do
     1000.times do
-      FactoryGirl.create(:user)
+      FactoryBot.create(:user)
     end
   end
 

data/lib/rom/factory.rb

@@ -21,9 +21,11 @@ module ROM
     #
     # @api public
     def self.configure(name = DEFAULT_NAME, &block)
-      Dry::Core::ClassBuilder.new(name: name, parent: Factories).call do |klass|
+      klass = Dry::Core::ClassBuilder.new(name: name, parent: Factories).call do |klass|
         klass.configure(&block)
       end
+
+      klass.new(klass.config.rom)
     end
   end
 end

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

@@ -5,7 +5,7 @@ module ROM::Factory
       attr_reader :name, :dsl, :block
 
       # @api private
-      def initialize(name, dsl = nil, &block)
+      def initialize(name, dsl, block)
         @name = name
         @dsl = dsl
         @block = block

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

@@ -9,9 +9,8 @@ module ROM::Factory
         @block = block
       end
 
-      def call(attrs = EMPTY_HASH)
-        return if attrs.key?(name)
-        block.call(increment)
+      def call(*args)
+        block.call(increment, *args)
       end
 
       def to_proc
@@ -25,6 +24,10 @@ module ROM::Factory
       def dependency_names
         EMPTY_ARRAY
       end
+
+      def parameters
+        block.parameters
+      end
     end
   end
 end

data/lib/rom/factory/builder.rb

@@ -1,24 +1,24 @@
 require 'dry/core/constants'
 
+require 'rom/struct'
+require 'rom/initializer'
 require 'rom/factory/tuple_evaluator'
 require 'rom/factory/builder/persistable'
 
 module ROM::Factory
   # @api private
   class Builder
-    include Dry::Core::Constants
+    extend ROM::Initializer
 
-    # @api private
-    attr_reader :attributes
+    include Dry::Core::Constants
 
-    # @api private
-    attr_reader :tuple_evaluator
+    # @!attribute [r] attributes
+    #   @return [ROM::Factory::Attributes]
+    param :attributes
 
-    # @api private
-    def initialize(attributes, relation)
-      @attributes = attributes
-      @tuple_evaluator = TupleEvaluator.new(attributes, relation)
-    end
+    # @!attribute [r] relation
+    #   @return [ROM::Relation]
+    option :relation, reader: false
 
     # @api private
     def tuple(attrs = EMPTY_HASH)
@@ -32,8 +32,18 @@ module ROM::Factory
     alias_method :create, :struct
 
     # @api private
-    def persistable
-      Persistable.new(self)
+    def struct_namespace(namespace)
+      with(relation: relation.struct_namespace(namespace))
+    end
+
+    # @api private
+    def persistable(struct_namespace = ROM::Struct)
+      Persistable.new(self, relation.struct_namespace(struct_namespace))
+    end
+
+    # @api private
+    def tuple_evaluator
+      @__tuple_evaluator__ ||= TupleEvaluator.new(attributes, options[:relation])
     end
 
     # @api private

data/lib/rom/factory/constants.rb

@@ -0,0 +1,9 @@
+module ROM
+  module Factory
+    class FactoryNotDefinedError < StandardError
+      def initialize(name)
+        super("Factory +#{name}+ not defined")
+      end
+    end
+  end
+end

data/lib/rom/factory/dsl.rb

@@ -39,7 +39,7 @@ module ROM
 
       # @api private
       def call
-        ::ROM::Factory::Builder.new(_attributes, _relation)
+        ::ROM::Factory::Builder.new(_attributes, relation: _relation)
       end
 
       # Delegate to a builder and persist a struct
@@ -138,13 +138,13 @@ module ROM
 
       # @api private
       def define_sequence(name, block)
-        _attributes << attributes::Callable.new(name, self, &attributes::Sequence.new(name, &block))
+        _attributes << attributes::Callable.new(name, self, attributes::Sequence.new(name, &block))
       end
 
       # @api private
       def define_attr(name, *args, &block)
         if block
-          _attributes << attributes::Callable.new(name, self, &block)
+          _attributes << attributes::Callable.new(name, self, block)
         else
           _attributes << attributes::Value.new(name, *args)
         end

data/lib/rom/factory/factories.rb

@@ -1,7 +1,10 @@
 require 'dry/configurable'
 require 'dry/core/inflector'
 
+require 'rom/initializer'
+require 'rom/struct'
 require 'rom/factory/dsl'
+require 'rom/factory/registry'
 
 module ROM::Factory
   # In-memory builder API
@@ -12,9 +15,14 @@ module ROM::Factory
     #   @return [Hash<Symbol=>Builder>]
     attr_reader :registry
 
+    # @!attribute [r] struct_namespace
+    #   @return [Module]
+    attr_reader :struct_namespace
+
     # @api private
-    def initialize(registry)
+    def initialize(registry, struct_namespace)
       @registry = registry
+      @struct_namespace = struct_namespace
     end
 
     # Build an in-memory struct
@@ -32,7 +40,7 @@ module ROM::Factory
     #
     # @api public
     def [](name, attrs = {})
-      registry[name].create(attrs)
+      registry[name].struct_namespace(struct_namespace).create(attrs)
     end
   end
 
@@ -41,144 +49,169 @@ module ROM::Factory
   # @api public
   class Factories
     extend Dry::Configurable
+    extend ROM::Initializer
 
     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)
-        klass.instance_variable_set(:'@structs', Structs.new(registry))
-        super
+    # @!attribute [r] rom
+    #   @return [ROM::Container] configured rom container
+    param :rom
+
+    # @!attribute [r] struct_namespace
+    #   @return [Structs] in-memory struct builder instance
+    option :struct_namespace, optional: true, default: proc { ROM::Struct }
+
+    # @!attribute [r] registry
+    #   @return [Hash<Symbol=>Builder>] a map with defined db-backed builders
+    option :registry, default: proc { Registry.new }
+
+    # 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
+
+      if registry.key?(name)
+        raise ArgumentError, "#{name.inspect} factory has been already defined"
       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
-
-        if registry.key?(name)
-          raise ArgumentError, "#{name.inspect} factory has been already defined"
+      builder =
+        if parent
+          extend_builder(name, registry[parent], &block)
+        else
+          relation_name = opts.fetch(:relation) { infer_relation(name) }
+          relation = rom.relations[relation_name]
+          DSL.new(name, relation: relation.struct_namespace(struct_namespace), factories: self, &block).call
         end
 
-        builder =
-          if parent
-            extend_builder(name, registry[parent], &block)
-          else
-            relation_name = opts.fetch(:relation) { infer_relation(name) }
-            relation = config.rom.relations[relation_name]
-            DSL.new(name, relation: relation, factories: self, &block).call
-          end
+      registry[name] = builder
+    end
 
-        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(struct_namespace).create(attrs)
+    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
+    # Return in-memory struct builder
+    #
+    # @return [Structs]
+    #
+    # @api public
+    def structs
+      @__structs__ ||= Structs.new(registry, struct_namespace)
+    end
 
-      # @api private
-      def for_relation(relation)
-        registry.fetch(infer_factory_name(relation.name.to_sym))
+    # Get factories with a custom struct namespace
+    #
+    # @example
+    #   EntityFactory = MyFactory.struct_namespace(MyApp::Entities)
+    #
+    #   EntityFactory[:user]
+    #   # => #<MyApp::Entities::User id=2 ...>
+    #
+    # @param [Module] namespace
+    #
+    # @return [Factories]
+    #
+    # @api public
+    def struct_namespace(namespace = Undefined)
+      if namespace.equal?(Undefined)
+        options[:struct_namespace]
+      else
+        with(struct_namespace: namespace)
       end
+    end
 
-      # @api private
-      def infer_factory_name(name)
-        ::Dry::Core::Inflector.singularize(name).to_sym
-      end
+    # @api private
+    def for_relation(relation)
+      registry[infer_factory_name(relation.name.to_sym)]
+    end
 
-      # @api private
-      def infer_relation(name)
-        ::Dry::Core::Inflector.pluralize(name).to_sym
-      end
+    # @api private
+    def infer_factory_name(name)
+      ::Dry::Core::Inflector.singularize(name).to_sym
+    end
 
-      # @api private
-      def extend_builder(name, parent, &block)
-        DSL.new(name, attributes: parent.attributes, relation: parent.relation, factories: self, &block).call
-      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, attributes: parent.attributes, relation: parent.relation, factories: self, &block).call
     end
   end
 end

data/lib/rom/factory/registry.rb

@@ -0,0 +1,34 @@
+require 'rom/factory/constants'
+
+module ROM
+  module Factory
+    # @api private
+    class Registry
+      # @!attribute [r] elements
+      #   @return [Hash] a hash with factory builders
+      attr_reader :elements
+
+      # @api private
+      def initialize
+        @elements = {}
+      end
+
+      # @api private
+      def key?(name)
+        elements.key?(name)
+      end
+
+      # @api private
+      def []=(name, builder)
+        elements[name] = builder
+      end
+
+      # @api private
+      def [](name)
+        elements.fetch(name) do
+          raise FactoryNotDefinedError.new(name)
+        end
+      end
+    end
+  end
+end

data/lib/rom/factory/sequences.rb

@@ -0,0 +1,35 @@
+require 'singleton'
+
+module ROM
+  module Factory
+    # @api private
+    class Sequences
+      include Singleton
+
+      # @api private
+      attr_reader :registry
+
+      # @api private
+      def self.[](relation)
+        key = :"#{relation.gateway}-#{relation.name.dataset}"
+        -> { instance.next(key) }
+      end
+
+      # @api private
+      def initialize
+        reset
+      end
+
+      # @api private
+      def next(key)
+        registry[key] += 1
+      end
+
+      # @api private
+      def reset
+        @registry = Concurrent::Map.new { |h, k| h[k] = 0 }
+        self
+      end
+    end
+  end
+end

data/lib/rom/factory/tuple_evaluator.rb

@@ -1,3 +1,5 @@
+require 'rom/factory/sequences'
+
 module ROM
   module Factory
     # @api private
@@ -19,7 +21,7 @@ module ROM
         @attributes = attributes
         @relation = relation.with(auto_struct: true)
         @model = @relation.combine(*assoc_names).mapper.model
-        @sequence = 0
+        @sequence = Sequences[relation]
       end
 
       # @api private
@@ -97,7 +99,7 @@ module ROM
 
       # @api private
       def next_id
-        @sequence += 1
+        sequence.()
       end
     end
   end

data/lib/rom/factory/version.rb

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

data/rom-factory.gemspec

@@ -29,7 +29,6 @@ Gem::Specification.new do |spec|
 
   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.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Janis Miezitis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-24 00:00:00.000000000 Z
+date: 2018-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -45,20 +45,6 @@ dependencies:
     - - ">="
       - !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.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
@@ -95,6 +81,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -116,8 +103,11 @@ files:
 - lib/rom/factory/attributes/value.rb
 - lib/rom/factory/builder.rb
 - lib/rom/factory/builder/persistable.rb
+- lib/rom/factory/constants.rb
 - lib/rom/factory/dsl.rb
 - lib/rom/factory/factories.rb
+- lib/rom/factory/registry.rb
+- lib/rom/factory/sequences.rb
 - lib/rom/factory/tuple_evaluator.rb
 - lib/rom/factory/version.rb
 - rom-factory.gemspec
@@ -142,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: ROM based builder library to make your specs awesome. DSL partially inspired