graphql-paging 0.1.0.beta1 → 0.1.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e5c25945713db86cedc652bfc5290e463d7c977b0f4cd6fc93f1b1a8d36b5c3
-  data.tar.gz: 17474d9bda3ded042b3ecd7a4732e909be074ae193cfb77cf0e07205b6e6b81e
+  metadata.gz: 4f8e37a1101fe27922433ad460dfdb189d3b17f8209a3cb7ae3b6704aa91d00e
+  data.tar.gz: 978108d3ad07358e31a3c1ff61544032da1d7ea523049e30aeb39fe8d0ec4115
 SHA512:
-  metadata.gz: 9b78076deebb534435a5cb5d0a52e0afe2ebc6e93d6f289e4fb98166b56d96326ae1af32398efef53d17a520ec862ba9e4c213277eeb79e0de8f6db655c6e30a
-  data.tar.gz: 5f0286f4522900e4dee2c0453cbb0a4b33e16ea9a97545454d4fafe04d492d7abbe700f702e7c1f1729716ae153be0c8aea1df2092f76d7ab99704b793ec5a39
+  metadata.gz: '0860c49c1f30eb232df93386a74be24563a00a58df4514e9b2a303e4d907d3f2a6faa3449724b308c8fb45d62b5b0c9a05cdee2bf496e0a178c711cb0cf44350'
+  data.tar.gz: 836a8ff0d587a0da768326d2bb39e0fbcae862d072ca2fd4a43c74ef3020426acb056d0934717284a247f48b044f611e767032f0e572f29cf92c32d6277b4a68

data/README.md

@@ -1,5 +1,7 @@
 # Graphql::Paging
 
+![](https://travis-ci.org/bastengao/graphql-paging.svg?branch=master)
+
 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.
@@ -25,6 +27,12 @@ Or install it yourself as:
 
 ## Usage
 
+Require the library
+
+```ruby
+require 'graphql/paging'
+```
+
 Include `GraphQL::Paging::ResolverExtension` in resolver and use `paginate` method.
 
 ```ruby
@@ -130,7 +138,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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.
+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
 
@@ -138,4 +146,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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).
+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/lib/graphql/paging.rb

@@ -2,7 +2,7 @@ require 'graphql'
 require_relative "paging/version"
 require_relative "paging/resolver_extension"
 
-module Graphql
+module GraphQL
   module Paging
   end
 end

data/lib/graphql/paging/page_info.rb

@@ -1,7 +1,7 @@
 module GraphQL
   module Paging
     class PageInfo < GraphQL::Schema::Object
-      graphql_name "PageInfo"
+      graphql_name "PagingPageInfo"
 
       field :total_count,  Integer, method: :total_count,  null: false
       field :total_pages,  Integer, method: :total_pages,  null: false

data/lib/graphql/paging/resolver_extension.rb

@@ -23,8 +23,8 @@ module GraphQL
 
           type pagination, null: false
 
-          argument :page, Int, "return _n_ th page",           required: false
-          argument :per,  Int, "return _n_ elements per page", required: false
+          argument :page, Int, "return the _n_ th page.",       required: false
+          argument :per,  Int, "return _n_ elements per page.", required: false
         end
 
         private
@@ -39,8 +39,8 @@ module GraphQL
             klass = Class.new(_object_class) do
               graphql_name(pagination_name)
 
-              field :page_info, PageInfo, null: false
-              field :nodes,     [wrapped_type],  null: true
+              field :page_info, PageInfo,       "Information to aid in pagination.", null: false
+              field :nodes,     [wrapped_type], "A list of nodes.",                  null: true
 
               def page_info
                 paged_data

data/lib/graphql/paging/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-paging
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta1
+  version: 0.1.0.beta2
 platform: ruby
 authors:
 - bastengao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-28 00:00:00.000000000 Z
+date: 2019-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -93,18 +93,8 @@ 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

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# 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

@@ -1,6 +0,0 @@
-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

@@ -1,89 +0,0 @@
-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/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/bin/console

@@ -1,14 +0,0 @@
-#!/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

@@ -1,8 +0,0 @@
-#!/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

@@ -1,31 +0,0 @@
-
-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