smart_pagination 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38a44adbebe9175085a9987a30fd959f0ccea1f3
+  data.tar.gz: 41037b399a8913f0774b64883fb18625715dd576
+SHA512:
+  metadata.gz: e3876b7f670150061bcce253880684f9076fca8532aa3b2e15cef182214b5177ab1f8136d6d14a5118823ad17885e26a125d3cb61d31996b154f2da6702d8cde
+  data.tar.gz: ebe79f1369d85c67f38cab3b47135fe43db92b38d44a53e2bb107da5d20979ddb19cd0325acad08d0f6c4577380ad9945836ef895457f911b248f8c38233e4d4

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    smart_pagination (0.1.0)
+      actionview (>= 4.0.0, < 5.2)
+      smart_paginate (~> 0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (5.1.1)
+      activesupport (= 5.1.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.1.1)
+      activesupport (= 5.1.1)
+    activerecord (5.1.1)
+      activemodel (= 5.1.1)
+      activesupport (= 5.1.1)
+      arel (~> 8.0)
+    activesupport (5.1.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    erubi (1.6.0)
+    i18n (0.8.4)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mini_portile2 (2.1.0)
+    minitest (5.10.2)
+    nokogiri (1.7.2)
+      mini_portile2 (~> 2.1.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    rake (10.5.0)
+    smart_paginate (0.2.0)
+      activerecord (>= 4.0.0, < 5.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  smart_pagination!
+
+BUNDLED WITH
+   1.14.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jonian Guveli
+
+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,92 @@
+# SmartPagination
+
+SmartPagination adds view helpers for SmartPaginate. A simple, smart and clean pagination extension for Active Record and plain Ruby Arrays:
+
+- **Simple:** Easy to use, with a simple interface. It just does pagination, nothing more.
+- **Smart:** Can navigate through the pages without having to do an expensive count query. SmartPaginate will actually fetch one record more than needed and use it to determine if there's a next page.
+- **Clean:** The code is as minimal as possible while still useful. SmartPaginate does not auto include itself or monkey patch any classes.
+
+For more details you can check SmartPaginate at https://github.com/ppostma/smart_paginate.
+
+[![Gem Version](https://badge.fury.io/rb/smart_pagination.svg)](https://badge.fury.io/rb/smart_pagination)
+[![Build Status](https://travis-ci.org/hardpixel/smart-pagination.svg?branch=master)](https://travis-ci.org/hardpixel/smart-pagination)
+[![Code Climate](https://codeclimate.com/github/hardpixel/smart-pagination/badges/gpa.png)](https://codeclimate.com/github/hardpixel/smart-pagination)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smart_pagination'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smart_pagination
+
+## Usage
+
+To enable pagination in an Active Record model, include the `SmartPagination` or `SmartPaginate` concern in your class:
+
+```ruby
+class User < ActiveRecord::Base
+  include SmartPagination
+end
+```
+
+Then you can use the paginate scope to paginate results:
+
+```ruby
+@users = User.paginate(page: params[:page], per_page: params[:per_page])
+```
+
+And finally you can use the `smart_pagination_for` or `pagination_for` helper in your views to render the pagination links:
+
+```ruby
+<%= smart_pagination_for(@users) %>
+```
+
+If you want to render only previous and next links you can use the `smart_pager_for` or `pager_for` helper in your views:
+
+```ruby
+<%= smart_pager_for(@users) %>
+```
+
+There are a number of options you can use to customize the pagination links. The default options are:
+
+```ruby
+options = {
+  pager_mode:     false,
+  item_class:     '',
+  previous_text:  '&laquo;',
+  previous_class: 'previous',
+  next_text:      '&raquo;',
+  next_class:     'next',
+  active_class:   'active',
+  disabled_class: 'disabled',
+  wrapper:        'ul',
+  wrapper_class:  'pagination',
+  item_wrapper:   'li',
+  inner_window:    2,
+  outer_window:    0
+}
+
+smart_pagination_for(@users, options)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hardpixel/smart-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,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/lib/smart_pagination.rb

@@ -0,0 +1,16 @@
+require 'smart_paginate'
+require 'smart_pagination/version'
+require 'smart_pagination/helper'
+require 'smart_pagination/renderer'
+
+module SmartPagination
+  class << self
+    def included(model_class)
+      model_class.send :include, SmartPaginate
+    end
+  end
+end
+
+if defined? ActionView::Base
+  ActionView::Base.send :include, SmartPagination::Helper
+end

data/lib/smart_pagination/helper.rb

@@ -0,0 +1,20 @@
+module SmartPagination
+  module Helper
+    # Render pagination links
+    def smart_pagination_for(collection, options={})
+      SmartPagination::Renderer.new(self, collection, options).render
+    end
+
+    # Alias helper method
+    alias :pagination_for :smart_pagination_for
+
+    # Render pager links
+    def smart_pager_for(collection, options={})
+      options = options.merge(pager_mode: true)
+      SmartPagination::Renderer.new(self, collection, options).render
+    end
+
+    # Alias helper method
+    alias :pager_for :smart_pager_for
+  end
+end

data/lib/smart_pagination/renderer.rb

@@ -0,0 +1,183 @@
+module SmartPagination
+  class Renderer
+    # Initialize pagination renderer
+    def initialize(context, collection, options={})
+      @context    = context
+      @collection = collection
+      @options    = default_options.merge(options)
+    end
+
+    # Render pagination links
+    def render
+      pager_mode? ? pager : pagination
+    end
+
+    private
+
+      # Default options
+      def default_options
+        {
+          pager_mode:     false,
+          item_class:     '',
+          previous_text:  '«',
+          previous_class: 'previous',
+          next_text:      '»',
+          next_class:     'next',
+          active_class:   'active',
+          disabled_class: 'disabled',
+          wrapper:        'ul',
+          wrapper_class:  'pagination',
+          item_wrapper:   'li',
+          inner_window:    2,
+          outer_window:    0
+        }
+      end
+
+      # Get current_page
+      def current_page
+        @collection.current_page.to_i
+      end
+
+      # Get total pages
+      def total_pages
+        @total_pages ||= @collection.total_pages
+      end
+
+      # Check if current page
+      def current_page?(page)
+        page.to_i == current_page
+      end
+
+      # Check if pager mode enabled
+      def pager_mode?
+        @options[:pager_mode].present?
+      end
+
+      # Get page numbers
+      def page_numbers
+        inner = @options[:inner_window].to_i
+        outer = @options[:outer_window].to_i
+        from  = current_page - inner
+        to    = current_page + inner
+
+        if to > total_pages
+          from -= to - total_pages
+          to    = total_pages
+        end
+
+        if from < 1
+          to   += 1 - from
+          from  = 1
+          to    = total_pages if to > total_pages
+        end
+
+        middle = from..to
+
+        if outer + 3 < middle.first
+          left = (1..(outer + 1)).to_a
+          left << :sep
+        else
+          left = 1...middle.first
+        end
+
+        if total_pages - outer - 2 > middle.last
+          right = ((total_pages - outer)..total_pages).to_a
+          right.unshift :sep
+        else
+          right = (middle.last + 1)..total_pages
+        end
+
+        left.to_a + middle.to_a + right.to_a
+      end
+
+      # Get link params
+      def link_params(page)
+        if page.is_a? Integer
+          { page: page }
+        else
+          { page: @collection.send(:"#{page}_page") }
+        end
+      end
+
+      # Get link options
+      def link_options(page)
+        if page.is_a? Integer
+          active = @options[:active_class] if current_page? page
+          { class: "#{@options[:item_class]} #{active}".strip }
+        else
+          disabled   = @options[:disabled_class] unless @collection.send(:"#{page}_page?")
+          item_class = @options[:"#{page}_class"]
+
+          { class: "#{@options[:item_class]} #{item_class} #{disabled}".strip }
+        end
+      end
+
+      # Page link
+      def page_link(page)
+        item_link page, link_params(page), link_options(page)
+      end
+
+      # Previous link
+      def previous_link
+        item_link @options[:previous_text], link_params(:previous), link_options(:previous)
+      end
+
+      # Next link
+      def next_link
+        item_link @options[:next_text], link_params(:next), link_options(:next)
+      end
+
+      # Render item link
+      def item_link(text, params={}, html_options={})
+        wrapper  = @options[:item_wrapper]
+        link_opt = html_options if wrapper.blank?
+        item_tag = link_to text, params, link_opt
+        item_tag = tag wrapper, item_tag, html_options if wrapper.present?
+
+        item_tag
+      end
+
+      # Render item separator
+      def item_sep
+        item_link '&hellip;', {}, class: "#{@options[:item_class]} #{@options[:disabled_class]}".strip
+      end
+
+      # Render content tag
+      def tag(*args, &block)
+        @context.content_tag(*args, &block)
+      end
+
+      # Render link tag
+      def link_to(text, params={}, html_options={})
+        url = @context.url_for params.merge(per_page: @collection.per_page)
+        opt = html_options.to_h
+
+        opt.merge!(href: url) if params[:page].present?
+        tag :a, "#{text}".html_safe, opt
+      end
+
+      # Render wrapper
+      def wrapper(links)
+        wrapper  = @options[:wrapper]
+        wrap_opt = { class: @options[:wrapper_class] }
+        wrap_tag = links.html_safe
+        wrap_tag = tag wrapper, wrap_tag, wrap_opt if wrapper.present?
+
+        wrap_tag
+      end
+
+      # Render pager
+      def pager
+        items = [previous_link, next_link]
+        wrapper items.map(&:to_s).join
+      end
+
+      # Render pagination
+      def pagination
+        items = page_numbers.map { |page| page == :sep ? item_sep : page_link(page) }
+        items = [previous_link, *items, next_link]
+
+        wrapper items.map(&:to_s).join
+      end
+  end
+end

data/lib/smart_pagination/version.rb

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

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: smart_pagination
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonian Guveli
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: smart_paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Adds view helpers for SmartPaginate. A simple, smart and clean pagination
+  extension for Active Record and plain Ruby Arrays.
+email:
+- jonian@hardpixel.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/smart_pagination.rb
+- lib/smart_pagination/helper.rb
+- lib/smart_pagination/renderer.rb
+- lib/smart_pagination/version.rb
+homepage: https://github.com/hardpixel/smart-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.6.11
+signing_key: 
+specification_version: 4
+summary: View helpers for SmartPaginate
+test_files: []