fixture_factory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9970ff1a9b9427593019d53a7ae239fe9752651b9a8a8d15b684ecac2d041c93
+  data.tar.gz: 1842a6092e09ff6d64f25630d0c0a725c49315d2664629b1af0651935ac0970d
+SHA512:
+  metadata.gz: a5aa2e004aeabda9c7472c1e159f823b8d97ae8e9d094e82f96fbf4838270ee1f04a69172471f8dd9cc37712d4efe6ce4359e3994e9dd35b534a1982978ec248
+  data.tar.gz: c9533a232a9c28dd4d6ecb8356af3f49868b265766780c9d5fb4c29dc7a089907c97b45b7ba06e03d1bb498f0848d6e18245983861bd0d4efa266417939e0e88

data/lib/fixture_factory.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'fixture_factory/version'
+require 'fixture_factory/definition'
+require 'fixture_factory/methods'
+require 'fixture_factory/registry'
+require 'fixture_factory/sequence'
+require 'fixture_factory/errors'
+
+module FixtureFactory
+  class << self
+    def attributes_for(name, options) # :nodoc:
+      _, attributes = retrieve(name, options)
+      attributes
+    end
+
+    def build(name, options) # :nodoc:
+      klass, attributes = retrieve(name, options)
+      klass.new(attributes)
+    end
+
+    def create(name, options) # :nodoc:
+      build(name, options).tap(&:save!)
+    end
+
+    def evaluate(block, args: [], context:) # :nodoc:
+      attributes = context.instance_exec(*args, &block)
+      extract_attributes(attributes)
+    end
+
+    private
+
+    def extract_attributes(object)
+      raise ArgumentError, "FixtureFactory blocks must return a hash-like object" unless object.respond_to?(:to_h)
+      object.to_h.symbolize_keys
+    end
+
+    def retrieve(name, scope:, context: nil, overrides: {})
+      definition = scope.all_factory_definitions.fetch(name) do
+        raise NotFoundError, name
+      end
+      attributes = definition.run(context: context)
+      attributes.merge!(overrides).delete(:id)
+      [definition.klass, attributes]
+    end
+  end
+end

data/lib/fixture_factory/definition.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module FixtureFactory
+  class Definition # :nodoc:
+    EMPTY_BLOCK = proc {}
+
+    attr_reader   :klass
+    attr_writer   :block
+    attr_accessor :fixture_method, :fixture_name, :parent, :sequence
+
+    def initialize(name, options = {})
+      self.parent         = options.fetch(:parent) { default_parent_for(name) }
+      self.klass          = options.fetch(:class)  { parent.klass }
+      self.fixture_method = options.fetch(:via)    { parent.fixture_method }
+      self.fixture_name   = options.fetch(:like)   { parent.fixture_name }
+      self.block          = options.fetch(:block)  { EMPTY_BLOCK }
+      self.sequence       = Sequence.new
+    end
+
+    def block
+      all_blocks = [parent&.block, @block].compact
+      -> (*args) do
+        all_blocks.reduce({}) do |attributes, block|
+          block_attributes = FixtureFactory.evaluate(
+            block, args: args, context: self
+          )
+          attributes.merge(block_attributes)
+        end
+      end
+    end
+
+    def klass=(new_class)
+      @klass = case new_class
+      when String
+        new_class.to_s.constantize # rubocop:disable Sorbet/ConstantsFromStrings
+      else
+        new_class
+      end
+    rescue NameError
+      raise WrongClassError, new_class
+    end
+
+    def fixture_args
+      [fixture_method, fixture_name]
+    end
+
+    def from_fixture?
+      fixture_name.present? && fixture_method.present?
+    end
+
+    def run(context:)
+      FixtureFactory.evaluate(runner, context: context)
+    end
+
+    private
+
+    def runner
+      definition = self
+      args = sequence.take(1)
+      -> do
+        attributes = FixtureFactory.evaluate(definition.block, args: args, context: self)
+        if definition.from_fixture?
+          begin
+            fixture = send(*definition.fixture_args)
+            attributes.reverse_merge!(fixture.attributes)
+          rescue NoMethodError
+            raise WrongFixtureMethodError, definition.fixture_args.first
+          end
+        end
+        attributes
+      end
+    end
+
+    def default_parent_for(name)
+      self.class.new(
+        name,
+        parent: nil,
+        like: nil,
+        class: name.to_s.classify.safe_constantize,
+        via: name.to_s.pluralize,
+      )
+    end
+  end
+end

data/lib/fixture_factory/errors.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module FixtureFactory
+  class Error < StandardError # :nodoc:
+  end
+
+  # Raised when a factory is referenced, but not defined.
+  class NotFoundError < Error
+    def initialize(fixture_name)
+      super(
+        <<~MSG.squish
+          No factory named "#{fixture_name}".
+          Did you forget to define it?
+          https://github.com/Shopify/fixture_factory/blob/master/README.md#definition
+        MSG
+      )
+    end
+  end
+
+  class WrongFixtureMethodError < Error
+    def initialize(method_name)
+      super(
+        <<~MSG.squish
+          No fixture method named "#{method_name}".
+          Try using the `via` option in your definition to specify a valid method.
+          https://github.com/Shopify/fixture_factory/blob/master/README.md#naming
+        MSG
+      )
+    end
+  end
+
+  class WrongClassError < Error
+    def initialize(class_name)
+      super(
+        <<~MSG.squish
+          No class named "#{class_name}".
+          Try using the `class` option in your definition to specify a valid class name.
+          https://github.com/Shopify/fixture_factory/blob/master/README.md#naming
+        MSG
+      )
+    end
+  end
+end

data/lib/fixture_factory/methods.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module FixtureFactory
+  module Methods
+    # Generates a hash of attributes given a factory name and an optional
+    # hash of override attributes.
+    #
+    # === Example
+    #
+    # attributes_for(:user)
+    # attributes_for(:blog, title: 'Riding Rails')
+    # attributes_for(:comment, content: 'Hello', approved: false)
+    # attributes_for(:post, comments_attributes: [attributes_for(:comment)])
+    def attributes_for(name, overrides = {})
+      FixtureFactory.attributes_for(
+        name, overrides: overrides, context: self, scope: self.class
+      )
+    end
+
+    # Generates an array of hash attributes given a factory name, a count,
+    # and an optional hash of override attributes.
+    #
+    # === Example
+    #
+    # attributes_for_list(:user, 5)
+    # attributes_for_list(:blog, 3, title: 'Riding Rails')
+    # attributes_for_list(:comment, 50, content: 'Hello', approved: false)
+    # attributes_for_list(:post, 3, comments_attributes: attributes_for_list(:comment, 1))
+    def attributes_for_list(name, count, overrides = {})
+      count.times.map { attributes_for(name, overrides) }
+    end
+
+    # Generates an instance of a model given a factory name and an optional
+    # hash of override attributes.
+    #
+    # === Example
+    #
+    # build(:user)
+    # build(:blog, title: 'Riding Rails')
+    # build(:comment, content: 'Hello', approved: false)
+    # build(:post, comments: [build(:comment)])
+    def build(name, overrides = {})
+      FixtureFactory.build(
+        name, overrides: overrides, context: self, scope: self.class
+      )
+    end
+
+    # Generates an array of model instances given a factory name and an optional
+    # hash of override attributes.
+    #
+    # === Example
+    #
+    # build_list(:user, 5)
+    # build_list(:blog, 3, title: 'Riding Rails')
+    # build_list(:comment, 50, content: 'Hello', approved: false)
+    # build_list(:post, 3, comments: build_list(:comment, 1))
+    def build_list(name, count, overrides = {})
+      count.times.map { build(name, overrides) }
+    end
+
+    # Generates a persisted model instance given a factory name and an optional
+    # hash of override attributes.
+    #
+    # === Example
+    #
+    # create(:user)
+    # create(:blog, title: 'Riding Rails')
+    # create(:comment, content: 'Hello', approved: false)
+    # create(:post, comments: [create(:comment)])
+    def create(name, overrides = {})
+      FixtureFactory.create(
+        name, overrides: overrides, context: self, scope: self.class
+      )
+    end
+
+    # Generates an array of persisted model instances given a factory name and
+    # an optional hash of override attributes.
+    #
+    # === Example
+    #
+    # create_list(:user, 5)
+    # create_list(:blog, 3, title: 'Riding Rails')
+    # create_list(:comment, 50, content: 'Hello', approved: false)
+    # create_list(:post, 3, comments: create_list(:comment, 1))
+    def create_list(name, count, overrides = {})
+      count.times.map { create(name, overrides) }
+    end
+  end
+end

data/lib/fixture_factory/registry.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/hash/indifferent_access"
+
+module FixtureFactory
+  module Registry
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute(:fixture_factory_definitions) # :nodoc:
+    end
+
+    class_methods do
+      # Defines a fixture given a name, options, and a block.
+      #
+      # === Options
+      #
+      # [:parent]
+      #   Specify a parent fixture to inherit options from. If no parent is specified,
+      #   a default parent will be assumed that guesses class a via options.
+      # [:class]
+      #   Specify a class (typically as a string to prevent autoloading) to instantiate
+      #   when building or creating models from fixturies. This option is guessed
+      #   using the classified fixture name.
+      # [:via]
+      #   Specify a fixture method to call when generating data. Only necessary when
+      #   the `like` option is used to specify a fixture name. This option is guessed
+      #   by default using the pluralized fixture name.
+      # [:like]
+      #   Specify a fixture to use when generating data. Used in combination with
+      #   `via` to extract attributes from a fixture.
+      # [:block]
+      #   Specify a block to call when running a fixture. This option will default to
+      #   a passed block or an empty block if neither are provided.
+      #
+      # === Example
+      #
+      # define_factories do
+      #   fixture(:user, like: :bob)
+      #   fixture(:active_user, parent: :user) do
+      #     { active: true }
+      #   end
+      #   fixture(:cool_user, class: 'User') do
+      #     { status: :cool }
+      #   end
+      #   fixture(:admin, via: :users, like: :bob_admin, class: 'User')
+      # end
+      def fixture(name, options = {}, &block)
+        parent = all_factory_definitions[options[:parent]]
+        options[:parent] = parent if options.key?(:parent)
+        options[:block]  = block if block
+        fixture_factory_definitions[name] = Definition.new(name, options)
+      end
+
+      # Sets up factories definitions for the current class scope. Accepts an
+      # optional block to define factories in.
+      #
+      # === Example
+      #
+      # class SomeTest < ActiveSupport::TestCase
+      #   define_factories do
+      #     fixture(:blog)
+      #   end
+      # end
+      #
+      # SomeTest.define_factories do
+      #   fixture(:post)
+      # end
+      def define_factories(&block)
+        self.fixture_factory_definitions = {}.with_indifferent_access
+        instance_exec(&block) if block.present?
+      end
+
+      def all_factory_definitions # :nodoc:
+        fixtury_ancestors = ancestors.select do |ancestor|
+          ancestor.respond_to?(:fixture_factory_definitions)
+        end
+        [self, *fixtury_ancestors].map(&:fixture_factory_definitions).reduce(:reverse_merge)
+      end
+    end
+  end
+end

data/lib/fixture_factory/sequence.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module FixtureFactory
+  class Sequence # :nodoc:
+    include Enumerable
+
+    def initialize
+      @count = 0
+    end
+
+    def next
+      @count += 1
+    end
+
+    def each
+      loop { yield(self.next) }
+    end
+  end
+end

data/lib/fixture_factory/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FixtureFactory
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: fixture_factory
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shopify Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- gems@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/fixture_factory.rb
+- lib/fixture_factory/definition.rb
+- lib/fixture_factory/errors.rb
+- lib/fixture_factory/methods.rb
+- lib/fixture_factory/registry.rb
+- lib/fixture_factory/sequence.rb
+- lib/fixture_factory/version.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Factories via fixtures
+test_files: []