rails_api_paginate 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 666081da8f1a0c52c4d1b349a72138c69ce223661ad8037dae394e1b88f32680
+  data.tar.gz: aac8be088b54d75d201f3b141da8f117db4a93cfc05699466628c71c491bea9a
+SHA512:
+  metadata.gz: 1466f6f5184402b475b88ad5a4f34073992e3cff1bce88cef1b61ec6663b98615c357ada2705ba225239b8ee1cf37c31410a3fdc9f5aebd0cca99e3589da1dc1
+  data.tar.gz: fbd222e09f91032fa73287a561f86b2fadd4683182b55966d153464477277feaa56804dd2f546a067248065b2fb264b25ba081afca35a3fae51bb04ad8820893

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Usman
+
+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,66 @@
+# RailsApiPaginate
+
+Add pagination support to rails API-Only applications for ActiveRecord relations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_api_paginate'
+```
+
+And then execute:
+
+    $ bundle
+
+Next, you need to run the generator:
+
+    $ rails g rails_api_paginate:install
+
+## Usage
+
+Include RailsApiPaginate in controller where you need to paginate ActiveRecord relations.
+
+```ruby
+include RailsApiPaginate
+```
+
+And then:
+
+```ruby
+records, meta = paginate(collection)
+```
+
+Example:
+
+```ruby
+posts = Post.all
+posts, meta = paginate(posts)
+```
+
+The `meta` object is a `Hash` that holds pagination details, e.g.
+
+```ruby
+{
+    current_page: 2,
+    next_page: 3,
+    prev_page: 1,
+    total_pages: 4,
+    total_items: 100
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/uxman-sherwani/rails_api_paginate.
+
+## 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,2 @@
+require 'bundler/gem_tasks'
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails_api_paginate"
+
+# 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/lib/generators/rails_api_paginate/install_generator.rb

@@ -0,0 +1,14 @@
+module RailsApiPaginate
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+      desc 'Creates RailsApiPaginate initializer for your application'
+
+      def copy_initializer
+        template 'rails_api_paginate_config.rb', 'config/initializers/rails_api_paginate_config.rb'
+
+        puts 'Install complete! Update config/initializers/rails_api_paginate_config.rb to your needs.'
+      end
+    end
+  end
+end

data/lib/generators/templates/rails_api_paginate_config.rb

@@ -0,0 +1,6 @@
+require 'rails_api_paginate'
+
+RailsApiPaginate.configure do |config|
+  config.default_per_page = 25
+  config.max_per_page = 100
+end

data/lib/rails_api_paginate/version.rb

@@ -0,0 +1,3 @@
+module RailsApiPaginate
+  VERSION = '1.0.0'
+end

data/lib/rails_api_paginate.rb

@@ -0,0 +1,35 @@
+require 'rails_api_paginate/version'
+
+module RailsApiPaginate
+  mattr_accessor :default_per_page, :max_per_page
+
+  def self.setup
+    yield self
+  end
+
+  def paginate(collection)
+    current_page = (params[:page].to_i)
+    current_page = 1 if current_page < 1
+
+    per_page = params[:per_page].to_i
+    per_page = default_per_page if per_page < 1 || per_page > max_per_page
+
+    total_items = collection.count
+    total_pages = (total_items.to_f / per_page).ceil
+
+    next_page = current_page + 1 if current_page < total_pages
+
+    prev_page = current_page - 1 if current_page > 1
+    prev_page = total_pages - 1 if current_page > total_pages
+
+    records = collection.limit(per_page).offset(per_page * (current_page - 1))
+
+    return records, {
+      current_page: current_page,
+      next_page: next_page,
+      prev_page: prev_page,
+      total_pages: total_pages,
+      total_items: total_items
+    }
+  end
+end

data/rails_api_paginate.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_api_paginate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rails_api_paginate'
+  spec.version       = RailsApiPaginate::VERSION
+  spec.authors       = ['Usman']
+  spec.email         = ['uxman.sherwani@gmail.com']
+
+  spec.summary       = %q{Pagination support for rails API-Only applications.}
+  spec.description   = %q{Add pagination support to rails API-Only applications for ActiveRecord relations.}
+  spec.homepage      = 'https://github.com/uxman-sherwani/rails_api_paginate'
+  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_runtime_dependency 'rails', '~> 5.0'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: rails_api_paginate
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Usman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: Add pagination support to rails API-Only applications for ActiveRecord
+  relations.
+email:
+- uxman.sherwani@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/rails_api_paginate/install_generator.rb
+- lib/generators/templates/rails_api_paginate_config.rb
+- lib/rails_api_paginate.rb
+- lib/rails_api_paginate/version.rb
+- rails_api_paginate.gemspec
+homepage: https://github.com/uxman-sherwani/rails_api_paginate
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Pagination support for rails API-Only applications.
+test_files: []