fast_seeder 0.0.1

data/LGPL-LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,94 @@
+# FastSeeder [![Build Status](https://secure.travis-ci.org/smartdict/smartdict-core.png)](http://travis-ci.org/greyblake/fast_seeder)
+
+By [Sergey Potapov](https://github.com/greyblake)
+
+Speeds up seeding database using multiple SQL inserts!
+
+## Installation
+
+Add to Gemfile:
+
+```ruby
+gem "fast_seeder"
+```
+
+
+## Usage
+
+### Seeding from CSV file
+
+Lets say you have CSV file `db/seeds/cities/ukraine.csv`:
+
+```csv
+Kharkov,1654
+Lviv,1240
+Kiev,600
+```
+
+You can populate DB with it using FastSeeder:
+
+```ruby
+# Seeding from CSV file:
+FastSeeder.seed_csv!(City, "cities/ukraine.csv", :name, :founded_in, :country => "Ukraine")
+```
+
+Technically it equals to:
+
+```ruby
+City.create(:name => "Kharkov", :founded_in => 1654, :country => "Ukraine")
+City.create(:name => "Lviv"   , :founded_in => 1240, :country => "Ukraine")
+City.create(:name => "Kiev"   , :founded_in => 600 , :country => "Ukraine")
+```
+
+But does the job faster using only one SQL query instead of three.
+As you also noticed it expects you to pass model class, path to CSV file(located in `db/seeds`),
+CSV columns, and default values.
+
+### Seeding in place
+
+The next example is equivalent to showed above one, but uses inline data
+without CSV file:
+
+```ruby
+# Seeding in place:
+FastSeeder.seed!(City, :name, :founded_in, :country => "Ukraine") do
+  record "Kharkov", 1654
+  record "Lviv"   , 1240
+  record "Kiev"   , 600
+end
+```
+
+## Supported database adapters
+
+* PostgreSQL
+* MySQL(mysql, mysql2)
+* SQLite3
+
+## Running specs
+
+```
+rake spec:all               # run specs with all supported adapters
+rake spec:mysql             # run specs with mysql adapter
+rake spec:mysql2            # run specs with mysql2 adapter
+rake spec:postgresql        # run specs with postgresql adapter
+rake spec:sqlite3           # run specs with sqlite3 adapter
+```
+
+## Credits
+
+* [Sergey Potapov](https://github.com/greyblake) - creator and maintainer
+
+## License
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/lgpl.txt>

data/Rakefile

@@ -0,0 +1,59 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+Rake::Task[:spec].enhance ['db:setup']
+
+namespace :spec do
+  desc "run specs with postgresql adapter"
+  task :postgresql do
+    ENV['ADAPTER'] = 'postgresql'
+    Rake::Task[:spec].invoke
+  end
+
+  desc "run specs with mysql adapter"
+  task :mysql do
+    ENV['ADAPTER'] = 'mysql'
+    Rake::Task[:spec].invoke
+  end
+
+  desc "run specs with mysql2 adapter"
+  task :mysql2 do
+    ENV['ADAPTER'] = 'mysql2'
+    Rake::Task[:spec].invoke
+  end
+
+  desc "run specs with sqlite3 adapter"
+  task :sqlite3 do
+    ENV['ADAPTER'] = 'sqlite3'
+    Rake::Task[:spec].invoke
+  end
+
+  desc "run specs with all supported adapters"
+  task :all do
+    adapters = %w(postgresql mysql mysql2 sqlite3)
+    adapters.each do |adapter|
+      puts "=" * 80
+      puts adapter.center(80)
+      puts "=" * 80
+      system "rake spec:#{adapter}"
+    end
+  end
+end
+
+
+task :default => 'spec:all'

data/lib/fast_seeder.rb

@@ -0,0 +1,31 @@
+require 'csv'
+require 'active_support/all'
+
+module FastSeeder
+  extend self
+  extend ActiveSupport::Autoload
+
+  autoload :Seeders
+  autoload :Adapters
+  autoload :RecordSet
+
+
+  def self.seed_csv!(model_class, csv_file, *colums_and_default_values)
+    default_values = colums_and_default_values.extract_options!
+    columns        = colums_and_default_values
+    seeder = Seeders::CsvSeeder.new(model_class, columns, default_values, csv_file)
+    seeder.seed!
+  end
+
+  def self.seed!(model_class, *colums_and_default_values, &block)
+    default_values = colums_and_default_values.extract_options!
+    columns        = colums_and_default_values
+    seeder = Seeders::InlineSeeder.new(model_class, columns, default_values, block)
+    seeder.seed!
+  end
+
+
+  def seeds_path
+    Rails.root + "db/seeds"
+  end
+end

data/lib/fast_seeder/adapters.rb

@@ -0,0 +1,10 @@
+module FastSeeder
+  module Adapters
+    extend ActiveSupport::Autoload
+
+    autoload :PostgresqlAdapter
+    autoload :MysqlAdapter
+    autoload :SqliteAdapter
+    autoload :BaseAdapter
+  end
+end

data/lib/fast_seeder/adapters/base_adapter.rb

@@ -0,0 +1,62 @@
+module FastSeeder
+  module Adapters
+    class BaseAdapter
+      def initialize(conn, record_set)
+	@conn       = conn
+	@record_set = record_set
+      end
+
+      def insert!
+	sql = build_sql
+	@conn.execute(sql)
+      end
+
+
+      private
+
+      def build_sql
+	columns_str = build_columns_str
+	values_str  = build_values_str
+	"INSERT INTO #{@record_set.table} (#{columns_str}) VALUES #{values_str}"
+      end
+
+      def build_columns_str
+	column_names = @record_set.columns
+	column_names << 'created_at' if process_created_at?
+	column_names << 'updated_at' if process_updated_at?
+	column_names.join(", ")
+      end
+
+      def build_values_str
+	values = @record_set.values.map do |vals|
+	  build_record_values_str(vals)
+	end
+	values.join(", ")
+      end
+
+      def build_record_values_str(values)
+	vals = values.dup
+	vals << Time.zone.now if process_created_at?
+	vals << Time.zone.now if process_updated_at?
+	quoted_vals = vals.map { |val| @conn.quote(val) }
+	joint_vals =  quoted_vals.join(", ")
+	"(#{joint_vals})"
+      end
+
+
+      def process_created_at?
+	@process_created_at ||= process_timestamp?('created_at')
+      end
+
+      def process_updated_at?
+	@process_updated_at ||= process_timestamp?('updated_at')
+      end
+
+      def process_timestamp?(column_name)
+	@record_set.model_class.column_names.include?(column_name.to_s) &&
+	  !@record_set.columns.include?(column_name.to_s)
+      end
+
+    end
+  end
+end

data/lib/fast_seeder/adapters/mysql_adapter.rb

@@ -0,0 +1,7 @@
+module FastSeeder
+  module Adapters
+    class MysqlAdapter < BaseAdapter
+
+    end
+  end
+end

data/lib/fast_seeder/adapters/postgresql_adapter.rb

@@ -0,0 +1,7 @@
+module FastSeeder
+  module Adapters
+    class PostgresqlAdapter < BaseAdapter
+
+    end
+  end
+end

data/lib/fast_seeder/adapters/sqlite_adapter.rb

@@ -0,0 +1,65 @@
+module FastSeeder
+  module Adapters
+    class SqliteAdapter < BaseAdapter
+
+      private
+
+      # Build something similar to this:
+      #   INSERT INTO 'tablename' (column1, column2)
+      #   SELECT 'data1' AS 'column1', 'data2' AS 'column2'
+      #   UNION SELECT 'data3', 'data4'
+      #   UNION SELECT 'data5', 'data6'
+      def build_sql
+	values_str  = build_values_str
+	columns_str = build_columns_str
+	"INSERT INTO '#{@record_set.table}' (#{columns_str})\n#{values_str}"
+      end
+
+      # Build values part like:
+      #   SELECT 'data1' AS 'column1', 'data2' AS 'column2'
+      #   UNION SELECT 'data3', 'data4'
+      #   UNION SELECT 'data5', 'data6'
+      def build_values_str
+	first_record_vals = @record_set.values.first
+	other_vals        = @record_set.values[1..-1]
+	first_str = build_first_record_srt(first_record_vals)
+	other_str = build_other_records_str(other_vals)
+	"#{first_str}\n#{other_str}"
+      end
+
+      # Build first line of values part like:
+      #   SELECT 'data1' AS 'column1', 'data2' AS 'column2'
+      def build_first_record_srt(record_vals)
+	pairs = ActiveSupport::OrderedHash[@record_set.columns.zip(record_vals)]
+	pairs['created_at'] = Time.zone.now if process_created_at?
+	pairs['updated_at'] = Time.zone.now if process_updated_at?
+	joint_pairs = pairs.map do |column, value|
+	  quoted_value = @conn.quote(value)
+	  "#{quoted_value} AS '#{column}'"
+	end
+	data_str = joint_pairs.join(", ")
+	"SELECT #{data_str}"
+      end
+
+      # Build values part like this:
+      #   UNION SELECT 'data3', 'data4'
+      #   UNION SELECT 'data5', 'data6'
+      def build_other_records_str(records_vals)
+	records_vals.map do |record_vals|
+	  build_record_str(record_vals)
+	end.join("\n")
+      end
+
+      # Build line of values part like:
+      #   UNION SELECT 'data5', 'data6'
+      def build_record_str(record_vals)
+	vals = record_vals.dup
+	vals << Time.zone.now if process_created_at?
+	vals << Time.zone.now if process_updated_at?
+	data = vals.map { |val| @conn.quote(val) }.join(", ")
+	"UNION SELECT #{data}"
+      end
+
+    end
+  end
+end

data/lib/fast_seeder/record_set.rb

@@ -0,0 +1,19 @@
+module FastSeeder
+  class RecordSet
+    attr_reader :columns, :values, :model_class
+
+    def initialize(model_class, columns)
+      @model_class = model_class
+      @columns    = columns.map(&:to_s)
+      @values     = []
+    end
+
+    def <<(values)
+      @values << values
+    end
+
+    def table
+      @model_class.table_name
+    end
+  end
+end

data/lib/fast_seeder/seeders.rb

@@ -0,0 +1,9 @@
+module FastSeeder
+  module Seeders
+    extend ActiveSupport::Autoload
+
+    autoload :BaseSeeder
+    autoload :CsvSeeder
+    autoload :InlineSeeder
+  end
+end

data/lib/fast_seeder/seeders/base_seeder.rb

@@ -0,0 +1,50 @@
+module FastSeeder
+  module Seeders
+    class BaseSeeder
+      def initialize(model_class, declared_columns, default_values)
+	@model_class      = model_class
+	@declared_columns = declared_columns
+
+        # Ordered hash is necessary to not mess columns and wrong values
+	@default_values = ActiveSupport::OrderedHash[*default_values.to_a.flatten]
+      end
+
+      def seed!
+	record_set = RecordSet.new(@model_class, columns)
+	specific_values.each do |record_vals|
+	  record_set << merged_values_for(record_vals)
+	end
+	adapter = adapter_class.new(conn, record_set)
+	adapter.insert!
+      end
+
+      private
+
+      def specific_values
+	raise NotImplementedError
+      end
+
+
+      def columns
+	@columns ||= @declared_columns + @default_values.keys
+      end
+
+      def merged_values_for(specific_vals)
+	specific_vals + @default_values.values
+      end
+
+      def adapter_class
+	case conn.adapter_name
+	when "PostgreSQL"      then Adapters::PostgresqlAdapter
+	when "Mysql2", "MySQL" then Adapters::MysqlAdapter
+	when "SQLite"          then Adapters::SqliteAdapter
+	else raise("Unsupported connection adapter: #{conn.adapter_name}")
+	end
+      end
+
+      def conn
+	ActiveRecord::Base.connection
+      end
+    end
+  end
+end

data/lib/fast_seeder/seeders/csv_seeder.rb

@@ -0,0 +1,18 @@
+module FastSeeder
+  module Seeders
+    class CsvSeeder < BaseSeeder
+      def initialize(model_class, declared_columns, default_values, csv_file)
+	super(model_class, declared_columns, default_values)
+	@csv_file = File.join(FastSeeder.seeds_path, csv_file)
+      end
+
+
+      private
+
+      def specific_values
+	CSV.read(@csv_file)
+      end
+
+    end
+  end
+end

data/lib/fast_seeder/seeders/inline_seeder.rb

@@ -0,0 +1,32 @@
+module FastSeeder
+  module Seeders
+    class InlineSeeder < BaseSeeder
+      class DataContext
+	attr_reader :records
+
+	def initialize(data_block)
+	  @records = []
+	  instance_eval(&data_block)
+	end
+
+	def record(*args)
+	  @records << args
+	end
+      end
+
+
+      def initialize(model_class, declared_columns, default_values, data_block)
+	super(model_class, declared_columns, default_values)
+	@data_block       = data_block
+      end
+
+
+      private
+
+      def specific_values
+	DataContext.new(@data_block).records
+      end
+
+    end
+  end
+end

data/lib/fast_seeder/version.rb

@@ -0,0 +1,3 @@
+module FastSeeder
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: fast_seeder
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Sergey Potapov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-08-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+description: Speeds up seeding database using multiple SQL inserts
+email: 
+- blake131313@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/fast_seeder/version.rb
+- lib/fast_seeder/seeders.rb
+- lib/fast_seeder/seeders/inline_seeder.rb
+- lib/fast_seeder/seeders/csv_seeder.rb
+- lib/fast_seeder/seeders/base_seeder.rb
+- lib/fast_seeder/adapters.rb
+- lib/fast_seeder/record_set.rb
+- lib/fast_seeder/adapters/postgresql_adapter.rb
+- lib/fast_seeder/adapters/sqlite_adapter.rb
+- lib/fast_seeder/adapters/mysql_adapter.rb
+- lib/fast_seeder/adapters/base_adapter.rb
+- lib/fast_seeder.rb
+- LGPL-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/greyblake/fast_seeder
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Speeds up seeding database using multiple SQL inserts
+test_files: []
+