katalyst-koi 4.6.0 → 4.7.0

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

@@ -1,142 +0,0 @@
-# frozen_string_literal: true
-
-module Koi
-  module Tables
-    # Custom body row component, in order to override the default body cell component
-    class BodyRowComponent < Katalyst::Tables::BodyRowComponent
-      # Generates a column from boolean values rendered as "Yes" or "No".
-      #
-      # @param method [Symbol] the method to call on the record
-      # @param attributes [Hash] HTML attributes to be added to the cell
-      # @param block [Proc] optional block to alter the cell content
-      # @return [void]
-      #
-      # @example Render a boolean column indicating whether the record is active
-      #   <% row.boolean :active %> # => <td>Yes</td>
-      def boolean(method, **attributes, &block)
-        with_column(Body::BooleanComponent.new(@table, @record, method, **attributes), &block)
-      end
-
-      # Generates a column from date values rendered using I18n.l.
-      # The default format is :admin, but it can be overridden.
-      #
-      # @param method [Symbol] the method to call on the record
-      # @param format [Symbol] the I18n date format to use when rendering
-      # @param attributes [Hash] HTML attributes to be added to the cell tag
-      # @param block [Proc] optional block to alter the cell content
-      # @return [void]
-      #
-      # @example Render a date column describing when the record was created
-      #   <% row.date :created_at %> # => <td>29 Feb 2024</td>
-      def date(method, format: :admin, **attributes, &block)
-        with_column(Body::DateComponent.new(@table, @record, method, format:, **attributes), &block)
-      end
-
-      # Generates a column from datetime values rendered using I18n.l.
-      # The default format is :admin, but it can be overridden.
-      #
-      # @param method [Symbol] the method to call on the record
-      # @param format [Symbol] the I18n datetime format to use when rendering
-      # @param attributes [Hash] HTML attributes to be added to the cell tag
-      # @param block [Proc] optional block to alter the cell content
-      # @return [void]
-      #
-      # @example Render a datetime column describing when the record was created
-      #   <% row.datetime :created_at %> # => <td>29 Feb 2024, 5:00pm</td>
-      def datetime(method, format: :admin, **attributes, &block)
-        with_column(Body::DatetimeComponent.new(@table, @record, method, format:, **attributes), &block)
-      end
-
-      # Generates a column from numeric values formatted appropriately.
-      #
-      # @param method [Symbol] the method to call on the record
-      # @param attributes [Hash] HTML attributes to be added to the cell tag
-      # @param block [Proc] optional block to alter the cell content
-      # @return [void]
-      #
-      # @example Render the number of comments on a post
-      #   <% row.number :comment_count %> # => <td>0</td>
-      def number(method, **attributes, &block)
-        with_column(Body::NumberComponent.new(@table, @record, method, **attributes), &block)
-      end
-
-      # Generates a column from numeric values rendered using `number_to_currency`.
-      #
-      # @param method [Symbol] the method to call on the record
-      # @param options [Hash] options to be passed to `number_to_currency`
-      # @param attributes [Hash] HTML attributes to be added to the cell tag
-      # @param block [Proc] optional block to alter the cell content
-      # @return [void]
-      #
-      # @example Render a currency column for the price of a product
-      #   <% row.currency :price %> # => <td>$3.50</td>
-      def currency(method, options: {}, **attributes, &block)
-        with_column(Body::CurrencyComponent.new(@table, @record, method, options:, **attributes), &block)
-      end
-
-      # Generates a column containing HTML markup.
-      #
-      # @param method [Symbol] the method to call on the record
-      # @param attributes [Hash] HTML attributes to be added to the cell tag
-      # @param block [Proc] optional block to alter the cell content
-      # @return [void]
-      #
-      # @note This method assumes that the method returns HTML-safe content.
-      #   If the content is not HTML-safe, it will be escaped.
-      #
-      # @example Render a description column containing HTML markup
-      #   <% row.rich_text :description %> # => <td><em>Emphasis</em></td>
-      def rich_text(method, **attributes, &block)
-        with_column(Body::RichTextComponent.new(@table, @record, method, **attributes), &block)
-      end
-
-      # Generates a column that links to the record's show page (by default).
-      #
-      # @param method [Symbol] the method to call on the record
-      # @param link [Hash] options to be passed to the link_to helper
-      # @option opts [Hash, Array, String, Symbol] :url ([:admin, object]) options for url_for,
-      # or a symbol to be passed to the route helper
-      # @param attributes [Hash] HTML attributes to be added to the cell tag
-      # @param block [Proc] optional block to alter the cell content
-      # @return [void]
-      #
-      # @example Render a column containing the record's title, linked to its show page
-      #   <% row.link :title %> # => <td><a href="/admin/post/15">About us</a></td>
-      # @example Render a column containing the record's title, linked to its edit page
-      #   <% row.link :title, url: :edit_admin_post_path do |cell| %>
-      #      Edit <%= cell %>
-      #   <% end %>
-      #   # => <td><a href="/admin/post/15/edit">Edit About us</a></td>
-      def link(method, url: [:admin, @record], link: {}, **attributes, &block)
-        with_column(Body::LinkComponent.new(@table, @record, method, url:, link:, **attributes), &block)
-      end
-
-      # Generates a column that renders the contents as text.
-      #
-      # @param method [Symbol] the method to call on the record
-      # @param attributes [Hash] HTML attributes to be added to the cell tag
-      # @param block [Proc] optional block to alter the cell content
-      # @return [void]
-      #
-      # @example Render a column containing the record's title
-      #   <% row.text :title %> # => <td>About us</td>
-      def text(method, **attributes, &block)
-        with_column(BodyCellComponent.new(@table, @record, method, **attributes), &block)
-      end
-
-      # Generates a column that renders an ActiveStorage attachment as a downloadable link.
-      #
-      # @param method [Symbol] the method to call on the record
-      # @param variant [Symbol] the variant to use when rendering the image (default :thumb)
-      # @param attributes [Hash] HTML attributes to be added to the cell tag
-      # @param block [Proc] optional block to alter the cell content
-      # @return [void]
-      #
-      # @example Render a column containing a download link to the record's background image
-      #   <% row.attachment :background %> # => <td><a href="...">background.png</a></td>
-      def attachment(method, variant: :thumb, **attributes, &block)
-        with_column(Body::AttachmentComponent.new(@table, @record, method, variant:, **attributes), &block)
-      end
-    end
-  end
-end

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

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-using Katalyst::HtmlAttributes::HasHtmlAttributes
-
-module Koi
-  module Tables
-    module Header
-      class NumberComponent < HeaderCellComponent
-        def default_html_attributes
-          super.merge_html(class: "type-number")
-        end
-      end
-
-      class CurrencyComponent < HeaderCellComponent
-        def default_html_attributes
-          super.merge_html(class: "type-currency")
-        end
-      end
-
-      class BooleanComponent < HeaderCellComponent
-        def default_html_attributes
-          super.merge_html(class: "type-boolean")
-        end
-      end
-
-      class DateComponent < HeaderCellComponent
-        def default_html_attributes
-          super.merge_html(class: "type-date")
-        end
-      end
-
-      class DateTimeComponent < HeaderCellComponent
-        def default_html_attributes
-          super.merge_html(class: "type-datetime")
-        end
-      end
-
-      class LinkComponent < HeaderCellComponent
-        def default_html_attributes
-          super.merge_html(class: "type-link")
-        end
-      end
-
-      class TextComponent < HeaderCellComponent
-        def default_html_attributes
-          super.merge_html(class: "type-text")
-        end
-      end
-
-      class ImageComponent < HeaderCellComponent
-        def default_html_attributes
-          super.merge_html(class: "type-image")
-        end
-      end
-
-      class AttachmentComponent < HeaderCellComponent
-        def default_html_attributes
-          super.merge_html(class: "type-attachment")
-        end
-      end
-    end
-  end
-end

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

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-using Katalyst::HtmlAttributes::HasHtmlAttributes
-
-module Koi
-  module Tables
-    class HeaderCellComponent < Katalyst::Tables::HeaderCellComponent
-      attr_reader :width
-
-      def initialize(table, attribute, label: nil, link: {}, width: nil, **html_attributes)
-        @width = width
-
-        super(table, attribute, label:, link:, **html_attributes)
-      end
-
-      def default_html_attributes
-        super.merge_html(class: width_class)
-      end
-
-      private
-
-      def width_class
-        case width
-        when :xs
-          "width-xs"
-        when :s
-          "width-s"
-        when :m
-          "width-m"
-        when :l
-          "width-l"
-        else
-          ""
-        end
-      end
-    end
-  end
-end

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

@@ -1,213 +0,0 @@
-# frozen_string_literal: true
-
-module Koi
-  module Tables
-    # 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
-      # 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
-
-      # 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
-
-      # 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
-
-      # 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
-
-      # 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
-
-      # 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
-
-      # 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
-
-      # 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
-
-      # 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(method, component: HeaderCellComponent, **attributes, &block)
-        with_column(component.new(@table, method, link: @link_attributes, **attributes), &block)
-      end
-    end
-  end
-end

data/app/views/admin/admin_users/_admin.html+row.erb

@@ -1,2 +0,0 @@
-<%= row.link :name, url: :admin_admin_user_path %>
-<%= row.text :email %>

data/app/views/admin/url_rewrites/_url_rewrite.html+row.erb

@@ -1,3 +0,0 @@
-<%= row.link :from %>
-<%= row.text :to %>
-<%= row.boolean :active %>

data/lib/generators/koi/admin_views/templates/_record.html+row.erb.tt

@@ -1,7 +0,0 @@
-<%- index_attributes.each_with_index do |attribute, index| -%>
-<%- if index.zero? -%>
-<%% row.link :<%= attribute.name %> %>
-<%- else -%>
-<%= index_attribute_for attribute %>
-<%- end -%>
-<%- end -%>