simple_paginate 0.0.1

data/lib/generators/simple_paginate/templates/simple_paginate_config.rb

@@ -0,0 +1,3 @@
+SimplePaginte.configure do |config|
+  # config.default_per_page = 25
+end

data/lib/generators/simple_paginate/views_generator.rb

@@ -0,0 +1,31 @@
+module SimplePaginate
+  module Generators
+
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../../../app/views/simple_paginate', __FILE__)
+
+      class_option :template_engine, :type => :string, :aliases => '-e', :desc => 'Template engine for the views. Available options are "erb", "haml", and "slim".'
+
+      def self.banner #:nodoc:
+        <<-BANNER.chomp
+rails g simple_paginate:views [options]
+
+    Copies all paginator partial templates to your application.
+BANNER
+      end
+
+      def copy_views
+        filename_pattern = File.join self.class.source_root, "*.html.#{template_engine}"
+        Dir.glob(filename_pattern).map {|f| File.basename f}.each do |f|
+          copy_file f, "app/views/simple_paginate/#{f}"
+        end
+      end
+
+      private
+
+      def template_engine
+        options[:template_engine].try(:to_s).try(:downcase) || 'erb'
+      end
+    end
+  end
+end

data/lib/simple_paginate/config.rb

@@ -0,0 +1,21 @@
+require 'active_support/configurable'
+
+module SimplePaginate
+  def self.configure(&block)
+    yield @config ||= SimplePaginate::Configuration.new
+  end
+
+  def self.config
+    @config
+  end
+
+  class Configuration
+    include ActiveSupport::Configurable
+
+    config_accessor :default_per_page
+  end
+
+  configure do |config|
+    config.default_per_page = 25
+  end
+end

data/lib/simple_paginate/engine.rb

@@ -0,0 +1,4 @@
+module SimplePaginate
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/simple_paginate/helpers/action_view_extension.rb

@@ -0,0 +1,19 @@
+module SimplePaginate
+  module ActionViewExtension
+    # A helper that renders the pagination links
+    def simple_paginate(scope, options = {})
+      paginator = SimplePaginate::Helpers::Paginator.new self, options.reverse_merge(current_page: scope.current_page, per_page: scope.limit_value, length: scope.length)
+      paginator.to_s
+    end
+
+    def link_to_previous_page(scope, name = nil, options = {})
+      prev_page = SimplePaginate::Helpers::PrevPage.new self, options.reverse_merge(:current_page => scope.current_page)
+      link_to_unless scope.first_page?, name, prev_page.url, options.except(:params, :param_name).reverse_merge(:rel => 'prev')
+    end
+
+    def link_to_next_page(scope, name = nil, options = {})
+      next_page = SimplePaginate::Helpers::NextPage.new self, options.reverse_merge(:current_page => scope.current_page)
+      link_to_unless scope.last_page?, name, next_page.url, options.except(:params, :param_name).reverse_merge(:rel => 'next')
+    end
+  end
+end

data/lib/simple_paginate/helpers/paginator.rb

@@ -0,0 +1,70 @@
+require 'action_view'
+require 'simple_paginate/helpers/tags'
+
+module SimplePaginate
+  module Helpers
+    class Paginator < Tag
+      include ActionView::Context
+
+      def initialize(template, options)
+        super template, options.merge(current_page: PageProxy.new(options))
+        @output_buffer = ActionView::OutputBuffer.new
+      end
+
+      def render(&block)
+        instance_eval(&block)
+        @output_buffer
+      end
+
+      def prev_page_tag
+        PrevPage.new @template, @options
+      end
+
+      def next_page_tag
+        NextPage.new @template, @options
+      end
+
+      def to_s
+        super @options.merge(paginator: self)
+      end
+
+      class PageProxy
+        def initialize(options)
+          @options = options
+        end
+
+        def number
+          @options[:current_page]
+        end
+
+        def first?
+          @options[:current_page] == 1
+        end
+
+        def last?
+          @options[:length] < @options[:per_page]
+        end
+
+        def to_i
+          number
+        end
+
+        def to_s
+          number.to_s
+        end
+
+        def +(other)
+          to_i + other.to_i
+        end
+
+        def -(other)
+          to_i - other.to_i
+        end
+
+        def <=>(other)
+          to_i <=> other.to_i
+        end
+      end
+    end
+  end
+end

data/lib/simple_paginate/helpers/tags.rb

@@ -0,0 +1,84 @@
+module SimplePaginate
+  module Helpers
+    PARAM_KEY_BLACKLIST = :authenticity_token, :commit, :utf8, :_method
+    PARAM_NAME = 'page'
+
+    class Tag
+      def initialize(template, options = {})
+        @template, @options = template, options
+        @views_prefix = @options.delete(:views_prefix)
+        @params = template.params.except(*PARAM_KEY_BLACKLIST).merge(@options.delete(:params) || {})
+      end
+
+      def to_s(locals = {})
+        @template.render partial: partial_path, locals: @options.merge(locals), formats: [:html]
+      end
+
+      def page_url_for(page) 
+        @template.url_for params_for(page).merge(only_path: true)
+      end
+
+      private
+
+      def params_for(page)
+        page_params = Rack::Utils.parse_nested_query("#{PARAM_NAME}=#{page}")
+        page_params = @params.with_indifferent_access.deep_merge(page_params)
+
+        if page <= 1
+          PARAM_NAME.to_s.scan(/\w+/)[0..-2].inject(page_params){|h, k| h[k] }[$&] = nil
+        end
+
+        page_params
+      end
+
+      def partial_path
+        [@views_prefix,
+         'simple_paginate',
+          self.class.name.demodulize.underscore
+        ].compact.join('/')
+      end
+    end
+
+    module Link
+      def page
+        raise 'Override page with the actual page value to be a Page.'
+      end
+
+      def url
+        page_url_for(page)
+      end
+
+      def to_s(locals = {})
+        super locals.merge(url: url)
+      end
+    end
+
+    class Page < Tag
+      include Link
+      
+      def page
+        @options[:page]
+      end
+
+      def to_s(locals = {})
+        super locals.merge(page: page)
+      end
+    end
+
+    class PrevPage < Tag
+      include Link
+
+      def page
+        @options[:current_page] - 1
+      end
+    end
+
+    class NextPage < Tag
+      include Link
+
+      def page
+        @options[:current_page] + 1
+      end
+    end
+  end
+end

data/lib/simple_paginate/models/active_record_extension.rb

@@ -0,0 +1,27 @@
+module SimplePaginate
+  module ActiveRecordExtension
+    extend ActiveSupport::Concern
+
+    included do
+      def self.paginate(options = {})
+        options = options.dup
+        page = options.delete(:page) || 1
+        per_page = options.delete(:per_page) || SimplePaginate.config.default_per_page 
+
+        offset(per_page * (page - 1)).limit(per_page + 1).extending do
+          def current_page
+            (offset_value / (limit_value - 1)) + 1
+          end
+
+          def first_page?
+            current_page == 1
+          end
+
+          def last_page?
+            length < limit_value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/simple_paginate/railtie.rb

@@ -0,0 +1,16 @@
+module SimplePaginate
+  class Railtie < Rails::Railtie
+    initializer 'simple_paginate' do |app|
+      ActiveSupport.on_load :active_record do
+        require 'simple_paginate/models/active_record_extension'
+        ::ActiveRecord::Base.send :include, SimplePaginate::ActiveRecordExtension
+      end
+
+      ActiveSupport.on_load :action_view do
+        require 'simple_paginate/helpers/action_view_extension'
+        require 'simple_paginate/helpers/paginator'
+        ::ActionView::Base.send :include, SimplePaginate::ActionViewExtension
+      end
+    end
+  end
+end

data/lib/simple_paginate/version.rb

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

data/lib/simple_paginate.rb

@@ -0,0 +1,9 @@
+module SimplePaginate
+end
+
+if defined?(Rails::Railtie)
+  require 'simple_paginate/railtie'
+  require 'simple_paginate/engine'
+end
+
+require 'simple_paginate/config'

data/simple_paginate.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_paginate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_paginate"
+  spec.version       = SimplePaginate::VERSION
+  spec.authors       = ["Yong Gu"]
+  spec.email         = ["zerogy921@gmail.com"]
+  spec.summary       = %q{Simple pagination solution for previous and next page navigation.}
+  spec.description   = %q{Simple pagination solution for previous and next page navigation.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency 'activesupport', ['>= 3.0.0']
+  spec.add_dependency 'actionpack', ['>= 3.0.0']
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency 'database_cleaner', ['~> 1.4.0']
+end

data/spec/fake_app/active_record/config.rb

@@ -0,0 +1,3 @@
+# database
+ActiveRecord::Base.configurations = {'test' => {:adapter => 'sqlite3', :database => ':memory:'}}
+ActiveRecord::Base.establish_connection :test

data/spec/fake_app/active_record/models.rb

@@ -0,0 +1,12 @@
+# models
+class User < ActiveRecord::Base
+end
+
+#migrations
+class CreateAllTables < ActiveRecord::Migration
+  def self.up
+    create_table(:users) {|t| t.string :name; t.integer :age}
+  end
+end
+ActiveRecord::Migration.verbose = false
+CreateAllTables.up

data/spec/fake_app/rails_app.rb

@@ -0,0 +1,38 @@
+require 'action_controller/railtie'
+require 'action_view/railtie'
+
+require 'fake_app/active_record/config' 
+# config
+app = Class.new(Rails::Application)
+app.config.secret_key_base = '9489b3eee4eccf317ed77407553e8adc97baca7c74dc7ee33cd93e4c8b69477eea66eaedeb18af0be2679887c7c69c0a28c0fded0a71ea472a8c4laalal19cb'
+app.config.secret_token = '3b7cd727ee24e8444053437c36cc66c4'
+app.config.session_store :cookie_store, :key => '_myapp_session'
+app.config.active_support.deprecation = :log
+app.config.eager_load = false
+# Rais.root
+app.config.root = File.dirname(__FILE__)
+Rails.backtrace_cleaner.remove_silencers!
+app.initialize!
+
+# routes
+app.routes.draw do
+  resources :users
+end
+
+#models
+require 'fake_app/active_record/models'
+
+# controllers
+class ApplicationController < ActionController::Base; end
+class UsersController < ApplicationController
+  def index
+    @users = User.paginate page: params[:page]
+    render :inline => <<-ERB
+<%= @users.map(&:name).join("\n") %>
+<%= simple_paginate @users %>
+ERB
+  end
+end
+
+# helpers
+Object.const_set(:ApplicationHelper, Module.new)

data/spec/simple_paginate/config_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe SimplePaginate::Configuration do
+  subject { SimplePaginate.config }
+
+  describe 'default_per_page' do
+    context 'by default' do
+      it { expect(subject.default_per_page).to eq 25 }
+    end
+
+    context 'configured via config block' do
+      before do
+        SimplePaginate.configure do |config|
+          config.default_per_page = 20
+        end
+      end
+
+      it { expect(subject.default_per_page).to eq 25 }
+
+      before do
+        SimplePaginate.configure do |config|
+          config.default_per_page = 25
+        end
+      end
+    end
+  end
+end

data/spec/simple_paginate/helpers/action_view_extension_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe 'SimplePaginate::ActionViewExtension', type: :helper do
+  before :all do
+    1.upto(100) {|i| User.create name: "user#{'%03d' % i}"}
+  end
+
+  after :all do
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  describe '#link_to_previous_page' do
+    subject { helper.link_to_previous_page users, 'Previous Page', params: { controller: 'users', action: 'index' } }
+
+    context 'having previous pages' do
+      let(:users) { User.paginate(page: 3) }
+
+      it { expect(subject).to eq('<a rel="prev" href="/users?page=2">Previous Page</a>') }
+    end
+
+    context 'the first page' do
+      let(:users) { User.paginate(page: 1) }
+
+      it { expect(subject).to eq('Previous Page') }
+    end
+  end
+
+  describe '#link_to_next_page' do
+    subject { helper.link_to_next_page users, 'Next Page', params: { controller: 'users', action: 'index' } }
+
+    context 'having next pages' do
+      let(:users) { User.paginate(page: 3) }
+
+      it { expect(subject).to eq('<a rel="next" href="/users?page=4">Next Page</a>') }
+    end
+
+    context 'the last page' do
+      let(:users) { User.paginate(page: 4) }
+
+      it { expect(subject).to eq('Next Page') }
+    end
+  end
+end

data/spec/simple_paginate/helpers/tags_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+include SimplePaginate::Helpers
+
+describe 'SimplePaginate::Helpers', type: :helper do
+  describe 'Tag' do
+    describe '#page_url_for' do
+      before { helper.request.assign_parameters(_routes, 'users', 'index') }
+
+      context 'for first page' do
+        subject { Tag.new(helper).page_url_for(1) }
+        it { expect(subject).to eq('/users') }
+      end
+
+      context 'with a friendly route setting' do
+        before do
+          helper.request.assign_parameters(_routes, 'users', 'index', page: 3)
+        end
+
+        context 'for first page' do
+          subject { Tag.new(helper).page_url_for(1) }
+          it { expect(subject).to eq('/users') }
+        end
+
+        context 'for other page' do
+          subject { Tag.new(helper).page_url_for(5) }
+          it { expect(subject).to eq('/users?page=5') }
+        end
+      end
+    end
+  end
+
+  describe 'Paginator' do
+    describe 'Paginator::PageProxy' do
+      describe '#first?' do
+        context 'page == 1' do
+          subject { Paginator::PageProxy.new(current_page: 1, length: 20, per_page: 25) }
+          it { expect(subject.first?).to be_truthy }
+        end
+        context 'page != 1' do
+          subject { Paginator::PageProxy.new(current_page: 5, length: 20, per_page: 25) }
+          it { expect(subject.first?).to be_falsey }
+        end
+      end
+
+      describe '#last?' do
+        context 'length == per_page' do
+          subject { Paginator::PageProxy.new(current_page: 5, length: 25, per_page: 25) }
+          it { expect(subject.last?).to be_falsey}
+        end
+        context 'length < per_page' do
+          subject { Paginator::PageProxy.new(current_page: 5, length: 20, per_page: 25) }
+          it { expect(subject.last?).to be_truthy }
+        end
+      end
+    end
+  end
+end

data/spec/simple_paginate/models/active_record_extension_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe SimplePaginate::ActiveRecordExtension do
+  before :all do
+    1.upto(100) {|i| User.create name: "user#{'%03d' % i}"}
+  end
+
+  after :all do
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  describe '#paginate' do
+    subject { User.paginate(page: page) }
+
+    context 'page 1' do
+      let(:page) { 1 }
+
+      it { expect(subject.first.name).to eq('user001') }
+    end
+
+    context 'page 2' do
+      let(:page) { 2 }
+
+      it { expect(subject.first.name).to eq('user026') }
+    end
+
+    context 'page < 1' do
+      let(:page) { 0 }
+
+      it { expect(subject.first.name).to eq('user001') }
+    end
+
+    context 'page > max page' do
+      let(:page) { 5 }
+
+      it { expect(subject).to be_empty }
+    end
+  end
+
+  describe '#current_page' do
+    context 'page 1' do
+      subject { User.paginate(page: 1) }
+      it { expect(subject.current_page).to eq 1 }
+    end
+  end
+
+  describe '#first_page?' do
+    context 'on first page' do
+      subject { User.paginate(page: 1) }
+      it { expect(subject.first_page?).to be_truthy }
+    end
+
+    context 'not on first page' do
+      subject { User.paginate(page: 2) }
+      it { expect(subject.first_page?).to be_falsey }
+    end
+  end
+
+  describe '#last_page?' do
+    context 'on last page' do
+      subject { User.paginate(page: 4) }
+
+      it { expect(subject.last_page?).to be_truthy }
+    end
+
+    context 'not on last page' do
+      subject { User.paginate(page: 3) }
+      it { expect(subject.last_page?).to be_falsey }
+    end
+  end
+end

data/spec/simple_paginate/version_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe SimplePaginate::VERSION do
+  it 'returns right value' do
+    expect(SimplePaginate::VERSION).to eq('0.0.1')
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+begin
+  require 'rails'
+rescue LoadError
+end
+
+require 'bundler/setup'
+Bundler.require
+
+require 'database_cleaner'
+require 'fake_app/rails_app'
+require 'rspec/rails'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.infer_spec_type_from_file_location!
+end

data/spec/support/database_cleaner.rb

@@ -0,0 +1,12 @@
+RSpec.configure do |config|
+  config.before :suite do
+    DatabaseCleaner.strategy = :transaction 
+    DatabaseCleaner.clean_with :truncation 
+  end
+
+   config.around(:each) do |example|
+     DatabaseCleaner.cleaning do
+       example.run
+     end
+   end
+end