protos-protoform 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c57b1b4645f529c7f8b132e92b0776a839448cd20eb3c689fbcf3689f2f7cfda
+  data.tar.gz: da70f9680fed7bb2815deaa61ffb049ab9edfac706bb9e8b9e60f2ac8e5904a4
+SHA512:
+  metadata.gz: 7dbee5d770d7efed179c43eb39892f8bf4fc8d7935b65160ab84876688a64bb3612a2226ffb421094c32412e895af9fbfcebe44872b54680b2cd7951f9d82c4d
+  data.tar.gz: 8bd336c38077d8c15855329c01c63a9897320b62117e06a4f747b7f2f3e9c9849b4bf37a0bd4bce8d854e9994fd6c0fa19ba0551e2275ee8511ac57d4dab1bfa

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,9 @@
+require:
+  - rubocop-inhouse
+
+inherit_gem:
+  rubocop-inhouse:
+    - config/default.yml
+
+AllCops:
+  TargetRubyVersion: 3.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-06-23
+
+- Initial release

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in protoform.gemspec
+gemspec
+
+gem "activemodel"
+gem "debug"
+gem "phlex-testing-capybara"
+gem "rake"
+gem "rspec"
+gem "rubocop-inhouse"

data/Gemfile.lock

@@ -0,0 +1,245 @@
+PATH
+  remote: .
+  specs:
+    protos-protoform (0.0.1)
+      phlex-rails (~> 1.0)
+      protos (~> 0.2)
+      zeitwerk (~> 2.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.1.3.2)
+      actionview (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actionview (7.1.3.2)
+      activesupport (= 7.1.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activemodel (7.1.3.2)
+      activesupport (= 7.1.3.2)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.7)
+    builder (3.2.4)
+    capybara (3.40.0)
+      addressable
+      matrix
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.11)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (>= 1.5, < 3.0)
+      xpath (~> 3.2)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    debug (1.9.2)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    dry-core (1.0.1)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.0.0)
+    dry-initializer (3.1.1)
+    dry-logic (1.5.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.2)
+      bigdecimal (~> 3.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
+    erubi (1.12.0)
+    i18n (1.14.4)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
+    irb (1.12.0)
+      rdoc
+      reline (>= 0.4.2)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    lru_redux (1.1.0)
+    matrix (0.4.2)
+    mini_mime (1.1.5)
+    minitest (5.22.3)
+    mutex_m (0.2.0)
+    nokogiri (1.16.4-aarch64-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.4-arm-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.4-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.4-x86-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.4-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.4-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    phlex (1.10.0)
+    phlex-rails (1.2.1)
+      phlex (~> 1.10.0)
+      railties (>= 6.1, < 8)
+    phlex-testing-capybara (0.1.0)
+      capybara (~> 3.38)
+      phlex (>= 0.5)
+    protos (0.4.1)
+      dry-core (~> 1.0)
+      dry-initializer (~> 3.1)
+      dry-types (~> 1.7)
+      phlex (~> 1.10)
+      tailwind_merge (~> 0.10)
+    psych (5.1.2)
+      stringio
+    public_suffix (5.0.5)
+    racc (1.7.3)
+    rack (3.0.10)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rdoc (6.6.3.1)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.0)
+    reline (0.5.1)
+      io-console (~> 0.5)
+    rexml (3.2.6)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.63.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-inhouse (0.1.5)
+      rubocop (>= 1.5)
+      rubocop-capybara (>= 2.1)
+      rubocop-performance (>= 1.1)
+      rubocop-rails (>= 2.2)
+      rubocop-rake (>= 0.6)
+      rubocop-rspec (>= 2.2)
+    rubocop-performance (1.21.0)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails (2.24.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.29.1)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.28.3)
+      rubocop (~> 1.40)
+    ruby-progressbar (1.13.0)
+    stringio (3.1.0)
+    tailwind_merge (0.11.0)
+      lru_redux (~> 1.1)
+    thor (1.3.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+    zeitwerk (2.6.13)
+
+PLATFORMS
+  aarch64-linux
+  arm-linux
+  arm64-darwin
+  x86-linux
+  x86_64-darwin
+  x86_64-linux
+
+DEPENDENCIES
+  activemodel
+  debug
+  phlex-testing-capybara
+  protos-protoform!
+  rake
+  rspec
+  rubocop-inhouse
+
+BUNDLED WITH
+   2.5.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Brad Gessler
+
+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,61 @@
+# Protoform
+
+An experimental fork of [Superform](https://github.com/rubymonolith/superform).
+Uses [protos](https://github.com/inhouse-work/protos) as base components.
+
+This is a more opinionated version of Superform. My goal is to maintain feature
+parity with and contribute features back to Superform.
+
+## Usage
+
+```
+gem "protos-protoform", require: "protoform"
+```
+
+Once the gem is installed you can run the generators:
+
+```
+bin/rails g protoform:install
+```
+
+This will:
+
+- Add `phlex-rails` to your gemfile if it does not exist
+- Add `layouts`, `components` and other folders to be autoloaded from `app/views`
+- Add an `ApplicationForm` as the base form class to your `app/views`
+
+This gem follows the same conventions as Superform with some key differences:
+
+- Components are expected to inherit from `Protos::Component` so your
+  `ApplicationComponent` should inherit from that
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/rubymonolith/superform. 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/rubymonolith/superform/blob/main/CODE_OF_CONDUCT.md).
+
+## 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 Superform project's codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/rubymonolith/superform/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/generators/protoform/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Installs Phlex Rails and Protoform
+
+Example:
+    bin/rails generate protoform:install
+
+    This will create:
+        app/views/forms/application_form.rb

data/lib/generators/protoform/install/install_generator.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "bundler"
+
+module Protoform
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    APPLICATION_CONFIGURATION_PATH = Rails.root.join("config/application.rb")
+
+    def install_phlex_rails
+      return if gem_in_bundle? "phlex-rails"
+
+      gem "phlex-rails"
+      generate "phlex:install"
+    end
+
+    def autoload_components
+      return unless APPLICATION_CONFIGURATION_PATH.exist?
+
+      inject_into_class(
+        APPLICATION_CONFIGURATION_PATH,
+        "Application",
+        %(    config.autoload_paths << "\#{root}/app/views/forms"\n)
+      )
+    end
+
+    def create_application_form
+      template "application_form.rb",
+               Rails.root.join("app/views/forms/application_form.rb")
+    end
+
+    private
+
+    def gem_in_bundle?(gem_name)
+      Bundler.load.specs.any? { |spec| spec.name == gem_name }
+    end
+  end
+end

data/lib/generators/protoform/install/templates/application_form.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class ApplicationForm < Protoform::Rails::Form
+  include Phlex::Rails::Helpers::Pluralize
+
+  def row(component)
+    div do
+      render component.field.label(style: "display: block;")
+      render component
+    end
+  end
+
+  def around_template(&block)
+    super do
+      error_messages
+      yield
+      submit
+    end
+  end
+
+  def error_messages
+    return if model.errors.none?
+
+    div(style: "color: red;") do
+      h2 do
+        "#{pluralize model.errors.count,
+                     "error"} prohibited this post from being saved:"
+      end
+      ul do
+        model.errors.each do |error|
+          li { error.full_message }
+        end
+      end
+    end
+  end
+end

data/lib/protoform/dom.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Protoform
+  # Generates DOM IDs, names, etc. for a Field, Namespace, or Node based on
+  # norms that were established by Rails. These can be used outsidef or Rails in
+  # other Ruby web frameworks since it has now dependencies on Rails.
+  class DOM
+    def initialize(field:)
+      @field = field
+    end
+
+    # Converts the value of the field to a String, which is required to work
+    # with Phlex. Assumes that `Object#to_s` emits a format suitable for the web
+    # form.
+    def value
+      @field.value.to_s
+    end
+
+    # Walks from the current node to the parent node, grabs the names, and
+    # seperates them with a `_` for a DOM ID. One limitation of this approach is
+    # if multiple forms exist on the same page, the ID may be duplicate.
+    def id
+      lineage.map(&:key).join("_")
+    end
+
+    # The `name` attribute of a node, which is influenced by Rails (not sure
+    # where Rails got it from). All node names, except the parent node, are
+    # wrapped in a `[]` and collections are left empty. For example,
+    # `user[addresses][][street]` would be created for a form with data shaped
+    # like `{user: {addresses: [{street: "Sesame Street"}]}}`.
+    def name
+      root, *names = keys
+      names
+        .map { |name| "[#{name}]" }
+        .unshift(root)
+        .join
+    end
+
+    # Emit the id, name, and value in an HTML tag-ish that doesnt have an
+    # element.
+    def inspect
+      "<id=#{id.inspect} name=#{name.inspect} value=#{value.inspect}/>"
+    end
+
+    private
+
+    def keys
+      lineage.map do |node|
+        # If the parent of a field is a field, the name should be nil.
+        node.key unless node.parent.is_a? Field
+      end
+    end
+
+    # One-liner way of walking from the current node all the way up to the
+    # parent.
+    def lineage
+      Enumerator.produce(@field, &:parent).take_while(&:itself).reverse
+    end
+  end
+end

data/lib/protoform/field.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Protoform
+  class Field < Node
+    attr_reader :dom, :object
+
+    def initialize(key, parent:, object: nil, value: nil)
+      super(key, parent:)
+      @object = object
+      @value = value
+      @dom = Protoform::DOM.new(field: self)
+    end
+
+    def value
+      if @object.respond_to? @key.to_s
+        @object.send @key
+      else
+        @value
+      end
+    end
+    alias serialize value
+
+    def assign(value)
+      if @object.respond_to? :"#{@key}="
+        @object.send :"#{@key}=", value
+      else
+        @value = value
+      end
+    end
+    alias value= assign
+
+    # Wraps a field that's an array of values with a bunch of fields
+    # that are indexed with the array's index.
+    def collection(&block)
+      @collection ||= FieldCollection.new(field: self, &block)
+    end
+  end
+end

data/lib/protoform/field_collection.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Protoform
+  class FieldCollection
+    include Enumerable
+
+    def initialize(field:, &block)
+      @field = field
+      @index = 0
+      each(&block) if block
+    end
+
+    def each
+      Enumerator.new do |collection|
+        values.each do |value|
+          collection.yield build_field(value:)
+        end
+      end
+    end
+
+    def field
+      build_field
+    end
+
+    def values
+      Array(@field.value)
+    end
+
+    private
+
+    def build_field(**kwargs)
+      @field.class.new(current_index, parent: @field, **kwargs)
+    end
+
+    def current_index
+      @index += 1
+    end
+  end
+end