Contents

module DryCrud
  module Table

    # Provides headers with sort links. Expects a method :sortable?(attr)
    # in the template/controller to tell if an attribute is sortable or not.
    # Extracted into an own module for convenience.
    module Sorting

      # Create a header with sort links and a mark for the current sort
      # direction.
      def sort_header(attr, label = nil)
        label ||= attr_header(attr)
        template.link_to(label, sort_params(attr)) + current_mark(attr)
      end

      # Same as :attrs, except that it renders a sort link in the header
      # if an attr is sortable.
      def sortable_attrs(*attrs)
        attrs.each { |a| sortable_attr(a) }
      end

      # Renders a sort link header, otherwise similar to :attr.
      def sortable_attr(attr, header = nil, &block)
        if template.sortable?(attr)
          attr(attr, sort_header(attr, header), &block)
        else
          attr(attr, header, &block)
        end
      end

      private

      # Request params for the sort link.
      def sort_params(attr)
        result = params.respond_to?(:to_unsafe_h) ? params.to_unsafe_h : params
        result.merge(sort: attr, sort_dir: sort_dir(attr), only_path: true)
      end

      # The sort mark, if any, for the given attribute.
      def current_mark(attr)
        if current_sort?(attr)
          # rubocop:disable Rails/OutputSafety
          (sort_dir(attr) == 'asc' ? ' ↑' : ' ↓').html_safe
          # rubocop:enable Rails/OutputSafety
        else
          ''
        end
      end

      # Returns true if the given attribute is the current sort column.
      def current_sort?(attr)
        params[:sort] == attr.to_s
      end

      # The sort direction to use in the sort link for the given attribute.
      def sort_dir(attr)
        current_sort?(attr) && params[:sort_dir] == 'asc' ? 'desc' : 'asc'
      end

      # Delegate to template.
      def params
        template.params
      end

    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
dry_crud-7.1.0	app/helpers/dry_crud/table/sorting.rb
dry_crud-6.0.0	app/helpers/dry_crud/table/sorting.rb
dry_crud-5.2.0	app/helpers/dry_crud/table/sorting.rb