page_adams 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 469e57128393113fb99819c0f749211948e46b4e
+  data.tar.gz: 4cbf476bb2960d604e3ed7deeab5c1accc4322d9
+SHA512:
+  metadata.gz: b64d1392ce5006b58c74bca6888530a8cf4c279594269a096d4a7438c8139349e36600f3cc8ba178019d386d8489357de030f14b4e0b247846e7bb33e7e267d7
+  data.tar.gz: dda424b5b5f571665b731cbee4a74fac09645137ad76cc7e65a3ec9550b476f8426ab17a0149c1f5bb5e7e6adf5cae7a80ac758d889d0ac01154753690f8e1f4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Sebastián González
+
+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,47 @@
+# PageAdams
+ActiveRecord model pagination made easy.
+
+## Usage
+Include PageAdams in every model you want to paginate
+~~~ruby
+class Article < ApplicationRecord
+  include PageAdams
+end
+~~~
+
+That's it. Now you can call `Article.page 5` to get the fifth page of paginated results.
+
+`page` returns a hash of the following structure:
+~~~ruby
+> Article.page 0
+=> {:records=>#<ActiveRecord::Relation [#<Article id: 1>]>, :current_page=>1, :total_pages=>4}
+~~~
+
+in wich
+* the `:records` key holds an array of instances (or empty) (`ActiveRecord::Relation`)
+* the `:current_page` key holds the current retrieved page (`Integer`)
+* the `:total_pages` key holds the total number of instances pages (`Integer`)
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'page_adams'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+```bash
+$ gem install page_adams
+```
+
+## Tests
+A basic suite of tests has been included into the gem, using RSpec. 
+Clone the project, enter the folder and run `rspec`.
+
+## 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,26 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PageAdams'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+

data/lib/page_adams.rb

@@ -0,0 +1,25 @@
+require "page_adams/engine"
+
+module PageAdams
+  mattr_accessor :page_size
+  @@page_size = 10
+  
+  def self.setup
+    yield self  
+  end
+
+  def self.included klass
+    klass.extend ClassMethods
+  end
+
+  module ClassMethods
+    def page page, page_size = 10
+      page = 1 if page.nil? or not page.is_a? Integer or page <= 0
+      total_records = self.count
+      # page_size = 10
+      total_pages = ((total_records % page_size) == 0) ? total_records / page_size : total_records / page_size + 1
+      records = self.offset(page_size * (page - 1)).limit(page_size)
+      { records: records, current_page: page, total_pages: total_pages }
+    end
+  end
+end

data/lib/page_adams/engine.rb

@@ -0,0 +1,8 @@
+module PageAdams
+  class Engine < ::Rails::Engine
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_girl      
+    end
+  end
+end

data/lib/page_adams/version.rb

@@ -0,0 +1,3 @@
+module PageAdams
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: page_adams
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sebastián González
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-09 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: sqlite3
+  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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: Automatically paginate your ActiveRecord models.
+email:
+- sebagonz91@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/page_adams.rb
+- lib/page_adams/engine.rb
+- lib/page_adams/version.rb
+homepage: https://github.com/sebastialonso/page_adams
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Pagination made easy.
+test_files: []