graphql-connections 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a9c9ec5b3fb2eff5eb12781de11a726576630f03381b4d0d12f334bf1c0daad5
+  data.tar.gz: 57fc193b3559ae72cd6ffb75b14ceafe4e3e73371e09b6204f2ead111b9023a9
+SHA512:
+  metadata.gz: 84d109d7e71943db1522c6d0beb12403a8c442dfd208e39048b175e9410f0d44cec75a1b77942fec35fcf1925532a6909ba706b80525c6d36c64f4d3bf426846
+  data.tar.gz: d5c7ebc8dd7d72b30069f619fedb548cf6b3828db686cefbe490d65b9ae0dd0e5454a83634386293d7c0a473969b93eccaf315d89740f061635046ff4ccba2f4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Misha Merkushin (aka bibendi)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+[![Gem Version](https://badge.fury.io/rb/graphql-connections.svg)](https://badge.fury.io/rb/graphql-connections)
+[![Build Status](https://travis-ci.org/bibendi/graphql-connections.svg?branch=master)](https://travis-ci.org/bibendi/graphql-connections)
+
+# 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.
+
+<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>
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "graphql-connections"
+```
+
+## Usage
+
+You can use a stable connection wrapper on a specific field:
+
+```ruby
+field :messages, Types::Message.connection_type, null: false
+
+def messages
+  GraphQL::Connections::Stable.new(Message.all)
+end
+```
+
+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. 
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bibendi/graphql-connections.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/graphql/connections.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "graphql"
+
+module GraphQL
+  module Connections
+  end
+end
+
+require "graphql/connections/stable"

data/lib/graphql/connections/stable.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Connections
+    # Cursor-based pagination to work with `ActiveRecord::Relation`s.
+    # Implements a mechanism for serving stable connections based on column values.
+    # If objects are created or destroyed during pagination, the list of items won't be disrupted.
+    #
+    # Inspired by `GraphQL::Pro`s Stable Relation Connections
+    # https://graphql-ruby.org/pagination/stable_relation_connections.html
+    #
+    # 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"
+
+      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
+        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
+
+      def before_cursor
+        @before_cursor ||= decode(before)
+      end
+    end
+  end
+end

data/lib/graphql/connections/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Paging
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: graphql-connections
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Misha Merkushin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-04 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
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+- !ruby/object:Gem::Dependency
+  name: test-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: 
+email:
+- merkushin.m.s@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/graphql/connections.rb
+- lib/graphql/connections/stable.rb
+- lib/graphql/connections/version.rb
+homepage: https://github.com/bibendi/graphql-connections
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: GraphQL cursor-based stable pagination to work with Active Record relations
+test_files: []