kaminari-core 1.0.0.beta2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ad3d5396adc51998d690a560dea4308037faee3
+  data.tar.gz: 1efdb607e00f8b4a27350074a7b4ff77dfb06dc9
+SHA512:
+  metadata.gz: cd23e9feaac1566b0a99c3bcb469a19d1d07134d77fe44b28ca2e3ae938909774bb12f191b98b62344981751e09db04771bbb4c01026a42fb9ddf450885a8171
+  data.tar.gz: 14f300e09667f82e8001460febb946dd8a9037f7aa8e7cea28603fa1d6602eaa0ce6095f37ae8273a83aa86cee1aa8e67c49404bdecd6f38a43ccee9095fe8b1

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Akira Matsuda
+
+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,31 @@
+# Kaminari::Core
+
+Kaminari core libraries.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kaminari-core'
+```
+
+And bundle.
+
+
+## Usage
+
+This gem is basically an internal gem that will be automatically bundled from kaminari gem or kaminari adapter gems.
+
+See [Kaminari README](https://github.com/amatsuda/kaminari/blob/master/README.md) for the documentation.
+
+
+## Contributing
+
+Pull requests are welcome on GitHub at https://github.com/amatsuda/kaminari.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/app/views/kaminari/_first_page.html.erb

@@ -0,0 +1,11 @@
+<%# Link to the "First" page
+  - available local variables
+    url:           url to the first page
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="first">
+  <%= link_to_unless current_page.first?, t('views.pagination.first').html_safe, url, remote: remote %>
+</span>

data/app/views/kaminari/_first_page.html.haml

@@ -0,0 +1,9 @@
+-#  Link to the "First" page
+-#  available local variables
+-#    url:           url to the first page
+-#    current_page:  a page object for the currently displayed page
+-#    total_pages:   total number of pages
+-#    per_page:      number of items to fetch per page
+-#    remote:        data-remote
+%span.first
+  = link_to_unless current_page.first?, t('views.pagination.first').html_safe, url, remote: remote

data/app/views/kaminari/_first_page.html.slim

@@ -0,0 +1,10 @@
+/ Link to the "First" page
+  - available local variables
+    url          : url to the first page
+    current_page : a page object for the currently displayed page
+    total_pages  : total number of pages
+    per_page     : number of items to fetch per page
+    remote       : data-remote
+span.first
+  == link_to_unless current_page.first?, t('views.pagination.first').html_safe, url, remote: remote
+'

data/app/views/kaminari/_gap.html.erb

@@ -0,0 +1,8 @@
+<%# Non-link tag that stands for skipped pages...
+  - available local variables
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="page gap"><%= t('views.pagination.truncate').html_safe %></span>

data/app/views/kaminari/_gap.html.haml

@@ -0,0 +1,8 @@
+-#  Non-link tag that stands for skipped pages...
+-#  available local variables
+-#    current_page:  a page object for the currently displayed page
+-#    total_pages:   total number of pages
+-#    per_page:      number of items to fetch per page
+-#    remote:        data-remote
+%span.page.gap
+  = t('views.pagination.truncate').html_safe

data/app/views/kaminari/_gap.html.slim

@@ -0,0 +1,9 @@
+/ Non-link tag that stands for skipped pages...
+  - available local variables
+    current_page : a page object for the currently displayed page
+    total_pages  : total number of pages
+    per_page     : number of items to fetch per page
+    remote       : data-remote
+span.page.gap
+  == t('views.pagination.truncate').html_safe
+'

data/app/views/kaminari/_last_page.html.erb

@@ -0,0 +1,11 @@
+<%# Link to the "Last" page
+  - available local variables
+    url:           url to the last page
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="last">
+  <%= link_to_unless current_page.last?, t('views.pagination.last').html_safe, url, remote: remote %>
+</span>

data/app/views/kaminari/_last_page.html.haml

@@ -0,0 +1,9 @@
+-#  Link to the "Last" page
+-#  available local variables
+-#    url:           url to the last page
+-#    current_page:  a page object for the currently displayed page
+-#    total_pages:   total number of pages
+-#    per_page:      number of items to fetch per page
+-#    remote:        data-remote
+%span.last
+  = link_to_unless current_page.last?, t('views.pagination.last').html_safe, url, remote: remote

data/app/views/kaminari/_last_page.html.slim

@@ -0,0 +1,10 @@
+/ Link to the "Last" page
+  - available local variables
+    url          : url to the last page
+    current_page : a page object for the currently displayed page
+    total_pages  : total number of pages
+    per_page     : number of items to fetch per page
+    remote       : data-remote
+span.last
+  == link_to_unless current_page.last?, t('views.pagination.last').html_safe, url, remote: remote
+'

data/app/views/kaminari/_next_page.html.erb

@@ -0,0 +1,11 @@
+<%# Link to the "Next" page
+  - available local variables
+    url:           url to the next page
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="next">
+  <%= link_to_unless current_page.last?, t('views.pagination.next').html_safe, url, rel: 'next', remote: remote %>
+</span>

data/app/views/kaminari/_next_page.html.haml

@@ -0,0 +1,9 @@
+-#  Link to the "Next" page
+-#  available local variables
+-#    url:           url to the next page
+-#    current_page:  a page object for the currently displayed page
+-#    total_pages:   total number of pages
+-#    per_page:      number of items to fetch per page
+-#    remote:        data-remote
+%span.next
+  = link_to_unless current_page.last?, t('views.pagination.next').html_safe, url, rel: 'next', remote: remote

data/app/views/kaminari/_next_page.html.slim

@@ -0,0 +1,10 @@
+/ Link to the "Next" page
+  - available local variables
+    url          : url to the next page
+    current_page : a page object for the currently displayed page
+    total_pages  : total number of pages
+    per_page     : number of items to fetch per page
+    remote       : data-remote
+span.next
+  == link_to_unless current_page.last?, t('views.pagination.next').html_safe, url, rel: 'next', remote: remote
+'

data/app/views/kaminari/_page.html.erb

@@ -0,0 +1,12 @@
+<%# Link showing page number
+  - available local variables
+    page:          a page object for "this" page
+    url:           url to this page
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="page<%= ' current' if page.current? %>">
+  <%= link_to_unless page.current?, page, url, {remote: remote, rel: page.rel} %>
+</span>

data/app/views/kaminari/_page.html.haml

@@ -0,0 +1,10 @@
+-#  Link showing page number
+-#  available local variables
+-#    page:          a page object for "this" page
+-#    url:           url to this page
+-#    current_page:  a page object for the currently displayed page
+-#    total_pages:   total number of pages
+-#    per_page:      number of items to fetch per page
+-#    remote:        data-remote
+%span{class: "page#{' current' if page.current?}"}
+  = link_to_unless page.current?, page, url, {remote: remote, rel: page.rel}

data/app/views/kaminari/_page.html.slim

@@ -0,0 +1,11 @@
+/ Link showing page number
+  - available local variables
+    page         : a page object for "this" page
+    url          : url to this page
+    current_page : a page object for the currently displayed page
+    total_pages  : total number of pages
+    per_page     : number of items to fetch per page
+    remote       : data-remote
+span class="page#{' current' if page.current?}"
+  == link_to_unless page.current?, page, url, {remote: remote, rel: page.rel}
+'

data/app/views/kaminari/_paginator.html.erb

@@ -0,0 +1,25 @@
+<%# The container tag
+  - available local variables
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+    paginator:     the paginator that renders the pagination tags inside
+-%>
+<%= paginator.render do -%>
+  <nav class="pagination">
+    <%= first_page_tag unless current_page.first? %>
+    <%= prev_page_tag unless current_page.first? %>
+    <% each_page do |page| -%>
+      <% if page.display_tag? -%>
+        <%= page_tag page %>
+      <% elsif !page.was_truncated? -%>
+        <%= gap_tag %>
+      <% end -%>
+    <% end -%>
+    <% unless current_page.out_of_range? %>
+      <%= next_page_tag unless current_page.last? %>
+      <%= last_page_tag unless current_page.last? %>
+    <% end %>
+  </nav>
+<% end -%>

data/app/views/kaminari/_paginator.html.haml

@@ -0,0 +1,18 @@
+-#  The container tag
+-#  available local variables
+-#    current_page:  a page object for the currently displayed page
+-#    total_pages:   total number of pages
+-#    per_page:      number of items to fetch per page
+-#    remote:        data-remote
+-#    paginator:     the paginator that renders the pagination tags inside
+= paginator.render do
+  %nav.pagination
+    = first_page_tag unless current_page.first?
+    = prev_page_tag unless current_page.first?
+    - each_page do |page|
+      - if page.display_tag?
+        = page_tag page
+      - elsif !page.was_truncated?
+        = gap_tag
+    = next_page_tag unless current_page.last?
+    = last_page_tag unless current_page.last?

data/app/views/kaminari/_paginator.html.slim

@@ -0,0 +1,19 @@
+/ The container tag
+  - available local variables
+    current_page : a page object for the currently displayed page
+    total_pages  : total number of pages
+    per_page     : number of items to fetch per page
+    remote       : data-remote
+    paginator    : the paginator that renders the pagination tags inside
+
+== paginator.render do
+  nav.pagination
+    == first_page_tag unless current_page.first?
+    == prev_page_tag unless current_page.first?
+    - each_page do |page|
+      - if page.display_tag?
+        == page_tag page
+      - elsif !page.was_truncated?
+        == gap_tag
+    == next_page_tag unless current_page.last?
+    == last_page_tag unless current_page.last?

data/app/views/kaminari/_prev_page.html.erb

@@ -0,0 +1,11 @@
+<%# Link to the "Previous" page
+  - available local variables
+    url:           url to the previous page
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="prev">
+  <%= link_to_unless current_page.first?, t('views.pagination.previous').html_safe, url, rel: 'prev', remote: remote %>
+</span>

data/app/views/kaminari/_prev_page.html.haml

@@ -0,0 +1,9 @@
+-#  Link to the "Previous" page
+-#  available local variables
+-#    url:           url to the previous page
+-#    current_page:  a page object for the currently displayed page
+-#    total_pages:   total number of pages
+-#    per_page:      number of items to fetch per page
+-#    remote:        data-remote
+%span.prev
+  = link_to_unless current_page.first?, t('views.pagination.previous').html_safe, url, rel: 'prev', remote: remote

data/app/views/kaminari/_prev_page.html.slim

@@ -0,0 +1,10 @@
+/ Link to the "Previous" page
+  - available local variables
+    url          : url to the previous page
+    current_page : a page object for the currently displayed page
+    total_pages  : total number of pages
+    per_page     : number of items to fetch per page
+    remote       : data-remote
+span.prev
+  == link_to_unless current_page.first?, t('views.pagination.previous').html_safe, url, rel: 'prev', remote: remote
+'

data/config/locales/kaminari.yml

@@ -0,0 +1,23 @@
+# Sample localization file for Kaminari. You can override these values in your app's locales file if you want.
+
+en:
+  views:
+    pagination:
+      first: "« First"
+      last: "Last »"
+      previous: "‹ Prev"
+      next: "Next ›"
+      truncate: "…"
+  helpers:
+    page_entries_info:
+      entry:
+        zero: "entries"
+        one: "entry"
+        other: "entries"
+      one_page:
+        display_entries:
+          zero: "No %{entry_name} found"
+          one: "Displaying <b>1</b> %{entry_name}"
+          other: "Displaying <b>all %{count}</b> %{entry_name}"
+      more_pages:
+        display_entries: "Displaying %{entry_name} <b>%{first}&nbsp;-&nbsp;%{last}</b> of <b>%{total}</b> in total"

data/kaminari-core.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kaminari/core/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kaminari-core"
+  spec.version       = Kaminari::Core::VERSION
+  spec.authors       = ["Akira Matsuda"]
+  spec.email         = ["ronnie@dio.jp"]
+
+  spec.summary       = "Kaminari's core pagination library"
+  spec.description   = 'kaminari-core includes pagination logic independent from ORMs and view libraries'
+  spec.homepage      = 'https://github.com/amatsuda/kaminari'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", ">= 1.13"
+  spec.add_development_dependency "rake", ">= 10.0"
+end

data/lib/generators/kaminari/config_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module Kaminari
+  module Generators
+    # rails g kaminari:config
+    class ConfigGenerator < Rails::Generators::Base # :nodoc:
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      desc <<DESC
+Description:
+    Copies Kaminari configuration file to your application's initializer directory.
+DESC
+
+      def copy_config_file
+        template 'kaminari_config.rb', 'config/initializers/kaminari_config.rb'
+      end
+    end
+  end
+end

data/lib/generators/kaminari/templates/kaminari_config.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+Kaminari.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
+  # config.params_on_first_page = false
+end

data/lib/generators/kaminari/views_generator.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+module Kaminari
+  module Generators
+    # rails g kaminari:views THEME
+    class ViewsGenerator < Rails::Generators::NamedBase # :nodoc:
+      source_root File.expand_path('../../../../app/views/kaminari', __FILE__)
+
+      class_option :template_engine, type: :string, aliases: '-e', desc: 'Template engine for the views. Available options are "erb", "haml", and "slim".'
+      class_option :views_prefix, type: :string, desc: 'Prefix for path to put views in.'
+
+      def self.banner #:nodoc:
+        <<-BANNER.chomp
+rails g kaminari: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'
+
+        if (theme = self.class.themes.detect {|t| t.name == file_name})
+          if download_templates(theme).empty?
+            say "template_engine: #{template_engine} is not available for theme: #{file_name}"
+          end
+        else
+          say "no such theme: #{file_name}\n  available themes: #{self.class.themes.map(&:name).join ', '}"
+        end
+      end
+
+      private
+      def self.themes
+        @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
+
+      def download_templates(theme)
+        theme.templates_for(template_engine).each do |template|
+          say "      downloading #{template.name} from kaminari_themes..."
+          create_file view_path_for(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, view_path_for(f)
+        end
+      end
+
+      def view_path_for(file)
+        ['app', 'views', views_prefix, 'kaminari', File.basename(file)].compact.join('/')
+      end
+
+      def views_prefix
+        options[:views_prefix].try(:to_s)
+      end
+
+      def template_engine
+        engine = options[:template_engine].try(:to_s).try(:downcase)
+
+        if engine == 'haml' || engine == 'slim'
+          ActiveSupport::Deprecation.warn 'The -e option is deprecated and will be removed in the near future. Please use the html2slim gem or the html2haml gem ' \
+                                          'to convert erb templates manually.'
+        end
+
+        engine || '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.engine == template_engine }
+      end
+    end
+
+    module GitHubApiHelper
+      def get_files_in_master
+        master_tree_sha = open('https://api.github.com/repos/amatsuda/kaminari_themes/git/refs/heads/master') do |json|
+          ActiveSupport::JSON.decode(json.read)['object']['sha']
+        end
+        open('https://api.github.com/repos/amatsuda/kaminari_themes/git/trees/' + master_tree_sha + '?recursive=1') do |json|
+          blobs = ActiveSupport::JSON.decode(json.read)['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/kaminari_themes/contents/' + path) do |json|
+          Base64.decode64(ActiveSupport::JSON.decode(json.read)['content'])
+        end
+      end
+      module_function :get_content_for
+    end
+  end
+end