styxable 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b5fff266f8b26a2e96d3d48cff4fbfb4bba7a804d3b3594e449794d1dd653a2
+  data.tar.gz: 4f93e3748e5629da335ec2e32466b0df390a0f7185ca18bc107105ea67057aa6
+SHA512:
+  metadata.gz: b38f9d703f88842a090b1efb4441427b8d51a0627036c3f7de684ba03a0d5159e9f2caf5fda941e34c0f9a995c4d66cad09cc30e9d641187828c5c781d28f024
+  data.tar.gz: 30f9ba47f9f659b27344f97a7330b90fcb29be27115ba8f50032a29bbb6c04ede134977e7db41a4baec13b95affda540fe665b98f4d5882e115b0db8e15a8961

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-09-09
+
+- Initial release of the Styxable gem scaffold

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"styxable" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will **be tolerant** of opposing views.
+* Participants must ensure that their language and actions are **free of personal attacks** and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always **assume good intentions**.
+* Behaviour which can be reasonably considered **harassment will not be tolerated**.
+
+If you have any concerns about behaviour within this project, please contact a maintainer.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Andreas Finger
+
+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,78 @@
+# Styxable
+
+Archivable ActiveRecords / immutable soft-delete, with (GDPR) data retention and permanent purging.
+
+> THIS IS STILL WORK IN PROGRESS OR NOT FUNCTIONAL YET!
+
+Styxable turns deletion into a three-stage lifecycle for ActiveRecord models: active, archived, purged. Calling styx_archive soft-deletes a record — it (optionally) vanishes from default scopes like being in a trash can or recycle bin, but the row survives, so foreign keys, joins, reports and audits keep working. Archived records can still be listed, counted and restored during a configurable grace or retention period, giving you an undo window or restore window instead of an irreversible destroy.
+
+While a record sits in the archive it is immutable: writes are rejected, so nothing can be silently edited between archiving and erasure — like in a vault. styx_unarchive brings a record back, unless it cannot, for example when a newer record has claimed a unique attribute in the meantime. Archiving cascades along dependent: associations, so closing an account, deactivating a user or tearing down a tenant can archive everything it owns in a single call, with callbacks around each step.
+
+Each model declares its own data retention period. A recurring background job then permanently destroys records whose retention window has expired, expressing your retention schedule, records disposition and automatic purge in code rather than in a runbook — useful for GDPR storage limitation and right to erasure ("right to be forgotten") obligations, or any policy with a TTL or expiry date. A before-purge callback lets you detach ActiveStorage blobs, delete remote files or notify external systems before a record crosses the Styx for good.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add styxable
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install styxable
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Who or what is 'Styx'? Why 'Styxable'?
+
+In greek mythology **Styx** is the river dividing the world of the living from the realm of the dead — and also a goddess, a daughter of Oceanus and Tethys. For being the first to side with Zeus in the war against the Titans, he made her waters the oath by which the gods themselves must swear, and an oath sworn on the Styx cannot be broken. 
+
+Four things about that story map onto what this gem does.
+
+| In the myth                                                                                                                                                                                                                            | In Styxable                                                                                                                                                                                                                                                                                                                                            |
+|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| The Styx is a **boundary, not an ending**. Souls cross out of the living world; they do not stop existing                                                                                                                              | `styx_archive` moves a record out of your default scopes and out of the working set. The row survives, so foreign keys, joins, reports and audits still resolve                                                                                                                                                                                        |
+| An oath sworn on the Styx is **unbreakable**                                                                                                                                                                                           | Archived records are `immutable`. Writes are rejected for as long as the record stays archived                                                                                                                                                                                                                                                         |
+| The return is **possible, but conditional**. Orpheus crossed and was granted Eurydice back — on a condition he failed to keep, and lost her a second time                                                                              | `styx_unarchive` can bring a record back, unless the world moved on and a newer record has claimed a unique attribute in the meantime                                                                                                                                                                                                                  |
+| The unburied **wait on the shore** before the final crossing                                                                                                                                                                           | The `retention period`. An archived record waits out its window, is then permanently destroyed, and nothing remembers it afterwards                                                                                                                                                                                                                    |
+| Thetis dipped the infant Achilles into the Styx to make him **invulnerable**, holding him by the heel — the one spot the water never touched. _(Which sounds awefully familiar to the Germanic hero Siegfried of the Nibelungenlied.)_ | Styxable has a heel too. Immutability is enforced through ActiveRecord validations, so anything that bypasses validations bypasses the vault: `update_column`, `update_all`, `delete_all` and raw SQL will all happily change or destroy an archived record. The guard protects you from ordinary application code, not from deliberate circumvention. |
+
+> And the obvious reason: the name `archivable` was already taken in all its mutations, so I needed an alternative / prefix.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Maintainers and Contributors
+
+### Issues
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mediafinger/styxable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/mediafinger/styxable/blob/main/CODE_OF_CONDUCT.md).
+
+### Installation
+
+After checking out the repo, run `bin/setup` and then `bundle execute rake ci` to run the **tests and rubocop**.
+
+You can also run `bin/console` to open an irb session with the `Styxable` pre-loaded that will allow you to experiment.
+
+To build and install this gem onto your local machine, run `bundle exec rake install`.
+
+> **Maintainers only:**
+>
+> To release a new version, bump the version number in `version.rb`, commit this change, 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/gems/styxable).
+
+
+## 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 Styxable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mediafinger/styxable/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "bundler/audit/task"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+# setup task bundle:audit
+Bundler::Audit::Task.new
+
+RSpec::Core::RakeTask.new(:rspec)
+
+RuboCop::RakeTask.new
+
+desc "Open a console with Styxable loaded"
+task :console do
+  sh "bin/console"
+end
+
+desc "Run rubocop and the specs and check for known CVEs"
+task ci: %i(rubocop rspec bundle:audit)
+
+task default: :ci

data/lib/styxable/version.rb

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

data/lib/styxable.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "styxable/version"
+
+module Styxable
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/styxable.rbs

@@ -0,0 +1,4 @@
+module Styxable
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: styxable
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Andreas Finger
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: amazing_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.75'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.75'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: |
+  Styxable turns deletion into a three-stage lifecycle for ActiveRecord models: active,
+  archived, purged. Calling styx_archive soft-deletes a record — it (optionally) vanishes
+  from default scopes like being in a trash can or recycle bin, but the row survives, so foreign
+  keys, joins, reports and audits keep working. Archived records can still be listed,
+  counted and restored during a configurable grace or retention period, giving you an undo window or
+  restore window instead of an irreversible destroy.
+
+  While a record sits in the archive it is immutable: writes are rejected, so nothing can
+  be silently edited between archiving and erasure — like in a vault.
+  styx_unarchive brings a record back, unless it cannot, for example when
+  a newer record has claimed a unique attribute in the meantime. Archiving cascades along
+  dependent: associations, so closing an account, deactivating a user or tearing down a
+  tenant can archive everything it owns in a single call, with callbacks around each step.
+
+  Each model declares its own data retention period. A recurring background job then permanently
+  destroys records whose retention window has expired, expressing your retention schedule,
+  records disposition and automatic purge in code rather than in a runbook — useful for
+  GDPR storage limitation and right to erasure ("right to be forgotten") obligations, or
+  any policy with a TTL or expiry date. A before-purge callback lets you detach
+  ActiveStorage blobs, delete remote files or notify external systems before a record
+  crosses the Styx for good.
+email:
+- webmaster@mediafinger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/styxable.rb
+- lib/styxable/version.rb
+- sig/styxable.rbs
+homepage: https://github.com/mediafinger/styxable
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/mediafinger/styxable
+  source_code_uri: https://github.com/mediafinger/styxable
+  changelog_uri: https://github.com/mediafinger/styxable/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 4.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: Archivable ActiveRecords / immutable soft-delete, with (GDPR) data retention
+  and permanent purging.
+test_files: []