bootstrap_pager 0.9.0

data/lib/bootstrap_pager/models/data_mapper_extension.rb

@@ -0,0 +1,48 @@
+require 'bootstrap_pager/models/data_mapper_collection_methods'
+
+module BootstrapPager
+  module DataMapperExtension
+    module Paginatable
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{BootstrapPager.config.page_method_name}(num = 1)
+          num = [num.to_i, 1].max - 1
+          all(:limit => default_per_page, :offset => default_per_page * num).extend Paginating
+        end
+      RUBY
+    end
+
+    module Paginating
+      include BootstrapPager::PageScopeMethods
+
+      def all(options={})
+        super.extend Paginating
+      end
+
+      def per(num)
+        super.extend Paginating
+      end
+    end
+
+    module Collection
+      extend ActiveSupport::Concern
+      included do
+        include BootstrapPager::ConfigurationMethods::ClassMethods
+        include BootstrapPager::DataMapperCollectionMethods
+        include Paginatable
+      end
+    end
+
+    module Model
+      include BootstrapPager::ConfigurationMethods::ClassMethods
+      include Paginatable
+
+      def limit(val)
+        all(:limit => val)
+      end
+
+      def offset(val)
+        all(:offset => val)
+      end
+    end
+  end
+end

data/lib/bootstrap_pager/models/mongo_mapper_extension.rb

@@ -0,0 +1,18 @@
+require 'bootstrap_pager/models/plucky_criteria_methods'
+
+module BootstrapPager
+  module MongoMapperExtension
+    module Document
+      extend ActiveSupport::Concern
+      include BootstrapPager::ConfigurationMethods
+
+      included do
+        # Fetch the values at the specified page number
+        #   Model.page(5)
+        scope BootstrapPager.config.page_method_name, Proc.new {|num|
+          limit(default_per_page).offset(default_per_page * ([num.to_i, 1].max - 1))
+        }
+      end
+    end
+  end
+end

data/lib/bootstrap_pager/models/mongoid_criteria_methods.rb

@@ -0,0 +1,23 @@
+module BootstrapPager
+  module MongoidCriteriaMethods
+    def limit_value #:nodoc:
+      options[:limit]
+    end
+
+    def offset_value #:nodoc:
+      options[:skip]
+    end
+
+    def total_count #:nodoc:
+      embedded? ? unpage.count : count
+    end
+
+    private
+    def unpage
+      clone.tap do |crit|
+        crit.options.delete :limit
+        crit.options.delete :skip
+      end
+    end
+  end
+end

data/lib/bootstrap_pager/models/mongoid_extension.rb

@@ -0,0 +1,33 @@
+require 'bootstrap_pager/models/mongoid_criteria_methods'
+
+module BootstrapPager
+  module MongoidExtension
+    module Criteria
+      extend ActiveSupport::Concern
+
+      included do
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{BootstrapPager.config.page_method_name}(*args)
+            super(*args).criteria.merge(self)
+          end
+        RUBY
+      end
+    end
+
+    module Document
+      extend ActiveSupport::Concern
+      include BootstrapPager::ConfigurationMethods
+
+      included do
+        # Fetch the values at the specified page number
+        #   Model.page(5)
+        scope BootstrapPager.config.page_method_name, Proc.new {|num|
+          limit(default_per_page).offset(default_per_page * ([num.to_i, 1].max - 1))
+        } do
+          include BootstrapPager::MongoidCriteriaMethods
+          include BootstrapPager::PageScopeMethods
+        end
+      end
+    end
+  end
+end

data/lib/bootstrap_pager/models/page_scope_methods.rb

@@ -0,0 +1,70 @@
+module BootstrapPager
+  module PageScopeMethods
+    # Specify the <tt>per_page</tt> value for the preceding <tt>page</tt> scope
+    #   Model.page(3).per(10)
+    def per(num)
+      if (n = num.to_i) <= 0
+        self
+      elsif max_per_page && max_per_page < n
+        limit(max_per_page).offset(offset_value / limit_value * max_per_page)
+      else
+        limit(n).offset(offset_value / limit_value * n)
+      end
+    end
+
+    def padding(num)
+      @_padding = num
+      offset(offset_value + num.to_i)
+    end
+
+    # Total number of pages
+    def total_pages
+      count_without_padding = total_count
+      count_without_padding -= @_padding if defined?(@_padding) && @_padding
+      count_without_padding = 0 if count_without_padding < 0
+
+      total_pages_count = (count_without_padding.to_f / limit_value).ceil
+      if max_pages.present? && max_pages < total_pages_count
+        max_pages
+      else
+        total_pages_count
+      end
+    end
+    #FIXME for compatibility. remove num_pages at some time in the future
+    alias num_pages total_pages
+
+    # Current page number
+    def current_page
+      offset_without_padding = offset_value
+      offset_without_padding -= @_padding if defined?(@_padding) && @_padding
+      offset_without_padding = 0 if offset_without_padding < 0
+
+      (offset_without_padding / limit_value) + 1
+    end
+
+    # Next page number in the collection
+    def next_page
+      current_page + 1 unless last_page?
+    end
+
+    # Previous page number in the collection
+    def prev_page
+      current_page - 1 unless first_page?
+    end
+
+    # First page of the collection?
+    def first_page?
+      current_page == 1
+    end
+
+    # Last page of the collection?
+    def last_page?
+      current_page >= total_pages
+    end
+
+    # Out of range of the collection?
+    def out_of_range?
+      current_page > total_pages
+    end
+  end
+end

data/lib/bootstrap_pager/models/plucky_criteria_methods.rb

@@ -0,0 +1,18 @@
+module BootstrapPager
+  module PluckyCriteriaMethods
+    include BootstrapPager::PageScopeMethods
+    include BootstrapPager::ConfigurationMethods::ClassMethods
+
+    def limit_value #:nodoc:
+      options[:limit]
+    end
+
+    def offset_value #:nodoc:
+      options[:skip]
+    end
+
+    def total_count #:nodoc:
+      count
+    end
+  end
+end

data/lib/bootstrap_pager/railtie.rb

@@ -0,0 +1,7 @@
+module BootstrapPager
+  class Railtie < ::Rails::Railtie #:nodoc:
+    initializer 'bootstrap_pager' do |_app|
+      BootstrapPager::Hooks.init
+    end
+  end
+end

data/lib/bootstrap_pager/sinatra.rb

@@ -0,0 +1,5 @@
+require 'sinatra/base'
+require 'bootstrap_pager'
+require 'bootstrap_pager/helpers/sinatra_helpers'
+
+BootstrapPager::Hooks.init

data/lib/bootstrap_pager/version.rb

@@ -0,0 +1,3 @@
+module BootstrapPager
+  VERSION = '0.9.0'
+end

data/lib/bootstrap_pager.rb

@@ -0,0 +1,38 @@
+module BootstrapPager
+end
+
+# load Rails/Railtie
+begin
+  require 'rails'
+rescue LoadError
+  #do nothing
+end
+
+$stderr.puts <<-EOC if !defined?(Rails) && !defined?(Sinatra) && !defined?(Grape)
+warning: no framework detected.
+
+Your Gemfile might not be configured properly.
+---- e.g. ----
+Rails:
+    gem 'bootstrap_pager'
+
+Sinatra/Padrino:
+    gem 'bootstrap_pager', :require => 'bootstrap_pager/sinatra'
+
+Grape:
+    gem 'bootstrap_pager', :require => 'bootstrap_pager/grape'
+
+EOC
+
+# load BootstrapPager components
+require 'bootstrap_pager/config'
+require 'bootstrap_pager/helpers/paginator'
+require 'bootstrap_pager/models/page_scope_methods'
+require 'bootstrap_pager/models/configuration_methods'
+require 'bootstrap_pager/hooks'
+
+# if not using Railtie, call `BootstrapPager::Hooks.init` directly
+if defined? Rails
+  require 'bootstrap_pager/railtie'
+  require 'bootstrap_pager/engine'
+end

data/lib/generators/pager/config_generator.rb

@@ -0,0 +1,16 @@
+module BootstrapPager
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      desc <<DESC
+Description:
+    Copies BootstrapPager configuration file to your application's initializer directory.
+DESC
+
+      def copy_config_file
+        template 'bootstrap_pager_config.rb', 'config/initializers/bootstrap_pager_config.rb'
+      end
+    end
+  end
+end

data/lib/generators/pager/templates/pager_config.rb

@@ -0,0 +1,10 @@
+BootstrapPager.configure do |config|
+  # config.default_per_page = 25
+  # config.max_per_page = nil
+  # config.window = 4
+  # config.outer_window = 0
+  # config.left = 0
+  # config.right = 0
+  # config.page_method_name = :page
+  # config.param_name = :page
+end

data/lib/generators/pager/views_generator.rb

@@ -0,0 +1,118 @@
+module BootstrapPager
+  module Generators
+
+    class ViewsGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../../../../app/views/bootstrap_pager', __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 bootstrap_pager:views THEME [options]
+
+    Copies all paginator partial templates to your application.
+    You can choose a template THEME by specifying one from the list below:
+
+        - default
+            The default one.
+            This one is used internally while you don't override the partials.
+#{themes.map {|t| "        - #{t.name}\n#{t.description}"}.join("\n")}
+BANNER
+      end
+
+      desc ''
+      def copy_or_fetch #:nodoc:
+        return copy_default_views if file_name == 'default'
+
+        themes = self.class.themes
+        if theme = themes.detect {|t| t.name == file_name}
+          download_templates theme
+        else
+          say %Q[no such theme: #{file_name}\n  avaliable themes: #{themes.map(&:name).join ", "}]
+        end
+      end
+
+      private
+      def self.themes
+        begin
+          @themes ||= GitHubApiHelper.get_files_in_master.group_by {|fn, _| fn[0...(fn.index('/') || 0)]}.delete_if {|fn, _| fn.blank?}.map do |name, files|
+            Theme.new name, files
+          end
+        rescue SocketError
+          []
+        end
+      end
+
+      def download_templates(theme)
+        theme.templates_for(template_engine).each do |template|
+          say "      downloading #{template.name} from bootstrap_pager_themes..."
+          create_file template.name, GitHubApiHelper.get_content_for("#{theme.name}/#{template.name}")
+        end
+      end
+
+      def copy_default_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/bootstrap_pager/#{f}"
+        end
+      end
+
+      def template_engine
+        options[:template_engine].try(:to_s).try(:downcase) || 'erb'
+      end
+    end
+
+    Template = Struct.new(:name, :sha) do
+      def description?
+        name == 'DESCRIPTION'
+      end
+
+      def view?
+        name =~ /^app\/views\//
+      end
+
+      def engine #:nodoc:
+        File.extname(name).sub /^\./, ''
+      end
+    end
+
+    class Theme
+      attr_accessor :name
+      def initialize(name, templates) #:nodoc:
+        @name, @templates = name, templates.map {|fn, sha| Template.new fn.sub(/^#{name}\//, ''), sha}
+      end
+
+      def description #:nodoc:
+        file = @templates.detect(&:description?)
+        return "#{' ' * 12}#{name}" unless file
+        GitHubApiHelper.get_content_for("#{@name}/#{file.name}").chomp.gsub(/^/, ' ' * 12)
+      end
+
+      def templates_for(template_engine) #:nodoc:
+        @templates.select {|t| !t.description?}.select {|t| !t.view? || (t.engine == template_engine)}
+      end
+    end
+
+    module GitHubApiHelper
+      def get_files_in_master
+        master_tree_sha = open('https://api.github.com/repos/amatsuda/bootstrap_pager_themes/git/refs/heads/master') do |json|
+          ActiveSupport::JSON.decode(json)['object']['sha']
+        end
+        open('https://api.github.com/repos/amatsuda/bootstrap_pager_themes/git/trees/' + master_tree_sha + '?recursive=1') do |json|
+          blobs = ActiveSupport::JSON.decode(json)['tree'].find_all {|i| i['type'] == 'blob' }
+          blobs.map do |blob|
+            [blob['path'], blob['sha']]
+          end
+        end
+      end
+      module_function :get_files_in_master
+
+      def get_content_for(path)
+        open('https://api.github.com/repos/amatsuda/bootstrap_pager_themes/contents/' + path) do |json|
+          Base64.decode64(ActiveSupport::JSON.decode(json)['content'])
+        end
+      end
+      module_function :get_content_for
+    end
+  end
+end

data/spec/config/config_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe BootstrapPager::Configuration do
+  subject { BootstrapPager.config }
+  describe 'default_per_page' do
+    context 'by default' do
+      its(:default_per_page) { should == 25 }
+    end
+    context 'configured via config block' do
+      before do
+        BootstrapPager.configure {|c| c.default_per_page = 17}
+      end
+      its(:default_per_page) { should == 17 }
+      after do
+        BootstrapPager.configure {|c| c.default_per_page = 25}
+      end
+    end
+  end
+
+  describe 'max_per_page' do
+    context 'by default' do
+      its(:max_per_page) { should == nil }
+    end
+    context 'configure via config block' do
+      before do
+        BootstrapPager.configure {|c| c.max_per_page = 100}
+      end
+      its(:max_per_page) { should == 100 }
+      after do
+        BootstrapPager.configure {|c| c.max_per_page = nil}
+      end
+    end
+  end
+
+  describe 'window' do
+    context 'by default' do
+      its(:window) { should == 4 }
+    end
+  end
+
+  describe 'outer_window' do
+    context 'by default' do
+      its(:outer_window) { should == 0 }
+    end
+  end
+
+  describe 'left' do
+    context 'by default' do
+      its(:left) { should == 0 }
+    end
+  end
+
+  describe 'right' do
+    context 'by default' do
+      its(:right) { should == 0 }
+    end
+  end
+
+  describe 'param_name' do
+    context 'by default' do
+      its(:param_name) { should == :page }
+    end
+
+    context 'configured via config block' do
+      before do
+        BootstrapPager.configure {|c| c.param_name = lambda { :test } }
+      end
+
+      its(:param_name) { should == :test }
+
+      after do
+        BootstrapPager.configure {|c| c.param_name = :page }
+      end
+    end
+  end
+
+  describe 'max_pages' do
+    context 'by default' do
+      its(:max_pages) { should == nil }
+    end
+    context 'configure via config block' do
+      before do
+        BootstrapPager.configure {|c| c.max_pages = 5}
+      end
+      its(:max_pages) { should == 5 }
+      after do
+        BootstrapPager.configure {|c| c.max_pages = nil}
+      end
+    end
+  end
+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,57 @@
+# models
+class User < ActiveRecord::Base
+  has_many :authorships
+  has_many :readerships
+  has_many :books_authored, :through => :authorships, :source => :book
+  has_many :books_read, :through => :readerships, :source => :book
+  has_many :addresses, :class_name => 'User::Address'
+
+  def readers
+    User.joins(:books_read => :authors).where(:authors_books => {:id => self})
+  end
+
+  scope :by_name, order(:name)
+  scope :by_read_count, lambda {
+    cols = if connection.adapter_name == "PostgreSQL"
+      column_names.map { |column| %{"users"."#{column}"} }.join(", ")
+    else
+      '"users"."id"'
+    end
+    group(cols).select("count(readerships.id) AS read_count, #{cols}").order('read_count DESC')
+  }
+end
+class Authorship < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :book
+end
+class Readership < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :book
+end
+class Book < ActiveRecord::Base
+  has_many :authorships
+  has_many :readerships
+  has_many :authors, :through => :authorships, :source => :user
+  has_many :readers, :through => :readerships, :source => :user
+end
+# a model that is a descendant of AR::Base but doesn't directly inherit AR::Base
+class Admin < User
+end
+# a model with namespace
+class User::Address < ActiveRecord::Base
+  belongs_to :user
+end
+
+#migrations
+class CreateAllTables < ActiveRecord::Migration
+  def self.up
+    create_table(:gem_defined_models) { |t| t.string :name; t.integer :age }
+    create_table(:users) {|t| t.string :name; t.integer :age}
+    create_table(:books) {|t| t.string :title}
+    create_table(:readerships) {|t| t.integer :user_id; t.integer :book_id }
+    create_table(:authorships) {|t| t.integer :user_id; t.integer :book_id }
+    create_table(:user_addresses) {|t| t.string :street; t.integer :user_id }
+  end
+end
+ActiveRecord::Migration.verbose = false
+CreateAllTables.up

data/spec/fake_app/data_mapper/config.rb

@@ -0,0 +1,7 @@
+DataMapper.setup(:default, 'sqlite::memory:')
+
+class DataMapper::Collection
+  def default_per_page
+    model.default_per_page
+  end
+end

data/spec/fake_app/data_mapper/models.rb

@@ -0,0 +1,27 @@
+class User
+  include ::DataMapper::Resource
+
+  property :id, Serial
+  property :name, String, :required => true
+  property :age, Integer
+
+  has n, :projects, :through => Resource
+end
+
+class User::Address
+  include ::DataMapper::Resource
+
+  property :id, Serial
+end
+
+class Project
+  include ::DataMapper::Resource
+
+  property :id, Serial
+  property :name, String, :required => true
+
+  has n, :users, :through => Resource
+end
+
+DataMapper.finalize
+DataMapper.auto_migrate!