factory_manager 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 37fabd6029e6818555d8b82e65f4dd43a09bc32cd4bcf80f0eba71642837d49f
+  data.tar.gz: 6672c4290dcc696078c7497c9c9e5cd98adb318b816efb698301f313abe851ab
+SHA512:
+  metadata.gz: b3402099193577e089708b0f51e9ede35b4cf66faecb6d941707c16b5529b7ecb8af3154a685b2782bb0e6f8d4b1f885b060fdd0fdcd45a61a98d5f72ae7d3c6
+  data.tar.gz: c64c9b86f85678c11ebd421b890fd8d5323c68233f2a96e013c4f1503a3c01f945d13d0589e99d673f8788286469de424e5172097b018708e78545de6d2389f4

data/lib/factory_manager.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+# A factory manager of factory bots.
+class FactoryManager
+  # Initializes a new factory.
+  def initialize(strategy:)
+    @locals = {}
+    @results = {}
+    @scopes = {}
+    @strategy = strategy
+  end
+
+  # Initializes and builds a new factory.
+  #
+  # @yield Invokes the block to build the factory.
+  def self.build(&block)
+    instance = new(strategy: :build)
+    instance.generate(&block)
+  end
+
+  # Initializes and creates a new factory.
+  #
+  # @yield Invokes the block to create the factory.
+  def self.create(&block)
+    instance = new(strategy: :create)
+    instance.generate(&block)
+  end
+
+  # Generate the factory.
+  #
+  # @yield Invokes the block to generate the factory.
+  # @return [OpenStruct] An object containing the record results.
+  def generate(&block)
+    instance_eval(&block)
+
+    OpenStruct.new(@locals)
+  end
+
+  private
+
+  # Add a record to a new or existing scope.
+  #
+  # @param [ActiveRecord::Base] The record to add to the scope.
+  # @param [Symbol] scope The name of the scope.
+  # @return [ActiveRecord::Base] The record.
+  def _add_to_scope(record, scope:)
+    @scopes[scope] ||= []
+    @scopes[scope] << record
+
+    yield
+
+    @scopes[scope].pop
+  end
+
+  # Assign a local variable.
+  #
+  # @param [Symbol] method The method name for the local.
+  # @param [*] value The value of the local.
+  def _assign_local(method, value)
+    @locals[method.to_s.tr("=", "")] = value
+  end
+
+  # Determine if a name is an assignment method.
+  #
+  # @param [Symbol] name The assignment method name.
+  # @return [Boolean] Whether or not the name is an assignment method.
+  def _assignment_method?(name)
+    name.to_s.end_with?("=")
+  end
+
+  # Find the associations for a specific factory.
+  #
+  # @param [String] name The factory name.
+  # @return [Hash] The associations for the factory.
+  def _associations_for(name)
+    @scopes
+      .slice(*_factory_attributes(name))
+      .transform_values(&:last)
+  end
+
+  # Determine all attribute names for a factory.
+  #
+  # @param [String] name The factory name.
+  # @return [Array] The attributes for the factory.
+  def _factory_attributes(name)
+    @_factory_attributes ||= {}
+    @_factory_attributes[name] ||= FactoryBot.factories.find(name).definition.attributes.names
+  end
+
+  # Generate a factory record with associations and custom attributes.
+  #
+  # @param [String] name The factory name.
+  # @param [Hash] arguments The factory arguments.
+  # @return [ActiveRecord::Base] The built factory record.
+  def _generate_factory(name, *arguments)
+    arguments.push(
+      _associations_for(name).merge(arguments.extract_options!)
+    )
+
+    method = arguments.first.is_a?(Integer) ? "#{@strategy}_list" : @strategy
+
+    FactoryBot.public_send(method, name, *arguments)
+  end
+
+  # Generate a factory record for the missing method.
+  #
+  # @param [Symbol] method The name of the method.
+  # @param [Hash] arguments The factory arguments.
+  # @return [ActiveRecord::Base] The built factory record.
+  def method_missing(method, *arguments, &block)
+    super unless respond_to_missing?(method)
+
+    if _assignment_method?(method)
+      _assign_local(method, arguments.first)
+    else
+      record = _generate_factory(method, *arguments)
+
+      _add_to_scope(record, scope: method) do
+        generate(&block) if block
+      end
+
+      record
+    end
+  end
+
+  # Determine if a factory exists for the missing method, or if a local
+  # variable is being assigned.
+  #
+  # @param [Symbol] method The name of the method.
+  # @return [Boolean] Whether or not the factory exists.
+  def respond_to_missing?(method)
+    !FactoryBot.factories.find(method).nil?
+  rescue KeyError
+    _assignment_method?(method)
+  end
+end

data/spec/lib/factory_manager_spec.rb

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe FactoryManager do
+  describe ".build" do
+    context "with a valid factory" do
+      it "builds a record" do
+        result = build do
+          self.user = user
+        end
+
+        expect(result.user).to be_a(User)
+      end
+
+      it "does not persist the record" do
+        result = build do
+          self.user = user
+        end
+
+        expect(result.user).not_to be_persisted
+      end
+    end
+
+    context "with a factory trait" do
+      it "builds a record using the trait" do
+        result = build do
+          self.user = user(:admin, name: "Admin")
+        end
+
+        expect(result.user).to have_attributes(name: "Admin", admin: true)
+      end
+    end
+
+    context "with a number" do
+      it "builds multiple records" do
+        result = build do
+          self.users = user(2, :admin, name: "Admin")
+        end
+
+        expect(result.users).to contain_exactly(
+          an_object_having_attributes(name: "Admin", admin: true),
+          an_object_having_attributes(name: "Admin", admin: true)
+        )
+      end
+    end
+
+    context "with custom attributes" do
+      it "forwards the custom attributes to the factory" do
+        result = build do
+          self.user = user(name: "Tester")
+        end
+
+        expect(result.user).to have_attributes(name: "Tester")
+      end
+    end
+
+    context "with associations" do
+      it "allows nesting of associated records" do
+        result = build do
+          self.user = user do
+            self.post = post(title: "User's Post")
+          end
+        end
+
+        expect(result.post).to have_attributes(
+          user:  result.user,
+          title: "User's Post"
+        )
+      end
+
+      it "allows multiple level nesting of associated records" do
+        result = build do
+          self.user_1 = user do
+            self.user_2 = user do
+              self.post = post(title: "User's Post")
+            end
+          end
+        end
+
+        expect(result).to have_attributes(
+          user_1: an_instance_of(User),
+          user_2: an_instance_of(User),
+          post:   an_object_having_attributes(
+            user:  result.user_2,
+            title: "User's Post"
+          )
+        )
+      end
+    end
+
+    context "with an invalid factory" do
+      it "raises a no method error" do
+        expect do
+          build { fake }
+        end.to raise_error(NoMethodError)
+      end
+    end
+
+    def build(&block)
+      described_class.build(&block)
+    end
+  end
+
+  describe ".create" do
+    context "with a valid factory" do
+      it "creates a record" do
+        create do
+          user
+        end
+
+        expect(User.count).to eq(1)
+      end
+    end
+
+    context "with a factory trait" do
+      it "creates a record using the trait" do
+        create do
+          user(:admin, name: "Admin")
+        end
+
+        expect(User.all).to contain_exactly(
+          an_object_having_attributes(name: "Admin", admin: true)
+        )
+      end
+    end
+
+    context "with a number" do
+      it "creates multiple records" do
+        create do
+          user(2, :admin, name: "Admin")
+        end
+
+        expect(User.all).to contain_exactly(
+          an_object_having_attributes(name: "Admin", admin: true),
+          an_object_having_attributes(name: "Admin", admin: true)
+        )
+      end
+    end
+
+    context "with custom attributes" do
+      it "forwards the custom attributes to the factory" do
+        create do
+          user(name: "Tester")
+        end
+
+        expect(User.all).to contain_exactly(
+          an_object_having_attributes(name: "Tester")
+        )
+      end
+    end
+
+    context "with associations" do
+      it "allows nesting of associated records" do
+        create do
+          user do
+            post(title: "User's Post")
+          end
+        end
+
+        expect(User.all).to contain_exactly(
+          an_object_having_attributes(
+            posts: [an_object_having_attributes(title: "User's Post")]
+          )
+        )
+      end
+
+      it "allows multiple level nesting of associated records" do
+        create do
+          user do
+            user do
+              post(title: "User's Post")
+            end
+          end
+        end
+
+        expect(User.all).to contain_exactly(
+          an_object_having_attributes(
+            posts: []
+          ),
+          an_object_having_attributes(
+            posts: [an_object_having_attributes(title: "User's Post")]
+          )
+        )
+      end
+    end
+
+    context "with local variables" do
+      it "returns an object with local variable assignments" do
+        result = create do
+          user do
+            self.admin = admin = user(:admin)
+
+            self.user = user(name: "Local User") do
+              self.post = post(title: "User's Post")
+            end
+
+            self.announcement = post(user: admin)
+          end
+        end
+
+        expect(result).to have_attributes(
+          admin:        an_object_having_attributes(admin: true),
+          announcement: an_object_having_attributes(user: result.admin),
+          post:         an_object_having_attributes(title: "User's Post"),
+          user:         an_object_having_attributes(name: "Local User")
+        )
+      end
+    end
+
+    context "with an invalid factory" do
+      it "raises a no method error" do
+        expect do
+          create { fake }
+        end.to raise_error(NoMethodError)
+      end
+    end
+
+    def create(&block)
+      described_class.create(&block)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+if ENV["CI"] || ENV["COVERAGE"]
+  require "simplecov"
+  require "simplecov-console"
+
+  SimpleCov.formatter = SimpleCov::Formatter::Console
+  SimpleCov.start("rails") do
+    coverage_dir "./tmp/cache/coverage"
+    enable_coverage :branch
+    minimum_coverage line: 100, branch: 100
+  end
+end
+
+Bundler.require(:default, :development)
+
+Dir[File.expand_path("support/**/*.rb", __dir__)].sort.each do |file|
+  require file
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |rspec|
+    rspec.syntax = :expect
+  end
+
+  # Raise errors for any deprecations.
+  config.raise_errors_for_deprecations!
+end

data/spec/support/database/connection.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+  end
+
+  config.after do
+    ApplicationRecord.subclasses.each(&:delete_all)
+  end
+end

data/spec/support/database/factories.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "factory_bot"
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    FactoryBot.define do
+      factory :post do
+        user
+
+        sequence(:title) { |n| "Post ##{n}" }
+      end
+
+      factory :user do
+        sequence(:name) { |n| "User ##{n}" }
+
+        trait :admin do
+          admin { true }
+        end
+      end
+    end
+  end
+end

data/spec/support/database/models.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# rubocop:disable Lint/ConstantDefinitionInBlock
+RSpec.configure do |config|
+  config.before(:suite) do
+    # The base ActiveRecord class.
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+
+    # A post record.
+    class Post < ApplicationRecord
+      belongs_to :user, required: true
+
+      validates :title, presence: true
+    end
+
+    # A user record.
+    class User < ApplicationRecord
+      has_many :posts
+
+      validates :name, presence: true
+    end
+  end
+end
+# rubocop:enable Lint/ConstantDefinitionInBlock

data/spec/support/database/schema.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    ActiveRecord::Schema.define do
+      self.verbose = false
+
+      create_table :users, force: true do |t|
+        t.string :name, null: false
+        t.boolean :admin, null: false, default: false
+
+        t.timestamps null: false
+      end
+
+      create_table :posts, force: true do |t|
+        t.references :user, null: false
+        t.string :title, null: false
+
+        t.timestamps null: false
+      end
+    end
+  end
+end

data/spec/support/database.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "active_record"
+require_relative "./database/connection"
+require_relative "./database/schema"
+require_relative "./database/models"
+require_relative "./database/factories"

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: factory_manager
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tristan Dunn
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.1.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.1.4.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.22.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.22.3
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.26
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.26
+description: A factory manager of factory bots.
+email: hello@tristandunn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/factory_manager.rb
+- spec/lib/factory_manager_spec.rb
+- spec/spec_helper.rb
+- spec/support/database.rb
+- spec/support/database/connection.rb
+- spec/support/database/factories.rb
+- spec/support/database/models.rb
+- spec/support/database/schema.rb
+homepage: https://github.com/tristandunn/factory_manager
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: A factory manager of factory bots.
+test_files:
+- spec/lib/factory_manager_spec.rb
+- spec/spec_helper.rb
+- spec/support/database/connection.rb
+- spec/support/database/factories.rb
+- spec/support/database/models.rb
+- spec/support/database/schema.rb
+- spec/support/database.rb