db_seed_dump 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 12060dc2ff4d43740982f7ba85591a5957be54061b5edb727a9a4b98d0f5eb0a
+  data.tar.gz: b82fc9a34b062e6fd4e74589d99c807037c8fb02c22a25613a2fb087672b62b6
+SHA512:
+  metadata.gz: 71c7aa7db97b4a637146f3ca9022ff8e1379f0f91ed8096dd0ae9de5df05f971fd63ffec5d81cd49955e8bf5fd10bc52523398485985681a40fb127807444b94
+  data.tar.gz: 8ec68dead1f7db5ecc0e842d0f42216be36cfa5a790e29c8f7b8696f0132ab571762e637cb754771e62aaa968f721474db22c747a02ba4c6176288df65dd984c

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rubocop.yml

@@ -0,0 +1,92 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+Layout/LineLength:
+  Max: 120
+
+Lint/MissingSuper:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/MixinUsage:
+  Exclude:
+    - 'bin/setup'
+    - 'bin/update'
+    - 'db/seeds.rb'
+
+Style/NonNilCheck:
+  IncludeSemanticChanges: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/HashAsLastArrayItem:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+    - 'config/environments/**/*.rb'
+    - 'config/routes.rb'
+    - 'db/seeds.rb'
+
+Metrics/MethodLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/system/**/*'
+    - 'spec/views/**/*'
+
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/DescribedClass:
+  SkipBlocks: true
+
+RSpec/ExampleLength:
+  Max: 20
+  Exclude:
+    - 'spec/system/**/*'
+    - 'spec/requests/**/*'
+    - 'spec/views/**/*'
+
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/views/**/*'
+
+RSpec/NestedGroups:
+  Max: 5
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'bin/**/*'
+    - 'db_seed_dump.gemspec'
+
+inherit_mode:
+  merge:
+    - Exclude

data/.rubocop_todo.yml

@@ -0,0 +1,118 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config --auto-gen-only-exclude --exclude-limit 1000`
+# on 2021-09-23 15:39:08 UTC using RuboCop version 1.21.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'seed_dump.gemspec'
+
+# Offense count: 1
+# Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches.
+Lint/DuplicateBranch:
+  Exclude:
+    - 'lib/seed_dump/dump_methods.rb'
+
+# Offense count: 3
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/seed_dump/dump_methods/enumeration.rb'
+    - 'lib/seed_dump/environment.rb'
+    - 'spec/dump_methods_spec.rb'
+
+# Offense count: 5
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes, Max.
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/seed_dump/dump_methods.rb'
+    - 'lib/seed_dump/dump_methods/enumeration.rb'
+    - 'lib/seed_dump/environment.rb'
+    - 'spec/helpers.rb'
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods, Max.
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/seed_dump/dump_methods.rb'
+
+# Offense count: 6
+# Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods, IgnoredMethods.
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/seed_dump/dump_methods.rb'
+    - 'lib/seed_dump/dump_methods/enumeration.rb'
+    - 'lib/seed_dump/environment.rb'
+    - 'spec/helpers.rb'
+
+# Offense count: 1
+# Configuration parameters: CountComments, Max, CountAsOne.
+Metrics/ModuleLength:
+  Exclude:
+    - 'lib/seed_dump/dump_methods.rb'
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods, Max.
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/seed_dump/dump_methods.rb'
+
+# Offense count: 1
+RSpec/BeforeAfterAll:
+  Exclude:
+    - 'spec/environment_spec.rb'
+
+# Offense count: 6
+# Configuration parameters: Prefixes.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/dump_methods_spec.rb'
+
+# Offense count: 2
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
+# Include: **/*_spec*rb*, **/spec/**/*
+RSpec/FilePath:
+  Exclude:
+    - 'spec/dump_methods_spec.rb'
+    - 'spec/environment_spec.rb'
+
+# Offense count: 6
+# Configuration parameters: AssignmentOnly.
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/dump_methods_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/environment_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'spec/helpers.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: Mode.
+Style/StringConcatenation:
+  Exclude:
+    - 'lib/seed_dump/dump_methods.rb'
+
+# Offense count: 8
+# Cop supports --auto-correct.
+# Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Exclude:
+    - 'Rakefile'
+    - 'seed_dump.gemspec'
+    - 'spec/dump_methods_spec.rb'

data/Gemfile

@@ -0,0 +1,24 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '>= 4'
+gem 'activesupport', '>= 4'
+gem 'rgl'
+
+group :development, :test do
+  gem 'activerecord-import', '~> 0.4'
+  gem 'byebug', '~> 11.0'
+  gem 'factory_bot', '~> 4.8.2'
+  gem 'rubocop', require: false
+  gem 'rubocop-performance', require: false
+  gem 'rubocop-rspec', require: false
+end
+
+group :development do
+  gem 'jeweler', '~> 2.0'
+end
+
+group :test do
+  gem 'database_cleaner', '~> 1.0'
+  gem 'rspec', '~> 3.7.0'
+  gem 'sqlite3', '~> 1.0'
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2021 Nick Flueckiger
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,125 @@
+Seed Dump
+========
+
+Seed Dump is a Rails 4 and 5 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.
+
+Installation
+------------
+
+Add it to your Gemfile with:
+```ruby
+gem 'seed_dump', git: 'git://github.com/renuo/seed_dump', branch: 'master'
+```
+
+Documentation
+-------------
+
+This documentation is point to the develop branch of the repository.
+For the documentation of the current release head to: https://github.com/renuo/seed_dump/blob/master/README.md.
+
+Examples
+--------
+
+### Rake task
+
+Dump all data directly to `db/seeds.rb`:
+```sh
+  $ rake db:seed:dump
+```
+Result:
+```ruby
+Product.create!([
+  { category_id: 1, description: "Long Sleeve Shirt", name: "Long Sleeve Shirt" },
+  { category_id: 3, description: "Plain White Tee Shirt", name: "Plain T-Shirt" }
+])
+User.create!([
+  { password: "123456", username: "test_1" },
+  { password: "234567", username: "test_2" }
+])
+```
+
+Dump only data from the users table and dump a maximum of 1 record:
+```sh
+$ rake db:seed:dump MODELS=User LIMIT=1
+```
+
+Result:
+```ruby
+User.create!([
+  { password: "123456", username: "test_1" }
+])
+```
+
+Append to `db/seeds.rb` instead of overwriting it:
+```sh
+rake db:seed:dump APPEND=true
+```
+
+Use another output file instead of `db/seeds.rb`:
+```sh
+rake db:seed:dump FILE=db/seeds/users.rb
+```
+
+Exclude `name` and `age` from the dump:
+```sh
+rake db:seed:dump EXCLUDE=name,age
+```
+
+There are more options that can be set— see below for all of them.
+
+### Console
+
+Output a dump of all User records:
+```ruby
+irb(main):001:0> puts SeedDump.dump(User)
+User.create!([
+  { password: "123456", username: "test_1" },
+  { password: "234567", username: "test_2" }
+])
+```
+
+Write the dump to a file:
+```ruby
+irb(main):002:0> SeedDump.dump(User, file: 'db/seeds.rb')
+```
+
+Append the dump to a file:
+```ruby
+irb(main):003:0> SeedDump.dump(User, file: 'db/seeds.rb', append: true)
+```
+
+Exclude `name` and `age` from the dump:
+```ruby
+irb(main):004:0> SeedDump.dump(User, exclude: [:name, :age])
+```
+
+Options are specified as a Hash for the second argument.
+
+In the console, any relation of ActiveRecord rows can be dumped (not individual objects though)
+```ruby
+irb(main):001:0> puts SeedDump.dump(User.where(is_admin: false))
+User.create!([
+  { password: "123456", username: "test_1", is_admin: false },
+  { password: "234567", username: "test_2", is_admin: false }
+])
+```
+
+Options
+-------
+
+| Option          | Values        | Usage                                                                                                                      | Default                         |
+|-----------------|---------------|----------------------------------------------------------------------------------------------------------------------------|---------------------------------|
+| append          | [true, false] | Set if the data should be appended to the file or overwritten                                                              | false                           |
+| batch_size      | [Integer]     | Number of records written to the file at once. Decrease if you are running out of memory, Increase if too slow             | 1000                            |
+| limit           | [Integer]     | Limits the number of entries dumped into the seeds file                                                                    | no                              |
+| file            | [Path]        | Sets the file path for the output seeds file                                                                               | 'db/seeds.rb'                   |
+| exclude         | [Columns]     | Exclude multiple attributes from the dump                                                                                  | [:id, :created_at, :updated_at] |
+| import          | [true, false] | Use the format for the [activerecord-import](https://github.com/zdennis/activerecord-import) gem                           | false                           |
+| conditions      | []            | Dump only specific records to the seeds. Can be set in the console with (e.g. `SeedDump.dump(User.where(state: :active))`) | None                            |
+| models          | [Models]      | List of models that should be dumped to the seeds                                                                          | All Models                      |
+| models_excluded | [Models]      | List of modles that should be excluded from the seeds dump                                                                 | No Models excluded              |
+| insert_all      | [true, false] | Set if the data should use insert_all instead of create! in the dump                                                       | false                           |

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'db_seed_dump'
+    gem.summary = '{Seed Dumper for Rails}'
+    gem.description = %{Dump (parts) of your database to db/seeds.rb to get a headstart creating a meaningful seeds.rb file}
+    gem.email = 'nick.flueckiger@renuo.ch'
+    gem.homepage = 'https://github.com/reno/seed_dump'
+    gem.authors = ['Rob Halff', 'Ryan Oblak', 'Nick Flueckiger']
+    gem.license = 'MIT'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler'
+end
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "db_seed_dump #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/bin/fastcheck

@@ -0,0 +1 @@
+bundle exec rubocop

data/db_seed_dump.gemspec

@@ -0,0 +1,80 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: db_seed_dump 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "db_seed_dump".freeze
+  s.version = "1.0.0"
+
+  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, "Nick Flueckiger".freeze]
+  s.date = "2021-10-02"
+  s.description = "Dump (parts) of your database to db/seeds.rb to get a headstart creating a meaningful seeds.rb file".freeze
+  s.email = "nick.flueckiger@renuo.ch".freeze
+  s.executables = ["fastcheck".freeze]
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.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"
+  ]
+  s.homepage = "https://github.com/reno/seed_dump".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "3.2.22".freeze
+  s.summary = "{Seed Dumper for Rails}".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+  end
+
+  if s.respond_to? :add_runtime_dependency then
+    s.add_runtime_dependency(%q<activerecord>.freeze, [">= 4"])
+    s.add_runtime_dependency(%q<activesupport>.freeze, [">= 4"])
+    s.add_runtime_dependency(%q<rgl>.freeze, [">= 0"])
+    s.add_development_dependency(%q<activerecord-import>.freeze, ["~> 0.4"])
+    s.add_development_dependency(%q<byebug>.freeze, ["~> 11.0"])
+    s.add_development_dependency(%q<factory_bot>.freeze, ["~> 4.8.2"])
+    s.add_development_dependency(%q<rubocop>.freeze, [">= 0"])
+    s.add_development_dependency(%q<rubocop-performance>.freeze, [">= 0"])
+    s.add_development_dependency(%q<rubocop-rspec>.freeze, [">= 0"])
+    s.add_development_dependency(%q<jeweler>.freeze, ["~> 2.0"])
+  else
+    s.add_dependency(%q<activerecord>.freeze, [">= 4"])
+    s.add_dependency(%q<activesupport>.freeze, [">= 4"])
+    s.add_dependency(%q<rgl>.freeze, [">= 0"])
+    s.add_dependency(%q<activerecord-import>.freeze, ["~> 0.4"])
+    s.add_dependency(%q<byebug>.freeze, ["~> 11.0"])
+    s.add_dependency(%q<factory_bot>.freeze, ["~> 4.8.2"])
+    s.add_dependency(%q<rubocop>.freeze, [">= 0"])
+    s.add_dependency(%q<rubocop-performance>.freeze, [">= 0"])
+    s.add_dependency(%q<rubocop-rspec>.freeze, [">= 0"])
+    s.add_dependency(%q<jeweler>.freeze, ["~> 2.0"])
+  end
+end
+

data/lib/seed_dump/dependency_unwrangler.rb

@@ -0,0 +1,51 @@
+require 'rgl/adjacency'
+require 'rgl/topsort'
+
+class SeedDump
+  class DependencyUnwrangler
+    def initialize(models)
+      @models = models
+      @graph = RGL::DirectedAdjacencyGraph.new
+      @evaluation_order = []
+    end
+
+    def evaluation_order
+      return [] if @models.empty?
+      return @evaluation_order unless @evaluation_order.empty?
+
+      build_graph unless graph_built?
+
+      @evaluation_order = @graph.topsort_iterator.to_a.reverse
+      @evaluation_order
+    end
+
+    private
+
+    def build_graph
+      @models.map do |model|
+        referents_by_model(model).each do |referent|
+          @graph.add_edge(model, referent)
+        end
+      end
+    end
+
+    def graph_built?
+      !@graph.edges.empty? && !@graph.vertices.empty?
+    end
+
+    def referents_by_model(model)
+      associations = model.reflect_on_all_associations(:belongs_to)
+      associations.map do |association|
+        association.options[:polymorphic] ? collect_polymorphic_deps(association) : association.klass
+      end.flatten
+    end
+
+    def collect_polymorphic_deps(association)
+      ActiveRecord::Base.descendants.select do |other_model|
+        other_model.reflect_on_all_associations(:has_many).any? do |has_many_association|
+          has_many_association.options[:as] == association.name
+        end
+      end
+    end
+  end
+end

data/lib/seed_dump/dump_methods/enumeration.rb

@@ -0,0 +1,86 @@
+class SeedDump
+  module DumpMethods
+    module Enumeration
+      def active_record_enumeration(records, _io, options)
+        # If the records don't already have an order,
+        # order them by primary key ascending.
+        if !records.respond_to?(:arel) || records.arel.orders.blank?
+          records.order("#{records.quoted_table_name}.#{records.quoted_primary_key} ASC")
+        end
+
+        num_of_batches, batch_size, last_batch_size = batch_params_from(records, options)
+
+        processed_entities = 0
+        # Loop through each batch
+        (1..num_of_batches).each do |batch_number|
+          record_strings = []
+
+          last_batch = (batch_number == num_of_batches)
+
+          cur_batch_size = if last_batch
+                             last_batch_size
+                           else
+                             batch_size
+                           end
+
+          processed_entities += cur_batch_size
+
+          # Loop through the records of the current batch
+          records.offset((batch_number - 1) * batch_size).limit(cur_batch_size).each do |record|
+            record_strings << dump_record(record, options)
+          end
+
+          should_split_file = split_file?(processed_entities, options)
+          processed_entities -= options[:file_split_limit] if should_split_file
+
+          yield record_strings, last_batch, should_split_file
+        end
+      end
+
+      def split_file?(processed_entities, options)
+        return false if options[:file_split_limit].nil?
+
+        (processed_entities / file_index_from(options)) >= options[:file_split_limit]
+      end
+
+      def enumerable_enumeration(records, _io, options)
+        num_of_batches, batch_size = batch_params_from(records, options)
+
+        record_strings = []
+
+        batch_number = 1
+
+        records.each_with_index do |record, i|
+          record_strings << dump_record(record, options)
+
+          last_batch = (i == records.length - 1)
+
+          next unless (record_strings.length == batch_size) || last_batch
+
+          yield record_strings, last_batch
+
+          record_strings = []
+          batch_number += 1
+        end
+      end
+
+      def batch_params_from(records, options)
+        batch_size = batch_size_from(options)
+
+        count = records.count
+
+        remainder = count % batch_size
+
+        [(count.to_f / batch_size).ceil, batch_size, (remainder.zero? ? batch_size : remainder)]
+      end
+
+      def batch_size_from(options)
+        options[:batch_size]&.to_i || 1000
+      end
+
+      def file_index_from(options)
+        options[:current_file_index]&.to_i || 1
+      end
+    end
+  end
+end