graphql-connections 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1206b9dbdd7d135f43b52b0a62b4d28b4d5d8c93bb5e8a18800ef5abcc5a6157
-  data.tar.gz: 509ba8323078d1dee9095c18ec227b8416967ad0ce51bb4e3bd2806f09a28a57
+  metadata.gz: '02926f990b7d1e58b3525574aa596bb9562c505748b5ec57bc6273c6b5f1392d'
+  data.tar.gz: 27b7eadc1484abdca5f63689a7f12a9ae342b4067701263c7c7e2a64d72ed575
 SHA512:
-  metadata.gz: 63f191221ff5b1e2133ad84bb8cb377941cad75de324310f18734729f5a519dae01f466a88539e895a155f32e39eccfab60f423271a220b4cf3fcfa33bfdbb3b
-  data.tar.gz: da4d990bcc8941fbce16049f0a4ea6aa642f73194a34bfb757c1c0080bd16da1736e4466f2ee7f2868dcc5ceebc8677b745a6c3ea43328561af8ad09f9c9e71f
+  metadata.gz: b23023ada99877a5a48fc7d5ae9c516a7ff85e0047ba1aa552b46c8b9bfc97e8fb68554cad0f8fefd5e23a76d4040f9e9a79c342709a8a97e6465e76cd4b541a
+  data.tar.gz: 7407e8990df1428fc8accfcbedca133fea7847e9052bd6aed828eb6dfbf5101166a18741e4e54033498898da6014ccaaa9150ffdd14b02fe0ba9039d6701487a

data/README.md

@@ -59,7 +59,9 @@ Also, you can pass the `:desc` option to reverse the relation:
 GraphQL::Connections::Stable.new(Message.all, keys: %w[name id], desc: true)
 ```
 
-**NOTE:** `:desc` option is not implemented for stable connections with `:primary_key` passed; if you need it—use keyset pagination or implement `:desc` option for us 🙂.
+```ruby
+GraphQL::Connections::Stable.new(Message.all, primary_key: :created_at, desc: true)
+```
 
 Also, you can disable opaque cursors by setting `opaque_cursor` param:
 

data/lib/graphql/connections/keyset/asc.rb

@@ -42,10 +42,10 @@ module GraphQL
             false
           end
         end
-        # rubocop:enable Naming/PredicateName, Metrics/AbcSize, Metrics/MethodLength
 
         private
 
+        # standard:disable Metrics/AbcSize, Metrics/MethodLength
         def limited_relation
           scope = sliced_relation
           nodes = []
@@ -78,6 +78,7 @@ module GraphQL
             .where(arel_table[primary_key].lt(before_cursor_primary_key))
             .or(relation.where(arel_table[field_key].lt(before_cursor_date)))
         end
+        # standard:enable Metrics/AbcSize, Metrics/MethodLength
       end
     end
   end

data/lib/graphql/connections/keyset/desc.rb

@@ -42,8 +42,8 @@ module GraphQL
             false
           end
         end
-        # rubocop:enable Naming/PredicateName, Metrics/AbcSize, Metrics/MethodLength
 
+        # standard:disable Metrics/AbcSize, Metrics/MethodLength
         def cursor_for(item)
           cursor = [item[field_key], item[primary_key]].map { |value| serialize(value) }.join(@separator)
           cursor = encode(cursor) if opaque_cursor
@@ -85,6 +85,7 @@ module GraphQL
             .where(arel_table[primary_key].gt(before_cursor_primary_key))
             .or(relation.where(arel_table[field_key].gt(before_cursor_date)))
         end
+        # standard:disable Metrics/AbcSize, Metrics/MethodLength
       end
     end
   end

data/lib/graphql/connections/primary_key/asc.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Connections
+    # Implements pagination by one field with asc order
+    module PrimaryKey
+      class Asc < Base
+        PAGE_COMPARABLE_METHODS = {
+          previous: {query: :lt, cursor: :lteq},
+          next: {query: :gt, cursor: :gteq}
+        }
+
+        SLICED_COMPARABLE_METHODS = {
+          after: :gt,
+          before: :lt
+        }.freeze
+
+        private
+
+        def first_limited_sorted_table
+          arel_table[primary_key].asc
+        end
+
+        def last_limited_sorted_table
+          arel_table[primary_key].desc
+        end
+      end
+    end
+  end
+end

data/lib/graphql/connections/primary_key/base.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Connections
+    module PrimaryKey
+      # Base class for PrimaryKey pagination implementations
+      class Base < ::GraphQL::Connections::Base
+        COMPARABLE_METHODS = %i[
+          gt lt lteq gteq
+        ].freeze
+
+        def initialize(*args, primary_key: nil, **kwargs)
+          @primary_key = primary_key
+
+          super(*args, **kwargs)
+        end
+
+        def has_previous_page
+          return false if nodes.empty?
+
+          if last
+            items_exist?(type: :query, search: nodes.first[primary_key], page_type: :previous)
+          elsif after
+            items_exist?(type: :cursor, search: after_cursor, page_type: :previous)
+          else
+            false
+          end
+        end
+
+        def has_next_page
+          return false if nodes.empty?
+
+          if first
+            items_exist?(type: :query, search: nodes.last[primary_key], page_type: :next)
+          elsif before
+            items_exist?(type: :cursor, search: before_cursor, page_type: :next)
+          else
+            false
+          end
+        end
+
+        def cursor_for(item)
+          cursor = serialize(item[primary_key])
+          cursor = encode(cursor) if opaque_cursor
+          cursor
+        end
+
+        private
+
+        def page_comparable_method(query_type:, page_type:)
+          self.class::PAGE_COMPARABLE_METHODS.fetch(page_type).fetch(query_type)
+        end
+
+        def items_exist?(type:, search:, page_type:)
+          comparable_method = page_comparable_method(query_type: type, page_type: page_type)
+
+          if COMPARABLE_METHODS.exclude?(comparable_method)
+            raise ArgumentError.new("Unknown #{comparable_method} comparable type. Allowed #{COMPARABLE_METHODS.join(", ")}")
+          end
+
+          items.where(arel_table[primary_key].send(comparable_method, search)).exists?
+        end
+
+        def limited_relation
+          scope = sliced_relation
+          nodes = []
+
+          if first
+            nodes |=
+              scope
+                .reorder(first_limited_sorted_table)
+                .limit(first)
+                .to_a
+          end
+
+          if last
+            nodes |=
+              scope
+                .reorder(last_limited_sorted_table)
+                .limit(last)
+                .to_a.reverse!
+          end
+
+          nodes
+        end
+
+        def sliced_relation
+          items
+            .yield_self { |s| after ? sliced_items(items: s, cursor: after_cursor, type: :after) : s }
+            .yield_self { |s| before ? sliced_items(items: s, cursor: before_cursor, type: :before) : s }
+        end
+
+        def sliced_items(items:, cursor:, type:)
+          items.where(arel_table[primary_key].send(sliced_comparable_method(type), cursor))
+        end
+
+        def sliced_comparable_method(type)
+          self.class::SLICED_COMPARABLE_METHODS.fetch(type.to_sym)
+        end
+
+        def first_limited_sorted_table
+          raise NotImplementedError.new("method \"#{__method__}\" should be implemented in #{self.class.name} class")
+        end
+
+        def last_limited_sorted_table
+          raise NotImplementedError.new("method \"#{__method__}\" should be implemented in #{self.class.name} class")
+        end
+      end
+    end
+  end
+end

data/lib/graphql/connections/primary_key/desc.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Connections
+    # Implements pagination by one field with desc order
+    module PrimaryKey
+      class Desc < Base
+        PAGE_COMPARABLE_METHODS = {
+          previous: {query: :gt, cursor: :gteq},
+          next: {query: :lt, cursor: :lteq}
+        }.freeze
+
+        SLICED_COMPARABLE_METHODS = {
+          after: :lt,
+          before: :gt
+        }.freeze
+
+        private
+
+        def first_limited_sorted_table
+          arel_table[primary_key].desc
+        end
+
+        def last_limited_sorted_table
+          arel_table[primary_key].asc
+        end
+      end
+    end
+  end
+end

data/lib/graphql/connections/stable.rb

@@ -14,9 +14,9 @@ module GraphQL
     module Stable
       def self.new(*args, desc: false, keys: nil, **kwargs)
         if kwargs[:primary_key] || keys.nil?
-          raise NotImplementedError, "desc connection is not implemented yet" if desc
+          cls = desc ? GraphQL::Connections::PrimaryKey::Desc : GraphQL::Connections::PrimaryKey::Asc
 
-          return GraphQL::Connections::KeyAsc.new(*args, **kwargs)
+          return cls.new(*args, **kwargs)
         end
 
         raise ArgumentError, "keyset for more that 2 keys is not implemented yet" if keys.length > 2

data/lib/graphql/connections/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module Paging
-    VERSION = "1.2.0"
+    VERSION = "1.4.0"
   end
 end

data/lib/graphql/connections.rb

@@ -11,10 +11,13 @@ end
 require "graphql/connections/stable"
 
 require "graphql/connections/base"
-require "graphql/connections/key_asc"
 
 require "graphql/connections/keyset/base"
 require "graphql/connections/keyset/asc"
 require "graphql/connections/keyset/desc"
 
+require "graphql/connections/primary_key/base"
+require "graphql/connections/primary_key/asc"
+require "graphql/connections/primary_key/desc"
+
 require "graphql/connections/chewy"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-connections
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Misha Merkushin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-04 00:00:00.000000000 Z
+date: 2023-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -162,14 +162,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
@@ -190,14 +190,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.0.0
 description:
 email:
 - merkushin.m.s@gmail.com
@@ -210,10 +210,12 @@ files:
 - lib/graphql/connections.rb
 - lib/graphql/connections/base.rb
 - lib/graphql/connections/chewy.rb
-- lib/graphql/connections/key_asc.rb
 - lib/graphql/connections/keyset/asc.rb
 - lib/graphql/connections/keyset/base.rb
 - lib/graphql/connections/keyset/desc.rb
+- lib/graphql/connections/primary_key/asc.rb
+- lib/graphql/connections/primary_key/base.rb
+- lib/graphql/connections/primary_key/desc.rb
 - lib/graphql/connections/stable.rb
 - lib/graphql/connections/version.rb
 homepage: https://github.com/bibendi/graphql-connections
@@ -229,14 +231,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: GraphQL cursor-based stable pagination to work with Active Record relations

data/lib/graphql/connections/key_asc.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-module GraphQL
-  module Connections
-    # Implements pagination by one field with asc order
-    class KeyAsc < ::GraphQL::Connections::Base
-      def initialize(*args, primary_key: nil, **kwargs)
-        @primary_key = primary_key
-
-        super(*args, **kwargs)
-      end
-
-      def has_previous_page
-        if last
-          nodes.any? && items.where(arel_table[primary_key].lt(nodes.first[primary_key])).exists?
-        elsif after
-          items.where(arel_table[primary_key].lteq(after_cursor)).exists?
-        else
-          false
-        end
-      end
-
-      def has_next_page
-        if first
-          nodes.any? && items.where(arel_table[primary_key].gt(nodes.last[primary_key])).exists?
-        elsif before
-          items.where(arel_table[primary_key].gteq(before_cursor)).exists?
-        else
-          false
-        end
-      end
-
-      def cursor_for(item)
-        cursor = serialize(item[primary_key])
-        cursor = encode(cursor) if opaque_cursor
-        cursor
-      end
-
-      private
-
-      def limited_relation
-        scope = sliced_relation
-        nodes = []
-
-        if first
-          nodes |= scope
-            .reorder(arel_table[primary_key].asc)
-            .limit(first)
-            .to_a
-        end
-
-        if last
-          nodes |= scope
-            .reorder(arel_table[primary_key].desc)
-            .limit(last)
-            .to_a.reverse!
-        end
-
-        nodes
-      end
-
-      def sliced_relation
-        items
-          .yield_self { |s| after ? s.where(arel_table[primary_key].gt(after_cursor)) : s }
-          .yield_self { |s| before ? s.where(arel_table[primary_key].lt(before_cursor)) : s }
-      end
-    end
-  end
-end