proscenium 0.19.0.beta4-x86_64-linux → 0.19.0.beta6-x86_64-linux

data/lib/proscenium/ui/form.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+require 'literal'
+
+module Proscenium::UI
+  # Helpers to aid in building forms and associated inputs with built-in styling, and inspired by
+  # Rails form helpers and SimpleForm.
+  #
+  # Start by creating the form with `Proscenium::UI::Form`, which expects a model
+  # instance, and a block in which you define one or more fields. It automatically includes a hidden
+  # authenticity token field for you.
+  #
+  # Example:
+  #
+  #   render Proscenium::UI::Form.new(User.new) do |f|
+  #     f.text_field :name
+  #     f.radio_group :role, %i[admin manager]
+  #     f.submit 'Save'
+  #   end
+  #
+  # The following fields (inputs) are available:
+  #
+  #   - `url_field` - <input> with 'url' type.
+  #   - `text_field` - <input> with 'text' type.
+  #   - `textarea_field` - <textarea>.
+  #   - `rich_textarea_field` - A rich <textarea> using ActionText and Trix.
+  #   - `email_field` - <input> with 'email' type.
+  #   - `number_field` - <input> with 'number' type.
+  #   - `color_field` - <input> with 'color' type.
+  #   - `hidden_field` - <input> with 'hidden' type.
+  #   - `search_field` - <input> with 'search' type.
+  #   - `password_field` - <input> with 'password' type.
+  #   - `tel_field` - <input> with 'tel' type.
+  #   - `range_field` - <input> with 'range' type.
+  #   - `time_field` - <input> with 'time' type.
+  #   - `date_field` - <input> with 'date' type.
+  #   - `week_field` - <input> with 'week' type.
+  #   - `month_field` - <input> with 'month' type.
+  #   - `datetime_local_field` - <input> with 'datetime-local' type.
+  #   - `checkbox_field` - <input> with 'checkbox' type.
+  #   - `radio_field` - <input> with 'radio' type.
+  #   - `radio_group` - group of <input>'s with 'radio' type.
+  #   - `select_field` - <select> input.
+  #
+  class Form < Proscenium::UI::Component
+    extend ActiveSupport::Autoload
+    extend Literal::Properties
+
+    autoload :FieldMethods
+    autoload :Translation
+
+    module Fields
+      extend ActiveSupport::Autoload
+
+      autoload :Base
+      autoload :Input
+      autoload :Hidden
+      autoload :RadioInput
+      autoload :Checkbox
+      autoload :Textarea
+      autoload :RichTextarea
+      autoload :RadioGroup
+      autoload :Select
+      autoload :Tel
+    end
+
+    include FieldMethods
+    include Translation
+
+    STANDARD_METHOD_VERBS = %w[get post].freeze
+
+    def self.input_field(method_name, type:)
+      define_method method_name do |*args, **attributes|
+        merge_bang_attributes! args, attributes
+        render Fields::Input.new(args, @model, self, type:, **attributes)
+      end
+    end
+
+    prop :model, _Interface(:to_model), :positional, reader: :public
+
+    prop :method, _Union?(:get, :post, :put, :patch, :delete,
+                          'get', 'post', 'put', 'patch', 'delete') do |value|
+      value ||= 'patch' if @model.respond_to?(:persisted?) && @model.persisted?
+      value&.to_s&.downcase || 'post'
+    end
+
+    # The form action, which can be any value that can be passed to Rails `url_for` helper.
+    prop :action, _Union?(String, Symbol, Array, Hash)
+
+    prop :attributes, Hash, :**
+
+    # Use the given `field_class` to render a custom field. This allows you to create a custom
+    # form field on an as-needed basis. The `field_class` must be a subclass of
+    # `Proscenium::UI::Form::Fields::Base`.
+    #
+    # Example:
+    #
+    #   render Proscenium::UI::Form.new @resource do |f|
+    #     f.use_field Administrator::EmailField, :email, :required!
+    #   end
+    #
+    # @param field_class [Class<Proscenium::UI::Form::Fields::Base>]
+    # @param args [Array<Symbol>] name or nested names of model attribute
+    # @param attributes [Hash] passed through to each input
+    def use_field(field_class, *args, **attributes)
+      merge_bang_attributes! args, attributes
+      render field_class.new(args, model, self, **attributes)
+    end
+
+    # Returns a button with type of 'submit', using the `value` given.
+    #
+    # @param value [String] Value of the `value` attribute.
+    def submit(value = 'Save', **)
+      input(name: 'commit', type: :submit, value:, **)
+    end
+
+    # Returns a <div> with the given `message` as its content. If `message` is not given, and
+    # `attribute` is, then first error message for the given model `attribute`.
+    #
+    # @param message [String] error message to display.
+    # @param attribute [Symbol] name of the model attribute.
+    def error(message: nil, attribute: nil, &content)
+      if message.nil? && attribute.nil? && !content
+        raise ArgumentError, 'One of `message:`, `attribute:` or a block is required'
+      end
+
+      if content
+        div class: :@error, &content
+      else
+        div class: :@error do
+          message || @model.errors[attribute]&.first
+        end
+      end
+    end
+
+    def view_template(&block)
+      form action:, method:, **@attributes do
+        method_field
+        authenticity_token_field
+        error_for_base
+        yield_content(&block)
+      end
+    end
+
+    def error_for_base
+      return unless @model.errors.key?(:base)
+
+      callout :danger do |x|
+        x.title { 'Unable to save...' }
+        div { @model.errors.full_messages_for(:base).first }
+      end
+    end
+
+    def field_name(*names, multiple: false)
+      # Delete the `?` suffix if present.
+      lname = names.pop.to_s
+      names.append lname.delete_suffix('?').to_sym
+
+      @_view_context.field_name(ActiveModel::Naming.param_key(@model.class), *names,
+                                multiple:)
+    end
+
+    def field_id(*)
+      @_view_context.field_id(ActiveModel::Naming.param_key(@model.class), *)
+    end
+
+    def authenticity_token_field
+      return if method == 'get'
+
+      input(
+        name: 'authenticity_token',
+        type: 'hidden',
+        value: @_view_context.form_authenticity_token(form_options: { action:,
+                                                                      method: @method })
+      )
+    end
+
+    def action
+      @_view_context.url_for(@action || @model)
+    end
+
+    def method_field
+      return if STANDARD_METHOD_VERBS.include?(@method)
+
+      input type: 'hidden', name: '_method', value: @method, autocomplete: 'off'
+    end
+
+    def method
+      STANDARD_METHOD_VERBS.include?(@method) ? @method : 'post'
+    end
+
+    input_field :file_field, type: 'file'
+    input_field :url_field, type: 'url'
+    input_field :text_field, type: 'text'
+    input_field :time_field, type: 'time'
+    input_field :date_field, type: 'date'
+    input_field :number_field, type: 'number'
+    input_field :week_field, type: 'week'
+    input_field :month_field, type: 'month'
+    input_field :email_field, type: 'email'
+    input_field :color_field, type: 'color'
+    input_field :search_field, type: 'search'
+    input_field :password_field, type: 'password'
+    input_field :range_field, type: 'range'
+
+    private
+
+    def merge_bang_attributes!(attrs, kw_attributes, additional_bang_attrs: [])
+      Proscenium::Utils.merge_bang_attributes! attrs, kw_attributes,
+                                               %i[required disabled].concat(additional_bang_attrs)
+    end
+  end
+end

data/lib/proscenium/ui/props.css

@@ -0,0 +1,7 @@
+:where(html) {
+  --pui-input-border: 1px solid gray;
+  --pui-input-color: FieldText;
+  --pui-input-accent-color: lightgray;
+  --pui-input-border-radius: 2px;
+  --pui-input-background-color: Field;
+}

data/lib/proscenium/ui/react-manager/index.jsx

@@ -85,7 +85,7 @@ function init(elements) {
       throw `[proscenium/react/manager] Cannot load component ${path} (not found in Proscenium.lazyScripts)`;
     }
 
-    const react = import("@proscenium/react-manager/react");
+    const react = import("proscenium/react-manager/react");
     const Component = import(window.Proscenium.lazyScripts[path].outpath);
 
     const forwardChildren =

data/lib/proscenium/ui/test.js

@@ -1 +1 @@
-console.log("@proscenium/ui/test.js");
+console.log("proscenium/test.js");

data/lib/proscenium/ui/ujs/index.js

@@ -2,7 +2,7 @@ export default async () => {
   window.Proscenium = window.Proscenium || {};
 
   if (!window.Proscenium.UJS) {
-    const classPath = "/proscenium/ui/ujs/class.js";
+    const classPath = "/proscenium/ujs/class.js";
     const module = await import(classPath);
     window.Proscenium.UJS = new module.default();
   }

data/lib/proscenium/ui.rb

@@ -2,7 +2,10 @@
 
 module Proscenium::UI
   extend ActiveSupport::Autoload
+  extend Phlex::Kit
 
   autoload :Component
   autoload :Breadcrumbs
+  autoload :Form
+  autoload :Flash
 end

data/lib/proscenium/utils.rb

@@ -9,5 +9,38 @@ module Proscenium
     def digest(value)
       Digest::SHA1.hexdigest(value.to_s)[..7]
     end
+
+    # Merges the given array of attribute `name`'s into the `kw_arguments`. A bang attribute is one
+    # that ends with an exclamation mark or - in Ruby parlance - a "bang", and has a boolean value.
+    # Modifies the given `kw_attributes`, and only attribute names in `allowed` will be merged.
+    #
+    # @param names [Array(Symbol)] of argument names
+    # @param kw_attributes [Hash] attributes to be merged with
+    # @param allowed [Array(Symbol)] attribute names allowed to be merged as bang attributes
+    #
+    # Example:
+    #
+    #   def tab(name, *args, href:, **attributes)
+    #     Hue::Utils.merge_bang_attributes!(args, attributes, [:current])
+    #   end
+    #
+    # Allowing you to use either of the following API's:
+    #
+    #   tab 'Tab 1', required: true
+    #   tab 'Tab 1', :required!
+    #
+    def merge_bang_attributes!(names, kw_attributes, allowed)
+      allowed.each do |name|
+        sym_name = name.to_sym
+        bang_name = :"#{sym_name}!"
+
+        next unless names.include?(bang_name)
+
+        names.delete(bang_name)
+
+        # Keyword arguments should override the bang.
+        kw_attributes[sym_name] = true unless kw_attributes.key?(sym_name)
+      end
+    end
   end
 end

data/lib/proscenium/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Proscenium
-  VERSION = '0.19.0.beta4'
+  VERSION = '0.19.0.beta6'
 end

data/lib/proscenium/view_component.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'view_component'
-
 class Proscenium::ViewComponent < ViewComponent::Base
   extend ActiveSupport::Autoload
 

data/lib/proscenium.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
-require 'active_support/dependencies/autoload'
+# require 'zeitwerk'
+
+# loader = Zeitwerk::Loader.for_gem
+# loader.inflector.inflect 'ui' => 'UI'
+# loader.ignore "#{__dir__}/proscenium/ext"
+# loader.ignore "#{__dir__}/proscenium/libs"
+# loader.setup
 
 module Proscenium
   extend ActiveSupport::Autoload
@@ -65,7 +71,11 @@ module Proscenium
     end
 
     def ui_path
-      Railtie.root.join('lib', 'proscenium', 'ui')
+      @ui_path ||= Railtie.root.join('lib', 'proscenium', 'ui')
+    end
+
+    def ui_path_regex
+      @ui_path_regex ||= Regexp.new("^#{Proscenium.ui_path}/")
     end
 
     def root

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proscenium
 version: !ruby/object:Gem::Version
-  version: 0.19.0.beta4
+  version: 0.19.0.beta6
 platform: x86_64-linux
 authors:
 - Joel Moss
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-03 00:00:00.000000000 Z
+date: 2025-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -19,7 +19,7 @@ dependencies:
         version: 7.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,21 @@ dependencies:
         version: 7.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: countries
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.1.0
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
@@ -59,19 +73,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: oj
+  name: phonelib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: 0.10.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: 0.10.3
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +95,7 @@ dependencies:
         version: 7.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -91,7 +105,7 @@ dependencies:
         version: 7.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: ruby-next
   requirement: !ruby/object:Gem::Requirement
@@ -133,7 +147,6 @@ files:
 - lib/proscenium/middleware/base.rb
 - lib/proscenium/middleware/engines.rb
 - lib/proscenium/middleware/esbuild.rb
-- lib/proscenium/middleware/runtime.rb
 - lib/proscenium/monkey.rb
 - lib/proscenium/phlex.rb
 - lib/proscenium/phlex/asset_inclusions.rb
@@ -154,6 +167,44 @@ files:
 - lib/proscenium/ui/breadcrumbs/mixins.css
 - lib/proscenium/ui/component.rb
 - lib/proscenium/ui/custom_element.js
+- lib/proscenium/ui/flash.rb
+- lib/proscenium/ui/flash/index.css
+- lib/proscenium/ui/flash/index.js
+- lib/proscenium/ui/form.css
+- lib/proscenium/ui/form.rb
+- lib/proscenium/ui/form/field_methods.rb
+- lib/proscenium/ui/form/fields/base.rb
+- lib/proscenium/ui/form/fields/checkbox.rb
+- lib/proscenium/ui/form/fields/checkbox/index.jsx
+- lib/proscenium/ui/form/fields/checkbox/index.module.css
+- lib/proscenium/ui/form/fields/checkbox/previews/basic.jsx
+- lib/proscenium/ui/form/fields/date.module.css
+- lib/proscenium/ui/form/fields/datetime.rb
+- lib/proscenium/ui/form/fields/hidden.rb
+- lib/proscenium/ui/form/fields/input.rb
+- lib/proscenium/ui/form/fields/input/index.jsx
+- lib/proscenium/ui/form/fields/input/index.module.css
+- lib/proscenium/ui/form/fields/input/previews/basic.jsx
+- lib/proscenium/ui/form/fields/radio_group.rb
+- lib/proscenium/ui/form/fields/radio_input.rb
+- lib/proscenium/ui/form/fields/radio_input/index.jsx
+- lib/proscenium/ui/form/fields/radio_input/index.module.css
+- lib/proscenium/ui/form/fields/radio_input/previews/basic.jsx
+- lib/proscenium/ui/form/fields/rich_textarea.css
+- lib/proscenium/ui/form/fields/rich_textarea.js
+- lib/proscenium/ui/form/fields/rich_textarea.rb
+- lib/proscenium/ui/form/fields/select.jsx
+- lib/proscenium/ui/form/fields/select.module.css
+- lib/proscenium/ui/form/fields/select.rb
+- lib/proscenium/ui/form/fields/tel.css
+- lib/proscenium/ui/form/fields/tel.js
+- lib/proscenium/ui/form/fields/tel.rb
+- lib/proscenium/ui/form/fields/textarea.rb
+- lib/proscenium/ui/form/fields/textarea/index.jsx
+- lib/proscenium/ui/form/fields/textarea/index.module.css
+- lib/proscenium/ui/form/fields/textarea/previews/basic.jsx
+- lib/proscenium/ui/form/translation.rb
+- lib/proscenium/ui/props.css
 - lib/proscenium/ui/react-manager/index.jsx
 - lib/proscenium/ui/react-manager/react.js
 - lib/proscenium/ui/stimulus-loading.js

data/lib/proscenium/middleware/runtime.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Proscenium
-  class Middleware
-    class Runtime < Esbuild
-      private
-
-      def real_path
-        @real_path ||= Pathname.new(@request.path.sub(%r{^/@proscenium},
-                                                      '/lib/proscenium/libs')).to_s
-      end
-
-      def root_for_readable
-        Proscenium::Railtie.root
-      end
-    end
-  end
-end