katalyst-tables 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fff2924a5584c83799ccce74292d2597083e81fd771d24022a517f38e89147ef
-  data.tar.gz: d0230ed5a686ef5f5cedeb54f96ff8a206955d718a66420940087550958f7997
+  metadata.gz: 5482118f21175e8c1dbff1a397fa7b5ff68480783a2c47da2a92c0436c66e739
+  data.tar.gz: 99e70f74ef353cce895305e5ad39a98dc690efd7f0c68d4305867fbcdc23c941
 SHA512:
-  metadata.gz: 1655096befcbe0fcd8e11e3bf7240b6975ca3d6d1c3eef6e09d22b04aadd5697b37ebc124b9ebb0ddc7d1742e947a5d42c47f70f2e803bb9e2f04b54517cc99a
-  data.tar.gz: eca6c92288908ef026165bef43b8450187a3e101acfa94e67f8cf635125ade4567eab914bc1f44cae0afef80561efbd226302e9787a007e1bc5fd82e0fe6a5cf
+  metadata.gz: 219380d0ccb99e001c9604594d0aa68a58925bbd745d87898af359316192e61727d3549c4ab64198c31656c663ec00809d93ddc8034921143f8169fcb49f7769
+  data.tar.gz: b9d8a9e03604f9b39389d218bfceb4d354343bd0d1da4ff3bd7ca55f66446ba8f5fbc8430b9d5b22974f1210eed344ce0d579bccb209e29a0d35ca59982d4c63

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [1.1.0] - 2023-07-18
+
+- Replaces `param_key` with `i18n_key` for attribute lookup in locale file
+- Remove controller and url helpers from backend
+  - No changes required to existing code unless you were using the internal
+    classes directly
+
 ## [1.0.0] - 2022-03-23
 
 - Initial release

data/lib/katalyst/tables/backend/sort_form.rb

@@ -10,11 +10,9 @@ module Katalyst
 
         attr_accessor :column, :direction
 
-        def initialize(controller, column: nil, direction: nil)
+        def initialize(column: nil, direction: nil)
           self.column    = column
           self.direction = direction
-
-          @controller = controller
         end
 
         # Returns true if the given collection supports sorting on the given
@@ -38,35 +36,19 @@ module Katalyst
           direction if column.to_s == self.column
         end
 
-        # Generates a url for applying/toggling sort for the given column.
+        # Calculates the sort parameter to apply when the given column is toggled.
         #
-        # @param column [String, Symbol] the table column as defined in table_with
-        # @return [String] URL for use as a link in a column header
-        def url_for(column)
-          # Implementation inspired by pagy's `pagy_url_for` helper.
-
-          request = @controller.request
-
-          # Preserve any existing GET parameters
-          # CAUTION: these parameters are not sanitised
-          params       = request.GET.merge("sort" => "#{column} #{toggle_direction(column)}").except("page")
-          query_string = params.empty? ? "" : "?#{Rack::Utils.build_nested_query(params)}"
-
-          "#{request.path}#{query_string}"
-        end
-
-        # Generates a url for the current page without any sorting parameters.
-        #
-        # @return [String] URL for use as a link in a column header
-        def unsorted_url
-          request = @controller.request
-
-          # Preserve any existing GET parameters but remove sort.
-          # CAUTION: these parameters are not sanitised
-          params       = request.GET.except("sort", "page")
-          query_string = params.empty? ? "" : "?#{Rack::Utils.build_nested_query(params)}"
+        # @param column [String, Symbol]
+        # @return [String]
+        def toggle(column)
+          return "#{column} asc" unless column.to_s == self.column
 
-          "#{request.path}#{query_string}"
+          case direction
+          when "asc"
+            "#{column} desc"
+          when "desc"
+            "#{column} asc"
+          end
         end
 
         # Apply the constructed sort ordering to the collection.
@@ -92,17 +74,6 @@ module Katalyst
         def clear!
           self.column = self.direction = nil
         end
-
-        def toggle_direction(column)
-          return "asc" unless column.to_s == self.column
-
-          case direction
-          when "asc"
-            "desc"
-          when "desc"
-            "asc"
-          end
-        end
       end
     end
   end

data/lib/katalyst/tables/backend.rb

@@ -22,8 +22,7 @@ module Katalyst
         column, direction = params[:sort]&.split(" ")
         direction         = "asc" unless SortForm::DIRECTIONS.include?(direction)
 
-        SortForm.new(self,
-                     column: column,
+        SortForm.new(column: column,
                      direction: direction)
                 .apply(collection)
       end

data/lib/katalyst/tables/frontend/builder/base.rb

@@ -25,6 +25,7 @@ module Katalyst
           delegate :content_tag,
                    :link_to,
                    :render,
+                   :request,
                    :translate,
                    :with_output_buffer,
                    to: :template

data/lib/katalyst/tables/frontend/builder/header_cell.rb

@@ -46,7 +46,7 @@ module Katalyst
 
           def sort_link(content)
             (@html_options["data"] ||= {})["sort"] = sort.status(method)
-            link_to(content, @table.sort.url_for(method))
+            link_to(content, sort_url_for(sort: sort.toggle(method)))
           end
         end
       end

data/lib/katalyst/tables/frontend/helper.rb

@@ -4,6 +4,22 @@ module Katalyst
   module Tables
     module Frontend
       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
+        def sort_url_for(sort: nil)
+          # Implementation inspired by pagy's `pagy_url_for` helper.
+          # Preserve any existing GET parameters
+          # CAUTION: these parameters are not sanitised
+          params       = request.GET.merge("sort" => sort).except("page")
+          query_string = params.empty? ? "" : "?#{Rack::Utils.build_nested_query(params)}"
+
+          "#{request.path}#{query_string}"
+        end
+
         private
 
         def html_options_for_table_with(html: {}, **options)

data/lib/katalyst/tables/frontend.rb

@@ -17,7 +17,7 @@ module Katalyst
       def table_with(collection:, **options, &block)
         table_options = options.slice(:header, :object_name, :sort)
 
-        table_options[:object_name] ||= collection.try(:model_name)&.param_key
+        table_options[:object_name] ||= collection.try(:model_name)&.i18n_key
 
         html_options = html_options_for_table_with(**options)
 

data/lib/katalyst/tables/version.rb

@@ -2,6 +2,6 @@
 
 module Katalyst
   module Tables
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-tables
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Katalyst Interactive
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-23 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
+date: 2023-07-18 00:00:00.000000000 Z
+dependencies: []
 description: Builder-style HTML table generator for building tabular index views.
   Supports sorting by columns.
 email:
@@ -56,7 +42,7 @@ metadata:
   homepage_uri: https://github.com/katalyst/katalyst-tables
   source_code_uri: https://github.com/katalyst/katalyst-tables
   changelog_uri: https://github.com/katalyst/katalyst-tables/blobs/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -71,8 +57,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.12
+signing_key:
 specification_version: 4
 summary: HTML table generator for Rails views
 test_files: []