graphql-connections 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9c9ec5b3fb2eff5eb12781de11a726576630f03381b4d0d12f334bf1c0daad5
-  data.tar.gz: 57fc193b3559ae72cd6ffb75b14ceafe4e3e73371e09b6204f2ead111b9023a9
+  metadata.gz: ef27f5fb3f9d555769a1328f85b342b65b472e2d282a0e46296ba91441572641
+  data.tar.gz: dc5a4b2884b5266acad35c37b400fade1ea3850beaa2a03eb2d2974276bcd02a
 SHA512:
-  metadata.gz: 84d109d7e71943db1522c6d0beb12403a8c442dfd208e39048b175e9410f0d44cec75a1b77942fec35fcf1925532a6909ba706b80525c6d36c64f4d3bf426846
-  data.tar.gz: d5c7ebc8dd7d72b30069f619fedb548cf6b3828db686cefbe490d65b9ae0dd0e5454a83634386293d7c0a473969b93eccaf315d89740f061635046ff4ccba2f4
+  metadata.gz: 2b7ba37f332c49b5238969a683c1cdfbdcec8c76074d1e3d3903e1d2f8668bed48ea069a55cd65ed49f8ee6dceb7b5022dbfee2d95b1ca8452bb15d1b5d04053
+  data.tar.gz: 5375969fb009a1e7e7691f19fab5c0c60befc071d4cebf5e73a7854831508ee240e9209daeb4c33cf1f972cda56524fc97862105d2b0e8c0161a14e142fc3f3c

data/README.md

@@ -21,6 +21,8 @@ gem "graphql-connections"
 
 ## Usage
 
+### ActiveRecord
+
 You can use a stable connection wrapper on a specific field:
 
 ```ruby
@@ -31,17 +33,70 @@ 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)
+```
+
+In case when you want records to be sorted by more than one field (i.e., _keyset pagination_), you can use `keys` param:
+
+```ruby
+GraphQL::Connections::Stable.new(Message.all, keys: %w[name id])
+```
+
+When you pass only one key, a primary key will be added as a second one:
+
+```ruby
+GraphQL::Connections::Stable.new(Message.all, keys: [:name])
+```
+
+**NOTE:** Currently we support maximum two keys in the keyset.
+
+Also, you can pass the `:desc` option to reverse the relation:
+
+```ruby
+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 🙂.
+
+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
 class ApplicationSchema < GraphQL::Schema
-  use GraphQL::Pagination::Connections
-
   connections.add(ActiveRecord::Relation, GraphQL::Connections::Stable)
 end
 ```
 
-**NOTE:** Don't use stable connections for relations whose ordering is too complicated for cursor generation. 
+**NOTE:** Don't use stable connections for relations whose ordering is too complicated for cursor generation.
+
+### Elasticsearch via Chewy
+
+Register connection for all Chewy requests:
+
+```ruby
+class ApplicationSchema < GraphQL::Schema
+  connections.add(Chewy::Search::Request, GraphQL::Connections::ChewyConnection)
+end
+```
+
+And define field like below:
+
+```ruby
+field :messages, Types::Message.connection_type, null: false
+
+def messages
+  CitiesIndex.query(match: {name: "Moscow"})
+end
+
+**NOTE:** Using `first` and `last`arguments simultaneously is not supported yet.
 
 ## Development
 

data/lib/graphql/connections.rb

@@ -9,3 +9,12 @@ module GraphQL
 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/chewy"

data/lib/graphql/connections/base.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Connections
+    # Base class for pagination implementations
+    class Base < ::GraphQL::Pagination::Connection
+      attr_reader :opaque_cursor
+
+      delegate :arel_table, to: :items
+
+      def initialize(*args, opaque_cursor: true, **kwargs)
+        @opaque_cursor = opaque_cursor
+
+        super(*args, **kwargs)
+      end
+
+      def primary_key
+        @primary_key ||= items.model.primary_key
+      end
+
+      def nodes
+        @nodes ||= limited_relation
+      end
+
+      def has_previous_page # rubocop:disable Naming/PredicateName
+        raise NotImplementedError
+      end
+
+      def has_next_page # rubocop:disable Naming/PredicateName
+        raise NotImplementedError
+      end
+
+      def cursor_for(item)
+        raise NotImplementedError
+      end
+
+      private
+
+      def serialize(cursor)
+        case cursor
+        when Time, DateTime, Date
+          cursor.iso8601
+        else
+          cursor.to_s
+        end
+      end
+
+      def limited_relation
+        raise NotImplementedError
+      end
+
+      def sliced_relation
+        raise NotImplementedError
+      end
+
+      def after_cursor
+        @after_cursor ||= opaque_cursor ? decode(after) : after
+      end
+
+      def before_cursor
+        @before_cursor ||= opaque_cursor ? decode(before) : before
+      end
+    end
+  end
+end

data/lib/graphql/connections/chewy.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Connections
+    class Chewy < ::GraphQL::Pagination::RelationConnection
+      private
+
+      def load_nodes
+        @nodes ||= limited_nodes.objects
+      end
+
+      def relation_count(relation)
+        offset = relation_offset(relation) || 0
+        limit = relation_limit(relation)
+        count = relation.count - offset
+
+        if limit.nil?
+          count
+        else
+          [count, limit].min
+        end
+      end
+
+      def relation_limit(relation)
+        relation.send(:raw_limit_value)&.to_i
+      end
+
+      def relation_offset(relation)
+        relation.send(:raw_offset_value)&.to_i
+      end
+
+      def null_relation(relation)
+        relation.none
+      end
+    end
+  end
+end

data/lib/graphql/connections/key_asc.rb

@@ -0,0 +1,69 @@
+# 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 # rubocop:disable Naming/PredicateName, Metrics/AbcSize
+        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 # rubocop:disable Naming/PredicateName, Metrics/AbcSize
+        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 # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        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 # rubocop:disable Metrics/AbcSize
+        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

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

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Connections
+    module Keyset
+      # Implements keyset pagination by two fields with asc order
+      class Asc < ::GraphQL::Connections::Keyset::Base
+        # rubocop:disable Naming/PredicateName, Metrics/AbcSize, Metrics/MethodLength
+        def has_previous_page
+          if last
+            nodes.any? &&
+              items.where(arel_table[field_key].eq(nodes.first[field_key]))
+                .where(arel_table[primary_key].lt(nodes.first[primary_key]))
+                .or(items.where(arel_table[field_key].lt(nodes.first[field_key])))
+                .exists?
+          elsif after
+            items
+              .where(arel_table[field_key].lt(after_cursor_date))
+              .or(
+                items.where(arel_table[field_key].eq(after_cursor_date))
+                  .where(arel_table[primary_key].lt(after_cursor_primary_key))
+              ).exists?
+          else
+            false
+          end
+        end
+
+        def has_next_page
+          if first
+            nodes.any? &&
+              items.where(arel_table[field_key].eq(nodes.last[field_key]))
+                .where(arel_table[primary_key].gt(nodes.last[primary_key]))
+                .or(items.where(arel_table[field_key].gt(nodes.last[field_key])))
+                .exists?
+          elsif before
+            items
+              .where(arel_table[field_key].gt(before_cursor_date))
+              .or(
+                items.where(arel_table[field_key].eq(before_cursor_date))
+                  .where(arel_table[primary_key].gt(before_cursor_primary_key))
+              ).exists?
+          else
+            false
+          end
+        end
+        # rubocop:enable Naming/PredicateName, Metrics/AbcSize, Metrics/MethodLength
+
+        private
+
+        def limited_relation # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+          scope = sliced_relation
+          nodes = []
+
+          if first
+            nodes |= scope
+              .reorder(arel_table[field_key].asc, arel_table[primary_key].asc)
+              .limit(first).to_a
+          end
+
+          if last
+            nodes |= scope
+              .reorder(arel_table[field_key].desc, arel_table[primary_key].desc)
+              .limit(last).to_a.reverse!
+          end
+
+          nodes
+        end
+
+        def sliced_relation_after(relation) # rubocop:disable Metrics/AbcSize
+          relation
+            .where(arel_table[field_key].eq(after_cursor_date))
+            .where(arel_table[primary_key].gt(after_cursor_primary_key))
+            .or(relation.where(arel_table[field_key].gt(after_cursor_date)))
+        end
+
+        def sliced_relation_before(relation) # rubocop:disable Metrics/AbcSize
+          relation
+            .where(arel_table[field_key].eq(before_cursor_date))
+            .where(arel_table[primary_key].lt(before_cursor_primary_key))
+            .or(relation.where(arel_table[field_key].lt(before_cursor_date)))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Connections
+    module Keyset
+      # Base class for keyset pagination implementations
+      class Base < ::GraphQL::Connections::Base
+        attr_reader :field_key
+
+        SEPARATOR = "/"
+
+        def initialize(*args, keys:, separator: SEPARATOR, **kwargs)
+          @field_key, @primary_key = keys
+          @separator = separator
+
+          super(*args, **kwargs)
+        end
+
+        def cursor_for(item)
+          cursor = [item[field_key], item[primary_key]].map { |value| serialize(value) }.join(@separator)
+          cursor = encode(cursor) if opaque_cursor
+          cursor
+        end
+
+        private
+
+        def sliced_relation
+          items
+            .yield_self { |s| after ? sliced_relation_after(s) : s }
+            .yield_self { |s| before ? sliced_relation_before(s) : s }
+        end
+
+        def after_cursor_date
+          @after_cursor_date ||= after_cursor.first
+        end
+
+        def after_cursor_primary_key
+          @after_cursor_primary_key ||= after_cursor.last
+        end
+
+        def after_cursor
+          @after_cursor ||= super.split(SEPARATOR)
+        end
+
+        def before_cursor_date
+          @before_cursor_date ||= before_cursor.first
+        end
+
+        def before_cursor_primary_key
+          @before_cursor_primary_key ||= before_cursor.last
+        end
+
+        def before_cursor
+          @before_cursor ||= super.split(SEPARATOR)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Connections
+    module Keyset
+      # Implements keyset pagination by two fields with desc order
+      class Desc < ::GraphQL::Connections::Keyset::Base
+        # rubocop:disable Naming/PredicateName, Metrics/AbcSize, Metrics/MethodLength
+        def has_previous_page
+          if last
+            nodes.any? &&
+              items.where(arel_table[field_key].eq(nodes.first[field_key]))
+                .where(arel_table[primary_key].gt(nodes.first[primary_key]))
+                .or(items.where(arel_table[field_key].gt(nodes.first[field_key])))
+                .exists?
+          elsif after
+            items
+              .where(arel_table[field_key].gt(after_cursor_date))
+              .or(
+                items.where(arel_table[field_key].eq(after_cursor_date))
+                  .where(arel_table[primary_key].gt(after_cursor_primary_key))
+              ).exists?
+          else
+            false
+          end
+        end
+
+        def has_next_page
+          if first
+            nodes.any? &&
+              items.where(arel_table[field_key].eq(nodes.last[field_key]))
+                .where(arel_table[primary_key].lt(nodes.last[primary_key]))
+                .or(items.where(arel_table[field_key].lt(nodes.last[field_key])))
+                .exists?
+          elsif before
+            items
+              .where(arel_table[field_key].lt(before_cursor_date))
+              .or(
+                items.where(arel_table[field_key].eq(before_cursor_date))
+                  .where(arel_table[primary_key].lt(before_cursor_primary_key))
+              ).exists?
+          else
+            false
+          end
+        end
+        # rubocop:enable Naming/PredicateName, 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
+          cursor
+        end
+
+        private
+
+        def limited_relation # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+          scope = sliced_relation
+          nodes = []
+
+          if first
+            nodes |= scope
+              .reorder(arel_table[field_key].desc, arel_table[primary_key].desc)
+              .limit(first).to_a
+          end
+
+          if last
+            nodes |= scope
+              .reorder(arel_table[field_key].asc, arel_table[primary_key].asc)
+              .limit(last)
+              .to_a.reverse!
+          end
+
+          nodes
+        end
+
+        def sliced_relation_after(relation) # rubocop:disable Metrics/AbcSize
+          relation
+            .where(arel_table[field_key].eq(after_cursor_date))
+            .where(arel_table[primary_key].lt(after_cursor_primary_key))
+            .or(relation.where(arel_table[field_key].lt(after_cursor_date)))
+        end
+
+        def sliced_relation_before(relation) # rubocop:disable Metrics/AbcSize
+          relation
+            .where(arel_table[field_key].eq(before_cursor_date))
+            .where(arel_table[primary_key].gt(before_cursor_primary_key))
+            .or(relation.where(arel_table[field_key].gt(before_cursor_date)))
+        end
+      end
+    end
+  end
+end

data/lib/graphql/connections/stable.rb

@@ -11,73 +11,18 @@ module GraphQL
     #
     # For more information see GraphQL Cursor Connections Specification
     # https://relay.dev/graphql/connections.htm
-    class Stable < ::GraphQL::Pagination::Connection
-      delegate :arel_table, to: :items
-      delegate :primary_key, to: "items.model"
+    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
 
-      def nodes
-        @nodes ||= limited_relation
-      end
-
-      def has_previous_page # rubocop:disable Naming/PredicateName
-        if last
-          nodes.any? && items.where(arel_table[primary_key].lt(nodes.first.id)).exists?
-        elsif after
-          items.where(arel_table[primary_key].lteq(after_cursor)).exists?
-        else
-          false
-        end
-      end
-
-      def has_next_page # rubocop:disable Naming/PredicateName
-        if first
-          nodes.any? && items.where(arel_table[primary_key].gt(nodes.last.id)).exists?
-        elsif before
-          items.where(arel_table[primary_key].gteq(before_cursor)).exists?
-        else
-          false
+          return GraphQL::Connections::KeyAsc.new(*args, **kwargs)
         end
-      end
-
-      def cursor_for(item)
-        encode(item.id.to_s)
-      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
-
-      def after_cursor
-        @after_cursor ||= decode(after)
-      end
+        raise ArgumentError, "keyset for more that 2 keys is not implemented yet" if keys.length > 2
 
-      def before_cursor
-        @before_cursor ||= decode(before)
+        klass = desc ? GraphQL::Connections::Keyset::Desc : GraphQL::Connections::Keyset::Asc
+        klass.new(*args, **kwargs.merge(keys: keys))
       end
     end
   end

data/lib/graphql/connections/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module Paging
-    VERSION = "0.1.0"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: graphql-connections
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Misha Merkushin
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-04 00:00:00.000000000 Z
+date: 2021-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5'
 - !ruby/object:Gem::Dependency
@@ -52,6 +52,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: chewy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: combustion
   requirement: !ruby/object:Gem::Requirement
@@ -114,43 +156,43 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.58'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.58'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: test-prof
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
-description: 
+        version: '1.0'
+description:
 email:
 - merkushin.m.s@gmail.com
 executables: []
@@ -160,6 +202,12 @@ files:
 - LICENSE.txt
 - README.md
 - 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/stable.rb
 - lib/graphql/connections/version.rb
 homepage: https://github.com/bibendi/graphql-connections
@@ -167,15 +215,15 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 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:
   - - ">="
@@ -183,7 +231,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: GraphQL cursor-based stable pagination to work with Active Record relations
 test_files: []