graphql-paging 0.1.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e5c25945713db86cedc652bfc5290e463d7c977b0f4cd6fc93f1b1a8d36b5c3
+  data.tar.gz: 17474d9bda3ded042b3ecd7a4732e909be074ae193cfb77cf0e07205b6e6b81e
+SHA512:
+  metadata.gz: 9b78076deebb534435a5cb5d0a52e0afe2ebc6e93d6f289e4fb98166b56d96326ae1af32398efef53d17a520ec862ba9e4c213277eeb79e0de8f6db655c6e30a
+  data.tar.gz: 5f0286f4522900e4dee2c0453cbb0a4b33e16ea9a97545454d4fafe04d492d7abbe700f702e7c1f1729716ae153be0c8aea1df2092f76d7ab99704b793ec5a39

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,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at bastengao@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    graphql-paging (0.1.0.beta1)
+      graphql (>= 1.8, < 2)
+      kaminari (>= 1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (6.0.0)
+      activesupport (= 6.0.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (6.0.0)
+      activesupport (= 6.0.0)
+    activerecord (6.0.0)
+      activemodel (= 6.0.0)
+      activesupport (= 6.0.0)
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    builder (3.2.3)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubi (1.8.0)
+    graphql (1.9.10)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    kaminari (1.1.1)
+      activesupport (>= 4.1.0)
+      kaminari-actionview (= 1.1.1)
+      kaminari-activerecord (= 1.1.1)
+      kaminari-core (= 1.1.1)
+    kaminari-actionview (1.1.1)
+      actionview
+      kaminari-core (= 1.1.1)
+    kaminari-activerecord (1.1.1)
+      activerecord
+      kaminari-core (= 1.1.1)
+    kaminari-core (1.1.1)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.2.0)
+      loofah (~> 2.2, >= 2.2.2)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.1.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  graphql-paging!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 bastengao
+
+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,141 @@
+# Graphql::Paging
+
+NOTE: If you need cursor-based pagination, [relay connection](https://graphql-ruby.org/relay/connections.html) is good for you.
+
+A page-based pagination extension for graphql gem, only support kaminari currently.
+
+* [x] support kaminari
+* [ ] support will_paginate
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-paging'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphql-paging
+
+## Usage
+
+Include `GraphQL::Paging::ResolverExtension` in resolver and use `paginate` method.
+
+```ruby
+class UserType < GraphQL::Schema::Object
+  graphql_name "User"
+
+  field :id, ID, null: false
+  field :name, String, null: false
+end
+
+class UserResolver < GraphQL::Schema::Resolver
+  include GraphQL::Paging::ResolverExtension
+
+  paginate UserType
+
+  def resolve(**args)
+    User.page(args[:page]).per(args[:perPage])
+  end
+end
+
+class QueryType < GraphQL::Schema::Object
+  field :users, resolver: UserResolver
+end
+```
+
+These code will generate the schema below.
+
+```graphql
+type PageInfo {
+  currentPage: Int!
+  per: Int!
+  totalCount: Int!
+  totalPages: Int!
+}
+
+type Query {
+  users(page: Int, per: Int): UserPagination!
+}
+
+type User {
+  id: ID!
+  name: String!
+}
+
+type UserPagination {
+  nodes: [User!]
+  pageInfo: PageInfo!
+}
+```
+
+### Custom fields
+
+```ruby
+class UserResolver < GraphQL::Schema::Resolver
+  include GraphQL::Paging::ResolverExtension
+
+  paginate UserType do
+    field :count, Int, null: false
+
+    def count
+      all_data.count
+    end
+  end
+
+  def resolve(**args)
+    all_data = User.all
+    paged_data = all_data.page(args[:page]).per(args[:per_page])
+    [all_data, paged_data]
+  end
+end
+```
+
+Pagination object will like this.
+
+```graphql
+type UserPagination {
+  count: Int!
+  nodes: [User!]
+  pageInfo: PageInfo!
+}
+```
+
+### Generate another pagination
+
+`paginate` will generate `#{graphql_name}Pagination` object default and cache it by name. If pagination has different custom fields, specify a name to avoid cache same pagination object.
+
+```ruby
+  paginate UserType, "AliasUser"
+```
+
+```ruby
+type AliasUserPagination {
+  nodes: [User!]
+  pageInfo: PageInfo!
+}
+```
+
+## 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/[bastengao]/graphql-paging. 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).
+
+## Code of Conduct
+
+Everyone interacting in the Graphql::Paging project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[bastengao]/graphql-paging/blob/master/CODE_OF_CONDUCT.md).

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "graphql/paging"
+
+# 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/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-paging.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "graphql/paging/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphql-paging"
+  spec.version       = Graphql::Paging::VERSION
+  spec.authors       = ["bastengao"]
+  spec.email         = ["bastengao@gmail.com"]
+
+  spec.summary       = %q{A page-based pagination extension for graphql gem}
+  spec.homepage      = "https://github.com/bastengao/graphql-paging"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  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", ">= 1.8", "< 2"
+  spec.add_dependency "kaminari", ">= 1.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/graphql/paging.rb

@@ -0,0 +1,8 @@
+require 'graphql'
+require_relative "paging/version"
+require_relative "paging/resolver_extension"
+
+module Graphql
+  module Paging
+  end
+end

data/lib/graphql/paging/page_info.rb

@@ -0,0 +1,12 @@
+module GraphQL
+  module Paging
+    class PageInfo < GraphQL::Schema::Object
+      graphql_name "PageInfo"
+
+      field :total_count,  Integer, method: :total_count,  null: false
+      field :total_pages,  Integer, method: :total_pages,  null: false
+      field :current_page, Integer, method: :current_page, null: false
+      field :per,          Integer, method: :limit_value,  null: false
+    end
+  end
+end

data/lib/graphql/paging/resolver_extension.rb

@@ -0,0 +1,79 @@
+require 'kaminari'
+require_relative 'page_info'
+
+module GraphQL
+  module Paging
+    module ResolverExtension
+      def self.included(klass)
+        klass.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        include GraphQL::Schema::Member::GraphQLTypeNames
+
+        @cached_pagination_types ||= {}
+
+        def self.cached_pagination_types
+          @cached_pagination_types
+        end
+
+        def paginate(wrapped_type, pagination_options = {}, &block)
+          pagination = pagination_type(wrapped_type, **pagination_options)
+          pagination.class_eval(&block) if block
+
+          type pagination, null: false
+
+          argument :page, Int, "return _n_ th page",           required: false
+          argument :per,  Int, "return _n_ elements per page", required: false
+        end
+
+        private
+
+        def pagination_type(wrapped_type, name: nil)
+          @@cached_pagination_types ||= {}
+
+          name ||= wrapped_type.graphql_name
+          pagination_name = "#{name}Pagination"
+
+          @@cached_pagination_types[pagination_name] ||= begin
+            klass = Class.new(_object_class) do
+              graphql_name(pagination_name)
+
+              field :page_info, PageInfo, null: false
+              field :nodes,     [wrapped_type],  null: true
+
+              def page_info
+                paged_data
+              end
+
+              def nodes
+                paged_data
+              end
+
+              def all_data
+                if object.is_a?(Array) && !object.is_a?(Kaminari::PaginatableArray)
+                  object.first
+                else
+                  object
+                end
+              end
+
+              def paged_data
+                if object.is_a?(Array) && !object.is_a?(Kaminari::PaginatableArray)
+                  object.last
+                else
+                  object
+                end
+              end
+            end
+            GraphQL::Paging.const_set(pagination_name, klass)
+          end
+        end
+
+        def _object_class
+          GraphQL::Schema::Object
+        end
+      end
+    end
+  end
+end

data/lib/graphql/paging/version.rb

@@ -0,0 +1,5 @@
+module Graphql
+  module Paging
+    VERSION = "0.1.0.beta1"
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: graphql-paging
+version: !ruby/object:Gem::Version
+  version: 0.1.0.beta1
+platform: ruby
+authors:
+- bastengao
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- bastengao@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphql-paging.gemspec
+- lib/graphql/paging.rb
+- lib/graphql/paging/page_info.rb
+- lib/graphql/paging/resolver_extension.rb
+- lib/graphql/paging/version.rb
+homepage: https://github.com/bastengao/graphql-paging
+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: 1.3.1
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A page-based pagination extension for graphql gem
+test_files: []