uchi 0.1.8 → 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/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.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/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) %>

data/app/controllers/uchi/repository_controller.rb

@@ -129,11 +129,11 @@ module Uchi
     end
 
     def permitted_params_for_edit
-      @repository.fields_for_edit.map(&:permitted_param)
+      @repository.fields_for_edit(record: @record).map(&:permitted_param)
     end
 
     def permitted_params_for_new
-      @repository.fields_for_new.map(&:permitted_param)
+      @repository.fields_for_new(record: @record || @repository.build).map(&:permitted_param)
     end
 
     def record_params_for_edit

data/app/views/layouts/uchi/_javascript.html.erb

@@ -1 +1 @@
-<%= javascript_include_tag "uchi/application", "data-turbo-track": "reload" %>
+<%= javascript_include_tag "uchi/application", "data-turbo-track": "reload", nonce: true %>

data/app/views/layouts/uchi/application.html.erb

@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html class="h-full">
+<html lang="en">
   <head>
     <title>
       <%= content_for?(:page_title) ? yield(:page_title) : "Uchi" %>
@@ -15,12 +15,10 @@
     <%= render "layouts/uchi/stylesheets" %>
   </head>
 
-  <body class="antialiased bg-neutral-secondary-medium h-full p-2">
-    <div class="md:flex h-full">
-      <%= render(partial: "uchi/navigation/main") %>
+  <body class="antialiased bg-neutral-secondary-medium p-2 h-screen overflow-hidden md:flex md:p-0">
+    <%= render(partial: "uchi/navigation/main") %>
 
-      <main class="py-6 overflow-x-hidden grow md:px-6"><%= yield %></main>
-    </div>
+    <main class="py-6 overflow-x-hidden grow md:px-6"><%= yield %></main>
 
     <%= render "layouts/uchi/flash_messages" %>
   </body>

data/app/views/uchi/has_many/associated_records/index.html.erb

@@ -1,4 +1,4 @@
-<ul class="p-4 text-sm text-body font-medium space-y-4">
+<ul class="p-4 space-y-4 text-sm font-medium text-body">
   <% @records.each do |record| %>
     <%
       checkbox_id = dom_id(record, [source_repository.model, @field_name, 'checkbox'].join("-"))
@@ -12,12 +12,14 @@
         <input
           type="checkbox"
           id="<%= checkbox_id %>"
-          class="w-4 h-4 border border-default-strong rounded-xs bg-neutral-secondary-strong focus:ring-2 focus:ring-brand-soft cursor-pointer"
+          class="w-4 h-4 border cursor-pointer border-default-strong rounded-xs bg-neutral-secondary-strong focus:ring-2 focus:ring-brand-soft"
           data-action="change->has-many#handleCheckboxChange"
           data-has-many-target="checkbox"
-          <%= 'checked' if @current_values.include?(record) %>
+          <% if @current_values.include?(record) %>
+            checked
+          <% end %>
         >
-        <label for="<%= checkbox_id %>" class="ms-2 text-sm font-medium text-heading cursor-pointer">
+        <label for="<%= checkbox_id %>" class="text-sm font-medium cursor-pointer ms-2 text-heading">
           <%= record_title(record) %>
         </label>
       </div>

data/app/views/uchi/repository/edit.html.erb

@@ -17,7 +17,7 @@
   <%= render(Uchi::Flowbite::Card.new) do %>
     <%= form_with model: @record, url: @repository.routes.path_for(:update, id: @record.id) do |form| %>
       <div class="space-y-6">
-        <% @repository.fields_for_edit.each do |field| %>
+        <% @repository.fields_for_edit(record: @record).each do |field| %>
           <div>
             <%= render(
               field.edit_component(

data/app/views/uchi/repository/new.html.erb

@@ -15,7 +15,7 @@
 <%= render(Uchi::Flowbite::Card.new) do %>
   <%= form_with model: @record, url: @repository.routes.path_for(:create) do |form| %>
     <div class="space-y-6">
-      <% @repository.fields_for_new.each do |field| %>
+      <% @repository.fields_for_new(record: @record).each do |field| %>
         <div>
           <%= render(
             field.new_component(

data/app/views/uchi/repository/show.html.erb

@@ -39,14 +39,14 @@
     ]) %>
 <% end %>
 
+<% visible_fields = @repository.fields_for_show(record: @record) %>
+
 <%= render(Uchi::Ui::Show::AttributeFields.new(
-  attribute_fields: @repository.fields_for_show.select { |field| field.group_as(:show) == :attributes },
+  attribute_fields: visible_fields.select { |field| field.group_as(:show) == :attributes },
   record: @record,
   repository: @repository
 )) %>
 
-<% association_fields = @repository.fields_for_show.select{ |field| field.group_as(:show) == :associations } %>
-
-<% association_fields.each do |field| %>
+<% visible_fields.select { |field| field.group_as(:show) == :associations }.each do |field| %>
   <%= render(field.show_component(record: @record, repository: @repository)) %>
 <% end %>

data/lib/uchi/field/configuration.rb

@@ -6,13 +6,15 @@ module Uchi
       class Unset; end
 
       DEFAULT_READER = ->(record, field_name) { record&.public_send(field_name) }
+      DEFAULT_VISIBLE = ->(_record) { true }
 
       def initialize(*args)
         super
         @on = default_on
         @reader = DEFAULT_READER
         @searchable = default_searchable?
-        @sortable = default_sortable?
+        @visible = DEFAULT_VISIBLE
+        @sortable = default_sortable
       end
 
       # Sets or gets which actions this field should appear on.
@@ -89,6 +91,32 @@ module Uchi
         !!@searchable
       end
 
+      # Sets or gets a conditional proc that determines whether this field should
+      # be visible for a given record.
+      #
+      # When called with a proc argument, sets the visibility condition and returns
+      # self for chaining. When called without arguments, returns the current proc.
+      #
+      # @param visible_proc [Proc] A callable that receives the record and returns
+      #   a boolean indicating whether the field should be visible.
+      #   Raises ArgumentError for non-callables.
+      # @return [self, Proc] Returns self for method chaining when setting,
+      #   or the current proc when getting
+      #
+      # @example Setting
+      #   Field::String.new(:id).visible(lambda { |record| record.id.even? })
+      #
+      # @example Getting
+      #   field.visible # => #<Proc...>
+      def visible(visible_proc = Configuration::Unset)
+        return @visible if visible_proc == Configuration::Unset
+
+        raise ArgumentError, "visible must be callable" unless visible_proc.respond_to?(:call)
+
+        @visible = visible_proc
+        self
+      end
+
       # Sets or gets whether and how this field is sortable.
       #
       # When called with an argument, sets sortable and returns self for chaining.
@@ -111,7 +139,7 @@ module Uchi
       # @example Getting
       #   field.sortable # => true
       def sortable(value = Configuration::Unset)
-        return @sortable if value == Configuration::Unset
+        return @sortable.nil? ? default_sortable : @sortable if value == Configuration::Unset
 
         @sortable = value
         self
@@ -119,9 +147,18 @@ module Uchi
 
       # Returns true if the field is sortable
       def sortable?
-        return default_sortable? if @sortable.nil?
+        !!sortable
+      end
 
-        !!@sortable
+      # Returns whether this field should be visible for the given record.
+      #
+      # Calls the visible proc with the record. Defaults to DEFAULT_VISIBLE,
+      # which always returns true.
+      #
+      # @param record [Object] The record to check visibility for
+      # @return [Boolean] Whether the field should be visible
+      def visible_for?(record)
+        !!@visible.call(record)
       end
 
       protected
@@ -134,7 +171,7 @@ module Uchi
         false
       end
 
-      def default_sortable?
+      def default_sortable
         true
       end
     end