active_record_data_loader 0.1.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbc38165d9ffa4debdc127641a9e79c4fd3eb382dd9271c7e0eed849992c8c72
-  data.tar.gz: d2703bbd36cdbcae163dbf19082704e39dc717499689d9754bc570d846895ada
+  metadata.gz: 33d3769ad2f8c008cf51e75a62b43ba3333dce8e7e45387e01ab3470f2a5bf6c
+  data.tar.gz: 6f2b812d1e3837d05ff565c050cd6c80110929136601fb95436996b14de4e809
 SHA512:
-  metadata.gz: a999728b9926d7e87cb93fbf3329902becc4dd0b51139f38b473820010b93987ecb5e87be0be214111f28bd6c64685af6d2b09d61cc35cf4d3c41dd1fc88f026
-  data.tar.gz: 1b6bcbf2edd88700ce91083ce7da1958ef314f65f5c57932cd978915e36603788696eb3f1cc5894f36dd6870d6d945ca9e72068e2ac05444f5992df099c4760a
+  metadata.gz: 8813fa219e7a710f147b79bb3a81826a5fe23ed7e3bef21a95fca310b3c8f3b09c7fb2c89d0cb3a65c825d01941eca8e394ee42900e13941d050e05fcb2c76d5
+  data.tar.gz: 43392902671095ffcf3d9f33984b7f77de3a9b2fb95bd99ee65378d046e2d509d34f8b92220de04642e6e33d816926215581caa58d02b0d30ac02011f1956776

data/.rubocop.yml

@@ -1,5 +1,20 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.5
+  NewCops: enable
+  SuggestExtensions: false
+
+Layout/LineLength:
+  Max: 110
+  Exclude: ["*.gemspec"]
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
 
 Lint/UnusedMethodArgument:
   AllowUnusedKeywordArguments: true
@@ -11,20 +26,31 @@ Metrics/AbcSize:
 Metrics/BlockLength:
   Exclude: ["spec/**/*", "*.gemspec"]
 
-Metrics/LineLength:
-  Max: 110
-  Exclude: ["*.gemspec"]
-
 Metrics/MethodLength:
   Max: 15
   Exclude: ["spec/**/*"]
 
-Style/FrozenStringLiteralComment:
-  Exclude: ["gemfiles/*"]
+Style/CaseLikeIf:
+  Enabled: false
 
 Style/Documentation:
   Enabled: false
 
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Exclude: ["gemfiles/*"]
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 

data/.travis.yml

@@ -1,11 +1,24 @@
 sudo: false
 language: ruby
+env:
+  - COVERALLS_PARALLEL=true
 rvm:
-  - 2.4.3
+  - 2.5.9
+  - 2.6.7
+  - 2.7.3
+gemfile:
+  - gemfiles/activerecord_5.gemfile
+  - gemfiles/rails.gemfile
+  - gemfiles/faker.gemfile
+  - gemfiles/ffaker.gemfile
 services:
   - postgresql
-before_install: gem install bundler -v 1.16.1
+  - mysql
+notifications:
+  webhooks: https://coveralls.io/webhook
+before_install: "gem update --system && gem install bundler"
 before_script:
   - psql -c 'create database test;' -U postgres
+  - mysql -e 'CREATE DATABASE IF NOT EXISTS test;'
   - cp config/database.yml.travis config/database.yml
-script: ./script/ci_build.sh
+script: "bundle exec rake"

data/Appraisals

@@ -4,8 +4,8 @@ appraise "activerecord-5" do
   gem "activerecord", "~> 5.0"
 end
 
-appraise "activerecord-6" do
-  gem "activerecord", "6.0.0.rc1"
+appraise "rails" do
+  gem "rails"
 end
 
 appraise "faker" do

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Change log
+
+## [v1.0.2] - 2019-07-05
+
+[Diff](https://github.com/abeiderman/active_record_data_loader/compare/v1.0.1...v1.0.2)
+
+### Enhancements:
+* Add support for MySQL enums
+* Accept a connection factory lambda as part of the configuration
+
+## [v1.0.1] - 2019-06-16
+
+[Diff](https://github.com/abeiderman/active_record_data_loader/compare/v1.0.0...v1.0.1)
+
+### Enhancements:
+* Generate values for datetime column types. This also fixes the fact that `created_at` and `updated_at` were not being populated by default.
+
+## [v1.0.0] - 2019-06-15
+
+Initial stable release
+
+[v1.0.0]: https://github.com/abeiderman/active_record_data_loader/releases/tag/v1.0.0
+[v1.0.1]: https://github.com/abeiderman/active_record_data_loader/releases/tag/v1.0.1
+[v1.0.2]: https://github.com/abeiderman/active_record_data_loader/releases/tag/v1.0.2

data/Gemfile.lock

@@ -1,19 +1,19 @@
 PATH
   remote: .
   specs:
-    active_record_data_loader (0.1.1)
-      activerecord (>= 4.0)
+    active_record_data_loader (1.1.0)
+      activerecord (>= 5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.2.3)
-      activesupport (= 5.2.3)
-    activerecord (5.2.3)
-      activemodel (= 5.2.3)
-      activesupport (= 5.2.3)
+    activemodel (5.2.4.5)
+      activesupport (= 5.2.4.5)
+    activerecord (5.2.4.5)
+      activemodel (= 5.2.4.5)
+      activesupport (= 5.2.4.5)
       arel (>= 9.0)
-    activesupport (5.2.3)
+    activesupport (5.2.4.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -23,9 +23,9 @@ GEM
       rake
       thor (>= 0.14.0)
     arel (9.0.0)
-    ast (2.4.0)
+    ast (2.4.1)
     coderay (1.1.2)
-    concurrent-ruby (1.1.5)
+    concurrent-ruby (1.1.8)
     coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
@@ -33,45 +33,51 @@ GEM
       thor (>= 0.19.4, < 2.0)
       tins (~> 1.6)
     diff-lcs (1.3)
-    docile (1.3.1)
-    i18n (1.6.0)
+    docile (1.3.2)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.2)
-    json (2.2.0)
-    method_source (0.9.2)
-    minitest (5.11.3)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
-    pg (1.1.4)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
+    json (2.3.1)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    mysql2 (0.5.3)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    pg (1.2.3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.0.0)
-    rake (12.3.2)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-collection_matchers (1.1.3)
+    rake (13.0.1)
+    regexp_parser (2.0.0)
+    rexml (3.2.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-collection_matchers (1.2.0)
       rspec-expectations (>= 2.99.0.beta1)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.68.1)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (1.6.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.6)
-    ruby-progressbar (1.10.0)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -82,26 +88,30 @@ GEM
       tins (~> 1.0)
     thor (0.20.3)
     thread_safe (0.3.6)
-    tins (1.20.3)
-    tzinfo (1.2.5)
+    timecop (0.9.1)
+    tins (1.21.0)
+    tzinfo (1.2.9)
       thread_safe (~> 0.1)
-    unicode-display_width (1.5.0)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
+  x86_64-darwin-19
 
 DEPENDENCIES
   active_record_data_loader!
   appraisal
   bundler (>= 1.16)
   coveralls
+  mysql2
   pg
   pry
-  rake (~> 12.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
   rspec-collection_matchers
   rubocop
   sqlite3
+  timecop
 
 BUNDLED WITH
-   2.0.1
+   2.2.1

data/README.md

@@ -1,7 +1,7 @@
-# ActiveRecord Data Loader
+# active_record_data_loader
 
 [![Build Status](https://travis-ci.org/abeiderman/active_record_data_loader.svg?branch=master)](https://travis-ci.org/abeiderman/active_record_data_loader)
-[![Coverage Status](https://coveralls.io/repos/github/abeiderman/active_record_data_loader/badge.svg?branch=master)](https://coveralls.io/github/abeiderman/active_record_data_loader?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/abeiderman/active_record_data_loader/badge.svg?branch=master&service=github)](https://coveralls.io/github/abeiderman/active_record_data_loader?branch=master)
 [![Maintainability](https://api.codeclimate.com/v1/badges/338904b3f7e8d19a3cb1/maintainability)](https://codeclimate.com/github/abeiderman/active_record_data_loader/maintainability)
 
 Efficiently bulk load data for your ActiveRecord models with a simple DSL.
@@ -10,6 +10,10 @@ Efficiently bulk load data for your ActiveRecord models with a simple DSL.
 
 Load, performance, and stress tests often require setting up a realistic amount of data in your database. This gem is intended to help organize that data load and make it more maintainable than having a collection of SQL scripts.
 
+#### How is this different from using _factory_bot_?
+
+This gem is not a replacement for [factory_bot](https://github.com/thoughtbot/factory_bot). It solves a different use case. While _factory_bot_ is great for organizing test data and reducing duplication in your functional tests, _active_record_data_loader_ is focused around bulk loading data for performance tests. The purpose of _active_record_data_loader_ is loading large amounts of data as efficiently as possible while providing a DSL that helps with maintainability.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -28,7 +32,181 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The gem will recognize most commonly used column types and attempt to populate with sensible values by default. You can override this behavior as you will see further below.
+
+`belongs_to` associations are recognized automatically. However, data is loaded in the order you define, so you want to make sure the parent model is loaded first.
+
+Polymorphic associations need to be defined explicitly as shown in [Polymorphic associations](#polymorphic-associations).
+
+### Basic usage
+
+Let's say you have the following models:
+```ruby
+class Customer < ApplicationRecord
+end
+
+class Order < ApplicationRecord
+  belongs_to :customer
+end
+```
+
+The following code will create 10,000 customers and 100,000 orders, and will associate the orders to those customers evenly:
+```ruby
+data_loader = ActiveRecordDataLoader.define do
+  model Customer do |m|
+    m.count 10_000
+  end
+
+  model Order do |m|
+    m.count 100_000
+  end
+end
+
+data_loader.load_data
+```
+
+#### Overriding column values
+To provide your own values for columns your can provide a lambda or a constant value:
+```ruby
+data_loader = ActiveRecordDataLoader.define do
+  model Customer do |m|
+    m.count 10_000
+    m.column :name, -> { %w[Jane John Mary Matt].sample }
+    m.column :country, "USA"
+    m.column :terminated_at, nil
+  end
+
+  ...
+end
+
+data_loader.load_data
+```
+
+### Controlling associations
+Let's say that you have certain restrictions on orders depending on country. You would want to test data to follow those restrictions which means orders cannot be randomly associated to any customer. You can control that by providing an `eligible_set` on the association.
+
+In this example, we are creating 25K orders for customers in CAN with a CAD currency, 25K for customers in MEX with a MXN currency, and 50K for those in USA with a USD currency.
+
+```ruby
+data_loader = ActiveRecordDataLoader.define do
+  model Customer do |m|
+    m.count 10_000
+    m.column :country, -> { %w[CAN MXN USA].sample }
+  end
+
+  model Order do |m|
+    m.count 25_000
+    m.column :currency, "CAD"
+    m.belongs_to :customer, eligible_set: -> { Customer.where(country: "CAN") }
+  end
+  
+  model Order do |m|
+    m.count 25_000
+    m.column :currency, "MXN"
+    m.belongs_to :customer, eligible_set: -> { Customer.where(country: "MEX") }
+  end
+  
+   model Order do |m|
+    m.count 50_000
+    m.column :currency, "USD"
+    m.belongs_to :customer, eligible_set: -> { Customer.where(country: "USA") }
+  end
+end
+
+data_loader.load_data
+```
+
+### Polymorphic associations
+
+If you have a polymorphic `belongs_to` association, you will need to define that explicitly for it to be populated.
+
+Let's assume the following models where an order could belong to either a person or a business:
+```ruby
+class Person < ApplicationRecord
+  has_many :orders
+end
+
+class Business < ApplicationRecord
+  has_many :orders
+end
+
+class Order < ApplicationRecord
+  belongs_to :customer, polymorphic: true
+end
+```
+
+In order to populate the `customer` association in orders, you would specify them like this:
+```ruby
+data_loader = ActiveRecordDataLoader.define do
+  model Person do |m|
+    m.count 5_000
+  end
+
+  model Business do |m|
+    m.count 5_000
+  end
+
+  model Order do |m|
+    m.count 100_000
+    
+    m.polymorphic :customer do |c|
+      c.model Person
+      c.model Business
+    end
+  end
+end
+
+data_loader.load_data
+```
+
+You can also provide a `weight` to each of the target models if you want to control how they are distributed. If you wanted to have twice as many orders for `Person` than for `Business`, it would look like this:
+```ruby
+data_loader = ActiveRecordDataLoader.define do
+  model Person do |m|
+    m.count 5_000
+  end
+
+  model Business do |m|
+    m.count 5_000
+  end
+
+  model Order do |m|
+    m.count 100_000
+    
+    m.polymorphic :customer do |c|
+      c.model Person, weight: 2
+      c.model Business, weight: 1
+    end
+  end
+end
+
+data_loader.load_data
+```
+
+Additionaly, you can also provide an `eligible_set` to control which records to limit the association to:
+```ruby
+data_loader = ActiveRecordDataLoader.define do
+  model Person do |m|
+    m.count 5_000
+  end
+
+  model Business do |m|
+    m.count 5_000
+    m.column :country, -> { %w[CAN USA].sample }
+  end
+
+  model Order do |m|
+    m.count 100_000
+    
+    m.polymorphic :customer do |c|
+      c.model Person, weight: 2
+      c.model Business, weight: 1, eligible_set: -> { Business.where(country: "USA") }
+    end
+  end
+end
+
+data_loader.load_data
+```
 
 ## Development
 
@@ -46,4 +224,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the ActiveRecord Data Loader project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/abeiderman/active_record_data_loader/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the _active_record_data_loader_ project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/abeiderman/active_record_data_loader/blob/master/CODE_OF_CONDUCT.md).