uchi 0.1.6 → 0.1.8

data/app/controllers/uchi/has_many/associated_records_controller.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "uchi/pagination/controller"
+
+module Uchi
+  module HasMany
+    # Companion controller for the Stimulus-based has_many_controller.
+    #
+    # Provides backend support for fetching associated records for a has_many
+    # field via AJAX.
+    class AssociatedRecordsController < Uchi::ApplicationController
+      layout false
+
+      def index
+        @current_values = field.value(parent_record) || []
+
+        @field_name = params[:field]
+        @records = field.collection_query.call(find_all_records_from_association)
+      end
+
+      protected
+
+      helper_method def record_title(record)
+        return "" if record.nil?
+
+        associated_repository.title(record)
+      end
+
+      helper_method def source_repository
+        @source_repository ||= begin
+          model_name = params[:model]
+          repository_class = Uchi::Repository.for_model(model_name)
+          raise NameError, "No repository found for model #{model_name}" unless repository_class
+
+          repository_class.new
+        end
+      end
+
+      private
+
+      def associated_repository
+        @associated_repository ||= begin
+          associated_repository = Uchi::Repository.for_model(association.klass)&.new
+          raise NameError, "No repository found for associated model #{association.klass}" unless associated_repository
+
+          associated_repository
+        end
+      end
+
+      def association
+        @association ||= begin
+          association = source_repository.model.reflect_on_association(field.name.to_sym)
+          raise NameError, "No association named #{field.name} on #{source_repository.model}" unless association
+
+          association
+        end
+      end
+
+      def field
+        @field ||= begin
+          field_name = params[:field]
+          field = source_repository.fields.find { |f| f.name == field_name.to_sym }
+          raise NameError, "No field named #{field_name} on #{source_repository.model}" unless field
+
+          field
+        end
+      end
+
+      def find_all_records(repository:, scope: nil)
+        # Duplicated from Uchi::RepositoryController; consider refactoring.
+        repository
+          .find_all(
+            scope: scope,
+            search: params[:query]
+          )
+      end
+
+      def find_all_records_from_association
+        find_all_records(repository: associated_repository)
+      end
+
+      def parent_record
+        return nil unless params[:record_id].present?
+
+        source_repository.find(params[:record_id])
+      end
+    end
+  end
+end

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/_javascript.html.erb

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

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

@@ -0,0 +1 @@
+<%= stylesheet_link_tag "uchi/application", media: "all", "data-turbo-track": "reload" %>

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

@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html>
+<html class="h-full">
   <head>
     <title>
       <%= content_for?(:page_title) ? yield(:page_title) : "Uchi" %>
@@ -11,12 +11,12 @@
 
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-    <%= javascript_include_tag "uchi/application", "data-turbo-track" => "reload" %>
-    <%= stylesheet_link_tag "uchi/application", media: "all", "data-turbo-track": "reload" %>
+    <%= render "layouts/uchi/javascript" %>
+    <%= render "layouts/uchi/stylesheets" %>
   </head>
 
-  <body class="antialiased bg-neutral-secondary-medium p-2">
-    <div class="md:flex">
+  <body class="antialiased bg-neutral-secondary-medium h-full p-2">
+    <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/belongs_to/associated_records/index.html.erb

@@ -0,0 +1,13 @@
+<ul class="p-2 text-sm text-body font-medium">
+  <% @records.each do |record| %>
+    <li
+      class="inline-flex items-center w-full p-2 hover:bg-neutral-tertiary-medium hover:text-heading rounded aria-selected:bg-brand aria-selected:text-white"
+      data-action="belongs-to#selectOption"
+      data-id="<%= record.id %>"
+      id="<%= dom_id(record, [source_repository.model, @field_name].join("-")) %>"
+      role="option"
+    >
+      <%= record_title(record) %>
+    </li>
+  <% end %>
+</ul>

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

@@ -0,0 +1,26 @@
+<ul class="p-4 text-sm text-body font-medium space-y-4">
+  <% @records.each do |record| %>
+    <%
+      checkbox_id = dom_id(record, [source_repository.model, @field_name, 'checkbox'].join("-"))
+    %>
+    <li
+      data-id="<%= record.id %>"
+      id="<%= dom_id(record, [source_repository.model, @field_name].join("-")) %>"
+      role="option"
+    >
+      <div class="flex items-center">
+        <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"
+          data-action="change->has-many#handleCheckboxChange"
+          data-has-many-target="checkbox"
+          <%= 'checked' if @current_values.include?(record) %>
+        >
+        <label for="<%= checkbox_id %>" class="ms-2 text-sm font-medium text-heading cursor-pointer">
+          <%= record_title(record) %>
+        </label>
+      </div>
+    </li>
+  <% end %>
+</ul>

data/app/views/uchi/navigation/_main.html.erb

@@ -2,8 +2,91 @@
   class="
     w-64 h-full px-3 py-4 overflow-y-auto shrink-0
     bg-neutral-secondary-medium
+    hidden md:block
   "
   aria-label="Main"
 >
   <%= render Uchi::Ui::Navigation.new %>
 </nav>
+
+<div
+  class="md:hidden">
+  <button
+    aria-controls="main-navigation"
+    class="
+      text-body bg-transparent hover:text-heading
+      hover:bg-neutral-tertiary rounded-base w-9 h-9
+      flex items-center justify-center
+    "
+    popovertarget="main-navigation"
+    type="button"
+  >
+    <svg
+      aria-hidden="true"
+      class="w-6 h-6"
+      xmlns="http://www.w3.org/2000/svg"
+      width="24"
+      height="24"
+      fill="none"
+      viewBox="0 0 24 24"
+    >
+      <path
+        stroke="currentColor"
+        stroke-linecap="round"
+        stroke-width="2"
+        d="M5 7h14M5 12h14M5 17h14"
+      />
+    </svg>
+  </button>
+</div>
+
+<nav
+  aria-label="Main"
+  class="
+    fixed top-0 left-0 z-40 h-screen p-2
+    flex-col
+    bg-neutral-primary-soft w-80
+    border-e border-default
+    backdrop:bg-dark-backdrop/70
+  "
+  id="main-navigation"
+  popover
+  tabindex="-1"
+>
+  <div>
+    <button
+      aria-controls="main-navigation"
+      class="
+        text-body bg-transparent hover:text-heading
+        hover:bg-neutral-tertiary rounded-base w-9 h-9
+        flex items-center justify-center
+      "
+      popovertarget="main-navigation"
+      type="button"
+    >
+      <svg
+        aria-hidden="true"
+        class="w-5 h-5"
+        fill="none"
+        height="24"
+        viewBox="0 0 24 24"
+        width="24"
+        xmlns="http://www.w3.org/2000/svg"
+      >
+        <path
+          stroke="currentColor"
+          stroke-linecap="round"
+          stroke-linejoin="round"
+          stroke-width="2"
+          d="M6 18 17.94 6M18 18 6.06 6"
+        />
+      </svg>
+
+      <span class="sr-only">Close menu</span>
+    </button>
+  </div>
+
+  <div class="overflow-y-auto max-h-full">
+    <%= render Uchi::Ui::Navigation.new %>
+  </div>
+</nav>

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/generators/uchi/controller/controller_generator.rb

@@ -8,9 +8,5 @@ module Uchi
       destination = File.join("app/controllers/uchi")
       template "controller.rb", File.join(destination, "#{plural_file_name}_controller.rb")
     end
-
-    def add_route
-      route "resources :#{plural_file_name}", namespace: :uchi
-    end
   end
 end

data/lib/generators/uchi/install/install_generator.rb

@@ -7,7 +7,7 @@ module Uchi
     end
 
     def mount_engine
-      route "mount Uchi::Engine, at: \"/uchi\""
+      route "Uchi.routes.mount(self)"
     end
   end
 end

data/lib/uchi/field/configuration.rb

@@ -5,7 +5,7 @@ module Uchi
     module Configuration
       class Unset; end
 
-      DEFAULT_READER = ->(record, field_name) { record.public_send(field_name) }
+      DEFAULT_READER = ->(record, field_name) { record&.public_send(field_name) }
 
       def initialize(*args)
         super
@@ -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

@@ -12,6 +12,13 @@ module Uchi
         }
       end
 
+      # Returns the "name" of the controller that handles requests for this
+      # repository. Note that this is different from the controllers class name
+      # and is intended for generating URLs.
+      def controller_name
+        model_param_key.pluralize
+      end
+
       # Returns the repository for the given model, or nil if none is found.
       def for_model(model)
         all.find { |repository| repository.model.to_s == model.to_s }
@@ -21,6 +28,10 @@ module Uchi
       def model
         @model ||= name.demodulize.constantize
       end
+
+      def model_param_key
+        model.model_name.param_key
+      end
     end
 
     # Returns a new, unsaved instance of the model this repository manages.
@@ -32,7 +43,7 @@ module Uchi
     # repository. Note that this is different from the controllers class name
     # and is intended for generating URLs.
     def controller_name
-      model_param_key.pluralize
+      self.class.controller_name
     end
 
     def default_sort_order
@@ -40,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)
@@ -104,7 +128,7 @@ module Uchi
     end
 
     def model_param_key
-      model.model_name.param_key
+      self.class.model_param_key
     end
 
     # Returns an instance of Uchi::Repository::Routes for this repository,
@@ -174,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

@@ -0,0 +1,67 @@
+module Uchi
+  class Routes
+    # Mounts the Uchi engine routes onto the host application's routes.
+    #
+    # Example usage in host application's routes.rb that install Uchi at /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,
+        as: mount_as,
+        at: mount_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, as: mount_as) do
+        routes.root to: "#{repository.controller_name}#index"
+      end
+    end
+
+    def draw_repository_routes(routes, at: default_at)
+      repositories = Uchi::Repository.all
+      repositories.each do |repository_class|
+        resources_name = repository_class.controller_name
+        routes.namespace(at, as: mount_as) do
+          routes.resources(resources_name)
+        end
+      end
+
+      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
+    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.6"
+  VERSION = "0.1.8"
 end

data/lib/uchi.rb

@@ -11,10 +11,18 @@ 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
-  # Your code goes here...
+  def self.plugins
+    @plugins ||= Plugins.new
+  end
+
+  def self.routes
+    @routes ||= Routes.new
+  end
 end