cranky 0.2.0 → 0.3.0

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Overview of Changes
+
+## 0.3.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

data/Gemfile

@@ -1,11 +1,13 @@
 source "http://gemcutter.org"
 
 group :development do
+  gem "rake"
   gem "gemcutter"
+  gem "ruby-debug19", :require => 'ruby-debug'
 end
 
 group :test do
-  gem "rspec", "1.3.0"
+  gem "rspec"
   gem "rcov"
 end
 

data/Gemfile.lock

@@ -1,14 +1,39 @@
 GEM
   remote: http://gemcutter.org/
   specs:
-    gemcutter (0.6.1)
-    rcov (0.9.8)
-    rspec (1.3.0)
+    archive-tar-minitar (0.5.2)
+    columnize (0.3.4)
+    diff-lcs (1.1.2)
+    gemcutter (0.7.0)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    rake (0.9.2)
+    rcov (0.9.9)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   gemcutter
+  rake
   rcov
-  rspec (= 1.3.0)
+  rspec
+  ruby-debug19

data/README.rdoc

@@ -1,6 +1,7 @@
 = Cranky
 
-Cranky is a fixtures replacement inspired by the excellent Factory Girl, but simpler and with less magic going on.
+Cranky is a fixtures replacement inspired by the excellent Factory Girl but with easier syntax and no external
+dependencies, it will work straight out of the box with rails 10.
 
 In short use this if you want to quickly and naturally create factory methods that you feel 100% in control of.
 
@@ -10,10 +11,7 @@ First install the gem...
 
   gem install cranky
 
-Or for rails stick it in your environment.rb or Gemfile as normal...
-
-  # environment.rb
-  config.gem "cranky"
+Or with bundler...
 
   # Gemfile
   gem "cranky"
@@ -29,7 +27,14 @@ You can create as many different factory files as you want, just require them in
 
 == In a Nutshell
 
-Cranky steals its core syntax from Factory Girl and can drop into tests already written for that framework...
+The API to use in your tests is:
+
+  crank(:user)                  # Build a user instance without saving
+  crank!(:user)                 # Build and save a user instance
+  crank(:user, :name => "Ian")  # Override a default attribute value
+  crank(:user_attrs)            # Return a set of valid attributes rather than the object
+
+Alternatively the Factory Girl syntax also works and therefore Cranky can drop into tests already written for that framework...
 
   Factory.build(:user)                  # Build a user instance without saving
   Factory.create(:user)                 # Build and save a user instance
@@ -50,7 +55,7 @@ Cranky has a nice debug option (rails only) to warn you when your factory is bro
 Cranky allows you to build factories via std Ruby methods, like this...
 
   # factories/my_factories.rb
-  class Cranky::Factory     # Your factory must extend Cranky::Factory
+  class Cranky::Factory     # Your factory must reopen Cranky::Factory
 
     # Simple factory method to create a user instance, you would call this via Factory.build(:user)
     def user
@@ -89,7 +94,7 @@ This is where Cranky really shines, if you can create Ruby methods you can prett
 
 The only rules are:
 
-1. Your factory must extend the Cranky::Factory class
+1. Your factory must reopen the Cranky::Factory class
 2. Your factory method must return the object you wanted to create
 3. You can access the overrides passed in via options[:key]  (not really a rule!) 
 

data/lib/cranky/factory.rb

@@ -31,7 +31,7 @@ module Cranky
     end
 
     def attributes_for(what, attrs={})
-      build(what, attrs).attributes
+      build(what, attrs.merge(:_return_attributes => true))
     end
 
     # Can be left in your tests as an alternative to build and to warn if your factory method 
@@ -39,7 +39,12 @@ module Cranky
     def debug(*args)
       item = build(*args) 
       if !item.valid?
-        raise "Oops, the #{item.class} created by the Factory has the following errors: #{item.errors}"
+        if item.errors.respond_to?("messages")
+          errors = item.errors.messages
+        else
+          errors = item.errors
+        end
+        raise "Oops, the #{item.class} created by the Factory has the following errors: #{errors}"
       end
       item
     end
@@ -63,6 +68,10 @@ module Cranky
 
       # Execute the requested factory method, crank out the target object!
       def crank_it(what, overrides)
+        if what.to_s =~ /(.*)_attrs$/
+          what = $1
+          overrides = overrides.merge(:_return_attributes => true)
+        end
         item = "TBD"
         new_job(what, overrides) do
           item = self.send(what)        # Invoke the factory method

data/lib/cranky/job.rb

@@ -8,6 +8,7 @@ module Cranky
       @defaults = {}
       @target = target
       @overrides = overrides
+      @return_attributes = overrides.delete(:_return_attributes)
     end
 
     def attributes
@@ -19,23 +20,43 @@ module Cranky
       @defaults = defs
     end
 
-    def execute
-      item = get_constant(attributes[:class] ? attributes[:class] : @target).new
-      # Assign all explicit attributes first
-      attributes.each do |attribute, value|
-        item.send("#{attribute}=", value) if item.respond_to?("#{attribute}=") && !value.respond_to?("call")
+    # Returns the created item
+    def item
+      return @item if @item
+      if @return_attributes
+        @item = Hash.new
+      else
+        @item = get_constant(attributes[:class] ? attributes.delete(:class) : @target).new
       end
-      # Then call any blocks
-      attributes.each do |attribute, value|
-        item.send("#{attribute}=", value.call(item)) if item.respond_to?("#{attribute}=") && value.respond_to?("call")
+    end
+
+    # Assign the value to the given attribute of the item
+    def assign(attribute, value)
+      unless value == :skip || attribute == :class
+        if item.respond_to?("#{attribute}=")
+          item.send("#{attribute}=", value)
+        elsif item.is_a?(Hash)
+          item[attribute] = value
+        end
       end
+    end
+
+    def execute
+      values = attributes.reject { |attribute, value| value.respond_to?("call") }
+      blocks = attributes.select { |attribute, value| value.respond_to?("call") }
+
+      values.each { |attribute, value| assign(attribute, value) }
+      blocks.each { |attribute, value| assign(attribute, value.call(*(value.arity > 0 ? [item] : []))) }
+
       item
     end
 
     private
 
-      # Nicked from here: http://gist.github.com/301173 
+      # Nicked from here: http://gist.github.com/301173
       def get_constant(name_sym)
+        return name_sym if name_sym.is_a? Class
+
         name = name_sym.to_s.split('_').collect {|s| s.capitalize }.join('')
         Object.const_defined?(name) ? Object.const_get(name) : Object.const_missing(name)
       end

data/lib/cranky/version.rb

@@ -1,3 +1,3 @@
 module Cranky
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/cranky_spec.rb

@@ -5,19 +5,21 @@ describe "The Cranky factory" do
   before(:each) do
   end
 
-  it "should be alive" do
+  it "is alive" do
     Factory.build(:user).class.should == User
   end
 
-  it "should not save the item when generated via build" do 
+  it "does not save the item when generated via build or crank" do 
     Factory.build(:user).saved?.should == false
+    crank(:user).saved?.should == false
   end
 
-  it "should save the item when generated via create" do 
+  it "does save the item when generated via create or crank!" do 
     Factory.create(:user).saved?.should == true
+    crank!(:user).saved?.should == true
   end
 
-  it "should allow all attributes to be overriden in the call" do
+  it "allows all attributes to be overriden in the call" do
     u = Factory.build(:user, :name => "Indy", :email => "indy@home.com", :role => :dog, :unique => :yep)
     u.name.should == "Indy"
     u.email.should == "indy@home.com"
@@ -25,19 +27,18 @@ describe "The Cranky factory" do
     u.unique.should == :yep
   end
 
-  it "should return valid attributes rather than the model (rails only)" do
-    attrs = Factory.attributes_for(:user)
-    attrs.class.should == Array
+  it "returns valid attributes rather than the model" do
+    Factory.attributes_for(:user).class.should == Hash
   end
 
-  it "should clear all instance variables when reset" do
+  it "clears all instance variables when reset" do
     Factory.some_instance_variable = true
     Factory.some_instance_variable.should == true
     Factory.reset
     Factory.some_instance_variable.should == nil
   end
 
-  it "should be able to create items using the define helper or manually" do
+  it "can create items using the define helper or manually" do
     m = Factory.build(:user_manually)
     d = Factory.build(:user_by_define)
     m.name.should ==  d.name
@@ -45,7 +46,7 @@ describe "The Cranky factory" do
     m.role.should ==  d.role
   end
 
-  it "should be able to build by inheriting and overriding from other methods" do
+  it "can build by inheriting and overriding from other methods" do
     a = Factory.build(:admin_manually)
     a.name.should == "Fred"
     a.role.should == :admin
@@ -54,14 +55,14 @@ describe "The Cranky factory" do
     b.role.should == :admin
   end
 
-  it "should give top priority to attributes defined at the top level, even when inheriting" do
+  it "gives top priority to attributes defined at the top level, even when inheriting" do
     a = Factory.build(:admin_manually, :role => :something_else)
     a.role.should == :something_else
     b = Factory.build(:admin_by_define, :role => :something_else)
     b.role.should == :something_else
   end
 
-  it "should create unique values using the n method" do
+  it "creates unique values using the n method" do
     a = Factory.build(:user)  
     b = Factory.build(:user)  
     c = Factory.build(:user)  
@@ -72,7 +73,7 @@ describe "The Cranky factory" do
   
   describe "debugger" do 
 
-    it "should raise an error if the factory produces an invalid object when enabled (rails only)" do
+    it "raises an error if the factory produces an invalid object when enabled (rails only)" do
       error = false
       begin
         Factory.debug(:user, :valid => false)
@@ -82,7 +83,7 @@ describe "The Cranky factory" do
       error.should == true
     end
 
-    it "should have debug work like build and create when there are no errors" do
+    it "debug works like build and create when there are no errors" do
       Factory.debug(:user).class.should == User
       Factory.debug(:user).saved?.should == false
       Factory.debug!(:user).saved?.should == true
@@ -90,16 +91,16 @@ describe "The Cranky factory" do
 
   end
 
-  it "should allow arguments to be passed in the overrides hash" do
+  it "allows arguments to be passed in the overrides hash" do
     Factory.build(:user).argument_received.should == nil
     Factory.build(:user, :argument_supplied => true).argument_received.should == true
   end
 
-  it "should allow blocks to be passed into the define method" do
+  it "allows blocks to be passed into the define method" do
     Factory.build(:user, :name => "jenny", :email => lambda{ |u| "#{u.name}@home.com" }).email.should == "jenny@home.com"
-    Factory.build(:user, :name => lambda{"jimmy" + " cranky"}).name.should == "jimmy cranky"
+    Factory.build(:user, :name => lambda { |u| "jimmy" + " cranky" }).name.should == "jimmy cranky"
     Factory.build(:user, :name => "jenny", :email => Proc.new{ |u| "#{u.name}@home.com" }).email.should == "jenny@home.com"
-    Factory.build(:user, :name => Proc.new{"jimmy" + " cranky"}).name.should == "jimmy cranky"
+    Factory.build(:user, :name => Proc.new{ |u| "jimmy" + " cranky" }).name.should == "jimmy cranky"
   end
 
   it "allows factories to call other factories" do
@@ -111,10 +112,33 @@ describe "The Cranky factory" do
     Factory.create(:user_by_define).address.saved?.should == true
   end
 
-  it "should also have its own syntax" do
+  it "has its own syntax" do
     crank(:user).saved?.should == false
     crank!(:address).saved?.should == true
   end
-  
+
+  it "is capable of creating user hashes" do
+    Factory.build(:user_hash)[:name].should == "Fred"
+    Factory.build(:user_hash)[:role].should == :user
+    Factory.build(:user_hash)[:class].should be_nil
+  end
+
+  it "is capable of overriding user hashes" do
+    Factory.build(:user_hash, :role => :admin)[:role].should == :admin
+  end
+
+  specify "attributes are not assigned when they have the value :skip" do
+    crank(:user, :name => :skip).name.should_not be
+  end
+
+  it "returns an hash of attributes when the 1st argument is appended with _attrs" do
+    crank(:user_attrs).class.should == Hash
+    crank(:user_attrs, :name => "Yo")[:name].should == "Yo"
+  end
+
+  it "returns nothing extra in the attributes" do
+    crank(:user_attrs).size.should == 6
+  end
+
 end
 

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-require 'spec'
+require 'rspec'
 require 'cranky'
 
 
@@ -86,6 +86,11 @@ class Cranky::Factory
            :valid => true
   end
 
+  def user_hash
+    define :class => Hash,
+           :name => "Fred",
+           :role => :user
+  end
 end
 
 

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: cranky
 version: !ruby/object:Gem::Version 
-  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Stephen McGinty
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-22 00:00:00 -05:00
+date: 2011-10-16 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -28,16 +27,17 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/cranky/job.rb
 - lib/cranky/factory.rb
 - lib/cranky/version.rb
+- lib/cranky/job.rb
 - lib/cranky.rb
 - spec/spec_helper.rb
 - spec/cranky_spec.rb
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
 - README.rdoc
 - LICENSE
-- Gemfile.lock
-- Gemfile
 - init.rb
 has_rdoc: true
 homepage: http://github.com/ginty/cranky
@@ -53,7 +53,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: -860389489
       segments: 
       - 0
       version: "0"
@@ -62,7 +62,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 19
       segments: 
       - 1
       - 3