runeledge 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 39db9c950fd85840a07634582e5668dd71825d4dab25a40ecc2f8d54efa59a53
+  data.tar.gz: e8e8c29e8d905c0a5016086daac606e3cb83bfdd7339a4fbf848cb9615c9d1d2
+SHA512:
+  metadata.gz: 0ac12c77f82f0821c8ca0e8d3378e796eaec6a33eb432959d7a69984c47daff88eb0a52d83d200845a513f0b304fb40babcdeb55296c2d9b4e6c8d3855ffdfb6
+  data.tar.gz: 662ee7941ef53cbf001cb2d537adbe88408020158cc27985cb9a4c4f421298befbecb47258a82653cb728d56f626376c8bc7fde4f40c29646a7e2bad5b3d6545

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Marco Roth
+
+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,70 @@
+<div align="center">
+  <img alt="Runeledge" height="256px" src="assets/logo.png">
+</div>
+
+<h2 align="center">Runeledge</h2>
+
+<h4 align="center">A file-backed Active Record adapter for permanent content archives.</h4>
+
+<div align="center">Git-friendly data persistence with the power of Active Record.</div>
+
+
+## About
+
+Runeledge lets your Rails models persist to structured files instead of a traditional database, while keeping the full power of Active Record. It's designed for  **content archives** like [RubyEvents.org](https://rubyevents.org), where data lives in a version-controlled repository, segmented into human-editable files.
+
+If you only need read access to static files, consider [FrozenRecord](https://github.com/byroot/frozen_record). Runeledge builds on that idea by adding **full CRUD**, transactions, and optional segmentation so you can shard a single model’s records across multiple files (e.g., one `videos.yml` per event).
+
+
+## Features
+
+- **File-backed storage** for Active Record models  
+- **Multiple formats**: YAML (default), JSON, TOML (pluggable backends)  
+- **Segmentation**: shard a model into multiple files by a key or custom resolver  
+- **Git-friendly**: stable key ordering, atomic writes, minimal diffs  
+- **Transactions**: changes are staged and flushed on commit  
+- **Human-editable**: store data alongside code for easier review and collaboration
+
+## Installation
+
+Add Runeledge to your `Gemfile`:
+
+```bash
+bundle add runeledge
+````
+
+## Configuration
+
+In `config/database.yml`:
+
+```yml
+default: &default
+  adapter: runeledge
+  root: <%= Rails.root.join("data") %>
+  backend: yaml # yaml | json | toml
+  segmentation:
+    videos:
+      key: :event_slug
+      path: ":organization_slug/:event_slug/videos.%{ext}"
+
+development:
+  <<: *default
+
+test:
+  <<: *default
+
+production:
+  <<: *default
+```
+
+* **root** — base directory for storing model files
+* **backend** — serialization format (`yaml`, `json`, `toml`, or a custom backend)
+* **segmentation** — optional per-model rules for sharding data into multiple files
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/marcoroth/runeledge. 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/marcoroth/runeledge/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+This project is licensed under the [MIT License](LICENSE.txt).

data/Rakefile

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

data/lib/runeledge/version.rb

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

data/lib/runeledge.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "runeledge/version"
+
+module Runeledge
+end

data/runeledge.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/runeledge/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "runeledge"
+  spec.version = Runeledge::VERSION
+  spec.authors = ["Marco Roth"]
+  spec.email = ["marco.roth@intergga.ch"]
+
+  spec.summary = "A file-backed Active Record adapter for permanent content archives."
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/marcoroth/runeledge"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/releases"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files = Dir[
+    "runeledge.gemspec",
+    "LICENSE.txt",
+    "Rakefile",
+    "README.md",
+    "lib/**/*.rb",
+    "sig/**/*.rbs",
+    "exe/*"
+  ]
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/sig/runeledge.rbs

@@ -0,0 +1,3 @@
+module Runeledge
+  VERSION: String
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: runeledge
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marco Roth
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: A file-backed Active Record adapter for permanent content archives.
+email:
+- marco.roth@intergga.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/runeledge.rb
+- lib/runeledge/version.rb
+- runeledge.gemspec
+- sig/runeledge.rbs
+homepage: https://github.com/marcoroth/runeledge
+licenses: []
+metadata:
+  homepage_uri: https://github.com/marcoroth/runeledge
+  source_code_uri: https://github.com/marcoroth/runeledge
+  changelog_uri: https://github.com/marcoroth/runeledge/releases
+  rubygems_mfa_required: 'true'
+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.7
+specification_version: 4
+summary: A file-backed Active Record adapter for permanent content archives.
+test_files: []