cranky 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbcde86a6a73ee0148b12ed591e978d21521f5ba
-  data.tar.gz: 61a43c0743b8b333f85e3ec26f6604197086741b
+  metadata.gz: 42aebc7927e7fc1f29417cb638be0bee94190521
+  data.tar.gz: dd1710da521efa26a01615646b5daaa4e98980b7
 SHA512:
-  metadata.gz: bf660e5eb16c325dc12f2c6f52839f6b2c5268a0d647729d5cb7b11f5bd9dcd55eb464609d57ffc3ef671b0def15abba10571c141e383e30029d59bd4696e5b6
-  data.tar.gz: ce11711bca5aa5de02f02d33305074e025147727ef13f425837e0182522cf119330bd38d19eb2e8bd5b46e3a23e44fd1d3a136e9a9b2486fc63bbfcd25848a70
+  metadata.gz: e5234e23763c245d614d50dfe44d4e862ad4e236f16fb4eb9f71d5e98bf1899c4b55c4edaec3632b7bd8ea20e16965f0877e6d6e499e8ca3fe5654e3c6ec64e1
+  data.tar.gz: 621dcfd64bbdfefddd9e484a3c10e96dbd0f5ebdfe11ba537d7b674973a5ca4b5a77f29eca5416a48e5cab040c4d339213b82b44fd10faa44d4dbfc1a4a5abe3

data/CHANGELOG.md

@@ -1,31 +1,9 @@
 # Overview of Changes
 
-## 0.3.1
+## 1.1.0
 
-* Bugfix, generating a hash of attributes via _attrs did not work with factory methods
-  that used the inherit method
+* Added before_create, after_build, after_create callbacks (@beorc)
 
-## 0.3.0
+## 1.0.0
 
-* Updated README to present the crank syntax as the default
-
-* Appending the first argument with _attrs will return a hash of attributes rather than
-  the object, i.e. crank(:user) returns a User instance, and crank(:user_attrs) returns
-  a hash of valid attributes
-
-* Factory.attributes_for now returns a hash of attributes rather than an array, this
-  method is no longer dependent on rails
-
-* \#3 Factory methods can generate attribute hashes by default by setting :class => Hash in 
-  the define declaration (leemhenson)
-
-* Factory.debug was broken on ActiveModel based classes, now works with them
-
-* Attributes can be skipped by setting the value to :skip. e.g. crank(:user, :name => :skip) will
-  generate a User instance without calling or assigning anything to the name attribute
-
-* Updated dev environment for latest rspec compatibility (2.6.0)
-
-## 0.2.0 
-
-Changes between version prior to this were not tracked here
+* Initial baseline for future change tracking

data/README.md

@@ -202,10 +202,12 @@ def user
 end
 
 def apply_trait_admin_to_user(user)
+  # the 'options' method is available here
   user.roles << :admin
 end
 
 def apply_trait_manager_to_user(user)
+  # the 'options' method is available here
   user.roles << :manager
 end
 ~~~
@@ -220,6 +222,36 @@ def users_collection
 end
 ~~~
 
+You can inject code using callbacks...
+
+~~~ruby
+# factories/my_factories.rb
+class Cranky::Factory
+
+  def user
+    define name: 'Jimmy'
+  end
+  
+  private
+  
+  def after_build_user(user)
+    # the 'options' method is available here
+    do_something_to(user)
+  end
+
+  def before_create_user(user)
+    # the 'options' method is available here
+    do_something_to(user)
+  end
+
+  def after_create_user(user)
+    # the 'options' method is available here
+    do_something_to(user)
+  end
+
+end
+~~~
+
 ## Linting Factories
 
 Cranky allows for linting known factories:
@@ -235,7 +267,7 @@ Recommended usage of `Factory.lint!` is to run this in a task before your test s
 Example Rake task:
 
 ~~~ruby
-# lib/tasks/factory_girl.rake
+# lib/tasks/cranky.rake
 namespace :cranky do
   desc "Verify that all factories are valid"
   task lint: :environment do

data/lib/cranky/factory.rb

@@ -13,18 +13,28 @@ module Cranky
     end
 
     def build(what, overrides={})
-      crank_it(what, overrides)
+      item = crank_it(what, overrides)
+      call_after_build(what, item)
+
+      item
     end
 
     def create(what, overrides={})
       item = build(what, overrides)
-      Array(item).each(&:save)
+      Array(item).each do |i|
+        call_before_create(what, i)
+        i.save && call_after_create(what, i)
+      end
       item
     end
 
     def create!(what, overrides={})
       item = build(what, overrides)
-      Array(item).each(&:save!)
+      Array(item).each do |i|
+        call_before_create(what, i)
+        i.save!
+        call_after_create(what, i)
+      end
       item
     end
 
@@ -75,12 +85,13 @@ module Cranky
     end
 
     def factory_names
-      public_methods(false).reject {|m| TRAIT_METHOD_REGEXP === m  }
+      public_methods(false).reject {|m| TRAIT_METHOD_REGEXP === m  }.sort
     end
 
     def traits_for(factory_name)
       regexp = /^apply_trait_(\w+)_to_#{factory_name}$/.freeze
-      trait_methods = public_methods(false).select {|m| regexp === m  }
+      available_methods = private_methods(false) + public_methods(false)
+      trait_methods = available_methods.select {|m| regexp === m  }
       trait_methods.map {|m| regexp.match(m)[1] }
     end
 
@@ -94,10 +105,25 @@ module Cranky
 
     private
 
+      def call_after_build(what, item)
+        method_name = "after_build_#{what}"
+        respond_to?(method_name, true) && send(method_name, item)
+      end
+
+      def call_before_create(what, item)
+        method_name = "before_create_#{what}"
+        respond_to?(method_name, true) && send(method_name, item)
+      end
+
+      def call_after_create(what, item)
+        method_name = "after_create_#{what}"
+        respond_to?(method_name, true) && send(method_name, item)
+      end
+
       def apply_traits(what, item)
         Array(options[:traits]).each do |t|
           trait_method_name = "apply_trait_#{t}_to_#{what}"
-          fail("Invalid trait '#{t}'! No method '#{trait_method_name}' is defined.") unless respond_to?(trait_method_name)
+          respond_to?(trait_method_name, true) || fail("Invalid trait '#{t}'! No method '#{trait_method_name}' is defined.")
           send(trait_method_name, item)
         end
 

data/lib/cranky/linter.rb

@@ -6,16 +6,17 @@ module Cranky
       @factories_to_lint = factories_to_lint
       @linting_method = "lint_#{linting_strategy}"
       @invalid_factories = calculate_invalid_factories
+      @invalid_callbacks = calculate_invalid_callbacks
     end
 
     def lint!
-      if invalid_factories.any?
+      if invalid_factories.any? || invalid_callbacks.any?
         raise InvalidFactoryError, error_message
       end
     end
 
-    attr_reader :factories_to_lint, :invalid_factories
-    private :factories_to_lint, :invalid_factories
+    attr_reader :factories_to_lint, :invalid_factories, :invalid_callbacks
+    private :factories_to_lint, :invalid_factories, :invalid_callbacks
 
     private
 
@@ -27,6 +28,25 @@ module Cranky
       end
     end
 
+    def calculate_invalid_callbacks
+      result = []
+
+      regexp = /^(after_build|before_create|after_create)_(\w+)$/.freeze
+      available_methods = @factory.private_methods(false) + @factory.public_methods(false)
+      available_methods.select do |m|
+        match = regexp.match(m)
+        if match
+          factory_name = match[2]
+
+          unless @factory.respond_to?(factory_name)
+            result << m
+          end
+        end
+      end
+
+      result
+    end
+
     # Raised when any factory is considered invalid
     class InvalidFactoryError < RuntimeError; end
 
@@ -87,15 +107,26 @@ module Cranky
     end
 
     def error_message
+      [
+        factories_error_message,
+        callbacks_error_message
+      ].compact.join("\n\n".freeze)
+    end
+
+    def factories_error_message
       lines = invalid_factories.map do |_factory, exceptions|
         exceptions.map(&:message)
       end.flatten
 
-      <<-ERROR_MESSAGE.strip
-The following factories are invalid:
+      return if lines.empty?
+
+      "The following factories are invalid:\n\n#{lines.join("\n")}"
+    end
+
+    def callbacks_error_message
+      return if invalid_callbacks.empty?
 
-#{lines.join("\n")}
-      ERROR_MESSAGE
+      "The following callbacks are invalid:\n\n#{invalid_callbacks.join("\n")}"
     end
   end
 end

data/lib/cranky/version.rb

@@ -1,3 +1,3 @@
 module Cranky
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/cranky_spec.rb

@@ -4,15 +4,17 @@ describe "The Cranky factory" do
 
   describe '#factory_names' do
     it 'returns an array of names of defined factories' do
-      Factory.factory_names.should eq [:user,
-                                       :address,
-                                       :users_collection,
-                                       :user_manually,
-                                       :user_by_define,
-                                       :admin_manually,
-                                       :admin_by_define,
-                                       :user_hash,
-                                       :invalid_user]
+      Factory.factory_names.should eq %i(
+                                        address
+                                        admin_by_define
+                                        admin_manually
+                                        invalid_user
+                                        user
+                                        user_by_define
+                                        user_hash
+                                        user_manually
+                                        users_collection
+                                      )
     end
   end
 
@@ -144,10 +146,12 @@ describe "The Cranky factory" do
   it "allows factories to call other factories" do
     Factory.build(:user_manually).address.city.should == "New York"
     Factory.create(:user_manually).address.city.should == "New York"
+    Factory.create!(:user_manually).address.city.should == "New York"
     Factory.create(:user_manually).address.saved?.should == false
-    Factory.build(:user_by_define).address.city.should == "New York"
     Factory.create(:user_by_define).address.city.should == "New York"
     Factory.create(:user_by_define).address.saved?.should == true
+    Factory.create(:user_by_define).email.should == 'max@home.com'
+    Factory.create!(:user_by_define).email.should == 'max@home.com'
   end
 
   it "has its own syntax" do
@@ -184,7 +188,7 @@ describe "The Cranky factory" do
   end
 
   it "returns nothing extra in the attributes" do
-    crank(:user_attrs).size.should == 6
+    crank(:user_attrs).size.should == 4
   end
 
   specify "attributes for works with factory methods using inherit" do

data/spec/linter_spec.rb

@@ -5,8 +5,12 @@ describe 'Factory.lint' do
     error_message = <<-ERROR_MESSAGE.strip
 The following factories are invalid:
 
-* user_hash - undefined method `save!' for [:name, "Fred"]:Array (NoMethodError)
 * invalid_user - Validation failed: {:required_attr=>["can't be blank"]} (RuntimeError)
+* user_hash - undefined method `save!' for [:name, "Fred"]:Array (NoMethodError)
+
+The following callbacks are invalid:
+
+after_create_not_existing_factory
     ERROR_MESSAGE
 
     expect do
@@ -15,7 +19,14 @@ The following factories are invalid:
   end
 
   it 'does not raise when all factories are valid' do
-    expect { Factory.lint!(factory_names: [:admin_manually, :address]) }.not_to raise_error
+    error_message = <<-ERROR_MESSAGE.strip
+The following callbacks are invalid:
+
+after_create_not_existing_factory
+        ERROR_MESSAGE
+    expect do
+      Factory.lint!(factory_names: [:admin_manually, :address])
+    end.to raise_error Cranky::Linter::InvalidFactoryError, error_message
   end
 
   describe "trait validation" do
@@ -24,9 +35,13 @@ The following factories are invalid:
         error_message = <<-ERROR_MESSAGE.strip
 The following factories are invalid:
 
+* invalid_user - Validation failed: {:required_attr=>["can't be blank"]} (RuntimeError)
 * user+invalid - Validation failed: {:required_attr=>["can't be blank"]} (RuntimeError)
 * user_hash - undefined method `save!' for [:name, "Fred"]:Array (NoMethodError)
-* invalid_user - Validation failed: {:required_attr=>["can't be blank"]} (RuntimeError)
+
+The following callbacks are invalid:
+
+after_create_not_existing_factory
         ERROR_MESSAGE
 
         expect do

data/spec/spec_helper.rb

@@ -69,8 +69,6 @@ class Cranky::Factory
                :name => "Fred",
                :role => :user,
                :unique => "value#{n}",
-               :email => "fred@home.com",
-               :address => Factory.create(:address),
                :required_attr => true
     u.argument_received = true if options[:argument_supplied]
     u
@@ -101,6 +99,12 @@ class Cranky::Factory
     3.times.map { build(:user) }
   end
 
+  def invalid_user
+    inherit(:user, required_attr: false)
+  end
+
+  private
+
   def apply_trait_manager_to_user_manually(user)
     user.role = :manager
   end
@@ -109,7 +113,23 @@ class Cranky::Factory
     user.required_attr = nil
   end
 
-  def invalid_user
-    inherit(:user, required_attr: false)
+  def after_build_user_by_define(user)
+    if user.respond_to?('[]')
+      user[:email] = 'fred@home.com'
+    else
+      user.email = 'fred@home.com'
+    end
+  end
+
+  def before_create_user_by_define(user)
+    user.address = create!(:address)
+  end
+
+  def after_create_user_by_define(user)
+    user.email = 'max@home.com'
+  end
+
+  def after_create_not_existing_factory(user)
+    user.address = create!(:address)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cranky
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-06 00:00:00.000000000 Z
+date: 2016-12-28 00:00:00.000000000 Z
 dependencies: []
 description: A very light yet powerful test factory framework with an extremely clean
   syntax that makes it very easy to define your factories.
@@ -51,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.4
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: A very light yet powerful test factory framework.