jinrai 1.0.1 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f90cbb057b2d8ed397a95afbd1be11e53f9a12ee
-  data.tar.gz: 262d9de132390d3eb80e4641f38372950ac02967
+SHA256:
+  metadata.gz: bbffd9d3fbdce795ac45ee5c58f173cd34fddb6ce20b8c66bf4e6f252c9875c7
+  data.tar.gz: 3f9ad85bd9b04780ae643a3ccc2c52cb9c471b535a1425a3717fc816d26d0479
 SHA512:
-  metadata.gz: 2bce5e4bc9d332e8d3e3921296d624622dd347cfbfc402b426396c15704a207622e378fc4b31af93232f1e458f29f233f19e34a619d9ce394d649cdeacecb436
-  data.tar.gz: 0141f31333eef1a456fe15edec0feaa0b761fe3d32310d996072aaed5c80bfe7cf28c9f503ccd77db8b0c9b23b522a2ff2718a5ecde409e019aae58503a5345c
+  metadata.gz: b111141fe30caf1d9760495a7c938475831737604f9cf01543b5f104fd527dbba29b8ed56f470a5f73bb6815261344b0b4db9aa00e3d4af986c0d7082db348f7
+  data.tar.gz: bcb1ad0a8139c5873a95b79d2d11708a02f57d2ce51fceddea2a6965ff83479169cf52025448161a34cd8808494ffb9271a0f3151f6d947a2cee3dcb994a8c86

data/README.md

@@ -8,7 +8,7 @@ Jinrai is a awesome cursor based paginator
 Jinrai.configure do |config|
   config.default_cursor_per = 20 #=> User.cursor.count == 20
   config.default_cursor_format = :id, :name #=> cursor format will be "#{user.id}_#{user.name}"
-  config.cursor_sort_order = :desc
+  config.default_cursor_sort_order = :desc
 end
 ```
 
@@ -18,7 +18,7 @@ end
 class User < ApplicationRecord
   cursor_per 100
   cursor_format :name, :age
-  cursor_order :asc # default: :desc
+  cursor_sort_order :asc # default: :desc
 end
 
 User.cursor.count #=> 100

data/lib/jinrai/active_record/core.rb

@@ -2,6 +2,9 @@ require 'jinrai/active_record/finder_methods'
 
 module Jinrai
   module ActiveRecord
+    RecordNotFound   = Class.new(::ActiveRecord::RecordNotFound)
+    StatementInvalid = Class.new(::ActiveRecord::StatementInvalid)
+
     module Core
       extend ActiveSupport::Concern
 

data/lib/jinrai/active_record/cursor_methods.rb

@@ -6,10 +6,12 @@ module Jinrai
       include Jinrai::ConfigurationMethods
 
       def since_cursor
+        return unless first
         encode_cursor(first)
       end
 
       def till_cursor
+        return unless last
         encode_cursor(last)
       end
 
@@ -27,7 +29,8 @@ module Jinrai
 
       def encode_cursor(record)
         attributes = default_cursor_format.map do |attr|
-          record.send(attr)
+          value = record.send(attr)
+          value.respond_to?(:iso8601) ? value.iso8601 : value
         end
         Base64.urlsafe_encode64(attributes.join("_"))
       end

data/lib/jinrai/active_record/finder_methods.rb

@@ -7,43 +7,37 @@ module Jinrai
 
       included do
         include Jinrai::ConfigurationMethods
-
-        def to_cursor
-          cursor_format = self.class.default_cursor_format
-          attributes = cursor_format.map do |attribute|
-            self.send(attribute)
-          end
-          Base64.urlsafe_encode64(attributes.join("_"))
-        end
       end
 
       module ClassMethods
-
         def cursor(**options)
+          sort_order = options[:sort_order] || default_cursor_sort_order
           relation =
-            if default_cursor_sort_order == :desc
+            if sort_order == :desc
               cursoring(:lt, :gt, options[:since], options[:sort_at]).cursoring(:gt, :lt, options[:till], options[:sort_at])
-            elsif default_cursor_sort_order == :asc
+            elsif sort_order == :asc
               cursoring(:gt, :lt, options[:since], options[:sort_at]).cursoring(:lt, :gt, options[:till], options[:sort_at])
             end
           relation.extending_cursor
         end
 
         def after(cursor, **options)
+          sort_order = options[:sort_order] || default_cursor_sort_order
           relation =
-            if default_cursor_sort_order == :desc
+            if sort_order == :desc
               cursoring(:lt, :gt, cursor, options[:sort_at])
-            elsif default_cursor_sort_order == :asc
+            elsif sort_order == :asc
               cursoring(:gt, :lt, cursor, options[:sort_at])
             end
           relation.extending_cursor
         end
 
         def before(cursor, **options)
+          sort_order = options[:sort_order] || default_cursor_sort_order
           relation =
-            if default_cursor_sort_order == :desc
+            if sort_order == :desc
               cursoring(:gt, :lt, cursor, options[:sort_at])
-            elsif default_cursor_sort_order == :asc
+            elsif sort_order == :asc
               cursoring(:lt, :gt, cursor, options[:sort_at])
             end
           relation.extending_cursor
@@ -57,27 +51,33 @@ module Jinrai
         def cursoring(rank, rank_for_primary, cursor, sort_at)
           sort_at ||= primary_key
           if cursor
-            attributes = HashWithIndifferentAccess.new(decode_cursor(cursor))
-            id = find_by(attributes).id
+            attributes = default_attributes_from_cursor.call(decode_cursor(cursor))
+            pointed = find_by!(attributes)
 
             if sort_at != primary_key
-              condition_1 = arel_table[sort_at].send(rank, attributes[sort_at])
-              condition_2 = arel_table.grouping(arel_table[sort_at].eq(attributes[sort_at]).and(arel_table[primary_key].send(rank_for_primary, id)))
+              condition_1 = arel_table[sort_at].send(rank, pointed[sort_at])
+              condition_2 = arel_table.grouping(arel_table[sort_at].eq(pointed[sort_at]).and(arel_table[primary_key].send(rank_for_primary, pointed[primary_key])))
               relation = where(condition_1.or(condition_2))
             else
-              relation = where(arel_table[primary_key].send(rank, id))
+              relation = where(arel_table[primary_key].send(rank, pointed[primary_key]))
             end
           else
             relation = all
           end
           relation.order(sort_at => default_cursor_sort_order)
+        rescue ::ActiveRecord::StatementInvalid => e
+          # TODO: modify error message
+          raise Jinrai::ActiveRecord::StatementInvalid, e
+        rescue ::ActiveRecord::RecordNotFound
+          raise Jinrai::ActiveRecord::RecordNotFound,
+            "Could not find record cursor pointing, Check cursor_format settings."
         end
 
         private
 
         def decode_cursor(cursor)
           attributes = Base64.urlsafe_decode64(cursor).split("_")
-          default_cursor_format.zip(attributes).to_h
+          HashWithIndifferentAccess.new(default_cursor_format.zip(attributes).to_h)
         end
       end
     end

data/lib/jinrai/active_record/result.rb

@@ -3,9 +3,9 @@ module Jinrai
     module Result
       attr_writer :is_cursored
 
-      def initialize(*a)
+      def initialize(klass, **args)
         @is_cursored = false
-        super(*a)
+        super
       end
 
       def cursored?

data/lib/jinrai/config.rb

@@ -14,12 +14,14 @@ module Jinrai #:nodoc:
   class Config #:nodoc:
     attr_accessor :default_cursor_per,
                   :default_cursor_format,
-                  :default_cursor_sort_order
+                  :default_cursor_sort_order,
+                  :default_attributes_from_cursor
 
     def initialize
       @default_cursor_per = 20
       @default_cursor_format = %i[created_at id]
       @default_cursor_sort_order = :desc
+      @default_attributes_from_cursor = Proc.new { |decoded_cursor| decoded_cursor }
     end
   end
 end

data/lib/jinrai/configuration_methods.rb

@@ -8,8 +8,9 @@ module Jinrai #:nodoc:
         @_default_cursor_per = num.to_i
       end
 
-      def cursor_format(*attributes)
+      def cursor_format(*attributes, &block)
         @_default_cursor_format = attributes
+        @_default_attributes_from_cursor = block
       end
 
       def cursor_sort_order(rank)
@@ -27,6 +28,10 @@ module Jinrai #:nodoc:
       def default_cursor_sort_order
         @_default_cursor_sort_order || Jinrai.config.default_cursor_sort_order
       end
+
+      def default_attributes_from_cursor
+        @_default_attributes_from_cursor || Jinrai.config.default_attributes_from_cursor
+      end
     end
   end
 end

data/lib/jinrai/version.rb

@@ -1,3 +1,3 @@
 module Jinrai
-  VERSION = '1.0.1'
+  VERSION = '1.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jinrai
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.3
 platform: ruby
 authors:
 - atomiyama
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-12-21 00:00:00.000000000 Z
+date: 2022-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,34 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 5.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 5.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +72,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-rails
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +100,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Jinrai is a awesome Cursor type pagination Link.
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Jinrai is a awesome Cursor based pagination Link.
 email:
 - akifumi.tomiyama@studyplus.jp
 executables: []
@@ -88,7 +136,7 @@ homepage: https://github.com/studyplus/jinrai
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,9 +151,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
-summary: A cursor type pagination plugin for Rails
+summary: A cursor based pagination plugin for Rails
 test_files: []