pagy 9.4.0 → 43.5.5

data/lib/pagy/keyset.rb

@@ -1,118 +0,0 @@
-# See Pagy API documentation: https://ddnexus.github.io/pagy/docs/api/keyset
-# frozen_string_literal: true
-
-require 'json'
-require_relative 'b64'
-require_relative 'shared_methods'
-
-class Pagy
-  # Implement wicked-fast keyset pagination for big data
-  class Keyset
-    class TypeError < ::TypeError; end
-
-    include SharedMethods
-
-    # Pick the right adapter for the set
-    def self.new(set, **vars)
-      if self == Pagy::Keyset
-        if defined?(::ActiveRecord) && set.is_a?(::ActiveRecord::Relation)
-          ActiveRecord
-        elsif defined?(::Sequel) && set.is_a?(::Sequel::Dataset)
-          Sequel
-        else
-          raise TypeError, "expected set to be an instance of ActiveRecord::Relation or Sequel::Dataset; got #{set.class}"
-        end.new(set, **vars)
-      else
-        allocate.tap { |instance| instance.send(:initialize, set, **vars) }
-      end
-    end
-
-    attr_reader :latest  # Other readers from SharedMethods
-
-    def initialize(set, **vars)
-      default = DEFAULT.slice(:limit, :page_param,                    # from pagy
-                              :headers,                               # from headers extra
-                              :jsonapi,                               # from jsonapi extra
-                              :limit_param, :limit_max, :limit_extra) # from limit_extra
-      assign_vars({ **default, page: nil }, vars)
-      assign_limit
-      @set    = set
-      @page   = @vars[:page]
-      @keyset = extract_keyset
-      raise InternalError, 'the set must be ordered' if @keyset.empty?
-      return unless @page
-
-      latest  = JSON.parse(B64.urlsafe_decode(@page)).transform_keys(&:to_sym)
-      @latest = typecast_latest(latest)
-      raise InternalError, 'page and keyset are not consistent' \
-            unless @latest.keys == @keyset.keys
-    end
-
-    # Return the next page
-    def next
-      records
-      return unless @more
-
-      @next ||= begin
-                  hash = keyset_attributes_from(@records.last)
-                  json = @vars[:jsonify_keyset_attributes]&.(hash) || hash.to_json
-                  B64.urlsafe_encode(json)
-                end
-    end
-
-    # Fetch the array of records for the current page
-    def records
-      @records ||= begin
-                     @set = apply_select if select?
-                     if @latest
-                       # :nocov:
-                       @set = @vars[:after_latest]&.(@set, @latest) || # deprecated
-                              # :nocov:
-                              @vars[:filter_newest]&.(@set, @latest, @keyset) ||
-                              filter_newest
-                     end
-                     records = @set.limit(@limit + 1).to_a
-                     @more   = records.size > @limit && !records.pop.nil?
-                     records
-                   end
-    end
-
-    protected
-
-    # Prepare the literal query string (complete with the placeholders for value interpolation)
-    # used to filter the newest records.
-    # For example:
-    # With a set like Pet.order(animal: :asc, name: :desc, id: :asc) it returns the following string:
-    # ( "pets"."animal" = :animal AND "pets"."name" = :name AND "pets"."id" > :id ) OR
-    # ( "pets"."animal" = :animal AND "pets"."name" < :name ) OR
-    # ( "pets"."animal" > :animal )
-    # When :tuple_comparison is enabled, and if the order is all :asc or all :desc,
-    # with a set like Pet.order(:animal, :name, :id) it returns the following string:
-    # ( "pets"."animal", "pets"."name", "pets"."id" ) > ( :animal, :name, :id )
-    def filter_newest_query
-      operator = { asc: '>', desc: '<' }
-      directions = @keyset.values
-      name = quoted_identifiers(@set.model.table_name)
-
-      if @vars[:tuple_comparison] && (directions.all?(:asc) || directions.all?(:desc))
-        placeholders = @keyset.keys.map { |column| ":#{column}" }.join(', ')
-        "( #{name.values.join(', ')} ) #{operator[directions.first]} ( #{placeholders} )"
-      else
-        keyset = @keyset.to_a
-        where  = []
-        until keyset.empty?
-          last_column, last_direction = keyset.pop
-          query = +'( '
-          query << (keyset.map { |column, _d| "#{name[column]} = :#{column}" } \
-                    << "#{name[last_column]} #{operator[last_direction]} :#{last_column}").join(' AND ')
-          query << ' )'
-          where << query
-        end
-        where.join(' OR ')
-      end
-    end
-  end
-end
-
-require_relative 'keyset/active_record'
-require_relative 'keyset/sequel'

data/lib/pagy/shared_methods.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-class Pagy
-  # Shared with Keyset
-  module SharedMethods
-    attr_reader :page, :limit, :vars
-
-    # Validates and assign the passed vars: var must be present and value.to_i must be >= to min
-    def assign_and_check(name_min)
-      name_min.each do |name, min|
-        raise VariableError.new(self, name, ">= #{min}", @vars[name]) \
-              unless @vars[name]&.respond_to?(:to_i) && instance_variable_set(:"@#{name}", @vars[name].to_i) >= min
-      end
-    end
-
-    # Assign @limit (overridden by the gearbox extra)
-    def assign_limit
-      assign_and_check(limit: 1)
-    end
-
-    # Assign @vars
-    def assign_vars(default, vars)
-      @vars = { **default, **vars.delete_if { |k, v| default.key?(k) && (v.nil? || v == '') } }
-    end
-  end
-end

data/lib/pagy/url_helpers.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-class Pagy
-  # Provide the helpers to handle the url in frontend and backend
-  module UrlHelpers
-    # Return the URL for the page, relying on the params method and Rack by default.
-    # It supports all Rack-based frameworks (Sinatra, Padrino, Rails, ...).
-    # For non-rack environments you can use the standalone extra
-    def pagy_url_for(pagy, page, absolute: false, fragment: nil, **_)
-      vars         = pagy.vars
-      query_params = request.GET.clone(freeze: false)
-      query_params.merge!(vars[:params].transform_keys(&:to_s)) if vars[:params].is_a?(Hash)
-      pagy_set_query_params(page, vars, query_params)
-      query_params = vars[:params].(query_params) if vars[:params].is_a?(Proc)
-      query_string = "?#{Rack::Utils.build_nested_query(query_params)}"
-      "#{request.base_url if absolute}#{vars[:request_path] || request.path}#{query_string}#{fragment}"
-    end
-
-    # Add the page and limit params
-    # Overridable by the jsonapi extra
-    def pagy_set_query_params(page, vars, query_params)
-      query_params[vars[:page_param].to_s]  = page
-      query_params[vars[:limit_param].to_s] = vars[:limit] if vars[:limit_extra]
-    end
-  end
-end

data/stylesheets/pagy.scss

@@ -1,48 +0,0 @@
-.pagy {
-  display: flex;
-  font-family: sans-serif;
-  font-size: 0.875rem;
-  line-height: 1.25rem;
-  font-weight: 600;
-  color: rgb(107 114 128);
-  & > :not([hidden]) ~ :not([hidden]) {
-    --space-reverse: 0;
-    margin-right: calc(0.25rem * var(--space-reverse));
-    margin-left: calc(0.25rem * calc(1 - var(--space-reverse)));
-  }
-
-  a:not(.gap) {
-    display: block;
-    text-decoration: none;
-    border-radius: 0.5rem;
-    background-color: rgb(229 231 235);
-    padding: 0.25rem 0.75rem;
-    color: inherit;
-    &:hover {
-      background-color: rgb(209 213 219);
-    }
-    &:not([href]) { /* disabled links */
-      cursor: default;
-      background-color: rgb(243 244 246);
-      color: rgb(209 213 219);
-    }
-    &.current {
-      background-color: rgb(156 163 175);
-      color: rgb(255 255 255);
-    }
-  }
-
-  label {
-    white-space: nowrap;
-    display: inline-block;
-    border-radius: 0.5rem;
-    background-color: rgb(229 231 235);
-    padding: 0.125rem 0.75rem;
-    input {
-      line-height: 1.5rem;
-      border-radius: 0.375rem;
-      border-style: none;
-      background-color: rgb(243 244 246);
-    }
-  }
-}

data/stylesheets/pagy.tailwind.css

@@ -1,21 +0,0 @@
-.pagy {
-  @apply flex space-x-1 font-semibold text-sm text-gray-500;
-  a:not(.gap) {
-    @apply block rounded-lg px-3 py-1 bg-gray-200;
-    &:hover {
-      @apply bg-gray-300;
-    }
-    &:not([href]) { /* disabled links */
-      @apply text-gray-300 bg-gray-100 cursor-default;
-    }
-    &.current {
-      @apply text-white bg-gray-400;
-    }
-  }
-  label {
-    @apply inline-block whitespace-nowrap bg-gray-200 rounded-lg px-3 py-0.5;
-    input {
-      @apply bg-gray-100 border-none rounded-md;
-    }
-  }
-}