rocket_pants-pagination 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5fc7bbf163f232c569ae8c590d8b61da5ca93f80
+  data.tar.gz: 46c661cc0911c65473c2b6eb1ce2155108bd39e6
+SHA512:
+  metadata.gz: d1f9906f54492e7392cb1d99a2d9896792924924446f61e16560c67b16e077c526ac6f659652b94cce9164bab31208a163bec43aa3192930cdd179433781dc1e
+  data.tar.gz: cace7216edea2bfb1a79311c7429d12fbdb3272dce32d64073c7a77c22d1d484b9e9ede3eab8d226fe56e79b5642868ed22d3cd220c837377b8554d22339526f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Alessandro Desantis
+
+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,51 @@
+# RocketPants::Pagination
+
+Pagination support for [RocketPants](https://github.com/Sutto/rocket_pants).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby gem 'rocket_pants-pagination' ```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rocket_pants-pagination
+
+## Usage
+
+```ruby
+class PostsController < RocketPants::Base
+  include RocketPants::Pagination
+
+  def index
+    @posts = Post.all
+    paginate_and_expose posts: @posts
+  end
+end
+```
+
+## 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/alessandro1997/rocket_pants-pagination](https://github.com/alessandro1997/rocket_pants-pagination).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rocket_pants/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
+
+# Do any other automated setup that you need to do here

data/lib/rocket_pants/pagination/version.rb

@@ -0,0 +1,5 @@
+module RocketPants
+  module Pagination
+    VERSION = '0.1.0'
+  end
+end

data/lib/rocket_pants/pagination.rb

@@ -0,0 +1,115 @@
+require 'rocket_pants/pagination/version'
+
+module RocketPants
+  #
+  # Pagination support for RocketPants
+  #
+  # Include this module in your RocketPants controllers to add pagination
+  # support.
+  #
+  # @author Alessandro Desantis <desa.alessandro@gmail.com>
+  #
+  module Pagination
+    #
+    # Reserved root keys
+    #
+    RESERVED_PAGINATION_KEYS = [:count, :pagination]
+
+    #
+    # Paginates the given relation.
+    #
+    # The page param is 'page' by default.
+    #
+    # @param [ActiveRecord::Relation] the relation to paginate
+    # @param [Hash] an options hash for the #paginate method
+    #
+    # @return [ActiveRecord::Relation] a paginated relation
+    #
+    def paginate(relation, options = {})
+      relation.paginate({ page: params[:page] }.merge(options))
+    end
+
+    #
+    # Exposes the given collection with pagination metadata.
+    #
+    # @param [Hash{Symbol => ActiveRecord::Relation}] a hash with exactly one
+    #   element, its key being the root key and its value a paginated relation
+    #
+    # @raise [ArgumentError] if the hash is malformed
+    #
+    def expose_with_pagination(hash)
+      root_key, collection = extract_pagination_elements_from hash
+
+      response = {
+        "#{root_key}" => ActiveModel::ArraySerializer.new(collection),
+        count: collection.count,
+        pagination: {
+          pages: collection.total_pages,
+          current: collection.current_page,
+          count: collection.count,
+          per_page: collection.per_page,
+          previous: collection.previous_page,
+          next: collection.next_page
+        }
+      }
+
+      expose response
+    end
+
+    #
+    # Paginates and exposes the given collection with pagination metadata.
+    #
+    # Basically, just calls {#paginate}, then {#expose_with_pagination}.
+    #
+    # @param [Hash(Symbol => ActiveRecord::Relation)] a hash with exactly one
+    #   element, its key being the root key and its value a paginated relation
+    #
+    # @raise [ArgumentError] if the hash is malformed
+    #
+    def paginate_and_expose(hash)
+      root_key, collection = extract_pagination_elements_from hash
+      expose_with_pagination "#{root_key}" => paginate(collection)
+    end
+
+    private
+
+    #
+    # Returns the first pair from the given hash.
+    #
+    # This is used to extract the root key and collection from a hash.
+    #
+    # @param [Hash(Symbol => ActiveRecord::Relation)] a hash with exactly one
+    #   element, its key being the root key and its value a relation
+    #
+    # @return [Array(Symbol, ActiveRecord::Relation)] an array containing a root
+    #   key and a relation
+    #
+    # @raise [ArgumentError] if the hash is malformed
+    #
+    def extract_pagination_elements_from(hash)
+      validate_pagination_hash! hash
+      hash.first
+    end
+
+    #
+    # Validates the given hash.
+    #
+    # Ensures that the hash has exactly one element and that the first element's
+    # key is not a reserved one.
+    #
+    # @param [Hash] a hash to validate
+    #
+    # @raise [ArgumentError] if the hash doesn't have exactly 1 element
+    # @raise [ArgumentError] if the first element's key is a reserved one
+    #
+    def validate_pagination_hash!(hash)
+      if hash.size != 1
+        raise ArgumentError, "the given hash should contain exactly 1 element (#{hash.size} elements)"
+      end
+
+      if hash.keys.first.to_sym.in?(RESERVED_PAGINATION_KEYS)
+        raise ArgumentError, "the given root key is reserved: #{hash.keys.first}"
+      end
+    end
+  end
+end

data/rocket_pants-pagination.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rocket_pants/pagination/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rocket_pants-pagination'
+  spec.version       = RocketPants::Pagination::VERSION
+  spec.authors       = ['Alessandro Desantis']
+  spec.email         = ['desa.alessandro@gmail.com']
+
+  spec.summary       = %q{Pagination support for RocketPants.}
+  spec.homepage      = 'https://github.com/alessandro1997/rocket_pants-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_dependency 'rocket_pants', '~> 1.13'
+  spec.add_dependency 'will_paginate', '~> 3.0'
+  spec.add_dependency 'active_model_serializers', '~> 0.9'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'fuubar'
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: rocket_pants-pagination
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alessandro Desantis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rocket_pants
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  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: 
+email:
+- desa.alessandro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rocket_pants/pagination.rb
+- lib/rocket_pants/pagination/version.rb
+- rocket_pants-pagination.gemspec
+homepage: https://github.com/alessandro1997/rocket_pants-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.8
+signing_key: 
+specification_version: 4
+summary: Pagination support for RocketPants.
+test_files: []