autoforme 1.13.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bff68076c7cdf213c0142df9ab3809d33ede301c99f12e5cfbe7d1e111df30d
-  data.tar.gz: d2446bc814e6a19ebb70dfd46717ac596bb0aa4915abf02dd83aded973ba8d65
+  metadata.gz: 4a736d797ecc713bf84bca96606007e8eb02c19e83b698365417afcc44fe20f6
+  data.tar.gz: bb6237775d2413f4d57e6d6c30e458f8b0037d65ea3b87db83bbfa63affae2e5
 SHA512:
-  metadata.gz: '048c064a080ae50bd872be8e17a96f06e6f9eece5fb095c31121810edbe2f03d1f5db7a6562fb0d33c7229b1e1a49641246186f6567435664be646da836ce251'
-  data.tar.gz: 596b1caa6bfc6a91cf8745019df9c299e9315ace558388c9c5ba4fb44b7df18fdfd0aff0c9e5a7213c71e26ffb3fa12d3afed34e91c962e1ae258254413cded4
+  metadata.gz: 21db83b2b59a9b71679b21f5d1fffae43f7c73809e5ee3bfe7af70cb14faf768208c794b2adf27c20777f322ef2dfc15b352e88f34b32dc6ca91b036ad88d785
+  data.tar.gz: 8b0f1295ff5b59334658c34e4d90d80aff5c9778bf3717f7c43eabede1accc7cb95aafca9043ac2fb81eaf667b215bb7f40f45368cdf6c88ce44b8a15a98e202

data/CHANGELOG

@@ -1,3 +1,13 @@
+=== 1.14.0 (2025-10-02)
+
+* Support customizing the searching done for specific columns via column_search_filter (jeremyevans)
+
+* Support autoforme_framework Roda class method in Roda plugin, to allow for reflection (jeremyevans)
+
+* Omit invalid Next/Previous links instead of including them in a tag with a disabled attribute (jeremyevans)
+
+* Support pagination via filtering instead of offset using pagination_strategy :filter (requires unambiguous order) (jeremyevans)
+
 === 1.13.0 (2024-07-10)
 
 * Typecast primary key values before using them for lookup (jeremyevans)

data/README.rdoc

@@ -132,6 +132,9 @@ autocomplete_options :: Enable autocompletion for this model, with the given
                         :limit :: The number of results to return
                         :filter :: Similar to callback, but overriding the default filter
                                    (a case insensitive substring search on display)
+column_search_filter :: This should be a Proc that accepts a dataset, column, value, and request,
+                        and returns a filtered dataset. This allows for customizing the search filtering,
+                        so you can use non-columns/non-associations on the search form.
 eager :: Array of associations to eagerly load in separate queries
 eager_graph :: Array of associations to eager load in the same query
                (necessary if order or filter refers to them)
@@ -144,6 +147,8 @@ inline_mtm_associations :: Array of many to many association symbols to allow ed
 lazy_load_association_links :: Whether to show the association links directly on the show/edit pages,
                                or to load them via ajax on request
 mtm_associations :: Array of many to many association symbols to support editing on a separate page 
+pagination_strategy :: Set to :filter to paginate using a filter instead of using offsets. This requires
+                       the column have an unambiguous order.
 per_page :: Number of records to show per page on the browse and search pages
 session_value :: Sets up a filter and before_create hook that makes it so access is limited
                  to objects where the object's column value is the same as the session value

data/lib/autoforme/action.rb

@@ -139,7 +139,6 @@ module AutoForme
       end
 
       request.redirect(path)
-      nil
     end
 
     # Handle the current action, returning an HTML string containing the page content,
@@ -415,20 +414,41 @@ module AutoForme
     def table_pager(type, next_page)
       html = String.new
       html << '<ul class="pager">'
-      page = request.id.to_i
-      if page > 1
-        html << "<li><a href=\"#{url_for("#{type}/#{page-1}?#{h request.query_string}")}\">Previous</a></li>"
+      qs = next_qs = h request.query_string
+
+      if next_page.is_a?(Array)
+        # Filter pagination, next_page contains the values for the last record of current page
+        no_previous = true
+        if next_page.empty?
+          next_page = nil
+        else
+          next_qs = qs.dup
+          params = request.params.dup
+          next_page = next_page.map(&:to_s)
+          next_page = next_page[0] if next_page.length == 1
+          params["_after"] = next_page
+          next_qs = h Rack::Utils.build_nested_query(params)
+          following = prev = "0"
+        end
       else
-        html << '<li class="disabled"><a href="#">Previous</a></li>'
+        # Offset pagination, request id contains current page
+        page = request.id.to_i
+        page = 1 if page < 1
+        no_previous = page <= 1
+        prev = page-1
+        following = page+1
+      end
+
+      unless no_previous
+        html << "<li><a href=\"#{url_for("#{type}/#{prev}?#{qs}")}\">Previous</a></li>"
       end
+
       if next_page
-        page = 1 if page < 1
-        html << "<li><a href=\"#{url_for("#{type}/#{page+1}?#{h request.query_string}")}\">Next</a></li>"
-      else
-        html << '<li class="disabled"><a href="#">Next</a></li>'
+        html << "<li><a href=\"#{url_for("#{type}/#{following}?#{next_qs}")}\">Next</a></li>"
       end
+
       html << "</ul>"
-      html << "<p><a href=\"#{url_for("#{type}/csv?#{h request.query_string}")}\">CSV Format</a></p>"
+      html << "<p><a href=\"#{url_for("#{type}/csv?#{qs}")}\">CSV Format</a></p>"
     end
 
     # Show page used for browse/search pages.

data/lib/autoforme/framework.rb

@@ -36,9 +36,9 @@ module AutoForme
 
     opts_attribute :after_create, :after_destroy, :after_update, :association_links,
       :autocomplete_options, :before_action, :before_create, :before_destroy,
-      :before_edit, :before_new, :before_update, :column_options,
+      :before_edit, :before_new, :before_update, :column_options, :column_search_filter,
       :columns, :display_name, :filter, :form_attributes, :form_options,
-      :inline_mtm_associations, :lazy_load_association_links,
+      :inline_mtm_associations, :lazy_load_association_links, :pagination_strategy,
       :model_type, :mtm_associations, :order, :page_footer, :page_header, :per_page,
       :redirect, :supported_actions, :table_class, :show_html, :edit_html
 
@@ -118,6 +118,14 @@ module AutoForme
       handle_proc(association_links, model, type, request)
     end
 
+    def column_search_filter_for(model, dataset, column, value, request)
+      handle_proc(column_search_filter, model, dataset, column, value, request)
+    end
+
+    def pagination_strategy_for(model, type, request)
+      handle_proc(pagination_strategy, model, type, request)
+    end
+
     def show_html_for(obj, column, type, request)
       handle_proc(show_html, obj, column, type, request)
     end

data/lib/autoforme/frameworks/rails.rb

@@ -6,7 +6,10 @@ module AutoForme
       class Request < AutoForme::Request
         def initialize(request)
           @controller = request
-          @params = request.params
+          @params = {}
+          request.params.each do |k, v|
+            @params[k] = v
+          end
           @session = request.session
           @env = request.request.env
           @method = @env['REQUEST_METHOD']

data/lib/autoforme/model.rb

@@ -18,6 +18,11 @@ module AutoForme
     # Regexp for valid constant names, to prevent code execution.
     VALID_CONSTANT_NAME_REGEXP = /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/.freeze
 
+    # The default pagination strategy to use. Offset is used by default,
+    # as a filter strategy requires an unambiguous order, which the library
+    # cannot guarantee.
+    DEFAULT_PAGINATION_STRATEGY = :offset
+
     extend OptsAttributes
 
     # Create a new instance for the given model type and underlying model class
@@ -38,9 +43,9 @@ module AutoForme
       :autocomplete_options, :before_action, :before_create, :before_destroy,
       :before_edit, :before_new, :before_update, :class_display_name,
       :column_options, :columns, :display_name, :eager, :eager_graph,
-      :filter, :form_attributes, :form_options,
+      :filter, :form_attributes, :form_options, :column_search_filter,
       :inline_mtm_associations, :lazy_load_association_links, :link_name, :mtm_associations,
-      :order, :page_footer, :page_header, :per_page,
+      :order, :page_footer, :page_header, :per_page, :pagination_strategy,
       :redirect, :supported_actions, :table_class, :show_html, :edit_html
 
     def initialize(model, framework)
@@ -95,6 +100,14 @@ module AutoForme
       handle_proc(columns || framework.columns_for(model, type, request), type, request) || default_columns
     end
 
+    def pagination_strategy_for(type, request)
+      handle_proc(pagination_strategy || framework.pagination_strategy_for(model, type, request), type, request) || DEFAULT_PAGINATION_STRATEGY
+    end
+
+    def column_search_filter_for(dataset, column, value, request)
+      handle_proc(column_search_filter || framework.column_search_filter_for(model, dataset, column, value, request), dataset, column, value, request)
+    end
+
     # The options to use for the given column and request.  Instead of the model options overriding the framework
     # options, they are merged together.
     def column_options_for(type, request, column)

data/lib/autoforme/models/sequel.rb

@@ -177,7 +177,9 @@ module AutoForme
         ds = apply_associated_eager(:search, request, all_dataset_for(type, request))
         columns_for(:search_form, request).each do |c|
           if (v = params[c.to_s]) && !(v = v.to_s).empty?
-            if association?(c)
+            if filtered_ds = column_search_filter_for(ds, c, v, request)
+              ds = filtered_ds
+            elsif association?(c)
               ref = model.association_reflection(c)
               ads = ref.associated_dataset
               if model_class = associated_model_class(c)
@@ -212,13 +214,32 @@ module AutoForme
       def paginate(type, request, ds, opts={})
         return ds.all if opts[:all_results]
         limit = limit_for(type, request)
-        %r{\/(\d+)\z} =~ request.env['PATH_INFO']
-        offset = (($1||1).to_i - 1) * limit
-        objs = ds.limit(limit+1, (offset if offset > 0)).all
-        next_page = false
+        ds = ds.limit(limit+1)
+
+        if pagination_strategy_for(type, request) == :filter
+          order_cols = ds.send(:hash_key_symbols, Array(order_for(type, request)).map{|c| c.is_a?(S::SQL::OrderedExpression) ? c.expression : c})
+          after = Array(request.params["_after"])
+          if order_cols.length == after.length
+            begin
+              after = order_cols.zip(after).map{|c, v| typecast_value(c, v)}
+            rescue S::InvalidValue
+              # ignore pagination, assume first page
+            else
+              ds = ds.where(ds.send(:ignore_values_preceding, {}){after})
+            end
+          end
+        else # offset strategy, the default
+          %r{\/(\d+)\z} =~ request.env['PATH_INFO']
+          offset = (($1||1).to_i - 1) * limit
+          ds = ds.offset(offset) if offset > 0
+        end
+
+        objs = ds.all
+        next_page = order_cols && []
         if objs.length > limit
-          next_page = true
           objs.pop
+          last_obj = objs[-1]
+          next_page = after ? order_cols.map{|c| last_obj.send(c)} : true
         end
         [next_page, objs]
       end

data/lib/autoforme/version.rb

@@ -6,7 +6,7 @@ module AutoForme
   MAJOR = 1
 
   # The minor version of AutoForme, updated for new feature releases of AutoForme.
-  MINOR = 13
+  MINOR = 14
 
   # The patch version of AutoForme, updated only for bug fixes from the last
   # feature release.

data/lib/roda/plugins/autoforme.rb

@@ -14,6 +14,7 @@ class Roda
       # the options and block.
       def self.configure(app, opts={}, &block)
         app.instance_exec do
+          @autoforme_frameworks ||= {}
           @autoforme_routes ||= {}
           if block
             autoforme(opts, &block)
@@ -26,7 +27,13 @@ class Roda
         # options and block.  If the :name option is given, store
         # this configuration for the given name.
         def autoforme(opts={}, &block)
-          @autoforme_routes[opts[:name]] = ::AutoForme.for(:roda, self, opts, &block).route_proc
+          framework = @autoforme_frameworks[opts[:name]] = ::AutoForme.for(:roda, self, opts, &block)
+          @autoforme_routes[opts[:name]] = framework.route_proc
+        end
+
+        # Retrieve the framework the named or default AutoForme.
+        def autoforme_framework(name=nil)
+          @autoforme_frameworks[name]
         end
 
         # Retrieve the route proc for the named or default AutoForme.
@@ -37,6 +44,7 @@ class Roda
         # Copy the autoforme configurations into the subclass.
         def inherited(subclass)
           super
+          subclass.instance_variable_set(:@autoforme_frameworks, @autoforme_frameworks.dup)
           subclass.instance_variable_set(:@autoforme_routes, @autoforme_routes.dup)
         end
       end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: autoforme
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.14.0
 platform: ruby
 authors:
 - Jeremy Evans
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forme
@@ -221,9 +220,9 @@ email: code@jeremyevans.net
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.rdoc
 - CHANGELOG
 - MIT-LICENSE
+- README.rdoc
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -251,7 +250,6 @@ metadata:
   documentation_uri: http://autoforme.jeremyevans.net
   mailing_list_uri: https://github.com/jeremyevans/autoforme/discussions
   source_code_uri: https://github.com/jeremyevans/autoforme
-post_install_message:
 rdoc_options:
 - "--quiet"
 - "--line-numbers"
@@ -273,8 +271,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Web Administrative Console for Roda/Sinatra/Rails and Sequel::Model
 test_files: []