graphql-connections 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f48d965da430fdbc88992199c0fef0e92e0bfe6f75f900735abd80d96edc098
-  data.tar.gz: 3513296ea1afb7d5300c1c9737462bd5baf407f797cb45737e1fa97ccdc52bfb
+  metadata.gz: ed09e36d3d30a8e2cd939a1b9b39341168478d547e4b0e990798e612f6f83e49
+  data.tar.gz: bc35f6d38dcebf5a97ce0cf69d6540db2712046bddc15f5c1bca0c685115eac4
 SHA512:
-  metadata.gz: 5f728d6e4fc47a7e0d7bb87cef013542e31370d33da2eb9289244dddb8a9dbd7ff80588726c437b1edc43fe569029c087a2016c76e62f80b30218f4b99a44060
-  data.tar.gz: 1f294f11f5f1e24bc525d1893ecd1de64ba39aae1bcbc9fd72487bfbd3d55b31983627de6c36c97d109b1f989b215fa312615750a31bea307de9d781aa5f2812
+  metadata.gz: 2408beb9fb3346e5ce7e980b462dc34762d5507bb65eb9c1051672d1dc0b8d33c2807d5113b0837a704ad3311bcbc27baeddb5bd4bb1177e8e748d00ca0f2b98
+  data.tar.gz: 042f6ee93e8fbc8391122ac5546bf18c3be595b2c45504daeff6dbec16240278141ad3e9a5d145e30a14c84e70d37ef03fb242e282c110f41ffd2605ebca81c4

data/README.md

@@ -3,10 +3,7 @@
 
 # GraphQL::Connections
 
-Cursor-based pagination to work with `ActiveRecord::Relation`s.
-
-Implements [Relay specification](https://relay.dev/graphql/connections.htm) for serving stable connections based on column values.
-If objects are created or destroyed during pagination, the list of items won’t be disrupted.
+Additional implementations of cursor-based paginations for [GraphQL Ruby](https://graphql-ruby.org/).
 
 <a href="https://evilmartians.com/?utm_source=graphql-connections">
 <img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
@@ -21,6 +18,11 @@ gem "graphql-connections"
 
 ## Usage
 
+### ActiveRecord
+
+Implements [Relay specification](https://relay.dev/graphql/connections.htm) for serving stable connections based on column values.
+If objects are created or destroyed during pagination, the list of items won’t be disrupted.
+
 You can use a stable connection wrapper on a specific field:
 
 ```ruby
@@ -57,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:
 
@@ -69,14 +73,34 @@ Or you can apply a stable connection to all Active Record relations returning by
 
 ```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.
 
+### 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
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/graphql/connections/base.rb

@@ -22,11 +22,11 @@ module GraphQL
         @nodes ||= limited_relation
       end
 
-      def has_previous_page # rubocop:disable Naming/PredicateName
+      def has_previous_page
         raise NotImplementedError
       end
 
-      def has_next_page # rubocop:disable Naming/PredicateName
+      def has_next_page
         raise NotImplementedError
       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/keyset/asc.rb

@@ -5,7 +5,6 @@ module GraphQL
     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? &&
@@ -47,7 +46,7 @@ module GraphQL
 
         private
 
-        def limited_relation # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        def limited_relation
           scope = sliced_relation
           nodes = []
 
@@ -66,14 +65,14 @@ module GraphQL
           nodes
         end
 
-        def sliced_relation_after(relation) # rubocop:disable Metrics/AbcSize
+        def sliced_relation_after(relation)
           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
+        def sliced_relation_before(relation)
           relation
             .where(arel_table[field_key].eq(before_cursor_date))
             .where(arel_table[primary_key].lt(before_cursor_primary_key))

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

@@ -5,7 +5,6 @@ module GraphQL
     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? &&
@@ -53,7 +52,7 @@ module GraphQL
 
         private
 
-        def limited_relation # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        def limited_relation
           scope = sliced_relation
           nodes = []
 
@@ -73,14 +72,14 @@ module GraphQL
           nodes
         end
 
-        def sliced_relation_after(relation) # rubocop:disable Metrics/AbcSize
+        def sliced_relation_after(relation)
           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
+        def sliced_relation_before(relation)
           relation
             .where(arel_table[field_key].eq(before_cursor_date))
             .where(arel_table[primary_key].gt(before_cursor_primary_key))

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,107 @@
+# 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
+          if last
+            nodes.any? && 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
+          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.0.0"
+    VERSION = "1.3.0"
   end
 end

data/lib/graphql/connections.rb

@@ -11,8 +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.0.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Misha Merkushin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-12 00:00:00.000000000 Z
+date: 2022-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -28,16 +28,22 @@ dependencies:
   name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +58,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
@@ -161,10 +209,13 @@ files:
 - README.md
 - lib/graphql/connections.rb
 - lib/graphql/connections/base.rb
-- lib/graphql/connections/key_asc.rb
+- lib/graphql/connections/chewy.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
@@ -187,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.32
 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 # 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