archive_hook 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 19b341cbc8d91d83b80ff2c777b6c2abba0218ac6ad5e2ff1babee26a9f39502
+  data.tar.gz: a1c5c5ff85989613db345b5bb5a173e164e96a1d55776a7bf6a199c7d63604e7
+SHA512:
+  metadata.gz: c3f0b6235c99999eb379cd8985902464b568f0cf5c68e8453aa88226cca508fb3a4a398671ef70b5d6124dc048bcf0ef897344eb3f3f8f5316fab87c39ff0efd
+  data.tar.gz: aeb121668ac39e8f9b2b95e69a4a4332371657ad0b1e554e834d06cb2738fcc71bc3454fa3c11b95e54a6aaa086f726bcd52650f98232df7a4c44ba33f4a857c

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.10
+before_install: gem install bundler -v 2.3.26

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at shurik.v.r@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem "rails", "~> 6.1"
+gem "pg"
+
+# Specify your gem's dependencies in archive_hook.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,176 @@
+PATH
+  remote: .
+  specs:
+    archive_hook (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.4.7)
+      actionpack (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.4.7)
+      actionpack (= 6.1.4.7)
+      activejob (= 6.1.4.7)
+      activerecord (= 6.1.4.7)
+      activestorage (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+      mail (>= 2.7.1)
+    actionmailer (6.1.4.7)
+      actionpack (= 6.1.4.7)
+      actionview (= 6.1.4.7)
+      activejob (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.4.7)
+      actionview (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.4.7)
+      actionpack (= 6.1.4.7)
+      activerecord (= 6.1.4.7)
+      activestorage (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.4.7)
+      activesupport (= 6.1.4.7)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.4.7)
+      activesupport (= 6.1.4.7)
+      globalid (>= 0.3.6)
+    activemodel (6.1.4.7)
+      activesupport (= 6.1.4.7)
+    activerecord (6.1.4.7)
+      activemodel (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+    activestorage (6.1.4.7)
+      actionpack (= 6.1.4.7)
+      activejob (= 6.1.4.7)
+      activerecord (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+      marcel (~> 1.0.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    builder (3.2.4)
+    concurrent-ruby (1.2.2)
+    crass (1.0.6)
+    date (3.3.3)
+    diff-lcs (1.5.0)
+    erubi (1.12.0)
+    globalid (1.1.0)
+      activesupport (>= 5.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    loofah (2.21.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.18.1)
+    net-imap (0.3.6)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.3.3)
+      net-protocol
+    nio4r (2.5.9)
+    nokogiri (1.13.10-x86_64-darwin)
+      racc (~> 1.4)
+    pg (1.5.3)
+    racc (1.7.1)
+    rack (2.2.7)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails (6.1.4.7)
+      actioncable (= 6.1.4.7)
+      actionmailbox (= 6.1.4.7)
+      actionmailer (= 6.1.4.7)
+      actionpack (= 6.1.4.7)
+      actiontext (= 6.1.4.7)
+      actionview (= 6.1.4.7)
+      activejob (= 6.1.4.7)
+      activemodel (= 6.1.4.7)
+      activerecord (= 6.1.4.7)
+      activestorage (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+      bundler (>= 1.15.0)
+      railties (= 6.1.4.7)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.1.1)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
+    railties (6.1.4.7)
+      actionpack (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+      method_source
+      rake (>= 0.13)
+      thor (~> 1.0)
+    rake (10.5.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    sprockets (4.2.0)
+      concurrent-ruby (~> 1.0)
+      rack (>= 2.2.4, < 4)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    thor (1.2.2)
+    timeout (0.4.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.8)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  archive_hook!
+  bundler (~> 2.3)
+  pg
+  rails (~> 6.1)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 alvir
+
+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,162 @@
+# ArchiveHook
+
+`ArchiveHook` moves old `ActiveRecord` records out of their table and into a parallel
+`_archive` table, following a dependency tree so related child records are archived (or
+restored) together. It's designed for pruning large, fast-growing tables (reservations,
+payments, logs, etc.) without losing the data — everything just moves to `<table>_archive`.
+
+Archiving is done with raw `INSERT INTO ... SELECT` + `DELETE`/`delete_all` SQL run inside a
+transaction, in batches, so it stays reasonably efficient on large tables.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'archive_hook'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install archive_hook
+
+## Setup
+
+For every model you want to archive, create a sibling `<table_name>_archive` table with the
+same columns. A Rails generator is included to scaffold the migration for you:
+
+    $ rails generate archive_hook Board
+
+which creates `db/migrate/..._create_boards_archive.rb`:
+
+```ruby
+class CreateBoardsArchive < ActiveRecord::Migration[7.0]
+  def up
+    execute("CREATE TABLE boards_archive (LIKE boards)")
+  end
+
+  def down
+    drop_table :boards_archive
+  end
+end
+```
+
+Run the generator for the root model and for every model listed under a `children:` entry in
+your dependency mapping (see below) — each one needs its own `_archive` table.
+
+`ArchiveHook` reads the columns off the model at call time, so the archive table just needs to
+have matching column names — it doesn't need matching constraints, indexes, or an FK to the
+original table.
+
+## Usage
+
+### Archiving everything older than a date (`.archive`)
+
+`ArchiveHook.archive(model, date, dependencies)` finds root records older than `date` (by
+`created_at`, or a custom column — see below) and archives them together with their declared
+children:
+
+```ruby
+ArchiveHook.archive(Board, 1.year.ago, Board => { children: [Card] }, Card => { children: [Tag] })
+```
+
+Typically run from a scheduled job:
+
+```ruby
+class ArchiveOldBoardsJob
+  MAPPING = {
+    Board => { children: [Card] },
+    Card => { children: [Tag] }
+  }
+
+  def self.perform
+    ArchiveHook.archive(Board, 1.year.ago, MAPPING)
+  end
+end
+```
+
+To archive by a column other than `created_at`, set `column:` on the root model's entry:
+
+```ruby
+ArchiveHook.archive(Board, 1.year.ago, Board => { children: [Card], column: :published_at })
+```
+
+Only root records matching the date filter are selected — children are archived because they
+belong to an archived root, not because they're independently outdated.
+
+### Archiving an arbitrary scope (`.archive_scope`)
+
+`ArchiveHook.archive_scope(scope, dependencies = {})` archives whatever `ActiveRecord::Relation`
+you pass in, applying the same dependency tree to its children. This is handy when the set of
+records to archive isn't simply "older than X":
+
+```ruby
+ArchiveHook.archive_scope(Board.where(id: stale_ids), Board => { children: [Card] })
+```
+
+`dependencies` can be omitted (or `nil`) when the scope has no children to cascade to:
+
+```ruby
+ArchiveHook.archive_scope(Tag.where(id: stale_tag_ids), nil)
+```
+
+### Restoring archived records (`.restore_scope`)
+
+`ArchiveHook.restore_scope(scope, dependencies = {})` does the reverse: it reads from
+`<table>_archive` (aliased to the original table name, so you can scope/query it normally),
+re-inserts into the original table, and deletes the archived rows — again cascading through
+`dependencies`:
+
+```ruby
+ArchiveHook.restore_scope(Board.where(id: board_ids), Board => { children: [Card] })
+```
+
+### Dependency mapping
+
+`dependencies` is a `{ model => { children: [...], column: :... } }` hash:
+
+- `children` — models that belong to this one (matched by the inferred foreign key, e.g.
+  `Card` is expected to have a `board_id` column when nested under `Board`) and that should be
+  archived/restored along with it.
+- `column` — the timestamp column used by `.archive` to decide what's "old"; defaults to
+  `:created_at`. Only relevant for the root model passed to `.archive`.
+
+Every level of the tree that has further descendants must have its own `children` entry — a
+model that's missing from `dependencies` is treated as a leaf. If it's actually a leaf that's
+fine, but if it has its own children that aren't declared, deleting it will violate the foreign
+key from its undeclared children and raise an `ActiveRecordError`.
+
+## Notes / gotchas
+
+- All archiving/restoring runs in batches (`in_batches`), each batch wrapped in its own
+  transaction — a failure partway through can leave earlier batches archived.
+- `default_scope` on a model doesn't hide it from `ArchiveHook.archive` — it operates on
+  `unscoped` relations internally.
+- Because `.archive` only filters the root by date, make sure children are only ever reachable
+  through an archived root (or archive/restore them explicitly via `.archive_scope`).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to
+run the tests (they need a local Postgres instance; the suite creates and drops an
+`archive_hook_test` database automatically). You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new
+version, update the version number in `version.rb`, and then run `bundle exec rake release`,
+which will create a git tag for the version, push git commits and tags, and push the `.gem`
+file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ArchiveHook project's codebases, issue trackers, chat rooms and
+mailing lists is expected to follow the
+[code of conduct](https://github.com/alvir/archive_hook/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/archive_hook.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "archive_hook/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "archive_hook"
+  spec.version       = ArchiveHook::VERSION
+  spec.authors       = ["alvir"]
+  spec.email         = ["shurik.v.r@gmail.com"]
+
+  spec.summary       = %q{Archive ActiveRecord models (and their dependents) to parallel _archive tables}
+  spec.description   = %q{Moves old ActiveRecord records into sibling <table>_archive tables, cascading through a declared parent/child dependency tree, with support for restoring them back.}
+  spec.homepage      = "https://github.com/alvir/archive_hook"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    # spec.metadata["changelog_uri"] = ""
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "archive_hook"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/archive_hook/version.rb

@@ -0,0 +1,3 @@
+module ArchiveHook
+  VERSION = "0.1.0"
+end

data/lib/archive_hook.rb

@@ -0,0 +1,116 @@
+require "archive_hook/version"
+
+module ArchiveHook
+  class ScopeArchiver
+    def initialize(dependencies: {})
+      @dependencies = dependencies
+    end
+
+    def call(scope)
+      parent = scope.model
+      parent_id_groups = scope.in_batches.map { |relation| relation.pluck(:id) }
+      return if parent_id_groups.empty?
+
+      archive_children(parent, parent_id_groups)
+      parent_id_groups.each do |parent_ids|
+        archive_by_scope(parent.unscoped.where(id: parent_ids))
+      end
+    end
+
+    private
+
+    def archive_children(parent, parent_id_groups)
+      return unless @dependencies[parent] && @dependencies[parent][:children].present?
+
+      @dependencies[parent][:children].each do |child|
+        parent_id_groups.each do |parent_ids|
+          call(child.unscoped.where(parent.to_s.foreign_key => parent_ids))
+        end
+      end
+    end
+
+    def archive_by_scope(scope)
+      ActiveRecord::Base.transaction do
+        ActiveRecord::Base.connection.execute(Arel.sql(archive_records_sql(scope)))
+        scope.delete_all
+      end
+    end
+
+    def archive_records_sql(scope)
+      table_name = scope.table_name
+      attributes_list = scope.column_names.join(",")
+      <<-SQL
+        INSERT INTO #{table_name}_archive (#{attributes_list})
+        #{scope.select(attributes_list).to_sql}
+      SQL
+    end
+  end
+
+  class ScopeRestorer
+    def initialize(dependencies: {})
+      @dependencies = dependencies
+    end
+
+    def call(scope)
+      parent = scope.model
+      table_name = "#{scope.table_name}_archive as #{scope.table_name}"
+      parent_id_groups = scope.from(table_name).in_batches.map { |relation| relation.pluck(:id) }
+      parent_id_groups.each do |parent_ids|
+        restore_by_ids(parent, parent_ids)
+      end
+      restore_children(parent, parent_id_groups)
+    end
+
+    private
+
+    def restore_children(parent, parent_id_groups)
+      return unless @dependencies[parent] && @dependencies[parent][:children].present?
+
+      @dependencies[parent][:children].each do |child|
+        if parent_id_groups.present?
+          parent_id_groups.each do |parent_ids|
+            call(child.unscoped.where(parent.to_s.foreign_key => parent_ids))
+          end
+        else
+          call(child.none)
+        end
+      end
+    end
+
+    def restore_by_ids(model, ids)
+      table_name = model.table_name
+      ActiveRecord::Base.transaction do
+        ActiveRecord::Base.connection.execute(Arel.sql(restore_records_sql(model, ids)))
+        ActiveRecord::Base.connection.execute(Arel.sql <<-SQL
+          DELETE FROM #{table_name}_archive WHERE id IN (#{ids.join(', ')})
+        SQL
+        )
+      end
+    end
+
+    def restore_records_sql(model, ids)
+      table_name = model.table_name
+      attributes_list = model.column_names.join(",")
+      <<-SQL
+        INSERT INTO #{table_name} (#{attributes_list})
+        SELECT #{attributes_list} FROM #{table_name}_archive WHERE id IN (#{ids.join(', ')})
+      SQL
+    end
+  end
+
+  class << self
+    def archive(root, archive_date, dependencies)
+      column = dependencies[root] && dependencies[root][:column] || :created_at
+      base_scope = root.where("#{column} < ?", archive_date)
+      ScopeArchiver.new(dependencies: dependencies).call(base_scope)
+    end
+
+    def archive_scope(scope, dependencies = {})
+      ScopeArchiver.new(dependencies: dependencies).call(scope)
+    end
+
+    def restore_scope(scope, dependencies = {})
+      ScopeRestorer.new(dependencies: dependencies).call(scope)
+    end
+  end
+end

data/lib/generators/archive_hook/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate archive_hook Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/archive_hook/archive_hook_generator.rb

@@ -0,0 +1,27 @@
+class ArchiveHookGenerator < Rails::Generators::NamedBase
+  include Rails::Generators::Migration
+
+  source_root File.expand_path('templates', __dir__)
+
+  def copy_archive_hook_migration
+    migration_template "migration.rb", migration_file_name, migration_version: migration_version, archive_table_name: archive_table_name
+  end
+
+  def self.next_migration_number(_dir_name)
+    Time.now.utc.to_s.tr('^0-9', '')[0..13]
+  end
+
+  def migration_file_name
+    "db/migrate/create_#{archive_table_name}.rb"
+  end
+
+  def archive_table_name
+    "#{table_name}_archive"
+  end
+
+  def migration_version
+    if Rails::VERSION::MAJOR >= 5
+      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+    end
+  end
+end

data/lib/generators/archive_hook/templates/migration.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Create<%= archive_table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
+  def up
+    execute("CREATE TABLE <%= archive_table_name %> (LIKE <%= table_name %>)")
+  end
+
+  def down
+    drop_table :<%= archive_table_name %>
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: archive_hook
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- alvir
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2026-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Moves old ActiveRecord records into sibling <table>_archive tables, cascading
+  through a declared parent/child dependency tree, with support for restoring them
+  back.
+email:
+- shurik.v.r@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- archive_hook.gemspec
+- bin/console
+- bin/setup
+- lib/archive_hook.rb
+- lib/archive_hook/version.rb
+- lib/generators/archive_hook/USAGE
+- lib/generators/archive_hook/archive_hook_generator.rb
+- lib/generators/archive_hook/templates/migration.rb
+homepage: https://github.com/alvir/archive_hook
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/alvir/archive_hook
+  source_code_uri: https://github.com/alvir/archive_hook
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Archive ActiveRecord models (and their dependents) to parallel _archive tables
+test_files: []