db_seed_dump 1.0.0

data/spec/environment_spec.rb

@@ -0,0 +1,160 @@
+require 'spec_helper'
+
+describe SeedDump do
+  describe '.dump_using_environment' do
+    before(:all) do
+      create_db
+    end
+
+    before do
+      Rails.application.eager_load!
+
+      FactoryBot.create(:sample)
+    end
+
+    describe 'INSERT_ALL' do
+      it "specifies insert_all as true if the INSERT_ALL env var is 'true'" do
+        described_class.should_receive(:dump).with(anything, include(insert_all: true))
+
+        described_class.dump_using_environment('INSERT_ALL' => 'true')
+      end
+    end
+
+    describe 'DUMP_ALL' do
+      it 'sets empty array if dump all is true' do
+        described_class.should_receive(:dump).with(anything, include(exclude: []))
+
+        described_class.dump_using_environment('DUMP_ALL' => 'true')
+      end
+    end
+
+    describe 'APPEND' do
+      it "specifies append as true if the APPEND env var is 'true'" do
+        described_class.should_receive(:dump).with(anything, include(append: true))
+
+        described_class.dump_using_environment('APPEND' => 'true')
+      end
+
+      it "specifies append as true if the APPEND env var is 'TRUE'" do
+        described_class.should_receive(:dump).with(anything, include(append: true))
+
+        described_class.dump_using_environment('APPEND' => 'TRUE')
+      end
+
+      it "specifies append as false the first time if the APPEND env var is not 'true' (and true after that)" do
+        FactoryBot.create(:another_sample)
+
+        described_class.should_receive(:dump).with(anything, include(append: false)).ordered
+        described_class.should_receive(:dump).with(anything, include(append: true)).ordered
+
+        described_class.dump_using_environment('APPEND' => 'false')
+      end
+    end
+
+    describe 'BATCH_SIZE' do
+      it 'passes along the specified batch size' do
+        described_class.should_receive(:dump).with(anything, include(batch_size: 17))
+
+        described_class.dump_using_environment('BATCH_SIZE' => '17')
+      end
+
+      it 'passes along a nil batch size if BATCH_SIZE is not specified' do
+        described_class.should_receive(:dump).with(anything, include(batch_size: nil))
+
+        described_class.dump_using_environment
+      end
+    end
+
+    describe 'EXCLUDE' do
+      it 'passes along any attributes to be excluded' do
+        described_class.should_receive(:dump).with(anything, include(exclude: %i[baggins saggins]))
+
+        described_class.dump_using_environment('EXCLUDE' => 'baggins,saggins')
+      end
+    end
+
+    describe 'FILE' do
+      it 'passes the FILE parameter to the dump method correctly' do
+        described_class.should_receive(:dump).with(anything, include(file: 'blargle'))
+
+        described_class.dump_using_environment('FILE' => 'blargle')
+      end
+
+      it 'passes db/seeds.rb as the file parameter if no FILE is specified' do
+        described_class.should_receive(:dump).with(anything, include(file: 'db/seeds.rb'))
+
+        described_class.dump_using_environment
+      end
+    end
+
+    describe 'LIMIT' do
+      it 'applies the specified limit to the records' do
+        relation_double = double('ActiveRecord relation double')
+        Sample.should_receive(:limit).with(5).and_return(relation_double)
+
+        described_class.should_receive(:dump).with(relation_double, anything)
+        described_class.stub(:dump)
+
+        described_class.dump_using_environment('LIMIT' => '5')
+      end
+    end
+
+    ['', 'S'].each do |model_suffix|
+      model_env = "MODEL#{model_suffix}"
+
+      describe model_env do
+        context "if #{model_env} is not specified" do
+          it 'dumps all non-empty models' do
+            FactoryBot.create(:another_sample)
+
+            [Sample, AnotherSample].each do |model|
+              SeedDump.should_receive(:dump).with(model, anything)
+            end
+
+            SeedDump.dump_using_environment
+          end
+        end
+
+        context "if #{model_env} is specified" do
+          it 'dumps only the specified model' do
+            FactoryBot.create(:another_sample)
+
+            SeedDump.should_receive(:dump).with(Sample, anything)
+
+            SeedDump.dump_using_environment(model_env => 'Sample')
+          end
+
+          it 'does not dump empty models' do
+            SeedDump.should_not_receive(:dump).with(EmptyModel, anything)
+
+            SeedDump.dump_using_environment(model_env => 'EmptyModel, Sample')
+          end
+        end
+      end
+    end
+
+    describe 'MODELS_EXCLUDE' do
+      it 'dumps all non-empty models except the specified models' do
+        FactoryBot.create(:another_sample)
+
+        described_class.should_receive(:dump).with(Sample, anything)
+
+        described_class.dump_using_environment('MODELS_EXCLUDE' => 'AnotherSample')
+      end
+    end
+
+    it 'runs ok without ActiveRecord::SchemaMigration being set (needed for Rails Engines)' do
+      schema_migration = ActiveRecord::SchemaMigration
+
+      ActiveRecord.send(:remove_const, :SchemaMigration)
+
+      described_class.stub(:dump)
+
+      begin
+        described_class.dump_using_environment
+      ensure
+        ActiveRecord.const_set(:SchemaMigration, schema_migration)
+      end
+    end
+  end
+end

data/spec/factories/another_samples.rb

@@ -0,0 +1,14 @@
+FactoryBot.define do
+  factory :another_sample do
+    string   { 'string' }
+    text     { 'text' }
+    integer  { 42 }
+    float    { 3.14 }
+    decimal  { 2.72 }
+    datetime { DateTime.parse('July 4, 1776 7:14pm UTC') }
+    time     { Time.parse('3:15am UTC') }
+    date     { Date.parse('November 19, 1863') }
+    binary   { 'binary' }
+    boolean  { false }
+  end
+end

data/spec/factories/samples.rb

@@ -0,0 +1,16 @@
+FactoryBot.define do
+  factory :sample do
+    string   { 'string' }
+    text     { 'text' }
+    integer  { 42 }
+    float    { 3.14 }
+    decimal  { 2.72 }
+    datetime { DateTime.parse('July 4, 1776 7:14pm UTC') }
+    time     { Time.parse('3:15am UTC') }
+    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/factories/yet_another_samples.rb

@@ -0,0 +1,14 @@
+FactoryBot.define do
+  factory :yet_another_sample do
+    string   { 'string' }
+    text     { 'text' }
+    integer  { 42 }
+    float    { 3.14 }
+    decimal  { 2.72 }
+    datetime { DateTime.parse('July 4, 1776 7:14pm UTC') }
+    time     { Time.parse('3:15am UTC') }
+    date     { Date.parse('November 19, 1863') }
+    binary   { 'binary' }
+    boolean  { false }
+  end
+end

data/spec/helpers.rb

@@ -0,0 +1,92 @@
+# Mock Rails.application.eager_load! and define some
+# Rails models for use in specs.
+class Rails
+  def self.application
+    self
+  end
+
+  def self.eager_load!
+    @already_called ||= false
+
+    unless @already_called
+      Object.const_set('Sample', Class.new(ActiveRecord::Base))
+
+      Object.const_set('AnotherSample', Class.new(ActiveRecord::Base))
+
+      Object.const_set('YetAnotherSample', Class.new(ActiveRecord::Base))
+
+      Object.const_set('NoTableModel', Class.new(ActiveRecord::Base))
+
+      Object.const_set('EmptyModel', Class.new(ActiveRecord::Base))
+
+      @already_called = true
+    end
+  end
+
+  def self.env
+    'test'
+  end
+end
+
+module Helpers
+  def create_db
+    ActiveRecord::Migration.verbose = false
+
+    ActiveRecord::Schema.define(version: 1) do
+      create_table 'samples', force: true do |t|
+        t.string   'string'
+        t.text     'text'
+        t.integer  'integer'
+        t.float    'float'
+        t.decimal  'decimal'
+        t.datetime 'datetime'
+        t.time     'time'
+        t.date     'date'
+        t.binary   'binary'
+        t.boolean  'boolean'
+        t.datetime 'created_at', null: false
+        t.datetime 'updated_at', null: false
+      end
+
+      create_table 'another_samples', force: true do |t|
+        t.string   'string'
+        t.text     'text'
+        t.integer  'integer'
+        t.float    'float'
+        t.decimal  'decimal'
+        t.datetime 'datetime'
+        t.time     'time'
+        t.date     'date'
+        t.binary   'binary'
+        t.boolean  'boolean'
+        t.datetime 'created_at', null: false
+        t.datetime 'updated_at', null: false
+      end
+
+      create_table 'yet_another_samples', force: true do |t|
+        t.string   'string'
+        t.text     'text'
+        t.integer  'integer'
+        t.float    'float'
+        t.decimal  'decimal'
+        t.datetime 'datetime'
+        t.time     'time'
+        t.date     'date'
+        t.binary   'binary'
+        t.boolean  'boolean'
+        t.datetime 'created_at', null: false
+        t.datetime 'updated_at', null: false
+      end
+
+      create_table 'empty_models', force: true
+    end
+  end
+
+  def load_sample_data
+    Rails.application.eager_load!
+
+    Sample.create!
+
+    ChildSample.create!
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+require 'seed_dump'
+
+require 'active_support'
+require 'active_record'
+
+require 'tempfile'
+
+require 'byebug'
+
+require 'database_cleaner'
+require 'factory_bot'
+
+require './spec/helpers'
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+
+FactoryBot.find_definitions
+
+RSpec.configure do |config|
+  config.order = 'random'
+
+  config.include Helpers
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before do
+    DatabaseCleaner.start
+  end
+
+  config.after do
+    DatabaseCleaner.clean
+  end
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: db_seed_dump
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rob Halff
+- Ryan Oblak
+- Nick Flueckiger
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rgl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.8.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Dump (parts) of your database to db/seeds.rb to get a headstart creating
+  a meaningful seeds.rb file
+email: nick.flueckiger@renuo.ch
+executables:
+- fastcheck
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bin/fastcheck
+- db_seed_dump.gemspec
+- lib/seed_dump.rb
+- lib/seed_dump/dependency_unwrangler.rb
+- lib/seed_dump/dump_methods.rb
+- lib/seed_dump/dump_methods/enumeration.rb
+- lib/seed_dump/environment.rb
+- lib/seed_dump/railtie.rb
+- lib/tasks/seed_dump.rake
+- spec/dump_methods_spec.rb
+- spec/environment_spec.rb
+- spec/factories/another_samples.rb
+- spec/factories/samples.rb
+- spec/factories/yet_another_samples.rb
+- spec/helpers.rb
+- spec/spec_helper.rb
+homepage: https://github.com/reno/seed_dump
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: "{Seed Dumper for Rails}"
+test_files: []