katalyst-koi 4.5.0.beta.2 → 4.5.0

data/app/components/koi/tables/header_row_component.rb

@@ -5,46 +5,208 @@ module Koi
     # Custom header row component, in order to override the default header cell component
     # for number columns, we add a class to the header cell to allow for custom styling
     class HeaderRowComponent < Katalyst::Tables::HeaderRowComponent
-      def boolean(attribute, **attributes, &block)
-        header_cell(attribute, **attributes, &block)
+      # Renders a boolean column header
+      # @param method [Symbol] the method to call on the record to get the value
+      # @param attributes [Hash] additional arguments are applied as html attributes to the th element
+      # @option attributes [String] :label (nil) The label options to display in the header
+      # @option attributes [Hash] :link ({}) The link options for the sorting link
+      # @option attributes [String] :width (:xs) The width of the column, can be +:xs+, +:s+, +:m+, +:l+ or nil
+      #
+      # @example Render a boolean column header
+      #  <% row.boolean :active %> # => <th>Active</th>
+      #
+      # @example Render a boolean column header with a custom label
+      #  <% row.boolean :active, label: "Published" %> # => <th>Published</th>
+      #
+      # @example Render a boolean column header with medium width
+      #  <% row.boolean :active, width: :m %>
+      #  # => <th class="width-s">Active</th>
+      #
+      # @see Koi::Tables::BodyRowComponent#boolean
+      def boolean(method, **attributes, &block)
+        header_cell(method, component: Header::BooleanComponent, **attributes, &block)
       end
 
-      def date(attribute, **attributes, &block)
-        header_cell(attribute, **attributes, &block)
+      # Renders a date column header
+      # @param method [Symbol] the method to call on the record to get the value
+      # @param attributes [Hash] additional arguments are applied as html attributes to the th element
+      # @option attributes [String] :label (nil) The label options to display in the header
+      # @option attributes [Hash] :link ({}) The link options for the sorting link
+      # @option attributes [String] :width (:s) The width of the column, can be +:xs+, +:s+, +:m+, +:l+ or nil
+      #
+      # @example Render a date column header
+      #  <% row.date :published_on %> # => <th>Published on</th>
+      #
+      # @example Render a date column header with a custom label
+      #  <% row.date :published_on, label: "Date" %> # => <th>Date</th>
+      #
+      # @example Render a date column header with small width
+      #  <% row.date :published_on, width: :s %>
+      #  # => <th class="width-s">Published on</th>
+      #
+      # @see Koi::Tables::BodyRowComponent#date
+      def date(method, **attributes, &block)
+        header_cell(method, component: Header::DateComponent, **attributes, &block)
       end
 
-      def datetime(attribute, **attributes, &block)
-        header_cell(attribute, **attributes, &block)
+      # Renders a datetime column header
+      # @param method [Symbol] the method to call on the record to get the value
+      # @param attributes [Hash] additional arguments are applied as html attributes to the th element
+      # @option attributes [String] :label (nil) The label options to display in the header
+      # @option attributes [Hash] :link ({}) The link options for the sorting link
+      # @option attributes [String] :width (:m) The width of the column, can be +:xs+, +:s+, +:m+, +:l+ or nil
+      #
+      # @example Render a datetime column header
+      #  <% row.datetime :created_at %> # => <th>Created at</th>
+      #
+      # @example Render a datetime column header with a custom label
+      #  <% row.datetime :created_at, label: "Published at" %> # => <th>Published at</th>
+      #
+      # @example Render a datetime column header with small width
+      #  <% row.datetime :created_at, width: :s %>
+      #  # => <th class="width-s">Created at</th>
+      #
+      # @see Koi::Tables::BodyRowComponent#datetime
+      def datetime(method, **attributes, &block)
+        header_cell(method, component: Header::DateTimeComponent, **attributes, &block)
       end
 
-      def number(attribute, **attributes, &block)
-        header_cell(attribute, **attributes, component: Header::NumberComponent, &block)
+      # Renders a number column header
+      # @param method [Symbol] the method to call on the record to get the value
+      # @param attributes [Hash] additional arguments are applied as html attributes to the th element
+      # @option attributes [String] :label (nil) The label options to display in the header
+      # @option attributes [Hash] :link ({}) The link options for the sorting link
+      # @option attributes [String] :width (:xs) The width of the column, can be +:xs+, +:s+, +:m+, +:l+ or nil
+      #
+      # @example Render a number column header
+      #  <% row.number :comment_count %> # => <th>Comments</th>
+      #
+      # @example Render a number column header with a custom label
+      #  <% row.number :comment_count, label: "Comments" %> # => <th>Comments</th>
+      #
+      # @example Render a number column header with medium width
+      #  <% row.number :comment_count, width: :m %>
+      #  # => <th class="width-m">Comment Count</th>
+      #
+      # @see Koi::Tables::BodyRowComponent#number
+      def number(method, **attributes, &block)
+        header_cell(method, component: Header::NumberComponent, **attributes, &block)
       end
 
-      def money(attribute, **attributes, &block)
-        header_cell(attribute, **attributes, component: Header::NumberComponent, &block)
+      # Renders a currency column header
+      # @param method [Symbol] the method to call on the record to get the value
+      # @param attributes [Hash] additional arguments are applied as html attributes to the th element
+      # @option attributes [String] :label (nil) The label options to display in the header
+      # @option attributes [Hash] :link ({}) The link options for the sorting link
+      # @option attributes [String] :width (:s) The width of the column, can be +:xs+, +:s+, +:m+, +:l+ or nil
+      #
+      # @example Render a currency column header
+      #  <% row.currency :price %> # => <th>Price</th>
+      #
+      # @example Render a currency column header with a custom label
+      #  <% row.currency :price, label: "Amount($)" %> # => <th>Amount($)</th>
+      #
+      # @example Render a currency column header with medium width
+      #  <% row.currency :price, width: :m %>
+      #  # => <th class="width-m">Price</th>
+      #
+      # @see Koi::Tables::BodyRowComponent#currency
+      def currency(method, **attributes, &block)
+        header_cell(method, component: Header::CurrencyComponent, **attributes, &block)
       end
 
-      def rich_text(attribute, **attributes, &block)
-        header_cell(attribute, **attributes, &block)
+      # Renders a rich text column header
+      # @param method [Symbol] the method to call on the record to get the value
+      # @param attributes [Hash] additional arguments are applied as html attributes to the th element
+      # @option attributes [String] :label (nil) The label options to display in the header
+      # @option attributes [Hash] :link ({}) The link options for the sorting link
+      # @option attributes [String] :width (nil) The width of the column, can be +:xs+, +:s+, +:m+, +:l+ or nil
+      #
+      # @example Render a rich text column header
+      #  <% row.rich_text :content %> # => <th>Content</th>
+      #
+      # @example Render a rich text column header with a custom label
+      #  <% row.rich_text :content, label: "Post content" %> # => <th>Post content</th>
+      #
+      # @example Render a rich text column header with large width
+      #  <% row.rich_text :content, width: :l %>
+      #  # => <th class="width-l">Content</th>
+      #
+      # @see Koi::Tables::BodyRowComponent#rich_text
+      def rich_text(method, **attributes, &block)
+        header_cell(method, component: Header::TextComponent, **attributes, &block)
       end
 
-      def link(attribute, **attributes, &block)
-        header_cell(attribute, **attributes, &block)
+      # Renders a link column header
+      # @param method [Symbol] the method to call on the record to get the value
+      # @param attributes [Hash] additional arguments are applied as html attributes to the th element
+      # @option attributes [String] :label (nil) The label options to display in the header
+      # @option attributes [Hash] :link ({}) The link options for the sorting link
+      # @option attributes [String] :width (nil) The width of the column, can be +:xs+, +:s+, +:m+, +:l+ or nil
+      #
+      # @example Render a link column header
+      #  <% row.link :link %> # => <th>Link</th>
+      #
+      # @example Render a link column header with a custom label
+      #  <% row.link :link, label: "Post" %> # => <th>Post</th>
+      #
+      # @example Render a link column header with small width
+      #  <% row.link :content, width: :s %>
+      #  # => <th class="width-s">Content</th>
+      #
+      # @see Koi::Tables::BodyRowComponent#link
+      def link(method, **attributes, &block)
+        header_cell(method, component: Header::LinkComponent, **attributes, &block)
       end
 
-      def text(attribute, **attributes, &block)
-        header_cell(attribute, **attributes, &block)
+      # Renders a text column header
+      # @param method [Symbol] the method to call on the record to get the value
+      # @param attributes [Hash] additional arguments are applied as html attributes to the th element
+      # @option attributes [String] :label (nil) The label options to display in the header
+      # @option attributes [Hash] :link ({}) The link options for the sorting link
+      # @option attributes [String] :width (nil) The width of the column, can be +:xs+, +:s+, +:m+, +:l+ or nil
+      #
+      # @example Render a text column header
+      #  <% row.text :content %> # => <th>Content</th>
+      #
+      # @example Render a text column header with a custom label
+      #  <% row.text :content, label: "Description" %> # => <th>Description</th>
+      #
+      # @example Render a text column header with large width
+      #  <% row.text :content, width: :l %>
+      #  # => <th class="width-l">Content</th>
+      #
+      # @see Koi::Tables::BodyRowComponent#text
+      def text(method, **attributes, &block)
+        header_cell(method, component: Header::TextComponent, **attributes, &block)
       end
 
-      def image(attribute, **attributes, &block)
-        header_cell(attribute, **attributes, &block)
+      # Renders a attachment column header
+      # @param method [Symbol] the method to call on the record to get the value
+      # @param attributes [Hash] additional arguments are applied as html attributes to the th element
+      # @option attributes [String] :label (nil) The label options to display in the header
+      # @option attributes [Hash] :link ({}) The link options for the sorting link
+      # @option attributes [String] :width (nil) The width of the column, can be +:xs+, +:s+, +:m+, +:l+ or nil
+      #
+      # @example Render a attachment column header
+      #  <% row.attachment :attachment %> # => <th>Attachment</th>
+      #
+      # @example Render a attachment column header with a custom label
+      #  <% row.attachment :attachment, label: "Document" %> # => <th>Document</th>
+      #
+      # @example Render a attachment column header with small width
+      #  <% row.attachment :attachment, width: :s %>
+      #  # => <th class="width-s">Attachment</th>
+      #
+      # @see Koi::Tables::BodyRowComponent#attachment
+      def attachment(method, **attributes, &block)
+        header_cell(method, component: Header::AttachmentComponent, **attributes, &block)
       end
 
       private
 
-      def header_cell(attribute, component: HeaderCellComponent, **attributes, &block)
-        with_column(component.new(@table, attribute, link: @link_attributes, **attributes), &block)
+      def header_cell(method, component: HeaderCellComponent, **attributes, &block)
+        with_column(component.new(@table, method, link: @link_attributes, **attributes), &block)
       end
     end
   end

data/app/helpers/koi/date_helper.rb

@@ -1,36 +1,26 @@
 # frozen_string_literal: true
 
-# rubocop:disable Naming/MethodName
 module Koi
   module DateHelper
-    # @deprecated
-    def date_format(date, format)
-      date.strftime format.gsub(/yyyy/, "%Y")
-                      .gsub(/yy/,    "%y")
-                      .gsub(/Month/, "%B")
-                      .gsub(/M/,     "%b")
-                      .gsub(/mm/,    "%m")
-                      .gsub(/m/,     "%-m")
-                      .gsub(/Day/,   "%A")
-                      .gsub(/D/,     "%a")
-                      .gsub(/dd/,    "%d")
-                      .gsub(/d/,     "%-d")
-    end
-
-    # @deprecated
-    def date_Month_d_yyyy(date)
-      date.strftime "%B %-d, %Y"
-    end
-
-    # @deprecated
-    def date_d_Month_yyyy(date)
-      date.strftime "%-d %B %Y"
-    end
+    # Returns a string representing the number of days ago or from now.
+    # If the date is not 'recent' returns nil.
+    def days_ago_in_words(value)
+      from_time = value.to_time
+      to_time = Date.current.to_time
+      distance_in_days = ((to_time - from_time) / (24.0 * 60.0 * 60.0)).round
 
-    # @deprecated
-    def date_d_M_yy(date)
-      date.strftime "%-d %b %y"
+      case distance_in_days
+      when 0
+        "today"
+      when 1
+        "yesterday"
+      when -1
+        "tomorrow"
+      when 2..5
+        "#{distance_in_days} days ago"
+      when -5..-2
+        "#{distance_in_days.abs} days from now"
+      end
     end
   end
 end
-# rubocop:enable Naming/MethodName

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

@@ -2,7 +2,6 @@
 
 module Admin
   class <%= controller_class_name %>Controller < ApplicationController
-
     before_action :set_<%= singular_name %>, only: %i[show edit update destroy]
 
     def index
@@ -31,7 +30,7 @@ module Admin
       @<%= singular_name %> = ::<%= class_name %>.new(<%= singular_table_name %>_params)
 
       if @<%= singular_name %>.save
-        redirect_to [:admin, @<%= singular_name %>]
+        redirect_to [:admin, @<%= singular_name %>], status: :see_other
       else
         render :new, locals: { <%= singular_name %>: @<%= singular_name %> }, status: :unprocessable_entity
       end
@@ -39,16 +38,16 @@ module Admin
 
     def update
       if @<%= singular_name %>.update(<%= singular_table_name %>_params)
-        redirect_to action: :show
+        redirect_to action: :show, status: :see_other
       else
         render :edit, locals: { <%= singular_name %>: @<%= singular_name %> }, status: :unprocessable_entity
       end
     end
 
     def destroy
-      @<%= singular_name %>.destroy
+      @<%= singular_name %>.destroy!
 
-      redirect_to action: :index
+      redirect_to action: :index, status: :see_other
     end
 
     private
@@ -56,9 +55,9 @@ module Admin
     # Only allow a list of trusted parameters through.
     def <%= "#{singular_table_name}_params" %>
       <%- if attributes_names.empty? -%>
-        params.fetch(:<%= singular_table_name %>, {})
+      params.fetch(:<%= singular_table_name %>, {})
       <%- else -%>
-        params.require(:<%= singular_table_name %>).permit(<%= permitted_params %>)
+      params.require(:<%= singular_table_name %>).permit(<%= permitted_params %>)
       <%- end -%>
     end
 

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

@@ -23,7 +23,7 @@ RSpec.describe Admin::<%= controller_class_name %>Controller do
 
       it "paginates the collection" do
         action
-        expect(response.body).to have_selector("tbody tr", count: 20)
+        expect(response.body).to have_css("tbody tr", count: 20)
       end
     end
 
@@ -37,7 +37,7 @@ RSpec.describe Admin::<%= controller_class_name %>Controller do
 
       it "finds first in second place" do
         action
-        expect(response.body).to have_selector("tbody tr + tr td", text: "first")
+        expect(response.body).to have_css("tbody tr + tr td", text: "first")
       end
     end
 
@@ -51,12 +51,12 @@ RSpec.describe Admin::<%= controller_class_name %>Controller do
 
       it "finds the needle" do
         action
-        expect(response.body).to have_selector("table td", text: "first")
+        expect(response.body).to have_css("table td", text: "first")
       end
 
       it "removes the chaff" do
         action
-        expect(response.body).not_to have_selector("table td", text: "second")
+        expect(response.body).to have_no_css("table td", text: "second")
       end
     end
   end

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

@@ -38,10 +38,10 @@ module Koi
         %(<%= form.govuk_check_box_field :#{attribute.name} %>)
       when :date
         %(<%= form.govuk_date_field :#{attribute.name}, legend: { size: "s" } %>)
-      when :text
-        %(<%= form.govuk_rich_text_area :#{attribute.name} %>)
-      when :rich_text
+      when :rich_text, :text
         %(<%= form.govuk_rich_text_area :#{attribute.name} %>)
+      when :attachment
+        %(<%= form.govuk_image_field :#{attribute.name} %>)
       else
         ""
       end
@@ -61,6 +61,8 @@ module Koi
         %(<% dl.datetime :#{attribute.name} %>)
       when :rich_text
         %(<% dl.rich_text :#{attribute.name} %>)
+      when :attachment
+        %(<% dl.attachment :#{attribute.name} %>)
       else
         %(<% dl.text :#{attribute.name} %>)
       end
@@ -79,7 +81,7 @@ module Koi
       when :rich_text
         %(<% row.rich_text :#{attribute.name} %>)
       when :attachment
-        %(<% row.image :#{attribute.name} %>)
+        %(<% row.attachment :#{attribute.name} %>)
       else
         %(<% row.text :#{attribute.name} %>)
       end

data/lib/koi/config.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
 require "active_support/configurable"
+require "active_support/core_ext/numeric"
 
 module Koi
   class Config
     include ActiveSupport::Configurable
 
     config_accessor(:resource_name_candidates) { %i[title name] }
+
+    config_accessor(:image_size_limit) { 10.megabytes }
   end
 end

data/lib/koi/form_builder.rb

@@ -37,7 +37,7 @@ module Koi
     # @api internal
     # @see GOVUKDesignSystemFormBuilder::Builder#govuk_document_field
     def govuk_document_field(attribute_name, hint: {}, **kwargs, &block)
-      max_size = hint[:max_size] || App::PERMITTED_IMAGE_SIZE
+      max_size = hint[:max_size] || Koi.config.image_size_limit
       super(attribute_name, hint:, **kwargs) do
         if block
           concat(yield)
@@ -50,7 +50,7 @@ module Koi
     # @api internal
     # @see GOVUKDesignSystemFormBuilder::Builder#govuk_image_field
     def govuk_image_field(attribute_name, hint: {}, **kwargs, &block)
-      max_size = hint[:max_size] || App::PERMITTED_IMAGE_SIZE
+      max_size = hint[:max_size] || Koi.config.image_size_limit
       super(attribute_name, hint:, **kwargs) do
         if block
           concat(yield)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-koi
 version: !ruby/object:Gem::Version
-  version: 4.5.0.beta.2
+  version: 4.5.0
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-27 00:00:00.000000000 Z
+date: 2024-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -454,9 +454,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.19
 signing_key: