graphql-page_cursors 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff87f78e643f6c03c976c91e44d541ccfdb3f9dd1f45614bf9113e048f7125c2
+  data.tar.gz: 1d0ee957ef5f769cf006e06f88a89fd0481aa5842b6830d1d70dcc0c8fdedf3f
+SHA512:
+  metadata.gz: 9334ae540c56fc0ee2cc9e928e1e17b45f65bf54660162746d1fab70e07a89b1cab4e21122a0d9526575366748765cfe0079b6146d38a2f2f3b517fb92107fcd
+  data.tar.gz: 00ec1948134ea669e920e57e33d958d2455980c445e51a3e78c68e6ee6d8c58b4606d11aab0ac2855cf55caae87006624e2a8fe8eaba3303da8b540cd90eadcf

data/.circleci/config.yml

@@ -0,0 +1,85 @@
+version: 2
+
+defaults: &defaults
+  working_directory: ~/graphql-page_cursors
+  docker:
+    - image: ruby:2.7.1
+
+jobs:
+  build:
+    <<: *defaults
+    steps:
+      - checkout
+
+      - run:
+          name: Gem install bundler
+          command: gem update --system && gem install bundler
+
+      - restore_cache:
+          name: Restore bundler cache
+          key: bundler-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: Bundle install
+          command: bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          name: Save bundler cache
+          key: bundler-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+
+  test:
+    <<: *defaults
+    steps:
+      - checkout
+
+      - run:
+          name: Gem install bundler
+          command: gem update --system && gem install bundler
+
+      - restore_cache:
+          name: Restore bundler cache
+          key: bundler-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: Bundle install
+          command: bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - run:
+          name: Run tests
+          command: bundle exec rake
+
+  deploy:
+    <<: *defaults
+    steps:
+      - checkout
+
+      - run:
+          name: Setup Rubygems
+          command: bash .circleci/setup-rubygems
+
+      - run:
+          name: Build gem
+          command: gem build graphql-page_cursors.gemspec --output graphql-page_cursors.gem
+
+      - run:
+          name: Publish gem
+          command: gem push graphql-page_cursors.gem
+
+workflows:
+  version: 2
+  default:
+    jobs:
+      - build
+      - test:
+          requires:
+            - build
+  release:
+    jobs:
+      - deploy:
+          filters:
+            tags:
+              only: /^v.*/
+            branches:
+              ignore: /.*/

data/.circleci/gem_credentials

@@ -0,0 +1,2 @@
+---
+:rubygems_api_key: REPLACE_ME

data/.circleci/setup-rubygems

@@ -0,0 +1,6 @@
+#! /bin/sh
+
+mkdir -p ~/.gem
+cp ./.circleci/gem_credentials ~/.gem/credentials
+chmod 0600 ~/.gem/credentials
+sed -i "s/REPLACE_ME/${RUBYGEMS_API_KEY}/g" ~/.gem/credentials

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7.1
+
+Style/Documentation:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,14 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-11-10 16:50:29 UTC using RuboCop version 1.2.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'graphql-page_cursors.gemspec'

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in graphql-page_cursors.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    graphql-page_cursors (0.0.1)
+      graphql
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    diff-lcs (1.4.4)
+    graphql (1.11.6)
+    parallel (1.20.0)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.2.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 1.0.1)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.1.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  graphql-page_cursors!
+  rake
+  rspec
+  rubocop
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jon Allured
+
+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,39 @@
+# Graphql::PageCursors
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/graphql/page_cursors`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-page_cursors'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphql-page_cursors
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/jonallured/graphql-page_cursors.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+desc 'Run RuboCop'
+RuboCop::RakeTask.new(:rubocop)
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'graphql/page_cursors'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/release

@@ -0,0 +1,16 @@
+#! /bin/sh
+set -ex
+
+old_version=$1
+new_version=$2
+
+version_files="lib/page_cursors/version.rb"
+commit_message="Bumping version numbers for $new_version"
+tag_message="Tagging version $new_version"
+
+sed -i "" "s/$old_version/$new_version/g" $version_files
+git add .
+git commit --message "$commit_message"
+git push upstream main
+git tag --annotate v$new_version --message "$tag_message"
+git push upstream --tags

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/graphql-page_cursors.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'page_cursors/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'graphql-page_cursors'
+  spec.version       = PageCursors::VERSION
+  spec.authors       = ['Jon Allured']
+  spec.email         = ['jon.allured@gmail.com']
+
+  spec.summary       = 'Add page cursors to your Rails GQL schema'
+  spec.description   = 'Add page cursors to your Rails GQL schema'
+  spec.homepage      = 'https://github.com/artsy/graphql-page_cursors'
+  spec.license       = 'MIT'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'graphql'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/graphql/page_cursors.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require 'graphql'
+
+module GraphQL
+  class PageCursor < GraphQL::Schema::Object
+    field :cursor, String, 'first cursor on the page', null: false
+    field :is_current, Boolean, 'is this the current page?', null: false
+    field :page, Int, 'page number out of totalPages', null: false
+  end
+
+  class PageCursors < GraphQL::Schema::Object
+    field :first, PageCursor, 'optional, may be included in field around', null: true
+    field :last, PageCursor, 'optional, may be included in field around', null: true
+    field :around, [PageCursor], null: false
+    field :previous, PageCursor, null: true
+  end
+
+  class PageCursorConnection < GraphQL::Types::Relay::BaseConnection
+    field :page_cursors, PageCursors, null: true
+    field :total_pages, Int, null: true
+    field :total_count, Int, null: true
+
+    MAX_CURSOR_COUNT = 5
+
+    def page_cursors
+      return if total_pages <= 1
+
+      {
+        around: around_cursors,
+        first: first_cursor,
+        last: last_cursor,
+        previous: previous_cursor
+      }.compact
+    end
+
+    def total_pages
+      return 0 if object.items.size.zero?
+      return 1 if nodes_per_page.nil?
+
+      (object.items.size.to_f / nodes_per_page).ceil
+    end
+
+    def total_count
+      object.items.size
+    end
+
+    private
+
+    def around_cursors
+      around_page_numbers.map { |page_num| page_cursor(page_num) }
+    end
+
+    def first_cursor
+      exceeds_max_cursor_count = total_pages > MAX_CURSOR_COUNT
+      include_first_cursor =
+        exceeds_max_cursor_count && around_page_numbers.exclude?(1)
+      return unless include_first_cursor
+
+      page_cursor(1)
+    end
+
+    def last_cursor
+      exceeds_max_cursor_count = total_pages > MAX_CURSOR_COUNT
+      include_last_cursor =
+        exceeds_max_cursor_count && around_page_numbers.exclude?(total_pages)
+      return unless include_last_cursor
+
+      page_cursor(total_pages)
+    end
+
+    def previous_cursor
+      include_previous_cursor = current_page > 1
+      return unless include_previous_cursor
+
+      page_cursor(current_page - 1)
+    end
+
+    def page_cursor(page_num)
+      {
+        cursor: cursor_for_page(page_num),
+        is_current: current_page == page_num,
+        page: page_num
+      }
+    end
+
+    def cursor_for_page(page_num)
+      return '' if page_num == 1
+
+      after_cursor = (page_num - 1) * nodes_per_page
+      encode(after_cursor.to_s)
+    end
+
+    def current_page
+      nodes_before / nodes_per_page + 1
+    end
+
+    def around_page_numbers # rubocop:disable Metrics/AbcSize
+      if total_pages <= MAX_CURSOR_COUNT
+        (1..total_pages).to_a
+      elsif current_page <= 3
+        (1..4).to_a
+      elsif current_page >= total_pages - 2
+        ((total_pages - 3)..total_pages).to_a
+      else
+        [current_page - 1, current_page, current_page + 1]
+      end
+    end
+
+    def nodes_before
+      node_offset(object.edge_nodes.first) - 1
+    end
+
+    def nodes_after
+      node_offset(object.edge_nodes.last)
+    end
+
+    def node_offset(node)
+      # this was previously accomplished by calling a private method:
+      # object.send(:offset_from_cursor, object.cursor_from_node(object.edge_nodes.first))
+      object.items.index(node) + 1
+    end
+
+    def nodes_per_page
+      object.first || object.last
+    end
+
+    # borrowed from https://graphql-ruby.org/api-doc/1.10.6/Base64Bp.html
+    def encode(value)
+      str = Base64.strict_encode64(value)
+      str.tr!('+/', '-_')
+      str.delete!('=')
+      str
+    end
+  end
+end

data/lib/page_cursors/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class PageCursors
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: graphql-page_cursors
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jon Allured
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add page cursors to your Rails GQL schema
+email:
+- jon.allured@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".circleci/gem_credentials"
+- ".circleci/setup-rubygems"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/release
+- bin/setup
+- graphql-page_cursors.gemspec
+- lib/graphql/page_cursors.rb
+- lib/page_cursors/version.rb
+homepage: https://github.com/artsy/graphql-page_cursors
+licenses:
+- MIT
+metadata: {}
+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: Add page cursors to your Rails GQL schema
+test_files: []