uchi 0.1.2 → 0.1.4

data/app/components/uchi/ui/pagination/next_link.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Uchi
+  module Ui
+    class Pagination
+      class NextLink < Item
+        # Returns true if there is a next page
+        def next?
+          paginator.next.present?
+        end
+
+        def url
+          if next?
+            page_url(:next)
+          else
+            page_url(:last)
+          end
+        end
+      end
+    end
+  end
+end

data/app/components/uchi/ui/pagination/pagination.html.erb

@@ -0,0 +1,15 @@
+<nav aria-label="<%= aria_label %>">
+  <ul class="flex items-center -space-x-px h-8 text-sm">
+    <%= render(Uchi::Ui::Pagination::PreviousLink.new(paginator: @paginator)) %>
+    <% pages.each do |page_number| %>
+      <% if page_number.nil? %>
+        <%= render(Uchi::Ui::Pagination::Gap.new(page_number: page_number, paginator: @paginator)) %>
+      <% elsif page_number == @paginator.page %>
+        <%= render(Uchi::Ui::Pagination::CurrentLink.new(page_number: page_number, paginator: @paginator)) %>
+      <% else %>
+        <%= render(Uchi::Ui::Pagination::Link.new(page_number: page_number, paginator: @paginator)) %>
+      <% end %>
+    <% end %>
+    <%= render(Uchi::Ui::Pagination::NextLink.new(paginator: @paginator)) %>
+  </ul>
+</nav>

data/app/components/uchi/ui/pagination/previous_link.html.erb

@@ -0,0 +1,8 @@
+<li>
+  <%= link_to(url, class: "flex items-center justify-center px-3 h-8 ms-0 leading-tight text-gray-500 bg-white border border-e-0 border-gray-300 rounded-s-lg hover:bg-gray-100 hover:text-gray-700 dark:bg-gray-800 dark:border-gray-700 dark:text-gray-400 dark:hover:bg-gray-700 dark:hover:text-white") do %>
+    <span class="sr-only">Previous</span>
+    <svg class="w-3 h-3 rtl:rotate-180" aria-hidden="true" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 6 10">
+      <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M5 1 1 5l4 4"/>
+    </svg>
+  <% end %>
+</li>

data/app/components/uchi/ui/pagination/previous_link.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Uchi
+  module Ui
+    class Pagination
+      class PreviousLink < Item
+        # Returns true if there is a previous page
+        def previous?
+          paginator.page > 1
+        end
+
+        def url
+          if previous?
+            page_url(:previous)
+          else
+            page_url(:first)
+          end
+        end
+      end
+    end
+  end
+end

data/app/components/uchi/ui/pagination.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Uchi
+  module Ui
+    class Pagination < ViewComponent::Base
+      attr_reader :paginator
+
+      def aria_label
+        "Page navigation"
+      end
+
+      # @param paginator [Pagy::Pagy] The Pagy object
+      def initialize(paginator:)
+        super()
+        @paginator = paginator
+      end
+
+      # Returns the URL for a given page. page can be a number, of :first,
+      # :last, :previous, :next, :current.
+      def page_url(page)
+        paginator.page_url(page)
+      end
+
+      # Returns an array of page numbers to display in the pagination component
+      def pages
+        pages = []
+        pages += [1]
+        pages += (paginator.page - 2..paginator.page + 2).to_a
+        pages += [paginator.last]
+        pages = pages.select { |page| page.between?(1, paginator.last) }.uniq.sort
+
+        result = []
+        pages.each_with_index do |page, index|
+          result << page
+          next_page = pages[index + 1]
+          if index < pages.size - 1 && next_page - page > 1
+            result << nil # Add a gap
+          end
+        end
+        result
+      end
+
+      def render?
+        paginator.present?
+      end
+    end
+  end
+end

data/app/components/uchi/ui/show/attribute_fields/attribute_fields.html.erb

@@ -0,0 +1,14 @@
+<%= render(Uchi::Ui::Frame.new) do %>
+  <dl class="divide-y divide-gray-200 dark:divide-white/5">
+    <% attribute_fields.each do |field| %>
+      <div class="px-4 py-4 sm:grid sm:grid-cols-4 sm:gap-4 sm:px-6">
+        <dt class="font-semibold text-gray-900 dark:text-white">
+          <%= repository.translate.field_label(field) %>
+        </dt>
+        <dd class="font-light text-gray-500 dark:text-gray-400 col-span-3">
+          <%= render(field.show_component(record: record, repository: repository)) %>
+        </dd>
+      </div>
+    <% end %>
+  </dl>
+<% end %>

data/app/components/uchi/ui/show/attribute_fields.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Uchi
+  module Ui
+    module Show
+      class AttributeFields < ViewComponent::Base
+        attr_reader :attribute_fields, :record, :repository
+
+        def initialize(attribute_fields:, record:, repository:)
+          super()
+          @attribute_fields = attribute_fields
+          @record = record
+          @repository = repository
+        end
+      end
+    end
+  end
+end

data/app/components/uchi/ui/spinner/spinner.html.erb

@@ -0,0 +1,7 @@
+<div role="status">
+  <svg aria-hidden="true" class="w-8 h-8 text-gray-200 animate-spin dark:text-gray-600 fill-blue-600" viewBox="0 0 100 101" fill="none" xmlns="http://www.w3.org/2000/svg">
+    <path d="M100 50.5908C100 78.2051 77.6142 100.591 50 100.591C22.3858 100.591 0 78.2051 0 50.5908C0 22.9766 22.3858 0.59082 50 0.59082C77.6142 0.59082 100 22.9766 100 50.5908ZM9.08144 50.5908C9.08144 73.1895 27.4013 91.5094 50 91.5094C72.5987 91.5094 90.9186 73.1895 90.9186 50.5908C90.9186 27.9921 72.5987 9.67226 50 9.67226C27.4013 9.67226 9.08144 27.9921 9.08144 50.5908Z" fill="currentColor"/>
+    <path d="M93.9676 39.0409C96.393 38.4038 97.8624 35.9116 97.0079 33.5539C95.2932 28.8227 92.871 24.3692 89.8167 20.348C85.8452 15.1192 80.8826 10.7238 75.2124 7.41289C69.5422 4.10194 63.2754 1.94025 56.7698 1.05124C51.7666 0.367541 46.6976 0.446843 41.7345 1.27873C39.2613 1.69328 37.813 4.19778 38.4501 6.62326C39.0873 9.04874 41.5694 10.4717 44.0505 10.1071C47.8511 9.54855 51.7191 9.52689 55.5402 10.0491C60.8642 10.7766 65.9928 12.5457 70.6331 15.2552C75.2735 17.9648 79.3347 21.5619 82.5849 25.841C84.9175 28.9121 86.7997 32.2913 88.1811 35.8758C89.083 38.2158 91.5421 39.6781 93.9676 39.0409Z" fill="currentFill"/>
+  </svg>
+  <span class="sr-only"><%= message %></span>
+</div>

data/app/components/uchi/ui/spinner.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Uchi
+  module Ui
+    # https://flowbite.com/docs/components/spinner/
+    class Spinner < ViewComponent::Base
+      attr_reader :message
+
+      def initialize(message: "Loading...")
+        super()
+        @message = message
+      end
+    end
+  end
+end

data/app/controllers/uchi/application_controller.rb

@@ -0,0 +1,4 @@
+module Uchi
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/uchi/controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Uchi
+  class Controller < ActionController::Base
+    layout "uchi/application"
+
+    protected
+
+    helper_method def uchi_user
+      current_user
+    end
+  end
+end

data/app/controllers/uchi/repository_controller.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+require "uchi/pagination/controller"
+
+module Uchi
+  class RepositoryController < Uchi::ApplicationController
+    include Uchi::Pagination::Controller
+
+    before_action :set_repository
+
+    def create
+      @record = build_record
+      if @record.save
+        flash[:success] = @repository.translate.successful_create
+        redirect_to(@repository.routes.path_for(:show, id: @record.id), status: :see_other)
+      else
+        render :new, status: :unprocessable_entity
+      end
+    end
+
+    def destroy
+      @record = find_record
+      if @record.destroy
+        flash[:success] = @repository.translate.successful_destroy
+        redirect_to(@repository.routes.path_for(:index), status: :see_other)
+      else
+        flash[:alert] = @repository.translate.failed_destroy
+        redirect_to(@repository.routes.path_for(:show, id: @record.id), status: :see_other)
+      end
+    end
+
+    def edit
+      @record = find_record
+    end
+
+    def index
+      if params[:scope]
+        # Handle being shown inline in another record's show view
+        parent_repository = Uchi::Repository.for_model(params[:scope][:model])&.new
+        parent_record = parent_repository.find(params[:scope][:id])
+        field_name = params[:scope][:field]
+        inverse_of = params[:scope][:inverse_of]&.to_sym
+
+        @columns = @repository.fields_for_index
+        @columns = @columns.reject { |field| field.name == inverse_of } if inverse_of
+        @records = find_all_records_from_association(name: field_name, parent_record: parent_record)
+        @paginator, @records = paginate(@records, records_per_page: scoped_records_per_page)
+      else
+        # Handle the normal case
+        @columns = @repository.fields_for_index
+        @records = find_all_records
+        @paginator, @records = paginate(@records, records_per_page: index_records_per_page)
+      end
+    end
+
+    def new
+      @record = build_record
+    end
+
+    def show
+      @record = find_record
+    end
+
+    def update
+      @record = find_record
+      if @record.update(record_params)
+        flash[:success] = @repository.translate.successful_update
+        redirect_to(@repository.routes.path_for(:show, id: @record.id, uniq: rand), status: :see_other)
+      else
+        render :edit, status: :unprocessable_entity
+      end
+    end
+
+    private
+
+    def build_record
+      @repository.build(record_params)
+    end
+
+    # Returns the path to use for the cancel link
+    helper_method def path_for_cancel(default:)
+      return default unless scoped?
+
+      parent_model_name = scope[:model]
+      parent_repository = Uchi::Repository.for_model(parent_model_name)&.new
+      raise NameError, "No repository found for scoped model #{parent_model_name}" unless parent_repository
+
+      parent_model_id = scope[:id]
+      parent_repository.routes.path_for(:show, id: parent_model_id)
+    end
+
+    helper_method def current_sort_order
+      @current_sort_order ||= SortOrder.from_params(params) || @repository.default_sort_order
+    end
+
+    def find_all_records(scope: nil)
+      @repository
+        .find_all(
+          scope: scope,
+          search: params[:query],
+          sort_order: current_sort_order
+        )
+    end
+
+    def find_all_records_from_association(name:, parent_record:)
+      association = parent_record.class.reflect_on_association(name.to_sym)
+      raise NameError, "No association named #{name} on #{parent_record.class}" unless association
+
+      source_repository = Uchi::Repository.for_model(association.active_record)&.new
+      raise NameError, "No repository found for scoped model #{association.active_record}" unless source_repository
+
+      associated_repository = Uchi::Repository.for_model(association.klass)&.new
+      raise NameError, "No repository found for associated model #{association.klass}" unless associated_repository
+
+      field = source_repository.fields.find { |f| f.name == name.to_sym }
+      raise NameError, "No field named #{name} on #{source_repository.model}" unless field
+
+      scope = parent_record.association(name.to_sym).scope
+      find_all_records(scope: scope)
+    end
+
+    def find_record
+      @record = @repository.find(params[:id])
+    end
+
+    # Returns the number of records per page to show in index views
+    def index_records_per_page
+      25
+    end
+
+    def record_params
+      permitted_params = @repository.fields_for_edit.map(&:permitted_param)
+      (params[@repository.model_param_key] || ActionController::Parameters.new)
+        .permit(*permitted_params)
+    end
+
+    def repository_class
+      raise NotImplementedError, "Subclasses must implement repository_class"
+    end
+
+    helper_method def scope_params
+      if scoped?
+        scope.permit(:field, :id, :inverse_of, :model)
+      else
+        ActionController::Parameters.new
+      end
+    end
+
+    # Returns the scope that we're currently operating within, if any.
+    def scope
+      params[:scope]
+    end
+
+    helper_method def scoped?
+      scope.present?
+    end
+
+    def scoped_records_per_page
+      5
+    end
+
+    def set_repository
+      @repository = repository_class.new
+    end
+  end
+end

data/app/helpers/uchi/application_helper.rb

@@ -0,0 +1,17 @@
+module Uchi
+  module ApplicationHelper
+    # Maps Rails flash types to Flowbite Toast styles
+    def flash_style(flash_type)
+      case flash_type.to_sym
+      when :success
+        :success
+      when :alert, :error
+        :danger
+      when :warning
+        :warning
+      else
+        :default
+      end
+    end
+  end
+end

data/app/jobs/uchi/application_job.rb

@@ -0,0 +1,4 @@
+module Uchi
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/uchi/application_mailer.rb

@@ -0,0 +1,6 @@
+module Uchi
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

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

@@ -0,0 +1,10 @@
+<% if flash.any? %>
+  <div class="fixed bottom-4 right-4 z-50 space-y-4">
+    <% flash.to_hash.each do |type, message| %>
+      <%= render Flowbite::Toast.new(
+        message: message,
+        style: flash_style(type),
+      ) %>
+    <% end %>
+  </div>
+<% end %>

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

@@ -0,0 +1,33 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= content_for?(:page_title) ? yield(:page_title) : "Uchi" %></title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+    <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" %>
+  </head>
+  <body class="antialiased bg-gray-50 dark:bg-gray-900 p-2">
+    <div class="md:flex">
+      <nav class="w-64 h-full px-3 py-4 overflow-y-auto shrink-0 bg-gray-50 dark:bg-gray-800" aria-label="Main">
+        <ul class="space-y-2 font-medium">
+          <% Uchi::Repository.all.map { |repository| repository.new }.sort_by { |repository| repository.translate.plural_name.downcase }.each do |repository| %>
+            <li>
+              <%= link_to(repository.routes.path_for(:index), :class => "flex items-center p-2 text-gray-900 rounded-lg dark:text-white hover:bg-gray-100 dark:hover:bg-gray-700 group") do %>
+                <span class="ms-3"><%= repository.translate.plural_name.titlecase %></span>
+              <% end %>
+            </li>
+          <% end %>
+        </ul>
+      </nav>
+
+      <main class="py-6 overflow-x-hidden grow md:px-6">
+        <%= yield %>
+      </main>
+    </div>
+
+    <%= render "layouts/uchi/flash_messages" %>
+  </body>
+</html>

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

@@ -0,0 +1,40 @@
+<%- content_for(:page_title) { @repository.translate.title(:edit, record: @record) } %>
+
+<%= render(
+  Uchi::Ui::PageHeader.new(
+    description: @repository.translate.description(:edit),
+    title: @repository.translate.title(:edit, record: @record),
+  )) do |header| %>
+  <% header.with_breadcrumb(items: [
+    {href: @repository.routes.root_path, label: Rails.application.name.titlecase },
+    {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) }
+  ]) %>
+<% end %>
+
+<div class="mx-4 md:mx-0">
+  <%= render(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| %>
+          <div>
+            <%= render(
+              field.edit_component(
+                form: form,
+                repository: @repository,
+                label: @repository.translate.field_label(field),
+                hint: @repository.translate.field_hint(field)
+              )
+            ) %>
+          </div>
+        <% end %>
+
+        <%= render(Uchi::Ui::Form::Footer.new) do |footer| %>
+          <%= footer.with_action { render(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>
+    <% end %>
+  <% end %>
+</div>

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

@@ -0,0 +1,49 @@
+<%- content_for(:page_title) { @repository.translate.title(:index) } %>
+
+<%= render(
+  Uchi::Ui::PageHeader.new(
+    description: @repository.translate.description(:index),
+    title: @repository.translate.title(:index),
+  )) do |header| %>
+  <% header.with_action do %>
+    <%= link_to(@repository.translate.link_to_new, @repository.routes.path_for(:new), class: Flowbite::Button.classes) %>
+  <% end %>
+  <% header.with_breadcrumb(items: [
+    {href: @repository.routes.root_path, label: Rails.application.name.titlecase },
+    {href: @repository.routes.path_for(:index), label: @repository.translate.breadcrumb_label(:index) }
+  ]) %>
+<% end %>
+
+<div class="mx-0">
+  <%= render(Uchi::Ui::Index::TurboFrame.new(
+    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">
+      <% 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,
+          sort_order: current_sort_order,
+          query: params[:query],
+          records: @records,
+          repository: @repository,
+          scope: (scoped? ? scope_params : nil),
+        )) %>
+      <% else %>
+        <div class="p-6 text-center text-gray-500 dark:text-gray-400">
+          <%= @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)) %>
+      </div>
+    <% end %>
+  <% end %>
+</div>

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

@@ -0,0 +1,37 @@
+<%- content_for(:page_title) { @repository.translate.title(:new) } %>
+
+<%= render(
+  Uchi::Ui::PageHeader.new(
+    description: @repository.translate.description(:new),
+    title: @repository.translate.title(:new),
+  )) do |header| %>
+  <% header.with_breadcrumb(items: [
+    {href: @repository.routes.root_path, label: Rails.application.name.titlecase },
+    {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 %>
+  <%= form_with model: @record, url: @repository.routes.path_for(:create) do |form| %>
+    <div class="space-y-6">
+      <% @repository.fields_for_edit.each do |field| %>
+        <div>
+          <%= render(
+            field.edit_component(
+              form: form,
+              repository: @repository,
+              label: @repository.translate.field_label(field),
+              hint: @repository.translate.field_hint(field)
+            )
+          ) %>
+        </div>
+      <% end %>
+
+      <%= render(Uchi::Ui::Form::Footer.new) do |footer| %>
+        <%= footer.with_action { render(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>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,41 @@
+<%- content_for(:page_title) { @repository.translate.title(:show, record: @record) } %>
+
+<%= render(
+  Uchi::Ui::PageHeader.new(
+    description: @repository.translate.description(:show, record: @record),
+    title: @repository.translate.title(:show, record: @record),
+  )
+) do |header| %>
+  <% 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),
+      data: {
+        :"turbo-confirm" => @repository.translate.destroy_dialog_title(@record)
+      }
+    ) %>
+  <% 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) %>
+  <% end %>
+
+  <% header.with_breadcrumb(items: [
+      {href: @repository.routes.root_path, label: Rails.application.name.titlecase },
+      {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) }
+    ]) %>
+<% end %>
+
+<%= render(Uchi::Ui::Show::AttributeFields.new(
+  attribute_fields: @repository.fields_for_show.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| %>
+  <%= render(field.show_component(record: @record, repository: @repository)) %>
+<% end %>

data/lib/generators/uchi/controller/controller_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Uchi
+  class ControllerGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path("templates", __dir__)
+
+    def create_controller_file
+      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/controller/templates/controller.rb.tt

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Uchi
+  class <%= name.pluralize %>Controller < Uchi::RepositoryController
+    private
+
+    def repository_class
+      Uchi::Repositories::<%= class_name %>
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Uchi
+  class InstallGenerator < Rails::Generators::Base
+    def create_namespace_in_routes
+      route "namespace :uchi do\nend"
+    end
+
+    def mount_engine
+      route "mount Uchi::Engine, at: \"/uchi\""
+    end
+  end
+end