kaminari-core 1.0.0.beta2

data/lib/kaminari/models/array_extension.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+require 'active_support/core_ext/module'
+module Kaminari
+  # Kind of Array that can paginate
+  class PaginatableArray < Array
+    include Kaminari::ConfigurationMethods::ClassMethods
+
+    ENTRY = 'entry'.freeze
+
+    attr_internal_accessor :limit_value, :offset_value
+
+    # ==== Options
+    # * <tt>:limit</tt> - limit
+    # * <tt>:offset</tt> - offset
+    # * <tt>:total_count</tt> - total_count
+    # * <tt>:padding</tt> - padding
+    def initialize(original_array = [], limit: nil, offset: nil, total_count: nil, padding: nil)
+      @_original_array, @_limit_value, @_offset_value, @_total_count, @_padding = original_array, (limit || default_per_page).to_i, offset.to_i, total_count, padding.to_i
+
+      if limit && offset
+        extend Kaminari::PageScopeMethods
+      end
+
+      if @_total_count && (@_total_count <= original_array.count)
+        original_array = original_array.first(@_total_count)[@_offset_value, @_limit_value]
+      end
+
+      unless @_total_count
+        original_array = original_array[@_offset_value, @_limit_value]
+      end
+
+      super(original_array || [])
+    end
+
+    # Used for page_entry_info
+    def entry_name(options = {})
+      I18n.t('helpers.page_entries_info.entry', options.reverse_merge(default: ENTRY.pluralize(options[:count])))
+    end
+
+    # items at the specified "page"
+    class_eval <<-RUBY, __FILE__, __LINE__ + 1
+      def #{Kaminari.config.page_method_name}(num = 1)
+        offset(limit_value * ((num = num.to_i - 1) < 0 ? 0 : num))
+      end
+    RUBY
+
+    # returns another chunk of the original array
+    def limit(num)
+      self.class.new @_original_array, limit: num, offset: @_offset_value, total_count: @_total_count, padding: @_padding
+    end
+
+    # total item numbers of the original array
+    def total_count
+      @_total_count || @_original_array.length
+    end
+
+    # returns another chunk of the original array
+    def offset(num)
+      self.class.new @_original_array, limit: @_limit_value, offset: num, total_count: @_total_count, padding: @_padding
+    end
+  end
+
+  # Wrap an Array object to make it paginatable
+  # ==== Options
+  # * <tt>:limit</tt> - limit
+  # * <tt>:offset</tt> - offset
+  # * <tt>:total_count</tt> - total_count
+  # * <tt>:padding</tt> - padding
+  def self.paginate_array(array, limit: nil, offset: nil, total_count: nil, padding: nil)
+    PaginatableArray.new array, limit: limit, offset: offset, total_count: total_count, padding: padding
+  end
+end

data/lib/kaminari/models/configuration_methods.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+module Kaminari
+  module ConfigurationMethods #:nodoc:
+    extend ActiveSupport::Concern
+    module ClassMethods #:nodoc:
+      # Overrides the default +per_page+ value per model
+      #   class Article < ActiveRecord::Base
+      #     paginates_per 10
+      #   end
+      def paginates_per(val)
+        @_default_per_page = val
+      end
+
+      # This model's default +per_page+ value
+      # returns +default_per_page+ value unless explicitly overridden via <tt>paginates_per</tt>
+      def default_per_page
+        (defined?(@_default_per_page) && @_default_per_page) || Kaminari.config.default_per_page
+      end
+
+      # Overrides the max +per_page+ value per model
+      #   class Article < ActiveRecord::Base
+      #     max_paginates_per 100
+      #   end
+      def max_paginates_per(val)
+        @_max_per_page = val
+      end
+
+      # This model's max +per_page+ value
+      # returns +max_per_page+ value unless explicitly overridden via <tt>max_paginates_per</tt>
+      def max_per_page
+        (defined?(@_max_per_page) && @_max_per_page) || Kaminari.config.max_per_page
+      end
+
+      # Overrides the max_pages value per model when a value is given
+      #   class Article < ActiveRecord::Base
+      #     max_pages 100
+      #   end
+      #
+      # Also returns this model's max_pages value (globally configured
+      # +max_pages+ value unless explicitly overridden) when no value is given
+      def max_pages(val = :none)
+        if val == :none
+          # getter
+          (defined?(@_max_pages) && @_max_pages) || Kaminari.config.max_pages
+        else
+          # setter
+          @_max_pages = val
+        end
+      end
+
+      def max_pages_per(val)
+        ActiveSupport::Deprecation.warn 'max_pages_per is deprecated. Use max_pages instead.', caller_locations(2)
+        max_pages val
+      end
+    end
+  end
+end

data/lib/kaminari/models/page_scope_methods.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+module Kaminari
+  module PageScopeMethods
+    # Specify the <tt>per_page</tt> value for the preceding <tt>page</tt> scope
+    #   Model.page(3).per(10)
+    def per(num, max_per_page: nil)
+      max_per_page ||= ((defined?(@_max_per_page) && @_max_per_page) || self.max_per_page)
+      @_per = num
+      if num.nil? && max_per_page
+        limit(max_per_page).offset(offset_value / limit_value * max_per_page)
+      elsif (n = num.to_i) < 0 || !(/^\d/ =~ num.to_s)
+        self
+      elsif n.zero?
+        limit(n)
+      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 max_paginates_per(new_max_per_page)
+      @_max_per_page = new_max_per_page
+      per ((defined?(@_per) && @_per) || default_per_page), max_per_page: new_max_per_page
+    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
+      max_pages && (max_pages < total_pages_count) ? max_pages : total_pages_count
+    rescue FloatDomainError
+      raise ZeroPerPageOperation, "The number of total pages was incalculable. Perhaps you called .per(0)?"
+    end
+
+    # 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
+    rescue ZeroDivisionError
+      raise ZeroPerPageOperation, "Current page was incalculable. Perhaps you called .per(0)?"
+    end
+
+    # Next page number in the collection
+    def next_page
+      current_page + 1 unless last_page? || out_of_range?
+    end
+
+    # Previous page number in the collection
+    def prev_page
+      current_page - 1 unless first_page? || out_of_range?
+    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/kaminari/railtie.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module Kaminari
+  class Railtie < ::Rails::Railtie #:nodoc:
+    # Doesn't actually do anything. Just keeping this hook point, mainly for compatibility
+    initializer 'kaminari' do
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: kaminari-core
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta2
+platform: ruby
+authors:
+- Akira Matsuda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+description: kaminari-core includes pagination logic independent from ORMs and view
+  libraries
+email:
+- ronnie@dio.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- app/views/kaminari/_first_page.html.erb
+- app/views/kaminari/_first_page.html.haml
+- app/views/kaminari/_first_page.html.slim
+- app/views/kaminari/_gap.html.erb
+- app/views/kaminari/_gap.html.haml
+- app/views/kaminari/_gap.html.slim
+- app/views/kaminari/_last_page.html.erb
+- app/views/kaminari/_last_page.html.haml
+- app/views/kaminari/_last_page.html.slim
+- app/views/kaminari/_next_page.html.erb
+- app/views/kaminari/_next_page.html.haml
+- app/views/kaminari/_next_page.html.slim
+- app/views/kaminari/_page.html.erb
+- app/views/kaminari/_page.html.haml
+- app/views/kaminari/_page.html.slim
+- app/views/kaminari/_paginator.html.erb
+- app/views/kaminari/_paginator.html.haml
+- app/views/kaminari/_paginator.html.slim
+- app/views/kaminari/_prev_page.html.erb
+- app/views/kaminari/_prev_page.html.haml
+- app/views/kaminari/_prev_page.html.slim
+- config/locales/kaminari.yml
+- kaminari-core.gemspec
+- lib/generators/kaminari/config_generator.rb
+- lib/generators/kaminari/templates/kaminari_config.rb
+- lib/generators/kaminari/views_generator.rb
+- lib/kaminari/config.rb
+- lib/kaminari/core.rb
+- lib/kaminari/core/version.rb
+- lib/kaminari/engine.rb
+- lib/kaminari/exceptions.rb
+- lib/kaminari/helpers/helper_methods.rb
+- lib/kaminari/helpers/paginator.rb
+- lib/kaminari/helpers/tags.rb
+- lib/kaminari/models/array_extension.rb
+- lib/kaminari/models/configuration_methods.rb
+- lib/kaminari/models/page_scope_methods.rb
+- lib/kaminari/railtie.rb
+homepage: https://github.com/amatsuda/kaminari
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Kaminari's core pagination library
+test_files: []