seed_dump 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0b00614503dc059aec841b50bfdcdfb8a2c5251
-  data.tar.gz: 0fa97c98fb72a40a0cabb63f3880a820c6599ffd
+  metadata.gz: bfceec9ace09fe7f6bec3d37e650177e6d38a498
+  data.tar.gz: d29db6f1aeab2121c7d384ff8caf9cb1c3e25cee
 SHA512:
-  metadata.gz: 74bc375add9785597f932cf72b3f71f47c915ee3fdb1623b3e24c62f7dd801ebd196f5798cb31344edfe792df7b6a5c572c2548a8b8d542fdd374dc34b6ee1e1
-  data.tar.gz: 9a14b0769f18890e25b5d85daa6f414b70573afef27d18e74f57bcd390286ddaf6a9e2260ae8b4c2d22180b7cf2a9848252b7b61024befe7efa5370fd0d379d7
+  metadata.gz: d1701fa7864603423e03e1fa615a54fcf550c599cee96d11f746e081cb5e677dc4bb628b9153c9dd3981fb829e060b61406b72edd145e345a051eeb37efcec06
+  data.tar.gz: c300b879c570e0225fc5091db798375ae5f3e3eecd52c1dfc4c22613458c48fcc51f70e8b44ecc2909fb33ecf0ef3f462e7f21ec199a4ab801644794d942ed6c

data/Gemfile

@@ -1,19 +1,20 @@
 source 'https://rubygems.org'
 
-gem 'activesupport'
-gem 'activerecord'
+gem 'activesupport', '~> 4'
+gem 'activerecord', '~> 4'
 
 group :development, :test do
-  gem 'byebug'
-  gem 'factory_girl'
+  gem 'byebug', '~> 2.0'
+  gem 'factory_girl', '~> 4.0'
+  gem 'activerecord-import', '~> 0.4'
 end
 
 group :development do
-  gem 'jeweler', :git => 'git://github.com/technicalpickles/jeweler.git'
+  gem 'jeweler', '~> 2.0'
 end
 
 group :test do
-  gem 'rspec'
-  gem 'sqlite3'
-  gem 'database_cleaner'
+  gem 'rspec', '~> 2.0'
+  gem 'sqlite3', '~> 1.0'
+  gem 'database_cleaner', '~> 1.0'
 end

data/README.md

@@ -5,7 +5,7 @@ Seed Dump is a Rails 4 plugin that adds a rake task named `db:seed:dump`.
 
 It allows you to create seed data files from the existing data in your database.
 
-You can also use Seed Dump from the Rails console.  See below for usage examples.
+You can also use Seed Dump from the Rails console. See below for usage examples.
 
 Note: if you want to use Seed Dump with Rails 3 or earlier, use [version 0.5.3](http://rubygems.org/gems/seed_dump/versions/0.5.3).
 
@@ -42,7 +42,7 @@ Result:
 
 Dump only data from the users table and dump a maximum of 1 record:
 
-    $ rake db:seed:dump MODELS=User,Product LIMIT=1
+    $ rake db:seed:dump MODELS=User LIMIT=1
 
 Result:
 
@@ -58,6 +58,10 @@ Use another output file instead of `db/seeds.rb`:
 
     rake db:seed:dump FILE=db/seeds/users.rb
 
+Exclude `name` and `age` from the dump:
+
+    rake db:seed:dump EXCLUDE=name,age
+
 There are more options that can be set— see below for all of them.
 
 ### Console
@@ -76,24 +80,30 @@ Write the dump to a file:
 
 Append the dump to a file:
 
-    irb(main):003:0> puts SeedDump.dump(User, file: 'db/seeds.rb', append: true)
+    irb(main):003:0> SeedDump.dump(User, file: 'db/seeds.rb', append: true)
+
+Exclude `name` and `age` from the dump:
 
-Options are specified as a Hash to the second argument.
+    irb(main):004:0> SeedDump.dump(User, exclude: [:name, :age])
+
+Options are specified as a Hash for the second argument.
 
 Options
 -------
 
 Options are common to both the Rake task and the console, except where noted.
 
-`append`: If set to `true`, append the data to the file instead of overwriting it.  Default: `false`.
+`append`: If set to `true`, append the data to the file instead of overwriting it. Default: `false`.
+
+`batch_size`: Controls the number of records that are written to file at a given time. Default: 1000. If you're running out of memory when dumping, try decreasing this. If things are dumping too slow, trying increasing this.
 
-`batch_size`: Controls the number of records that are written to file at a given time.  Default: 1000.  If you're running out of memory when dumping, try decreasing this.  If things are dumping too slow, trying increasing this.
+`exclude`: Attributes to be excluded from the dump. By default `id`, `created_at`, and `updated_at` are excluded. Pass a comma-separated list to the Rake task (i.e. `name,age`) and an array on the console (i.e. `[:name, :age]`).
 
-`exclude`: Attributes to be excluded from the dump.  Default: `id, created_at, updated_at`.
+`file`: Write to the specified output file. The Rake task default is `db/seeds.rb`. The console returns the dump as a string by default.
 
-`file`: Write to the specified output file.  Default in Rake task is `db/seeds.rb`.  Console returns the dump as a string by default.
+`import`: If `true`, output will be in the format needed by the [activerecord-import](https://github.com/zdennis/activerecord-import) gem, rather than the default format. Default: `false`.
 
-`limit`: Dump no more then this amount of data.  Default: no limit.  Rake task only.  In the console just pass in an ActiveRecord::Relation with the appropriate limit (e.g. `SeedDump.dump(User.limit(5))`).
+`limit`: Dump no more than this amount of data. Default: no limit. Rake task only. In the console just pass in an ActiveRecord::Relation with the appropriate limit (e.g. `SeedDump.dump(User.limit(5))`).
 
-`model[s]`: Restrict the dump to the specified comma-separated list of models.  Default: all models.  Rake task only.
+`model[s]`: Restrict the dump to the specified comma-separated list of models. Default: all models. If you are using a Rails engine you can dump a specific model by passing "EngineName::ModelName". Rake task only. Example: `rake db:seed:dump MODELS="User, Position, Function"`
 

data/VERSION

@@ -1 +1 @@
-3.1.0
+3.2.0

data/lib/seed_dump/dump_methods.rb

@@ -18,20 +18,20 @@ class SeedDump
     def dump_record(record, options)
       attribute_strings = []
 
-      options[:exclude] ||= [:id, :created_at, :updated_at]
-
       # We select only string attribute names to avoid conflict
       # with the composite_primary_keys gem (it returns composite
       # primary key attribute names as hashes).
       record.attributes.select {|key| key.is_a?(String) }.each do |attribute, value|
-        attribute_strings << dump_attribute_new(attribute, value) unless options[:exclude].include?(attribute.to_sym)
+        attribute_strings << dump_attribute_new(attribute, value, options) unless options[:exclude].include?(attribute.to_sym)
       end
 
-      "{#{attribute_strings.join(", ")}}"
+      open_character, close_character = options[:import] ? ['[', ']'] : ['{', '}']
+
+      "#{open_character}#{attribute_strings.join(", ")}#{close_character}"
     end
 
-    def dump_attribute_new(attribute, value)
-      "#{attribute}: #{value_to_s(value)}"
+    def dump_attribute_new(attribute, value, options)
+      options[:import] ? value_to_s(value) : "#{attribute}: #{value_to_s(value)}"
     end
 
     def value_to_s(value)
@@ -66,7 +66,14 @@ class SeedDump
     end
 
     def write_records_to_io(records, io, options)
-      io.write("#{model_for(records)}.create!([\n  ")
+      options[:exclude] ||= [:id, :created_at, :updated_at]
+
+      method = options[:import] ? 'import' : 'create!'
+      io.write("#{model_for(records)}.#{method}(")
+      if options[:import]
+        io.write("[#{attribute_names(records, options).map {|name| name.to_sym.inspect}.join(', ')}], ")
+      end
+      io.write("[\n  ")
 
       enumeration_method = if records.is_a?(ActiveRecord::Relation) || records.is_a?(Class)
                              :active_record_enumeration
@@ -90,6 +97,16 @@ class SeedDump
       end
     end
 
+    def attribute_names(records, options)
+      attribute_names = if records.is_a?(ActiveRecord::Relation) || records.is_a?(Class)
+                          records.attribute_names
+                        else
+                          records[0].attribute_names
+                        end
+
+      attribute_names.select {|name| !options[:exclude].include?(name.to_sym)}
+    end
+
     def model_for(records)
       if records.is_a?(Class)
         records

data/lib/seed_dump/environment.rb

@@ -23,7 +23,8 @@ class SeedDump
                       append: append,
                       batch_size: (env['BATCH_SIZE'] ? env['BATCH_SIZE'].to_i : nil),
                       exclude: (env['EXCLUDE'] ? env['EXCLUDE'].split(',').map {|e| e.strip.to_sym} : nil),
-                      file: (env['FILE'] || 'db/seeds.rb'))
+                      file: (env['FILE'] || 'db/seeds.rb'),
+                      import: (env['IMPORT'] == 'true'))
 
         append = true
       end

data/seed_dump.gemspec

@@ -2,14 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: seed_dump 3.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "seed_dump"
-  s.version = "3.1.0"
+  s.version = "3.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
   s.authors = ["Rob Halff", "Ryan Oblak"]
-  s.date = "2014-01-09"
+  s.date = "2014-07-27"
   s.description = "Dump (parts) of your database to db/seeds.rb to get a headstart creating a meaningful seeds.rb file"
   s.email = "rroblak@gmail.com"
   s.extra_rdoc_files = [
@@ -39,32 +41,34 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "https://github.com/rroblak/seed_dump"
   s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "2.0.3"
+  s.rubygems_version = "2.2.1"
   s.summary = "{Seed Dumper for Rails}"
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
-      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
-      s.add_development_dependency(%q<byebug>, [">= 0"])
-      s.add_development_dependency(%q<factory_girl>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, ["~> 4"])
+      s.add_runtime_dependency(%q<activerecord>, ["~> 4"])
+      s.add_development_dependency(%q<byebug>, ["~> 2.0"])
+      s.add_development_dependency(%q<factory_girl>, ["~> 4.0"])
+      s.add_development_dependency(%q<activerecord-import>, ["~> 0.4"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0"])
     else
-      s.add_dependency(%q<activesupport>, [">= 0"])
-      s.add_dependency(%q<activerecord>, [">= 0"])
-      s.add_dependency(%q<byebug>, [">= 0"])
-      s.add_dependency(%q<factory_girl>, [">= 0"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<activesupport>, ["~> 4"])
+      s.add_dependency(%q<activerecord>, ["~> 4"])
+      s.add_dependency(%q<byebug>, ["~> 2.0"])
+      s.add_dependency(%q<factory_girl>, ["~> 4.0"])
+      s.add_dependency(%q<activerecord-import>, ["~> 0.4"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0"])
     end
   else
-    s.add_dependency(%q<activesupport>, [">= 0"])
-    s.add_dependency(%q<activerecord>, [">= 0"])
-    s.add_dependency(%q<byebug>, [">= 0"])
-    s.add_dependency(%q<factory_girl>, [">= 0"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<activesupport>, ["~> 4"])
+    s.add_dependency(%q<activerecord>, ["~> 4"])
+    s.add_dependency(%q<byebug>, ["~> 2.0"])
+    s.add_dependency(%q<factory_girl>, ["~> 4.0"])
+    s.add_dependency(%q<activerecord-import>, ["~> 0.4"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0"])
   end
 end
 

data/spec/dump_methods_spec.rb

@@ -2,20 +2,29 @@ require 'spec_helper'
 
 describe SeedDump do
 
+  def expected_output(include_id = false, id_offset = 0)
+      output = "Sample.create!([\n  "
+
+      data = []
+      ((1 + id_offset)..(3 + id_offset)).each do |i|
+        data << "{#{include_id ? "id: #{i}, " : ''}string: \"string\", text: \"text\", integer: 42, float: 3.14, decimal: \"2.72\", datetime: \"1776-07-04 19:14:00\", time: \"2000-01-01 03:15:00\", date: \"1863-11-19\", binary: \"binary\", boolean: false}"
+      end
+
+      output + data.join(",\n  ") + "\n])\n"
+  end
+
   describe '.dump' do
     before do
       Rails.application.eager_load!
 
       create_db
 
-      3.times { FactoryGirl.create(:sample) }
-
-      @expected_output = "Sample.create!([\n  {string: \"string\", text: \"text\", integer: 42, float: 3.14, decimal: \"2.72\", datetime: \"1776-07-04 19:14:00\", time: \"2000-01-01 03:15:00\", date: \"1863-11-19\", binary: \"binary\", boolean: false},\n  {string: \"string\", text: \"text\", integer: 42, float: 3.14, decimal: \"2.72\", datetime: \"1776-07-04 19:14:00\", time: \"2000-01-01 03:15:00\", date: \"1863-11-19\", binary: \"binary\", boolean: false},\n  {string: \"string\", text: \"text\", integer: 42, float: 3.14, decimal: \"2.72\", datetime: \"1776-07-04 19:14:00\", time: \"2000-01-01 03:15:00\", date: \"1863-11-19\", binary: \"binary\", boolean: false}\n])\n"
+      FactoryGirl.create_list(:sample, 3)
     end
 
     context 'without file option' do
       it 'should return the dump of the models passed in' do
-        SeedDump.dump(Sample).should eq(@expected_output)
+        SeedDump.dump(Sample).should eq(expected_output)
       end
     end
 
@@ -31,7 +40,7 @@ describe SeedDump do
       it 'should dump the models to the specified file' do
         SeedDump.dump(Sample, file: @filename)
 
-        File.open(@filename) { |file| file.read.should eq(@expected_output) }
+        File.open(@filename) { |file| file.read.should eq(expected_output) }
       end
 
       context 'with append option' do
@@ -39,7 +48,7 @@ describe SeedDump do
           SeedDump.dump(Sample, file: @filename)
           SeedDump.dump(Sample, file: @filename, append: true)
 
-          File.open(@filename) { |file| file.read.should eq(@expected_output + @expected_output) }
+          File.open(@filename) { |file| file.read.should eq(expected_output + expected_output) }
         end
       end
     end
@@ -60,10 +69,7 @@ describe SeedDump do
 
       context 'without an order parameter' do
         it 'should dump the models sorted by primary key ascending' do
-          Sample.delete_all
-          samples = 3.times {|i| FactoryGirl.create(:sample, integer: i) }
-
-          SeedDump.dump(Sample).should eq("Sample.create!([\n  {string: \"string\", text: \"text\", integer: 0, float: 3.14, decimal: \"2.72\", datetime: \"1776-07-04 19:14:00\", time: \"2000-01-01 03:15:00\", date: \"1863-11-19\", binary: \"binary\", boolean: false},\n  {string: \"string\", text: \"text\", integer: 1, float: 3.14, decimal: \"2.72\", datetime: \"1776-07-04 19:14:00\", time: \"2000-01-01 03:15:00\", date: \"1863-11-19\", binary: \"binary\", boolean: false},\n  {string: \"string\", text: \"text\", integer: 2, float: 3.14, decimal: \"2.72\", datetime: \"1776-07-04 19:14:00\", time: \"2000-01-01 03:15:00\", date: \"1863-11-19\", binary: \"binary\", boolean: false}\n])\n")
+          SeedDump.dump(Sample).should eq(expected_output)
         end
       end
 
@@ -78,7 +84,7 @@ describe SeedDump do
           Sample.delete_all
           4.times { FactoryGirl.create(:sample) }
 
-          SeedDump.dump(Sample.limit(3), batch_size: 2).should eq(@expected_output)
+          SeedDump.dump(Sample.limit(3), batch_size: 2).should eq(expected_output(false, 3))
         end
       end
     end
@@ -89,15 +95,15 @@ describe SeedDump do
       end
 
       it 'should not cause records to not be dumped' do
-        SeedDump.dump(Sample, batch_size: 2).should eq(@expected_output)
+        SeedDump.dump(Sample, batch_size: 2).should eq(expected_output)
 
-        SeedDump.dump(Sample, batch_size: 1).should eq(@expected_output)
+        SeedDump.dump(Sample, batch_size: 1).should eq(expected_output)
       end
     end
 
     context 'Array' do
       it 'should return the dump of the models passed in' do
-        SeedDump.dump(Sample.all.to_a, batch_size: 2).should eq(@expected_output)
+        SeedDump.dump(Sample.all.to_a, batch_size: 2).should eq(expected_output)
       end
 
       it 'should return nil if the array is empty' do
@@ -120,6 +126,28 @@ describe SeedDump do
         SeedDump.dump([RangeSample.new]).should eq(expected_output)
       end
     end
+
+    context 'activerecord-import' do
+      it 'should dump in the activerecord-import format when import is true' do
+        SeedDump.dump(Sample, import: true, exclude: []).should eq <<-RUBY
+Sample.import([:id, :string, :text, :integer, :float, :decimal, :datetime, :time, :date, :binary, :boolean, :created_at, :updated_at], [
+  [1, "string", "text", 42, 3.14, "2.72", "1776-07-04 19:14:00", "2000-01-01 03:15:00", "1863-11-19", "binary", false, "1969-07-20 20:18:00", "1989-11-10 04:20:00"],
+  [2, "string", "text", 42, 3.14, "2.72", "1776-07-04 19:14:00", "2000-01-01 03:15:00", "1863-11-19", "binary", false, "1969-07-20 20:18:00", "1989-11-10 04:20:00"],
+  [3, "string", "text", 42, 3.14, "2.72", "1776-07-04 19:14:00", "2000-01-01 03:15:00", "1863-11-19", "binary", false, "1969-07-20 20:18:00", "1989-11-10 04:20:00"]
+])
+RUBY
+      end
+
+      it 'should omit excluded columns if they are specified' do
+        SeedDump.dump(Sample, import: true, exclude: [:id, :created_at, :updated_at]).should eq <<-RUBY
+Sample.import([:string, :text, :integer, :float, :decimal, :datetime, :time, :date, :binary, :boolean], [
+  ["string", "text", 42, 3.14, "2.72", "1776-07-04 19:14:00", "2000-01-01 03:15:00", "1863-11-19", "binary", false],
+  ["string", "text", 42, 3.14, "2.72", "1776-07-04 19:14:00", "2000-01-01 03:15:00", "1863-11-19", "binary", false],
+  ["string", "text", 42, 3.14, "2.72", "1776-07-04 19:14:00", "2000-01-01 03:15:00", "1863-11-19", "binary", false]
+])
+RUBY
+      end
+    end
   end
 end
 

data/spec/factories/samples.rb

@@ -10,5 +10,7 @@ FactoryGirl.define do
     date     Date.parse('November 19, 1863')
     binary   'binary'
     boolean  false
+    created_at DateTime.parse('July 20, 1969 20:18 UTC')
+    updated_at DateTime.parse('November 10, 1989 4:20 UTC')
   end
 end

data/spec/helpers.rb

@@ -22,6 +22,10 @@ class Rails
       @already_called = true
     end
   end
+
+  def self.env
+    'test'
+  end
 end
 
 module Helpers

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seed_dump
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Rob Halff
@@ -9,78 +9,92 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-09 00:00:00.000000000 Z
+date: 2014-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord-import
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 description: Dump (parts) of your database to db/seeds.rb to get a headstart creating
   a meaningful seeds.rb file
 email: rroblak@gmail.com
@@ -129,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: '{Seed Dumper for Rails}'