seed_dump 3.2.4 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e45348bd633ee31389d05784d8245f4901fd6f9f
-  data.tar.gz: c206280da2f2cf3dfbb777ef4354c961e3ea097e
+SHA256:
+  metadata.gz: 6ad701d741d9d678ca2d18480816402ba57d0210ad05850f831071b97ee17dc2
+  data.tar.gz: 2cddc929053a270b34504df28b864aedbd883cf33f05897541a663fe89794c7e
 SHA512:
-  metadata.gz: 514d8fbe85d91f41738dd6f68d13d96338b5c7d95c7d9169d456c71ea81954489ad51e970c1a4fe56a37891c072f3f033c6b001de12e1f3a57423542a91c0dfe
-  data.tar.gz: d8c406d03f95cd8135dd521a9f89e54894d0a7e333dcced76d09fb2f78ba1ae896a30a71ffb995c17da03b7d31ce942f570da114816151b0e6e3176a798e512d
+  metadata.gz: c89bbe066ed9ebf63299cbb3d3b097c672e7f1ca2ea9897f52a07d152f2946e525715f7ba29eccedb7369601d70a38c261b55190be4175b2f6925a569fa27e52
+  data.tar.gz: e316ce680fa0266bb1b6ee7ae85b76780812e23ef48ad1a72a78fe9a5ed6390d3db7f913bb9741def118850a8b15fd2a633faf552c0ca41a9c09ef306f4a7e10

data/Gemfile

@@ -5,7 +5,7 @@ gem 'activerecord', '>= 4'
 
 group :development, :test do
   gem 'byebug', '~> 2.0'
-  gem 'factory_girl', '~> 4.0'
+  gem 'factory_bot', '~> 4.8.2'
   gem 'activerecord-import', '~> 0.4'
 end
 
@@ -14,7 +14,7 @@ group :development do
 end
 
 group :test do
-  gem 'rspec', '~> 2.0'
+  gem 'rspec', '~> 3.7.0'
   gem 'sqlite3', '~> 1.0'
   gem 'database_cleaner', '~> 1.0'
 end

data/VERSION

@@ -1 +1 @@
-3.2.4
+3.3.0

data/lib/seed_dump/dump_methods.rb

@@ -42,6 +42,8 @@ class SeedDump
                 value.to_s(:db)
               when Range
                 range_to_string(value)
+              when ->(v) { v.class.ancestors.map(&:to_s).include?('RGeo::Feature::Instance') }
+                value.to_s
               else
                 value
               end
@@ -87,7 +89,7 @@ class SeedDump
         io.write(",\n  ") unless last_batch
       end
 
-      io.write("\n])\n")
+      io.write("\n]#{active_record_import_options(options)})\n")
 
       if options[:file].present?
         nil
@@ -97,6 +99,12 @@ class SeedDump
       end
     end
 
+    def active_record_import_options(options)
+      return unless options[:import] && options[:import].is_a?(Hash)
+
+      ', ' + options[:import].map { |key, value| "#{key}: #{value}" }.join(', ')
+    end
+
     def attribute_names(records, options)
       attribute_names = if records.is_a?(ActiveRecord::Relation) || records.is_a?(Class)
                           records.attribute_names

data/lib/seed_dump/environment.rb

@@ -4,7 +4,60 @@ class SeedDump
     def dump_using_environment(env = {})
       Rails.application.eager_load!
 
+      models = retrieve_models(env) - retrieve_models_exclude(env)
+
+      limit = retrieve_limit_value(env)
+      append = retrieve_append_value(env)
+      models.each do |model|
+        model = model.limit(limit) if limit.present?
+
+        SeedDump.dump(model,
+                      append: append,
+                      batch_size: retrieve_batch_size_value(env),
+                      exclude: retrieve_exclude_value(env),
+                      file: retrieve_file_value(env),
+                      import: retrieve_import_value(env))
+
+        append = true # Always append for every model after the first
+                      # (append for the first model is determined by
+                      # the APPEND environment variable).
+      end
+    end
+
+    private
+    # Internal: Array of Strings corresponding to Active Record model class names
+    # that should be excluded from the dump.
+    ACTIVE_RECORD_INTERNAL_MODELS = ['ActiveRecord::SchemaMigration',
+                                     'ActiveRecord::InternalMetadata']
+
+    # Internal: Retrieves an Array of Active Record model class constants to be
+    # dumped.
+    #
+    # If a "MODEL" or "MODELS" environment variable is specified, there will be
+    # an attempt to parse the environment variable String by splitting it on
+    # commmas and then converting it to constant.
+    #
+    # Model classes that do not have corresponding database tables or database
+    # records will be filtered out, as will model classes internal to Active
+    # Record.
+    #
+    # env - Hash of environment variables from which to parse Active Record
+    #       model classes. The Hash is not optional but the "MODEL" and "MODELS"
+    #       keys are optional.
+    #
+    # Returns the Array of Active Record model classes to be dumped.
+    def retrieve_models(env)
+      # Parse either the "MODEL" environment variable or the "MODELS"
+      # environment variable, with "MODEL" taking precedence.
       models_env = env['MODEL'] || env['MODELS']
+
+      # If there was a use models environment variable, split it and
+      # convert the given model string (e.g. "User") to an actual
+      # model constant (e.g. User).
+      #
+      # If a models environment variable was not given, use descendants of
+      # ActiveRecord::Base as the target set of models. This should be all
+      # model classes in the project.
       models = if models_env
                  models_env.split(',')
                            .collect {|x| x.strip.underscore.singularize.camelize.constantize }
@@ -12,33 +65,75 @@ class SeedDump
                  ActiveRecord::Base.descendants
                end
 
-      models = models.select do |model|
-                 (model.to_s != 'ActiveRecord::SchemaMigration') && \
-                  model.table_exists? && \
-                  model.exists?
-               end
 
-      append = (env['APPEND'] == 'true')
+      # Filter the set of models to exclude:
+      #   - The ActiveRecord::SchemaMigration model which is internal to Rails
+      #     and should not be part of the dumped data.
+      #   - Models that don't have a corresponding table in the database.
+      #   - Models whose corresponding database tables are empty.
+      filtered_models = models.select do |model|
+                          !ACTIVE_RECORD_INTERNAL_MODELS.include?(model.to_s) && \
+                          model.table_exists? && \
+                          model.exists?
+                        end
+    end
 
-      models_exclude_env = env['MODELS_EXCLUDE']
-      if models_exclude_env
-        models_exclude_env.split(',')
-                          .collect {|x| x.strip.underscore.singularize.camelize.constantize }
-                          .each { |exclude| models.delete(exclude) }
-      end
+    # Internal: Returns a Boolean indicating whether the value for the "APPEND"
+    # key in the given Hash is equal to the String "true" (ignoring case),
+    # false if no value exists.
+    def retrieve_append_value(env)
+      parse_boolean_value(env['APPEND'])
+    end
 
-      models.each do |model|
-        model = model.limit(env['LIMIT'].to_i) if env['LIMIT']
+    # Internal: Returns a Boolean indicating whether the value for the "IMPORT"
+    # key in the given Hash is equal to the String "true" (ignoring case),
+    # false if  no value exists.
+    def retrieve_import_value(env)
+      parse_boolean_value(env['IMPORT'])
+    end
 
-        SeedDump.dump(model,
-                      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'),
-                      import: (env['IMPORT'] == 'true'))
+    # Internal: Retrieves an Array of Class constants parsed from the value for
+    # the "MODELS_EXCLUDE" key in the given Hash, and an empty Array if such
+    # key exists.
+    def retrieve_models_exclude(env)
+      env['MODELS_EXCLUDE'].to_s
+                           .split(',')
+                           .collect { |x| x.strip.underscore.singularize.camelize.constantize }
+    end
 
-        append = true
-      end
+    # Internal: Retrieves an Integer from the value for the "LIMIT" key in the
+    # given Hash, and nil if no such key exists.
+    def retrieve_limit_value(env)
+      retrieve_integer_value('LIMIT', env)
+    end
+
+    # Internal: Retrieves an Array of Symbols from the value for the "EXCLUDE"
+    # key from the given Hash, and nil if no such key exists.
+    def retrieve_exclude_value(env)
+      env['EXCLUDE'] ? env['EXCLUDE'].split(',').map {|e| e.strip.to_sym} : nil
+    end
+
+    # Internal: Retrieves the value for the "FILE" key from the given Hash, and
+    # 'db/seeds.rb' if no such key exists.
+    def retrieve_file_value(env)
+      env['FILE'] || 'db/seeds.rb'
+    end
+
+    # Internal: Retrieves an Integer from the value for the "BATCH_SIZE" key in
+    # the given Hash, and nil if no such key exists.
+    def retrieve_batch_size_value(env)
+      retrieve_integer_value('BATCH_SIZE', env)
+    end
+
+    # Internal: Retrieves an Integer from the value for the given key in
+    # the given Hash, and nil if no such key exists.
+    def retrieve_integer_value(key, hash)
+      hash[key] ? hash[key].to_i : nil
+    end
+
+    # Internal: Parses a Boolean from the given value.
+    def parse_boolean_value(value)
+      value.to_s.downcase == 'true'
     end
   end
 end

data/seed_dump.gemspec

@@ -2,18 +2,18 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: seed_dump 3.2.4 ruby lib
+# stub: seed_dump 3.3.0 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = "seed_dump"
-  s.version = "3.2.4"
+  s.name = "seed_dump".freeze
+  s.version = "3.3.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 = "2015-12-25"
-  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.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Rob Halff".freeze, "Ryan Oblak".freeze]
+  s.date = "2018-04-20"
+  s.description = "Dump (parts) of your database to db/seeds.rb to get a headstart creating a meaningful seeds.rb file".freeze
+  s.email = "rroblak@gmail.com".freeze
   s.extra_rdoc_files = [
     "README.md"
   ]
@@ -39,36 +39,36 @@ Gem::Specification.new do |s|
     "spec/helpers.rb",
     "spec/spec_helper.rb"
   ]
-  s.homepage = "https://github.com/rroblak/seed_dump"
-  s.licenses = ["MIT"]
-  s.rubygems_version = "2.4.5"
-  s.summary = "{Seed Dumper for Rails}"
+  s.homepage = "https://github.com/rroblak/seed_dump".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "2.7.6".freeze
+  s.summary = "{Seed Dumper for Rails}".freeze
 
   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>, [">= 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"])
+      s.add_runtime_dependency(%q<activesupport>.freeze, [">= 4"])
+      s.add_runtime_dependency(%q<activerecord>.freeze, [">= 4"])
+      s.add_development_dependency(%q<byebug>.freeze, ["~> 2.0"])
+      s.add_development_dependency(%q<factory_bot>.freeze, ["~> 4.8.2"])
+      s.add_development_dependency(%q<activerecord-import>.freeze, ["~> 0.4"])
+      s.add_development_dependency(%q<jeweler>.freeze, ["~> 2.0"])
     else
-      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"])
+      s.add_dependency(%q<activesupport>.freeze, [">= 4"])
+      s.add_dependency(%q<activerecord>.freeze, [">= 4"])
+      s.add_dependency(%q<byebug>.freeze, ["~> 2.0"])
+      s.add_dependency(%q<factory_bot>.freeze, ["~> 4.8.2"])
+      s.add_dependency(%q<activerecord-import>.freeze, ["~> 0.4"])
+      s.add_dependency(%q<jeweler>.freeze, ["~> 2.0"])
     end
   else
-    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"])
+    s.add_dependency(%q<activesupport>.freeze, [">= 4"])
+    s.add_dependency(%q<activerecord>.freeze, [">= 4"])
+    s.add_dependency(%q<byebug>.freeze, ["~> 2.0"])
+    s.add_dependency(%q<factory_bot>.freeze, ["~> 4.8.2"])
+    s.add_dependency(%q<activerecord-import>.freeze, ["~> 0.4"])
+    s.add_dependency(%q<jeweler>.freeze, ["~> 2.0"])
   end
 end
 

data/spec/dump_methods_spec.rb

@@ -19,7 +19,7 @@ describe SeedDump do
 
       create_db
 
-      FactoryGirl.create_list(:sample, 3)
+      FactoryBot.create_list(:sample, 3)
     end
 
     context 'without file option' do
@@ -30,7 +30,7 @@ describe SeedDump do
 
     context 'with file option' do
       before do
-        @filename = Dir::Tmpname.make_tmpname(File.join(Dir.tmpdir, 'foo'), nil)
+        @filename = Tempfile.new(File.join(Dir.tmpdir, 'foo'), nil)
       end
 
       after do
@@ -61,7 +61,7 @@ describe SeedDump do
       context 'with an order parameter' do
         it 'should dump the models in the specified order' do
           Sample.delete_all
-          samples = 3.times {|i| FactoryGirl.create(:sample, integer: i) }
+          samples = 3.times {|i| FactoryBot.create(:sample, integer: i) }
 
           SeedDump.dump(Sample.order('integer DESC')).should eq("Sample.create!([\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  {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: 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])\n")
         end
@@ -82,7 +82,7 @@ describe SeedDump do
 
         it 'should dump the number of models specified by the limit when the limit is larger than the batch size but not a multiple of the batch size' do
           Sample.delete_all
-          4.times { FactoryGirl.create(:sample) }
+          4.times { FactoryBot.create(:sample) }
 
           SeedDump.dump(Sample.limit(3), batch_size: 2).should eq(expected_output(false, 3))
         end
@@ -147,6 +147,18 @@ Sample.import([:string, :text, :integer, :float, :decimal, :datetime, :time, :da
 ])
 RUBY
       end
+
+      context 'should add the params to the output if they are specified' do
+        it 'should dump in the activerecord-import format when import is true' do
+          SeedDump.dump(Sample, import: { validate: false }, 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"]
+], validate: false)
+          RUBY
+        end
+      end
     end
   end
 end

data/spec/environment_spec.rb

@@ -9,7 +9,7 @@ describe SeedDump do
     before(:each) do
       Rails.application.eager_load!
 
-      FactoryGirl.create(:sample)
+      FactoryBot.create(:sample)
     end
 
     describe 'APPEND' do
@@ -19,8 +19,14 @@ describe SeedDump do
         SeedDump.dump_using_environment('APPEND' => 'true')
       end
 
+      it "should specify append as true if the APPEND env var is 'TRUE'" do
+        SeedDump.should_receive(:dump).with(anything, include(append: true))
+
+        SeedDump.dump_using_environment('APPEND' => 'TRUE')
+      end
+
       it "should specify append as false the first time if the APPEND env var is not 'true' (and true after that)" do
-        FactoryGirl.create(:another_sample)
+        FactoryBot.create(:another_sample)
 
         SeedDump.should_receive(:dump).with(anything, include(append: false)).ordered
         SeedDump.should_receive(:dump).with(anything, include(append: true)).ordered
@@ -83,7 +89,7 @@ describe SeedDump do
       describe model_env do
         context "if #{model_env} is not specified" do
           it "should dump all non-empty models" do
-            FactoryGirl.create(:another_sample)
+            FactoryBot.create(:another_sample)
 
             [Sample, AnotherSample].each do |model|
               SeedDump.should_receive(:dump).with(model, anything)
@@ -95,7 +101,7 @@ describe SeedDump do
 
         context "if #{model_env} is specified" do
           it "should dump only the specified model" do
-            FactoryGirl.create(:another_sample)
+            FactoryBot.create(:another_sample)
 
             SeedDump.should_receive(:dump).with(Sample, anything)
 
@@ -113,7 +119,7 @@ describe SeedDump do
 
     describe "MODELS_EXCLUDE" do
       it "should dump all non-empty models except the specified models" do
-        FactoryGirl.create(:another_sample)
+        FactoryBot.create(:another_sample)
 
         SeedDump.should_receive(:dump).with(Sample, anything)
 

data/spec/factories/another_samples.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :another_sample do
     string   'string'
     text     'text'

data/spec/factories/samples.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :sample do
     string   'string'
     text     'text'

data/spec/factories/yet_another_samples.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :yet_another_sample do
     string   'string'
     text     'text'

data/spec/spec_helper.rb

@@ -8,17 +8,15 @@ require 'tempfile'
 require 'byebug'
 
 require 'database_cleaner'
-require 'factory_girl'
+require 'factory_bot'
 
 require './spec/helpers'
 
 ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
 
-FactoryGirl.find_definitions
+FactoryBot.find_definitions
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-
   config.order = 'random'
 
   config.include Helpers

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seed_dump
 version: !ruby/object:Gem::Version
-  version: 3.2.4
+  version: 3.3.0
 platform: ruby
 authors:
 - Rob Halff
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-25 00:00:00.000000000 Z
+date: 2018-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -54,19 +54,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.8.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.8.2
 - !ruby/object:Gem::Dependency
   name: activerecord-import
   requirement: !ruby/object:Gem::Requirement
@@ -143,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: "{Seed Dumper for Rails}"