factory_bot-refinements 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f97ca8bc54ccac42b61ddc6aa2f3e9ec9239d0e385015bdbfb6822f53403a146
+  data.tar.gz: fb5851e3d397a28c1b782809bc42827b19755fa39d81b2b9759175b5fa6e9ed5
+SHA512:
+  metadata.gz: 1d6e43bc05498885ccfed186f7c725899a42b3db86ac89e579b80220343ad4dfb6c50da612bf370cbc16eec74bef5c0bea3389959c99b4dc259004a4c32ae397
+  data.tar.gz: 568ac0d452823c63835b72933a64e359837a6ba458a293135a2ebe0b237505a698fefac25ba4edc5632c4c008bd71bf1d1a89f069f8f731f23d61007016833c6

data/README.md

@@ -0,0 +1,101 @@
+# FactoryBot::Refinements
+
+Extensions for factory_bot
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'factory_bot-refinements'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install factory_bot-refinements
+
+## Usage
+
+Add the following code to your test file:
+
+``` ruby
+# ActiveRecord extensions
+using FactoryBot::Refinements::ActiveRecord
+
+# RSpec extensions
+using FactoryBot::Refinements::RSpec
+
+# Or both of them
+using FactoryBot::Refinements
+```
+
+### FactoryBot::Refinements::ActiveRecord
+
+Add a set of methods to create/build a record using a factory for `has_many` associations. All arguments, including keyword arguments and a block, will be delegated to the factory.
+
+By default, the factory to use will be automatically looked up from the association's class. You can also specify an arbitrary one with `factory()`.
+
+
+``` ruby
+using FactoryBot::Refinements::ActiveRecord
+
+describe MyApp do
+  example do
+    user = create(:user)
+
+    user.posts.create_with_factory(:published, title: 'hello')
+    # Equivalent to:
+    # FactoryBot.create(:post, :published, user: user, title: 'hello')
+
+    user.posts.factory(:featured_post).create_with_factory
+    # Equivalent to:
+    # FactoryBot.create(:featured_post, user: user)
+
+    user.posts.build_with_factory
+    # Equivalent to:
+    # FactoryBot.build(:post, user: user)
+  end
+end
+```
+
+### FactoryBot::Refinements::RSpec
+
+Add a set of short-hand methods to the describe/context block that do `FactoryBot.create/build` and `let/let!` together. All arguments except the first, including keyword arguments and a block, will be delegated to the factory as-is.
+
+``` ruby
+using FactoryBot::Refinements::RSpec
+
+describe MyApp do
+  create :user, name: 'alice'
+  # Equivalent to:
+  # let!(:user) { FactoryBot.create(:user, name: 'alice') }
+
+  create :user.as(:bob), :admin, name: 'bob'
+  # Equivalent to:
+  # let!(:bob) { FactoryBot.create(:user, :admin, name: 'bob') }
+
+  create_lazy :user
+  # Equivalent to (let, not let!):
+  # let(:user) { FactoryBot.create(:user) }
+
+  build :user
+  # Equivalent to:
+  # let!(:user) { FactoryBot.build(:user) }
+
+  build_lazy :user
+  # Equivalent to:
+  # let(:user) { FactoryBot.build(:user) }
+end
+```
+
+#### Limitations
+
+Due to scope constraints, these factories do not have access to other `let` values. Therefore, it is recommended to use them for fixture-like fixed data setups. If you need `let` to build associations, consider using [RSpec::LetAs](https://github.com/ursm/rspec-let_as).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/factory_bot/refinements/active_record.rb

@@ -0,0 +1,37 @@
+require 'active_record'
+require 'factory_bot'
+
+module FactoryBot
+  module Refinements
+    module ActiveRecord
+      def self.default_factory(association)
+        association.klass.model_name.singular
+      end
+
+      refine ::ActiveRecord::Associations::CollectionProxy do
+        def factory(name)
+          tap { @__factory = name }
+        end
+
+        def create_with_factory(*args, **kwargs, &block)
+          factory = @__factory || ActiveRecord.default_factory(proxy_association)
+          key     = proxy_association.reflection.inverse_of.name
+
+          FactoryBot.create(factory, *args, key => proxy_association.owner, **kwargs, &block).tap {
+            @__factory = nil
+          }
+        end
+
+        def build_with_factory(...)
+          factory = @__factory || ActiveRecord.default_factory(proxy_association)
+
+          FactoryBot.build(factory, ...).tap {|record|
+            proxy_association.add_to_target record
+
+            @__factory = nil
+          }
+        end
+      end
+    end
+  end
+end

data/lib/factory_bot/refinements/rspec.rb

@@ -0,0 +1,49 @@
+require 'factory_bot'
+require 'rspec/core'
+
+module FactoryBot
+  module Refinements
+    module RSpec
+      def self.normalize_name_and_factory(name_and_factory)
+        case name_and_factory
+        when Array
+          name_and_factory
+        else
+          [name_and_factory, name_and_factory]
+        end
+      end
+
+      refine Symbol do
+        def as(as)
+          [as, self]
+        end
+      end
+
+      refine ::RSpec::Core::ExampleGroup.singleton_class do
+        def create(name_and_factory, ...)
+          name, factory = RSpec.normalize_name_and_factory(name_and_factory)
+
+          let!(name) { FactoryBot.create(factory, ...) }
+        end
+
+        def create_lazy(name_and_factory, ...)
+          name, factory = RSpec.normalize_name_and_factory(name_and_factory)
+
+          let(name) { FactoryBot.create(factory, ...) }
+        end
+
+        def build(name_and_factory, ...)
+          name, factory = RSpec.normalize_name_and_factory(name_and_factory)
+
+          let!(name) { FactoryBot.build(factory, ...) }
+        end
+
+        def build_lazy(name_and_factory, ...)
+          name, factory = RSpec.normalize_name_and_factory(name_and_factory)
+
+          let(name) { FactoryBot.build(factory, ...) }
+        end
+      end
+    end
+  end
+end

data/lib/factory_bot/refinements/version.rb

@@ -0,0 +1,5 @@
+module FactoryBot
+  module Refinements
+    VERSION = '0.1.0'
+  end
+end

data/lib/factory_bot/refinements.rb

@@ -0,0 +1,25 @@
+require_relative 'refinements/version'
+
+module FactoryBot
+  module Refinements
+    begin
+      require 'active_record'
+    rescue LoadError
+      # optional
+    else
+      require_relative 'refinements/active_record'
+
+      include ActiveRecord
+    end
+
+    begin
+      require 'rspec/core'
+    rescue LoadError
+      # optional
+    else
+      require_relative 'refinements/rspec'
+
+      include RSpec
+    end
+  end
+end

data/lib/factory_bot-refinements.rb

@@ -0,0 +1 @@
+require 'factory_bot/refinements'

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: factory_bot-refinements
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keita Urashima
+- Ryunosuke Sato
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- ursm@ursm.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/factory_bot-refinements.rb
+- lib/factory_bot/refinements.rb
+- lib/factory_bot/refinements/active_record.rb
+- lib/factory_bot/refinements/rspec.rb
+- lib/factory_bot/refinements/version.rb
+homepage: https://github.com/ursm/factory_bot-refinements
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ursm/factory_bot-refinements
+  source_code_uri: https://github.com/ursm/factory_bot-refinements.git
+  changelog_uri: https://github.com/ursm/factory_bot-refinements/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.31
+signing_key:
+specification_version: 4
+summary: Extensions for factory_bot
+test_files: []