graphql-pagination 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76c66de0736b4e48b3e0663e492753f1357bf8be61808b217fd630bea22009b1
+  data.tar.gz: f8f12c2b80a9f467511aa5d7fd34e34a46ff7fb3163de22f2b6ba409921f1ace
+SHA512:
+  metadata.gz: 95cad2fa47598627792741d8172eaa1e0bfabbfc4ca4354d656d416449a79c054b8ec3c8cf27db9e02f63ff72a8c13ed2ffd377191f5b3e0ad9c43e30ff47f6d
+  data.tar.gz: 2ca30fea914bc2a633733f252407d8bc6bf560fc8b7009db30cdab953b43ce366686327353fb8a0cf719ff97299bead0e0c6039e1a1964ad54f3120e4895a0b6

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+graphql-pagination

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    graphql-pagination (0.1.0)
+      graphql
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    graphql (1.9.4)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    kaminari-activerecord (1.1.1)
+      activerecord
+      kaminari-core (= 1.1.1)
+    kaminari-core (1.1.1)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  graphql-pagination!
+  kaminari-activerecord
+  kaminari-core
+  pry
+  rake
+  rspec
+
+BUNDLED WITH
+   2.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 RenoFi
+
+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,81 @@
+# graphql-pagination
+
+Implements page-based pagination returning collection and pagination metadata. It works with `kaminari` or other pagination tools implementing similar methods.
+
+## Installation
+
+Add `graphql-pagination` to your Gemfile, you can use `kaminari-activerecord` or `kaminari-monogid` to not implement page scope methods. Kaminari is not loaded by the gem, so you need to decide anmd load it on your own.
+
+```ruby
+  gem 'graphql-pagination'
+  gem 'kaminari-activerecord'
+```
+
+## Usage example
+
+```ruby
+  field :fruits, Types::FruitType.collection_type, null: true do
+    argument :page, Integer, required: false
+    argument :limit, Integer, required: false
+  end
+
+  def fruit(page: nil, limit: nil)
+    ::Fruit.page(page).per(limit)
+  end
+```
+
+Value returned by query resolver must be a kaminari object or implements its page scope methods (`current_page`, `limit_value`, `total_count`, `total_pages`).
+
+
+## GraphQL query
+
+```
+{
+  fruits(page: 2, limit: 2) {
+    collection {
+      id
+      name
+    }
+    metadata {
+      totalPages
+      totalCount
+      currentPage
+      limitValue
+    }
+  }
+}
+```
+
+```json
+{
+  "data": {
+    "checklists": {
+      "collection": [
+        {
+          "id": "93938bb3-7a6c-4d35-9961-cbb2d4c9e9ac",
+          "name": "Apple"
+        },
+        {
+          "id": "b1ee93b2-579a-4107-8454-119bba5afb63",
+          "name": "Mango"
+        }
+      ],
+      "metadata": {
+        "totalPages": 25,
+        "totalCount": 50,
+        "currentPage": 2,
+        "limitValue": 2
+      }
+    }
+  }
+}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/renofi/graphql-pagination. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "graphql-pagination"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/graphql-pagination.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "graphql_pagination/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphql-pagination"
+  spec.version       = GraphqlPagination::VERSION
+  spec.authors       = ["Krzysztof Knapik", "RenoFi Engineering Team"]
+  spec.email         = ["knapo@knapo.net", "engineering@renofi.com"]
+
+  spec.summary       = %q{Page-based kaminari pagination for graphql.}
+  spec.description   = %q{Implements page-based pagination for graphql returning collection and pagination metadata.}
+  spec.homepage      = "https://github.com/RenoFi/graphql-pagination"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = "https://github.com/RenoFi/graphql-pagination"
+  spec.metadata["source_code_uri"] = "https://github.com/RenoFi/graphql-pagination"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) 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 "kaminari-core"
+  spec.add_development_dependency "kaminari-activerecord"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/lib/graphql-pagination.rb

@@ -0,0 +1 @@
+require_relative 'graphql_pagination'

data/lib/graphql_pagination.rb

@@ -0,0 +1,12 @@
+require "graphql_pagination/version"
+require "graphql"
+require "graphql/schema/object"
+
+module GraphqlPagination
+end
+
+require "graphql_pagination/version"
+require "graphql_pagination/collection_type"
+require "graphql_pagination/collection_metadata_type"
+
+GraphQL::Schema::Object.extend GraphqlPagination::CollectionType

data/lib/graphql_pagination/collection_metadata_type.rb

@@ -0,0 +1,8 @@
+module GraphqlPagination
+  class CollectionMetadataType < GraphQL::Schema::Object
+    field :current_page, Integer, null: false
+    field :limit_value,  Integer, null: false
+    field :total_count,  Integer, null: false
+    field :total_pages,  Integer, null: false
+  end
+end

data/lib/graphql_pagination/collection_type.rb

@@ -0,0 +1,24 @@
+module GraphqlPagination
+  module CollectionType
+    def collection_type
+      @collection_type ||= begin
+        type_name = "#{graphql_name}Collection"
+        source_type = self
+
+        Class.new(GraphQL::Schema::Object) do
+          graphql_name type_name
+          field :collection, [source_type], null: false
+          field :metadata, GraphqlPagination::CollectionMetadataType, null: false
+
+          def collection
+            object
+          end
+
+          def metadata
+            object
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql_pagination/version.rb

@@ -0,0 +1,3 @@
+module GraphqlPagination
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: graphql-pagination
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Krzysztof Knapik
+- RenoFi Engineering Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-08 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: kaminari-core
+  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: kaminari-activerecord
+  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: 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: pry
+  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: Implements page-based pagination for graphql returning collection and
+  pagination metadata.
+email:
+- knapo@knapo.net
+- engineering@renofi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphql-pagination.gemspec
+- lib/graphql-pagination.rb
+- lib/graphql_pagination.rb
+- lib/graphql_pagination/collection_metadata_type.rb
+- lib/graphql_pagination/collection_type.rb
+- lib/graphql_pagination/version.rb
+homepage: https://github.com/RenoFi/graphql-pagination
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/RenoFi/graphql-pagination
+  source_code_uri: https://github.com/RenoFi/graphql-pagination
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Page-based kaminari pagination for graphql.
+test_files: []