factory_bot-preload 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40f6db7436f6c2e5af62b1432b8d4c2e4910e68aa2ae6bfe3ffd9fb7d37540f8
-  data.tar.gz: e03e9fcbc0772227d7f05032422cfea1488442b692ab873b0d2c4edd03855500
+  metadata.gz: d637fe4bb5ac2873148d2fb9c64772f5b5dcffad6eb317701bf56c67ad2131ce
+  data.tar.gz: 207e9f509ef305d20d11e3d3f8a3a663e62d7408064bb9f6a240d8a32b4753b2
 SHA512:
-  metadata.gz: 4b5095f45aee005e1b1377d98a9649c8c46ee96a89218e46f06aa6f5e8c632a1a09b0db76c52fc7738c53ce6e4f67897d98829810dbc02ec2061fb6a612278cc
-  data.tar.gz: 7607063d3be8e6af9aec024b8fe286442ae858d84f495cdec6679744af7a5fd2ff978dfef68faa6b52c9609dee6bf6d691788c7f094598dc621d5d4e791ab772
+  metadata.gz: 246ed765e74d0205c3a16cb2da2f83f783b627762eea4044b2cb028eaa31d36af6ba7b1b6ec97f47465856170a214a493eb8702b701406028caaafa6e96391e2
+  data.tar.gz: 5185f494d6cf186e9396e574f92eef8b77143edc14ae723175e7a27f2b2dcaf66493bb58cfe416aab5be68def1b7626b1f9cd2391b2a9ec6ff87ba0db8813970

data/.travis.yml

@@ -1,5 +1,4 @@
 ---
-
 language: ruby
 sudo: false
 cache: bundler
@@ -10,6 +9,7 @@ before_script:
   - chmod +x ./cc-test-reporter
   - "./cc-test-reporter before-build"
 rvm:
+  - 2.7.0
   - 2.6.5
   - 2.5.7
 gemfile:
@@ -21,4 +21,4 @@ after_script:
   - "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
 env:
   global:
-    - secure: Euebw1utbb/4mu9AwgmnNk1cF4flaUVxterXl2yG9STc3oR9e8IczV+r3107CuIu57O6xbi5WarzSgyASSmC/0G9vhT3OaMx0lAY55zy93LaYbkcbcaAYCfbw6h1RHZ1pA3K4SVw/+n+p2jg9xFTTRLUmOHb2vXHH79WAo+Ri9s=
+    secure: ABKL9+QRkF2+B8kQicumx122YSivY0L4yIZnbr5PxoRkgWdUVqyDPmhkz6yL4vhu53dRciKRLel1r+6QZ7rGDxRA0sOOSVyOw3ciyGSgIUFPTe8hO/r4wVKjCqoqK35gzd96x8DUSXBNMoTxFbgAXr7EajMMX8FQY5KjIomVloA=

data/README.md

@@ -30,13 +30,17 @@ gem "pg"
 
 group :test, :development do
   gem "factory_bot"
-  gem "factory_bot-preload"
+  gem "factory_bot-preload", require: false
 end
 ```
 
+Notice that adding `require: false` is important; otherwise you won't be able to
+run commands such as `rails db:test:prepare`.
+
 ### RSpec Setup
 
-On your `spec/spec_helper.rb` file, make sure that transactional fixtures are enabled. Here's is my file without all those RSpec comments:
+On your `spec/spec_helper.rb` file, make sure that transactional fixtures are
+enabled. Here's is my file without all those RSpec comments:
 
 ```ruby
 ENV["RAILS_ENV"] ||= "test"
@@ -57,9 +61,21 @@ RSpec.configure do |config|
 end
 ```
 
+You may want to configure the generated helper names. For instance, imagine you
+have a namespace like `MyApp::Models::User`. That'd generate a helper method
+like `myapp_models_user`. If you don't have conflicting names, you can strip
+`myapp_models_` like this:
+
+```ruby
+FactoryBot::Preload.helper_name = lambda do |class_name, helper_name|
+  helper_name.gsub(/^myapp_models_/, "")
+end
+```
+
 ### Minitest Setup
 
-On your `test/test_helper.rb` file, make sure that transaction fixtures are enabled. Here's what your file may look like:
+On your `test/test_helper.rb` file, make sure that transaction fixtures are
+enabled. Here's what your file may look like:
 
 ```ruby
 ENV["RAILS_ENV"] ||= "test"
@@ -88,7 +104,9 @@ FactoryBot::Preload.minitest
 
 ### Usage
 
-Create your factories and load it from your setup file (either `test/test_helper.rb` or `spec/spec_helper.rb`) You may have something like this:
+Create your factories and load it from your setup file (either
+`test/test_helper.rb` or `spec/spec_helper.rb`) You may have something like
+this:
 
 ```ruby
 FactoryBot.define do
@@ -151,7 +169,8 @@ FactoryBot.define do
 end
 ```
 
-Like Rails fixtures, FBP will define methods for each model. You can use it on your examples and alike.
+Like Rails fixtures, FBP will define methods for each model. You can use it on
+your examples and alike.
 
 ```ruby
 require "test_helper"

data/lib/factory_bot/preload.rb

@@ -5,28 +5,37 @@ require "active_record"
 
 module FactoryBot
   module Preload
-    require "factory_bot/preload/helpers"
-    require "factory_bot/preload/version"
-    require "factory_bot/preload/rspec" if defined?(RSpec)
-    require "factory_bot/preload/minitest" if defined?(Minitest)
-    require "factory_bot/preload/extension"
-
-    ActiveSupport.on_load(:after_initialize) do
-      ::FactoryBot::Preload::Helpers.load_models
-      ::FactoryBot::SyntaxRunner.include ::FactoryBot::Preload::Helpers
-    end
-
     class << self
       attr_accessor :preloaders
       attr_accessor :factories
       attr_accessor :record_ids
       attr_accessor :clean_with
+      attr_accessor :default_helper_name
+      attr_accessor :helper_name
+      attr_accessor :reserved_tables
     end
 
     self.preloaders = []
     self.factories = {}
     self.record_ids = {}
     self.clean_with = :truncation
+    self.default_helper_name = ->(_class_name, helper_name) { helper_name }
+    self.helper_name = default_helper_name
+    self.reserved_tables = %w[
+      ar_internal_metadata
+      schema_migrations
+    ]
+
+    require "factory_bot/preload/helpers"
+    require "factory_bot/preload/version"
+    require "factory_bot/preload/rspec" if defined?(RSpec)
+    require "factory_bot/preload/minitest" if defined?(Minitest)
+    require "factory_bot/preload/extension"
+
+    ActiveSupport.on_load(:after_initialize) do
+      ::FactoryBot::Preload::Helpers.load_models
+      ::FactoryBot::SyntaxRunner.include ::FactoryBot::Preload::Helpers
+    end
 
     def self.active_record
       ActiveRecord::Base
@@ -67,7 +76,7 @@ module FactoryBot
 
     def self.active_record_names
       names = active_record.descendants.collect(&:table_name).uniq.compact
-      reserved_tables = %w[ar_internal_metadata schema_migrations]
+
       names.reject {|name| reserved_tables.include?(name) }
     end
 

data/lib/factory_bot/preload/helpers.rb

@@ -15,9 +15,16 @@ module FactoryBot
 
       def self.define_helper_methods
         ActiveRecord::Base.descendants.each do |model|
-          method_name = model.name.underscore.tr("/", "_").pluralize
+          next if FactoryBot::Preload.reserved_tables.include?(model.table_name)
 
-          define_method(method_name) do |name|
+          helper_name = model.name.underscore.tr("/", "_").pluralize
+
+          helper_name = FactoryBot::Preload.helper_name.call(
+            model.name,
+            helper_name
+          )
+
+          define_method(helper_name) do |name|
             factory(name, model)
           end
         end

data/lib/factory_bot/preload/version.rb

@@ -4,8 +4,8 @@ module FactoryBot
   module Preload
     module Version
       MAJOR = 0
-      MINOR = 2
-      PATCH = 2
+      MINOR = 3
+      PATCH = 0
       STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
     end
   end

data/spec/factory_bot/preload_spec.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe FactoryBot::Preload do
   it "queues preloader block" do
-    block = proc {}
+    block = proc { }
     FactoryBot.preload(&block)
     expect(FactoryBot::Preload.preloaders).to include(block)
   end
@@ -45,6 +47,33 @@ describe FactoryBot::Preload do
     expect { FactoryBot::Preload.clean }.to raise_error(%[Couldn't find invalid clean type])
   end
 
+  it "ignores reserved table names when creating helpers" do
+    mod = Module.new do
+      include FactoryBot::Preload::Helpers
+    end
+
+    instance = Object.new.extend(mod)
+
+    expect(instance).not_to respond_to(:active_record_internal_metadata)
+    expect(instance).not_to respond_to(:active_record_schema_migrations)
+    expect(instance).not_to respond_to(:primary_schema_migrations)
+  end
+
+  it "processes helper name" do
+    FactoryBot::Preload.helper_name = lambda do |_class_name, helper_name|
+      helper_name.gsub(/^models_/, "")
+    end
+
+    mod = Module.new do
+      include FactoryBot::Preload::Helpers
+    end
+
+    instance = Object.new.extend(mod)
+
+    expect(instance).to respond_to(:assets)
+    expect(assets(:asset).name).to eq("Some asset")
+  end
+
   example "association uses preloaded record" do
     expect(build(:skill).user).to eq(users(:john))
   end

data/spec/spec_helper.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require "simplecov"
-SimpleCov.start
+SimpleCov.start do
+  add_filter(/schema\.rb/)
+end
 
 ENV["RAILS_ENV"] = "test"
 ENV["BUNDLE_GEMFILE"] = File.dirname(__FILE__) + "/../Gemfile"

data/spec/support/app/app/models/models/asset.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Models
+  class Asset < ActiveRecord::Base
+  end
+end

data/spec/support/app/db/schema.rb

@@ -7,7 +7,8 @@ ActiveRecord::Schema.define(version: 0) do
     drop_table :preloads
     drop_table :categories
     drop_table :categories_users
-  rescue Exception => e
+    drop_table :assets
+  rescue Exception => error
   end
 
   create_table :users do |t|
@@ -33,4 +34,8 @@ ActiveRecord::Schema.define(version: 0) do
     t.references :category
     t.references :user
   end
+
+  create_table :assets do |t|
+    t.string :name
+  end
 end

data/spec/support/factories.rb

@@ -16,9 +16,14 @@ FactoryBot.define do
     name { "My Preload" }
   end
 
+  factory :asset, class: "Models::Asset" do
+    name { "Some asset" }
+  end
+
   preload do
     factory(:john) { create(:user) }
     factory(:ruby) { create(:skill, user: users(:john)) }
     factory(:my)   { create(:preload) }
+    factory(:asset) { create(:asset) }
   end
 end

data/test/factory_bot/preload_test.rb

@@ -5,6 +5,7 @@ require "test_helper"
 class PreloadTest < ActiveSupport::TestCase
   setup do
     FactoryBot::Preload.clean_with = :truncation
+    FactoryBot::Preload.helper_name = FactoryBot::Preload.default_helper_name
   end
 
   test "queues preloader block" do
@@ -100,4 +101,31 @@ class PreloadTest < ActiveSupport::TestCase
     assert_equal 0, users(:john).invitations
     refute users(:john).frozen?
   end
+
+  test "ignores reserved table names" do
+    mod = Module.new do
+      include FactoryBot::Preload::Helpers
+    end
+
+    instance = Object.new.extend(mod)
+
+    refute_respond_to instance, :active_record_internal_metadata
+    refute_respond_to instance, :active_record_schema_migrations
+    refute_respond_to instance, :primary_schema_migrations
+  end
+
+  test "processes helper name" do
+    FactoryBot::Preload.helper_name = lambda do |_class_name, helper_name|
+      helper_name.gsub(/^models_/, "")
+    end
+
+    mod = Module.new do
+      include FactoryBot::Preload::Helpers
+    end
+
+    instance = Object.new.extend(mod)
+
+    assert_respond_to instance, :assets
+    assert_equal "Some asset", assets(:asset).name
+  end
 end

data/test/test_helper.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require "simplecov"
-SimpleCov.start
+SimpleCov.start do
+  add_filter(/schema\.rb/)
+end
 
 ENV["RAILS_ENV"] = "test"
 ENV["BUNDLE_GEMFILE"] = File.dirname(__FILE__) + "/../Gemfile"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factory_bot-preload
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-28 00:00:00.000000000 Z
+date: 2020-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -205,6 +205,7 @@ files:
 - spec/factory_bot/preload_spec.rb
 - spec/spec_helper.rb
 - spec/support/app/app/models/category.rb
+- spec/support/app/app/models/models/asset.rb
 - spec/support/app/app/models/preload.rb
 - spec/support/app/app/models/skill.rb
 - spec/support/app/app/models/user.rb
@@ -231,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Preload factories (Factory Bot) just like fixtures. It will be easier and,
@@ -240,6 +241,7 @@ test_files:
 - spec/factory_bot/preload_spec.rb
 - spec/spec_helper.rb
 - spec/support/app/app/models/category.rb
+- spec/support/app/app/models/models/asset.rb
 - spec/support/app/app/models/preload.rb
 - spec/support/app/app/models/skill.rb
 - spec/support/app/app/models/user.rb