the_pagination 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f3744ef91c8002a6f633c9d4f37b5355fcd12ba
-  data.tar.gz: 33596bc9c12451f655ea066aeacf818c624c081e
+  metadata.gz: a7d1bdaac42b90db91f8c5b7fb7f155cec28c279
+  data.tar.gz: e3e36b39929b84215afbeffa18656180154008b4
 SHA512:
-  metadata.gz: 0911734c29c6aebb182b42efefdbbefb11d6dc9e2021a3e60a0962a6aa91c4fb5e4b8d6ffeb0d30f0e1c6700c8c7b786240b6760fc60a184f2b142d2cc10e651
-  data.tar.gz: 7c9cdd40fab014701ed1f68a1ebef8a4bd41e1365306a88a25c1fe0d2750fac7b0c1adf7719d64ae4de3773d2a76aa27974a51fecc742b90e59c38d257d7e6d9
+  metadata.gz: e5a07f95b8562ffd9e7fb11ec62d529f97c8b540a4039d37c4c25f8fcf26a65ec47df50611174465c28d1fa163a2d7d76566760cd8d74f86716c3f8cadbe5065
+  data.tar.gz: 7f28938f91a633fe4941e51c08d7f90514ff6a9f5785335206eb1271bda3d1ecb45e6203e55fa550951b38022a4c1cc77a37d36292bfa811dc8504bafde74b9c

data/Gemfile

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

data/README.md

@@ -1,3 +1,85 @@
-# ThePagination
+```ruby
+This gem is a part of TheOpenCMS project. https://github.com/TheOpenCMS
+```
 
-Just Pagination conerns for The!Profit CMS
+## Pagination
+
+This simple gem provides the only method `pagination`, which takes `per_page` and `page` parameters from `params` hash and applies these parameters to a Model. In fact this gem just provides a simple helper to improve a typical staff with `per_page` and `page` parameters. Works with `Kaminary`.
+
+```ruby
+class Product < AR
+  include ::Pagination::Base
+end
+```
+
+```ruby
+@posts = Post.pagination(params)
+```
+
+```ruby
+div Items on the page:
+- %w[ 5 10 20 50 100 125 ].each do |num|
+  span= link_to num, url_for(per_page: num)
+```
+
+### Configurations of `page_method_name`
+
+**config/initializers/kaminari.rb**
+
+```ruby
+Kaminari.configure do |config|
+  config.page_method_name = :per_page_kaminari
+end
+
+module ::Pagination::Base
+  def self.per_method
+    @per = :per_page_kaminari
+  end
+end
+```
+
+## Pagination (RU)
+
+Этот простой гем всего лишь предоставляет метод `pagination`, который берет параметры `per_page` и  `page` из хеша `params` и применяет их к Модели. По факту гем просто обеспечивает простой хелпер, что бы улучшить типичную работу с переменными `per_page` и `page`. Работает с `Kaminary`.
+
+```ruby
+class Product < AR
+  include ::Pagination::Base
+end
+```
+
+```ruby
+@posts = Post.pagination(params)
+```
+
+```ruby
+div Элементов на странице:
+- %w[ 5 10 20 50 100 125 ].each do |num|
+  span= link_to num, url_for(per_page: num)
+```
+
+### Конфигурация параметра `page_method_name`
+
+**config/initializers/kaminari.rb**
+
+```ruby
+Kaminari.configure do |config|
+  config.page_method_name = :per_page_kaminari
+end
+
+module ::Pagination::Base
+  def self.per_method
+    @per = :per_page_kaminari
+  end
+end
+```
+
+### MIT License
+
+Copyright (c) 2014-[Current Year] Ilya N. Zykin
+
+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/config/locales/ru.yml

@@ -0,0 +1,6 @@
+ru:
+  views:
+    pagination:
+      first: Первая
+      last: Последняя
+      truncate: '...'

data/lib/pagination.rb

@@ -0,0 +1,21 @@
+require "kaminari"
+
+module Pagination
+  class Engine < Rails::Engine; end
+
+  module Base
+    extend ActiveSupport::Concern
+
+    # for example: per_page_kaminari
+    def self.per_method
+      @per ||= :per
+    end
+
+    class_methods do
+      def pagination params
+        per_method = ::Pagination::Base.per_method
+        page(params[:page]).send(::Pagination::Base.per_method, params[:per_page])
+      end
+    end
+  end
+end

data/the_pagination.gemspec

@@ -1,16 +1,19 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'the_pagination/version'
+
+module Pagination
+  VERSION = "1.0.0"
+end
 
 Gem::Specification.new do |spec|
   spec.name          = "the_pagination"
-  spec.version       = ThePagination::VERSION
+  spec.version       = Pagination::VERSION
   spec.authors       = ["Ilya N. Zykin"]
   spec.email         = ["zykin-ilya@ya.ru"]
-  spec.summary       = %q{Pagination concerns}
-  spec.description   = %q{Pagination concerns for The!Profit CMS}
-  spec.homepage      = "https://github.com/TheProfitCMS/the_pagination"
+  spec.summary       = %q{Pagination helper}
+  spec.description   = %q{Pagination helper for Kaminary based Models}
+  spec.homepage      = "https://github.com/TheOpenCMS"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -18,6 +21,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'kaminari'
+
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: the_pagination
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Ilya N. Zykin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-22 00:00:00.000000000 Z
+date: 2017-03-12 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
@@ -38,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Pagination concerns for The!Profit CMS
+description: Pagination helper for Kaminary based Models
 email:
 - zykin-ilya@ya.ru
 executables: []
@@ -46,15 +60,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".keep"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- gem_version.rb
-- lib/the_pagination.rb
-- lib/the_pagination/version.rb
+- config/locales/ru.yml
+- lib/pagination.rb
 - the_pagination.gemspec
-homepage: https://github.com/TheProfitCMS/the_pagination
+homepage: https://github.com/TheOpenCMS
 licenses:
 - MIT
 metadata: {}
@@ -74,8 +88,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: Pagination concerns
+summary: Pagination helper
 test_files: []

data/gem_version.rb

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

data/lib/the_pagination.rb

@@ -1,15 +0,0 @@
-require "the_pagination/version"
-
-module ThePagination
-  class Engine < Rails::Engine; end
-
-  module Concern
-    extend ActiveSupport::Concern
-
-    module ClassMethods
-      def pagination params
-        page(params[:page]).per(params[:per_page])
-      end
-    end
-  end
-end

data/lib/the_pagination/version.rb

@@ -1 +0,0 @@
-require_relative '../../gem_version'