live_fixtures 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4555eba9da64e35ef61d763132a1d2e5a280c785d0b2583fcb9055e6800eae74
-  data.tar.gz: fb54c037ff212fecb9bdbe2fd0c961df6d0acba9a0ed6dab7579c5e487656b0f
+  metadata.gz: 9414f9b5a408acaff1c2749f0f3127412f23f6d364988fcf1f75ce9a15b0cbe4
+  data.tar.gz: f6304bcef06ba8b4e153d7ff19744e9af837592ea0aa72a758a5446e3933055c
 SHA512:
-  metadata.gz: 6f0af7f78d0638a22f2dc607b6a21b0cf24b95497fe974c4f0c1b1d7c4b895048deac44ec55576391ccf67bc297e8aa318e841ed1ef1669eb286b8cdeba3f932
-  data.tar.gz: 12a8488d4e93c45462e7362926f057571f54f4afe2640ff94dc422b8c3bbc9a4ff0a6b4a064962e15ca13b75c2abb60e1f016495189a28e3d14b627504152c32
+  metadata.gz: 348ebda33ef0e11062c823ab14d64dc5b5c5947686f91d2a094836b7a1499061ff7e306a1e943824a27e958dad4e8ed4581b5626b835c191a5409a2d735f557b
+  data.tar.gz: 03eb2d921c1de9d75f144c99dd5166298d2ed67d79844bb5b2aac1b44acb31a00a2076ef4ec27e2a50a72b5f41de68d6168bb517786fb1fef7aadec8d610199f

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.1.0] - 2020-12-09
+### Added
+support for selectively import tables with custom callbacks per table (#34)
+
 ## [2.0.0] - 2020-11-11
 ### Breaking changes
 This is a breaking change because LiveFixtures::Import.new now needs to receive the class_names Hash to be able to correctly compute the insert_order in case there are some unconventional class names associations. And the class_names argument is removed from import_all. But this is the only change.

data/lib/live_fixtures/export.rb

@@ -55,10 +55,15 @@ module LiveFixtures::Export
   # @yieldparam model [ActiveRecord::Base] each successive model.
   # @yieldreturn [Hash{String => Object}] a hash of attributes to be merged and saved with the model's attributes.
   def export_fixtures(models, with_references = [])
-    return unless models.present?
+    return [] unless models.present?
 
-    table_name = models.first.class.table_name
-    File.open(File.join(@dir, table_name + '.yml'), 'w') do |file|
+    model_class = models.first.class
+
+    File.open(File.join(@dir, model_class.table_name + '.yml'), 'w') do |file|
+      file.write <<~PRELUDE
+        _fixture:
+          model_class: #{model_class.name}
+      PRELUDE
 
       iterator = export_options[:show_progress] ? ProgressBarIterator : SimpleIterator
 
@@ -66,7 +71,6 @@ module LiveFixtures::Export
         more_attributes = block_given? ? yield(model) : {}
         file.write Fixture.to_yaml(model, with_references, more_attributes)
       end
-
     end
   end
 

data/lib/live_fixtures/import.rb

@@ -1,3 +1,5 @@
+require 'benchmark'
+
 # An object that facilitates the import of fixtures into a database.
 class LiveFixtures::Import
   NO_LABEL = nil
@@ -6,6 +8,13 @@ class LiveFixtures::Import
   # the inferred one if none was specified.
   attr_reader :insert_order
 
+  # Map of table_name to import routine
+  # @return [Hash<String => Proc>]
+  attr_reader :alternate_imports
+
+  # Accessor for string label for a given fixture mapping to it's db id
+  attr_reader :label_to_id
+
   # Instantiate a new Import with the directory containing your fixtures, and
   # the order in which to import them. The order should ensure fixtures
   # containing references to another fixture are imported AFTER the referenced
@@ -18,14 +27,25 @@ class LiveFixtures::Import
   # @option opts [Boolean] show_progress whether or not to show the progress bar
   # @option opts [Boolean] skip_missing_tables when false, an error will be raised if a yaml file isn't found for each table in insert_order
   # @option opts [Boolean] skip_missing_refs when false, an error will be raised if an ID isn't found for a label.
+  # @option opts [Boolean] use_insert_order_as_table_names when true, table names will be those passed in insert_order, not read from yaml files
   # @return [LiveFixtures::Import] an importer
   # @see LiveFixtures::Export::Reference
   def initialize(root_path, insert_order = nil, class_names = {}, **opts)
-    defaut_options = { show_progress: true, skip_missing_tables: false, skip_missing_refs: false }
+    defaut_options = {
+      show_progress: true,
+      skip_missing_tables: false,
+      skip_missing_refs: false,
+      use_insert_order_as_table_names: false,
+    }
     @options = defaut_options.merge(opts)
     @root_path = root_path
-    @table_names = Dir.glob(File.join(@root_path, '{*,**}/*.yml')).map do |filepath|
-      File.basename filepath, ".yml"
+
+    if insert_order && @options[:use_insert_order_as_table_names]
+      @table_names = insert_order
+    else
+      @table_names = Dir.glob(File.join(@root_path, '{*,**}/*.yml')).map do |filepath|
+        File.basename filepath, ".yml"
+      end
     end
 
     @class_names = class_names
@@ -40,7 +60,9 @@ class LiveFixtures::Import
     if @table_names.size < @insert_order.size && !@options[:skip_missing_tables]
       raise ArgumentError, "table(s) mentioned in `insert_order` which has no yml file to import: #{@insert_order - @table_names}"
     end
+
     @label_to_id = {}
+    @alternate_imports = {}
   end
 
   # Within a transaction, import all the fixtures into the database.
@@ -54,13 +76,22 @@ class LiveFixtures::Import
   # @see https://github.com/rails/rails/blob/4-2-stable/activerecord/lib/active_record/fixtures.rb#L496
   def import_all
     connection = ActiveRecord::Base.connection
+    show_progress = @options[:show_progress]
 
+    # TODO: should be additive with alternate_imports so we can delete the fixture file
     files_to_read = @table_names
 
-    unless files_to_read.empty?
-      connection.transaction(requires_new: true) do
-        files_to_read.each do |path|
-          table_name = path.tr '/', '_'
+    return if files_to_read.empty?
+
+    connection.transaction(requires_new: true) do
+      files_to_read.each do |path|
+        table_name = path.tr '/', '_'
+        if alternate = @alternate_imports[table_name]
+          time = Benchmark.ms do
+            alternate.call(@label_to_id)
+          end
+          puts "Imported %s in %.0fms" % [table_name, time] if show_progress
+        else
           class_name = @class_names[table_name.to_sym] || table_name.classify
 
           ff = Fixtures.new(connection,
@@ -71,16 +102,25 @@ class LiveFixtures::Import
                             skip_missing_refs: @options[:skip_missing_refs])
 
           conn = ff.model_connection || connection
-          iterator = @options[:show_progress] ? ProgressBarIterator : SimpleIterator
-          iterator.new(ff).each do |table_name, label, row|
-            conn.insert_fixture(row, table_name)
-            @label_to_id[label] = conn.send(:last_inserted_id, table_name) unless label == NO_LABEL
+
+          iterator = show_progress ? ProgressBarIterator : SimpleIterator
+          iterator.new(ff).each do |tname, label, row|
+            conn.insert_fixture(row, tname)
+            @label_to_id[label] = conn.send(:last_inserted_id, tname) unless label == NO_LABEL
           end
         end
       end
     end
   end
 
+  # Override import of table using a callable object
+  # @param table_name [String] table to use callable instead of fixture file
+  # @param callable [Proc] Proc/lambda that will be called with @label_to_id
+  def override(table_name, callable)
+    @alternate_imports[table_name] = callable
+    self
+  end
+
   private
 
   # Here we go through each of the fixture YAML files to see what polymorphic
@@ -131,7 +171,7 @@ class LiveFixtures::Import
     def initialize(ff)
       @ff = ff
       @bar = LiveFixtures.get_progress_bar(
-        total:ff.fixtures.size,
+        total: ff.fixtures.size,
         title: ff.model_class.name
       )
     end

data/lib/live_fixtures/version.rb

@@ -1,3 +1,3 @@
 module LiveFixtures
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: live_fixtures
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - jleven
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-11 00:00:00.000000000 Z
+date: 1970-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -214,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Tools for exporting and importing between databases managed by ActiveRecord.