active_capture 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6e10fd5af7be677b0441dd76aaa567955953ba576753b10e3130daaff2b01d0
-  data.tar.gz: 4506c04f93aefb84f841dc9c591ccebe5dd24c3199f9056e9b39999cf4184c2e
+  metadata.gz: 874ca90fb90863834525adb945cfead2334c37dcf115b3768c5c1500ac8cc85f
+  data.tar.gz: 888263dff4492a4b952e1dc491a49d0cda55c31777c7ee1db3de3e0df6823b89
 SHA512:
-  metadata.gz: f3ce3ab62a22da2e1c0e34cfc1ed13081f8a477facdfff0d3d13cb1f6aaa140981300d67f108afc1ccb99875edc0443aaf45569c0c3bb5eb71c6068339683dd0
-  data.tar.gz: 79e418aab36f10f116120753cc4962e2a9933d22649292a424afc6efc89945ee5f95230701c3d3d1ebc534914523af3bd4e787bf0052eb6fd81ef6b3cf4d81db
+  metadata.gz: 44c1c5a0cbf60145bc0c60d1b0528f2a2f7ea52f4540468ef9630dd3c3a5e2d40fcf1fab1cba86ea1da7b514ea55c14005f4da0c6c379dc00b0909e714b55f13
+  data.tar.gz: aca8f8322c896f41b84ae434cd4505a313e266d1c13f4b7c94896de25dd0025d411a697a93403e4190be580c0d2d63b6957fb0db43f632cb5d4d301a27466ae3

data/lib/active_capture/capture_storage.rb

@@ -0,0 +1,30 @@
+require 'json'
+require 'fileutils'
+require 'pry'
+
+module ActiveCapture
+  class CaptureStorage
+    CAPTURE_DIR = 'captures'
+
+    def self.save_capture(record, capture_data, name = nil)
+      model_name = record.class.name.downcase
+      record_id = record.id
+      timestamp = Time.now.strftime('%Y%m%d%H%M%S')
+      file_name = name ? "#{name}.json" : "#{record_id}_#{timestamp}.json"
+
+      dir_path = File.join(CAPTURE_DIR, model_name)
+      FileUtils.mkdir_p(dir_path)
+
+      file_path = File.join(dir_path, file_name)
+      File.write(file_path, JSON.pretty_generate(capture_data))
+
+      puts "Capture saved to #{file_path}"
+    end
+
+    def self.load_capture(capture_file)
+      raise ArgumentError, "Capture file does not exist #{capture_file}" unless File.exist?(capture_file)
+
+      JSON.parse(File.read(capture_file))
+    end
+  end
+end

data/lib/active_capture/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveCapture
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

data/lib/active_capture.rb

@@ -1,31 +1,32 @@
-require "active_capture/version"
-require_relative "active_capture/snapshot_storage"
+require 'active_capture/version'
+require_relative 'active_capture/capture_storage'
+require 'json'
+require 'active_record'
 
 module ActiveCapture
-  class Snapshot
-    def self.take(record, include_associations: [], name: nil)
-      raise ArgumentError, "Record must be an ActiveRecord::Base instance" unless record.is_a?(ActiveRecord::Base)
+  class Capture
+    def self.take(record, associations: [], name: nil)
+      raise ArgumentError, 'Record must be an ActiveRecord::Base instance' unless record.is_a?(ActiveRecord::Base)
 
-      snapshot_data = {
+      capture_data = {
         model: record.class.name,
         record_id: record.id,
         attributes: record.attributes,
-        associations: capture_associations(record, include_associations)
+        associations: capture_associations(record, associations)
       }
 
-      SnapshotStorage.save_snapshot(record, snapshot_data, name)
+      CaptureStorage.save_capture(record, capture_data, name)
     end
 
-    def self.restore(record, snapshot_file)
-      snapshot_data = JSON.parse(File.read(snapshot_file))
+    def self.restore(record, capture_file, merge: false)
+      captured_records = CaptureStorage.load_capture(capture_file)
 
-      raise ArgumentError, "Snapshot file does not match the given record" unless snapshot_data["record_id"] == record.id
+      raise ArgumentError, 'capture file does not match the given record' unless captured_records['record_id'] == record.id
 
-      # Restore record attributes
-      record.update!(snapshot_data["attributes"])
-
-      # Restore associations
-      restore_associations(record, snapshot_data["associations"])
+      ActiveRecord::Base.transaction do
+        record.update!(captured_records['attributes'])
+        restore_associations(record, captured_records['associations'], merge: merge)
+      end
     end
 
     private
@@ -35,7 +36,7 @@ module ActiveCapture
 
       associations.each do |association|
         nested_associations = []
-        
+
         if association.is_a?(Hash)
           association_name = association.keys.first
           nested_associations = association.values.flatten
@@ -45,7 +46,7 @@ module ActiveCapture
 
         if record.respond_to?(association_name)
           related_records = record.send(association_name)
-          
+
           if related_records.is_a?(ActiveRecord::Base)
             association_data[association_name] = {
               attributes: related_records.attributes,
@@ -65,22 +66,39 @@ module ActiveCapture
       association_data
     end
 
-    def self.restore_associations(record, associations_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 has_many associations
           associated_class = record.class.reflect_on_association(association_name).klass
-          record.send(association_name).destroy_all
+          existing_records = record.send(association_name)
 
           related_data.each do |related_record_data|
-            associated_record = associated_class.create!(related_record_data["attributes"])
-            restore_associations(associated_record, related_record_data["associations"])
+            if related_record_data['attributes']['id'] && existing_record = existing_records.find_by(id: related_record_data['attributes']['id'])
+              existing_record.update!(related_record_data['attributes'])
+              restore_associations(existing_record, related_record_data['associations'], merge: merge)
+            else
+              new_record = associated_class.create!(related_record_data['attributes'])
+              restore_associations(new_record, related_record_data['associations'], merge: merge)
+            end
           end
         else
-          # Restore belongs_to or has_one association
           associated_class = record.class.reflect_on_association(association_name).klass
-          associated_record = associated_class.create!(related_data["attributes"])
-          restore_associations(associated_record, related_data["associations"])
+          if merge && related_data['attributes']['id']
+            existing_record = record.send(association_name)
+
+            if existing_record && existing_record.id == related_data['attributes']['id']
+              existing_record.update!(related_data['attributes'])
+              restore_associations(existing_record, related_data['associations'], merge: merge)
+            else
+              new_record = associated_class.create!(related_data['attributes'])
+              record.update!(association_name => new_record)
+              restore_associations(new_record, related_data['associations'], merge: merge)
+            end
+          else
+            new_record = associated_class.create!(related_data['attributes'])
+            record.update!(association_name => new_record)
+            restore_associations(new_record, related_data['associations'], merge: merge)
+          end
         end
       end
     end

data/test/test_active_capture.rb

@@ -1,5 +1,5 @@
-require "test_helper"
-require "minitest/autorun"
+require 'test_helper'
+require 'minitest/autorun'
 
 class ActiveCaptureTest < Minitest::Test
   def setup
@@ -9,36 +9,30 @@ class ActiveCaptureTest < Minitest::Test
     @comment2 = @post.comments.create!(content: "Thanks for sharing.")
   end
 
-  def test_snapshot_with_nested_associations
-    ActiveCapture::Snapshot.take(@user, include_associations: [{ posts: :comments }])
+  def test_capture_with_associations
+    ActiveCapture::Capture.take(@user, associations: [:posts, { posts: :comments }])
 
-    snapshot_files = Dir["snapshots/user/*.json"]
-    assert !snapshot_files.empty?, "Snapshot file should be created"
+    capture_files = Dir["captures/user/*.json"]
+    assert !capture_files.empty?, "capture file should be created"
 
-    snapshot_content = JSON.parse(File.read(snapshot_files.last))
-    assert_equal 1, snapshot_content["associations"]["posts"].size
-    assert_equal 2, snapshot_content["associations"]["posts"].first["associations"]["comments"].size
+    capture_content = JSON.parse(File.read(capture_files.last))
+    assert_equal 1, capture_content["associations"]["posts"].size
+    assert_equal 2, capture_content["associations"]["posts"].first["associations"]["comments"].size
   end
 
-  def test_restore_from_snapshot
-    ActiveCapture::Snapshot.take(@user, include_associations: [{ posts: :comments }])
-    snapshot_file = Dir["snapshots/user/*.json"].last
+  def test_restore_with_merge
+    ActiveCapture::Capture.take(@user, associations: [:posts, { posts: :comments }])
+    capture_file = Dir["captures/user/*.json"].last
+    @post.update(title: "updated title")
+    new_comment = @post.comments.create!(content: "Another comment")
+    ActiveCapture::Capture.restore(@user, capture_file, merge: true)
 
-    # Modify records
-    @user.update!(name: "Jane Doe")
-    @post.update!(title: "Updated Post")
-    @comment1.destroy
-
-    # Restore from snapshot
-    ActiveCapture::Snapshot.restore(@user, snapshot_file)
-
-    # Reload records
     @user.reload
     @post.reload
 
-    # Assertions
     assert_equal "John Doe", @user.name
     assert_equal "First Post", @post.title
-    assert_equal 2, @post.comments.count
+    assert_equal 3, @post.comments.count
+    assert @post.comments.exists?(new_comment.id), "New comment should still exist after merge"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: active_capture
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Tanmay Bhawsar
 bindir: bin
 cert_chain: []
-date: 2025-03-29 00:00:00.000000000 Z
+date: 2025-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -23,7 +23,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: ActiveCapture allows you to save snapshots of ActiveRecord records, including
+description: ActiveCapture allows you to save captures of ActiveRecord records, including
   their nested associations, and restore them at any point. Useful for auditing, backups,
   and rollback functionality.
 email: bhawsartanmay@gmail.com
@@ -32,7 +32,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/active_capture.rb
-- lib/active_capture/snapshot_storage.rb
+- lib/active_capture/capture_storage.rb
 - lib/active_capture/version.rb
 - test/test_active_capture.rb
 - test/test_helper.rb
@@ -58,6 +58,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.2
 specification_version: 4
-summary: A Ruby on Rails gem for taking and restoring snapshots of ActiveRecord records
+summary: A Ruby on Rails gem for taking and restoring captures of ActiveRecord records
   with nested associations.
 test_files: []

data/lib/active_capture/snapshot_storage.rb

@@ -1,23 +0,0 @@
-require 'json'
-require 'fileutils'
-
-module ActiveCapture
-  class SnapshotStorage
-    SNAPSHOT_DIR = "snapshots"
-
-    def self.save_snapshot(record, snapshot_data, name)
-      model_name = record.class.name.downcase
-      record_id = record.id
-      timestamp = Time.now.strftime("%Y%m%d%H%M%S")
-      file_name = "#{record_id}_#{timestamp}.json"
-
-      dir_path = File.join(SNAPSHOT_DIR, model_name)
-      FileUtils.mkdir_p(dir_path)
-
-      file_path = File.join(dir_path, file_name)
-      File.write(file_path, JSON.pretty_generate(snapshot_data))
-
-      puts "Snapshot saved to #{file_path}"
-    end
-  end
-end