ryanb-populator 0.1.0

data/CHANGELOG

@@ -0,0 +1,3 @@
+*0.1.0* (August 27th, 2008)
+
+* initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Ryan Bates
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest

@@ -0,0 +1,20 @@
+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

data/README

@@ -0,0 +1,67 @@
+= Populator
+
+Populate an Active Record database with mass insert.
+
+Special thanks to Zach Dennis for his ar-extensions gem which some of 
+this code is loosely based on.
+
+
+== Install
+
+Install the gem:
+
+	gem install ryanb-populator --source http://gems.github.com
+
+And then load it in your project:
+
+  require 'populator'
+
+
+== 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.
+
+  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. For 
+performance reasons, "person" is not an instance of the model. It's 
+just a simple interface for setting the column values.
+
+The person object contains the "id" so you can set up associations.
+
+  Person.populate(3000) do |person|
+    person.first_name = "John"
+    person.last_name = "Smith"
+    Project.populate(30) do |project|
+      project.person_id = person.id
+    end
+  end
+
+That will create 30 projects for each person.
+
+Passing an range or array of values will randomly select one.
+
+  Person.populate(1000..5000) do |person|
+    person.gender = ['male', 'female']
+    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.
+
+
+== Development
+
+This project can be found on github at the following URL.
+
+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/lib/populator/adapters/abstract.rb

@@ -0,0 +1,18 @@
+module Populator
+  module Adapters
+    module Abstract
+      # Executes multiple SQL statements in one query when joined with ";"
+      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
+    end
+  end
+end
+
+class ActiveRecord::ConnectionAdapters::AbstractAdapter
+  include Populator::Adapters::Abstract
+end

data/lib/populator/adapters/sqlite.rb

@@ -0,0 +1,22 @@
+module Populator
+  module Adapters
+    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) } }
+      end
+      
+      def populate(table, columns, rows, name = nil)
+        queries = []
+        rows.each do |row|
+          queries << "INSERT INTO #{table} #{columns} VALUES #{row}"
+        end
+        execute_batch(queries.join(';'), name)
+      end
+    end
+  end
+end
+
+class ActiveRecord::ConnectionAdapters::SQLiteAdapter < ActiveRecord::ConnectionAdapters::AbstractAdapter
+  include Populator::Adapters::Sqlite
+end

data/lib/populator/factory.rb

@@ -0,0 +1,49 @@
+module Populator
+  class Factory
+    def initialize(model_class, amount)
+      @model_class = model_class
+      @amount = amount.kind_of?(Integer) ? amount : amount.to_a.rand
+      @records = []
+    end
+    
+    def run(&block)
+      build_records(&block)
+      save_records
+    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
+      @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 build_records(&block)
+      (1..@amount).map do |i|
+        record = Record.new(@model_class, last_id+i)
+        block.call(record) if block
+        @records << record
+      end
+    end
+    
+    def save_records
+      @model_class.connection.populate(@model_class.quoted_table_name, columns_sql, rows_sql_arr, "#{@model_class.name} Populate")
+    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

data/lib/populator/model_additions.rb

@@ -0,0 +1,11 @@
+module Populator
+  module ModelAdditions
+    def populate(amount, &block)
+      Factory.new(self, amount).run(&block)
+    end
+  end
+end
+
+class ActiveRecord::Base
+  extend Populator::ModelAdditions
+end

data/lib/populator/record.rb

@@ -0,0 +1,37 @@
+module Populator
+  class Record
+    attr_accessor :attributes
+    
+    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
+      end
+    end
+    
+    def attribute_values
+      @columns.map do |column|
+        @attributes[column.to_sym]
+      end
+    end
+    
+    private
+    
+    def interpret_value(value)
+      case value
+      when Array then value.rand
+      when Range then value.to_a.rand
+      else value
+      end
+    end
+  end
+end

data/lib/populator.rb

@@ -0,0 +1,7 @@
+$:.unshift(File.dirname(__FILE__))
+require 'populator/model_additions'
+require 'populator/factory'
+require 'populator/record'
+
+require 'populator/adapters/abstract'
+require 'populator/adapters/sqlite'

data/populator.gemspec

@@ -0,0 +1,51 @@
+
+# Gem::Specification for Populator-0.1.0
+# Originally generated by Echoe
+
+Gem::Specification.new do |s|
+  s.name = %q{populator}
+  s.version = "0.1.0"
+
+  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.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+    else
+    end
+  else
+  end
+end
+
+
+# # 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 }

data/spec/README

@@ -0,0 +1,16 @@
+Running Populator Specs
+-----------------------
+
+There are several rake tasks for running the specs.
+
+  rake spec             # Run specs under all databases
+  rake spec:mysql       # Run specs under mysql
+  rake spec:sqlite3     # Run specs under sqlite3
+  ...
+
+To run the specs under mysql you have to create the database and user.
+See spec/database.yml for specifics.
+
+  CREATE DATABASE populator_test;
+  GRANT ALL ON populator_test.* TO populator@localhost;
+

data/spec/database.yml

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

data/spec/models/product.rb

@@ -0,0 +1,20 @@
+class Product < ActiveRecord::Base
+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
+    end
+  end
+  
+  def self.down
+    drop_table :products
+  end
+end

data/spec/populator/factory_spec.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Populator::Factory do
+  describe "for 5 products" do
+    before(:each) do
+      @factory = Populator::Factory.new(Product, 5)
+    end
+  
+    it "should only use one query when inserting records" do
+      $queries_executed = []
+      @factory.run
+      $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|
+        product.id.should == expected_id
+        expected_id += 1
+      end
+    end
+  
+    it "should start id at last id and increment" do
+      product = Product.create
+      expected_id = product.id+1
+      @factory.run 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
+      Product.count.should >= 2
+      Product.count.should <= 4
+    end
+  end
+end

data/spec/populator/model_additions_spec.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Populator::ModelAdditions do
+  it "should add populate method to active record class" do
+    Product.should respond_to(:populate)
+  end
+  
+  it "should add 10 records to database" do
+    Product.delete_all
+    Product.populate(10)
+    Product.count.should == 10
+  end
+  
+  it "should set attribute columns" do
+    Product.populate(1) do |product|
+      product.name = "foo"
+    end
+    Product.last.name.should == "foo"
+  end
+    
+  it "should not pass in an instance of Active Record for performance reasons" do
+    Product.populate(1) do |product|
+      product.should_not be_kind_of(ActiveRecord::Base)
+    end
+  end
+end

data/spec/populator/record_spec.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Populator::Record do
+  it "should have a writer and reader methods for each column" do
+    record = Populator::Record.new(Product, 1)
+    Product.column_names.each do |column|
+      record.send("#{column}=", "foo")
+      record.send(column).should == "foo"
+    end
+  end
+  
+  it "should return attribute values in same order as columns" do
+    record = Populator::Record.new(Product, nil)
+    record.name = "foo"
+    expected = Product.column_names.map { |c| "foo" if c == 'name' }
+    record.attribute_values.should == expected
+  end
+  
+  it "should assign second parameter to id" do
+    Populator::Record.new(Product, 2).id.should == 2
+  end
+  
+  it "should pick random number from range" do
+    record = Populator::Record.new(Product, 1)
+    record.stock = 2..5
+    record.stock.should >= 2
+    record.stock.should <= 5
+  end
+  
+  it "should pick random value from array" do
+    record = Populator::Record.new(Product, 1)
+    record.name = %w[foo bar]
+    %w[foo bar].should include(record.name)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'spec'
+require 'active_support'
+require 'active_record'
+require File.dirname(__FILE__) + '/../lib/populator.rb'
+
+ENV['POPULATOR_ADAPTER'] ||= 'sqlite3'
+
+# setup database adapter
+ActiveRecord::Base.establish_connection(
+  YAML.load(File.read(File.dirname(__FILE__) + "/database.yml"))[ENV['POPULATOR_ADAPTER']]
+)
+
+# keep track of which queries have been executed
+unless ActiveRecord::Base.connection.respond_to? :record_query
+  ActiveRecord::Base.connection.class.class_eval do
+    IGNORED_SQL = [/^PRAGMA/, /^SELECT currval/, /^SELECT CAST/, /^SELECT @@IDENTITY/, /^SELECT @@ROWCOUNT/, /^begin /i, /^commit /i]
+    
+    def record_query(sql)
+      $queries_executed ||= []
+      $queries_executed << sql unless IGNORED_SQL.any? { |r| sql =~ r }
+    end
+    
+    def execute_with_query_record(*args, &block)
+      record_query(args.first)
+      execute_without_query_record(*args, &block)
+    end
+    alias_method_chain :execute, :query_record
+    
+    def execute_batch_with_query_record(*args, &block)
+      record_query(args.first)
+      execute_batch_without_query_record(*args, &block)
+    end
+    alias_method_chain :execute_batch, :query_record
+  end
+end
+
+# load models
+# there's probably a better way to handle this
+require File.dirname(__FILE__) + '/models/product.rb'
+CreateProducts.migrate(:up) unless Product.table_exists?
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end

data/tasks/deployment.rake

@@ -0,0 +1,2 @@
+desc "Build the manifest and gemspec files."
+task :build => [:build_manifest, :build_gemspec]

data/tasks/spec.rake

@@ -0,0 +1,22 @@
+require 'spec/rake/spectask'
+
+ADAPTERS = %w[sqlite3 mysql]
+
+desc "Run specs under all supported databases"
+task :spec => ADAPTERS.map { |a| "spec:#{a}" }
+
+namespace :spec do
+  ADAPTERS.each do |adapter|
+    namespace :prepare do
+      task adapter do
+        ENV["POPULATOR_ADAPTER"] = adapter
+      end
+    end
+    
+    desc "Run specs under #{adapter}"
+    Spec::Rake::SpecTask.new(adapter => "spec:prepare:#{adapter}") do |t|
+      t.spec_files = Rake::FileList["spec/**/*_spec.rb"]
+      t.spec_opts = ["-c"]
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: ryanb-populator
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ryan Bates
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-28 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Mass populate an Active Record database.
+email: ryan (at) railscasts (dot) com
+executables: []
+
+extensions: []
+
+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
+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
+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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: populator
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Mass populate an Active Record database.
+test_files: []
+