katalyst-koi 4.18.0 → 5.0.0.alpha.1

data/lib/generators/koi/admin_route/admin_route_generator.rb

@@ -3,12 +3,20 @@
 require "rails/generators/named_base"
 require "rails/generators/resource_helpers"
 
+require_relative "../helpers/attribute_helpers"
+require_relative "../helpers/resource_helpers"
+
 module Koi
   class AdminRouteGenerator < Rails::Generators::NamedBase
-    include Rails::Generators::ResourceHelpers
+    include Helpers::AttributeHelpers
+    include Helpers::ResourceHelpers
 
     source_root File.expand_path("templates", __dir__)
 
+    argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+    class_option :force, type: :boolean, default: true
+
     def create_routes
       return if Pathname.new(destination_root).join("config/routes/admin.rb").exist?
 
@@ -16,7 +24,17 @@ module Koi
     end
 
     def add_route
-      route "resources :#{file_name.pluralize}", namespace: regular_class_path
+      route "resources :#{file_name.pluralize}"
+
+      if orderable?
+        resource_route "patch :order, on: :collection"
+      end
+
+      if archivable?
+        resource_route "put :restore, on: :collection"
+        resource_route "put :archive, on: :collection"
+        resource_route "get :archived, on: :collection"
+      end
     end
 
     def create_navigation
@@ -30,7 +48,7 @@ module Koi
         # Safe because we know that this only called during code generation
         config        = eval(match) # rubocop:disable Security/Eval
         label         = [*regular_class_path.map(&:humanize), human_name.pluralize].join(" ")
-        path          = "/admin#{route_url}"
+        path          = route_url
         config[label] = path
         config        = config.sort.to_h
         StringIO.new.tap do |io|
@@ -55,7 +73,7 @@ module Koi
 
     # See Rails::Generators::Actions
     # Replaces hard-coded route with admin route file
-    def route(routing_code, namespace: nil)
+    def route(routing_code, namespace: regular_class_path)
       namespace         = Array(namespace)
       namespace_pattern = route_namespace_pattern(namespace)
       routing_code      = namespace.reverse.reduce(routing_code) do |code, name|
@@ -76,10 +94,39 @@ module Koi
       end
     end
 
+    def resource_route(routing_code, namespace: regular_class_path, resource: "resources :#{file_name.pluralize}")
+      namespace        = Array(namespace)
+      resource_pattern = route_namespace_pattern(namespace, resource)
+      block_pattern    = /#{resource_pattern}( do)?\n/
+
+      log :route, routing_code
+
+      in_root do
+        resource_match = match_file(route_file, block_pattern)
+
+        if resource_match.captures.last.nil?
+          *, current_indent = resource_match.captures.compact.map(&:length)
+          inject_into_file route_file, " do\n#{' ' * current_indent}end",
+                           after:   resource_pattern,
+                           verbose: false,
+                           force:   false
+        end
+
+        resource_match = match_file(route_file, block_pattern)
+
+        *, existing_block_indent, _ = resource_match.captures.compact.map(&:length)
+        routing_code = rebase_indentation(routing_code, existing_block_indent + 2)
+
+        inject_into_file route_file, routing_code, after: block_pattern, verbose: true, force: false
+      end
+    end
+
     # See Rails::Generators::Actions
     # Replaces Routes.draw with namespace :admin as the search term
-    def route_namespace_pattern(namespace)
-      namespace.each_with_index.reverse_each.reduce(nil) do |pattern, (name, i)|
+    def route_namespace_pattern(namespace, resource = nil)
+      seed = resource ? route_resource_pattern(namespace, resource) : nil
+
+      namespace.each_with_index.reverse_each.reduce(seed) do |pattern, (name, i)|
         cummulative_margin     = "\\#{i + 1}[ ]{2}"
         blank_or_indented_line = "^[ ]*\n|^#{cummulative_margin}.*\n"
         "(?:(?:#{blank_or_indented_line})*?^(#{cummulative_margin})namespace :#{name} do\n#{pattern})?"
@@ -88,6 +135,13 @@ module Koi
       end
     end
 
+    # Generate a regex for the resource block at the appropriate level of nesting
+    def route_resource_pattern(namespace, resource)
+      cummulative_margin     = "\\#{namespace.count + 1}[ ]{2}"
+      blank_or_indented_line = "^[ ]*\n|^#{cummulative_margin}.*\n"
+      "(?:(?:#{blank_or_indented_line})*?^(#{cummulative_margin})#{resource})"
+    end
+
     def route_file
       "config/routes/admin.rb"
     end

data/lib/generators/koi/admin_views/USAGE

@@ -1,12 +1,23 @@
 Description:
-    Generates a Koi admin crud views for the given model
+    Generates Koi admin CRUD views for the given model.
+
+    When run without field:type arguments, the generator will automatically
+    introspect the model's attributes and associations to generate appropriate
+    admin views. This makes it easy to create admin views for existing models
+    or re-generate views when models change.
+
+Options:
+    --force Overwrite existing view files
 
 Example:
-    bin/rails generate koi:admin_views Test
+    bin/rails generate koi:admin_views Product name:string price:integer active:boolean
 
     This will create:
-        app/views/admin/tests/_fields.html.erb
-        app/views/admin/tests/edit.html.erb
-        app/views/admin/tests/index.html.erb
-        app/views/admin/tests/new.html.erb
-        app/views/admin/tests/show.html.erb
+        app/views/admin/products/_fields.html.erb
+        app/views/admin/products/edit.html.erb
+        app/views/admin/products/index.html.erb
+        app/views/admin/products/new.html.erb
+        app/views/admin/products/show.html.erb
+
+    For existing models, run without field arguments to auto-introspect:
+    bin/rails generate koi:admin_views Product --force

data/lib/generators/koi/admin_views/admin_views_generator.rb

@@ -1,38 +1,46 @@
 # frozen_string_literal: true
 
 require "rails/generators/named_base"
-require "rails/generators/resource_helpers"
 
-require_relative "../helpers/admin_generator_attributes"
+require_relative "../helpers/attribute_helpers"
+require_relative "../helpers/resource_helpers"
 
 module Koi
   class AdminViewsGenerator < Rails::Generators::NamedBase
-    include Rails::Generators::ResourceHelpers
-    include Helpers::AdminGeneratorAttributes
+    include Helpers::AttributeHelpers
+    include Helpers::ResourceHelpers
 
     source_root File.expand_path("templates", __dir__)
 
     argument :attributes, type: :array, default: [], banner: "field:type field:type"
 
+    class_option :force, type: :boolean, default: true
+
     def create_root_folder
       empty_directory File.join("app/views", controller_file_path)
     end
 
     def copy_view_files
       available_views.each do |filename|
-        target = filename.gsub("record", singular_name)
-        template filename, File.join("app/views", controller_file_path, target)
+        template(filename, File.join("app/views", controller_file_path, filename))
       end
     end
 
+    def remove_legacy
+      remove_file(File.join("app/views", controller_file_path, "_fields.html.erb"), force: true)
+    end
+
     private
 
     def available_views
-      %w(index.html.erb edit.html.erb show.html.erb new.html.erb _fields.html.erb)
-    end
-
-    def controller_class_path
-      ["admin"] + super
+      [
+        "index.html.erb",
+        ("archived.html.erb" if archivable?),
+        "show.html.erb",
+        "new.html.erb",
+        "edit.html.erb",
+        "_form.html.erb",
+      ].compact
     end
   end
 end

data/lib/generators/koi/admin_views/templates/_form.html.erb.tt

@@ -0,0 +1,8 @@
+<%%# locals: (<%= singular_name %>:) %>
+
+<%%= form_with(model: <%= singular_name %>) do |form| %>
+  <%- attributes.each do |attribute| -%>
+  <%= govuk_input_for attribute %>
+  <%- end -%>
+  <%%= form.button(type: :submit, class: "button") %>
+<%% end %>

data/lib/generators/koi/admin_views/templates/archived.html.erb.tt

@@ -0,0 +1,33 @@
+<%%# locals: (collection:) %>
+
+<%% content_for(:header) do %>
+  <%%= breadcrumb_list do %>
+    <li><%%= link_to("<%= human_name.pluralize.titleize %>", <%= admin_index_helper %>) %></li>
+  <%% end %>
+
+  <h1>Archived <%= human_name.pluralize.titleize %></h1>
+<%% end %>
+
+<% if query? %>
+<%%= table_query_with(collection:) %>
+<% end %>
+
+<%%= table_selection_with(collection:) do %>
+  <%%= tag.button("Restore", formaction: <%= restore_admin_helper %>, formmethod: :put, class: "button") %>
+<%% end %>
+
+<%%= table_with(collection:) do |row, <%= singular_name %>| %>
+  <%% row.select %>
+  <%- index_attributes.each_with_index do |attribute, index| -%>
+  <%- if index.zero? -%>
+  <%% row.link :<%= attribute.name %> %>
+  <%- else -%>
+  <%= index_attribute_for attribute %>
+  <%- end -%>
+  <%- end -%>
+  <%% row.date :archived_at %>
+<%% end %>
+
+<%- if paginate? -%>
+<%%= table_pagination_with(collection:) %>
+<%- end -%>

data/lib/generators/koi/admin_views/templates/edit.html.erb.tt

@@ -1,12 +1,20 @@
-<%% content_for :header do %>
-  <%%= render(Koi::Header::EditComponent.new(resource: <%= singular_name %>)) %>
-<%% end %>
+<%%# locals: (<%= singular_name %>:) %>
+
+<%% content_for(:header) do %>
+  <%%= breadcrumb_list do %>
+    <li><%%= link_to("<%= human_name.pluralize.titleize %>", <%= admin_index_helper %>) %></li>
+    <li><%%= link_to(<%= singular_name %>, <%= admin_show_helper %>) %></li>
+  <%% end %>
 
-<%%= form_with(model: <%= singular_name %>, url: <%= show_helper(singular_name, type: :path) %>) do |form| %>
-  <%%= render "fields", form: %>
+  <h1>Edit <%= human_name.downcase %></h1>
 
-  <div class="actions">
-    <%%= form.admin_save %>
-    <%%= form.admin_delete %>
-  </div>
+  <%%= actions_list do %>
+    <%- if archivable? -%>
+    <li><%%= link_to_archive_or_delete(<%= singular_name %>) %></li>
+    <%- else -%>
+    <li><%%= link_to_delete(<%= singular_name %>) %></li>
+    <%- end -%>
+  <%% end %>
 <%% end %>
+
+<%%= render("form", <%= singular_name %>:) %>

data/lib/generators/koi/admin_views/templates/index.html.erb.tt

@@ -1,12 +1,35 @@
-<%% content_for :header do %>
-  <%%= render(Koi::Header::IndexComponent.new(model: <%= class_name %>)) do |component| %>
-    <%% component.with_action "New", <%= new_helper(type: :path) %> %>
+<%%# locals: (collection:) %>
+
+<%% content_for(:header) do %>
+  <h1><%= human_name.pluralize.titleize %></h1>
+
+  <%%= actions_list do %>
+    <li><%%= link_to("New", <%= new_admin_helper %>) %></li>
+    <%- if archivable? -%>
+    <li><%%= link_to("Archived", <%= archived_admin_helper %>) %></li>
+    <%- end -%>
   <%% end %>
 <%% end %>
+<%- if query? -%>
 
 <%%= table_query_with(collection:) %>
+<%- end -%>
+<%- if selectable? -%>
+
+<%%= table_selection_with(collection:) do %>
+<%- if archivable? -%>
+  <%%= tag.button("Archive", formaction: <%= archive_admin_helper %>, formmethod: :put, class: "button") %>
+<%- end -%>
+<%% end %>
+<%- end -%>
 
 <%%= table_with(collection:) do |row, <%= singular_name %>| %>
+  <%- if orderable? -%>
+  <%% row.ordinal unless collection.filtered? %>
+  <%- end -%>
+  <%- if selectable? -%>
+  <%% row.select %>
+  <%- end -%>
   <%- index_attributes.each_with_index do |attribute, index| -%>
   <%- if index.zero? -%>
   <%% row.link :<%= attribute.name %> %>
@@ -15,5 +38,10 @@
   <%- end -%>
   <%- end -%>
 <%% end %>
+<%- if orderable? -%>
+
+<%%= table_orderable_with(collection:, url: <%= order_admin_helper(type: :path) %>) %>
+<%- elsif paginate? -%>
 
 <%%= table_pagination_with(collection:) %>
+<%- end -%>

data/lib/generators/koi/admin_views/templates/new.html.erb.tt

@@ -1,11 +1,11 @@
-<%% content_for :header do %>
-  <%%= render(Koi::Header::NewComponent.new(model: <%= class_name %>)) %>
-<%% end %>
+<%%# locals: (<%= singular_name %>:) %>
 
-<%%= form_with(model: <%= singular_name %>, url: <%= index_helper(type: :path) %>) do |form| %>
-  <%%= render "fields", form: %>
+<%% content_for(:header) do %>
+  <%%= breadcrumb_list do %>
+    <li><%%= link_to("<%= human_name.pluralize.titleize %>", <%= admin_index_helper %>) %></li>
+  <%% end %>
 
-  <div class="actions">
-    <%%= form.admin_save %>
-  </div>
+  <h1>New <%= human_name.downcase %></h1>
 <%% end %>
+
+<%%= render("form", <%= singular_name %>:) %>

data/lib/generators/koi/admin_views/templates/show.html.erb.tt

@@ -1,22 +1,19 @@
-<%% content_for :header do %>
-  <%%= render(Koi::Header::ShowComponent.new(resource: <%= singular_name %>)) %>
-<%% end %>
+<%%# locals: (<%= singular_name %>:) %>
 
-<h2>Summary</h2>
+<%% content_for(:header) do %>
+  <%%= breadcrumb_list do %>
+    <li><%%= link_to("<%= human_name.pluralize.titleize %>", <%= admin_index_helper %>) %></li>
+  <%% end %>
 
-<%%= summary_table_with(model: <%= singular_name %>) do |row| %>
-  <%- attributes.each_with_index do |attribute, index| -%>
-  <%- if index.zero? -%>
-  <%% row.link :<%= attribute.name %> %>
-  <%- else -%>
-  <%= summary_attribute_for attribute %>
-  <%- end -%>
-  <%- end -%>
+  <h1><%%= <%= singular_name %> %></h1>
+
+  <%%= actions_list do %>
+    <li><%%= link_to("Edit", <%= edit_admin_helper %>) %></li>
+  <%% end %>
 <%% end %>
 
-<div class="actions">
-  <%%= button_to "Delete", <%= show_helper(singular_name, type: :path) %>,
-                class:  "button button--secondary",
-                method: :delete,
-                form:   { data: { turbo_confirm: "Are you sure?" } } %>
-</div>
+<%%= summary_table_with(model: <%= singular_name %>) do |row| %>
+<%- show_attributes.each do |attribute| -%>
+  <%= show_attribute_for(attribute) %>
+<%- end -%>
+<%% end %>

data/lib/generators/koi/helpers/attribute_helpers.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require "rails/generators/resource_helpers"
+
+require_relative "attribute_types"
+
+module Koi
+  module Helpers
+    module AttributeHelpers
+      extend ActiveSupport::Concern
+
+      class IntrospectedAttribute < Rails::Generators::GeneratedAttribute
+        attr_reader :association, :attachment, :enum
+
+        def initialize(name, type, association: nil, attachment: nil, enum: nil, **)
+          super(name, type, **)
+
+          @association = association
+          @attachment = attachment
+          @enum = enum
+        end
+
+        def association?
+          @association.present?
+        end
+
+        def attachment?
+          @attachment.present?
+        end
+
+        def enum?
+          @enum.present?
+        end
+      end
+
+      def initialize(args, *options)
+        super
+
+        load_attributes! if attributes.empty?
+      end
+
+      def govuk_input_for(attribute)
+        AttributeTypes.for(attribute).govuk_input
+      end
+
+      def index_attribute_for(attribute)
+        AttributeTypes.for(attribute).index_row
+      end
+
+      def show_attribute_for(attribute)
+        AttributeTypes.for(attribute).show_row
+      end
+
+      def collection_attribute_for(attribute)
+        AttributeTypes.for(attribute).collection_attribute
+      end
+
+      def index_attributes
+        attributes.select { |attribute| index_attribute_for(attribute).present? }
+      end
+
+      def show_attributes
+        attributes.select { |attribute| show_attribute_for(attribute).present? }
+      end
+
+      def default_sort_attribute
+        if orderable?
+          :ordinal
+        elsif (attribute = attributes.find { |attr| attr.type == :string })
+          attribute.name
+        else
+          attributes.first&.name
+        end
+      end
+
+      private
+
+      def model_class
+        @model_class ||= class_name.safe_constantize
+      end
+
+      def load_attributes!
+        return unless model_class && model_class < ActiveRecord::Base
+
+        load_basic_attributes!
+        load_attachment_attributes!
+        load_rich_text_attributes!
+        load_association_attributes!
+      end
+
+      def load_basic_attributes!
+        model_class.attribute_types.each do |name, type|
+          next if internal_column?(name) || foreign_key_column?(name)
+
+          @attributes << IntrospectedAttribute.new(name, type.type, enum: model_class.defined_enums[name])
+        end
+      end
+
+      def load_attachment_attributes!
+        return unless model_class.respond_to?(:attachment_reflections)
+
+        model_class.attachment_reflections.each do |name, attachment|
+          @attributes << IntrospectedAttribute.new(name, :attachment, attachment:)
+        end
+      end
+
+      def load_rich_text_attributes!
+        return unless model_class.respond_to?(:rich_text_association_names)
+
+        model_class.rich_text_association_names.each do |name|
+          @attributes << IntrospectedAttribute.new(name.to_s.gsub(/^rich_text_/, "").to_sym, :rich_text)
+        end
+      end
+
+      def load_association_attributes!
+        model_class.reflect_on_all_associations.each do |association|
+          next unless association.macro == :belongs_to
+
+          @attributes << IntrospectedAttribute.new(
+            association.name.to_s,
+            :string, # associations display as text/links
+            association:,
+          )
+        end
+      end
+
+      def attachments?(name)
+        attribute = attributes.find { |attr| attr.name == name }
+        attribute&.attachments?
+      end
+
+      def internal_column?(name)
+        %w[id created_at updated_at].include?(name.to_s)
+      end
+
+      def foreign_key_columns
+        model_class
+          .reflect_on_all_associations(:belongs_to)
+          .map(&:foreign_key)
+      end
+
+      def foreign_key_column?(name)
+        foreign_key_columns.include?(name.to_s)
+      end
+    end
+  end
+end