rails-archiver 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b647fb72150d65930552bb7c012b90df5c3f8d74
-  data.tar.gz: ba295dee7a18aec3b628c73d6e9cf4836e38aa20
+  metadata.gz: e89e5ca01be0d05982ac7fa26975124829306cae
+  data.tar.gz: 6780627670479f1c424524a8deda72fa1c929469
 SHA512:
-  metadata.gz: ed11fad708c175d2c6f8bcb5fe557a722ae0b414da057c9ec7fed6aead8b919cb383d910fc13d7aca9e15252fb84cbfe64e1dc0396b39ef9ed2be9f58edb6e71
-  data.tar.gz: 44c2c0a496b2301d57a3738ce6d59c7dec05d3e339c56e261fd20b06a822c3d38c4f80f31ae3e75b6c20783518f72fcb47f1c5cd8168a9de1edcaa609f55aa25
+  metadata.gz: bba0013c0242a752fa52e28c25c3514a531bec16b0d50562897db64c932ab021aa4e9466d770eed74b12bb20d753e2d71bc2028001ef5f032ecfb098075f99fc
+  data.tar.gz: 244cb0624a39829ac8ecc00cc5e335ea4bcd27c86590b1e29de418bd022f2e80b97e1b0bce343ae72bf13fdc2639434577d264b2f6ce6ef5f7a5370e4ac9b5e6

data/lib/rails-archiver/archiver.rb

@@ -39,18 +39,54 @@ module RailsArchiver
     def archive
       @logger.info("Starting archive of #{@model.class.name} #{@model.id}")
       @hash = {}
-      _visit_association(@model)
+      visit_nodes(@model)
+      save_additional_data
       @logger.info('Completed loading data')
       @archive_location = @transport.store_archive(@hash)
       if @model.attribute_names.include?('archived')
         @model.update_attribute(:archived, true)
       end
-      @logger.info('Deleting rows')
-      _delete_records if @options[:delete_records]
-      @logger.info('All records deleted')
+      if @options[:delete_records]
+        @logger.info('Deleting rows')
+        _delete_records
+        @logger.info('All records deleted')
+      end
       @hash
     end
 
+    # Use this method to add more data into the archive hash which isn't
+    # directly accessible from the parent model. Call `visit_nodes` on each
+    # set of data you want to add. To be overridden by subclasses.
+    def save_additional_data
+    end
+
+    # Used to visit an association, and recursively calls down to
+    # all child objects through all other allowed associations.
+    # @param node [ActiveRecord::Base|Array<ActiveRecord::Base>]
+    #    any object(s) that inherits from ActiveRecord::Base
+    def visit_nodes(node)
+      return if node.blank?
+      if node.respond_to?(:each) # e.g. a list of nodes from a has_many association
+        node.each { |n| visit_nodes(n) }
+      else
+        class_name = node.class.name
+        @hash[class_name] ||= Set.new
+        @hash[class_name] << visit(node)
+        get_associations(node).each do |assoc|
+          @logger.debug("Visiting #{assoc.name}")
+          new_nodes = node.send(assoc.name)
+          next if new_nodes.blank?
+
+          if new_nodes.respond_to?(:find_each)
+            new_nodes.find_each { |n| visit_nodes(n) }
+          else
+            visit_nodes(new_nodes)
+          end
+        end
+
+      end
+    end
+
     # Returns a single object in the database represented as a hash.
     # Does not account for any associations, only prints out the columns
     # associated with the object as they relate to the current schema.
@@ -92,6 +128,13 @@ module RailsArchiver
       @logger.info("Finished deleting from #{table}")
     end
 
+    # @return [RailsArchiver::Unarchiver]
+    def unarchiver
+      unarchiver = RailsArchiver::Unarchiver.new(@model, :logger => @logger)
+      unarchiver.transport = self.transport
+      unarchiver
+    end
+
     protected
 
     # Callback that runs after deletion is finished.
@@ -131,31 +174,5 @@ module RailsArchiver
       end
     end
 
-    # Used to visit an association, and recursively calls down to
-    # all child objects through all other allowed associations.
-    # @param node [ActiveRecord::Base|Array<ActiveRecord::Base>]
-    #    any object(s) that inherits from ActiveRecord::Base
-    def _visit_association(node)
-      return if node.blank?
-      if node.respond_to?(:each) # e.g. a list of nodes from a has_many association
-        node.each { |n| _visit_association(n) }
-      else
-        class_name = node.class.name
-        @hash[class_name] ||= Set.new
-        @hash[class_name] << visit(node)
-        get_associations(node).each do |assoc|
-          @logger.debug("Visiting #{assoc.name}")
-          new_nodes = node.send(assoc.name)
-          next if new_nodes.blank?
-
-          if new_nodes.respond_to?(:find_each)
-            new_nodes.find_each { |n| _visit_association(n) }
-          else
-            _visit_association(new_nodes)
-          end
-        end
-
-      end
-    end
   end
 end

data/lib/rails-archiver/unarchiver.rb

@@ -32,15 +32,18 @@ module RailsArchiver
     # model) depending on the transport being used.
     def unarchive(location=nil)
       @errors = []
+      source = @model ? @model.class.name : location
       @logger.info('Downloading JSON file')
       hash = @transport.retrieve_archive(location)
-      @logger.info("Loading #{@model.class.name}")
+      @logger.info("Loading #{source}")
       load_classes(hash)
-      @model.reload
-      if @model.attribute_names.include?('archived')
-        @model.update_attribute(:archived, false)
+      if @model
+        @model.reload
+        if @model.attribute_names.include?('archived')
+          @model.update_attribute(:archived, false)
+        end
       end
-      @logger.info("#{@model.class.name} load complete!")
+      @logger.info("#{source} load complete!")
     end
 
     # Load a list of general classes that were saved as JSON.
@@ -98,12 +101,12 @@ module RailsArchiver
       model = klass.where(klass.primary_key => hash[klass.primary_key]).first
       if model.nil?
         model = klass.new
-        model.send(:attributes=, attrs, false)
+        _assign_attributes(model, attrs)
         # can't set this in the attribute hash, it'll be overridden. Need
         # to set it manually.
         model[klass.primary_key] = hash[klass.primary_key]
       else
-        model.send(:attributes=, attrs, false)
+        _assign_attributes(model, attrs)
       end
 
       model
@@ -111,6 +114,16 @@ module RailsArchiver
 
     private
 
+    # @param model [ActiveRecord::Base]
+    # @param attrs [Hash]
+    def _assign_attributes(model, attrs)
+      if model.method(:attributes=).arity == 1
+        model.attributes = attrs
+      else
+        model.send(:attributes=, attrs, false)
+      end
+    end
+
     def _get_transport(symbol_or_object)
       if symbol_or_object.is_a?(Symbol)
         klass = if symbol_or_object.present?

data/rails-archiver.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name         = 'rails-archiver'
   s.require_paths = %w(. lib lib/rails-archiver)
-  s.version      = '0.1.4'
-  s.date         = '2018-06-01'
+  s.version      = '0.1.5'
+  s.date         = '2018-06-04'
   s.summary      = 'Fully archive a Rails model'
   s.description  = <<-EOF
   EOF

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-archiver
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Daniel Orner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-01 00:00:00.000000000 Z
+date: 2018-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails