uchi 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de2b1d1a3dd3e56ab24bce7e64663414c0dbfe4dfc4ac782ca47fcd967e4b048
-  data.tar.gz: b9e0322ebafd58e4369f8b1e0087c8e4ec3bb637226a02b37b890d16be9986ad
+  metadata.gz: 56f0102a6440897f16c6a2cd432d2ce52a7c018c0546fd7029a012ce937d5511
+  data.tar.gz: 9c3fc85ba5021deec675ed623ff72e3c529aedcfcf75797f1d4dcc36d624ad69
 SHA512:
-  metadata.gz: b2ff7837db46a22eb39adc6cbd07077d9dd288032e6d77468a596c8042e3ab8476bc92ee57a3161ab177523701c0f7e4e4e8f8f49a45fc2691e8eaf0c4c2a0a2
-  data.tar.gz: 01accad1e6c453af98f1cccde568c46eb6b6eb9e0474f5454f3b9b59e215df636b00a599909b506f0c878a44d40d2f4b936329d0dab8aea82f422cf0709586ff
+  metadata.gz: 5c8c4ad2edc2e428b6b5c58f1c8a007d4fd60d6b84484eecadac47d0104fd8f021f1fedb3d422867d014e4672f29f1df6fbe1edbb09ee7b35570bc078a1a29b7
+  data.tar.gz: df693cb8af530b74deaaa10059a3a9162bf7ddc10cb77b64d01dfb79d620826e3f885935ef4b2ccd9fd3fbe0b449eb6f59556bfd09738a6870f3f6fe1c46731a

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/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/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/controllers/uchi/repository_controller.rb

@@ -9,7 +9,7 @@ module Uchi
     before_action :set_repository
 
     def create
-      @record = build_record
+      @record = build_record_for_new
       if @record.save
         flash[:success] = @repository.translate.successful_create
         redirect_to(@repository.routes.path_for(:show, id: @record.id), status: :see_other)
@@ -54,7 +54,7 @@ module Uchi
     end
 
     def new
-      @record = build_record
+      @record = build_record_for_new
     end
 
     def show
@@ -63,7 +63,7 @@ module Uchi
 
     def update
       @record = find_record
-      if @record.update(record_params)
+      if @record.update(record_params_for_update)
         flash[:success] = @repository.translate.successful_update
         redirect_to(@repository.routes.path_for(:show, id: @record.id, uniq: rand), status: :see_other)
       else
@@ -73,8 +73,8 @@ module Uchi
 
     private
 
-    def build_record
-      @repository.build(record_params)
+    def build_record_for_new
+      @repository.build(record_params_for_new)
     end
 
     # Returns the path to use for the cancel link
@@ -128,10 +128,26 @@ module Uchi
       25
     end
 
-    def record_params
-      permitted_params = @repository.fields_for_edit.map(&:permitted_param)
+    def permitted_params_for_edit
+      @repository.fields_for_edit.map(&:permitted_param)
+    end
+
+    def permitted_params_for_new
+      @repository.fields_for_new.map(&:permitted_param)
+    end
+
+    def record_params_for_edit
+      (params[@repository.model_param_key] || ActionController::Parameters.new)
+        .permit(*permitted_params_for_edit)
+    end
+
+    def record_params_for_update
+      record_params_for_edit
+    end
+
+    def record_params_for_new
       (params[@repository.model_param_key] || ActionController::Parameters.new)
-        .permit(*permitted_params)
+        .permit(*permitted_params_for_new)
     end
 
     # Returns the repository class associated with this controller.

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

@@ -16,7 +16,7 @@
   </head>
 
   <body class="antialiased bg-neutral-secondary-medium h-full p-2">
-    <div class="md:flex">
+    <div class="md:flex h-full">
       <%= render(partial: "uchi/navigation/main") %>
 
       <main class="py-6 overflow-x-hidden grow md:px-6"><%= yield %></main>

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

@@ -15,10 +15,10 @@
 <%= 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_edit.each do |field| %>
+      <% @repository.fields_for_new.each do |field| %>
         <div>
           <%= render(
-            field.edit_component(
+            field.new_component(
               form: form,
               repository: @repository,
               label: @repository.translate.field_label(field),

data/lib/uchi/field/configuration.rb

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

data/lib/uchi/field.rb

@@ -51,6 +51,17 @@ module Uchi
       @name = name.to_sym
     end
 
+    def new_component(form:, repository:, label: nil, hint: nil)
+      # For now all components use the same component for Edit and New. Override
+      # this method in a subclass to provide a different component.
+      edit_component(
+        form: form,
+        hint: hint,
+        label: label,
+        repository: repository
+      )
+    end
+
     # Returns the key that this field is expected to use in params
     def param_key
       name.to_sym

data/lib/uchi/plugins.rb

@@ -0,0 +1,21 @@
+module Uchi
+  class Plugins
+    attr_reader :registered
+
+    def hook(hook_name, **kwargs)
+      registered.each do |plugin_class|
+        next unless plugin_class.hooks_into?(hook_name)
+
+        plugin_class.hook(hook_name, **kwargs)
+      end
+    end
+
+    def initialize
+      @registered = []
+    end
+
+    def register(plugin_class)
+      @registered << plugin_class
+    end
+  end
+end

data/lib/uchi/repository/routes.rb

@@ -22,7 +22,7 @@ module Uchi
       end
 
       def root_path
-        "/#{uchi_namespace}/"
+        "/#{uchi_path}/"
       end
 
       private
@@ -34,7 +34,7 @@ module Uchi
 
       def plural_path_for(_action, **options)
         parts = [
-          uchi_namespace,
+          uchi_as,
           plural,
           "path"
         ].compact
@@ -47,15 +47,19 @@ module Uchi
         action = nil if action == :destroy
         parts = [
           action,
-          uchi_namespace,
+          uchi_as,
           singular,
           "path"
         ].compact
         call_url_helper_in_main_app(parts, **options)
       end
 
-      def uchi_namespace
-        :uchi
+      def uchi_as
+        Uchi.routes.mount_as
+      end
+
+      def uchi_path
+        Uchi.routes.mount_at
       end
     end
   end

data/lib/uchi/repository.rb

@@ -51,18 +51,31 @@ module Uchi
     end
 
     # Returns an array of fields to show on the edit page.
+    #
+    # @return [Array<Uchi::Field>]
     def fields_for_edit
-      fields.select { |field| field.on.include?(:edit) }.each { |field| field.repository = self }
+      fields_for(:edit)
     end
 
     # Returns an array of fields to show on the index page.
+    #
+    # @return [Array<Uchi::Field>]
     def fields_for_index
-      fields.select { |field| field.on.include?(:index) }.each { |field| field.repository = self }
+      fields_for(:index)
+    end
+
+    # Returns an array of fields to show on the new page.
+    #
+    # @return [Array<Uchi::Field>]
+    def fields_for_new
+      fields_for(:new)
     end
 
     # Returns an array of fields to show on the show page.
+    #
+    # @return [Array<Uchi::Field>]
     def fields_for_show
-      fields.select { |field| field.on.include?(:show) }.each { |field| field.repository = self }
+      fields_for(:show)
     end
 
     def find_all(search: nil, scope: model.all, sort_order: default_sort_order)
@@ -185,6 +198,20 @@ module Uchi
       end
     end
 
+    # Returns an array of fields to show for the given action.
+    #
+    # @param action [Symbol] The action to get fields for. One of :index, :show,
+    # :new, :edit.
+    #
+    # @return [Array<Uchi::Field>]
+    def fields_for(action)
+      fields_with_repository.select { |field| field.on.include?(action) }
+    end
+
+    def fields_with_repository
+      fields.each { |field| field.repository = self }
+    end
+
     def searchable_fields
       @searchable_fields ||= fields.select { |field| field.searchable? }
     end

data/lib/uchi/routes.rb

@@ -7,19 +7,26 @@ module Uchi
     #  Rails.application.routes.draw do
     #    Uchi.routes.mount(self)
     #  end
+    #
+    # @param host_routes [ActionDispatch::Routing::Mapper] The host
+    # application's routes mapper.
+    #
+    # @param at [Symbol] The path segment where Uchi should be mounted.
     def mount(host_routes, at: default_at)
+      @mount_at = (at || default_at).to_sym
       host_routes.mount(
         Uchi::Engine,
-        at: at
+        as: mount_as,
+        at: mount_at
       )
 
-      draw_repository_routes(host_routes, at: at)
+      draw_repository_routes(host_routes, at: mount_at)
     end
 
     def draw_root_route(routes, repository:, at: default_at)
       return unless repository
 
-      routes.namespace(at) do
+      routes.namespace(at, as: mount_as) do
         routes.root to: "#{repository.controller_name}#index"
       end
     end
@@ -28,7 +35,7 @@ module Uchi
       repositories = Uchi::Repository.all
       repositories.each do |repository_class|
         resources_name = repository_class.controller_name
-        routes.namespace(at) do
+        routes.namespace(at, as: mount_as) do
           routes.resources(resources_name)
         end
       end
@@ -36,10 +43,25 @@ module Uchi
       draw_root_route(routes, at: at, repository: repositories.first)
     end
 
+    # Returns the name to use when generating routing helper method names
+    def mount_as
+      :uchi
+    end
+
+    # Returns the path prefix for the routes, i.e. the first URL segment where
+    # Uchi can be requested.
+    def mount_at
+      @mount_at ||= default_at
+    end
+
     private
 
     def default_at
-      "uchi"
+      :uchi
+    end
+
+    def mount_path
+      mount_at
     end
   end
 end

data/lib/uchi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Uchi
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

data/lib/uchi.rb

@@ -11,12 +11,17 @@ require "uchi/action"
 require "uchi/action_response"
 require "uchi/field"
 require "uchi/i18n"
+require "uchi/plugins"
 require "uchi/repository"
 require "uchi/routes"
 require "uchi/sort_order"
 require "uchi/repository/translate"
 
 module Uchi
+  def self.plugins
+    @plugins ||= Plugins.new
+  end
+
   def self.routes
     @routes ||= Routes.new
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uchi
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Jakob Skjerning
@@ -169,6 +169,7 @@ files:
 - app/components/uchi/flowbite/input_field/url.rb
 - app/components/uchi/flowbite/link.rb
 - app/components/uchi/flowbite/style.rb
+- app/components/uchi/flowbite/styles.rb
 - app/components/uchi/flowbite/toast.rb
 - app/components/uchi/flowbite/toast/icon.html.erb
 - app/components/uchi/flowbite/toast/icon.rb
@@ -262,6 +263,7 @@ files:
 - lib/uchi/pagy/toolbox/helpers/page_url.rb
 - lib/uchi/pagy/toolbox/paginators/method.rb
 - lib/uchi/pagy/toolbox/paginators/offset.rb
+- lib/uchi/plugins.rb
 - lib/uchi/repository.rb
 - lib/uchi/repository/routes.rb
 - lib/uchi/repository/translate.rb