graphql-connections 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: faf6bee6dc175eb574286710382830d67b0bafdc8c0c23b78606781987bff57f
-  data.tar.gz: 78dfb742ac57250f12d80505225ed739fcde8fa35056f6338d673b04ae8c781f
+  metadata.gz: 17bf53a70dde489ced3c574a122728fd47122369a7e50ef8d45f5cf9c8743a09
+  data.tar.gz: 4f0b7158004251fced3b9989a0b0e1251e79f93208372b6c12aa60003816defd
 SHA512:
-  metadata.gz: 74ce335eae78448a120893aa47700e2766b8c186f2be45dd13adf63d9c00269d52f0c47ca487f216dac83b55ff9dfe7a045675543e0d2c3de3a9149f1e5d0a8a
-  data.tar.gz: 37c6bd839df707fb469d19519c7b9e07f33825bfc5802bf5ae4325b44e6f51d4cb2327627ed7f0c2e2b74dfa82a5cc3554071820603188dcdae0abd3598b500a
+  metadata.gz: 4d4e4beaa0f3124dfbfe6d99cfe1e911b38f24aee3fe6072aa69e38b9303042748f0ca18e4df973e67895901cf15978d5aabe4ad02396ae531cd1e1024df87d9
+  data.tar.gz: a981adbe63d036bf326a8ab6c0bd6a2fdf1b071f003f6665fab8302c48c9e69a1679353238c33d01f4a3469c3ae39363a2247b02bec703206ef4f30e457c8761

data/README.md

@@ -31,6 +31,18 @@ def messages
 end
 ```
 
+Records are sorted by model's primary key by default. You can change this behaviour by providing `primary_key` param:
+
+```ruby
+GraphQL::Connections::Stable.new(Message.all, primary_key: :created_at)
+```
+
+Also, you can disable opaque cursors by setting `opaque_cursor` param:
+
+```ruby
+GraphQL::Connections::Stable.new(Message.all, opaque_cursor: false)
+```
+
 Or you can apply a stable connection to all Active Record relations returning by any field:
 
 ```ruby

data/lib/graphql/connections/stable.rb

@@ -12,8 +12,20 @@ module GraphQL
     # For more information see GraphQL Cursor Connections Specification
     # https://relay.dev/graphql/connections.htm
     class Stable < ::GraphQL::Pagination::Connection
+      attr_reader :opaque_cursor
+
       delegate :arel_table, to: :items
-      delegate :primary_key, to: "items.model"
+
+      def initialize(*args, primary_key: nil, opaque_cursor: true, **kwargs)
+        @primary_key = primary_key
+        @opaque_cursor = opaque_cursor
+
+        super(*args, **kwargs)
+      end
+
+      def primary_key
+        @primary_key ||= items.model.primary_key
+      end
 
       def nodes
         @nodes ||= limited_relation
@@ -21,7 +33,7 @@ module GraphQL
 
       def has_previous_page # rubocop:disable Naming/PredicateName
         if last
-          nodes.any? && items.where(arel_table[primary_key].lt(nodes.first.id)).exists?
+          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
@@ -31,7 +43,7 @@ module GraphQL
 
       def has_next_page # rubocop:disable Naming/PredicateName
         if first
-          nodes.any? && items.where(arel_table[primary_key].gt(nodes.last.id)).exists?
+          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
@@ -40,11 +52,22 @@ module GraphQL
       end
 
       def cursor_for(item)
-        encode(item.id.to_s)
+        cursor = serialize(item[primary_key])
+        cursor = encode(cursor) if opaque_cursor
+        cursor
       end
 
       private
 
+      def serialize(cursor)
+        case cursor
+        when Time, DateTime, Date
+          cursor.iso8601
+        else
+          cursor.to_s
+        end
+      end
+
       def limited_relation
         scope = sliced_relation
         nodes = []
@@ -73,11 +96,11 @@ module GraphQL
       end
 
       def after_cursor
-        @after_cursor ||= decode(after)
+        @after_cursor ||= opaque_cursor ? decode(after) : after
       end
 
       def before_cursor
-        @before_cursor ||= decode(before)
+        @before_cursor ||= opaque_cursor ? decode(before) : before
       end
     end
   end

data/lib/graphql/connections/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module Paging
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-connections
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Misha Merkushin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-06 00:00:00.000000000 Z
+date: 2020-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -173,9 +173,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="