jim-summon 0.0.0 → 0.1.0

data/.gitignore

@@ -3,3 +3,4 @@
 coverage
 rdoc
 pkg
+test.log

data/README.rdoc

@@ -2,7 +2,108 @@
 
 Provides a nice DSL for creating dummy data using Factory Girl factory definitions.
 
-Docs and examples coming soon.
+== Why
+
+Now that you've moved away from fixtures (well, you have, haven't you?) and started using factory_girl
+in your tests and specs, it would be nice to have a succinct way to generate dummy data for use in development.
+
+In the past I've just used a bunch of extra factories for this, but it's a lot nicer to be able to build an
+arbitrary number of objects, each with its own set of associations.
+
+== Example
+
+Here is an example Rakefile from a project I'm working on:
+
+  namespace :summon do
+    desc "Builds a ton of dummy data"
+    task :build => ['environment', 'db:reset'] do
+  
+      require 'spec/support/factories' # load factory definitions
+      require 'summon'
+      
+      published_date = lambda {
+        method = %w(ago since)[rand(2)]
+        rand(100).days.send(method)
+      }
+  
+      Summon(:label, 5)
+      Summon(:blog_topic, 10)
+  
+      Summon(:user, 20) do |user|
+        user.blogs(3..8,
+          :topic => BlogTopic.all,
+          :published_at => published_date
+        ) do |blog|
+          blog.comments 0..4
+        end
+      end
+  
+      Summon(:artist, 20) do |artist|
+        artist.events 4..6
+        artist.releases(0..5,
+         :label => Label.all
+        ) do |release|
+         release.tracks 8..12
+        end
+      end
+ 
+      puts "Your minions are ready!"
+ 
+    end
+  end
+
+== Installation
+
+I'd go for the gem.
+
+  sudo gem install jim-summon
+
+== Usage
+
+=== Specifying how many objects to build
+
+You can use an integer or range when specifying how many objects to build:
+
+  Summon(:monkey, 3)         # build 3 monkeys
+  Summon(:monkey, 3..6)      # build between 3 and 6 monkeys
+
+=== Object attributes
+
+Other attributes to set on created objects (potentially overriding those defined by the factory)
+are passed in as a hash:
+
+  Summon(:monkey, 42, :dangerous => true)     # builds 42 dangerous monkeys
+    
+If you pass a proc in as an attribute, it will be evaluated for each object and the resulting 
+value used in its place.
+
+If you pass an Array in as a value to an attribute, a value from the array will be selected at 
+random. This might seem odd, but I've found it's much more common to want to set an attribute 
+or association randomly from a set of options than set an attribute value to be an array. You 
+can always use a proc for this.
+
+== Associated objects
+
+This is where the magic really happens. Use a block to define an object's associations, and 
+potentially their attributes:
+
+  Summon(:car, 4) do |car|    # Build 4 cars, and in each...
+    car.passengers 3          # Build 3 passengers
+    car.driver                # Build one driver
+  end
+    
+Right now has_many and has_one associations are supported. has_many :through is not. Associations 
+can be nested as deep as you like:
+
+  Summon(:car, 4, :color => 'red') do |car|
+    car.passengers 3, :backseat_driver => true
+    car.driver do |driver|
+      driver.gloves 2             
+      driver.jacket do |jacket|
+        jacket.pockets 2, :cents => [0,5,10,25,50]
+      end
+    end
+  end
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -5,7 +5,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "summon"
-    gem.summary = %Q{Provided a nice DSL for creating dummy data using Factory Girl factory definitions}
+    gem.summary = %Q{Provides a nice DSL for creating dummy data using Factory Girl factory definitions}
     gem.description = %Q{Allows for easily setting up deeply nested associations}
     gem.email = "jim@autonomousmachine.com"
     gem.homepage = "http://github.com/jim/summon"

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/lib/summon.rb

@@ -1,7 +1,12 @@
 require 'factory_girl'
 
 module Summon
-  
+
+  (class << self; self; end).class_eval do
+    attr_accessor :noisy
+  end
+  self.noisy = false
+    
   class Conjure
 
     attr :parent
@@ -11,7 +16,7 @@ module Summon
     end
 
     def log(string)
-      if parent.nil?
+      if parent.nil? && Summon.noisy
         printf string; $stdout.flush
       end
     end
@@ -31,7 +36,7 @@ module Summon
         end
       end
       
-      quantity = args.first      
+      quantity = args.first || 1
       quantity = quantity.to_a[rand(quantity.to_a.size)] if quantity.is_a?(Range)
       options = args.extract_options!
 
@@ -46,7 +51,17 @@ module Summon
         if parent.nil?
           child = Factory(name, attributes)
         else
-          child = parent.send(name).create(Factory.attributes_for(name.to_s.singularize, attributes))
+          association = @parent.class.reflect_on_association(name.to_sym)
+          raise "Association #{name} not found on #{@parent.class.to_s}" unless association
+          
+          child = case association.macro
+            when :has_one:
+              parent.send("#{name}=", Factory(name.to_s.singularize, attributes))
+            when :has_many:
+              parent.send(name).create(Factory.attributes_for(name.to_s.singularize, attributes))
+            else
+              raise "#{association.macro} macros are not supported"
+          end
         end
         yield Conjure.new(child) if block_given?
       end

data/summon.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{summon}
-  s.version = "0.0.0"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jim Benton"]
-  s.date = %q{2009-08-25}
+  s.date = %q{2009-08-26}
   s.description = %q{Allows for easily setting up deeply nested associations}
   s.email = %q{jim@autonomousmachine.com}
   s.extra_rdoc_files = [
@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.3}
-  s.summary = %q{Provided a nice DSL for creating dummy data using Factory Girl factory definitions}
+  s.summary = %q{Provides a nice DSL for creating dummy data using Factory Girl factory definitions}
   s.test_files = [
     "test/summon_test.rb",
      "test/test_helper.rb"

data/test/summon_test.rb

@@ -1,7 +1,53 @@
 require 'test_helper'
 
-class SummonTest < Test::Unit::TestCase
-  def test_pass
-    assert true, 'had better pass'
+class SummonTest < ActiveSupport::TestCase
+  
+  def setup
+    Summon.noisy = false
+    Corner.delete_all
+    Compartment.delete_all
+    Handle.delete_all
+    Box.delete_all
+    Secret.delete_all
   end
-end
+
+  test "building a number of objects" do
+    Summon(:corner, 3)
+    assert_equal 3, Corner.count
+  end
+  
+  test "building a variable number of objects" do
+    Summon(:corner, 3..5)
+    assert_operator 3..5, :===, Corner.count
+  end
+  
+  test "overriding default factory attributes" do
+    Summon(:corner, 1, :sharp => false)
+    assert_equal false, Corner.first.sharp
+  end
+  
+  test "building has_many associations" do
+    Summon(:box, 1) do |b|
+      b.corners 3
+      b.compartments 2 do |c|
+        c.secrets 4
+      end
+    end
+    assert_equal 3, Box.first.corners.count
+    assert_equal 3, Corner.count
+    assert_equal 2, Box.first.compartments.count
+    assert_equal 2, Compartment.count
+    assert_equal 8, Secret.count
+  end
+  
+  test "building has_one associations" do
+    Summon(:box, 1) do |b|
+      b.compartments 2 do |c|
+        c.handle
+      end
+    end
+    assert_equal 2, Compartment.count
+    assert_equal 2, Handle.count
+  end
+  
+end

data/test/test_helper.rb

@@ -1,9 +1,78 @@
 require 'rubygems'
+gem 'test-unit'
 require 'test/unit'
+require 'active_support'
+require 'active_support/test_case'
+require 'active_record'
+require 'factory_girl'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'summon'
 
-class Test::Unit::TestCase
+ActiveRecord::Base.logger = Logger.new(File.open('test.log', 'a'))
+ActiveRecord::Base.logger.level = Logger::DEBUG
+ActiveRecord::Base.colorize_logging = false
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database => ":memory:"
+)
+
+ActiveRecord::Schema.define do
+  create_table :boxes, :force => true do |t|
+    t.string :name
+    t.integer :depth
+  end
+  create_table :corners, :force => true do |t|
+    t.integer :box_id
+    t.boolean :sharp
+  end
+  create_table :compartments, :force => true do |t|
+    t.integer :box_id
+    t.boolean :hidden
+  end
+  create_table :handles, :force => true do |h|
+    h.integer :compartment_id
+    h.boolean :metal
+  end
+  create_table :secrets, :force => true do |s|
+    s.integer :compartment_id
+    s.boolean :valuable
+  end
+end
+
+class Corner < ActiveRecord::Base; end
+class Secret < ActiveRecord::Base; end
+class Handle < ActiveRecord::Base; end
+
+class Compartment < ActiveRecord::Base
+  has_many :secrets
+  has_one :handle
+end
+
+class Box < ActiveRecord::Base
+  has_many :compartments
+  has_many :corners
+end
+
+Factory.define(:box) do |b|
+  b.name 'A box'
+  b.depth 12
+end
+
+Factory.define(:corner) do |c|
+  c.sharp true
+end
+
+Factory.define(:compartment) do |c|
+  c.hidden true
+end
+
+Factory.define(:handle) do |h|
+  h.metal true
 end
+
+Factory.define(:secret) do |c|
+  c.valuable true
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jim-summon
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Jim Benton
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-25 00:00:00 -07:00
+date: 2009-08-26 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,7 +67,7 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
-summary: Provided a nice DSL for creating dummy data using Factory Girl factory definitions
+summary: Provides a nice DSL for creating dummy data using Factory Girl factory definitions
 test_files: 
 - test/summon_test.rb
 - test/test_helper.rb