ryanb-populator 0.1.0 → 0.2.1

data/CHANGELOG

@@ -1,3 +1,23 @@
+* performance improvements
+
+* improving inline documentation
+
+*0.2.1* (August 30th, 2008)
+
+* wrap sqlite inserts in transaction to improve performance
+
+* default created_at/on and updated_at/on columns to current time
+
+*0.2.0* (August 30th, 2008)
+
+* adding :per_query option to limit how many inserts are made per query
+
+* improving performance when nesting factories
+
+* adding Populator.sentences to generate a lot of text
+
+* adding Populator.words to fetch some random words
+
 *0.1.0* (August 27th, 2008)
 
 * initial release

data/Manifest

@@ -3,18 +3,25 @@ lib/populator/adapters/abstract.rb
 lib/populator/adapters/sqlite.rb
 lib/populator/factory.rb
 lib/populator/model_additions.rb
+lib/populator/random.rb
 lib/populator/record.rb
 lib/populator.rb
 LICENSE
 Manifest
 populator.gemspec
+Rakefile
 README
 spec/database.yml
+spec/example_database.yml
+spec/models/category.rb
 spec/models/product.rb
 spec/populator/factory_spec.rb
 spec/populator/model_additions_spec.rb
+spec/populator/random_spec.rb
 spec/populator/record_spec.rb
 spec/README
+spec/spec.opts
 spec/spec_helper.rb
 tasks/deployment.rake
 tasks/spec.rake
+TODO

data/README

@@ -10,7 +10,7 @@ this code is loosely based on.
 
 Install the gem:
 
-	gem install ryanb-populator --source http://gems.github.com
+  gem install populator
 
 And then load it in your project:
 
@@ -19,8 +19,6 @@ And then load it in your project:
 
 == Usage
 
-STILL IN EARLY DEVELOPMENT - so some of this doesn't work yet.
-
 This gem adds a "populate" method to all Active Record models. Pass the 
 number of records you want to create along with a block. In the block 
 you can set the column values for each record.
@@ -30,10 +28,7 @@ you can set the column values for each record.
     person.last_name = "Smith"
   end
 
-This will do a mass insert into the database so it is very fast. For 
-performance reasons, "person" is not an instance of the model. It's 
-just a simple interface for setting the column values.
-
+This will do a mass insert into the database so it is very fast.
 The person object contains the "id" so you can set up associations.
 
   Person.populate(3000) do |person|
@@ -56,12 +51,36 @@ Passing an range or array of values will randomly select one.
 This will create 1000 to 5000 men or women with the annual income 
 between 10,000 and 200,000.
 
+You can pass a :per_query option to limit how many records are saved 
+per query. This defaults to 1000.
+
+  Person.populate(2000, :per_query => 100)
+
+If you need to generate fake data, there are a few methods to do this.
+
+  Populator.words(3) # generates 3 random words separated by spaces
+  Populator.words(10..20) # generates between 10 and 20 random words
+  Populator.sentences(5) # generates 5 sentences
+
+For fancier data generation, try the Faker gem.
+
+http://faker.rubyforge.org
+
+
+== Important
+
+For performance reasons, this gem does not use actual instances of the 
+model. This means validations and callbacks are bypassed. It is up to 
+you to ensure you're adding valid data.
+
 
 == Development
 
+See spec/README for instructions on running specs.
+
 This project can be found on github at the following URL.
 
-http://github.com/ryanb/populator/
+http://github.com/ryanb/populator
 
 If you would like to contribute to this project, please fork the 
 repository and send me a pull request.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('populator', '0.2.1') do |p|
+  p.summary        = "Mass populate an Active Record database."
+  p.description    = "Mass populate an Active Record database."
+  p.url            = "http://github.com/ryanb/populator"
+  p.author         = 'Ryan Bates'
+  p.email          = "ryan (at) railscasts (dot) com"
+  p.ignore_pattern = ["script/*", "**/*.sqlite3"]
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/TODO

@@ -0,0 +1,20 @@
+Features
+- get single table inheritance working.
+
+Possible
+- iterate through array instead of selecting at random to ensure all values are chosen
+- if hash is passed, apply given value that number of times: { 'foo' => 3, 'bar' => 2 }
+- randomly fill every column if no block is passed to populate
+- add random_foo method to record for randomly generating content
+
+Performance
+- ensure instantiating the model is really that much of a performance hit.
+
+Support Environments
+- sqlite 2
+- old rails
+- edge rails
+
+Tests
+- automatically detect schema changes and rebuild database
+- add db:reset, db:drop and db:create rake tasks

data/lib/populator/adapters/abstract.rb

@@ -13,6 +13,6 @@ module Populator
   end
 end
 
-class ActiveRecord::ConnectionAdapters::AbstractAdapter
+ActiveRecord::ConnectionAdapters::AbstractAdapter.class_eval do
   include Populator::Adapters::Abstract
 end

data/lib/populator/adapters/sqlite.rb

@@ -3,7 +3,11 @@ module Populator
     module Sqlite
       # Executes multiple SQL statements in one query when joined with ";"
       def execute_batch(sql, name = nil)
-        catch_schema_changes { log(sql, name) { @connection.execute_batch(sql) } }
+        catch_schema_changes do
+          log(sql, name) do
+            @connection.transaction { |db| db.execute_batch(sql) }
+          end
+        end
       end
       
       def populate(table, columns, rows, name = nil)
@@ -17,6 +21,11 @@ module Populator
   end
 end
 
-class ActiveRecord::ConnectionAdapters::SQLiteAdapter < ActiveRecord::ConnectionAdapters::AbstractAdapter
-  include Populator::Adapters::Sqlite
+# TODO find a better way to load the SQLite adapter
+module ActiveRecord # :nodoc: all
+  module ConnectionAdapters
+    class SQLiteAdapter < ActiveRecord::ConnectionAdapters::AbstractAdapter
+      include Populator::Adapters::Sqlite
+    end
+  end
 end

data/lib/populator/factory.rb

@@ -1,38 +1,79 @@
 module Populator
+  # Builds multiple Populator::Record instances and saves them to the database
   class Factory
-    def initialize(model_class, amount)
-      @model_class = model_class
-      @amount = amount.kind_of?(Integer) ? amount : amount.to_a.rand
-      @records = []
+    DEFAULT_RECORDS_PER_QUERY = 1000
+    
+    @factories = {}
+    @depth = 0
+    
+    # Fetches the factory dedicated to a given model class. You should always use this
+    # method instead of instatiating a factory directly so that a single factory is
+    # shared on multiple calls.
+    def self.for_model(model_class)
+      @factories[model_class] ||= new(model_class)
     end
     
-    def run(&block)
-      build_records(&block)
-      save_records
+    # Find all remaining factories and call save_records on them.
+    def self.save_remaining_records
+      @factories.values.each do |factory|
+        factory.save_records
+      end
+      @factories = {}
     end
     
-    private
+    # Keep track of nested factory calls so we can save the remaining records once we
+    # are done with the base factory. This makes Populator more efficient when nesting
+    # factories.
+    def self.remember_depth
+      @depth += 1
+      yield
+      @depth -= 1
+      save_remaining_records if @depth.zero?
+    end
     
-    def quoted_column_names
-      @model_class.column_names.map do |column_name|
-        @model_class.connection.quote_column_name(column_name)
-      end
+    # Use for_model instead of instatiating a record directly.
+    def initialize(model_class)
+      @model_class = model_class
+      @records = []
     end
     
-    def last_id
-      @model_class.connection.select_value("SELECT id FROM #{@model_class.quoted_table_name} ORDER BY id DESC", "#{@model_class.name} Last ID").to_i
+    # Entry method for building records. Delegates to build_records after remember_depth.
+    def populate(amount, options = {}, &block)
+      self.class.remember_depth do
+        build_records(Populator.interpret_value(amount), options[:per_query] || DEFAULT_RECORDS_PER_QUERY, &block)
+      end
     end
     
-    def build_records(&block)
-      (1..@amount).map do |i|
-        record = Record.new(@model_class, last_id+i)
-        block.call(record) if block
+    # Builds multiple Populator::Record instances and calls save_records them when
+    # :per_query limit option is reached.
+    def build_records(amount, per_query, &block)
+      amount.times do
+        record = Record.new(@model_class, last_id_in_database + @records.size + 1)
         @records << record
+        block.call(record) if block
+        save_records if @records.size >= per_query
       end
     end
     
+    # Saves the records to the database by calling populate on the current database adapter.
     def save_records
-      @model_class.connection.populate(@model_class.quoted_table_name, columns_sql, rows_sql_arr, "#{@model_class.name} Populate")
+      unless @records.empty?
+        @model_class.connection.populate(@model_class.quoted_table_name, columns_sql, rows_sql_arr, "#{@model_class.name} Populate")
+        @last_id_in_database = @records.last.id
+        @records.clear
+      end
+    end
+    
+    private
+    
+    def quoted_column_names
+      @model_class.column_names.map do |column_name|
+        @model_class.connection.quote_column_name(column_name)
+      end
+    end
+    
+    def last_id_in_database
+      @last_id_in_database ||= @model_class.connection.select_value("SELECT id FROM #{@model_class.quoted_table_name} ORDER BY id DESC", "#{@model_class.name} Last ID").to_i
     end
     
     def columns_sql

data/lib/populator/model_additions.rb

@@ -1,11 +1,32 @@
 module Populator
   module ModelAdditions
-    def populate(amount, &block)
-      Factory.new(self, amount).run(&block)
+    # Call populate on any ActiveRecord model to fill it with data.
+    # Pass the number of records you want to create, and a block to
+    # set the attributes. You can nest calls to handle associations
+    # and use ranges or arrays to randomize the values.
+    #
+    #   Person.populate(3000) do |person|
+    #     person.name = "John Doe"
+    #     person.gender = ['male', 'female']
+    #     Project.populate(10..30, :per_query => 100) do |project|
+    #       project.person_id = person.id
+    #       project.due_at = 5.days.from_now..2.years.from_now
+    #       project.name = Populator.words(1..3).titleize
+    #       project.description = Populator.sentences(2..10)
+    #     end
+    #   end
+    #
+    # The following options are supported.
+    #
+    # * <tt>:per_query</tt> - limit how many records are inserted per query, defaults to 1000
+    #
+    # Populator::Factory is where all the work happens.
+    def populate(amount, options = {}, &block)
+      Factory.for_model(self).populate(amount, options, &block)
     end
   end
 end
 
-class ActiveRecord::Base
+ActiveRecord::Base.class_eval do
   extend Populator::ModelAdditions
 end

data/lib/populator/random.rb

@@ -0,0 +1,61 @@
+module Populator
+  # This module adds several methods for generating random data which can be
+  # called directly on Populator.
+  module Random
+    WORDS = %w(alias consequatur aut perferendis sit voluptatem accusantium doloremque aperiam eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo aspernatur aut odit aut fugit sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt neque dolorem ipsum quia dolor sit amet consectetur adipisci velit sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem ut enim ad minima veniam quis nostrum exercitationem ullam corporis nemo enim ipsam voluptatem quia voluptas sit suscipit laboriosam nisi ut aliquid ex ea commodi consequatur quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae et iusto odio dignissimos ducimus qui blanditiis praesentium laudantium totam rem voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident sed ut perspiciatis unde omnis iste natus error similique sunt in culpa qui officia deserunt mollitia animi id est laborum et dolorum fuga et harum quidem rerum facilis est et expedita distinctio nam libero tempore cum soluta nobis est eligendi optio cumque nihil impedit quo porro quisquam est qui minus id quod maxime placeat facere possimus omnis voluptas assumenda est omnis dolor repellendus temporibus autem quibusdam et aut consequatur vel illum qui dolorem eum fugiat quo voluptas nulla pariatur at vero eos et accusamus officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae itaque earum rerum hic tenetur a sapiente delectus ut aut reiciendis voluptatibus maiores doloribus asperiores repellat)
+    
+    # Pick a random value out of a given range.
+    def value_in_range(range)
+      case range.first
+      when Integer then number_in_range(range)
+      when Time then time_in_range(range)
+      when Date then date_in_range(range)
+      else range.to_a.rand
+      end
+    end
+    
+    # Generate a given number of words. If a range is passed, it will generate
+    # a random number of words within that range.
+    def words(total)
+      (1..interpret_value(total)).map { WORDS.rand }.join(' ')
+    end
+    
+    # Generate a given number of sentences. If a range is passed, it will generate
+    # a random number of sentences within that range.
+    def sentences(total)
+      (1..interpret_value(total)).map do
+        words(5..20).capitalize
+      end.join('. ')
+    end
+    
+    # If an array or range is passed, a random value will be selected to match.
+    # All other values are simply returned.
+    def interpret_value(value)
+      case value
+      when Array then value.rand
+      when Range then value_in_range(value)
+      else value
+      end
+    end
+    
+    private
+    
+    def time_in_range(range)
+      Time.at number_in_range(Range.new(range.first.to_i, range.last.to_i, range.exclude_end?))
+    end
+    
+    def date_in_range(range)
+      Date.jd number_in_range(Range.new(range.first.jd, range.last.jd, range.exclude_end?))
+    end
+    
+    def number_in_range(range)
+      if range.exclude_end?
+        rand(range.last - range.first) + range.first
+      else
+        rand((range.last+1) - range.first) + range.first
+      end
+    end
+  end
+  
+  extend Random # load it into the populator module directly so we can call the methods
+end

data/lib/populator/record.rb

@@ -1,23 +1,34 @@
 module Populator
+  # This is what is passed to the block when calling populate.
   class Record
     attr_accessor :attributes
     
+    # Creates a new instance of Record. Some attributes are set by default:
+    #
+    # * <tt>id</tt> - defaults to id passed
+    # * <tt>created_at</tt> - defaults to current time
+    # * <tt>updated_at</tt> - defaults to current time
+    # * <tt>created_on</tt> - defaults to current date
+    # * <tt>updated_on</tt> - defaults to current date
     def initialize(model_class, id)
       @attributes = { :id => id }
       @columns = model_class.column_names
       @columns.each do |column|
-        self.instance_eval <<-EOS
-          def #{column}=(value)
-            @attributes[:#{column}] = interpret_value(value)
-          end
-          
-          def #{column}
-            @attributes[:#{column}]
-          end
-        EOS
+        if column == 'created_at' || column == 'updated_at'
+          @attributes[column.to_sym] = Time.now
+        end
+        if column == 'created_on' || column == 'updated_on'
+          @attributes[column.to_sym] = Date.today
+        end
       end
     end
     
+    # override id since method_missing won't catch this column name
+    def id
+      @attributes[:id]
+    end
+    
+    # Return values for all columns inside an array.
     def attribute_values
       @columns.map do |column|
         @attributes[column.to_sym]
@@ -26,11 +37,16 @@ module Populator
     
     private
     
-    def interpret_value(value)
-      case value
-      when Array then value.rand
-      when Range then value.to_a.rand
-      else value
+    def method_missing(sym, *args, &block)
+      name = sym.to_s
+      if @columns.include?(name.sub('=', ''))
+        if name.include? '='
+          @attributes[name.sub('=', '').to_sym] = Populator.interpret_value(args.first)
+        else
+          @attributes[sym]
+        end
+      else
+        super
       end
     end
   end

data/lib/populator.rb

@@ -2,6 +2,11 @@ $:.unshift(File.dirname(__FILE__))
 require 'populator/model_additions'
 require 'populator/factory'
 require 'populator/record'
+require 'populator/random'
 
 require 'populator/adapters/abstract'
 require 'populator/adapters/sqlite'
+
+# Populator is made up of several parts. To start, see Populator::ModelAdditions.
+module Populator
+end

data/populator.gemspec

@@ -1,51 +1,106 @@
 
-# Gem::Specification for Populator-0.1.0
+# Gem::Specification for Populator-0.2.1
 # Originally generated by Echoe
 
-Gem::Specification.new do |s|
-  s.name = %q{populator}
-  s.version = "0.1.0"
+--- !ruby/object:Gem::Specification 
+name: populator
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Ryan Bates
+autorequire: 
+bindir: bin
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Ryan Bates"]
-  s.date = %q{2008-08-28}
-  s.description = %q{Mass populate an Active Record database.}
-  s.email = %q{ryan (at) railscasts (dot) com}
-  s.extra_rdoc_files = ["CHANGELOG", "lib/populator/adapters/abstract.rb", "lib/populator/adapters/sqlite.rb", "lib/populator/factory.rb", "lib/populator/model_additions.rb", "lib/populator/record.rb", "lib/populator.rb", "LICENSE", "README", "tasks/deployment.rake", "tasks/spec.rake"]
-  s.files = ["CHANGELOG", "lib/populator/adapters/abstract.rb", "lib/populator/adapters/sqlite.rb", "lib/populator/factory.rb", "lib/populator/model_additions.rb", "lib/populator/record.rb", "lib/populator.rb", "LICENSE", "Manifest", "populator.gemspec", "README", "spec/database.yml", "spec/models/product.rb", "spec/populator/factory_spec.rb", "spec/populator/model_additions_spec.rb", "spec/populator/record_spec.rb", "spec/README", "spec/spec_helper.rb", "tasks/deployment.rake", "tasks/spec.rake"]
-  s.has_rdoc = true
-  s.homepage = %q{http://github.com/ryanb/populator}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Populator", "--main", "README"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{populator}
-  s.rubygems_version = %q{1.2.0}
-  s.summary = %q{Mass populate an Active Record database.}
+date: 2008-09-01 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Mass populate an Active Record database.
+email: ryan (at) railscasts (dot) com
+executables: []
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+extensions: []
 
-    if current_version >= 3 then
-    else
-    end
-  else
-  end
-end
+extra_rdoc_files: 
+- CHANGELOG
+- lib/populator/adapters/abstract.rb
+- lib/populator/adapters/sqlite.rb
+- lib/populator/factory.rb
+- lib/populator/model_additions.rb
+- lib/populator/random.rb
+- lib/populator/record.rb
+- lib/populator.rb
+- LICENSE
+- README
+- tasks/deployment.rake
+- tasks/spec.rake
+- TODO
+files: 
+- CHANGELOG
+- lib/populator/adapters/abstract.rb
+- lib/populator/adapters/sqlite.rb
+- lib/populator/factory.rb
+- lib/populator/model_additions.rb
+- lib/populator/random.rb
+- lib/populator/record.rb
+- lib/populator.rb
+- LICENSE
+- Manifest
+- Rakefile
+- README
+- spec/database.yml
+- spec/example_database.yml
+- spec/models/category.rb
+- spec/models/product.rb
+- spec/populator/factory_spec.rb
+- spec/populator/model_additions_spec.rb
+- spec/populator/random_spec.rb
+- spec/populator/record_spec.rb
+- spec/README
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/deployment.rake
+- tasks/spec.rake
+- TODO
+- populator.gemspec
+has_rdoc: true
+homepage: http://github.com/ryanb/populator
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Populator
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - "="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
 
-
-# # Original Rakefile source (requires the Echoe gem):
-# 
-# require 'rubygems'
-# require 'rake'
-# require 'echoe'
-# 
-# Echoe.new('populator', '0.1.0') do |p|
-#   p.summary        = "Mass populate an Active Record database."
-#   p.description    = "Mass populate an Active Record database."
-#   p.url            = "http://github.com/ryanb/populator"
-#   p.author         = 'Ryan Bates'
-#   p.email          = "ryan (at) railscasts (dot) com"
-#   p.ignore_pattern = ["script/*", "**/*.sqlite3"]
-# end
-# 
-# Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+rubyforge_project: populator
+rubygems_version: 1.2.0
+specification_version: 2
+summary: Mass populate an Active Record database.
+test_files: []

data/spec/README

@@ -1,16 +1,23 @@
-Running Populator Specs
------------------------
+Running Specs
+-------------
 
-There are several rake tasks for running the specs.
+To prepare the specs, run this command.
+
+  script/setup
+  
+This will generate the spec/database.yml file. Configure this to work 
+with your databases. You can add and remove entries here as well to 
+test different databases. A rake task is available to run the specs for 
+each database.
 
   rake spec             # Run specs under all databases
   rake spec:mysql       # Run specs under mysql
   rake spec:sqlite3     # Run specs under sqlite3
+  rake spec:postgresql  # Run specs under postgresql
   ...
 
-To run the specs under mysql you have to create the database and user.
-See spec/database.yml for specifics.
+Don't forget to create the user and database as necessary. You can do 
+so under MySQL with these commands.
 
   CREATE DATABASE populator_test;
   GRANT ALL ON populator_test.* TO populator@localhost;
-

data/spec/example_database.yml

@@ -0,0 +1,20 @@
+# you can add and remove entries to support different databases in tests.
+
+sqlite3:
+  adapter: sqlite3
+  database: spec/test.sqlite3
+  timeout: 5000
+
+mysql:
+  adapter: mysql
+  database: populator_test
+  username: populator
+  password: 
+  host: localhost
+
+postgresql:
+  adapter: postgresql
+  database: populator_test
+  username: populator
+  password: populator
+  host: localhost

data/spec/models/category.rb

@@ -0,0 +1,15 @@
+class Category < ActiveRecord::Base
+  has_many :products
+end
+
+class CreateCategories < ActiveRecord::Migration
+  def self.up
+    create_table :categories do |t|
+      t.string :name
+    end
+  end
+  
+  def self.down
+    drop_table :categories
+  end
+end

data/spec/models/product.rb

@@ -1,16 +1,18 @@
 class Product < ActiveRecord::Base
+  belongs_to :category
 end
 
 class CreateProducts < ActiveRecord::Migration
   def self.up
     create_table :products do |t|
-      t.string   :name
-      t.text     :description
-      t.integer  :stock
-      t.float    :weight
-      t.decimal  :price
-      t.datetime :released_at
-      t.boolean  :hidden
+      t.string       :name
+      t.text         :description
+      t.integer      :stock
+      t.float        :weight
+      t.decimal      :price
+      t.datetime     :released_at
+      t.boolean      :hidden
+      t.integer  :category_id
     end
   end
   

data/spec/populator/factory_spec.rb

@@ -1,46 +1,69 @@
 require File.dirname(__FILE__) + '/../spec_helper.rb'
 
 describe Populator::Factory do
-  describe "for 5 products" do
+  describe "for products" do
     before(:each) do
-      @factory = Populator::Factory.new(Product, 5)
+      @factory = Populator::Factory.for_model(Product)
     end
   
     it "should only use one query when inserting records" do
       $queries_executed = []
-      @factory.run
+      @factory.populate(5)
       $queries_executed.grep(/^insert/i).should have(1).record
     end
   
     it "should start id at 1 and increment when table is empty" do
       Product.delete_all
       expected_id = 1
-      @factory.run do |product|
+      @factory.populate(5) do |product|
         product.id.should == expected_id
         expected_id += 1
       end
     end
   
     it "should start id at last id and increment" do
+      Product.delete_all
       product = Product.create
       expected_id = product.id+1
-      @factory.run do |product|
+      @factory.populate(5) do |product|
         product.id.should == expected_id
         expected_id += 1
       end
     end
-  end
-  
-  describe "between 2 and 4 products" do
-    before(:each) do
-      @factory = Populator::Factory.new(Product, 2..4)
-    end
     
     it "should generate within range" do
       Product.delete_all
-      @factory.run
+      @factory.populate(2..4)
       Product.count.should >= 2
       Product.count.should <= 4
     end
+  
+    it "should limit number of records per query" do
+      $queries_executed = []
+      @factory.populate(5, :per_query => 2)
+      $queries_executed.grep(/^insert/i).should have(3).records
+    end
+  end
+  
+  it "should only use two queries when nesting factories (one for each class)" do
+    $queries_executed = []
+    Populator::Factory.for_model(Category).populate(3) do |category|
+      Populator::Factory.for_model(Product).populate(3) do |product|
+        product.category_id = category.id
+      end
+    end
+    $queries_executed.grep(/^insert/i).should have(2).records
+  end
+  
+  it "should only use one query when nesting factories of the same type" do
+    $queries_executed = []
+    Populator::Factory.for_model(Product).populate(3) do |product|
+      Populator::Factory.for_model(Product).populate(3)
+    end
+    $queries_executed.grep(/^insert/i).should have(1).record
+  end
+  
+  it "should default to 1000 records per query" do
+    Populator::Factory::DEFAULT_RECORDS_PER_QUERY.should == 1000
   end
 end

data/spec/populator/model_additions_spec.rb

@@ -23,4 +23,12 @@ describe Populator::ModelAdditions do
       product.should_not be_kind_of(ActiveRecord::Base)
     end
   end
+    
+  it "should not pass options hash" do
+    $queries_executed = []
+    Product.populate(5, :per_query => 2) do |product|
+      product.should_not be_kind_of(ActiveRecord::Base)
+    end
+    $queries_executed.grep(/^insert/i).should have(3).records
+  end
 end

data/spec/populator/random_spec.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Populator::Random do
+  it "should pick a random number in range excluding last value" do
+    Populator.expects(:rand).with(5).returns(3)
+    Populator.value_in_range(10...15).should == 13
+  end
+  
+  it "should pick a random number in range including last value" do
+    Populator.expects(:rand).with(5).returns(3)
+    Populator.value_in_range(10..14).should == 13
+  end
+  
+  it "should pick a random time in range" do
+    start_time = 2.days.ago
+    end_time = Time.now
+    Populator.expects(:rand).with(end_time.to_i-start_time.to_i).returns(1)
+    Populator.value_in_range(start_time...end_time).should == Time.at(start_time.to_i + 1)
+  end
+  
+  it "should pick a random date in range" do
+    start_date = 2.years.ago.to_date
+    end_date = Date.today
+    Populator.expects(:rand).with(end_date.jd-start_date.jd).returns(1)
+    Populator.value_in_range(start_date...end_date).should == Date.jd(start_date.jd + 1)
+  end
+  
+  it "should pick a random string by converting to array" do
+    Kernel.expects(:rand).with(5).returns(2)
+    Populator.value_in_range('a'..'e').should == 'c'
+  end
+  
+  it "should pick 3 random words" do
+    Populator.words(3).split.should have(3).records
+  end
+  
+  it "should pick a random number of random words" do
+    Populator.expects(:rand).with(5).returns(3)
+    Populator.words(10...15).split.should have(13).records
+  end
+  
+  it "should generate 3 random sentences" do
+    Populator.sentences(3).split(/\. [A-Z]/).should have(3).records
+  end
+end

data/spec/populator/record_spec.rb

@@ -32,4 +32,13 @@ describe Populator::Record do
     record.name = %w[foo bar]
     %w[foo bar].should include(record.name)
   end
+  
+  it "should automatically set created/updated columns" do
+    Product.stubs(:column_names).returns(%w[id created_at updated_at created_on updated_on])
+    record = Populator::Record.new(Product, 1)
+    record.created_at.to_date.should == Date.today
+    record.updated_at.to_date.should == Date.today
+    record.created_on.should == Date.today
+    record.updated_on.should == Date.today
+  end
 end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -4,11 +4,12 @@ require 'active_support'
 require 'active_record'
 require File.dirname(__FILE__) + '/../lib/populator.rb'
 
-ENV['POPULATOR_ADAPTER'] ||= 'sqlite3'
+adapter = ENV['POPULATOR_ADAPTER'] || 'sqlite3'
+puts "Running specs on #{adapter}"
 
 # setup database adapter
 ActiveRecord::Base.establish_connection(
-  YAML.load(File.read(File.dirname(__FILE__) + "/database.yml"))[ENV['POPULATOR_ADAPTER']]
+  YAML.load(File.read(File.dirname(__FILE__) + "/database.yml"))[adapter]
 )
 
 # keep track of which queries have been executed
@@ -37,7 +38,9 @@ end
 
 # load models
 # there's probably a better way to handle this
+require File.dirname(__FILE__) + '/models/category.rb'
 require File.dirname(__FILE__) + '/models/product.rb'
+CreateCategories.migrate(:up) unless Category.table_exists?
 CreateProducts.migrate(:up) unless Product.table_exists?
 
 Spec::Runner.configure do |config|

data/tasks/spec.rake

@@ -1,6 +1,6 @@
 require 'spec/rake/spectask'
 
-ADAPTERS = %w[sqlite3 mysql]
+ADAPTERS = YAML.load(File.read(File.dirname(__FILE__) + "/../spec/database.yml")).keys
 
 desc "Run specs under all supported databases"
 task :spec => ADAPTERS.map { |a| "spec:#{a}" }

metadata

@@ -1,18 +1,26 @@
 --- !ruby/object:Gem::Specification 
 name: ryanb-populator
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Ryan Bates
 autorequire: 
 bindir: bin
-cert_chain: []
-
-date: 2008-08-28 00:00:00 -07:00
+cert_chain: 
+date: 2008-09-01 00:00:00 -07:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: Mass populate an Active Record database.
 email: ryan (at) railscasts (dot) com
 executables: []
@@ -25,33 +33,42 @@ extra_rdoc_files:
 - lib/populator/adapters/sqlite.rb
 - lib/populator/factory.rb
 - lib/populator/model_additions.rb
+- lib/populator/random.rb
 - lib/populator/record.rb
 - lib/populator.rb
 - LICENSE
 - README
 - tasks/deployment.rake
 - tasks/spec.rake
+- TODO
 files: 
 - CHANGELOG
 - lib/populator/adapters/abstract.rb
 - lib/populator/adapters/sqlite.rb
 - lib/populator/factory.rb
 - lib/populator/model_additions.rb
+- lib/populator/random.rb
 - lib/populator/record.rb
 - lib/populator.rb
 - LICENSE
 - Manifest
-- populator.gemspec
+- Rakefile
 - README
 - spec/database.yml
+- spec/example_database.yml
+- spec/models/category.rb
 - spec/models/product.rb
 - spec/populator/factory_spec.rb
 - spec/populator/model_additions_spec.rb
+- spec/populator/random_spec.rb
 - spec/populator/record_spec.rb
 - spec/README
+- spec/spec.opts
 - spec/spec_helper.rb
 - tasks/deployment.rake
 - tasks/spec.rake
+- TODO
+- populator.gemspec
 has_rdoc: true
 homepage: http://github.com/ryanb/populator
 post_install_message: 
@@ -72,9 +89,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">="
+  - - "="
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: "1.2"
   version: 
 requirements: []
 

data/spec/database.yml

@@ -1,11 +0,0 @@
-sqlite3:
-  adapter: sqlite3
-  database: spec/test.sqlite3
-  timeout: 5000
-
-mysql:
-  adapter: mysql
-  database: populator_test
-  username: populator
-  password: 
-  host: localhost