factory_burgers 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67f3705a0aa0daae828a023c64d2076905e6a55ecc976819b2c1782fd654f7bd
-  data.tar.gz: 41f2fb80a4430ddb0fe469f6c43edc41cdd8f479b8214be080461411c860740f
+  metadata.gz: 4f976d301bd92dab1483eae6443b7aff5a8f96ff417a24a79bb9a03568c79028
+  data.tar.gz: 6a5718377d57f7c9fe72ab91cab29a7bc156e348ffe56cfd3401b7e4c87fd0c5
 SHA512:
-  metadata.gz: a543ecdb55543d128659f8c999ecf4d90cf1a35dd0a616a11160723236effa2c259c502b33e65f23e11e575d17a3b3954163fa1bde9bb55b107af9c0d6cfecec
-  data.tar.gz: eaaf8613824e8f425fe09a5bc21a4ae74cb5678853634819380e5edbd44d6ece1c730e4e0afa63a24653a848f54f96f22fe0bb01712990f9eb8984257756343c
+  metadata.gz: 8bf91ca8dcb5eeb240ba57f3c1e7a1e00e6b0c74e1ba8af1127f9fea4774f96b9edfadbbdcec1424df66b4bdac1194db0a1a1825410baee8e460c7d6dd7cb1e8
+  data.tar.gz: 3d063a6dcb7fc933f712225b36c3992250688ad48fbe2a1ad67e504ef9b9a7381369f88193769f93323fe4eafbd280dd4953a630ce5af1c67cd548cabf6f5c39

data/lib/factory_burgers/builder.rb

@@ -1,26 +1,44 @@
 module FactoryBurgers
   # Build resources from specified factories, traits, and attributes
   class Builder
+    attr_reader :owner
+
+    # `owner` is an optional resource that we can attach new resources to
+    # E.g. a `User` for whom we wish to build a `Post`.
+    def initialize(owner = nil)
+      @owner = owner
+    end
+
     # TODO: clean up method signature
-    def build(factory, traits, attributes, owner)
+    def build(factory, traits, attributes, as: nil) # rubocop:disable Naming/MethodParameterName; as is a good name here
       resource = insistently do
         FactoryBot.create(factory, *traits, attributes)
       end
-      update_owner_resource(owner, params[:owner_association], resource) if owner
+      update_assocation_to_owner(as, resource) if owner && as
 
       return resource
     end
 
-    def update_owner_resource(owner, name, resource)
-      reflection = owner.class.reflections[name] or raise "Could not find reflection named #{name}"
-      if reflection.is_a?(ActiveRecord::Reflection::HasManyReflection)
-        owner.update!(name => owner.public_send(name) + [resource])
-        resource.reload
+    private
+
+    def update_assocation_to_owner(association_name, resource)
+      reflection = get_owner_association(association_name)
+      case reflection
+      when ActiveRecord::Reflection::BelongsToReflection, ActiveRecord::Reflection::HasOneReflection
+        # This will update the foreign key on `resource` for has_one.
+        owner.update!(association_name => resource)
+      when ActiveRecord::Reflection::HasManyReflection
+        # This will update the foreign key on `resource`.
+        owner.public_send(association_name) << resource
       else
-        owner.update!(name => resource)
+        invalid_association(reflection)
       end
     end
 
+    def get_owner_association(name)
+      owner.class.reflections[name.to_s] or raise "Could not find association named #{name}"
+    end
+
     # Brute force through sequences (e.g. account name) to overcome uniqueness validations
     def insistently(tries = 30)
       tries.times do |attempt|
@@ -29,5 +47,10 @@ module FactoryBurgers
         raise if attempt >= tries - 1
       end
     end
+
+    def invalid_association(reflection)
+      msg = "#{reflection.class} association #{reflection.name} on #{reflection.active_record.name} is not supported."
+      raise FactoryBurgers::Errors::InvalidAssociationError, msg
+    end
   end
 end

data/lib/factory_burgers/errors.rb

@@ -0,0 +1,7 @@
+module FactoryBurgers
+  module Errors
+    FactoryBurgerError = Class.new(StandardError)
+    InvalidAssociationError = Class.new(FactoryBurgerError)
+    InvalidRequestError = Class.new(FactoryBurgerError)
+  end
+end

data/lib/factory_burgers/middleware/build.rb

@@ -24,8 +24,8 @@ module FactoryBurgers
         factory = params.fetch("factory")
         traits = params["traits"]&.keys
         attributes = attribute_overrides(params["attributes"])
-        owner = get_resource_owner(params[:owner_type], params[:owner_id], params[:owner_association])
-        return FactoryBurgers::Builder.new.build(factory, traits, attributes, owner)
+        owner = get_resource_owner(params["owner_type"], params["owner_id"])
+        return FactoryBurgers::Builder.new(owner).build(factory, traits, attributes, as: params["owner_association"])
       end
 
       def request(env)
@@ -43,15 +43,13 @@ module FactoryBurgers
         return attribute_items.map { |attr| [attr["name"], attr["value"]] }.to_h
       end
 
-      # TODO: make params explicit
-      def get_resource_owner(owner_type, owner_id, owner_association)
-        return nil if owner_type.blank? || owner_id.blank? || owner_association.blank?
+      def get_resource_owner(owner_type, owner_id)
+        return nil if owner_type.blank? || owner_id.blank?
 
         klass = owner_type.constantize
-        invalid_build_class(klass) if !valid_build_class?(klass)
-        invalid_association(klass) if !valid_owner?(klass, owner_association)
+        invalid_resource(klass) if !valid_resource?(klass)
 
-        return klass.constantize.find(owner_id)
+        return klass.find(owner_id)
       end
 
       def log_error(error)
@@ -64,20 +62,12 @@ module FactoryBurgers
 
       private
 
-      def valid_build_class?(klass)
+      def valid_resource?(klass)
         klass < ActiveRecord::Base
       end
 
-      def invalid_build_class(klass)
-        raise "#{klass.name} is not a thing I can build."
-      end
-
-      def valid_association?(klass, assoc_name)
-        klass.reflections.include?(assoc_name)
-      end
-
-      def invalid_association(klass, association)
-        raise "#{association} is not an association for #{klass.name}!"
+      def invalid_resource(klass)
+        raise FactoryBurgers::Errors::InvalidRequestError, "#{klass.name} is not a valid resource."
       end
     end
   end

data/lib/factory_burgers/version.rb

@@ -1,3 +1,3 @@
 module FactoryBurgers
-  VERSION = '0.1.4'.freeze
+  VERSION = '0.1.5'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factory_burgers
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Andrew Schwartz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-23 00:00:00.000000000 Z
+date: 2021-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot
@@ -122,7 +122,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: factory_burgers provides a UI and some tooling to allow manual testing
+  the abilit to use all of your factories.
 email: ozydingo@gmail.com
 executables: []
 extensions: []
@@ -244,6 +245,7 @@ files:
 - lib/factory_burgers/app.rb
 - lib/factory_burgers/builder.rb
 - lib/factory_burgers/cheating.rb
+- lib/factory_burgers/errors.rb
 - lib/factory_burgers/factory_bot_adapter.rb
 - lib/factory_burgers/init.rb
 - lib/factory_burgers/introspection.rb
@@ -280,5 +282,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
-summary: UI for thoughtbot/factory_bot
+summary: Bring the power of thoughtbot/factory_bot to manual testing
 test_files: []