RubyGems - katalyst-koi - Versions diffs - 4.18.1 → 5.0.0.alpha.1 - Mend

katalyst-koi 4.18.1 → 5.0.0.alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (218) hide show

data/app/views/layouts/koi/application.html.erb CHANGED Viewed

@@ -1,7 +1,6 @@
 <!DOCTYPE html>
 <html lang="en">
 <head>
-  <!-- meta -->
   <meta charset="UTF-8">
   <!-- title -->
@@ -18,12 +17,7 @@
   <meta name="turbo-refresh-scroll" content="preserve">
   <%= yield :head %>
-  <%# Deprecated: meta, use :head instead %>
-  <%= yield :meta %>
   <!-- STYLES -->
-  <link rel="stylesheet" href="https://unpkg.com/modern-css-reset/dist/reset.min.css">
-  <link rel="stylesheet" href="https://rsms.me/inter/inter.css">
   <%= stylesheet_link_tag Koi.config.admin_stylesheet, "data-turbo-track": "reload" %>
   <!-- SCRIPTS -->
@@ -35,33 +29,34 @@
           Slash->shortcut:search
           KeyN->shortcut:create
           KeyG->shortcut:go
-          BracketLeft->shortcut:nav-toggle
           Escape->shortcut:cancel
           ArrowLeft->shortcut:page-prev
           ArrowRight->shortcut:page-next
         ">
-<%= render "layouts/koi/navigation" %>
-<main>
-  <% if content_for? :header %>
-    <%= yield :header %>
-  <% else %>
-    <%= render "layouts/koi/header" %>
-  <% end %>
+<!-- application header -->
+<%= render "layouts/koi/application_header" %>
-  <div class="page <%= "has-sidebar" if content_for?(:sidebar) %>">
-    <div class="page--content stack" role="main">
-      <%= render "layouts/koi/flash" unless flash.empty? %>
-      <%= yield %>
+<!-- header -->
+<% if content_for?(:header) %>
+  <header class="page-header">
+    <div class="flow wrapper">
+      <%= yield(:header) %>
     </div>
-    <%= tag.div class: "page--sidebar" do %>
-      <%= yield :sidebar %>
-    <% end if content_for?(:sidebar) %>
-  </div>
-</main>
-<%= render "layouts/koi/environment" %>
-<%= render ScrimComponent.new %>
-<%= render Kpop::FrameComponent.new do %>
-  <%= content_for :kpop %>
+  </header>
 <% end %>
+<main class="flow wrapper">
+  <% unless flash.empty? %>
+    <!-- flash -->
+    <%= render "layouts/koi/flash" %>
+  <% end %>
+  <!-- content -->
+  <%= yield %>
+</main>
+<!-- application navigation -->
+<%= render "layouts/koi/application_navigation" %>
 </body>
 </html>

data/app/views/layouts/koi/frame.html.erb CHANGED Viewed

@@ -10,8 +10,6 @@
   <%= yield :head %>
 </head>
 <body>
-<%= render Kpop::FrameComponent.new do %>
-  <%= yield %>
-<% end %>
+<%= yield %>
 </body>
 </html>

data/app/views/layouts/koi/login.html.erb CHANGED Viewed

@@ -14,16 +14,23 @@
   <%= yield :meta %>
   <!-- STYLES -->
-  <link rel="stylesheet" href="https://unpkg.com/modern-css-reset/dist/reset.min.css">
-  <link rel="stylesheet" href="https://rsms.me/inter/inter.css">
+  <%= stylesheet_link_tag path_to_stylesheet("koi/login.css"), "data-turbo-track": "reload" %>
   <%= stylesheet_link_tag Koi.config.admin_stylesheet, "data-turbo-track": "reload" %>
   <!-- SCRIPTS -->
   <%= javascript_importmap_tags "koi/admin" %>
 </head>
-<body class="admin-login">
-<main class="stack">
-  <%= yield %>
+<body>
+<main class="cover" data-centered>
+  <div class="login | modal">
+    <header>
+      <img src="<%= path_to_image("koi/koi.png") %>" alt="Koi" aria-hidden>
+      <h1>Koi</h1>
+      <h2 class="site-name"><%= URI.parse(root_url).host %></h2>
+    </header>
+    <%= yield %>
+  </div>
 </main>
 </body>
 </html>

data/config/locales/koi.en.yml CHANGED Viewed

@@ -16,9 +16,17 @@ en:
       new: New
       search: Search
   activerecord:
+    attributes:
+      url_rewrite/status_code:
+        303: "See other (303)"
+        307: "Temporary redirect (307)"
+        308: "Permanent redirect (308)"
+      well_known/content_type:
+        text: "Plain text"
+        json: "JSON"
     errors:
       models:
-        admin:
+        admin_user:
           invalid: "Invalid login credentials"
   helpers:
     hint:

data/config/routes.rb CHANGED Viewed

@@ -30,5 +30,5 @@ Rails.application.routes.draw do
     mount Flipper::UI.app(Flipper) => "flipper" if Object.const_defined?("Flipper::UI")
   end
-  resources :well_knowns, path: ".well-known", param: :name, only: %i[show], name: /[^\/]+/
+  resources :well_knowns, path: ".well-known", param: :name, only: %i[show], name: /.+/
 end

data/lib/generators/koi/admin/admin_generator.rb CHANGED Viewed

@@ -1,17 +1,11 @@
 # frozen_string_literal: true
-require "rails/generators/rails/scaffold/scaffold_generator"
+require "rails/generators/named_base"
 module Koi
-  class AdminGenerator < Rails::Generators::ScaffoldGenerator
-    # Replace the default model generator with our own
-    remove_hook_for(:orm)
-    hook_for(:orm, in: :koi, as: :admin, default: true)
+  class AdminGenerator < Rails::Generators::NamedBase
-    # Disable default controller generation as we do not want to generate public
-    # controllers by default
-    remove_hook_for(:scaffold_controller)
-    remove_hook_for(:resource_route)
+    class_option :force, type: :boolean, default: true
     hook_for :admin_controller, in: :koi, as: :admin, type: :boolean, default: true do |instance, controller|
       args, opts, config = @_initializer
@@ -20,8 +14,5 @@ module Koi
       # setting model_name so that generators will use the controller_class_path
       instance.invoke controller, args, { model_name: instance.name, **opts }, config
     end
-    Rails::Generators::ModelGenerator.hook_for :admin_search, type: :boolean, default: true
-    Rails::Generators::ModelGenerator.hook_for :ordinal_scope, type: :boolean, default: true
   end
 end

data/lib/generators/koi/admin_controller/admin_controller_generator.rb CHANGED Viewed

@@ -3,12 +3,13 @@
 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 AdminControllerGenerator < Rails::Generators::NamedBase
-    include Rails::Generators::ResourceHelpers
-    include Helpers::AdminGeneratorAttributes
+    include Helpers::AttributeHelpers
+    include Helpers::ResourceHelpers
     source_root File.expand_path("templates", __dir__)
@@ -16,6 +17,8 @@ module Koi
     argument :attributes, type: :array, default: [], banner: "field:type field:type"
+    class_option :force, type: :boolean, default: true
     def create_controller_files
       template("controller.rb",
                File.join("app/controllers",
@@ -35,24 +38,11 @@ module Koi
     private
-    def controller_class_path
-      ["admin"] + super
-    end
     def permitted_params
       attachments, others = attributes_names.partition { |name| attachments?(name) }
       params              = others.map { |name| ":#{name}" }
       params += attachments.map { |name| "#{name}: []" }
       params.join(", ")
     end
-    def attachments?(name)
-      attribute = attributes.find { |attr| attr.name == name }
-      attribute&.attachments?
-    end
-    def sort_attribute
-      attributes.find { |attr| attr.type == :string }&.name
-    end
   end
 end

data/lib/generators/koi/admin_controller/templates/controller.rb.tt CHANGED Viewed

@@ -3,51 +3,110 @@
 class <%= controller_class_name %>Controller < ApplicationController
   before_action :set_<%= singular_name %>, only: %i[show edit update destroy]
+  attr_reader :collection, :<%= singular_name %>
   def index
-    collection = Collection.new.with_params(params).apply(::<%= class_name %>.strict_loading.all)
+    <%- if archivable? -%>
+    @collection = Collection.with_params(params).apply(<%= class_name %>.not_archived.strict_loading)
+    <%- else -%>
+    @collection = Collection.with_params(params).apply(<%= class_name %>.strict_loading)
+    <%- end -%>
+    render locals: { collection: }
+  end
+  <%- if archivable? -%>
+  def archived
+    collection = Collection.with_params(params).apply(<%= class_name %>.archived.strict_loading)
     render locals: { collection: }
   end
+  <%- end -%>
   def show
-    render locals: { <%= singular_name %>: @<%= singular_name %> }
+    render locals: { <%= singular_name %>: }
   end
   def new
-    render locals: { <%= singular_name %>: ::<%= class_name %>.new }
+    @<%= singular_name %> = <%= class_name %>.new
+    render locals: { <%= singular_name %>: }
   end
   def edit
-    render locals: { <%= singular_name %>: @<%= singular_name %> }
+    render locals: { <%= singular_name %>: }
   end
   def create
-    @<%= singular_name %> = ::<%= class_name %>.new(<%= singular_table_name %>_params)
+    @<%= singular_name %> = <%= class_name %>.new(<%= singular_table_name %>_params)
-    if @<%= singular_name %>.save
-      redirect_to [:admin, @<%= singular_name %>], status: :see_other
+    if <%= singular_name %>.save
+      redirect_to <%= admin_show_helper %>, status: :see_other
     else
-      render :new, locals: { <%= singular_name %>: @<%= singular_name %> }, status: :unprocessable_content
+      render :new, locals: { <%= singular_name %>: }, status: :unprocessable_content
     end
   end
   def update
-    if @<%= singular_name %>.update(<%= singular_table_name %>_params)
-      redirect_to action: :show, status: :see_other
+    if <%= singular_name %>.update(<%= singular_table_name %>_params)
+      redirect_to <%= admin_show_helper %>, status: :see_other
     else
-      render :edit, locals: { <%= singular_name %>: @<%= singular_name %> }, status: :unprocessable_content
+      render :edit, locals: { <%= singular_name %>: }, status: :unprocessable_content
+    end
+  end
+  <%- if archivable? -%>
+  def archive
+    <%= class_name %>.where(id: params[:id]).each(&:archive!)
+    redirect_back(fallback_location: <%= admin_index_helper %>, status: :see_other)
+  end
+  def restore
+    <%= class_name %>.archived.where(id: params[:id]).each(&:restore!)
+    redirect_back(fallback_location: <%= admin_index_helper %>, status: :see_other)
+  end
+  <%- end -%>
+  <%- if orderable? -%>
+  def order
+    order_params[:<%= table_name %>].each do |id, attrs|
+      <%= class_name %>.find(id).update(attrs)
     end
+    redirect_back(fallback_location: <%= admin_index_helper %>, status: :see_other)
   end
+  <%- end -%>
   def destroy
-    @<%= singular_name %>.destroy!
+    <%- if archivable? -%>
+    if <%= singular_name %>.archived?
+      <%= singular_name %>.destroy!
+      redirect_to <%= admin_index_helper %>, status: :see_other
+    else
+      <%= singular_name %>.archive!
-    redirect_to action: :index, status: :see_other
+      redirect_back_or_to(<%= admin_show_helper %>, status: :see_other)
+    end
+    <%- else -%>
+    <%= singular_name %>.destroy!
+    redirect_to <%= admin_index_helper %>, status: :see_other
+    <%- end -%>
   end
   private
-  # Only allow a list of trusted parameters through.
+  def set_<%= singular_name %>
+    <%- if archivable? -%>
+    @<%= singular_name %> = <%= class_name %>.with_archived.find(params[:id])
+    <%- else -%>
+    @<%= singular_name %> = <%= class_name %>.find(params[:id])
+    <%- end -%>
+  end
   def <%= "#{singular_table_name}_params" %>
     <%- if attributes_names.empty? -%>
     params.expect(<%= singular_table_name %>: [])
@@ -56,14 +115,19 @@ class <%= controller_class_name %>Controller < ApplicationController
     <%- end -%>
   end
-  # Use callbacks to share common setup or constraints between actions.
-  def set_<%= singular_name %>
-    @<%= singular_name %> = ::<%= class_name %>.find(params[:id])
+  <%- if orderable? -%>
+  def order_params
+    params.expect(order: { <%= table_name %>: [[:ordinal]] })
   end
+  <%- end -%>
   class Collection < Admin::Collection
-    config.sorting  = :<%= sort_attribute %>
+    <%- if sortable? %>
+    config.sorting  = :<%= default_sort_attribute %>
+    <%- end -%>
+    <%- if paginate? -%>
     config.paginate = true
+    <%- end -%>
     <%- attributes.each do |attribute| -%>
     <% definition = collection_attribute_for(attribute) -%>

data/lib/generators/koi/admin_controller/templates/controller_spec.rb.tt CHANGED Viewed

@@ -4,12 +4,12 @@ require "rails_helper"
 RSpec.describe <%= controller_class_name %>Controller do
   let(:admin) { create(:admin) }
-  let(:model) { create(:<%= singular_name %>) }
+  let(:<%= singular_name %>) { create(:<%= singular_name %>) }
   include_context "with admin session"
   describe "GET /admin/<%= plural_name %>" do
-    let(:action) { get polymorphic_path([:admin, <%= class_name %>]) }
+    let(:action) { get <%= admin_index_helper %> }
     it_behaves_like "requires admin"
@@ -17,52 +17,35 @@ RSpec.describe <%= controller_class_name %>Controller do
       action
       expect(response).to have_http_status(:success)
     end
+    <%- if orderable? -%>
-    context "with a large collection" do
-      before { create_list(:<%= singular_name %>, 25) } # rubocop:disable FactoryBot/ExcessiveCreateList
+    it "sorts by ordinal" do
+      first = create(:<%= singular_name %>, ordinal: 1)
+      second = create(:<%= singular_name %>, ordinal: 0)
-      it "paginates the collection" do
-        action
-        expect(response.body).to have_css("tbody tr", count: 20)
-      end
-    end
-    context "with sort parameter" do
-      let(:action) { get polymorphic_path([:admin, <%= class_name %>], sort: "<%= sort_attribute %> desc") }
-      before do
-        create(:<%= singular_name %>, <%= sort_attribute %>: "first")
-        create(:<%= singular_name %>, <%= sort_attribute %>: "second")
-      end
+      action
-      it "finds first in second place" do
-        action
-        expect(response.body).to have_css("tbody tr + tr td", text: "first")
-      end
+      expect(response.parsed_body.css("tbody td a").pluck(:href))
+        .to eq([second, first].map { |<%= singular_name %>| <%= admin_show_helper %> })
     end
+    <%- end -%>
+  end
-    context "with search parameter" do
-      let(:action) { get polymorphic_path([:admin, <%= class_name %>], search: "first") }
-      before do
-        create(:<%= singular_name %>, <%= sort_attribute %>: "first")
-        create(:<%= singular_name %>, <%= sort_attribute %>: "second")
-      end
+  <%- if archivable? -%>
+  describe "GET /admin/<%= plural_name %>/archived" do
+    let(:action) { get <%= archived_admin_helper %> }
-      it "finds the needle" do
-        action
-        expect(response.body).to have_css("table td", text: "first")
-      end
+    it_behaves_like "requires admin"
-      it "removes the chaff" do
-        action
-        expect(response.body).to have_no_css("table td", text: "second")
-      end
+    it "renders successfully" do
+      action
+      expect(response).to have_http_status(:success)
     end
   end
+  <%- end -%>
   describe "GET /admin/<%= plural_name %>/new" do
-    let(:action) { get new_polymorphic_path([:admin, <%= class_name %>]) }
+    let(:action) { get <%= new_admin_helper %> }
     it_behaves_like "requires admin"
@@ -73,14 +56,14 @@ RSpec.describe <%= controller_class_name %>Controller do
   end
   describe "POST /admin/<%= plural_name %>" do
-    let(:action) { post polymorphic_path([:admin, <%= class_name %>]), params: { <%= singular_name %>: params } }
+    let(:action) { post <%= admin_index_helper %>, params: { <%= singular_name %>: params } }
     let(:params) { attributes_for(:<%= singular_name %>) }
     it_behaves_like "requires admin"
     it "renders successfully" do
       action
-      expect(response).to redirect_to([:admin, assigns(:<%= singular_name %>)])
+      expect(response).to redirect_to(<%= admin_show_helper("assigns(:#{singular_name})") %>)
     end
     it "creates a <%= singular_name %>" do
@@ -89,7 +72,7 @@ RSpec.describe <%= controller_class_name %>Controller do
   end
   describe "GET /admin/<%= plural_name %>/:id" do
-    let(:action) { get polymorphic_path([:admin, model]) }
+    let(:action) { get <%= admin_show_helper %> }
     it_behaves_like "requires admin"
@@ -100,7 +83,7 @@ RSpec.describe <%= controller_class_name %>Controller do
   end
   describe "GET /admin/<%= plural_name %>/:id/edit" do
-    let(:action) { get edit_polymorphic_path([:admin, model]) }
+    let(:action) { get <%= edit_admin_helper %> }
     it_behaves_like "requires admin"
@@ -111,30 +94,113 @@ RSpec.describe <%= controller_class_name %>Controller do
   end
   describe "PATCH /admin/<%= plural_name %>/:id" do
-    let(:action) { patch polymorphic_path([:admin, model]), params: { <%= singular_name %>: params } }
+    let(:action) { patch <%= admin_show_helper %>, params: { <%= singular_name %>: params } }
     let(:params) { attributes_for(:<%= singular_name %>) }
     it_behaves_like "requires admin"
     it "renders successfully" do
       action
-      expect(response).to redirect_to(polymorphic_path([:admin, model]))
+      expect(response).to redirect_to(<%= admin_show_helper %>)
     end
   end
+  <%- if archivable? -%>
+  describe "PUT /admin/<%= plural_name %>/archive" do
+    let(:action) { put <%= archive_admin_helper %>, params: }
+    let(:params) { { id: <%= plural_name %>.take(2).pluck(:id) } }
+    let(:<%= plural_name %>) { create_list(:<%= singular_name %>, 3) }
+    it_behaves_like "requires admin"
+    it "renders successfully" do
+      action
+      expect(response).to redirect_to(<%= admin_index_helper %>)
+    end
+    it "updates archived" do
+      expect { action }.to(change { <%= class_name %>.archived.count }.to(2))
+    end
+  end
+  <%- end -%>
+  <%- if archivable? -%>
+  describe "PUT /admin/<%= plural_name %>/restore" do
+    let(:action) { put <%= restore_admin_helper %>, params: }
+    let(:params) { { id: <%= plural_name %>.take(2).pluck(:id) } }
+    let(:<%= plural_name %>) { create_list(:<%= singular_name %>, 3, archived: true) }
+    it_behaves_like "requires admin"
+    it "renders successfully" do
+      action
+      expect(response).to redirect_to(<%= admin_index_helper %>)
+    end
+    it "updates archived" do
+      expect { action }.to(change { <%= class_name %>.not_archived.count }.by(2))
+    end
+  end
+  <%- end -%>
+  <%- if orderable? -%>
+  describe "PATCH /admin/<%= plural_name %>/order" do
+    let(:action) { patch <%= order_admin_helper %>, params: { order: params } }
+    let(:params) { { <%= plural_name %>: { first.id => { ordinal: 1 }, second.id => { ordinal: 0 } } } }
+    let(:first) { create(:<%= singular_name %>, ordinal: 0) }
+    let(:second) { create(:<%= singular_name %>, ordinal: 1) }
+    it_behaves_like "requires admin"
+    it "redirects back" do
+      action
+      expect(response).to redirect_to(<%= admin_index_helper %>)
+    end
+    it "updates ordinals" do
+      expect { action }.to change { first.reload.ordinal }.to(1)
+    end
+  end
+  <%- end -%>
   describe "DELETE /admin/<%= plural_name %>/:id" do
-    let(:action) { delete polymorphic_path([:admin, model]) }
-    let!(:model) { create(:<%= singular_name %>) }
+    let(:action) { delete <%= admin_show_helper %> }
+    let!(:<%= singular_name %>) { create(:<%= singular_name %>) }
     it_behaves_like "requires admin"
+    <%- if !archivable? -%>
     it "renders successfully" do
       action
-      expect(response).to redirect_to(polymorphic_path([:admin, <%= class_name %>]))
+      expect(response).to redirect_to(<%= admin_index_helper %>)
     end
-    it "deletes the <%= singular_name %>" do
+    it "deletes the <%= human_name %>" do
       expect { action }.to change(<%= class_name %>, :count).by(-1)
     end
+    <%- else -%>
+    it "renders successfully" do
+      action
+      expect(response).to redirect_to(<%= admin_show_helper %>)
+    end
+    it "archives the <%= human_name %>" do
+      expect { action }.to change { <%= singular_name %>.reload.archived }.to(true)
+    end
+    context "when the <%= human_name %> is archived" do
+      let(:<%= singular_name %>) { create(:<%= singular_name %>, archived_at: 1.day.ago) }
+      it "renders successfully" do
+        action
+        expect(response).to redirect_to(<%= admin_index_helper %>)
+      end
+      it "deletes the <%= human_name %>" do
+        <%= singular_name %>
+        expect { action }.to change(<%= class_name %>.with_archived, :count).by(-1)
+      end
+    end
+    <%- end -%>
   end
 end