phlexi-display 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b140e54c49ca3a4a8808a12bb7a91dd8d250c91e2d7d29a8d7f9be2c20a7dbf5
+  data.tar.gz: 9c70cec19581873bb9b93fc887571d6c8d5d65c95a25576bdf26a67e2bb30046
+SHA512:
+  metadata.gz: 466d34728adaedd7c4669a7419ec53929e49e1b4466135e5a7cc1eb42c88aa196b344ca4e29d8f27fb56a1e83437500678a2b003ca95fc82bbf70ab1ad017afc
+  data.tar.gz: 047a28cd2c6afba47d9b6c8a833437ac2c009e626f747663dc9f506ef8d805b7979b8f59e4b0fe6e59a8180538d7e66cf323aba83e26e671e567ff12a3236a2c

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Appraisals

@@ -0,0 +1,8 @@
+appraise "default" do
+  # gem "phlex", "~> 1.10"
+end
+
+appraise "rails-7" do
+  gem "rails", "~> 7.1.3", ">= 7.1.3.4"
+  gem "sqlite3", "~> 1.4"
+end

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.2.0] - 2024-07-31
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Stefan Froelich
+
+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,13 @@
+# Phlexi::Display 
+
+Phlexi::Display is a flexible and powerful display builder for Ruby applications. It provides a more customizable and extensible way to create data displays.
+
+[![Ruby](https://github.com/radioactive-labs/phlexi-display/actions/workflows/main.yml/badge.svg)](https://github.com/radioactive-labs/phlexi-display/actions/workflows/main.yml)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/radioactive-labs/phlexi-display.
+
+## 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,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "standard/rake"
+
+task default: %i[test standard]
+
+# https://juincc.medium.com/how-to-setup-minitest-for-your-gems-development-f29c4bee13c2
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end

data/config.ru

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler"
+
+Bundler.require :default, :development

data/gemfiles/default.gemfile

@@ -0,0 +1,5 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gemspec path: "../"

data/gemfiles/rails_7.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.1.3", ">= 7.1.3.4"
+gem "sqlite3", "~> 1.4"
+
+gemspec path: "../"

data/lib/phlexi/display/base.rb

@@ -0,0 +1,243 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/module/delegation"
+require "active_support/string_inquirer"
+require "active_support/core_ext/hash/deep_merge"
+require "active_support/core_ext/string/inflections"
+
+module Phlexi
+  module Display
+    # A form component for building flexible and customizable forms.
+    #
+    # @example Basic usage
+    #   Phlexi::Display.new(user, action: '/users', method: 'post') do |f|
+    #     render field(:name).placeholder("Name").input_tag
+    #     render field(:email).placeholder("Email").input_tag
+    #   end
+    #
+    # @attr_reader [Symbol] key The form's key, derived from the record or explicitly set
+    # @attr_reader [ActiveModel::Model, nil] object The form's associated object
+    class Base < COMPONENT_BASE
+      class Namespace < Structure::Namespace; end
+
+      class FieldBuilder < Structure::FieldBuilder; end
+
+      attr_reader :key, :object
+
+      delegate :field, :submit_button, :nest_one, :nest_many, to: :@namespace
+
+      # Initializes a new Display instance.
+      #
+      # @param record [ActiveModel::Model, Symbol, String] The form's associated record or key
+      # @param action [String, nil] The form's action URL
+      # @param method [String, nil] The form's HTTP method
+      # @param attributes [Hash] Additional HTML attributes for the form tag
+      # @param options [Hash] Additional options for form configuration
+      # @option options [String] :class CSS classes for the form
+      # @option options [Class] :namespace_klass Custom namespace class
+      # @option options [Class] :builder_klass Custom field builder class
+      def initialize(record, action: nil, method: nil, attributes: {}, **options)
+        @form_action = action
+        @form_method = method
+        @form_class = options.delete(:class)
+        @attributes = attributes
+        @namespace_klass = options.delete(:namespace_klass) || default_namespace_klass
+        @builder_klass = options.delete(:builder_klass) || default_builder_klass
+        @options = options
+
+        initialize_object_and_key(record)
+        initialize_namespace
+        initialize_attributes
+      end
+
+      # Renders the form template.
+      #
+      # @return [void]
+      def view_template
+        form_tag { form_template }
+      end
+
+      # Executes the form's content block.
+      # Override this in subclasses to defie a static form.
+      #
+      # @return [void]
+      def form_template
+        instance_exec(&@_content_block) if @_content_block
+      end
+
+      # Renders the form tag with its contents.
+      #
+      # @yield The form's content
+      # @return [void]
+      def form_tag(&)
+        form(**form_attributes) do
+          render_hidden_method_field
+          render_authenticity_token if authenticity_token?
+          yield
+        end
+      end
+
+      def extract_input(params)
+        call unless @_rendered
+        @namespace.extract_input(params)
+      end
+
+      protected
+
+      attr_reader :options, :attributes, :namespace_klass, :builder_klass
+
+      # Initializes the object and key based on the given record.
+      #
+      # @param record [ActiveModel::Model, Symbol, String] The form's associated record or key
+      # @return [void]
+      def initialize_object_and_key(record)
+        # always pop these keys
+        # add support for `as` to make it more rails friendly
+        @key = options.delete(:key) || options.delete(:as)
+
+        case record
+        when String, Symbol
+          @object = nil
+          @key = record
+        else
+          @object = record
+          if @key.nil?
+            unless object.respond_to?(:model_name) && object.model_name.respond_to?(:param_key) && object.model_name.param_key.present?
+              raise ArgumentError, "record must respond to #model_name.param_key with a non nil value or set `key` option e.g. Phlexi::Display(record, key: :record)"
+            end
+            @key = object.model_name.param_key
+          end
+        end
+        @key = @key.to_sym
+      end
+
+      # Initializes the namespace for the form.
+      #
+      # @return [void]
+      def initialize_namespace
+        @namespace = namespace_klass.root(key, object: object, builder_klass: builder_klass)
+      end
+
+      # Initializes form attributes.
+      #
+      # @return [void]
+      def initialize_attributes
+        attributes.fetch(:accept_charset) { attributes[:accept_charset] = "UTF-8" }
+      end
+
+      # Determines the form's action URL.
+      #
+      # @return [String, nil] The form's action URL
+      def form_action
+        puts ""
+        # if @form_action != false
+        #   @form_action ||= if options[:format].nil?
+        #     polymorphic_path(object, {})
+        #   else
+        #     polymorphic_path(object, format: options[:format])
+        #   end
+        # end
+        @form_action
+      end
+
+      # Determines the form's HTTP method.
+      #
+      # @return [ActiveSupport::StringInquirer] The form's HTTP method
+      def form_method
+        @form_method ||= (object_form_method || "get").to_s.downcase
+        ActiveSupport::StringInquirer.new(@form_method)
+      end
+
+      # Retrieves the form's CSS classes.
+      #
+      # @return [String] The form's CSS classes
+      attr_reader :form_class
+
+      # Checks if the authenticity token should be included.
+      #
+      # @return [Boolean] True if the authenticity token should be included, false otherwise
+      def authenticity_token?
+        defined?(helpers) && options.fetch(:authenticity_token) { !form_method.get? }
+      end
+
+      # Retrieves the authenticity token.
+      #
+      # @return [String] The authenticity token
+      def authenticity_token
+        options.fetch(:authenticity_token) { helpers.form_authenticity_token }
+      end
+
+      # Renders the authenticity token field.
+      #
+      # @param name [String] The name attribute for the authenticity token field
+      # @param value [String] The value for the authenticity token field
+      # @return [void]
+      def authenticity_token_field(name = "authenticity_token", value = authenticity_token)
+        input(name: name, value: value, type: "hidden", hidden: true)
+      end
+
+      # Determines the appropriate form method based on the object's state.
+      #
+      # @return [String, nil] The appropriate form method
+      def object_form_method
+        if object.respond_to?(:persisted?)
+          object.persisted? ? "patch" : "post"
+        elsif object.present?
+          "post"
+        end
+      end
+
+      # Renders the hidden method field for non-standard HTTP methods.
+      #
+      # @return [void]
+      def render_hidden_method_field
+        return if standard_form_method?
+        input(name: "_method", value: form_method, type: "hidden", hidden: true)
+      end
+
+      # Checks if the form method is standard (GET or POST).
+      #
+      # @return [Boolean] True if the form method is standard, false otherwise
+      def standard_form_method?
+        form_method.get? || form_method.post?
+      end
+
+      # Returns the standardized form method for the HTML form tag.
+      #
+      # @return [String] The standardized form method
+      def standardized_form_method
+        standard_form_method? ? form_method : "post"
+      end
+
+      # Generates the form attributes hash.
+      #
+      # @return [Hash] The form attributes
+      def form_attributes
+        {
+          id: @namespace.dom_id,
+          action: form_action,
+          method: standardized_form_method,
+          class: form_class,
+          **attributes
+        }
+      end
+
+      # Renders the authenticity token if required.
+      #
+      # @return [void]
+      def render_authenticity_token
+        authenticity_token_field
+      end
+
+      private
+
+      def default_namespace_klass
+        self.class::Namespace
+      end
+
+      def default_builder_klass
+        self.class::FieldBuilder
+      end
+    end
+  end
+end

data/lib/phlexi/display/components/base.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Display
+    module Components
+      class Base < COMPONENT_BASE
+        attr_reader :field, :attributes
+
+        def initialize(field, **attributes)
+          @field = field
+          @attributes = attributes
+
+          build_attributes
+          append_attribute_classes
+        end
+
+        protected
+
+        def build_attributes
+          attributes.fetch(:id) { attributes[:id] = "#{field.dom.id}_#{component_name}" }
+        end
+
+        def append_attribute_classes
+          return if attributes[:class] == false
+
+          attributes[:class] = tokens(
+            component_name,
+            attributes[:class],
+            -> { attributes[:required] } => "required",
+            -> { !attributes[:required] } => "optional",
+            -> { field.has_errors? } => "invalid",
+            -> { attributes[:readonly] } => "readonly",
+            -> { attributes[:disabled] } => "disabled"
+          )
+        end
+
+        def component_name
+          @component_name ||= self.class.name.demodulize.underscore
+        end
+      end
+    end
+  end
+end
+
+
+
+User
+ name: :string
+ validate :name, presence: true
+
+f.input :name

data/lib/phlexi/display/components/checkbox.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Display
+    module Components
+      class Checkbox < Input
+        def view_template
+          input(type: :hidden, name: attributes[:name], value: @unchecked_value, autocomplete: "off", hidden: true) if include_hidden?
+          input(**attributes, value: @checked_value)
+        end
+
+        protected
+
+        def build_input_attributes
+          attributes[:type] = :checkbox
+          super
+
+          @include_hidden = attributes.delete(:include_hidden)
+          @checked_value = (attributes.key?(:checked_value) ? attributes.delete(:checked_value) : "1").to_s
+          @unchecked_value = (attributes.key?(:unchecked_value) ? attributes.delete(:unchecked_value) : "0").to_s
+
+          attributes[:value] = @checked_value
+          attributes[:checked] = attributes.fetch(:checked) { checked? }
+        end
+
+        def include_hidden?
+          @include_hidden != false
+        end
+
+        def checked?
+          return false if field.dom.value == @unchecked_value
+
+          if @checked_value == "1" # using default values
+            # handle nils, numbers and booleans
+            !["", "0", "false"].include?(field.dom.value)
+          else # custom value, so explicit match
+            field.dom.value == @checked_value
+          end
+        end
+
+        def normalize_input(...)
+          input_value = super
+          [@checked_value, @unchecked_value].include?(input_value) ? input_value : @unchecked_value
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/display/components/collection_checkboxes.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Display
+    module Components
+      class CollectionCheckboxes < Base
+        include Concerns::HandlesInput
+        include Concerns::HandlesArrayInput
+        include Concerns::HasOptions
+
+        def view_template
+          div(**attributes.slice(:id, :class)) do
+            field.multi(option_mapper.values) do |builder|
+              render builder.hidden_field_tag if builder.index == 0
+
+              field = builder.field(
+                label: option_mapper[builder.key],
+                # We set the attributes here so they are applied to all input components even if the user decides to use a block
+                input_attributes: {
+                  checked_value: builder.key,
+                  include_hidden: false,
+                  checked: selected?(builder.key)
+                }
+              )
+              if block_given?
+                yield field
+              else
+                render field.checkbox_tag
+                render field.label_tag
+              end
+            end
+          end
+        end
+
+        protected
+
+        def build_attributes
+          super
+          attributes[:multiple] = true
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/display/components/collection_radio_buttons.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Display
+    module Components
+      class CollectionRadioButtons < Base
+        include Concerns::HandlesInput
+        include Concerns::HasOptions
+
+        def view_template
+          div(**attributes.slice(:id, :class)) do
+            field.multi(option_mapper.values) do |builder|
+              render builder.hidden_field_tag if builder.index == 0
+
+              field = builder.field(
+                label: option_mapper[builder.key],
+                # We set the attributes here so they are applied to all input components even if the user decides to use a block
+                input_attributes: {
+                  checked_value: builder.key,
+                  checked: selected?(builder.key)
+                }
+              )
+              if block_given?
+                yield field
+              else
+                render field.radio_button_tag
+                render field.label_tag
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/display/components/concerns/handles_array_input.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Display
+    module Components
+      module Concerns
+        module HandlesArrayInput
+          protected
+
+          def normalize_input(input_value)
+            normalize_array_input(input_value)
+          end
+
+          def normalize_array_input(input_value)
+            Array(input_value).map { |nested_input_value| normalize_simple_input(nested_input_value) }.compact
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/display/components/concerns/handles_input.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Display
+    module Components
+      module Concerns
+        module HandlesInput
+          # Collects parameters matching the input field's param key.
+          #
+          # @param params [Hash] the parameters to collect from.
+          # @return [Hash] the collected parameters.
+          def extract_input(params)
+            # # Handles multi parameter attributes
+            # # https://www.cookieshq.co.uk/posts/rails-spelunking-date-select
+            # # https://www.cookieshq.co.uk/posts/multiparameter-attributes
+
+            # # Matches
+            # # - parameter
+            # # - parameter(1)
+            # # - parameter(2)
+            # # - parameter(1i)
+            # # - parameter(2f)
+            # regex = /^#{param}(\(\d+[if]?\))?$/
+            # keys = params.select { |key, _| regex.match?(key) }.keys
+            # params.slice(*keys)
+
+            params ||= {}
+            {input_param => normalize_input(params[field.key])}
+          end
+
+          protected
+
+          def build_attributes
+            super
+            @input_param = attributes.delete(:input_param) || field.key
+          end
+
+          def input_param
+            @input_param
+          end
+
+          def normalize_input(input_value)
+            normalize_simple_input(input_value)
+          end
+
+          def normalize_simple_input(input_value)
+            input_value.to_s.presence
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/display/components/concerns/has_options.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Display
+    module Components
+      module Concerns
+        module HasOptions
+          protected
+
+          def build_attributes
+            super
+            @collection = attributes.delete(:collection) || field.collection
+            @label_method = attributes.delete(:label_method)
+            @value_method = attributes.delete(:value_method)
+          end
+
+          def option_mapper
+            @option_mapper ||= OptionMapper.new(@collection, label_method: @label_method, value_method: @value_method)
+          end
+
+          def selected?(option)
+            if attributes[:multiple]
+              @options_list ||= Array(field.value)
+              @options_list.any? { |item| item.to_s == option.to_s }
+            else
+              field.value.to_s == option.to_s
+            end
+          end
+
+          def normalize_simple_input(input_value)
+            ([super] & option_mapper.values)[0]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/display/components/concerns/submits_form.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Display
+    module Components
+      module Concerns
+        module SubmitsDisplay
+          def submit_type_value
+            if field.object.respond_to?(:persisted?)
+              field.object.persisted? ? :update : :create
+            else
+              :submit
+            end
+          end
+
+          def submit_type_label
+            @submit_type_label ||= begin
+              key = submit_type_value
+
+              model_object = field.dom.lineage.first.key.to_s
+              model_name_human = if field.object.respond_to?(:model_name)
+                field.object.model_name.human
+              else
+                model_object.humanize
+              end
+
+              defaults = []
+              defaults << :"helpers.submit.#{model_object}.#{key}"
+              defaults << :"helpers.submit.#{key}"
+              defaults << "#{key.to_s.humanize} #{model_name_human}"
+
+              I18n.t(defaults.shift, model: model_name_human, default: defaults)
+            end
+          end
+        end
+      end
+    end
+  end
+end