brightbox-object-factory 0.1.3 → 0.2.2

data/CHANGELOG

@@ -1,3 +1,11 @@
+= Version 0.2.0 (2009-05-20)
+
+Added clean_up options
+
+= Version 0.1.4 (2009-03-25)
+
+Added a_number to allow the generation of unique integers
+
 = Version 0.1.3 (2008-12-08)
 
 Added generate_ip_address

data/Manifest

@@ -0,0 +1,11 @@
+CHANGELOG
+github.rb
+init.rb
+lib/object_factory.rb
+Manifest
+object-factory.gemspec
+Rakefile
+README.rdoc
+spec/object_spec.rb
+spec/spec.opts
+tasks/rspec.rake

data/README.rdoc

@@ -10,7 +10,7 @@ If you don't use the a_saved method then it should work with any type of model,
   
 == Usage
 
-See the wiki page at http://github.com/brightbox/object-factory/wikis/home for the latest docs.
+See the wiki page at http://github.com/brightbox/object-factory/wikis/home for the latest docs.  In particular, http://wiki.github.com/brightbox/object-factory/usage-with-rails-rspec-and-cucumber is a pretty good example of how to get started.  
 
 However, it works something like this: 
 
@@ -28,11 +28,33 @@ And your options are:
 * :set => { :field3 => 'value3', :field4 => 'value4' }: sets the given fields to the supplied static values
 * :generate => { :field5 => lambda { Date.today } }: sets the given fields to the supplied dynamic values
 
+If you want to generate a unique value yourself, you can use Object::Factory's next_number call (which has a simple shortcut a_number).  
+
+  :generate => { :field => "unique-value-#{a_number}" }
+
+== Cleaning up
+
+(currently only for ActiveRecord)
+
+If you register your (ActiveRecord) class with the clean_up option, then the factory can ensure that all instances are deleted.  This is useful if you cannot use transactional_fixtures (for example using Watir or Culerity in your test suite).  
+
+Add a clean_up parameter when registering your classes: 
+  
+  when_creating_a Person, :auto_generate => [:first_name, :last_name], :clean_up => true
+  
+Then in your "after" section call: 
+
+  Object.factory.clean_up
+  
+This will call delete_all on any registered classes (hence it is currently ActiveRecord only).  
+
 == Rails
 
 To use this with rails, stick the following in your +environment.rb+:
 
   config.gem "brightbox-object-factory", :lib => "object_factory", :source => "http://gems.github.com"
+  
+Also check out http://wiki.github.com/brightbox/object-factory/usage-with-rails-rspec-and-cucumber for more information on integrating Object-Factory with your application.  
 
 == Released under the MIT Licence
 

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('object-factory', '0.1.3') do | config | 
+Echoe.new('object-factory', '0.2.2') do | config | 
   config.description = 'A simple object factory to help you build valid objects in your tests'
   config.url = 'http://github.com/brightbox/object-factory'
   config.author = 'Brightbox Systems Ltd'

data/github.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+require 'yaml'
+ 
+if ARGV.size < 1
+  puts "Usage: github-test.rb my-project.gemspec"
+  exit
+end
+ 
+require 'rubygems/specification'
+data = File.read(ARGV[0])
+spec = nil
+ 
+if data !~ %r{!ruby/object:Gem::Specification}
+  Thread.new { spec = eval("$SAFE = 3\n#{data}") }.join
+else
+  spec = YAML.load(data)
+end
+ 
+spec.validate
+ 
+puts spec
+puts "OK"

data/lib/object_factory.rb

@@ -25,6 +25,14 @@ class Object
     def reset
       @confirmed_fields = {}
       @generators = {}
+      @classes_for_clean_up = []
+    end
+    
+    # clean up all instances
+    def clean_up
+      @classes_for_clean_up.each do | klass | 
+        klass.delete_all
+      end
     end
   
     # Create a new instance of the given class with the given parameters and apply the auto-generated fields, according to the configured rules
@@ -59,6 +67,7 @@ class Object
       need_to_generate_ip_addresses_for klass, options[:generate_ip_address] unless options[:generate_ip_address].nil?
       need_to_set_values_for klass, options[:set] unless options[:set].nil? 
       need_to_set_generators_for klass, options[:generate] unless options[:generate].nil?
+      register_for_clean_up klass if options[:clean_up]
     end
     
     alias :when_creating_an :when_creating_a
@@ -69,6 +78,11 @@ class Object
       @generator ||= ValueGenerator.new
     end
     
+    # Generate a unique Integer
+    def next_number
+      generator.unique_integer
+    end
+    
     # A simple class that generates unique values
     class ValueGenerator
       def initialize
@@ -84,7 +98,7 @@ class Object
       end
     end
     
-    #�Error raised when create_and_save_a cannot save the object
+    # Error raised when create_and_save_a cannot save the object
     class CannotSaveError < RuntimeError; end
     
     # print the rules for a given class
@@ -97,7 +111,7 @@ class Object
       end
     end
     
-    private
+  private
       
     def symbol_for object
       klass = object.is_a?(Class) ? object : object.class
@@ -170,6 +184,10 @@ class Object
         instance.send("#{field_name.to_sym}=".to_sym, value) unless parameters.has_key?(field_name.to_sym)
       end
     end
+    
+    def register_for_clean_up klass
+      @classes_for_clean_up << klass
+    end
   end
   
 end
@@ -196,4 +214,9 @@ end
 
 alias when_creating_an when_creating_a
 
+# Short-cut method for Object::Factory#next_number
+def a_number
+  Object.factory.next_number
+end
+
 THE_OBJECT_FACTORY_INSTANCE = Object::Factory.new

data/object-factory.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{object-factory}
-  s.version = "0.1.3"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brightbox Systems Ltd"]
-  s.date = %q{2008-12-08}
+  s.date = %q{2009-05-21}
   s.description = %q{A simple object factory to help you build valid objects in your tests}
   s.email = %q{hello@brightbox.co.uk}
   s.extra_rdoc_files = ["CHANGELOG", "lib/object_factory.rb", "README.rdoc", "tasks/rspec.rake"]
-  s.files = ["CHANGELOG", "init.rb", "lib/object_factory.rb", "Manifest", "object-factory.gemspec", "Rakefile", "README.rdoc", "spec/object_spec.rb", "spec/spec.opts", "tasks/rspec.rake"]
+  s.files = ["CHANGELOG", "github.rb", "init.rb", "lib/object_factory.rb", "Manifest", "object-factory.gemspec", "Rakefile", "README.rdoc", "spec/object_spec.rb", "spec/spec.opts", "tasks/rspec.rake"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/brightbox/object-factory}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Object-factory", "--main", "README.rdoc"]

data/spec/object_spec.rb

@@ -97,6 +97,7 @@ describe Object::Factory, "creating simple instances" do
   it "should raise an exception if the auto-saved object cannot be saved" do
     @test_instance = mock('Test Instance')
     TestClass.should_receive(:new).with({:some => :values}).and_return(@test_instance)
+    @test_instance.should_receive(:errors).and_return(['errors'])
     @test_instance.should_receive(:save).and_return(false)
     
     lambda { 
@@ -299,4 +300,38 @@ describe Object::Factory, "using lambdas to generate values" do
     @instance.field.should == 'poop'
     @instance.another_field.should == Date.today.to_s
   end
+end
+
+describe Object::Factory, "generating sequential numbers" do
+  before :each do
+    Object.factory.reset
+  end
+  
+  it "should generate a sequential number" do
+    first = Object.factory.next_number
+    second = Object.factory.next_number
+    
+    second.should == first + 1
+  end
+  
+  it "should use the shortcut to generate a sequential number" do
+    Object.factory.should_receive(:next_number).and_return(1)
+    number = a_number
+  end
+end
+
+describe Object::Factory, "cleaning up ActiveRecord models" do
+  before :each do
+    Object.factory.reset
+  end
+  
+  it "should delete all instances for registered classes" do
+    Object.factory.when_creating_a TestClass, :auto_confirm => :password, :clean_up => true
+    Object.factory.when_creating_an AnotherTestClass, :clean_up => true
+    
+    TestClass.should_receive(:delete_all).and_return(0)
+    AnotherTestClass.should_receive(:delete_all).and_return(0)
+    
+    Object.factory.clean_up
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: brightbox-object-factory
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.2.2
 platform: ruby
 authors: 
 - Brightbox Systems Ltd
@@ -9,11 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-08 00:00:00 -08:00
+date: 2009-05-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: brightbox-rujitsu
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -34,6 +35,7 @@ extra_rdoc_files:
 - tasks/rspec.rake
 files: 
 - CHANGELOG
+- github.rb
 - init.rb
 - lib/object_factory.rb
 - Manifest