fast_seeder 0.0.1 → 0.0.2

data/lib/fast_seeder/error.rb

@@ -0,0 +1,3 @@
+module FastSeeder
+  class Error < StandardError; end
+end

data/lib/fast_seeder/version.rb

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

data/lib/fast_seeder.rb

@@ -1,6 +1,24 @@
 require 'csv'
 require 'active_support/all'
 
+# Populates database with seeds using multiple inserts.
+#
+# Usage:
+#
+# CSV file:
+#   Kharkov,1654
+#   Lviv,1240
+#   Kiev,600
+#
+# Seeding from CSV file:
+#   FastSeeder.seed_csv!(City, "cities/ukraine.csv", :name, :founded_in, :country => "Ukraine")
+#
+# Seeding in place:
+#   FastSeeder.seed!(City, :name, :founded_in, :country => "Ukraine") do
+#     record "Kharkov", 1654
+#     record "Lviv"   , 1240
+#     record "Kiev"   , 600
+#   end
 module FastSeeder
   extend self
   extend ActiveSupport::Autoload
@@ -8,8 +26,15 @@ module FastSeeder
   autoload :Seeders
   autoload :Adapters
   autoload :RecordSet
+  autoload :Error
 
-
+  # Seed database with data from CSV file
+  # Usage:
+  #   FastSeeder.seed_csv!(City, "cities/ukraine.csv", :name, :founded_in, :country => "Ukraine")
+  #
+  # @param [ActiveRecord::Base] model_class model which needs to be seeded
+  # @param [String] csv_file path to CSV file relative to db/seeds
+  # @param [*] colums_and_default_values
   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
@@ -17,7 +42,20 @@ module FastSeeder
     seeder.seed!
   end
 
+  # Seeds database with data defined in block with "record" method.
+  # Usage:
+  #   FastSeeder.seed!(City, :name, :founded_in, :country => "Ukraine") do
+  #     record "Kharkov", 1654
+  #     record "Lviv"   , 1240
+  #     record "Kiev"   , 600
+  #   end
+  # @param [ActiveRecord::Base] model_class model which needs to be seeded
+  # @param [*] colums_and_default_values
   def self.seed!(model_class, *colums_and_default_values, &block)
+    unless block_given?
+      raise FastSeeder::Error.new("`FastSeeder.seed!` requires a block to be passed")
+    end
+
     default_values = colums_and_default_values.extract_options!
     columns        = colums_and_default_values
     seeder = Seeders::InlineSeeder.new(model_class, columns, default_values, block)
@@ -25,6 +63,7 @@ module FastSeeder
   end
 
 
+  # Path to basic seeds directory
   def seeds_path
     Rails.root + "db/seeds"
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: fast_seeder
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Sergey Potapov
@@ -53,6 +53,7 @@ files:
 - lib/fast_seeder/adapters/sqlite_adapter.rb
 - lib/fast_seeder/adapters/mysql_adapter.rb
 - lib/fast_seeder/adapters/base_adapter.rb
+- lib/fast_seeder/error.rb
 - lib/fast_seeder.rb
 - LGPL-LICENSE
 - Rakefile