uchi 0.1.4 → 0.1.6

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

@@ -0,0 +1,9 @@
+<nav
+  class="
+    w-64 h-full px-3 py-4 overflow-y-auto shrink-0
+    bg-neutral-secondary-medium
+  "
+  aria-label="Main"
+>
+  <%= render Uchi::Ui::Navigation.new %>
+</nav>

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

@@ -1,12 +1,12 @@
-<%- content_for(:page_title) { @repository.translate.title(:edit, record: @record) } %>
+<%- content_for(:page_title) { @repository.translate.title_for_edit(@record) } %>
 
 <%= render(
   Uchi::Ui::PageHeader.new(
     description: @repository.translate.description(:edit),
-    title: @repository.translate.title(:edit, record: @record),
+    title: @repository.translate.title_for_edit(@record),
   )) do |header| %>
   <% header.with_breadcrumb(items: [
-    {href: @repository.routes.root_path, label: Rails.application.name.titlecase },
+    {href: @repository.routes.root_path, label: @repository.translate.breadcrumb_label_for_root },
     {href: @repository.routes.path_for(:index), label: @repository.translate.breadcrumb_label(:index) },
     {href: @repository.routes.path_for(:show, id: @record.id), label: @repository.translate.breadcrumb_label(:show, record: @record) },
     {href: @repository.routes.path_for(:edit, id: @record.id), label: @repository.translate.breadcrumb_label(:edit, record: @record) }
@@ -14,7 +14,7 @@
 <% end %>
 
 <div class="mx-4 md:mx-0">
-  <%= render(Flowbite::Card.new) do %>
+  <%= 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| %>
@@ -31,7 +31,7 @@
         <% end %>
 
         <%= render(Uchi::Ui::Form::Footer.new) do |footer| %>
-          <%= footer.with_action { render(Flowbite::Button.new) { @repository.translate.submit_button } } %>
+          <%= footer.with_action { render(Uchi::Flowbite::Button.new) { @repository.translate.submit_button } } %>
           <%= footer.with_action { link_to(@repository.translate.link_to_cancel, path_for_cancel(default: @repository.routes.path_for(:show, id: @record.id))) } %>
         <% end %>
       </div>

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

@@ -1,15 +1,16 @@
-<%- content_for(:page_title) { @repository.translate.title(:index) } %>
+<%- content_for(:page_title) { @repository.translate.title_for_index } %>
 
 <%= render(
   Uchi::Ui::PageHeader.new(
     description: @repository.translate.description(:index),
-    title: @repository.translate.title(:index),
+    title: @repository.translate.title_for_index,
   )) do |header| %>
   <% header.with_action do %>
-    <%= link_to(@repository.translate.link_to_new, @repository.routes.path_for(:new), class: Flowbite::Button.classes) %>
+    <%= link_to(@repository.translate.link_to_new, @repository.routes.path_for(:new), class: Uchi::Flowbite::Button.classes) %>
   <% end %>
+
   <% header.with_breadcrumb(items: [
-    {href: @repository.routes.root_path, label: Rails.application.name.titlecase },
+    {href: @repository.routes.root_path, label: @repository.translate.breadcrumb_label_for_root },
     {href: @repository.routes.path_for(:index), label: @repository.translate.breadcrumb_label(:index) }
   ]) %>
 <% end %>
@@ -19,12 +20,19 @@
     repository: @repository,
     scope: (scoped? ? scope_params : nil),
   )) do %>
-    <div class="relative overflow-x-auto bg-white border border-gray-200 shadow-sm md:rounded-lg dark:bg-gray-800 dark:border-gray-700">
+    <%# Styles from https://flowbite.com/docs/components/tables/#default-table %>
+    <div
+      class="
+        relative overflow-x-auto bg-neutral-primary-soft rounded-base border
+        border-default shadow-xs
+      "
+    >
       <% if @repository.searchable? %>
         <div class="px-3 py-3">
           <%= render(Uchi::Ui::Index::RecordsTable::SearchForm.new(params: params, repository: @repository)) %>
         </div>
       <% end %>
+
       <% if @records.any? %>
         <%= render(Uchi::Ui::Index::RecordsTable.new(
           columns: @columns,
@@ -35,11 +43,12 @@
           scope: (scoped? ? scope_params : nil),
         )) %>
       <% else %>
-        <div class="p-6 text-center text-gray-500 dark:text-gray-400">
+        <div class="p-6 text-center text-body-subtle">
           <%= @repository.translate.no_records_found %>
         </div>
       <% end %>
     </div>
+
     <% if @records.any? %>
       <div class="my-4 flex justify-center">
         <%= render(Uchi::Ui::Pagination.new(paginator: @paginator)) %>

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

@@ -1,18 +1,18 @@
-<%- content_for(:page_title) { @repository.translate.title(:new) } %>
+<%- content_for(:page_title) { @repository.translate.title_for_new } %>
 
 <%= render(
   Uchi::Ui::PageHeader.new(
     description: @repository.translate.description(:new),
-    title: @repository.translate.title(:new),
+    title: @repository.translate.title_for_new,
   )) do |header| %>
   <% header.with_breadcrumb(items: [
-    {href: @repository.routes.root_path, label: Rails.application.name.titlecase },
+    {href: @repository.routes.root_path, label: @repository.translate.breadcrumb_label_for_root },
     {href: @repository.routes.path_for(:index), label: @repository.translate.breadcrumb_label(:index) },
     {href: @repository.routes.path_for(:new), label: @repository.translate.breadcrumb_label(:new) }
   ]) %>
 <% end %>
 
-<%= render(Flowbite::Card.new) do %>
+<%= 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| %>
@@ -29,7 +29,7 @@
       <% end %>
 
       <%= render(Uchi::Ui::Form::Footer.new) do |footer| %>
-        <%= footer.with_action { render(Flowbite::Button.new) { @repository.translate.submit_button } } %>
+        <%= footer.with_action { render(Uchi::Flowbite::Button.new) { @repository.translate.submit_button } } %>
         <%= footer.with_action { link_to(@repository.translate.link_to_cancel, path_for_cancel(default: @repository.routes.path_for(:index))) } %>
       <% end %>
     </div>

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

@@ -1,17 +1,27 @@
-<%- content_for(:page_title) { @repository.translate.title(:show, record: @record) } %>
+<%- content_for(:page_title) { @repository.translate.title_for_show(@record) } %>
 
 <%= render(
   Uchi::Ui::PageHeader.new(
     description: @repository.translate.description(:show, record: @record),
-    title: @repository.translate.title(:show, record: @record),
+    title: @repository.translate.title_for_show(@record),
   )
 ) do |header| %>
+  <% if @repository.actions.any? %>
+    <% header.with_action do %>
+      <%= render(Uchi::Ui::Actions::Dropdown.new(
+        actions: @repository.actions,
+        record: @record,
+        repository: @repository
+      )) %>
+    <% end %>
+  <% end %>
+
   <% header.with_action do %>
     <%= button_to(
       @repository.translate.link_to_destroy(@record),
       @repository.routes.path_for(:destroy, id: @record.id),
       method: :delete,
-      class: Flowbite::Button.classes(style: :red),
+      class: Uchi::Flowbite::Button.classes(style: :danger),
       data: {
         :"turbo-confirm" => @repository.translate.destroy_dialog_title(@record)
       }
@@ -19,11 +29,11 @@
   <% end %>
 
   <% header.with_action do %>
-    <%= link_to(@repository.translate.link_to_edit(@record), @repository.routes.path_for(:edit, id: @record.id), class: Flowbite::Button.classes) %>
+    <%= link_to(@repository.translate.link_to_edit(@record), @repository.routes.path_for(:edit, id: @record.id), class: Uchi::Flowbite::Button.classes) %>
   <% end %>
 
   <% header.with_breadcrumb(items: [
-      {href: @repository.routes.root_path, label: Rails.application.name.titlecase },
+      {href: @repository.routes.root_path, label: @repository.translate.breadcrumb_label_for_root },
       {href: @repository.routes.path_for(:index), label: @repository.translate.breadcrumb_label(:index) },
       {href: @repository.routes.path_for(:show, id: @record.id), label: @repository.translate.breadcrumb_label(:show, record: @record) }
     ]) %>
@@ -36,6 +46,7 @@
 )) %>
 
 <% association_fields = @repository.fields_for_show.select{ |field| field.group_as(:show) == :associations } %>
+
 <% association_fields.each do |field| %>
   <%= render(field.show_component(record: @record, repository: @repository)) %>
 <% end %>

data/lib/generators/uchi/controller/templates/controller.rb.tt

@@ -2,10 +2,5 @@
 
 module Uchi
   class <%= name.pluralize %>Controller < Uchi::RepositoryController
-    private
-
-    def repository_class
-      Uchi::Repositories::<%= class_name %>
-    end
   end
 end

data/lib/generators/uchi/scaffold/scaffold_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rails/generators/rails/resource/resource_generator"
+
+module Uchi
+  class ScaffoldGenerator < Rails::Generators::ResourceGenerator # :nodoc:
+    remove_hook_for :resource_controller
+    remove_hook_for :resource_route
+    remove_class_option :actions
+
+    def generate_repository
+      generate("uchi:repository", name)
+    end
+  end
+end

data/lib/uchi/action.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Uchi
+  # Base class for all Uchi actions.
+  #
+  # Actions allow you to perform custom operations on one or more records from
+  # a repository. Examples include publishing posts, exporting data, or sending
+  # notifications.
+  #
+  # To create an action, subclass this class and implement the `perform` method:
+  #
+  #   class PublishPost < Uchi::Action
+  #     def perform(records, input = {})
+  #       records.each { |record| record.update!(published: true) }
+  #       Uchi::ActionResponse.success("Published #{records.size} posts")
+  #     end
+  #   end
+  #
+  # Actions are registered on repositories via the `actions` method:
+  #
+  #   class PostRepository < Uchi::Repository
+  #     def actions
+  #       [PublishPost.new]
+  #     end
+  #   end
+  class Action
+    # Returns the display name for this action.
+    #
+    # By default, this looks up the translation key
+    # `uchi.action.[action_key].name` and falls back to the humanized class
+    # name.
+    #
+    # @return [String]
+    def name
+      translate(:name, default: self.class.name.demodulize.titleize)
+    end
+
+    # Returns the list of fields to show in the action form.
+    #
+    # Fields are instances of Uchi::Field subclasses (e.g., Field::String,
+    # Field::Boolean).
+    #
+    # @return [Array<Uchi::Field>]
+    def fields
+      []
+    end
+
+    # Performs the action on the given records.
+    #
+    # This method must be implemented in subclasses.
+    #
+    # @param records [ActiveRecord::Relation, Array] - The records to operate on
+    # @param input [Hash] - Hash of field values from the action form
+    # @return [Uchi::ActionResponse]
+    def perform(records, input = {})
+      raise NotImplementedError, "#{self.class}#perform must be implemented"
+    end
+
+    # Returns true if this action requires input fields.
+    #
+    # @return [Boolean]
+    def requires_input?
+      fields.any?
+    end
+
+    private
+
+    # Looks up i18n key with fallback
+    # @param key [Symbol] - the key to look up (e.g., :name)
+    # @param default [String] - fallback value
+    # @param options [Hash] - additional i18n options (count, etc.)
+    # @return [String, nil]
+    def translate(key, default:, **options)
+      i18n_key = "action.#{translation_key}.#{key}"
+      Uchi::I18n.translate(i18n_key, default: default, **options)
+    end
+
+    # Returns the i18n key segment for this action
+    # Example: PublishPost -> "publish_post"
+    def translation_key
+      self.class.name.underscore.tr("/", ".")
+    end
+  end
+end

data/lib/uchi/action_response.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Uchi
+  # Represents the response from executing an action.
+  #
+  # ActionResponse uses a builder pattern for fluent chaining:
+  #
+  #   ActionResponse.success("Done").redirect_to(path: "/posts")
+  #   ActionResponse.error("Failed").message("Try again later")
+  #   ActionResponse.success("Exported").download(file_path: path, filename: "data.csv")
+  class ActionResponse
+    attr_reader :status, :message_text, :redirect_path, :file_path, :filename, :turbo_stream_block
+
+    # Creates a successful response with an optional message.
+    #
+    # @param message [String, nil] - Success message to display
+    # @return [ActionResponse]
+    def self.success(message = nil)
+      new(status: :success, message: message)
+    end
+
+    # Creates an error response with an optional message.
+    #
+    # @param message [String, nil] - Error message to display
+    # @return [ActionResponse]
+    def self.error(message = nil)
+      new(status: :error, message: message)
+    end
+
+    def initialize(status:, message: nil)
+      @status = status
+      @message_text = message
+    end
+
+    # Sets the message to display.
+    #
+    # @param text [String] - The message text
+    # @return [ActionResponse] self for chaining
+    def message(text)
+      @message_text = text
+      self
+    end
+
+    # Sets a redirect path.
+    #
+    # @param path [String] - The path to redirect to
+    # @return [ActionResponse] self for chaining
+    def redirect_to(path:)
+      @redirect_path = path
+      self
+    end
+
+    # Sets a file to download.
+    #
+    # @param file_path [String] - Path to the file
+    # @param filename [String] - Name for the downloaded file
+    # @return [ActionResponse] self for chaining
+    def download(file_path:, filename:)
+      @file_path = file_path
+      @filename = filename
+      self
+    end
+
+    # Sets a custom Turbo Stream response.
+    #
+    # @yield [stream] Provides a Turbo Stream builder
+    # @return [ActionResponse] self for chaining
+    def turbo_stream(&block)
+      @turbo_stream_block = block
+      self
+    end
+
+    # Returns true if this is a success response.
+    #
+    # @return [Boolean]
+    def success?
+      status == :success
+    end
+
+    # Returns true if this is an error response.
+    #
+    # @return [Boolean]
+    def error?
+      status == :error
+    end
+
+    # Returns true if this response includes a redirect.
+    #
+    # @return [Boolean]
+    def redirect?
+      !redirect_path.nil?
+    end
+
+    # Returns true if this response includes a download.
+    #
+    # @return [Boolean]
+    def download?
+      !file_path.nil?
+    end
+
+    # Returns true if this response includes a custom Turbo Stream.
+    #
+    # @return [Boolean]
+    def turbo_stream?
+      !turbo_stream_block.nil?
+    end
+  end
+end

data/lib/uchi/repository/translate.rb

@@ -5,6 +5,20 @@ module Uchi
     class Translate
       attr_reader :repository
 
+      # Returns the label for the actions button in the UI.
+      #
+      # Returns the first of the following that is present:
+      # 1. uchi.repository.author.button.actions
+      # 2. uchi.common.actions
+      # 3. "Actions"
+      def actions_button_label
+        first_present_value(
+          translate(i18n_scope("button.actions"), default: nil),
+          translate("common.actions", default: nil),
+          "Actions"
+        )
+      end
+
       # Returns the breadcrumb label for the given page.
       #
       # Example translation key:
@@ -39,11 +53,23 @@ module Uchi
           translate(i18n_scope("breadcrumb.index.label"), default: nil),
           translate(i18n_scope("index.title"), default: nil),
           plural_name,
-          translate("common.index"),
+          translate("common.index", default: nil),
           "Index"
         )
       end
 
+      # Returns the label for the root breadcrumb item. Defaults to the
+      # application name.
+      #
+      # To customize this provide a translation for the key:
+      # `uchi.breadcrumb.root.label`
+      def breadcrumb_label_for_root
+        first_present_value(
+          translate("breadcrumb.root.label", default: nil),
+          Rails.application.name.titlecase
+        )
+      end
+
       # Returns a description for the given page, or nil if none is found.
       # This description is intended to provide additional context for the page
       # being shown.
@@ -126,30 +152,53 @@ module Uchi
       end
 
       def link_to_destroy(record)
-        translate(
-          "link_to_destroy",
-          default: "Delete",
-          model: singular_name,
-          record: repository.title(record),
-          scope: i18n_scope("button")
+        first_present_value(
+          translate(
+            "link_to_destroy",
+            default: nil,
+            model: singular_name,
+            record: repository.title(record),
+            scope: i18n_scope("button")
+          ),
+          translate(
+            "common.destroy",
+            default: nil,
+            model: singular_name,
+            record: repository.title(record)
+          ),
+          "Delete"
         )
       end
 
       def link_to_edit(record)
-        translate(
-          "link_to_edit",
-          default: "Edit",
-          model: singular_name,
-          record: repository.title(record),
-          scope: i18n_scope("button")
+        first_present_value(
+          translate(
+            "link_to_edit",
+            default: nil,
+            model: singular_name,
+            record: repository.title(record),
+            scope: i18n_scope("button")
+          ),
+          translate(
+            "common.edit",
+            default: nil,
+            model: singular_name,
+            record: repository.title(record)
+          ),
+          "Edit"
         )
       end
 
       # Returns the text for the "new" action link.
+      #
+      # Returns the first of the following translations that is present:
+      # 1. Translation from "uchi.repository.[name].button.link_to_new"
+      # 2. Translation from "uchi.common.new" with interpolation key %{model}
+      # 3. Default string "New %{model}"
       def link_to_new
         translate(
           "link_to_new",
-          default: "New %{model}", # rubocop:disable Style/FormatStringToken
+          default: translate("common.new", default: "New %{model}"),
           model: singular_name,
           scope: i18n_scope("button")
         )
@@ -159,6 +208,21 @@ module Uchi
         translate("loading", default: "Loading...", scope: "uchi.repository.common")
       end
 
+      # Returns the label for the navigation link to this repository's index
+      # page.
+      #
+      # Returns the first of the following that is present:
+      # 1. Translation from "uchi.repository.[name].navigation.label"
+      # 2. Translation from "uchi.repository.[name].index.title"
+      # 3. plural name of the model
+      def navigation_label
+        first_present_value(
+          translate(i18n_scope("navigation.label"), default: nil),
+          translate(i18n_scope("index.title"), default: nil),
+          plural_name
+        )
+      end
+
       # Returns the localized, human-readable plural name of the model this
       # repository manages.
       def plural_name
@@ -222,16 +286,50 @@ module Uchi
         )
       end
 
-      # Returns the title for the given page.
-      def title(page, record: nil)
-        return repository.title(record) if record && page == :show
+      def title_for_edit(record)
+        first_present_value(
+          translate(
+            "title",
+            default: nil,
+            model: singular_name,
+            record: repository.title(record),
+            scope: i18n_scope(:edit)
+          ),
+          link_to_edit(record)
+        )
+      end
 
+      def title_for_index
         translate(
           "title",
           default: plural_name,
           model: singular_name,
-          record: record,
-          scope: i18n_scope(page)
+          scope: i18n_scope(:index)
+        )
+      end
+
+      def title_for_show(record)
+        return repository.title(record) if record
+
+        translate(
+          "title",
+          default: plural_name,
+          model: singular_name,
+          scope: i18n_scope(:show)
+        )
+      end
+
+      # Returns the title for the "new" page.
+      #
+      # Returns the first of the following translations that is present:
+      # 1. Translation from "uchi.repository.[name].new.title"
+      # 2. Translation from "uchi.repository.[name].button.link_to_new"
+      # 3. Translation from "uchi.common.new" with interpolation key %{model}
+      # 4. Default string "New %{model}"
+      def title_for_new
+        first_present_value(
+          translate(i18n_scope("new.title"), default: nil),
+          link_to_new
         )
       end
 

data/lib/uchi/repository.rb

@@ -61,6 +61,16 @@ module Uchi
       apply_sort_order(query, sort_order)
     end
 
+    # Finds multiple records by their IDs. If a record is not found, it is
+    # ignored.
+    #
+    # @param ids [Array<Integer>] The IDs of the records to find
+    #
+    # @return [ActiveRecord::Relation] The found records
+    def find_many(ids)
+      model.where(id: ids)
+    end
+
     def find(id)
       model.find(id)
     end
@@ -74,6 +84,21 @@ module Uchi
       []
     end
 
+    # Returns the list of actions available for this repository.
+    #
+    # Actions are instances of Uchi::Action subclasses that can be executed
+    # on one or more records.
+    #
+    # Example:
+    #   def actions
+    #     [PublishPost.new, ExportToCsv.new]
+    #   end
+    #
+    # @return [Array<Uchi::Action>]
+    def actions
+      []
+    end
+
     def model
       self.class.model
     end

data/lib/uchi/version.rb

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

data/lib/uchi.rb

@@ -7,6 +7,8 @@ require "view_component"
 require "uchi/version"
 require "uchi/engine"
 
+require "uchi/action"
+require "uchi/action_response"
 require "uchi/field"
 require "uchi/i18n"
 require "uchi/repository"