katalyst-tables 3.0.0.beta1 → 3.1.0

data/app/components/concerns/katalyst/tables/header/typed_columns.rb

@@ -1,179 +0,0 @@
-# frozen_string_literal: true
-
-module Katalyst
-  module Tables
-    module Header
-      module TypedColumns
-        extend ActiveSupport::Concern
-
-        # 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 (nil) 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 small width
-        #  <% row.boolean :active, width: :s %>
-        #  => <th class="width-s">Active</th>
-        #
-        def boolean(method, **attributes, &)
-          with_column(Header::BooleanComponent.new(@table, method, link: @link_attributes, **attributes), &)
-        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 (nil) 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 boolean column header with small width
-        #  <% row.date :published_on, width: :s %>
-        #  => <th class="width-s">Published on</th>
-        #
-        def date(method, **attributes, &)
-          with_column(Header::DateComponent.new(@table, method, link: @link_attributes, **attributes), &)
-        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 (nil) 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 boolean column header with small width
-        #  <% row.datetime :created_at, width: :s %>
-        #  => <th class="width-s">Created at</th>
-        #
-        def datetime(method, **attributes, &)
-          with_column(Header::DateTimeComponent.new(@table, method, link: @link_attributes, **attributes), &)
-        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 (nil) 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 boolean column header with small width
-        #  <% row.number :comment_count, width: :s %>
-        #  => <th class="width-s">Comments</th>
-        #
-        def number(method, **attributes, &)
-          with_column(Header::NumberComponent.new(@table, method, link: @link_attributes, **attributes), &)
-        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 (nil) 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 boolean column header with small width
-        #  <% row.currency :price, width: :s %>
-        #  => <th class="width-s">Price</th>
-        #
-        def currency(method, **attributes, &)
-          with_column(Header::CurrencyComponent.new(@table, method, link: @link_attributes, **attributes), &)
-        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 header
-        #  <% row.rich_text :content %> # => <th>Content</th>
-        #
-        # @example Render a rich text column header with a custom label
-        #  <% row.currency :content, label: "Content!" %> # => <th>Content!</th>
-        #
-        # @example Render a boolean column header with small width
-        #  <% row.currency :content, width: :s %>
-        #  => <th class="width-s">Content</th>
-        #
-        def rich_text(method, **attributes, &)
-          with_column(Header::RichTextComponent.new(@table, method, link: @link_attributes, **attributes), &)
-        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 boolean column header with small width
-        #  <% row.link :link, width: :s %>
-        #  => <th class="width-s">Link</th>
-        #
-        def link(method, **attributes, &)
-          with_column(Header::LinkComponent.new(@table, method, link: @link_attributes, **attributes), &)
-        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 boolean column header with small width
-        #  <% row.attachment :attachment, width: :s %>
-        #  => <th class="width-s">Attachment</th>
-        #
-        def attachment(method, **attributes, &)
-          with_column(Header::AttachmentComponent.new(@table, method, link: @link_attributes, **attributes), &)
-        end
-      end
-    end
-  end
-end

data/app/components/katalyst/tables/body/attachment_component.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-using Katalyst::HtmlAttributes::HasHtmlAttributes
-
-module Katalyst
-  module Tables
-    module Body
-      # Shows an attachment
-      #
-      # The value is expected to be an ActiveStorage attachment
-      #
-      # If it is representable, shows as a image tag using a default variant named :thumb.
-      #
-      # Otherwise shows as a link to download.
-      class AttachmentComponent < BodyCellComponent
-        def initialize(table, record, attribute, variant: :thumb, **options)
-          super(table, record, attribute, **options)
-
-          @variant = variant
-        end
-
-        def rendered_value
-          representation
-        end
-
-        def representation
-          if value.try(:variable?) && named_variant.present?
-            image_tag(value.variant(@variant))
-          elsif value.try(:attached?)
-            filename.to_s
-          else
-            ""
-          end
-        end
-
-        def filename
-          value.blob.filename
-        end
-
-        # Utility for accessing the path Rails provides for retrieving the
-        # attachment for use in cells. Example:
-        #    <% row.attachment :file do |cell| %>
-        #       <%= link_to "Download", cell.internal_path %>
-        #    <% end %>
-        def internal_path
-          rails_blob_path(value, disposition: :attachment)
-        end
-
-        private
-
-        # Find the reflective variant by name (i.e. :thumb by default)
-        def named_variant
-          object.attachment_reflections[@attribute.to_s].named_variants[@variant.to_sym]
-        end
-      end
-    end
-  end
-end

data/app/components/katalyst/tables/body/link_component.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-using Katalyst::HtmlAttributes::HasHtmlAttributes
-
-module Katalyst
-  module Tables
-    module Body
-      # Displays a link to the record
-      # The link text is the value of the attribute
-      # @see Koi::Tables::BodyRowComponent#link
-      class LinkComponent < BodyCellComponent
-        def initialize(table, record, attribute, url:, link: {}, **options)
-          super(table, record, attribute, **options)
-
-          @url = url
-          @link_options = link
-        end
-
-        def call
-          content # ensure content is set before rendering options
-
-          link = content.present? && url.present? ? link_to(content, url, @link_options) : content.to_s
-          content_tag(@type, link, **html_attributes)
-        end
-
-        def url
-          case @url
-          when Symbol
-            # helpers are not available until the component is rendered
-            @url = helpers.public_send(@url, record)
-          when Proc
-            @url = @url.call(record)
-          else
-            @url
-          end
-        end
-      end
-    end
-  end
-end

data/app/components/katalyst/tables/body_cell_component.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module Katalyst
-  module Tables
-    class BodyCellComponent < ViewComponent::Base # :nodoc:
-      include Katalyst::HtmlAttributes
-
-      attr_reader :record
-
-      def initialize(table, record, attribute, heading: false, **html_attributes)
-        super(**html_attributes)
-
-        @table     = table
-        @record    = record
-        @attribute = attribute
-        @type      = heading ? :th : :td
-      end
-
-      def before_render
-        # fallback if no content block is given
-        with_content(rendered_value) unless content?
-      end
-
-      def call
-        content # ensure content is set before rendering options
-
-        content_tag(@type, content, **html_attributes)
-      end
-
-      # @return the object for this row.
-      def object
-        @record
-      end
-
-      def value
-        @record.public_send(@attribute)
-      end
-
-      def rendered_value
-        value.to_s
-      end
-
-      def to_s
-        value.to_s
-      end
-
-      def inspect
-        "#<#{self.class.name} attribute: #{@attribute.inspect}, value: #{value.inspect}>"
-      end
-
-      # Backwards compatibility with tables 1.0
-      alias_method :options, :html_attributes=
-    end
-  end
-end

data/app/components/katalyst/tables/header/attachment_component.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-using Katalyst::HtmlAttributes::HasHtmlAttributes
-
-module Katalyst
-  module Tables
-    module Header
-      class AttachmentComponent < HeaderCellComponent
-        def default_html_attributes
-          super.merge_html(class: "type-attachment")
-        end
-      end
-    end
-  end
-end

data/app/components/katalyst/tables/header/boolean_component.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-using Katalyst::HtmlAttributes::HasHtmlAttributes
-
-module Katalyst
-  module Tables
-    module Header
-      class BooleanComponent < HeaderCellComponent
-        def default_html_attributes
-          super.merge_html(class: "type-boolean")
-        end
-      end
-    end
-  end
-end

data/app/components/katalyst/tables/header/currency_component.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-using Katalyst::HtmlAttributes::HasHtmlAttributes
-
-module Katalyst
-  module Tables
-    module Header
-      class CurrencyComponent < HeaderCellComponent
-        def default_html_attributes
-          super.merge_html(class: "type-currency")
-        end
-      end
-    end
-  end
-end

data/app/components/katalyst/tables/header/date_component.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-using Katalyst::HtmlAttributes::HasHtmlAttributes
-
-module Katalyst
-  module Tables
-    module Header
-      class DateComponent < HeaderCellComponent
-        def default_html_attributes
-          super.merge_html(class: "type-date")
-        end
-      end
-    end
-  end
-end

data/app/components/katalyst/tables/header/date_time_component.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-using Katalyst::HtmlAttributes::HasHtmlAttributes
-
-module Katalyst
-  module Tables
-    module Header
-      class DateTimeComponent < HeaderCellComponent
-        def default_html_attributes
-          super.merge_html(class: "type-datetime")
-        end
-      end
-    end
-  end
-end

data/app/components/katalyst/tables/header/link_component.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-using Katalyst::HtmlAttributes::HasHtmlAttributes
-
-module Katalyst
-  module Tables
-    module Header
-      class LinkComponent < HeaderCellComponent
-        def default_html_attributes
-          super.merge_html(class: "type-link")
-        end
-      end
-    end
-  end
-end

data/app/components/katalyst/tables/header/number_component.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-using Katalyst::HtmlAttributes::HasHtmlAttributes
-
-module Katalyst
-  module Tables
-    module Header
-      class NumberComponent < HeaderCellComponent
-        def default_html_attributes
-          super.merge_html(class: "type-number")
-        end
-      end
-    end
-  end
-end

data/app/components/katalyst/tables/header/rich_text_component.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-using Katalyst::HtmlAttributes::HasHtmlAttributes
-
-module Katalyst
-  module Tables
-    module Header
-      class RichTextComponent < HeaderCellComponent
-        def default_html_attributes
-          super.merge_html(class: "type-rich-text")
-        end
-      end
-    end
-  end
-end

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

@@ -1,97 +0,0 @@
-# frozen_string_literal: true
-
-using Katalyst::HtmlAttributes::HasHtmlAttributes
-
-module Katalyst
-  module Tables
-    class HeaderCellComponent < ViewComponent::Base # :nodoc:
-      include Frontend::Helper
-      include Katalyst::HtmlAttributes
-      include Sortable
-
-      delegate :object_name, :collection, :sorting, to: :@table
-
-      def initialize(table, attribute, label: nil, link: {}, width: nil, **html_attributes)
-        super(**html_attributes)
-
-        @table           = table
-        @attribute       = attribute
-        @value           = label
-        @width           = width
-        @link_attributes = link
-      end
-
-      def call
-        tag.th(**html_attributes) do
-          if sortable?(@attribute)
-            link_to(value, sort_url(@attribute), **link_attributes)
-          else
-            value
-          end
-        end
-      end
-
-      def value
-        if !@value.nil?
-          @value
-        elsif object_name.present?
-          translation
-        else
-          default_value
-        end
-      end
-
-      def translation(key = "activerecord.attributes.#{object_name}.#{@attribute}")
-        translate(key, default: default_value)
-      end
-
-      def default_value
-        @attribute.to_s.humanize.capitalize
-      end
-
-      def inspect
-        "#<#{self.class.name} attribute: #{@attribute.inspect}, value: #{@value.inspect}>"
-      end
-
-      # Backwards compatibility with tables 1.0
-      alias_method :options, :html_attributes=
-
-      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
-
-      def link_attributes
-        { data: { turbo_action: "replace" } }.merge_html(@link_attributes)
-      end
-
-      def default_html_attributes
-        sort_data.merge(width_data)
-      end
-
-      def width_data
-        return {} unless @width
-
-        { class: width_class }
-      end
-
-      def sort_data
-        return {} unless sorting&.supports?(collection, @attribute)
-
-        { data: { sort: sorting.status(@attribute) } }
-      end
-    end
-  end
-end

data/app/helpers/katalyst/tables/frontend/helper.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Katalyst
-  module Tables
-    module Frontend
-      # @deprecated Use {Katalyst::TableComponent} instead.
-      module Helper # :nodoc:
-        extend ActiveSupport::Concern
-
-        # Generates a url for applying/toggling sort for the given column.
-        #
-        # @param sort [String, nil] sort parameter to apply, or nil to remove sorting
-        # @return [String] URL for toggling column sorting
-        # @deprecated Use {Katalyst::TablesComponent} instead.
-        def sort_url_for(sort: nil, default: nil)
-          # Implementation inspired by pagy's `pagy_url_for` helper.
-          # Preserve any existing GET parameters
-          # CAUTION: these parameters are not sanitised
-          params = if sort && !sort.eql?(default)
-                     request.GET.merge("sort" => sort).except("page")
-                   else
-                     request.GET.except("page", "sort")
-                   end
-          query_string = params.empty? ? "" : "?#{Rack::Utils.build_nested_query(params)}"
-
-          "#{request.path}#{query_string}"
-        end
-      end
-    end
-  end
-end

data/app/javascript/tables/turbo/collection_controller.js

@@ -1,38 +0,0 @@
-import { Controller } from "@hotwired/stimulus";
-import { Turbo } from "@hotwired/turbo-rails";
-
-export default class TurboCollectionController extends Controller {
-  static values = {
-    query: String,
-    sort: String,
-  };
-
-  queryValueChanged(query) {
-    Turbo.navigator.history.replace(this.#url(query));
-  }
-
-  sortValueChanged(sort) {
-    document.querySelectorAll(this.#sortSelector).forEach((input) => {
-      if (input) input.value = sort;
-    });
-  }
-
-  get #sortSelector() {
-    return "input[name='sort']";
-  }
-
-  #url(query) {
-    const frame = this.element.closest("turbo-frame");
-    let url;
-
-    if (frame) {
-      url = new URL(frame.baseURI);
-    } else {
-      url = new URL(window.location.href);
-    }
-
-    url.search = query;
-
-    return url;
-  }
-}