kaminari-logarithmic 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 962826fa842b45f3e37e5b61296f16f8baab560b
+  data.tar.gz: e9a3d9f8e9539b84526056acffa3af1fbc17a449
+SHA512:
+  metadata.gz: ef7496175482093639ed57a59dbba40178117fd01bade464fb331f5d2ec08ecc0d0c2459a6f9795e2569e1bbf6c6effc088d7b3de8ed45adbef415c903f3a050
+  data.tar.gz: fd33a556b2819a0fca4a6c81def08b4a944029dc87648d4ff483ad69c8543f4ebd56a6d4688d29ae8db7bc530b1a4fce1e67d8ab9910b54ff04a165eaceb6da2

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=d

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Anton Lee
+
+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,44 @@
+# Kaminari::Logarithmic
+
+This plugin extends popular [kaminari](https://github.com/amatsuda/kaminari) gem to provide functionality for distributing big number of pages logarithmically. Such approach originally was  discussed [here](http://stackoverflow.com/questions/7835752/how-to-do-page-navigation-for-many-many-pages-logarithmic-page-navigation).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kaminari-logarithmic'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kaminari-logarithmic
+
+## Usage
+
+Do all the pagination stuff in controller and model usually. In your view use special helper instead of `paginate`:
+
+```ruby
+paginate_logarithmic @your_collection
+```
+By default even distribution strategy is used. You can specify strategy with `strategy` option:
+
+```ruby
+paginate_logarithmic @users, strategy: :fixed_steps
+```
+At the moment 2 strategies are available(TODO: describe both):
+
+ 1. `:even`.
+ 2. `:fixed_steps`
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/kaminari-logarithmic/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/kaminari-logarithmic.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kaminari/logarithmic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kaminari-logarithmic"
+  spec.version       = Kaminari::Logarithmic::VERSION
+  spec.authors       = ["Anton Lee"]
+  spec.email         = ["antoshalee@gmail.com"]
+  spec.summary       = %q{Kaminari extension for logarithmic pagination}
+  spec.description   = %q{Kaminari extension for logarithmic pagination}
+  spec.homepage      = "https://github.com/antoshalee/kaminari-logarithmic"
+  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 "kaminari"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/kaminari/logarithmic/action_view_extension.rb

@@ -0,0 +1,10 @@
+module Kaminari
+  module Logarithmic
+    module ActionViewExtension
+      def paginate_logarithmic(scope, options = {}, &block)
+        paginator = Kaminari::Logarithmic::Paginator.new self, options.reverse_merge(:current_page => scope.current_page, :total_pages => scope.total_pages, :per_page => scope.limit_value, :remote => false)
+        paginator.to_s
+      end
+    end
+  end
+end

data/lib/kaminari/logarithmic/page_proxy_extension.rb

@@ -0,0 +1,9 @@
+module Kaminari
+  module Logarithmic
+    module PageProxyExtension
+      def logaritmic_page?
+        @options[:logarithmic_pages].include? @page
+      end
+    end
+  end
+end

data/lib/kaminari/logarithmic/paginator.rb

@@ -0,0 +1,53 @@
+module Kaminari
+  module Logarithmic
+    class Paginator < ::Kaminari::Helpers::Paginator
+      def initialize(template, options)
+        @logarithmic_strategy = options[:strategy]
+        super(template, options)
+
+        precalculate_logarithnmic_pages
+      end
+
+      def each_relevant_page
+        extended_options = @window_options.merge(
+          logarithmic_pages: @left_log_seq + @right_log_seq
+        )
+
+        return to_enum(:each_relevant_page) unless block_given?
+        relevant_pages(@window_options).each do |i|
+          yield PageProxy.new(extended_options, i, @last)
+        end
+      end
+
+      alias each_page each_relevant_page
+
+      def relevant_pages(options)
+        left_window_plus_one = 1.upto(options[:left] + 1).to_a
+        right_window_plus_one = (options[:total_pages] - options[:right]).upto(options[:total_pages]).to_a
+        inside_window_plus_each_sides = (options[:current_page] - options[:window] - 1).upto(options[:current_page] + options[:window] + 1).to_a
+
+        log_pages_with_gaps = \
+          @left_log_seq.map { |p| [p, p - 1] }.flatten +
+          @right_log_seq.map { |p| [p, p + 1] }.flatten
+
+        (
+          left_window_plus_one +
+          inside_window_plus_each_sides +
+          log_pages_with_gaps +
+          right_window_plus_one
+        ).uniq.sort.reject { |x| (x < 1) || (x > options[:total_pages]) }
+      end
+
+      def precalculate_logarithnmic_pages
+        builder_options = { strategy: @logarithmic_strategy }
+        left_start = @window_options[:current_page] - @window_options[:window] - 1
+        left_finish = @window_options[:left] + 1
+        @left_log_seq = SeqBuilder.new(left_start, left_finish, builder_options).build.reverse
+
+        right_start = @window_options[:current_page] + @window_options[:window] + 1
+        right_finish = @window_options[:total_pages] - @window_options[:right]
+        @right_log_seq = SeqBuilder.new(right_start, right_finish, builder_options).build
+      end
+    end
+  end
+end

data/lib/kaminari/logarithmic/seq_builder.rb

@@ -0,0 +1,24 @@
+module Kaminari
+  module Logarithmic
+    class SeqBuilder
+      DEFAULT_STRATEGY = :even
+
+      def initialize(start, finish, options = {})
+        @options = options
+        build_strategy(start, finish)
+      end
+
+      def build
+        @strategy.build
+      end
+
+      private
+
+      def build_strategy(start, finish)
+        code = @options[:strategy] || DEFAULT_STRATEGY
+        klass = "Kaminari::Logarithmic::Strategies::#{code.to_s.camelize}Strategy".constantize
+        @strategy = klass.new(start, finish)
+      end
+    end
+  end
+end

data/lib/kaminari/logarithmic/strategies/base_strategy.rb

@@ -0,0 +1,29 @@
+module Kaminari
+  module Logarithmic
+    module Strategies
+      class BaseStrategy
+        def build
+          fail NotImplementedError
+        end
+
+        private
+
+        def asc?
+          @asc ||= (@global_start <= @global_finish)
+        end
+
+        def desc?
+          !asc?
+        end
+
+        def enough?(value)
+          if asc?
+            value < @global_finish
+          else
+            value > @global_finish
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kaminari/logarithmic/strategies/even_strategy.rb

@@ -0,0 +1,29 @@
+module Kaminari
+  module Logarithmic
+    module Strategies
+      class EvenStrategy < BaseStrategy
+        def initialize(start, finish, base = 2)
+          @global_start = start
+          @global_finish = finish
+          @base = base
+        end
+
+        def build
+          value = @global_start
+          step = @base
+          result = []
+          while enough?(value)
+            result << value
+            if asc?
+              value = value + step
+            else
+              value = value - step
+            end
+            step *= @base
+          end
+          result
+        end
+      end
+    end
+  end
+end

data/lib/kaminari/logarithmic/strategies/fixed_steps_strategy.rb

@@ -0,0 +1,64 @@
+module Kaminari
+  module Logarithmic
+    module Strategies
+      class FixedStepsStrategy < BaseStrategy
+        def initialize(start, finish, base = 10)
+          @global_start = start
+          @global_finish = finish
+          @base = base
+        end
+
+        def build
+          start = next_point_or_itself(@global_start, @base)
+          step = @base
+          result = []
+          while enough?(start)
+            finish = next_finish(start, step)
+            result += seq_with_step(start, finish, step)
+            start = next_point(finish, step * @base)
+            step *= @base
+          end
+          result
+        end
+
+        private
+
+        def enough?(value)
+          if asc?
+            value < @global_finish
+          else
+            value > @global_finish
+          end
+        end
+
+        def next_finish(start, step)
+          variants = [@global_finish, next_point(start, step * @base)]
+          asc? ? variants.min : variants.max
+        end
+
+        # if value is divisible by step return itself
+        def next_point_or_itself(value, step)
+          if (value % step) == 0
+            value
+          else
+            next_point(value, step)
+          end
+        end
+
+        def next_point(value, step)
+          if asc?
+            ((value + step) / step) * step
+          else
+            return (value - step) if value % step == 0
+            (value / step) * step
+          end
+        end
+
+        def seq_with_step(start, finish, step)
+          step = -step if desc?
+          start.step(finish, step).to_a
+        end
+      end
+    end
+  end
+end

data/lib/kaminari/logarithmic/version.rb

@@ -0,0 +1,5 @@
+module Kaminari
+  module Logarithmic
+    VERSION = "0.0.1"
+  end
+end

data/lib/kaminari/logarithmic.rb

@@ -0,0 +1,17 @@
+require "kaminari"
+require "kaminari/helpers/paginator"
+require "kaminari/logarithmic/version"
+require "kaminari/logarithmic/action_view_extension"
+require "kaminari/logarithmic/page_proxy_extension"
+require "kaminari/logarithmic/strategies/base_strategy"
+require "kaminari/logarithmic/strategies/even_strategy"
+require "kaminari/logarithmic/strategies/fixed_steps_strategy"
+require "kaminari/logarithmic/seq_builder"
+
+module Kaminari
+  module Logarithmic
+  end
+end
+
+::ActionView::Base.send :include, Kaminari::Logarithmic::ActionViewExtension
+::Kaminari::Helpers::Paginator::PageProxy.send :include, Kaminari::Logarithmic::PageProxyExtension

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'kaminari/logarithmic'
+
+RSpec.configure do |config|
+end

data/spec/strategies/even_strategy_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Kaminari::Logarithmic::Strategies::EvenStrategy do
+  describe ".build" do
+    {
+      [1, 100] => [1, 3, 7, 15, 31, 63],
+      [100, 1] => [100, 98, 94, 86, 70, 38]
+    }.each do |range, pages|
+      it { expect(described_class.new(*range).build).to eq pages }
+    end
+  end
+
+end

data/spec/strategies/fixed_steps_strategy_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Kaminari::Logarithmic::Strategies::FixedStepsStrategy do
+  describe ".build" do
+    {
+      [1, 100] => [10, 20, 30, 40, 50, 60, 70, 80, 90, 100],
+      [10, 100] => [10, 20, 30, 40, 50, 60, 70, 80, 90, 100],
+      [1, 101] => [10, 20, 30, 40, 50, 60, 70, 80, 90, 100],
+      [45, 670] => [50, 60, 70, 80, 90, 100, 200, 300, 400, 500, 600],
+      [315, 2346] => [320, 330, 340, 350, 360, 370, 380, 390, 400, 500, 600, 700, 800, 900, 1000, 2000],
+      [315, 22346] => [320, 330, 340, 350, 360, 370, 380, 390, 400, 500, 600, 700, 800, 900, 1000, 2000, 3000, 4000, 5000, 6000, 7000, 8000, 9000, 10000, 20000],
+      [673, 45] => [670, 660, 650, 640, 630, 620, 610, 600, 500, 400, 300, 200, 100],
+      [100, 1] => [100, 90, 80, 70, 60, 50, 40, 30, 20, 10],
+      [100, 10] => [100, 90, 80, 70, 60, 50, 40, 30, 20, 10]
+    }.each do |range, pages|
+      it { expect(described_class.new(*range).build).to eq pages }
+    end
+  end
+
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: kaminari-logarithmic
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Anton Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+- !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'
+description: Kaminari extension for logarithmic pagination
+email:
+- antoshalee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kaminari-logarithmic.gemspec
+- lib/kaminari/logarithmic.rb
+- lib/kaminari/logarithmic/action_view_extension.rb
+- lib/kaminari/logarithmic/page_proxy_extension.rb
+- lib/kaminari/logarithmic/paginator.rb
+- lib/kaminari/logarithmic/seq_builder.rb
+- lib/kaminari/logarithmic/strategies/base_strategy.rb
+- lib/kaminari/logarithmic/strategies/even_strategy.rb
+- lib/kaminari/logarithmic/strategies/fixed_steps_strategy.rb
+- lib/kaminari/logarithmic/version.rb
+- spec/spec_helper.rb
+- spec/strategies/even_strategy_spec.rb
+- spec/strategies/fixed_steps_strategy_spec.rb
+homepage: https://github.com/antoshalee/kaminari-logarithmic
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Kaminari extension for logarithmic pagination
+test_files:
+- spec/spec_helper.rb
+- spec/strategies/even_strategy_spec.rb
+- spec/strategies/fixed_steps_strategy_spec.rb