simple_paginator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 073894baaf8b6c2915339f2e24f96fe118273e81
+  data.tar.gz: 14e02f2da4dfe5c482e70331fdc08a72a36da897
+SHA512:
+  metadata.gz: f9e13c3017ff127603f92c982797d6f2f99751ced7d1f315db838e881398a594e30fae07e874585d8cc512426a39c8dd5f3bbe3e85bd62924efa242dbd4d66f6
+  data.tar.gz: 99df5ecd25316480a42dc3ce469875624a3ad74ac985f330e004f6f354b7fe4837b074a9be8046957b6a8d35bbe18cba92453dfcc60ba2471d44ee04c9aa8cc4

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/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Satoshi Ebisawa
+
+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.ja.md

@@ -0,0 +1,55 @@
+# SimplePaginator
+
+API を作るときなどに使えるページネーション用のライブラリです。
+
+## 特徴
+- count 文を発行しません。
+- 最大ページ数が設定できます。
+- 1 ページあたりのレコード数を設定できます。
+
+## インストール方法
+
+Gemfile に以下のように記述してください。
+
+    gem 'simple_paginator'
+
+そして、以下を実行します。
+
+    $ bundle
+
+## 使い方
+
+モデルに以下のように SimplePaginator を include してください。
+
+```
+class Post < ActiveRecord::Base
+  include SimplePaginator
+end
+```
+
+`Post.paged(page)` メソッドでページ分けされたレコードを取得します。
+
+デフォルトでは 1 ページあたり 25 件ずつ、最大 10 ページまで取得できるようになっています。また、次のページにレコードがある場合は規定より 1 件多くレコードが返ります。
+
+```
+Post.paged(1) #=> 最大 26 件のオブジェクトが返ります。
+Post.paged(11) #=> 最大ページ以降は常に 0 件のレコードが返ります。
+```
+
+1 ページあたりのレコード数や最大ページ数を変えたい場合は `set_per_page`, `set_max_page` メソッドを使います。
+
+```
+class Post < ActiveRecord::Base
+  include SimplePaginator
+  set_per_page 10
+  set_max_page 5
+end
+```
+
+## 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/README.md

@@ -0,0 +1,56 @@
+# SimplePaginator
+
+This is a useful pagination library especially building APIs.
+
+## Feature
+- Does not issue `count`.
+- You can set max page.
+- You can set number of records per page.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_paginator'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Include SimplePaginator into your models like below.
+
+```
+class Post < ActiveRecord::Base
+  include SimplePaginator
+end
+```
+
+You can get paginated records using `Post.paged(page)` method.
+
+Default is 25 records / page, maximum page number is 10.
+You will get 26 (per_page + 1) records when you can get next page.
+
+```
+Post.paged(1) #=> returns 26 records at most.
+Post.paged(11) #=> returns 0 records if page is more than max_page.
+```
+
+You can use `set_per_page`, `set_max_page` to change default behavior.
+
+```
+class Post < ActiveRecord::Base
+  include SimplePaginator
+  set_per_page 10
+  set_max_page 5
+end
+```
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/lib/simple_paginator/version.rb

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

data/lib/simple_paginator.rb

@@ -0,0 +1,39 @@
+require "simple_paginator/version"
+require 'active_support/core_ext/class'
+require 'active_support/concern'
+require 'active_record'
+
+module SimplePaginator
+  extend ActiveSupport::Concern
+
+  DEFAULT_PER_PAGE = 25
+  DEFAULT_MAX_PAGE = 10
+
+  included do
+    cattr_accessor :per_page, :max_page
+    self.per_page = DEFAULT_PER_PAGE
+    self.max_page = DEFAULT_MAX_PAGE
+    scope :paged, ->(page) {
+      num = page_number(page)
+      if num > max_page
+        none
+      elsif num == max_page
+        limit(per_page).offset((num-1)*per_page)
+      else
+        limit(per_page+1).offset((num-1)*per_page)
+      end
+    }
+  end
+
+  module ClassMethods
+    def page_number(raw_page)
+      [raw_page.to_i, 1].max
+    end
+    def set_per_page(per_page)
+      self.per_page = per_page
+    end
+    def set_max_page(max_page)
+      self.max_page = max_page
+    end
+  end
+end

data/simple_paginator.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_paginator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_paginator"
+  spec.version       = SimplePaginator::VERSION
+  spec.authors       = ["Satoshi Ebisawa"]
+  spec.email         = ["e.satoshi@gmail.com"]
+  spec.description   = %q{Useful paginator library for building APIs.}
+  spec.summary       = %q{Useful paginator library for building APIs.}
+  spec.homepage      = "https://github.com/satococoa/simple_paginator"
+  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"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'activerecord'
+end

data/spec/simple_paginator_spec.rb

@@ -0,0 +1,132 @@
+require_relative 'spec_helper'
+
+describe SimplePaginator do
+  context 'Post includes SimplePaginator' do
+
+    before do
+      class Post < ActiveRecord::Base
+        include SimplePaginator
+      end
+      ActiveRecord::Schema.define do
+        self.verbose = false
+        create_table :posts, :force => true do |t|
+          t.string :text
+        end
+      end
+    end
+
+    describe 'class methods' do
+      specify { expect(Post).to be_respond_to(:paged) }
+      specify { expect(Post).to be_respond_to(:set_per_page) }
+      specify { expect(Post).to be_respond_to(:set_max_page) }
+    end
+
+    describe '.page_number' do
+      subject(:page_number) { Post.page_number(raw_page) }
+      context 'raw_page is string' do
+        let(:raw_page) { 'foo' }
+        specify { expect(subject).to eq(1) }
+      end
+      context 'raw_page is blank string' do
+        let(:raw_page) { '' }
+        specify { expect(subject).to eq(1) }
+      end
+      context 'raw_page is 0' do
+        let(:raw_page) { 0 }
+        specify { expect(subject).to eq(1) }
+      end
+      context 'raw_page is negative' do
+        let(:raw_page) { -1 }
+        specify { expect(subject).to eq(1) }
+      end
+      context 'raw_page is a string to represent number' do
+        let(:raw_page) { '10' }
+        specify { expect(subject).to eq(10) }
+      end
+      context 'raw_page is a string to represent negative number' do
+        let(:raw_page) { '-1' }
+        specify { expect(subject).to eq(1) }
+      end
+      context 'raw_page is nil' do
+        let(:raw_page) { nil }
+        specify { expect(subject).to eq(1) }
+      end
+    end
+
+    describe '.paged' do
+      context 'per_page, max_page are default' do
+        context 'page = 1' do
+          let(:page) { 1 }
+          it 'send :limit, :offset method' do
+            Post.should_receive(:limit).with(26).once { Post }
+            Post.should_receive(:offset).with(0).once
+            Post.paged(page)
+          end
+        end
+        context 'page = 2' do
+          let(:page) { 2 }
+          it 'send :limit, :offset method' do
+            Post.should_receive(:limit).with(26).once { Post }
+            Post.should_receive(:offset).with(25).once
+            Post.paged(page)
+          end
+        end
+        context 'page = 10' do
+          let(:page) { 10 }
+          it 'send :limit, :offset method' do
+            Post.should_receive(:limit).with(25).once { Post }
+            Post.should_receive(:offset).with(25 * (page-1)).once
+            Post.paged(page)
+          end
+        end
+        context 'page = 11' do
+          let(:page) { 11 }
+          it 'send :none method' do
+            Post.should_receive(:none).once
+            Post.paged(page)
+          end
+        end
+      end
+
+      context 'change per_page, max_page' do
+        before do
+          Post.class_eval {
+            set_per_page 3
+            set_max_page 2
+          }
+        end
+
+        after do
+          Post.class_eval {
+            set_per_page SimplePaginator::DEFAULT_PER_PAGE
+            set_max_page SimplePaginator::DEFAULT_MAX_PAGE
+          }
+        end
+
+        context 'page = 1' do
+          let(:page) { 1 }
+          it 'send :limit, :offset method' do
+            Post.should_receive(:limit).with(4).once { Post }
+            Post.should_receive(:offset).with(0).once
+            Post.paged(page)
+          end
+        end
+        context 'page = 2' do
+          let(:page) { 2 }
+          it 'send :limit, :offset method' do
+            Post.should_receive(:limit).with(3).once { Post }
+            Post.should_receive(:offset).with(3).once
+            Post.paged(page)
+          end
+        end
+        context 'page = 3' do
+          let(:page) { 3 }
+          it 'send :limit, :offset method' do
+            Post.should_receive(:none).once
+            Post.paged(page)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'bundler/setup'
+Bundler.require
+
+require 'simple_paginator'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.before do
+    ActiveRecord::Base.establish_connection(
+        :adapter => 'sqlite3',
+        :database => ':memory:'
+    )
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: simple_paginator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Satoshi Ebisawa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-06 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'
+- !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: 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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Useful paginator library for building APIs.
+email:
+- e.satoshi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.ja.md
+- README.md
+- Rakefile
+- lib/simple_paginator.rb
+- lib/simple_paginator/version.rb
+- simple_paginator.gemspec
+- spec/simple_paginator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/satococoa/simple_paginator
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Useful paginator library for building APIs.
+test_files:
+- spec/simple_paginator_spec.rb
+- spec/spec_helper.rb
+has_rdoc: