uchi 0.1.7 → 0.2.0

data/app/assets/stylesheets/uchi/application.css

@@ -669,6 +669,9 @@
     text-overflow: ellipsis;
     white-space: nowrap;
   }
+  .overflow-hidden {
+    overflow: hidden;
+  }
   .overflow-x-auto {
     overflow-x: auto;
   }
@@ -1339,6 +1342,11 @@
       }
     }
   }
+  .md\:p-0 {
+    @media (width >= 48rem) {
+      padding: calc(var(--spacing) * 0);
+    }
+  }
   .md\:px-0 {
     @media (width >= 48rem) {
       padding-inline: calc(var(--spacing) * 0);

data/app/assets/tailwind/uchi.css

@@ -19,3 +19,8 @@ running the following command:
 
 /* Don't include classes used in docs into Uchis stylesheet */
 @source not "docs";
+
+/* Don't include classes from the the Tailwind-generated stylesheet into the
+list of classes to preserve in the Tailwind-generated stylesheet. Doing so means
+that classes would never be purged */
+@source not "app/assets/stylesheets/uchi/application.css";

data/app/components/uchi/field/base/show.html.erb

@@ -0,0 +1 @@
+<%= value %>

data/app/components/uchi/field/base.rb

@@ -3,39 +3,40 @@
 module Uchi
   class Field
     class Base < Field
-      # Uchi::Field::Base::Edit components render fields in the edit view.
-      class Edit < ViewComponent::Base
-        attr_reader :field, :form, :record, :repository, :label, :hint
+      class Component < ViewComponent::Base
+        attr_reader :field, :record, :repository
 
-        def initialize(field:, form:, repository:, label: nil, hint: nil)
+        def initialize(field:, record:, repository:)
           super()
 
           @field = field
-          @form = form
-          @label = label
-          @hint = hint
-          @record = form.object
+          @record = record
           @repository = repository
         end
-      end
 
-      # Uchi::Field::Base::Show components render fields in the show view.
-      class Show < ViewComponent::Base
-        attr_reader :field, :record, :repository
+        # Returns the raw value of the field as returned by the field's value
+        # method.
+        def value
+          return @value if instance_variable_defined?(:@value)
 
-        def initialize(field:, record:, repository:)
-          super()
+          @value = field.value(record)
+        end
+      end
 
-          @field = field
-          @record = record
-          @repository = repository
+      # Uchi::Field::Base::Edit components render fields in the edit view.
+      class Edit < Component
+        attr_reader :form, :label, :hint
+
+        def initialize(field:, form:, repository:, label: nil, hint: nil)
+          super(field:, record: form.object, repository:)
+          @form = form
+          @label = label
+          @hint = hint
         end
       end
 
       # Uchi::Field::Base::Index components render fields in the index view.
-      class Index < ViewComponent::Base
-        attr_reader :field, :record, :repository
-
+      class Index < Component
         class << self
           # Returns the CSS classes to apply to the td or th of the table where
           # this field is rendered.
@@ -43,14 +44,10 @@ module Uchi
             []
           end
         end
+      end
 
-        def initialize(field:, record:, repository:)
-          super()
-
-          @field = field
-          @record = record
-          @repository = repository
-        end
+      # Uchi::Field::Base::Show components render fields in the show view.
+      class Show < Component
       end
     end
   end

data/app/components/uchi/field/belongs_to/edit.html.erb

@@ -2,7 +2,7 @@
   class="relative"
   data-action="keydown.esc->belongs-to#closeDropdown"
   data-controller="belongs-to"
-  data-belongs-to-backend-url-value="<%= helpers.belongs_to_associated_records_path(field: field.name, model: repository.model, record_id: record&.id) %>"
+  data-belongs-to-backend-url-value="<%= helpers.uchi.belongs_to_associated_records_path(field: field.name, model: repository.model, record_id: record&.id) %>"
 >
   <%= render(Uchi::Flowbite::Input::Label.new(attribute: field.name, form: form, options: {for: dom_id_for_toggle})) { label } %>
 

data/app/components/uchi/field/belongs_to.rb

@@ -19,7 +19,14 @@ module Uchi
               "No association named #{field.name.inspect} found on #{record.class}"
           end
 
-          model = reflection.klass
+          model = if reflection.polymorphic?
+            associated_record&.class
+          else
+            reflection.klass
+          end
+
+          return nil if model.nil?
+
           repository_class = Uchi::Repository.for_model(model)
           repository_class.new
         end
@@ -34,7 +41,14 @@ module Uchi
 
         def associated_repository
           @associated_repository ||= begin
-            model = reflection.klass
+            model = if reflection.polymorphic?
+              associated_record&.class
+            else
+              reflection.klass
+            end
+
+            return nil if model.nil?
+
             repository_class = Uchi::Repository.for_model(model)
             repository_class.new
           end
@@ -125,11 +139,31 @@ module Uchi
         :attributes
       end
 
+      # Returns the actions this field should appear on.
+      #
+      # For polymorphic associations, excludes :edit and :new to prevent showing
+      # the field on forms where the type cannot be determined.
+      def on(*actions)
+        on = super
+        return on - [:edit, :new] if polymorphic? && actions.empty?
+
+        on
+      end
+
       def param_key
         # TODO: This is too naive. We need to match this to the actual foreign
         # key of the model.
         :"#{name}_id"
       end
+
+      private
+
+      def polymorphic?
+        return false unless repository
+
+        reflection = repository.model.reflect_on_association(name)
+        reflection&.polymorphic? || false
+      end
     end
   end
 end

data/app/components/uchi/field/boolean/index.html.erb

@@ -1,9 +1,11 @@
-<% if field.value(record) %>
-  <svg class="w-5 h-5" aria-hidden="true" xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" viewBox="0 0 24 24">
+<svg class="w-5 h-5" aria-hidden="true" xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" viewBox="0 0 24 24">
+  <% if field.value(record) %>
+
     <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M8.5 11.5 11 14l4-4m6 2a9 9 0 1 1-18 0 9 9 0 0 1 18 0Z"/>
-  </svg>
-<% else %>
-  <svg class="w-5 h-5" aria-hidden="true" xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" viewBox="0 0 24 24">
+
+  <% else %>
+
     <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M7.757 12h8.486M21 12a9 9 0 1 1-18 0 9 9 0 0 1 18 0Z"/>
-  </svg>
-<% end %>
+
+  <% end %>
+</svg>

data/app/components/uchi/field/boolean/show.html.erb

@@ -1,9 +1,11 @@
-<% if field.value(record) %>
-  <svg class="w-5 h-5" aria-hidden="true" xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" viewBox="0 0 24 24">
+<svg class="w-5 h-5" aria-hidden="true" xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" viewBox="0 0 24 24">
+  <% if value %>
+
     <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M8.5 11.5 11 14l4-4m6 2a9 9 0 1 1-18 0 9 9 0 0 1 18 0Z"/>
-  </svg>
-<% else %>
-  <svg class="w-5 h-5" aria-hidden="true" xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" viewBox="0 0 24 24">
+
+  <% else %>
+
     <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M7.757 12h8.486M21 12a9 9 0 1 1-18 0 9 9 0 0 1 18 0Z"/>
-  </svg>
-<% end %>
+
+  <% end %>
+</svg>

data/app/components/uchi/field/file/show.html.erb

@@ -1,4 +1,4 @@
-<% attachment = field.value(record) %>
+<% attachment = value %>
 
 <% if attachment.attached? %>
   <%= render Uchi::Flowbite::Link.new(href: Rails.application.routes.url_helpers.rails_blob_path(attachment, only_path: true)) do %>

data/app/components/uchi/field/file.rb

@@ -29,7 +29,7 @@ module Uchi
         false
       end
 
-      def default_sortable?
+      def default_sortable
         false
       end
     end

data/app/components/uchi/field/has_and_belongs_to_many.rb

@@ -25,7 +25,7 @@ module Uchi
 
       class Show < Uchi::Field::Base::Show
         def associated_records
-          records = field.value(record)
+          records = value
 
           associated_repository.find_all(scope: records)
         end
@@ -126,6 +126,24 @@ module Uchi
       def association
         @association ||= repository.model.reflect_on_association(name)
       end
+
+      def default_sortable
+        lambda { |query, direction|
+          reflection = query.klass.reflect_on_association(name)
+          return query unless reflection
+
+          associated_table = reflection.klass.table_name
+          associated_primary_key = reflection.klass.primary_key
+          count = Arel.sql("COUNT(#{associated_table}.#{associated_primary_key})")
+          primary_key = query.klass.arel_table[query.klass.primary_key]
+
+          SortOrder.new(count, direction).apply(
+            query
+              .left_outer_joins(name)
+              .group(primary_key)
+          ).order(primary_key.asc)
+        }
+      end
     end
   end
 end

data/app/components/uchi/field/has_many/edit.html.erb

@@ -2,7 +2,7 @@
   class="relative"
   data-action="keydown.esc->has-many#closeDropdown"
   data-controller="has-many"
-  data-has-many-backend-url-value="<%= helpers.has_many_associated_records_path(field: field.name, model: repository.model, record_id: record&.id) %>"
+  data-has-many-backend-url-value="<%= helpers.uchi.has_many_associated_records_path(field: field.name, model: repository.model, record_id: record&.id) %>"
   data-has-many-field-name-value="<%= field_name_for_input %>"
 >
   <%= render(Uchi::Flowbite::Input::Label.new(attribute: field.name, form: form, options: {for: dom_id_for_toggle})) { label } %>

data/app/components/uchi/field/has_many.rb

@@ -150,6 +150,26 @@ module Uchi
       def permitted_param
         {param_key => []}
       end
+
+      protected
+
+      def default_sortable
+        lambda { |query, direction|
+          reflection = query.klass.reflect_on_association(name)
+          return query unless reflection
+
+          associated_table = reflection.klass.table_name
+          associated_primary_key = reflection.klass.primary_key
+          count = Arel.sql("COUNT(#{associated_table}.#{associated_primary_key})")
+          primary_key = query.klass.arel_table[query.klass.primary_key]
+
+          SortOrder.new(count, direction).apply(
+            query
+              .left_outer_joins(name)
+              .group(primary_key)
+          ).order(primary_key.asc)
+        }
+      end
     end
   end
 end

data/app/components/uchi/field/id/show.html.erb

@@ -1,4 +1,4 @@
 <%= render(Uchi::Flowbite::Link.new(
   href: @repository.routes.path_for(:show, id: record.id),
-  target: "_top").with_content(field.value(record))
+  target: "_top").with_content(value)
 ) %>

data/app/components/uchi/field/image/index.html.erb

@@ -1,7 +1,7 @@
 <% attachment = field.value(record) %>
 
 <% if attachment.attached? %>
-  <%= image_tag attachment.variant(resize_to_limit: [100, 100]), class: "h-12 w-12 object-cover rounded" %>
+  <%= image_tag attachment.variant(resize_to_limit: [100, 100]), alt: repository.translate.field_label(field), class: "h-12 w-12 object-cover rounded" %>
 <% else %>
   <%= render(Uchi::Ui::NoValue.new) %>
 <% end %>

data/app/components/uchi/field/image/show.html.erb

@@ -1,7 +1,7 @@
-<% attachment = field.value(record) %>
+<% attachment = value %>
 
 <% if attachment.attached? %>
-  <%= image_tag attachment, class: "max-w-full h-auto rounded-lg shadow-md" %>
+  <%= image_tag attachment, alt: repository.translate.field_label(field),class: "max-w-full h-auto rounded-lg shadow-md" %>
 <% else %>
   <%= render(Uchi::Ui::NoValue.new) %>
 <% end %>

data/app/components/uchi/field/image.rb

@@ -30,7 +30,7 @@ module Uchi
         false
       end
 
-      def default_sortable?
+      def default_sortable
         false
       end
     end

data/app/components/uchi/field/select/edit.html.erb

@@ -0,0 +1 @@
+<%= render(Uchi::Flowbite::InputField::Select.new(**options)) %>

data/app/components/uchi/field/select/index.html.erb

@@ -0,0 +1 @@
+<%= field.label_for(field.value(record)) %>

data/app/components/uchi/field/select/show.html.erb

@@ -0,0 +1 @@
+<%= field.label_for(value) %>

data/app/components/uchi/field/select.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module Uchi
+  class Field
+    class Select < Field
+      class Edit < Uchi::Field::Base::Edit
+        def collection
+          if field.grouped?
+            field.options.map { |group, group_options| [group, group_options.map { |value, label| [label, value] }] }
+          else
+            field.flat_options.map { |value, label| [label, value] }
+          end
+        end
+
+        private
+
+        def options
+          options = {
+            attribute: field.name,
+            collection: collection,
+            form: form,
+            label: {content: label}
+          }
+          options[:hint] = {content: hint} if hint.present?
+          options
+        end
+      end
+
+      class Index < Uchi::Field::Base::Index
+      end
+
+      class Show < Uchi::Field::Base::Show
+      end
+
+      # Resolves and memoizes the options as a flat value => label Hash, keyed
+      # by the string representation of each option's value so #label_for
+      # can look up a label in constant time. Memoized so that a Proc given
+      # to #options is only called once per field instance - see
+      # #resolved_options for details. The memo is cleared whenever #options
+      # is called with a new value.
+      #
+      # When the same value appears in more than one group, the first
+      # matching label wins - matching how a browser's `<select>` element
+      # only ever selects the first option with a matching value.
+      def flat_options
+        @flat_options ||= resolved_options.each_with_object({}) { |(key, value), flat|
+          if value.is_a?(Hash)
+            value.each { |group_key, group_label| flat[group_key.to_s] = group_label unless flat.key?(group_key.to_s) }
+          else
+            flat[key.to_s] = value unless flat.key?(key.to_s)
+          end
+        }
+      end
+
+      # Returns true if the configured options are grouped, ie. a non-empty
+      # Hash whose values are all themselves Hashes of options.
+      def grouped?
+        resolved_options.present? && resolved_options.values.all? { |value| value.is_a?(Hash) }
+      end
+
+      def initialize(name)
+        super
+        @options = {}
+      end
+
+      # Returns the label to display for the given value, or nil if the value
+      # doesn't match any of the configured options.
+      #
+      # Values are compared using their string representation, matching how
+      # a `<select>` element compares its options' values against the
+      # persisted attribute value.
+      def label_for(value)
+        return if value.nil?
+
+        flat_options[value.to_s]
+      end
+
+      # Sets or gets the options to choose between.
+      #
+      # When called with an argument, sets the options and returns self for
+      # chaining. When called without arguments, returns the current options,
+      # resolved to a Hash.
+      #
+      # @param options [Hash, Array, Proc] A hash mapping stored values to
+      #   their human-readable labels. An array can be given instead, in which
+      #   case each item is used as both the stored value and its label. A
+      #   proc can also be given; it's called with no arguments and should
+      #   return a Hash or an Array as described above.
+      #
+      #   To group options, pass a Hash whose values are themselves a Hash or
+      #   Array of options, keyed by the group label.
+      # @return [self, Hash] Returns self for method chaining when setting,
+      #   or the options hash when getting
+      #
+      # @example Setting with a Hash
+      #   Field::Select.new(:size).options({s: "Small", m: "Medium", l: "Large"})
+      #
+      # @example Setting with an Array
+      #   Field::Select.new(:size).options(["Small", "Medium", "Large"])
+      #
+      # @example Setting with a Proc
+      #   Field::Select.new(:size).options(-> { Size.pluck(:key, :name).to_h })
+      #
+      # @example Setting grouped options
+      #   Field::Select.new(:size).options({
+      #     "Letters" => {s: "Small", m: "Medium", l: "Large"},
+      #     "Numbers" => ["32", "34", "36"]
+      #   })
+      #
+      # @example Getting
+      #   field.options # => {s: "Small", m: "Medium", l: "Large"}
+      def options(options = Configuration::Unset)
+        return resolved_options if options == Configuration::Unset
+
+        @options = options
+        @resolved_options = nil
+        @flat_options = nil
+        self
+      end
+
+      private
+
+      def normalize(options)
+        case options
+        when Array
+          options.to_h { |option| [option, option] }
+        when Hash
+          options.transform_values { |value| value.is_a?(Array) ? value.to_h { |option| [option, option] } : value }
+        else
+          raise ArgumentError, "Field::Select options must be a Hash, an Array, or a Proc returning one of those, got #{options.class}"
+        end
+      end
+
+      # Resolves and memoizes the configured options. Memoized so that a Proc
+      # given to #options is only called once per field instance, even though
+      # #options, #grouped?, and #label_for are all called multiple times
+      # while rendering a single page (e.g. once per row on an index page).
+      # The memo is cleared whenever #options is called with a new value.
+      def resolved_options
+        @resolved_options ||= normalize(@options.respond_to?(:call) ? @options.call : @options)
+      end
+    end
+  end
+end

data/app/components/uchi/field/text.rb

@@ -27,7 +27,7 @@ module Uchi
       protected
 
       def default_on
-        [:edit, :show]
+        [:edit, :new, :show]
       end
 
       def default_searchable?

data/app/components/uchi/flowbite/button.rb

@@ -20,7 +20,7 @@ module Uchi::Flowbite
 
     class << self
       def classes(size: :default, state: :default, style: :default)
-        style = styles.fetch(style) or raise "wut"
+        style = styles.fetch(style)
         classes = style.fetch(state)
         classes + sizes.fetch(size)
       end

data/app/components/uchi/flowbite/input/field.rb

@@ -93,7 +93,13 @@ module Uchi::Flowbite
         !!@disabled
       end
 
+      # Returns true if the object has errors. Returns false if there is no
+      # object.
+      #
+      # @return [Boolean] true if there are errors, false otherwise.
       def errors?
+        return false unless @object
+
         @object.errors.include?(@attribute.intern)
       end
 

data/app/components/uchi/flowbite/input/label.rb

@@ -36,6 +36,8 @@ module Uchi::Flowbite
       end
 
       def errors?
+        return false unless @object
+
         @object.errors.include?(@attribute.intern)
       end
 

data/app/components/uchi/flowbite/input_field.rb

@@ -67,7 +67,11 @@ module Uchi::Flowbite
     renders_one :label
 
     # Returns the errors for attribute
+    #
+    # @return [Array<String>] An array of error messages for the attribute.
     def errors
+      return [] unless @object
+
       @object.errors[@attribute] || []
     end
 
@@ -185,7 +189,13 @@ module Uchi::Flowbite
     end
 
     def id_for_hint_element
-      "#{@form.object_name}_#{@attribute}_hint"
+      [
+        @form.object_name,
+        @attribute,
+        "hint"
+      ]
+        .compact_blank
+        .join("_")
     end
 
     # @return [Hash] The keyword arguments for the input component.

data/app/components/uchi/flowbite/styles.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Uchi::Flowbite
+  class Styles
+    class StyleNotFoundError < ::KeyError; end
+
+    class << self
+      def from_hash(styles_hash)
+        styles = Styles.new
+        styles_hash.each do |style_name, states_hash|
+          styles.add_style(style_name, states_hash)
+        end
+        styles
+      end
+    end
+
+    def add_style(style_name, states_hash)
+      @styles[style_name] = Uchi::Flowbite::Style.new(states_hash)
+    end
+
+    def fetch(style_name)
+      return @styles[style_name] if @styles.key?(style_name)
+
+      raise \
+        StyleNotFoundError,
+        "Style not found: #{style_name}. Available styles: " \
+        "#{@styles.keys.sort.join(", ")}"
+    end
+
+    def initialize
+      @styles = {}
+    end
+  end
+end

data/app/components/uchi/ui/actions/dropdown/dropdown.html.erb

@@ -42,7 +42,7 @@
     >
       <% actions.each do |action| %>
         <li role="menuitem">
-          <%= form_with url: helpers.actions_executions_path, method: :post, class: "block" do %>
+          <%= form_with url: helpers.uchi.actions_executions_path, method: :post, class: "block" do %>
             <%= hidden_field_tag :model, repository.model.name %>
             <%= hidden_field_tag :action_name, action.class.name %>
             <%= hidden_field_tag :id, record.id %>

data/app/components/uchi/ui/index/records_table/records_table.html.erb

@@ -15,7 +15,7 @@
           class="px-6 py-3 font-medium whitespace-nowrap <%= component_class.classes_for_table_cell.join(" ") %>"
         >
           <% if field.sortable? %>
-            <% if field.name == sort_order&.name %>
+            <% if field.name == sort_order&.column %>
               <% if sort_order&.ascending? %>
                 <%= link_to(repository.routes.path_for(:index, query: query, scope: scope, sort: {:by => field.name, :direction => :desc})) do %>
                   <%= repository.translate.field_label(field) %>