page_clip 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 855d3260600eacab9c0cdc86cdb2e4902a2f2716
+  data.tar.gz: c836d76d3213776f3d068b51816483dd25311fcf
+SHA512:
+  metadata.gz: d5736b8475dda63cb9cf11b6e4bcaff09c3a5067ecd66109f194f0e3ca73175859b4cf44dff1385022d833b346a1de4debd7a6ec06371e564868c12bcba8ba16
+  data.tar.gz: 84d3cd93b851075720705ce74bb71e724ff0c081b2ade82971149ea078383de90df5cd1b8a454b44a706aec495c99e989e0eeaec1329611900343dbe4904b50a

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+coverage/

data/.rubocop.yml

@@ -0,0 +1,14 @@
+cs/AbcSize:
+  Max: 30
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 15
+
+Style/Documentation:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.2

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright © 2015 Mert Guldur
+
+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,32 @@
+# page_clip
+
+[![Build Status](https://travis-ci.org/mertguldur/page_clip.svg?branch=master)](https://travis-ci.org/mertguldur/page_clip)
+[![Coverage Status](https://coveralls.io/repos/mertguldur/page_clip/badge.svg?branch=master&service=github)](https://coveralls.io/github/mertguldur/page_clip?branch=master)
+
+Page clip calculates the pages to display in a paginator based on item count, items per page, current page and number of pages to display.
+
+## Installation
+
+```ruby
+gem 'page_clip'
+```
+
+## Examples
+
+```ruby
+pages, last_page = PageClip.show \
+  item_count: 100,
+  per_page: 10,
+  current_page: 1,
+  pages_to_show_count: 5
+pages # => [1, 2, 3, 4, 5]
+last_page # => 10
+
+pages, last_page = PageClip.show \
+  item_count: 100,
+  per_page: 20,
+  current_page: 3,
+  pages_to_show_count: 3
+pages # => [2, 3, 4]
+last_page # => 5
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:rubocop, :spec]

data/lib/page_clip.rb

@@ -0,0 +1,73 @@
+require 'set'
+
+class PageClip
+  def initialize(item_count, per_page, current_page, pages_to_show_count)
+    verify_arguments(item_count, per_page, current_page, pages_to_show_count)
+
+    @current_page = current_page
+    @page_count = (item_count.to_f / per_page.to_f).ceil
+    @pages = (1..@page_count).to_set
+    @side_pages_to_show_count = (pages_to_show_count - 1) / 2
+  end
+
+  def self.show(item_count:, per_page:, current_page:, pages_to_show_count:)
+    new(item_count, per_page, current_page, pages_to_show_count).calculate
+  end
+
+  def calculate
+    [pages_to_show, @page_count]
+  end
+
+  private
+
+  def pages_to_show
+    return [] if @page_count.zero?
+
+    verify_current_page
+
+    pages = [@current_page]
+
+    pages_to_add, left_missed_page_count = side_pages_to_add(:left)
+    pages += pages_to_add
+
+    if left_missed_page_count > 0
+      pages += side_pages_to_add(:right, left_missed_page_count).first
+      return pages.sort
+    end
+
+    pages_to_add, right_missed_page_count = side_pages_to_add(:right)
+    pages += pages_to_add
+
+    if right_missed_page_count > 0
+      pages += side_pages_to_add(:left, right_missed_page_count).first
+    end
+
+    pages.uniq.sort
+  end
+
+  def side_pages_to_add(direction, extra_page_count = 0)
+    pages = []
+    page = @current_page
+    pages_to_add_count = @side_pages_to_show_count + extra_page_count
+
+    pages_to_add_count.times do
+      page = direction == :left ? page - 1 : page + 1
+      pages << page if @pages.include?(page)
+    end
+
+    missed_page_count = pages_to_add_count - pages.size
+    [pages, missed_page_count]
+  end
+
+  def verify_arguments(item_count, per_page, current_page, pages_to_show_count)
+    fail "Item count can't be negative!" if item_count < 0
+    fail 'Per page must be positive!' if per_page <= 0
+    fail 'Current page must be positive!' if current_page <= 0
+    fail 'Pages to show count must be positive!' if pages_to_show_count <= 0
+    fail 'Pages to show count must be an odd number!' if pages_to_show_count.even?
+  end
+
+  def verify_current_page
+    fail "Current page can't be greater than the last page!" if @current_page > @page_count
+  end
+end

data/page_clip.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name        = 'page_clip'
+  s.version     = '1.0.0'
+  s.date        = '2015-08-18'
+  s.summary     = 'Pagination calculator'
+  s.description = 'Calculates pages to display in a paginator'
+  s.authors     = ['Mert Guldur']
+  s.email       = 'mertguldur@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+  s.license     = 'MIT'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'coveralls'
+  s.add_development_dependency 'rubocop'
+end

data/spec/page_clip_spec.rb

@@ -0,0 +1,279 @@
+require 'spec_helper'
+
+describe PageClip do
+  describe '.show' do
+    context 'item count' do
+      context '0 items, 10 per page, page 1, 5 pages to show' do
+        it 'returns pages: [1], last_page: 1' do
+          pages, last_page = described_class.show \
+            item_count: 0,
+            per_page: 10,
+            current_page: 1,
+            pages_to_show_count: 5
+          expect(pages).to eq([])
+          expect(last_page).to eq(0)
+        end
+      end
+
+      context '10 items, 10 per page, page 1, 5 pages to show' do
+        it 'returns pages: [1], last_page: 1' do
+          pages, last_page = described_class.show \
+            item_count: 10,
+            per_page: 10,
+            current_page: 1,
+            pages_to_show_count: 5
+          expect(pages).to eq([1])
+          expect(last_page).to eq(1)
+        end
+      end
+
+      context '20 items, 10 per page, page 1, 5 pages to show' do
+        it 'returns pages: [1, 2], last_page: 2' do
+          pages, last_page = described_class.show \
+            item_count: 20,
+            per_page: 10,
+            current_page: 1,
+            pages_to_show_count: 5
+          expect(pages).to eq([1, 2])
+          expect(last_page).to eq(2)
+        end
+      end
+
+      context '50 items, 10 per page, page 1, 5 pages to show' do
+        it 'returns pages: [1, 2, 3, 4, 5], last_page: 5' do
+          pages, last_page = described_class.show \
+            item_count: 50,
+            per_page: 10,
+            current_page: 1,
+            pages_to_show_count: 5
+          expect(pages).to eq([1, 2, 3, 4, 5])
+          expect(last_page).to eq(5)
+        end
+      end
+
+      context '60 items, 10 per page, page 1, 5 pages to show' do
+        it 'returns pages: [1, 2, 3, 4, 5], last_page: 6' do
+          pages, last_page = described_class.show \
+            item_count: 60,
+            per_page: 10,
+            current_page: 1,
+            pages_to_show_count: 5
+          expect(pages).to eq([1, 2, 3, 4, 5])
+          expect(last_page).to eq(6)
+        end
+      end
+    end
+
+    context 'per page' do
+      context '50 items, 10 per page, page 1, 5 pages to show' do
+        it 'returns pages: [1, 2, 3, 4, 5], last_page: 5' do
+          pages, last_page = described_class.show \
+            item_count: 50,
+            per_page: 10,
+            current_page: 1,
+            pages_to_show_count: 5
+          expect(pages).to eq([1, 2, 3, 4, 5])
+          expect(last_page).to eq(5)
+        end
+      end
+
+      context '50 items, 25 per page, page 1, 5 pages to show' do
+        it 'returns pages: [1, 2], last_page: 2' do
+          pages, last_page = described_class.show \
+            item_count: 50,
+            per_page: 25,
+            current_page: 1,
+            pages_to_show_count: 5
+          expect(pages).to eq([1, 2])
+          expect(last_page).to eq(2)
+        end
+      end
+
+      context '50 items, 50 per page, page 1, 5 pages to show' do
+        it 'returns pages: [1], last_page: 1' do
+          pages, last_page = described_class.show \
+            item_count: 50,
+            per_page: 50,
+            current_page: 1,
+            pages_to_show_count: 5
+          expect(pages).to eq([1])
+          expect(last_page).to eq(1)
+        end
+      end
+
+      context '50 items, 60 per page, page 1, 5 pages to show' do
+        it 'returns pages: [1], last_page: 1' do
+          pages, last_page = described_class.show \
+            item_count: 50,
+            per_page: 60,
+            current_page: 1,
+            pages_to_show_count: 5
+          expect(pages).to eq([1])
+          expect(last_page).to eq(1)
+        end
+      end
+    end
+
+    context 'current page' do
+      context '60 items, 10 per page, page 1, 5 pages to show' do
+        it 'returns pages: [1, 2, 3, 4, 5], last_page: 6' do
+          pages, last_page = described_class.show \
+            item_count: 60,
+            per_page: 10,
+            current_page: 1,
+            pages_to_show_count: 5
+          expect(pages).to eq([1, 2, 3, 4, 5])
+          expect(last_page).to eq(6)
+        end
+      end
+
+      context '60 items, 10 per page, page 3, 5 pages to show' do
+        it 'returns pages: [1, 2, 3, 4, 5], last_page: 6' do
+          pages, last_page = described_class.show \
+            item_count: 60,
+            per_page: 10,
+            current_page: 3,
+            pages_to_show_count: 5
+          expect(pages).to eq([1, 2, 3, 4, 5])
+          expect(last_page).to eq(6)
+        end
+      end
+
+      context '60 items, 10 per page, page 4, 5 pages to show' do
+        it 'returns pages: [2, 3, 4, 5, 6], last_page: 6' do
+          pages, last_page = described_class.show \
+            item_count: 60,
+            per_page: 10,
+            current_page: 4,
+            pages_to_show_count: 5
+          expect(pages).to eq([2, 3, 4, 5, 6])
+          expect(last_page).to eq(6)
+        end
+      end
+
+      context '60 items, 10 per page, page 6, 5 pages to show' do
+        it 'returns pages: [2, 3, 4, 5, 6], last_page: 6' do
+          pages, last_page = described_class.show \
+            item_count: 60,
+            per_page: 10,
+            current_page: 6,
+            pages_to_show_count: 5
+          expect(pages).to eq([2, 3, 4, 5, 6])
+          expect(last_page).to eq(6)
+        end
+      end
+    end
+
+    context 'pages to show count' do
+      context '50 items, 10 per page, page 1, 5 pages to show' do
+        it 'returns pages: [1, 2, 3, 4, 5], last_page: 5' do
+          pages, last_page = described_class.show \
+            item_count: 50,
+            per_page: 10,
+            current_page: 1,
+            pages_to_show_count: 5
+          expect(pages).to eq([1, 2, 3, 4, 5])
+          expect(last_page).to eq(5)
+        end
+      end
+
+      context '50 items, 10 per page, page 1, 3 pages to show' do
+        it 'returns pages: [1, 2, 3], last_page: 5' do
+          pages, last_page = described_class.show \
+            item_count: 50,
+            per_page: 10,
+            current_page: 1,
+            pages_to_show_count: 3
+          expect(pages).to eq([1, 2, 3])
+          expect(last_page).to eq(5)
+        end
+      end
+
+      context '50 items, 10 per page, page 1, 1 page to show' do
+        it 'returns pages: [1], last_page: 5' do
+          pages, last_page = described_class.show \
+            item_count: 50,
+            per_page: 10,
+            current_page: 1,
+            pages_to_show_count: 1
+          expect(pages).to eq([1])
+          expect(last_page).to eq(5)
+        end
+      end
+    end
+
+    context 'invalid arguments' do
+      context 'negative item count' do
+        it 'throws an exception' do
+          expect do
+            described_class.show \
+              item_count: -1,
+              per_page: 10,
+              current_page: 1,
+              pages_to_show_count: 5
+          end.to raise_error("Item count can't be negative!")
+        end
+      end
+
+      context 'zero per page' do
+        it 'throws an exception' do
+          expect do
+            described_class.show \
+              item_count: 10,
+              per_page: 0,
+              current_page: 1,
+              pages_to_show_count: 5
+          end.to raise_error('Per page must be positive!')
+        end
+      end
+
+      context 'zero current page' do
+        it 'throws an exception' do
+          expect do
+            described_class.show \
+              item_count: 10,
+              per_page: 10,
+              current_page: 0,
+              pages_to_show_count: 5
+          end.to raise_error('Current page must be positive!')
+        end
+      end
+
+      context 'zero pages to show count' do
+        it 'throws an exception' do
+          expect do
+            described_class.show \
+              item_count: 10,
+              per_page: 10,
+              current_page: 1,
+              pages_to_show_count: 0
+          end.to raise_error('Pages to show count must be positive!')
+        end
+      end
+
+      context 'even pages to show count' do
+        it 'throws an exception' do
+          expect do
+            described_class.show \
+              item_count: 10,
+              per_page: 10,
+              current_page: 1,
+              pages_to_show_count: 2
+          end.to raise_error('Pages to show count must be an odd number!')
+        end
+      end
+
+      context 'current page is greater than the last page' do
+        it 'throws an exception' do
+          expect do
+            described_class.show \
+              item_count: 10,
+              per_page: 10,
+              current_page: 2,
+              pages_to_show_count: 5
+          end.to raise_error("Current page can't be greater than the last page!")
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  Coveralls::SimpleCov::Formatter,
+  SimpleCov::Formatter::HTMLFormatter,
+]
+
+SimpleCov.start
+
+require 'page_clip'

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: page_clip
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mert Guldur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-18 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: simplecov
+  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: coveralls
+  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: rubocop
+  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: Calculates pages to display in a paginator
+email: mertguldur@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/page_clip.rb
+- page_clip.gemspec
+- spec/page_clip_spec.rb
+- spec/spec_helper.rb
+homepage: 
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Pagination calculator
+test_files: []