populator 0.2.5 → 1.0.0

data/{CHANGELOG → CHANGELOG.rdoc}

@@ -1,8 +1,15 @@
-0.2.5 (October 1st, 2008)
+1.0.0 (January 25, 2011)
 
-* compatibility with RubyGems 1.3
+* Fixing SQLite adapter to work in Rails 3
+
+* Improving PostgreSQL adapter (thanks phlawski and zehkae)
+
+* adding Oracle adapter (thanks Andrew N)
+
+* Upgrading to RSpec 2 and Rails 3 in specs
+
+* New Gemfile and .rvmrc file to make development and running specs easier
 
-* mass assign attributes with "attributes=" method
 
 0.2.4 (September 9th, 2008)
 
@@ -10,24 +17,28 @@
 
 * adding Populator.paragraphs to generate paragraphs of text
 
+
 0.2.3 (September 2nd, 2008)
 
 * support single table inhertance by setting inheritance_column to class name
 
 * support custom primary_key in model if they don't use "id"
 
+
 0.2.2 (September 1st, 2008)
 
 * 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
@@ -38,6 +49,7 @@
 
 * adding Populator.words to fetch some random words
 
+
 0.1.0 (August 27th, 2008)
 
 * initial release

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# TODO change depending on adapter (?)
+gem "sqlite3-ruby", :require => "sqlite3"
+gem "mysql2"
+gem "pg"
+gem "activerecord", :require => "active_record"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,99 @@
+PATH
+  remote: .
+  specs:
+    populator (1.0.0.beta1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.3)
+      actionpack (= 3.0.3)
+      mail (~> 2.2.9)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+    activesupport (3.0.3)
+    arel (2.0.7)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.5.0)
+    mail (2.2.14)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    mocha (0.9.10)
+      rake
+    mysql2 (0.2.6)
+    pg (0.10.1)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.3)
+      actionmailer (= 3.0.3)
+      actionpack (= 3.0.3)
+      activerecord (= 3.0.3)
+      activeresource (= 3.0.3)
+      activesupport (= 3.0.3)
+      bundler (~> 1.0)
+      railties (= 3.0.3)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    sqlite3 (1.3.3)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  mocha (~> 0.9.10)
+  mysql2
+  pg
+  populator!
+  rails (~> 3.0.3)
+  rspec (~> 2.1.0)
+  sqlite3-ruby

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008 Ryan Bates
+Copyright (c) 2011 Ryan Bates
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/{README → README.rdoc}

@@ -1,37 +1,33 @@
 = Populator
 
-Populate an Active Record database with mass insert.
+RDocs[http://rdoc.info/projects/ryanb/populator] | Screencast[http://railscasts.com/episodes/126-populating-a-database]
 
-You can find the rdocs at http://populator.rubyforge.org.
+Populate an Active Record database with mass insertion.
 
-Special thanks to Zach Dennis for his ar-extensions gem which some of 
-this code is loosely based on.
 
+== Installation
 
-== Install
+<b>Rails 3</b> support is currently being worked on. Stay tuned.
 
-Install the gem:
+In <b>Rails 2</b>, install the gem.
 
   gem install populator
 
-And then load it in your project:
+And then load it in a rake task or elsewhere.
 
-  require 'populator'
+  require "populator"
 
 
 == Usage
 
-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.
+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.
 
   Person.populate(3000) do |person|
     person.first_name = "John"
     person.last_name = "Smith"
   end
 
-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.
+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|
     person.first_name = "John"
@@ -50,11 +46,9 @@ Passing a range or array of values will randomly select one.
     person.annual_income = 10000..200000
   end
 
-This will create 1000 to 5000 men or women with the annual income 
-between 10,000 and 200,000.
+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.
+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)
 
@@ -65,27 +59,21 @@ If you need to generate fake data, there are a few methods to do this.
   Populator.sentences(5) # generates 5 sentences
   Populator.paragraphs(3) # generates 3 paragraphs
 
-For fancier data generation, try the Faker gem.
-
-http://faker.rubyforge.org
+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.
+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.
+Problems or questions? Add an {issue on GitHub}[https://github.com/ryanb/populator/issues] or fork the project and send a pull request.
 
-This project can be found on github at the following URL.
+See {spec/README}[https://github.com/ryanb/populator/blob/master/spec/README.rdoc] for instructions on running specs.
 
-http://github.com/ryanb/populator
 
-If you find a bug, please send me a message on GitHub.
+== Special Thanks
 
-If you would like to contribute to this project, please fork the 
-repository and send me a pull request.
+Special thanks to Zach Dennis for his ar-extensions gem which some of this code is based on. Also many thanks to the contributors[https://github.com/ryanb/populator/contributors]. See the CHANGELOG[https://github.com/ryanb/populator/blob/master/CHANGELOG.rdoc] for the full list.

data/Rakefile

@@ -1,15 +1,25 @@
 require 'rubygems'
 require 'rake'
-require 'echoe'
-
-Echoe.new('populator', '0.2.5') 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", "tmp/*"]
-  p.development_dependencies = []
-end
+require 'rspec/core/rake_task'
+require 'yaml'
+
+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}" }
+task :default => :spec
 
-Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+namespace :spec do
+  ADAPTERS.each do |adapter|
+    namespace :prepare do
+      task adapter do
+        ENV["POPULATOR_ADAPTER"] = adapter
+      end
+    end
+
+    desc "Run specs under #{adapter}"
+    RSpec::Core::RakeTask.new(adapter => "spec:prepare:#{adapter}") do |t|
+      t.verbose = false
+    end
+  end
+end

data/lib/populator.rb

@@ -6,6 +6,8 @@ require 'populator/random'
 
 require 'populator/adapters/abstract'
 require 'populator/adapters/sqlite'
+require 'populator/adapters/oracle'
+require 'populator/adapters/postgresql'
 
 # Populator is made up of several parts. To start, see Populator::ModelAdditions.
 module Populator

data/lib/populator/adapters/abstract.rb

@@ -5,7 +5,7 @@ module Populator
       def execute_batch(sql, name = nil)
         raise NotImplementedError, "execute_batch is an abstract method"
       end
-      
+
       def populate(table, columns, rows, name = nil)
         execute("INSERT INTO #{table} #{columns} VALUES #{rows.join(', ')}", name)
       end

data/lib/populator/adapters/oracle.rb

@@ -0,0 +1,26 @@
+module Populator
+  module Adapters
+    module Oracle
+
+      # Executes SQL statements one at a time.
+
+      def populate(table, columns, rows, name = nil)
+        rows.each do |row|
+          sql = "INSERT INTO #{table} #{columns} VALUES #{row}"
+          log(sql, name) do
+            @connection.exec(sql)
+          end
+        end
+      end
+
+    end
+  end
+end
+
+module ActiveRecord # :nodoc: all
+  module ConnectionAdapters
+    class OracleAdapter < ActiveRecord::ConnectionAdapters::AbstractAdapter
+      include Populator::Adapters::Oracle
+    end
+  end
+end

data/lib/populator/adapters/postgresql.rb

@@ -0,0 +1,22 @@
+module Populator
+  module Adapters
+    module Postgresql
+      def populate(table, columns, rows, name = nil)
+        queries = []
+        rows.each do |row|
+          row.gsub!(/^\(\d{1,}/, "(DEFAULT")
+          queries << "INSERT INTO #{table} #{columns} VALUES #{row}"
+        end
+        execute(queries.join("; "), name)
+      end
+    end
+  end
+end
+
+module ActiveRecord # :nodoc: all
+  module ConnectionAdapters
+    class PostgreSQLAdapter < ActiveRecord::ConnectionAdapters::AbstractAdapter
+      include Populator::Adapters::Postgresql
+    end
+  end
+end

data/lib/populator/adapters/sqlite.rb

@@ -3,13 +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 do
-          log(sql, name) do
-            @connection.transaction { |db| db.execute_batch(sql) }
-          end
+        log(sql, name) do
+          @connection.transaction { |db| db.execute_batch(sql) }
         end
       end
-      
+
       def populate(table, columns, rows, name = nil)
         queries = []
         rows.each do |row|

data/lib/populator/factory.rb

@@ -1,90 +1,90 @@
-module Populator
-  # Builds multiple Populator::Record instances and saves them to the database
-  class Factory
-    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
-    
-    # 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
-    
-    # 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
-    
-    # Use for_model instead of instatiating a record directly.
-    def initialize(model_class)
-      @model_class = model_class
-      @records = []
-    end
-    
-    # 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
-    
-    # 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
-      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
-      "(#{quoted_column_names.join(', ')})"
-    end
-    
-    def rows_sql_arr
-      @records.map do |record|
-        quoted_attributes = record.attribute_values.map { |v| @model_class.sanitize(v) }
-        "(#{quoted_attributes.join(', ')})"
-      end
-    end
-  end
-end
+module Populator
+  # Builds multiple Populator::Record instances and saves them to the database
+  class Factory
+    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
+
+    # 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
+
+    # 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
+
+    # Use for_model instead of instatiating a record directly.
+    def initialize(model_class)
+      @model_class = model_class
+      @records = []
+    end
+
+    # 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
+
+    # 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
+      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 #{@model_class.primary_key} FROM #{@model_class.quoted_table_name} ORDER BY #{@model_class.primary_key} DESC", "#{@model_class.name} Last ID").to_i
+    end
+
+    def columns_sql
+      "(#{quoted_column_names.join(', ')})"
+    end
+
+    def rows_sql_arr
+      @records.map do |record|
+        quoted_attributes = record.attribute_values.map { |v| @model_class.sanitize(v) }
+        "(#{quoted_attributes.join(', ')})"
+      end
+    end
+  end
+end