active_capture 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c6e10fd5af7be677b0441dd76aaa567955953ba576753b10e3130daaff2b01d0
+  data.tar.gz: 4506c04f93aefb84f841dc9c591ccebe5dd24c3199f9056e9b39999cf4184c2e
+SHA512:
+  metadata.gz: f3ce3ab62a22da2e1c0e34cfc1ed13081f8a477facdfff0d3d13cb1f6aaa140981300d67f108afc1ccb99875edc0443aaf45569c0c3bb5eb71c6068339683dd0
+  data.tar.gz: 79e418aab36f10f116120753cc4962e2a9933d22649292a424afc6efc89945ee5f95230701c3d3d1ebc534914523af3bd4e787bf0052eb6fd81ef6b3cf4d81db

data/lib/active_capture/snapshot_storage.rb

@@ -0,0 +1,23 @@
+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

data/lib/active_capture/version.rb

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

data/lib/active_capture.rb

@@ -0,0 +1,88 @@
+require "active_capture/version"
+require_relative "active_capture/snapshot_storage"
+
+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)
+
+      snapshot_data = {
+        model: record.class.name,
+        record_id: record.id,
+        attributes: record.attributes,
+        associations: capture_associations(record, include_associations)
+      }
+
+      SnapshotStorage.save_snapshot(record, snapshot_data, name)
+    end
+
+    def self.restore(record, snapshot_file)
+      snapshot_data = JSON.parse(File.read(snapshot_file))
+
+      raise ArgumentError, "Snapshot file does not match the given record" unless snapshot_data["record_id"] == record.id
+
+      # Restore record attributes
+      record.update!(snapshot_data["attributes"])
+
+      # Restore associations
+      restore_associations(record, snapshot_data["associations"])
+    end
+
+    private
+
+    def self.capture_associations(record, associations)
+      association_data = {}
+
+      associations.each do |association|
+        nested_associations = []
+        
+        if association.is_a?(Hash)
+          association_name = association.keys.first
+          nested_associations = association.values.flatten
+        else
+          association_name = association
+        end
+
+        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,
+              associations: capture_associations(related_records, nested_associations)
+            }
+          elsif related_records.respond_to?(:map)
+            association_data[association_name] = related_records.map do |related_record|
+              {
+                attributes: related_record.attributes,
+                associations: capture_associations(related_record, nested_associations)
+              }
+            end
+          end
+        end
+      end
+
+      association_data
+    end
+
+    def self.restore_associations(record, associations_data)
+      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
+
+          related_data.each do |related_record_data|
+            associated_record = associated_class.create!(related_record_data["attributes"])
+            restore_associations(associated_record, related_record_data["associations"])
+          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"])
+        end
+      end
+    end
+  end
+end

data/test/test_active_capture.rb

@@ -0,0 +1,44 @@
+require "test_helper"
+require "minitest/autorun"
+
+class ActiveCaptureTest < Minitest::Test
+  def setup
+    @user = User.create!(name: "John Doe", email: "john@example.com")
+    @post = @user.posts.create!(title: "First Post", content: "This is my first post.")
+    @comment1 = @post.comments.create!(content: "Great post!")
+    @comment2 = @post.comments.create!(content: "Thanks for sharing.")
+  end
+
+  def test_snapshot_with_nested_associations
+    ActiveCapture::Snapshot.take(@user, include_associations: [{ posts: :comments }])
+
+    snapshot_files = Dir["snapshots/user/*.json"]
+    assert !snapshot_files.empty?, "Snapshot 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
+  end
+
+  def test_restore_from_snapshot
+    ActiveCapture::Snapshot.take(@user, include_associations: [{ posts: :comments }])
+    snapshot_file = Dir["snapshots/user/*.json"].last
+
+    # 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
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,46 @@
+# test/test_helper.rb
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)  # This line makes sure your gem's lib directory is included in the load path.
+require "active_capture"
+require "minitest/autorun"
+require "active_record"
+
+# Setup an in-memory SQLite database for testing
+ActiveRecord::Base.establish_connection(
+  adapter: "sqlite3",
+  database: ":memory:"
+)
+
+ActiveRecord::Schema.define do
+  create_table :users, force: true do |t|
+    t.string :name
+    t.string :email
+    t.timestamps
+  end
+
+  create_table :posts, force: true do |t|
+    t.integer :user_id
+    t.string :title
+    t.text :content
+    t.timestamps
+  end
+
+  create_table :comments, force: true do |t|
+    t.integer :post_id
+    t.string :content
+    t.timestamps
+  end
+end
+
+class User < ActiveRecord::Base
+  has_many :posts
+end
+
+class Post < ActiveRecord::Base
+  belongs_to :user
+  has_many :comments
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+end
+

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: active_capture
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Tanmay Bhawsar
+bindir: bin
+cert_chain: []
+date: 2025-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: ActiveCapture allows you to save snapshots of ActiveRecord records, including
+  their nested associations, and restore them at any point. Useful for auditing, backups,
+  and rollback functionality.
+email: bhawsartanmay@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/active_capture.rb
+- lib/active_capture/snapshot_storage.rb
+- lib/active_capture/version.rb
+- test/test_active_capture.rb
+- test/test_helper.rb
+homepage: https://github.com/bhawsartanmay/active_capture
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bhawsartanmay/active_capture
+  source_code_uri: https://github.com/bhawsartanmay/active_capture
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A Ruby on Rails gem for taking and restoring snapshots of ActiveRecord records
+  with nested associations.
+test_files: []