rom-factory 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb5feab75eb72799779fea6582a2cd96c84f7e65
-  data.tar.gz: 771008f99234f6bd33b07581995783118c415241
+  metadata.gz: b0e9af2bccde24058817960957099aa19a54cda9
+  data.tar.gz: f99643318992b7df49913638a47043086a992519
 SHA512:
-  metadata.gz: 76efd0835cc269ab37364c1d164698d5707733a932cd3bb0594b6bf7be697c6f708dc553ecaa4fb6c074d1483084d23bf09896207ccb5cfa7eca6e07e4208710
-  data.tar.gz: 66e2d00acfbcc2147299f34df216f07c8e240d7a9af4b97f6fe590483a6023c77ac9d2f591354e3303232f7cd51ecd0a0023034e798118a8a6a5aad0c6c3f129
+  metadata.gz: 6f8a9de64072548a7e3597000b27898d4a6041f6e999be10837ef917a56ae0bade2437bc8cd85b260e9bee006e8f7042ceb6792e65e22e602dd356bea54d6c59
+  data.tar.gz: a809541e1f0bb8a36b8c6b7ee7c3f41f0e36c9964bb70aebd072cfc1c78658fb8b4d31e46b912bcfbae5e5a629d57e3d9c8ba4139c6c6fc636efc0198033161e

data/.travis.yml

@@ -1,17 +1,18 @@
 language: ruby
-dist: trusty
-sudo: required
-cache: bundler
-bundler_args: --without tools
+sudo: false
+services:
+  - postgresql
+  - mysql
+bundler_args: --without tools benchmarks
+before_script:
+  - psql -c 'create database rom_factory;' -U postgres
 script: "bundle exec rake spec"
 after_success:
-  - '[ "${TRAVIS_JOB_NUMBER#*.}" = "1" ] && [ "$TRAVIS_BRANCH" = "master" ] && bundle exec codeclimate-test-reporter'
+  - '[ -d coverage ] && bundle exec codeclimate-test-reporter'
 rvm:
-  - 2.4.0
-  - 2.3
-  - 2.2
-  - rbx-3
-  - jruby-9.1.6.0
+  - 2.3.4
+  - 2.4.1
+  - jruby-9.1.13.0
 env:
   global:
     - COVERAGE='true'

data/.yardopts

@@ -0,0 +1,7 @@
+--plugin junk
+--query '@api.text != "private"'
+--embed-mixins
+-r README.md
+--markup-provider=redcarpet
+--markup=markdown
+--files CHANGELOG.md

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 0.5.0 to-be-released
+
+### Added
+
+* Updated to rom 4.0 (solnic)
+* Support for `has_many` and `has_one` associations (solnic)
+* Support for attributes depending on values from other attributes (solnic)
+* Support for `rand` inside the generator block (flash-gordon)
+
+### Changed
+
+* Depends on `rom-core` now (solnic)
+
+[Compare v0.4.0...v0.5.0](https://github.com/rom-rb/rom-factory/compare/v0.4.0...v0.5.0)
+
 ## v0.4.0 2017-03-03
 
 This is a revamp of the original `rom_factory` gem which adds new features and

data/Gemfile

@@ -7,11 +7,37 @@ gem 'simplecov', require: false, platform: :mri
 gem 'codeclimate-test-reporter', require: false, platform: :mri
 
 gem 'rspec', '~> 3.0'
-gem 'rom', '~> 3.0'
-gem 'rom-sql', '~> 1.0'
-gem 'sqlite3', '~> 1.3', platforms: [:mri, :rbx]
-gem 'jdbc-sqlite3', platforms: :jruby
+
+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 'mysql2', platforms: [:mri, :rbx]
+  gem 'jdbc-postgres', platforms: :jruby
+  gem 'jdbc-mysql', platforms: :jruby
+  gem 'sqlite3', '~> 1.3', platforms: [:mri, :rbx]
+  gem 'jdbc-sqlite3', platforms: :jruby
+end
 
 group :tools do
   gem 'byebug', platform: :mri
+  gem 'redcarpet' # for yard
+end
+
+group :benchmarks do
+  gem 'activerecord'
+  gem 'benchmark-ips'
+  gem 'factory_girl'
+  gem 'fabrication'
+  gem 'pg', platforms: :mri
 end

data/README.md

@@ -15,6 +15,10 @@
 
 Data generator with support for persistence backends, built on top of [rom-rb](http://rom-rb.org) and [dry-rb](http://dry-rb.org).
 
+More information:
+
+- [API docs](http://rubydoc.info/gems/rom-factory)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -31,201 +35,27 @@ Or install it yourself as:
 
     $ gem install rom-factory
 
-## Configuration
-
-First, you have to define ROM container:
-
-```ruby
-rom = ROM.container(:sql, 'sqlite::memory') do |conf|
-  conf.default.create_table(:users) do
-    primary_key :id
-    column :last_name, String, null: false
-    column :first_name, String, null: false
-    column :email, String, null: false
-    column :admin, TrueClass, null: false, default: false
-    column :created_at, Time, null: false
-    column :updated_at, Time, null: false
-  end
-end
-```
-
-> Notice that if you're using ROM in your application, then simply set up factory using your existing ROM container
-
-Once that is done, you will have to specify which container ROM::Factory will use:
-
-```ruby
-Factory = ROM::Factory.configure do |config|
-  config.rom = rom
-end
-```
-
-This returns a new factory ready to be used.
-
-## Simple use case
-
-After configuration is done, you can define builders using your `Factory`:
-
-```ruby
-Factory.define(:user) do |f|
-  f.first_name "Janis"
-  f.last_name "Miezitis"
-  f.email "janjiss@gmail.com"
-end
-```
-
-Then you can use it to generate data:
-
-```ruby
-user = Factory[:user]
-user.email #=> "janjiss@gmail.com"
-```
-
-### Callable properties
-
-You can easily define dynamic (callbale) properties if value needs to change every time it needs to be called.
-Anything that responds to `.call` can be a dynamic property.
-
-```ruby
-Factory.define(:user) do |f|
-  f.first_name "Janis"
-  f.last_name "Miezitis"
-  f.email "janjiss@gmail.com"
-  f.created_at {Time.now}
-end
-
-user = Factory[:user]
-user.created_at #=> 2016-08-27 18:17:08 -0500
-```
-
-### Sequencing
-
-If you want attributes to be unique each time you generate data, you can use sequence to achieve that:
-
-```ruby
-Factory.define(:user) do |f|
-  f.first_name "Janis"
-  f.last_name "Miezitis"
-  f.sequence :email do |n|
-    "janjiss#{n}@gmail.com"
-  end
-end
-
-user1 = Factory[:user]
-user2 = Factory[:user]
-
-user1.email #=> janjiss1@gmail.com
-user2.email #=> janjiss2@gmail.com
-```
-
-### Timestamps
-
-There is a support for timestamps for `created_at` and `updated_at` attributes:
-
-```ruby
-Factory.define(:user) do |f|
-  f.first_name "Janis"
-  f.last_name "Miezitis"
-  f.email "janjiss@gmail.com"
-  f.timestamps
-end
-
-user = Factory[:user]
-user.created_at #=> 2016-08-27 18:17:08 -0500
-user.updated_at #=> 2016-08-27 18:17:10 -0500
-```
-
-### Associations
-
-If you defined associations in your relations, you can use `association` builder:
-
-``` ruby
-factories.define(:user) do |f|
-  f.first_name 'Jane'
-  f.last_name 'Doe'
-  f.email 'jane@doe.org'
-  f.timestamps
-end
-
-factories.define(:task) do |f|
-  f.title 'A task'
-  f.association(:user)
-end
-
-task = factories[:task]
-```
-
-> Currently only `belongs_to` is supported
-
-### Fake data generator
-
-There's a builtin support for [Faker](https://github.com/stympy/faker) gem with a `fake` shortcut in the DSL:
+### Performance
 
+Seems like this thing is a bit faster than other popular factory gems:
 
-``` ruby
-factories.define(:user) do |f|
-  f.first_name { fake(:name, :first_name) }
-  f.last_name { fake(:name, :last_name) }
-  f.email { fake(:internet, :email) }
-  f.timestamps
-end
 ```
-
-### Extending existing builders
-
-You can create a hierarchy of builders easily, which is useful if you want to share data generation logic across
-multiple definitions:
-
-``` ruby
-Factory.define(:user) do |f|
-  f.first_name "Janis"
-  f.last_name "Miezitis"
-  f.email "janjiss@gmail.com"
-  f.admin false
-  f.timestamps
-end
-
-Factory.define(admin: :user) do |f|
-  f.admin true
-end
-
-user = Factory[:admin]
-
-user.admin # true
+Warming up --------------------------------------
+         rom-factory     1.000  i/100ms
+        factory_girl     1.000  i/100ms
+         fabrication     1.000  i/100ms
+Calculating -------------------------------------
+         rom-factory      1.550  (± 0.0%) i/s -      8.000  in   5.166227s
+        factory_girl      0.982  (± 0.0%) i/s -      5.000  in   5.098193s
+         fabrication      1.011  (± 0.0%) i/s -      6.000  in   5.942209s
+
+Comparison:
+         rom-factory:        1.5 i/s
+         fabrication:        1.0 i/s - 1.53x  slower
+        factory_girl:        1.0 i/s - 1.58x  slower
 ```
 
-### Setting up relation backend explicitly
-
-By default, relation is configured automatically based on the builder name. For example if your builder is called `:user`, then `:users`
-relation name will be inferred. If you want to set up a relation explicitly, use `:relation` option:
-
-``` ruby
-Factory.define(:user, relation: :people) do |f|
-  f.first_name "Janis"
-  f.last_name "Miezitis"
-  f.email "janjiss@gmail.com"
-  f.admin false
-  f.timestamps
-end
-```
-
-### Generating structs without persistence
-
-You can generate struct objects without persisting them using `#structs` generator:
-
-``` ruby
-Factory.define(:user) do |f|
-  f.first_name "Janis"
-  f.last_name "Miezitis"
-  f.email "janjiss@gmail.com"
-  f.admin false
-  f.timestamps
-end
-
-user = Factory.structs[:user]
-
-user.id # auto-generated fake PK
-user.first_name # "Janis"
-```
+> See [benchmarks/basic.rb](https://github.com/rom-rb/rom-factory/blob/master/benchmarks/basic.rb)
 
 ## Credits
 

data/benchmarks/basic.rb

@@ -0,0 +1,70 @@
+require 'rom-factory'
+require 'rom-core'
+require 'active_record'
+require 'factory_girl'
+require 'fabrication'
+require 'benchmark/ips'
+
+DATABASE_URL = 'postgres://localhost/rom_factory_bench'.freeze
+
+rom = ROM.container(:sql, DATABASE_URL) do |conf|
+  conf.default.connection.create_table?(:users) do
+    primary_key :id
+    column :last_name, String, null: false
+    column :first_name, String, null: false
+    column :admin, TrueClass
+  end
+
+  conf.relation(:users) do
+    schema(infer: true)
+  end
+end
+
+factory = ROM::Factory.configure { |c| c.rom = rom }
+
+factory.define(:user) do |f|
+  f.first_name "John"
+  f.last_name "Doe"
+  f.admin false
+end
+
+class User < ActiveRecord::Base
+end
+
+ActiveRecord::Base.establish_connection(DATABASE_URL)
+
+FactoryGirl.define do
+  factory(:user) do
+    first_name "John"
+    last_name  "Doe"
+    admin false
+  end
+end
+
+Fabricator(:user) do
+  first_name "John"
+  last_name  "Doe"
+  admin false
+end
+
+Benchmark.ips do |x|
+  x.report('rom-factory persisted struct') do
+    1000.times do
+      factory[:user]
+    end
+  end
+
+  x.report('factory_girl') do
+    1000.times do
+      FactoryGirl.create(:user)
+    end
+  end
+
+  x.report('fabrication') do
+    1000.times do
+      Fabricate(:user)
+    end
+  end
+
+  x.compare!
+end

data/lib/rom/factory.rb

@@ -2,9 +2,24 @@ require 'dry/core/class_builder'
 require 'rom/factory/factories'
 
 module ROM
+  # Main ROM::Factory API
+  #
+  # @api public
   module Factory
     DEFAULT_NAME = 'Factories'.freeze
 
+    # Configure a new factory
+    #
+    # @example
+    #   MyFactory = ROM::Factory.configure do |config|
+    #     config.rom = my_rom_container
+    #   end
+    #
+    # @param [Symbol] name An optional factory class name
+    #
+    # @return [Class]
+    #
+    # @api public
     def self.configure(name = DEFAULT_NAME, &block)
       Dry::Core::ClassBuilder.new(name: name, parent: Factories).call do |klass|
         klass.configure(&block)

data/lib/rom/factory/attribute_registry.rb

@@ -0,0 +1,64 @@
+require 'tsort'
+
+module ROM
+  module Factory
+    # @api private
+    class AttributeRegistry
+      include Enumerable
+      include TSort
+
+      # @api private
+      attr_reader :elements
+
+      # @api private
+      def initialize(elements = [])
+        @elements = elements
+      end
+
+      # @api private
+      def each(&block)
+        elements.each(&block)
+      end
+
+      # @api private
+      def [](name)
+        detect { |e| e.name.equal?(name) }
+      end
+
+      # @api private
+      def <<(element)
+        existing = self[element.name]
+        elements.delete(existing) if existing
+        elements << element
+        self
+      end
+
+      # @api private
+      def dup
+        self.class.new(elements.dup)
+      end
+
+      # @api private
+      def values
+        self.class.new(elements.select(&:value?))
+      end
+
+      # @api private
+      def associations
+        self.class.new(elements.select { |e| e.kind_of?(Attributes::Association::Core) })
+      end
+
+      private
+
+      # @api private
+      def tsort_each_node(&block)
+        each(&block)
+      end
+
+      # @api private
+      def tsort_each_child(attr, &block)
+        attr.dependency_names.map { |name| self[name] }.compact.each(&block)
+      end
+    end
+  end
+end