guess_paging 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6c5c44a20928974b3cc25482d83b9e2aa6743257
+  data.tar.gz: bd1a108ceb24a9eacbdaf8c9f4b5e60aa1110b9b
+SHA512:
+  metadata.gz: 4af71b6d1298ec1d670702a1fb4d2ea71a412fefc4411a5178c283469a512f0a3e7376f5f05567fb3bd06369821f6c56bc645bd3b51fd7392d18d05d4521db7c
+  data.tar.gz: e5cfe2a2960e96a232274fc4acf27d2aacfcd1420064dfea310d1c541d1801f9d2c225a95928b081cff62e1f83829eb8ab0988cc0adde1d4dc18f00fb4f000a0

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at h3.poteto@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 h3poteto
+
+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,99 @@
+# guess_paging
+
+guess_paging is a pagination library, and this library work wonderfully when you treat many records in RDB.
+
+## Features
+### Light workload
+General pagination libraries calculate records size to display accurate last page number. But sometimes, count query is too heavy workload for database, if you use heavy SQL Query. In the result, page speed slow.
+
+guess_paging calculate and cache records size at the first time. From then on, guess_paging not count records size, and display last page number of suitable size. When user click that last page, once again calculate accurate last page number, and refresh cache.
+When user visit first page and halfway pages, count query is not called.
+
+So, guess_paging is light workload for database, because it call count query at the first time and last page only.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'guess_paging'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install guess_paging
+
+## Usage
+
+### Setup redis
+This gem requires `redis`, so please prepare `redis-server` and setup redis in initializer.
+
+```ruby
+GuessPaging::RedisClient.setup do |config|
+  config.redis_host = '127.0.0.1'
+  config.redis_port = 6379
+end
+```
+
+### Controllers
+```ruby
+class RecordsController < ApplicationController
+  def search
+    @guess = GuessPaging::Paginate.new(
+      query: Record.where(category_id: params[:category_id].to_i),
+      per_page: 10)
+    @guess.guess(
+      page_params: params[:page]
+    )
+  end
+end
+```
+
+### Views
+```erb
+<%= paging(@guess) %>
+```
+
+### Helpers
+- output pagination view
+  
+  ```erb
+  <%= paging(@guess) %>
+  ```
+- current page number
+  
+  ```ruby
+  @guess.current_page
+  ```
+
+- last page number of suitable size
+  
+  ```ruby
+  @guess.max_page
+  ```
+
+- record number of suitable size.
+  
+  ```ruby
+  @guess.count
+  ```
+
+## 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/[USERNAME]/guess_paging. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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 "guess_paging"
+
+# 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,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/guess_paging.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'guess_paging/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "guess_paging"
+  spec.version       = GuessPaging::VERSION
+  spec.authors       = ["h3poteto"]
+  spec.email         = ["h3.poteto@gmail.com"]
+
+  spec.summary       = %q{Pagination for many records}
+  spec.description   = %q{Pagination for rails when to treat many records or big table in RDB.}
+  spec.homepage      = "https://github.com/h3poteto/guess_paging"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    #spec.metadata['allowed_push_host'] = "git@github.com:h3poteto/guess_paging"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "redis", "~> 3.2"
+end

data/lib/guess_paging.rb

@@ -0,0 +1,4 @@
+require "guess_paging/version"
+require "guess_paging/paginate"
+require "guess_paging/engine"
+require "guess_paging/redis_client"

data/lib/guess_paging/engine.rb

@@ -0,0 +1,11 @@
+require 'guess_paging/guess_helper'
+module GuessPaging
+  class Engine < ::Rails::Engine
+    isolate_namespace GuessPaging
+    initializer 'guess_paging.action_view_helpers' do
+      ActiveSupport.on_load :action_view do
+        include GuessPaging::GuessHelper
+      end
+    end
+  end
+end

data/lib/guess_paging/guess_helper.rb

@@ -0,0 +1,91 @@
+module GuessPaging
+  module GuessHelper
+    def paging(guess)
+      hash = request.params
+      hash.delete(:controller)
+      hash.delete(:action)
+      div = content_tag(:div, class: 'guess-paging') do
+        content_tag(:ul) do
+          if guess.current_page < 5
+            first_paging(guess, hash)
+          elsif guess.current_page > guess.max_page - 4
+            last_paging(guess, hash)
+          else
+            middle_paging(guess, hash)
+          end
+        end
+      end
+      div.html_safe
+    end
+
+    def first_paging(guess, hash)
+      li = ""
+      (1..4).each do |i|
+        li << if i == guess.current_page
+                content_tag(:li, class: 'active') do
+                  "#{i}"
+                end
+              else
+                content_tag(:li) do
+                  link_to("#{i}", request.path + "?" + hash.merge(page: i).to_param)
+                end
+              end
+      end
+      li << content_tag(:li, class: 'truncate') do
+        "..."
+      end
+      li <<  content_tag(:li, class: 'last') do
+        link_to("#{guess.max_page}", request.path + "?" + hash.merge(page: guess.max_page).to_param)
+      end
+      li.html_safe
+    end
+
+    def last_paging(guess, hash)
+      li = content_tag(:li) do
+        link_to("1", request.path + "?" + hash.merge(page: 1).to_param)
+      end
+      li << content_tag(:li, class: 'truncate') do
+        "..."
+      end
+      ((guess.max_page - 3)..guess.max_page).each do |i|
+        li << if i == guess.current_page
+                content_tag(:li, class: 'active') do
+                  "#{i}"
+                end
+              else
+                content_tag(:li) do
+                  link_to("#{i}", request.path + "?" + hash.merge(page: i).to_param)
+                end
+              end
+      end
+      li.html_safe
+    end
+
+    def middle_paging(guess, hash)
+      li = content_tag(:li) do
+        link_to("1", request.path + "?" + hash.merge(page: 1).to_param)
+      end
+      li << content_tag(:li, class: 'truncate') do
+        "..."
+      end
+      ((guess.current_page - 2)..(guess.current_page + 2)).each do |i|
+        li << if guess.current_page == i
+                content_tag(:li, class: 'active') do
+                  "#{i}"
+                end
+              else
+                content_tag(:li) do
+                  link_to("#{i}", request.path + "?" + hash.merge(page: i).to_param)
+                end
+              end
+      end
+      li << content_tag(:li) do
+        "..."
+      end
+      li << content_tag(:li) do
+        link_to("#{guess.max_page}", request.path + "?" + hash.merge(page: guess.max_page).to_param)
+      end
+      li.html_safe
+    end
+  end
+end

data/lib/guess_paging/paginate.rb

@@ -0,0 +1,54 @@
+module GuessPaging
+  class Paginate
+    attr_reader :current_page, :max_page, :count, :query, :records
+
+    def initialize(query: nil, per_page: 10, essential: 3)
+      @query = query
+      @key = Digest::MD5.hexdigest(query.all.to_sql.to_s)
+      @per_page = per_page
+      @essential = essential
+    end
+
+    def guess(page_params: nil)
+      get_max_page
+      if page(page_params).length < @per_page
+        last_page = @query.count / @per_page + 1
+        GuessPaging::RedisClient.set(@key, last_page) if last_page != get_max_page
+        @records = @query.limit(@per_page).offset(@per_page * (last_page - 1))
+        @current_page = last_page
+        @max_page = last_page
+        @count = @query.count
+      else
+        @current_page = get_page(page_params)
+        @max_page = get_max_page
+        @count = @max_page * @per_page
+      end
+    end
+
+    private
+
+    def get_page(page_params)
+      page_params ? page_params.to_i : 1
+    end
+
+    def page(page_params)
+      @records = @query.limit(@per_page).offset(@per_page * (get_page(page_params) - 1))
+    end
+
+    def get_max_page
+      max = GuessPaging::RedisClient.get(@key).to_i
+      if max.blank? || max.zero?
+        all = @query.count
+        max = all % @per_page == 0 ? all / @per_page : (all / @per_page + 1)
+        GuessPaging::RedisClient.set(@key, max)
+      end
+
+      count_digit = max.to_s.length
+      if count_digit > @essential
+        i = max.to_f / (10 ** (count_digit - @essential))
+        last_page = (i.ceil * 10 ** (count_digit - @essential)).to_i
+      end
+      last_page ||= max
+    end
+  end
+end

data/lib/guess_paging/redis_client.rb

@@ -0,0 +1,28 @@
+require 'redis'
+
+module GuessPaging
+  class RedisClient
+    cattr_accessor :redis_host, :redis_port
+    cattr_accessor :redis
+    @@redis_host = nil
+    @@redis_port = nil
+    @@redis = nil
+    def self.setup
+      yield self
+    end
+
+    def self.config
+      @@redis = Redis.new(host: @@redis_host, port: @@redis_port)
+    end
+
+    def self.set(key, value)
+      config unless @@redis
+      @@redis.set(key, value)
+    end
+
+    def self.get(key)
+      config unless @@redis
+      @@redis.get(key)
+    end
+  end
+end

data/lib/guess_paging/version.rb

@@ -0,0 +1,3 @@
+module GuessPaging
+  VERSION = "0.1.0"
+end

data/vendor/assets/stylesheets/guess_paging/index.css.scss

@@ -0,0 +1,27 @@
+.guess-paging {
+  width: 100%;
+  text-align: center;
+  ul {
+    list-style-type: none;
+    padding: 8px;
+    li {
+      font-size: 11px;
+      display: inline-block;
+      padding: 6px;
+      border-left: 1px solid rgb(180, 180, 180);
+      border-top: 1px solid rgb(180, 180, 180);
+      border-bottom: 1px solid rgb(180, 180, 180);
+      a, a:hover, a:visited {
+        color: rgb(66, 139, 202);
+        text-decoration: none;
+      }
+    }
+    li.active {
+      color: rgb(255, 255, 255);
+      background: rgb(66, 139, 202);
+    }
+    li:last-child {
+      border-right: 1px solid rgb(180, 180, 180);
+    }
+  }
+}

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: guess_paging
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- h3poteto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Pagination for rails when to treat many records or big table in RDB.
+email:
+- h3.poteto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- guess_paging.gemspec
+- lib/guess_paging.rb
+- lib/guess_paging/engine.rb
+- lib/guess_paging/guess_helper.rb
+- lib/guess_paging/paginate.rb
+- lib/guess_paging/redis_client.rb
+- lib/guess_paging/version.rb
+- vendor/assets/stylesheets/guess_paging/index.css.scss
+homepage: https://github.com/h3poteto/guess_paging
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Pagination for many records
+test_files: []