data_for 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 70b639bf977cd804d0b23908514220947ca35736f8042019f9bd02fb4e11e911
+  data.tar.gz: 4f48be5128f8d9204217cba84cda4e4d1fd0b32ad4900421c27f339b80e51d0a
+SHA512:
+  metadata.gz: b6edc2f15523421111119c2301e83b39d9776e366ed9aeca4fff5b91b3fbe9574028cfe006c97ceb914b9cf0a9bbe9c9e9c0119c9b088663e9cc563e303c768b
+  data.tar.gz: '0593d66e096c6681695f1aad9ed8ad79e8fe9958eefd6ba74613cc3cbd89094f062bdf2ebc679510ad5dd9ef0182bed1f8e4385aba8552e517670ff5f85dbe47'

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+## Changelog
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+Initial pre-release. The gem has not yet been published to RubyGems.
+
+### Added
+
+- `DataFor::Model` concern for read-only `Data.define` models backed by Rails config files.
+- `find`, `find!`, `find_by`, `find_by!`, and `where` query methods.
+- O(1) primary-key lookup for `find` and `find!` via a lazily-built index.
+- `DataFor::RecordNotFound` raised by bang variants.
+- `self.primary_key=` for non-`:id` primary keys.
+- `cast_<member>` hooks for typed attribute casting (including nested Data models).
+- `project:` keyword on `config` for reshaping the source data before it becomes the model's record set, letting a single YAML file drive multiple query surfaces.
+- `loader:` keyword on `config` for loading source data outside of Rails.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Andy Cohen
+
+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,273 @@
+# DataFor
+
+> Queryable, read-only Ruby `Data` models backed by Rails config files.
+
+[![Gem Version](https://badge.fury.io/rb/data_for.svg)](https://rubygems.org/gems/data_for)
+[![Ruby](https://img.shields.io/badge/ruby-%3E%3D%203.4-ruby.svg)](https://www.ruby-lang.org/)
+
+```ruby
+Country = Data.define(:id, :name) do
+  include DataFor::Model
+  config :countries
+end
+
+Country.find("US")              #=> #<data Country id="US", name="United States">
+Country.find!("ZZ")             # raises DataFor::RecordNotFound
+Country.find_by(name: "Canada") #=> #<data Country id="CA", name="Canada">
+Country.where(name: "Canada")   #=> [#<data Country id="CA", name="Canada">]
+```
+
+`DataFor` turns YAML in your Rails config directory into queryable, read-only
+models — countries, currencies, plans, and other reference data that rarely
+changes and doesn't belong in your database. It's built on Ruby's native
+[`Data.define`](https://docs.ruby-lang.org/en/3.4/Data.html) and Rails'
+[`config_for`](https://guides.rubyonrails.org/configuring.html#config-for-loading-external-configuration), so the records are immutable value objects and the
+storage is a YAML file you already know how to edit.
+
+## Why?
+
+Not all of an application's data must live in the database. Reference data —
+countries, currencies, subscription tiers, feature flags, lookup tables — has
+a few properties that distinguish it from "real" data:
+
+- It rarely changes (changes are deployments, not user actions).
+- It is not user-editable.
+- It needs to be versioned alongside the code that depends on it.
+- It is small enough to live in memory.
+
+### Database vs. `DataFor`
+
+|                                 | Database | `DataFor`            |
+|---------------------------------|----------|----------------------|
+| Writeable at runtime            | yes      | no                   |
+| Schema migrations required      | yes      | no                   |
+| Versioned with application code | no       | yes                  |
+| Joins                           | yes      | no                   |
+| Editable without a redeploy     | yes      | no                   |
+| Cost per query                  | network  | in-memory hash/array |
+
+If your data is on the right-hand side of that table, `DataFor` is probably a
+better fit than a table.
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem "data_for"
+```
+
+Then:
+
+```bash
+bundle install
+```
+
+`DataFor` requires Ruby `>= 3.4` (for the implicit `it` block parameter) and
+Rails `>= 6.1` (for `config_for`).
+
+## Usage
+
+### 1. Put your data in `config/`
+
+Rails' `config_for` reads `config/<name>.yml` files. The top-level key
+`shared` provides defaults across environments; per-environment keys
+(`development`, `production`, etc.) override them.
+
+Example `config/countries.yml`:
+
+```yaml
+shared:
+  - id: AU
+    name: Australia
+    states:
+      - { id: ACT, name: "Australian Capital Territory", country_id: AU }
+      - { id: NSW, name: "New South Wales",              country_id: AU }
+      # ...
+  - id: CA
+    name: Canada
+    states:
+      - { id: AB, name: Alberta, country_id: CA }
+      # ...
+  - id: US
+    name: "United States"
+    states:
+      - { id: AL, name: Alabama, country_id: US }
+      # ...
+```
+
+### 2. Define a model
+
+Use Ruby's `Data.define` to declare the value object's members, then
+`include DataFor::Model` to make it queryable:
+
+```ruby
+Country = Data.define(:id, :name, :states) do
+  include DataFor::Model
+  config :countries
+end
+```
+
+### 3. Query
+
+```ruby
+Country.find("AU")
+# => #<data Country id="AU", name="Australia", states=[...]>
+
+Country.find!("ZZ")
+# raises DataFor::RecordNotFound
+
+Country.find_by(name: "United States")
+# => #<data Country id="US", name="United States", states=[...]>
+
+Country.find_by!(name: "Atlantis")
+# raises DataFor::RecordNotFound
+
+Country.where(name: "Canada")
+# => [#<data Country id="CA", ...>]
+
+Country.all
+# => [#<data Country id="AU", ...>, #<data Country id="CA", ...>, ...]
+```
+
+`find` uses a primary-key index and is O(1). `find_by` and `where` scan
+linearly across the record set — fine for the size of data that belongs in
+`DataFor` in the first place.
+
+### Custom primary keys
+
+The default primary key is `:id`. Override it with `self.primary_key=` when
+your data uses a different identifier:
+
+```ruby
+Book = Data.define(:isbn, :title, :author) do
+  include DataFor::Model
+  config :books
+  self.primary_key = :isbn
+end
+
+Book.find("978-0-13-468599-1")
+```
+
+### Casting attributes with `cast_<member>`
+
+For every member of your `Data` class, `DataFor::Model` generates a private
+`cast_<member>` method that runs at construction time. The default
+implementation is the identity function. Override the cast method to coerce,
+parse, or nest:
+
+```ruby
+Country = Data.define(:id, :name, :states) do
+  include DataFor::Model
+  config :countries
+
+  private
+
+  def cast_states(data)
+    Array(data).map { State[**it] }
+  end
+end
+```
+
+Now every `Country#states` returns an array of `State` value objects rather
+than raw hashes:
+
+```ruby
+Country.find("US").states.first
+# => #<data State id="AL", name="Alabama", country_id="US">
+```
+
+### Reprojecting one config to drive multiple models
+
+`config` accepts a `project:` proc that transforms the loaded data before it
+becomes the model's record set. This lets a single YAML file power multiple
+query surfaces:
+
+```ruby
+State = Data.define(:id, :name, :country_id) do
+  include DataFor::Model
+  config :countries, project: -> { it.pluck(:states).flatten }
+end
+
+State.where(country_id: "US")
+# => [#<data State id="AL", ...>, #<data State id="AK", ...>, ...]
+
+Country.find("US").states == State.where(country_id: "US")
+# => true
+```
+
+### Loading data outside of Rails
+
+By default, `config` reads data via `Rails.application.config_for(filename)`.
+Pass a `loader:` proc to load data from somewhere else:
+
+```ruby
+Plan = Data.define(:id, :name, :price_cents) do
+  include DataFor::Model
+  config :plans, loader: ->(name) { YAML.load_file("data/#{name}.yml") }
+end
+```
+
+## Caching & reloading
+
+`config` reads the file once, applies the `project:` proc, freezes the
+result, and caches it in a class instance variable. Subsequent queries hit
+in-memory data structures — no file I/O, no parsing.
+
+- **In `production`** (with `config.cache_classes = true`), models load at
+  boot and stay until the process restarts.
+- **In `development`**, Rails reloads model classes on every request, which
+  re-evaluates the `Data.define` block and re-runs `config`. Edits to your
+  YAML files take effect on the next request — no server restart.
+- **In `test`**, behavior matches `production` by default.
+
+If you call `config` a second time on the same class (rare), the internal
+`@all` and `@index` memos are cleared so the new data takes over cleanly.
+
+## Alternatives
+
+`DataFor` is not the first gem in this space. The closest neighbors:
+
+### [`data_for`](https://github.com/OutlawAndy/data_for) *(this gem)*
+
+- **Storage:** Rails `config_for` (YAML)
+- **Record type:** Ruby `Data.define` (immutable value object)
+- **Distinct features:** idiomatic Rails configuration, immutable records, and
+  the `project:` proc reshapes one config file into multiple query surfaces.
+
+### [`frozen_record`](https://github.com/byroot/frozen_record)
+
+- **Storage:** YAML / JSON / custom backends
+- **Record type:** ActiveRecord-style class
+- **Distinct features:** the most mature gem in this space, broadest query API,
+  pluggable backends. Records are AR-style classes, not Ruby `Data`.
+
+### [`active_hash`](https://github.com/active-hash/active_hash)
+
+- **Storage:** in-memory hashes (`active_hash`), YAML (`active_yaml`), JSON, ENUM
+- **Record type:** ActiveRecord-style class
+- **Distinct features:** AR-compatible API, supports associations to AR models.
+  Long-established.
+
+### [`yaml_record`](https://github.com/joshbuddy/yaml_record)
+
+- **Storage:** YAML
+- **Record type:** custom class
+- **Status:** older, less active.
+
+If you need AR-style associations across both real DB tables and your
+reference data, `active_hash` is the best fit. If you want the broadest
+query API and don't care about value-object semantics, `frozen_record` is
+the most mature option. `DataFor` is the smallest gem of the bunch and the
+only one built on native Ruby `Data` objects with Rails-idiomatic
+configuration.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+<https://github.com/OutlawAndy/data_for>.
+
+## License
+
+`DataFor` is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/lib/data_for/version.rb

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

data/lib/data_for.rb

@@ -0,0 +1,75 @@
+require "active_support/concern"
+require "active_support/core_ext/enumerable"
+require "data_for/version"
+
+module DataFor
+  class RecordNotFound < StandardError; end
+
+  module Model
+    extend ActiveSupport::Concern
+
+    DEFAULT_LOADER = ->(filename) { Rails.application.config_for(filename) }
+
+    included do
+      class << self
+        attr_accessor :source_data
+        attr_writer :primary_key
+
+        def primary_key
+          @primary_key ||= :id
+        end
+      end
+
+      members.each do |member|
+        private(define_method(:"cast_#{member}") { it })
+      end
+    end
+
+    def initialize(**kwargs)
+      super(**members.index_with { send(:"cast_#{it}", kwargs[it]) })
+    end
+
+    class_methods do
+      def config(filename, project: -> { it }, loader: DEFAULT_LOADER)
+        self.source_data = project[loader[filename]].freeze
+        @all = nil
+        @index = nil
+        source_data
+      end
+
+      def all
+        @all ||= source_data.map { new(**it) }
+      end
+
+      def find(value)
+        index[value]
+      end
+
+      def find!(value)
+        find(value) or raise RecordNotFound,
+          "Couldn't find #{name} with #{primary_key}=#{value.inspect}"
+      end
+
+      def find_by(data)
+        all.find { match_all?(data, it) }
+      end
+
+      def find_by!(data)
+        find_by(data) or raise RecordNotFound,
+          "Couldn't find #{name} matching #{data.inspect}"
+      end
+
+      def where(data)
+        all.select { match_all?(data, it) }
+      end
+
+      def index
+        @index ||= all.index_by { it.public_send(primary_key) }
+      end
+
+      def match_all?(constraints, resource)
+        constraints.all? { |key, value| resource.public_send(key) == value }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: data_for
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andy Cohen
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+description: DataFor turns YAML in your Rails config directory into queryable, read-only
+  models -- countries, currencies, plans, and other reference data that rarely changes
+  and doesn't belong in your database. Built on Ruby's Data.define and Rails' config_for,
+  with a familiar find, find_by, and where API, plus a transform proc that lets one
+  config file power multiple query surfaces.
+email:
+- outlawandy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- lib/data_for.rb
+- lib/data_for/version.rb
+homepage: https://github.com/OutlawAndy/data_for
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/OutlawAndy/data_for
+  source_code_uri: https://github.com/OutlawAndy/data_for
+  changelog_uri: https://github.com/OutlawAndy/data_for/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: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Queryable, read-only Ruby Data models backed by Rails config files.
+test_files: []