config_for-data_model 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 075ddb158bd8daf76d3cc92265090e9a2e712a6fd01e6efda3fceb0c18685c3c
+  data.tar.gz: d2338abaf2cbdc7820c67ead8ed3aa99b79afdcde31c1e494f4e827cd805514e
+SHA512:
+  metadata.gz: 8365c7b0027e74ecaf29a981dc2385bcc1632ff7b34d5e7ccc11cad51a20cf41a0a5f0060e5f43f69d3bf1a54f9dcd910d7f69d02a9cb2cf5a276e6cdf7144f1
+  data.tar.gz: c2bfc008112025f33c35a4f91866994e5c1fef4b5e7f30afac9f0ba1e6971eacc6b2b7f6806581014e6364802e8870dbde735d6c422a0ff1ed18282495bd8136

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,481 @@
+# ConfigFor::DataModel
+
+A minimal, `ActiveRecord::QueryMethods`-like interface for data models backed by Rails configuration files.
+
+## Motivation
+
+Not all of your application's data must reside in the database.  For example, States & Countries don't change very often and don't need to be editable by users.
+
+Rails provides a mechanism for loading such data from YAML files in your application's config directory:
+
+```ruby
+Rails.application.config_for(:filename)
+```
+
+This is useful on it's own, but I've found myself abstracting ontop of this Rails feature often enough that I decided to extract it for reuse.
+
+## Usage
+
+Let's say we have a YAML file with Country & State Data like the following.
+
+<details>
+  <summary>e.g. /config/countries.yml</summary>
+
+  ```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: NT
+          name: Northern Territory
+          country_id: AU
+        -
+          id: QLD
+          name: Queensland
+          country_id: AU
+        -
+          id: SA
+          name: South Australia
+          country_id: AU
+        -
+          id: TAS
+          name: Tasmania
+          country_id: AU
+        -
+          id: VIC
+          name: Victoria
+          country_id: AU
+        -
+          id: WA
+          name: Western Australia
+          country_id: AU
+    -
+      id: CA
+      name: Canada
+      states:
+        -
+          id: AB
+          name: Alberta
+          country_id: CA
+        -
+          id: BC
+          name: British Columbia
+          country_id: CA
+        -
+          id: MB
+          name: Manitoba
+          country_id: CA
+        -
+          id: NB
+          name: New Brunswick
+          country_id: CA
+        -
+          id: NL
+          name: Newfoundland
+          country_id: CA
+        -
+          id: NS
+          name: Nova Scotia
+          country_id: CA
+        -
+          id: NT
+          name: Northwest Territories
+          country_id: CA
+        -
+          id: NU
+          name: Nunavut
+          country_id: CA
+        -
+          id: 'ON' # in YAML, unquoted 'ON' is treated as boolean true
+          name: Ontario
+          country_id: CA
+        -
+          id: PE
+          name: Prince Edward Island
+          country_id: CA
+        -
+          id: QC
+          name: Quebec
+          country_id: CA
+        -
+          id: SK
+          name: Saskatchewan
+          country_id: CA
+        -
+          id: YT
+          name: Yukon
+          country_id: CA
+    -
+      id: US
+      name: United States
+      states:
+        -
+          id: AL
+          name: Alabama
+          country_id: US
+        -
+          id: AK
+          name: Alaska
+          country_id: US
+        -
+          id: AZ
+          name: Arizona
+          country_id: US
+        -
+          id: AR
+          name: Arkansas
+          country_id: US
+        -
+          id: CA
+          name: California
+          country_id: US
+        -
+          id: CO
+          name: Colorado
+          country_id: US
+        -
+          id: CT
+          name: Connecticut
+          country_id: US
+        -
+          id: DE
+          name: Delaware
+          country_id: US
+        -
+          id: DC
+          name: District of Columbia
+          country_id: US
+        -
+          id: FL
+          name: Florida
+          country_id: US
+        -
+          id: GA
+          name: Georgia
+          country_id: US
+        -
+          id: HI
+          name: Hawaii
+          country_id: US
+        -
+          id: ID
+          name: Idaho
+          country_id: US
+        -
+          id: IL
+          name: Illinois
+          country_id: US
+        -
+          id: IN
+          name: Indiana
+          country_id: US
+        -
+          id: IA
+          name: Iowa
+          country_id: US
+        -
+          id: KS
+          name: Kansas
+          country_id: US
+        -
+          id: KY
+          name: Kentucky
+          country_id: US
+        -
+          id: LA
+          name: Louisiana
+          country_id: US
+        -
+          id: ME
+          name: Maine
+          country_id: US
+        -
+          id: MD
+          name: Maryland
+          country_id: US
+        -
+          id: MA
+          name: Massachusetts
+          country_id: US
+        -
+          id: MI
+          name: Michigan
+          country_id: US
+        -
+          id: MN
+          name: Minnesota
+          country_id: US
+        -
+          id: MS
+          name: Mississippi
+          country_id: US
+        -
+          id: MO
+          name: Missouri
+          country_id: US
+        -
+          id: MT
+          name: Montana
+          country_id: US
+        -
+          id: NE
+          name: Nebraska
+          country_id: US
+        -
+          id: NV
+          name: Nevada
+          country_id: US
+        -
+          id: NH
+          name: New Hampshire
+          country_id: US
+        -
+          id: NJ
+          name: New Jersey
+          country_id: US
+        -
+          id: NM
+          name: New Mexico
+          country_id: US
+        -
+          id: NY
+          name: New York
+          country_id: US
+        -
+          id: NC
+          name: North Carolina
+          country_id: US
+        -
+          id: ND
+          name: North Dakota
+          country_id: US
+        -
+          id: OH
+          name: Ohio
+          country_id: US
+        -
+          id: OK
+          name: Oklahoma
+          country_id: US
+        -
+          id: OR
+          name: Oregon
+          country_id: US
+        -
+          id: PA
+          name: Pennsylvania
+          country_id: US
+        -
+          id: PR
+          name: Puerto Rico
+          country_id: US
+        -
+          id: RI
+          name: Rhode Island
+          country_id: US
+        -
+          id: SC
+          name: South Carolina
+          country_id: US
+        -
+          id: SD
+          name: South Dakota
+          country_id: US
+        -
+          id: TN
+          name: Tennessee
+          country_id: US
+        -
+          id: TX
+          name: Texas
+          country_id: US
+        -
+          id: UT
+          name: Utah
+          country_id: US
+        -
+          id: VT
+          name: Vermont
+          country_id: US
+        -
+          id: VA
+          name: Virginia
+          country_id: US
+        -
+          id: WA
+          name: Washington
+          country_id: US
+        -
+          id: WV
+          name: West Virginia
+          country_id: US
+        -
+          id: WI
+          name: Wisconsin
+          country_id: US
+        -
+          id: WY
+          name: Wyoming
+          country_id: US
+  ```
+
+</details>
+
+We could then make use of this in our app with a simple data model like this:
+
+e.g. app/models/data/country.rb
+
+```ruby
+Data::Country = Data.define(:id, :name, :states) do
+  include ConfigFor::DataModel
+  config :countries
+end
+```
+
+We could then access our data like:
+
+```ruby
+Data::Country.find('AU')
+# =>
+# #<data Data::Country
+#  id="AU",
+#  name="Australia",
+#  states=
+#   [{id: "ACT", name: "Australian Capital Territory", country_id: "AU"},
+#    {id: "NSW", name: "New South Wales", country_id: "AU"}, ...
+```
+
+Or
+
+```ruby
+Data::Country.find_by(name: 'United States')
+# =>
+# #<data Data::Country
+#  id="US",
+#  name="United States",
+#  states=
+#   [{id: "AL", name: "Alabama", country_id: "US"},
+#    {id: "AK", name: "Alaska", country_id: "US"}, ...
+```
+
+If we want more from the attribute members of our DataModel, we can define `cast_#{member}` methods.
+
+e.g.
+
+```ruby
+Data::State = Data.define(:id, :name, :country_id)
+Data::Country = Data.define(:id, :name, :states) do
+  include ConfigFor::DataModel
+  config :countries
+
+  private
+
+  def cast_states(data = nil)
+    Array(data).map { Data::State[**it] }
+  end
+end
+```
+
+Now, our data looks like this:
+
+```ruby
+Data::Country.find('AU')
+# =>
+# #<data Data::Country
+#  id="AU",
+#  name="Australia",
+#  states=
+#   [#<data Data::State id="ACT", name="Australian Capital Territory", country_id="AU">,
+#    #<data Data::State id="NSW", name="New South Wales", country_id="AU">, ...
+```
+
+### But what if we want to query State data directly?
+
+Do we need to duplicate and restructure our data into a new YAML file? Actually, No!
+
+In addition to a filename, the `config` class method also accepts a transform proc
+
+e.g.
+
+```ruby
+Data::State = Data.define(:id, :name, :country_id) do
+  include ConfigFor::DataModel
+  config :countries, -> { it.pluck(:states).flatten }
+end
+```
+
+Now we can query States directly.
+
+e.g.
+
+```ruby
+Data::State.where(country_id: 'AU')
+# =>
+# [#<data Data::State id="ACT", name="Australian Capital Territory", country_id="AU">,
+#  #<data Data::State id="NSW", name="New South Wales", country_id="AU">,
+#  #<data Data::State id="NT", name="Northern Territory", country_id="AU">,
+#  #<data Data::State id="QLD", name="Queensland", country_id="AU">,
+#  #<data Data::State id="SA", name="South Australia", country_id="AU">,
+#  #<data Data::State id="TAS", name="Tasmania", country_id="AU">,
+#  #<data Data::State id="VIC", name="Victoria", country_id="AU">,
+#  #<data Data::State id="WA", name="Western Australia", country_id="AU">]
+
+Data::Country.find('US').states == Data::State.where(country_id: 'US')
+# => true
+
+Data::State.find_by(name: 'Missouri', country_id: 'US')
+# => #<data Data::State id="MO", name="Missouri", country_id="US">
+
+_.in? Data::Country.find('US').states
+# => true
+```
+
+### Primary Keys
+
+> [!IMPORTANT]
+> If your data model does not have an `id` member, you need to provide an alternative `primary_key`
+
+e.g.
+
+```ruby
+Data::Book = Data.define(:name, :author, :isbn) do
+  include ConfigFor::DataModel
+  config :books
+
+  self.primary_key = :isbn
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "config_for-data_model"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install config_for-data_model
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/config_for/data_model/railtie.rb

@@ -0,0 +1,6 @@
+module ConfigFor
+  module DataModel
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/lib/config_for/data_model/version.rb

@@ -0,0 +1,5 @@
+module ConfigFor
+  module DataModel
+    VERSION = "0.1.0"
+  end
+end

data/lib/config_for/data_model.rb

@@ -0,0 +1,49 @@
+require "config_for/data_model/version"
+require "config_for/data_model/railtie"
+
+module ConfigFor
+  module DataModel
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :source_data, instance_writer: false
+      class_attribute :primary_key, instance_writer: false, default: :id
+
+      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
+
+    def blank? = send(primary_key).blank?
+
+    class_methods do
+      def config(filename, transform = -> { it })
+        self.source_data = transform[Rails.application.config_for(filename)].freeze
+      end
+
+      def all
+        @all ||= source_data.map { new(**it) }
+      end
+
+      def find(value)
+        find_by(primary_key => value)
+      end
+
+      def find_by(data)
+        all.find(&method(:match_all?).curry[data])
+      end
+
+      def where(data)
+        all.select(&method(:match_all?).curry[data])
+      end
+
+      def match_all?(constraints, resource)
+        constraints.all? { |key, value| resource.public_send(key) == value }
+      end
+    end
+  end
+end

data/lib/tasks/config_for/data_model_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :config_for_data_model do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: config_for-data_model
+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: rails
+  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: A minimal, ActiveRecord::QueryMethods-like interface for data models
+  backed by Rails configuration files.
+email:
+- outlawandy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/config_for/data_model.rb
+- lib/config_for/data_model/railtie.rb
+- lib/config_for/data_model/version.rb
+- lib/tasks/config_for/data_model_tasks.rake
+homepage: https://github.com/OutlawAndy/config_for-data_model
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/OutlawAndy/config_for-data_model
+  source_code_uri: https://github.com/OutlawAndy/config_for-data_model
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A small wrapper around Rails.application.config_for
+test_files: []