active_capture 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93b2a116c7a013ba34b42a5211179f14185d2e60d324ff74da5f4f23a8f30a7d
-  data.tar.gz: dd339d97072f5440c0ef2551c73aa6708bc9e22f894fda9e5641eb463d013399
+  metadata.gz: 408cdbd0f3cea245a023857573782eab133c6f8d3a41981ff190702c8f6424bb
+  data.tar.gz: 9726c3c013f766036550a1170d8f4b71f382043058e78701fee884654b002f6c
 SHA512:
-  metadata.gz: 17dde4d63324dc3f3e8934e8e5310b3484be942e653068ff9e6d97474d52641571749a556f40985164b9067f3669ed1979f2ccf692479dd998e59c380c549ec9
-  data.tar.gz: 2f0111ff053df52edec0f1632716e45224f1447a811253543212766d685a9d881e7d2b0ec6841cee696bf99ff05c570beff835bfb4daf4674f1a5db3cd493fb5
+  metadata.gz: '08763c65b1bf808fbf85677e912621e34ffc2d00de886a6242f1bdc5308e425215e293d471403a6bc14c51b92bab82d4c2e6cf652421192c66977a2cd4c46a7e'
+  data.tar.gz: 6dfbb8e4974cc7382d5b6999413643d7483586843582eba130424ba0929519855f9d0519a14615ac0c37dfdea593bb6e73f353d0130f710e03836069e81d0bab

data/lib/active_capture.rb

@@ -4,6 +4,7 @@ require 'json'
 require 'active_record'
 
 module ActiveCapture
+  # Captures the state of a record and its associations
   def self.take(record, associations: [], name: nil)
     validate_record(record)
 
@@ -15,18 +16,21 @@ module ActiveCapture
     }
 
     begin
+      # Save the captured data in json file
       Support::CaptureStorage.save_capture(record, capture_data, name)
     rescue StandardError => e
       raise "Failed to save capture: #{e.message}"
     end
   end
 
+  # Restores a record and its associations from a capture file
   def self.restore(record, capture_file, merge: false)
     captured_records = Support::CaptureStorage.load_capture(capture_file)
     validate_capture(record, captured_records)
 
     ActiveRecord::Base.transaction do
       begin
+        # Update the record's attributes and restore its associations
         record.update!(captured_records['attributes'])
         restore_associations(record, captured_records['associations'], merge: merge)
       rescue StandardError => e
@@ -35,24 +39,28 @@ module ActiveCapture
     end
   end
 
+  # Flushes all captured data of a specified directory
   def self.flush(directory)
     Support::CaptureStorage.flush(directory)
   end
 
   private
 
+  # Validates that the given record is an ActiveRecord instance
   def self.validate_record(record)
     unless record.is_a?(ActiveRecord::Base)
       raise ArgumentError, 'Record must be an ActiveRecord::Base instance'
     end
   end
 
+  # Validates that the capture file matches the given record
   def self.validate_capture(record, captured_records)
     unless captured_records['record_id'] == record.id
       raise ArgumentError, 'Capture file does not match the given record'
     end
   end
 
+  # Captures the specified associations of a record
   def self.capture_associations(record, associations)
     associations.each_with_object({}) do |association, association_data|
       association_name, nested_associations = parse_association(association)
@@ -60,6 +68,7 @@ module ActiveCapture
       next unless record.respond_to?(association_name)
 
       begin
+        # Capture the related records for the association
         related_records = record.send(association_name)
         association_data[association_name] = capture_related_records(related_records, nested_associations)
       rescue StandardError => e
@@ -68,6 +77,7 @@ module ActiveCapture
     end
   end
 
+  # Captures the attributes and nested associations of related records
   def self.capture_related_records(related_records, nested_associations)
     if related_records.is_a?(ActiveRecord::Base)
       {
@@ -84,6 +94,7 @@ module ActiveCapture
     end
   end
 
+  # Parses an association to extract its name and nested associations
   def self.parse_association(association)
     if association.is_a?(Hash)
       [association.keys.first, association.values.flatten]
@@ -92,36 +103,44 @@ module ActiveCapture
     end
   end
 
+  # Restores the associations of a record from captured data
   def self.restore_associations(record, associations_data, merge: false)
     associations_data.each do |association_name, related_data|
       if related_data.is_a?(Array)
+        # Restore a collection association (e.g., has_many)
         restore_collection_association(record, association_name, related_data, merge)
       else
+        # Restore a single association (e.g., belongs_to, has_one)
         restore_single_association(record, association_name, related_data, merge)
       end
     end
   end
 
+  # Restores a collection association (e.g., has_many)
   def self.restore_collection_association(record, association_name, related_data, merge)
     associated_class = record.class.reflect_on_association(association_name).klass
     existing_records = record.send(association_name)
 
     related_data.each do |related_record_data|
       if merge && related_record_data['attributes']['id']
+        # Update existing records if merging is enabled
         existing_record = existing_records.find_by(id: related_record_data['attributes']['id'])
         if existing_record
           update_and_restore(existing_record, related_record_data, merge)
           next
         end
       end
+      # Create and restore new records
       create_and_restore(associated_class, related_record_data, record, association_name)
     end
   end
 
+  # Restores a single association (e.g., belongs_to, has_one)
   def self.restore_single_association(record, association_name, related_data, merge)
     associated_class = record.class.reflect_on_association(association_name).klass
 
     if merge && related_data['attributes']['id']
+      # Update existing record if merging is enabled
       existing_record = record.send(association_name)
       if existing_record&.id == related_data['attributes']['id']
         update_and_restore(existing_record, related_data, merge)
@@ -129,15 +148,18 @@ module ActiveCapture
       end
     end
 
+    # Create and restore a new record
     new_record = create_and_restore(associated_class, related_data)
     record.update!(association_name => new_record)
   end
 
+  # Updates an existing record and restores its associations
   def self.update_and_restore(record, related_data, merge)
     record.update!(related_data['attributes'])
     restore_associations(record, related_data['associations'], merge: merge)
   end
 
+  # Creates a new record and restores its associations
   def self.create_and_restore(associated_class, related_data, parent_record = nil, association_name = nil)
     new_record = associated_class.create!(related_data['attributes'])
     restore_associations(new_record, related_data['associations'], merge: false)

data/lib/support/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Support
-  VERSION = "1.1.2"
+  VERSION = "1.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_capture
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Tanmay Bhawsar