did_paginate 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25236dfb785f5fabf62039759b4e04e0159e292b
+  data.tar.gz: 3154ed9109f04fb6840dafc6aecf2390ebbfb74b
+SHA512:
+  metadata.gz: c2bc26a0159e71a51d69ba83d9b19ffb6e34fb7a0ba287c503afa71cf66902b250f875e1756dd3bd5e37754f0e6cd627d9d4dec01e72936932eff3412983b9c3
+  data.tar.gz: 704c004b6ffe7f671da0ecfe776c2b06ed13c540372985bfca6a18e0f72cdb2e1524f3e637da4faa09adfe61cd5c5a9778618d0822a487fec64192b09fd89e62

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alex Petropavlovsky
+
+MIT License
+
+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,95 @@
+# Overview
+
+This gem provides Rails view helper for rendering pagination component. It doesn't make any data queries to split data collection on pages, instead it assumes that collection has been already paginated and total pages count is known.
+
+Basically it gerenates html list of pagination items, where each item might link to certain page. There are several types of pagination item:
+ * previous page
+ * general page
+ * current page
+ * next page
+ * gap
+ 
+Previous page item and next page item are presented only if it's possible to go to those pages. General page item contains link to certain page. The items for the first and the last pages are always visible. Current page item doesn't link to current page (no sense to go from current page to current). Gap item contains `…` symbol and also doesn't link anywhere.
+
+This is how the rendered component looks like
+
+![Pagination component render](https://www.dropbox.com/s/du116n5vrzunc9f/Screenshot%202014-12-11%2018.38.56.png?dl=1)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'did_paginate'
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+To render pagination component you should use `did_paginate` helper
+
+    <%= did_paginate(self,
+                    @current_page, 
+                    @total_pages,                 
+                    params, 
+                    ->(url_params) { refinery.brands_admin_brands_path(url_params) },
+                    page_param_name: :page,
+                    klass: 'did-paginate-pager',
+                    siblings_count: 7) 
+                    %>
+                    
+This is the signature of this helper method
+
+    did_paginate(template, current_page, total_pages, params, url_builder, options = {})
+    
+The `params` parameter is a hash of request parameters used to keep other url query parameters in each generated pagination item, e.g. search query or category parameter.
+
+When it needs to create a url for certain pagination item, it calls the `url_builder` lambda parameter passing into a hash of all needed parameters for creating a url.
+
+The `options` parameter contains following settings:
+ * page_param_name
+ * klass
+ * siblings_count
+
+The `page_param_name` parameter is a name of the key of your `params` hash representing page query parameter in the url. Default values is `:page`.
+
+The `klass` parameter used for setting a CSS class on the root `ul` element of pagination component. Default value is `did-paginate-pager`. This is the HTML structure of entire component
+
+    <ul class="did-paginate-pager">
+        <li>
+            <a href="/products?page=5">previous</a>
+        </li>
+        <li>
+            <a href="/products?page=1">1</a>
+        </li>
+        <li class="disabled">
+            <a href="#">…</a>
+        </li>
+        ...
+        <li class="active">
+            <a href="#">6</a>
+        </li>
+        ...
+        <li>
+            <a href="/products?page=10">10</a>
+        </li>
+        <li>
+            <a href="/products?page=7">next</a>
+        </li>
+    </ul>
+    
+**NOTE**: if you want to use default style you need to require it in you application.css manifest file
+
+    *= require did_paginate
+    
+The `siblings_count` parameter determines how many items to show at each side of the current page item. Default value is `5`. Note that for each side this number includes two first items (first page and gap) and two last items (gap and last page), but doesn't include previous page and next page items.
+
+## 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 new Pull Request

data/Rakefile

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

data/did_paginate.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'did_paginate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "did_paginate"
+  spec.version       = DidPaginate::VERSION
+  spec.authors       = ["Alex Petropavlovsky"]
+  spec.email         = ["petalvlad@gmail.com"]
+  spec.description   = 'did_paginate provides Rails view helper to build pagination component. This helper assumes that collection data has been already paginated, i.e. current page and total pages count are known.'
+  spec.summary       = 'Renders pagination component for given current page and total pages count.'
+  spec.homepage      = "https://github.com/petalvlad/did_paginate"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/assets/stylesheets/did_paginate/index.css

@@ -0,0 +1,64 @@
+.did-paginate-pager {
+  display: inline-block;
+  padding-left: 0;
+  margin: 20px 0;
+  border-radius: 4px;
+}
+.did-paginate-pager > li {
+  display: inline;
+  padding: 0px !important;
+}
+.did-paginate-pager > li > a,
+.did-paginate-pager > li > span {
+  position: relative;
+  float: left;
+  padding: 6px 12px !important;
+  margin-left: -1px;
+  line-height: 1.42857143 !important;
+  color: #337ab7;
+  text-decoration: none;
+  background-color: #fff;
+  border: 1px solid #ddd !important;
+}
+.did-paginate-pager > li:first-child > a,
+.did-paginate-pager > li:first-child > span {
+  margin-left: 0;
+  border-top-left-radius: 4px;
+  border-bottom-left-radius: 4px;
+}
+.did-paginate-pager > li:last-child > a,
+.did-paginate-pager > li:last-child > span {
+  border-top-right-radius: 4px;
+  border-bottom-right-radius: 4px;
+}
+.did-paginate-pager > li > a:hover,
+.did-paginate-pager > li > span:hover,
+.did-paginate-pager > li > a:focus,
+.did-paginate-pager > li > span:focus {
+  color: #23527c;
+  background-color: #eee;
+  border-color: #ddd;
+}
+.did-paginate-pager > .active > a,
+.did-paginate-pager > .active > span,
+.did-paginate-pager > .active > a:hover,
+.did-paginate-pager > .active > span:hover,
+.did-paginate-pager > .active > a:focus,
+.did-paginate-pager > .active > span:focus {
+  z-index: 2;
+  color: #fff;
+  cursor: default;
+  background-color: #337ab7;
+  border-color: #337ab7;
+}
+.did-paginate-pager > .disabled > span,
+.did-paginate-pager > .disabled > span:hover,
+.did-paginate-pager > .disabled > span:focus,
+.did-paginate-pager > .disabled > a,
+.did-paginate-pager > .disabled > a:hover,
+.did-paginate-pager > .disabled > a:focus {
+  color: #777;
+  cursor: default;
+  background-color: #fff;
+  border-color: #ddd;
+}

data/lib/did_paginate.rb

@@ -0,0 +1,9 @@
+require 'did_paginate/version'
+require 'did_paginate/railtie' if defined?(Rails)
+require 'did_paginate/page_item'
+require 'did_paginate/pager'
+
+module DidPaginate  
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/did_paginate/page_item.rb

@@ -0,0 +1,73 @@
+module DidPaginate
+  
+  class PageItem
+    
+    ACTIVE_CLASS = 'active'
+    DISABLED_CLASS = 'disabled'
+    NULL_URL = '#'
+
+    attr_accessor :url, :content
+
+    def initialize(url, content, is_current)
+      @url = url || NULL_URL
+      @content = content
+      @is_current = is_current
+    end    
+
+    def is_current?
+      @is_current
+    end
+
+    def is_linkable?
+      @url != NULL_URL
+    end
+
+    def render(template)
+      template.content_tag(:li, template.link_to(@content, @url), class: item_class)
+    end
+
+  protected
+
+    def item_class    
+      return ACTIVE_CLASS if is_current?
+      DISABLED_CLASS unless is_linkable?
+    end   
+
+  end
+
+  class PreviousPageItem < PageItem
+    
+    def initialize(url, content = previous_span, is_current = false)
+      super(url, content, is_current)
+    end
+
+  private
+
+    def previous_span
+      '<span aria-hidden="true">&laquo;</span>'.html_safe
+    end
+
+  end
+
+  class NextPageItem < PageItem
+    
+    def initialize(url, content = next_span, is_current = false)
+      super(url, content, is_current)
+    end
+
+  private
+
+    def next_span
+      '<span aria-hidden="true">&raquo;</span>'.html_safe
+    end
+
+  end
+
+  class GapPageItem < PageItem
+    
+    def initialize(url = nil, content = '…', is_current = false)
+      super(url, content, is_current)
+    end
+
+  end
+end

data/lib/did_paginate/pager.rb

@@ -0,0 +1,127 @@
+module DidPaginate
+  class Pager
+    
+    def initialize(current_page, total_pages, params, url_builder, options = {})
+      options = default_options.merge(options)      
+      @current_page = current_page
+      @total_pages = total_pages      
+      @params = params    
+      @url_builder = url_builder
+      @page_param_name = options[:page_param_name]
+      @class = options[:klass]
+      @siblings_count = options[:siblings_count]
+      @all_items_count = @siblings_count * 2 + 1
+    end
+
+    def render(template)
+      html = items.map { |item| item.render(template) }.join.html_safe
+      template.content_tag(:ul, html, class: @class)
+    end
+
+    def items
+      @items ||= 
+        [ 
+          (previous_page_item if previous_page_item.is_linkable?), 
+          pages.map { |page| page_item(page) }, 
+          (next_page_item if next_page_item.is_linkable?)]          
+          .select { |item| item.present? }
+          .flatten
+    end
+
+  private
+
+    def default_options
+      { 
+        page_param_name: :page, 
+        klass: 'did-paginate-pager', 
+        siblings_count: 5
+      }
+    end
+
+    def previous_page_item
+      @previous_page_item ||= PreviousPageItem.new(item_url(@current_page - 1))
+    end
+
+    def next_page_item
+      @next_page_item ||= NextPageItem.new(item_url(@current_page + 1))
+    end
+
+    def pages
+      return (1..@total_pages).to_a if @total_pages <= @all_items_count
+      
+      # for example [24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34]
+      pages = pages_sequence
+
+      # turns above into [1, nil, 26, 27, 28, 29, 30, 31, 32, nil, 100]
+      add_gaps!(pages)
+      
+      pages
+    end
+
+    def pages_sequence
+      # for example, if @total_pages equals to 21
+      # @current_page equals to 2 
+      # siblings_count equals to 5            
+      # then unshifted_sequence will be equal
+      # [-3, -2, -1, 0, 1, 2, 3, 4, 5, 6, 7]    
+      unshifted_sequence = ((@current_page - @siblings_count)..(@current_page + @siblings_count)).to_a 
+
+      # offset will be equal to 4
+      offset = offset_of_pages(unshifted_sequence)
+
+      # shifts the above sequence
+      # [-3, -2, -1, 0, 1, 2, 3, 4, 5, 6, 7] to 
+      # [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]    
+      unshifted_sequence.map {|page| page + offset}
+    end
+
+    def offset_of_pages(pages)
+      left_offset = 1 - pages.first
+      right_offset = @total_pages - pages.last
+
+      if left_offset > 0
+        left_offset
+      elsif right_offset < 0
+        right_offset
+      else
+        0
+      end
+    end
+
+    def add_gaps!(pages) 
+      # adds gap to the head   
+      # [4, 5, 6, 7, 8, 9, 10] -> [1, nil, 6, 7, 8, 9, 10]    
+      pages[0], pages[1] = 1, nil if pages[2] != 3
+      
+      # adds gap to the tail
+      # [1, 2, 3, 4, 5, 6, 7] -> [1, 2, 3, 4, 5, nil, 10]
+      pages[-2], pages[-1] = nil, @total_pages if pages[-3] != @total_pages - 2
+    end
+
+    def page_item(page)
+      return GapPageItem.new if page.nil?
+      PageItem.new(item_url(page), page, is_page_current?(page))
+    end
+
+    def item_url(page)
+      return nil unless is_page_linkable?(page)
+      url_params = @params.merge({ @page_param_name => page })
+      url_params.delete(@page_param_name) if page <= 1
+      url_params = url_params.reject {|k,v| v.blank? }
+      @url_builder.call(url_params)
+    end
+
+    def is_page_linkable?(page)
+      is_page_exist?(page) && !is_page_current?(page)
+    end
+
+    def is_page_exist?(page)
+      page.present? && page > 0 && page <= @total_pages
+    end
+
+    def is_page_current?(page)    
+      @current_page == page
+    end
+  
+  end
+end

data/lib/did_paginate/railtie.rb

@@ -0,0 +1,11 @@
+require 'did_paginate/view_helpers'
+
+module DidPaginate
+  class Railtie < Rails::Railtie
+
+    initializer "did_paginate.view_helpers" do
+      ActionView::Base.send :include, ViewHelpers
+    end
+
+  end
+end

data/lib/did_paginate/version.rb

@@ -0,0 +1,3 @@
+module DidPaginate
+  VERSION = "0.0.1"
+end

data/lib/did_paginate/view_helpers.rb

@@ -0,0 +1,9 @@
+module DidPaginate
+  module ViewHelpers
+
+    def did_paginate(template, current_page, total_pages, params, url_builder, options = {})
+      DidPaginate::Pager.new(current_page, total_pages, params, url_builder, options).render(template)    
+    end
+
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: did_paginate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex Petropavlovsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: did_paginate provides Rails view helper to build pagination component.
+  This helper assumes that collection data has been already paginated, i.e. current
+  page and total pages count are known.
+email:
+- petalvlad@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- did_paginate.gemspec
+- lib/assets/stylesheets/did_paginate/index.css
+- lib/did_paginate.rb
+- lib/did_paginate/page_item.rb
+- lib/did_paginate/pager.rb
+- lib/did_paginate/railtie.rb
+- lib/did_paginate/version.rb
+- lib/did_paginate/view_helpers.rb
+homepage: https://github.com/petalvlad/did_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.2.2
+signing_key: 
+specification_version: 4
+summary: Renders pagination component for given current page and total pages count.
+test_files: []