model_form_facade 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df7bfe8f520d385db578e47e05b9a08397eaed01ac108828b9d92a59b8aeca29
+  data.tar.gz: 12975038ffe2a8dc51253383fa75a9e11e31c0e5c9911bf30ef605549ee8ea31
+SHA512:
+  metadata.gz: ca388061f33ff239feb1cb9579181ecc469459db8ab364c4842fc8c6025bdb0140208cf97c7a82716e305a4ce098493d5696cb48af438fa9782d37cc9858f538
+  data.tar.gz: 7121b04f4921390f4ca4285abff657cf4885f84a679af0bc3672d9dc37e7637d8f5040d7e5413075c46c18a88acc40a4565d4b6d18d7c306f36ada6d76574ef0

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.3

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-08-27
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Joshua Paine
+
+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,39 @@
+# ModelFormFacade
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/model_form_facade`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/model_form_facade.
+
+## 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,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/model_form_facade/version.rb

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

data/lib/model_form_facade.rb

@@ -0,0 +1,164 @@
+require_relative "model_form_facade/version"
+require "activesupport"
+
+module ModelFormFacade
+  class Error < StandardError; end
+  
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :fields, instance_accessor: false, instance_predicate: false, default: {}
+    class_attribute :params_root, default: true # infer from model
+    attr_reader :object
+    private attr_writer :object
+    private attr_accessor :component_props
+  end
+
+  def initialize(model_object = nil, root: nil, **component_props)
+    self.params_root = root unless root.nil?
+    self.object = model_object
+    self.component_props = component_props
+  end
+
+  def options = {} # Override me
+
+  def as_json(root: params_root)
+    hash = self.class.fields.values.filter_map do |field|
+      next nil unless field.read
+
+      raw = send(field.name)
+      value = case field.type
+      in :scalar then raw
+      in :object then field.form.new(raw).as_json(root: false)
+      in :array then (raw || []).map { field.form.new(_1).as_json(root: false) }
+      end
+      [field.name, field.serialize(value)]
+    end.to_h.compact
+    return hash unless (root = _params_root(root:))
+    {root => hash}
+  end
+
+  def errors(root: params_root)
+    errs = object_error_messages.reject { |k, v| k.to_s.include? "." } # Remove nested, we'll recurse
+    hash = self.class.fields.values.filter_map do |field|
+      err = case field.type
+      in :scalar then errs[field.attribute]&.map(&:capitalize)&.join(";").presence
+      in :object then field.form.new(send(field.name)).errors(root: false)
+      in :array then (send(field.name) || []).map { field.form.new(_1).errors(root: false) }
+      end
+      [field.name, err] if err
+    end.to_h.compact
+    return hash unless (root = _params_root(root:))
+    {root => hash}
+  end
+
+  def form_props(root: params_root)
+    {
+      **component_props,
+      data: as_json(root:),
+      options: options,
+      errors: errors(root:)
+    }
+  end
+
+  def set_fields(params, root: nil)
+    params = params.expect(expectation(root:)) if params.respond_to?(:expect) && !params.permitted?
+    self.attributes = params
+  end
+  alias_method :fields=, :set_fields
+
+  def attributes=(hash)
+    hash.each do |key, value|
+      send("#{key}=", value)
+    end
+  end
+
+  def attributes = as_json
+
+  def expectation(root: nil)
+    self.class.expectation(root: _params_root(root:))
+  end
+
+  def save! = object.save!
+
+  def save = object.save
+
+  private def _params_root(root: nil)
+    case root.nil? ? params_root : root
+    in true then object.class.name&.split("::")&.last&.downcase&.to_sym
+    in false then nil
+    in Symbol => sym then sym
+    in String => str then str.to_sym
+    end
+  end
+
+  private def object_error_messages = object&.errors&.messages || {}
+
+  Field = Data.define(:name, :read, :write, :attribute, :type, :form) do
+    def serialize(v)
+      return v unless type == :scalar
+      v&.to_s
+    end
+  end
+
+  module FieldMethods; end
+
+  class_methods do
+    def field(name, read: nil, write: nil, attribute: nil)
+      _field(name, read:, write:, attribute:, type: :scalar)
+    end
+
+    def one(*, **, &block) = _relation(*, **, type: :object, &block)
+
+    def nested(*, **, &block) = _relation(*, **, type: :array, &block)
+
+    def expectation(root:)
+      expected = fields.values.select(&:write).map do |field|
+        case field.type
+        in :scalar then field.name
+        in :object then {field.name => field.form.expectation(root: false)}
+        in :array then {field.name => [field.form.expectation(root: false)]}
+        end
+      end
+      return expected unless root &&= root.to_sym
+      {root => expected}
+    end
+
+    private
+
+    def _relation(name, allow_destroy: false, form: nil, read: nil, write: nil, attribute: nil, type: nil, &block)
+      form ||= create_form_class_for(name)
+      form.field :_destroy, read: false if allow_destroy
+      form.instance_exec(&block) if block
+      if write.nil? && attribute.nil? && !name.to_s.ends_with?("_attributes")
+        write = :"#{name}_attributes="
+      end
+      _field(name, read:, write:, attribute:, type:, form:)
+    end
+
+    def _field(name, read: nil, write: nil, attribute: nil, type: :scalar, form: nil)
+      name = name.to_sym
+      attribute = (attribute || name).to_sym
+      read = attribute if read.nil?
+      write = :"#{attribute}=" if write.nil?
+      field = Field.new(name:, read:, write:, attribute:, type:, form:)
+      self.fields = {**fields, name.to_sym => field}
+      field_methods_module.define_method(name) { object&.send(read) } unless read == false
+      field_methods_module.define_method(:"#{name}=") { |value| object.send(write, value) } unless write == false
+    end
+
+    def create_form_class_for(field_name)
+      class_name = "anonymous_#{field_name}_form".camelize
+      const_set(class_name, Class.new.tap { _1.include ModelForm })
+    end
+
+    def field_methods_module
+      return @field_methods_module if @field_methods_module
+      @field_methods_module = Module.new
+      module_name = name.presence && name.gsub(/\W+/, "__") + "Fields"
+      FieldMethods.const_set(module_name, @field_methods_module) if module_name
+      include @field_methods_module
+      @field_methods_module
+    end
+  end
+end

data/sig/model_form_facade.rbs

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

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: model_form_facade
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joshua Paine
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+email:
+- joshua@letterblock.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/model_form_facade.rb
+- lib/model_form_facade/version.rb
+- sig/model_form_facade.rbs
+homepage: https://github.com/midnightmonster/model_form_facade
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/midnightmonster/model_form_facade
+  source_code_uri: https://github.com/midnightmonster/model_form_facade
+  changelog_uri: https://github.com/midnightmonster/model_form_facade/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.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: Form objects as read/write facades for your models, with a convenient DSL
+test_files: []