separate_history 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc395963f666596f7efacf30e2a23a43430c8dd9a05b8c3610f236afa09d6847
+  data.tar.gz: 67c0767c09a4748791590a02f86d4eddcb001c0df2ceef4209ce231ea1a26ddd
+SHA512:
+  metadata.gz: 1b6dd2568dac8ecb8e0e86ef8a148225c5b66926f433081236b6d59a94ee8758901c63f1869b27fc8d40233ba077036c4e030a9198d62e2624fc5ba08a78dfd8
+  data.tar.gz: 50a6e61ae7a304cf3803ed82f78d914eec7a4093b59b1a881f12dfba30b315e30389f2c092757cdfe76e4ec73256485868c0a2d5c1d9ba9dc61322e724775976

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/Appraisals

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+appraise "rails-7.0" do
+  gem "rails", "~> 7.0.0"
+  gem "sqlite3", "~> 1.4"
+end
+
+appraise "rails-7.1" do
+  gem "rails", "~> 7.1.0"
+end
+
+appraise "rails-7.2" do
+  gem "rails", "~> 7.2.0"
+end
+
+appraise "rails-8.0" do
+  gem "rails", "~> 8.0.0.rc1"
+  gem "sqlite3", "~> 2.1"
+end

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-06-26
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Sarvesh Kumar Dwivedi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,350 @@
+# SeparateHistory
+
+[![CI](https://github.com/sarvesh4396/separate_history/actions/workflows/test.yml/badge.svg)](https://github.com/sarvesh4396/separate_history/actions/workflows/test.yml)
+[![Gem Version](https://badge.fury.io/rb/separate_history.svg)](https://badge.fury.io/rb/separate_history)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+`SeparateHistory` provides a simple and flexible way to keep a complete history of your ActiveRecord model changes in a separate, dedicated history table. It automatically records every `create`, `update`, and `destroy` event, ensuring you have a full audit trail of your data.
+
+## Features
+
+- **Automatic History Tracking:** Automatically creates a history record for every create, update, and destroy action on your models.
+- **Dedicated History Tables:** Keeps your history data separate from your primary tables, ensuring your main application's performance is not impacted.
+- **Point-in-Time Recovery:** Easily retrieve the state of a record at any point in the past.
+- **Easy Setup:** Get started with a single line in your model and a simple migration generator.
+- **Flexible Configuration:** Select which attributes to track, customize history table names, and more.
+- **Data Integrity:** Includes a `manipulated?` method to easily check if a history record has been altered after its creation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'separate_history'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Quick Start
+
+Getting started with `SeparateHistory` is a three-step process:
+
+### 1. Generate the History Table Migration
+
+Use the provided generator to create a migration for the history table. For a model named `User`, run:
+
+```bash
+$ rails g separate_history:sync User
+```
+
+This creates a migration file that defines the schema for your history table.
+
+### 2. Generate the History Model
+
+Next, generate the history model file. This model will include the necessary `SeparateHistory::History` module.
+
+```bash
+$ rails g separate_history:model User
+```
+
+This creates the `app/models/user_history.rb` file.
+
+### 3. Run the Migration and Add to Your Model
+
+Run the migration to create the table in your database:
+
+```bash
+$ rails db:migrate
+```
+
+Finally, add the `has_separate_history` macro to your original model:
+
+```ruby
+# app/models/user.rb
+class User < ApplicationRecord
+  has_separate_history
+end
+```
+
+That's it! Now, every change to a `User` instance will be recorded in the `user_histories` table.
+## Usage
+
+### Basic Setup
+
+1. Generate and run the migration for your model:
+
+```bash
+rails generate separate_history:migration User
+rails db:migrate
+```
+
+2. Add to your model:
+
+```ruby
+class User < ApplicationRecord
+  has_separate_history
+end
+```
+
+### Tracking Options
+
+#### Track Specific Attributes
+
+```ruby
+class Article < ApplicationRecord
+  has_separate_history only: [:title, :content]
+end
+```
+
+#### Exclude Specific Attributes
+
+```ruby
+class User < ApplicationRecord
+  has_separate_history except: [:last_sign_in_ip, :encrypted_password]
+end
+```
+
+#### Track Only Changed Attributes
+
+```ruby
+class User < ApplicationRecord
+  has_separate_history track_changes: true
+end
+```
+
+### Advanced Usage
+
+#### Custom History Class Name
+
+```ruby
+class AdminUser < ApplicationRecord
+  has_separate_history history_class_name: 'AdminActionLog'
+end
+```
+
+#### Track Specific Events
+
+Track only certain events (create/update/destroy):
+
+```ruby
+class Document < ApplicationRecord
+  has_separate_history events: [:create, :update]  # Only track creation and updates
+end
+```
+
+#### Accessing History
+
+```ruby
+# Get all history records for a user
+user = User.find(1)
+user.user_histories.each do |history|
+  puts "Event: #{history.event} at #{history.history_created_at}"
+end
+
+# Or use the alias
+user.separate_histories.each { |h| puts h.inspect }
+```
+
+#### Class-Level History Queries
+
+```ruby
+# Get historical state of a record at a specific time
+old_user = User.history_as_of(user_id, 1.month.ago)
+
+# Check if history exists for a record
+if User.history_exists?(user_id)
+  # Do something with history
+end
+```
+
+### Point-in-Time History
+
+You can retrieve the state of a record at any given point in time using the `history_for` class method. It returns the last history record created before or at the specified timestamp, giving you a precise snapshot of the record's state.
+
+This query uses the `history_updated_at` timestamp to ensure accuracy, even if records were created out of order or their timestamps were manually altered.
+
+```ruby
+# Get the user record as it was 2 days ago
+user_snapshot = User.history_for(user.id, 2.days.ago)
+puts user_snapshot.name # => "Old Name"
+
+# Get what a user looked like 1 week ago
+user_week_ago = user.history_as_of(1.week.ago)
+
+# Get the state of a record that might have been deleted
+old_user = User.history_as_of(deleted_user_id, 1.month.ago)
+```
+
+### Error Handling
+
+When the history table is missing, you'll get a helpful error message:
+
+```
+History table `user_histories` is missing. 
+Run `rails g separate_history:model User` to create it.
+```
+
+### Validation and Options
+
+SeparateHistory includes built-in validation for options:
+
+```ruby
+# These will raise ArgumentError:
+has_separate_history only: [:name], except: [:email]  # Can't use both only and except
+has_separate_history invalid_option: true             # Invalid option
+has_separate_history events: [:invalid_event]         # Invalid event type
+has_separate_history track_changes: 'yes'             # Must be boolean
+```
+
+## Instance Methods
+
+When you include `has_separate_history` in your model, the following instance methods become available:
+
+- **`#snapshot_history`**  
+  Manually create a snapshot history record for the current state.
+
+- **`#history?`**  
+  Returns `true` if any history exists for this record, otherwise `false`.
+
+- **`#history_as_of(timestamp)`**  
+  Returns the state of the record at or before the given timestamp.
+
+- **`#all_history`**  
+  Returns all history records for this instance.
+
+- **`#latest_history`**  
+  Returns the most recent history record for this instance.
+
+- **`#clear_history(force: true)`**  
+  Deletes all history records for this instance.  
+  **Warning:** You must pass `force: true` to confirm deletion.
+
+**Example:**
+```ruby
+user = User.create!(name: "Alice")
+user.update!(name: "Bob")
+user.snapshot_history
+user.history? # => true
+user.all_history # => [<UserHistory ...>, ...]
+user.latest_history # => <UserHistory ...>
+user.history_as_of(1.day.ago) # => <UserHistory ...>
+user.clear_history(force: true)
+```
+
+## Advanced Usage
+
+### Tracking Only Changes
+
+By default, `SeparateHistory` saves a complete snapshot of the record on every change. For high-traffic tables, this can lead to a lot of data storage. You can optimize this by enabling the `track_changes` option. When set to `true`, only the attributes that actually changed during an `update` event will be saved.
+
+```ruby
+# in app/models/user.rb
+class User < ApplicationRecord
+  has_separate_history track_changes: true
+end
+```
+
+With this enabled, if you only update a user's name, the history record will store the new name, but all other attributes will be `nil`.
+
+### Excluding Attributes
+
+You can prevent certain attributes from being saved to the history table by using the `except` option. This is useful for ignoring fields that change frequently but aren't important for auditing, like `sign_in_count` or `last_login_at`.
+
+```ruby
+# Only track changes to name and email
+class User < ApplicationRecord
+  has_separate_history only: [:name, :email]
+end
+
+# Track all attributes except for sign_in_count
+class User < ApplicationRecord
+  has_separate_history except: [:sign_in_count]
+end
+```
+
+### Custom History Class Name
+
+If you want to use a different name for your history model, you can specify it with the `history_class_name` option.
+
+```ruby
+# in app/models/user.rb
+class User < ApplicationRecord
+  has_separate_history history_class_name: 'UserAuditTrail'
+end
+
+# in app/models/user_audit_trail.rb
+class UserAuditTrail < ApplicationRecord
+  # ...
+end
+```
+
+### Checking for Manipulation
+
+To verify that a history record has not been altered since it was first created, you can use the `manipulated?` method.
+
+```ruby
+last_history = user.histories.last
+last_history.manipulated? # => false
+
+# If someone changes the record later...
+last_history.update(name: "A new name")
+last_history.manipulated? # => true
+```
+
+## Creating Snapshots
+
+If you add `SeparateHistory` to a model with existing records, you may want to create an initial history entry for them. You can do this by creating a `snapshot` event. This is also useful for creating periodic backups of your records.
+
+Here is an example of a Rake task to create an initial snapshot for all records in your `User` model:
+
+```ruby
+# lib/tasks/history.rake
+namespace :history do
+  desc "Create initial history records for existing users"
+  task sync_users: :environment do
+    User.find_each do |user|
+      history_class = User.history_class
+      unless history_class.exists?(original_id: user.id)
+        history_class.create!(user.attributes.merge(original_id: user.id, event: 'snapshot'))
+        puts "Created snapshot for User ##{user.id}"
+      end
+    end
+  end
+end
+```
+
+Run it with `bundle exec rake history:sync_users`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake` to run the tests (RSpec, Minitest, and RuboCop).
+
+This project uses `appraisal` to test against multiple versions of Rails. The test suites can be run with:
+
+```bash
+$ bundle exec appraisal rake
+```
+
+Before running test suites install dependencies.
+
+```bash
+$ bundle exec appraisal install
+```
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Development
+
+For a detailed log of the debugging and development process for the Rails 7 compatibility fixes, please see [DEV.md](DEV.md).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/sarvesh4396/separate_history](https://github.com/sarvesh4396/separate_history).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rake/testtask"
+
+RSpec::Core::RakeTask.new(:spec)
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+# require "rubocop/rake_task"
+
+# RuboCop::RakeTask.new
+
+task default: %i[spec test]

data/gemfiles/rails_7.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.0.0"
+gem "sqlite3", "~> 1.4"
+
+gemspec path: "../"

data/gemfiles/rails_7.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.1.0"
+
+gemspec path: "../"

data/gemfiles/rails_7.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_8.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 8.0.0.rc1"
+gem "sqlite3", "~> 2.1"
+
+gemspec path: "../"

data/lib/generators/separate_history/install/install_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module SeparateHistory
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_initializer
+        template "separate_history.rb", "config/initializers/separate_history.rb"
+      end
+    end
+  end
+end

data/lib/generators/separate_history/install/templates/separate_history.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# SeparateHistory configuration goes here.
+# For example:
+# SeparateHistory.configure do |config|
+#   config.default_tracking = :on
+# end

data/lib/generators/separate_history/migration_generator.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/active_record"
+
+module SeparateHistory
+  module Generators
+    class MigrationGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+      argument :name, type: :string, desc: "The name of the model to create history for"
+
+      def create_migration_file
+        migration_template "migration.rb.erb", "db/migrate/create_#{history_table_name}.rb"
+      end
+
+      private
+
+      def history_table_name
+        "#{name.underscore}_histories"
+      end
+
+      def history_class_name
+        "#{name.camelize}History"
+      end
+
+      def original_class
+        @original_class ||= name.camelize.constantize
+      rescue NameError
+        nil
+      end
+
+      def original_table_name
+        if original_class
+          original_class.table_name
+        else
+          name.underscore.pluralize
+        end
+      end
+
+      def original_columns
+        if original_class
+          # Use actual model columns if class exists
+          original_class.columns.reject do |c|
+            [original_class.primary_key, "created_at", "updated_at"].include?(c.name)
+          end
+        else
+          # Use common columns structure if model doesn't exist
+          # This will be a basic structure for the migration
+          []
+        end
+      end
+    end
+  end
+end