jbuilder_pagination 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b5e96a670102c2f927e59e21c26d90f9b4d2d070
+  data.tar.gz: ee270b6e1ebcd7ac567aa3c5a43e4f18083b5893
+SHA512:
+  metadata.gz: 77db3f4d5c32df65b5c68ee9a387b3038c16571c8827d9ce8741517531d96b1302f127c391e24e452b0072660bbc39a41d800af60594e5e7ac707a4692ff48ab
+  data.tar.gz: d4474e11826257048f4261475af2bd28a370012c162c130848f5fd43fba3bc032b83072b181f70791881ae66cb0ba61f1460b911f449e71299c1c962ce38d806

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.sw?

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+jbuilder_pagination

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+install: bin/setup
+script:
+  - bundle exec rspec spec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jbuilder_pagination.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Bruno Bacarini
+
+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,55 @@
+# Jbuilder::Pagination [![Build Status](https://travis-ci.org/bacarini/jbuilder_pagination.svg?branch=master)](https://travis-ci.org/bacarini/jbuilder_pagination)
+
+[Jbuilder](https://github.com/rails/jbuilder) extension that makes easier to use pagination according to the [JSON API](http://jsonapi.org/format/#fetching-pagination) conventions.
+
+## Requirement
+
+It is based on [will_paginate](https://github.com/mislav/will_paginate).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jbuilder_pagination', require: 'jbuilder/pagination'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jbuilder_pagination
+
+## Usage
+
+```ruby
+json.links do
+  json.pages! @servers, url: "https://api.example.com/v1/servers"
+end
+
+# =>
+#  "links": {
+#      "pages": {
+#          "first": "https://api.example.com/v1/servers/v1/servers?page=1&per_page=1",
+#          "prev": "https://api.example.com/v1/servers/v1/servers?page=1&per_page=1",
+#          "last": "https://api.example.com/v1/servers/v1/servers?page=3&per_page=1",
+#          "next": "https://api.example.com/v1/servers/v1/servers?page=3&per_page=1"
+#      }
+#  },
+```
+
+In case there is no pagination at all, `links` will be omitted.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jbuilder/pagination"
+
+# 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

data/bin/setup

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

data/jbuilder_pagination.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jbuilder/pagination/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jbuilder_pagination"
+  spec.version       = Jbuilder::Pagination::VERSION
+  spec.authors       = ["Bruno Bacarini"]
+  spec.email         = ["bacarini.bruno@gmail.com"]
+
+  spec.summary       = "Jbuilder extension to allows pagination according to JSON API format"
+  spec.description   = "Jbuilder extension to allows pagination according to JSON API format. See http://jsonapi.org for details on the format"
+  spec.homepage      = "https://github.com/bacarini/jbuilder_pagination"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'jbuilder', '~> 2.2', '>= 2.2.0'
+  spec.add_development_dependency 'rspec', '~> 3.2', '>= 3.2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry', '~> 0'
+end

data/lib/jbuilder/pagination.rb

@@ -0,0 +1,3 @@
+require "jbuilder"
+require "jbuilder/pagination/pages"
+

data/lib/jbuilder/pagination/pages.rb

@@ -0,0 +1,29 @@
+class Jbuilder
+  def pages!(collection, options={})
+    return unless collection
+
+    pages do
+      pages_from(collection).map do |k, v|
+        _set_value k, "#{options[:url]}?page=#{v}&per_page=#{collection.per_page}"
+      end
+    end
+  end
+
+  private
+
+  def pages_from(collection)
+    return {} if collection.total_pages == 1
+
+    {}.tap do |pages|
+      unless collection.current_page == 1
+        pages[:first] = 1
+        pages[:prev]  = collection.current_page - 1
+      end
+
+      unless collection.current_page == collection.total_pages
+        pages[:last] = collection.total_pages
+        pages[:next] = collection.current_page + 1
+      end
+    end
+  end
+end

data/lib/jbuilder/pagination/version.rb

@@ -0,0 +1,5 @@
+module Jbuilder
+  class Pagination
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: jbuilder_pagination
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bruno Bacarini
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !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: 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: Jbuilder extension to allows pagination according to JSON API format.
+  See http://jsonapi.org for details on the format
+email:
+- bacarini.bruno@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jbuilder_pagination.gemspec
+- lib/jbuilder/pagination.rb
+- lib/jbuilder/pagination/pages.rb
+- lib/jbuilder/pagination/version.rb
+homepage: https://github.com/bacarini/jbuilder_pagination
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Jbuilder extension to allows pagination according to JSON API format
+test_files: []