foliate 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e632e2cdf928b30535057da735d185e35d5bb80
+  data.tar.gz: dcaed853a25f108a2838ad7c686a9e389e55cdb2
+SHA512:
+  metadata.gz: b34de5919e49576e9a4c27b84488d179a2a021e618dcbbec69707121023a12fb2ca69eb9a2d0e3058687602bbe2dcde50ffe4b5a058239fe2d2efe006f4ff32a
+  data.tar.gz: 3b8719a28e535fd8ba94b0ec5bcf78a43451d01ba34172c87389bf05217100aceb042e21888a57232dffec8732c40aa483620427fb95adcb64656128527c708d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 
+
+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,106 @@
+# foliate
+
+Pagination for Ruby on Rails.
+
+**Why another pagination library?**  Because a different approach leads
+to a cleaner and much simpler implementation.
+
+**How is it different?**  Instead of extending ActiveRecord, or
+dynamically defining methods on objects after instantiating them,
+*foliate* adds a single method to ActionController:
+
+```ruby
+## app/controllers/posts_controller.rb
+class PostsController < ApplicationController
+
+  def index
+    @posts = paginate(Post) # <-- single method
+  end
+
+end
+```
+
+Calling `paginate` with something like an ActiveRecord::Relation (or an
+Array) returns an ActiveRecord::Relation (or an Array) scoped to the
+current page of records, as dictated by `params[:page]`.
+
+Calling `paginate` also sets a `@pagination` instance variable for use
+in the view.  This object can be passed directly to `render`, which will
+then render the "app/views/pagination/_pagination.html.erb" view
+partial:
+
+```html
+<!-- app/views/posts/index.html.erb -->
+
+Do something with @posts here...
+
+<%= render @pagination %>
+```
+
+**How does that look?**  By default, something like this:
+
+<img src="screenshots/page_input.png" alt="page input pagination">
+
+
+## More Information
+
+**How do I customize the appearance of the pagination?**  Running the
+*foliate* installation generator creates
+"app/views/pagination/_pagination.html.erb" and
+"app/assets/stylesheets/pagination.css" in your project directory.
+These files can be edited to meet your needs.
+
+**How many records are in each page?**  By default, *foliate* allots
+`Foliate.config.default_per_page` records per page, which is set in
+"config/initializers/foliate.rb".  However, this can be overridden by
+passing `per_page:` to `paginate`:
+
+```ruby
+@posts = paginate(Post, per_page: 50)
+```
+
+**What if I have a very large table, and don't want to incur a count of
+all records for each page?**  The `paginate` method accepts a
+`total_records:` argument, which will prevent a SQL count when set:
+
+```ruby
+@posts = paginate(Post, total_records: Post.cached_count)
+```
+
+**What if I want a different param than `:page` to dictate the current
+page?**  That can be configured with `Foliate.config.page_param`, which
+is set in "config/initializers/foliate.rb".
+
+**For even more information,** see the
+[full documentation](http://www.rubydoc.info/gems/foliate/).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "foliate"
+```
+
+Then execute:
+
+```bash
+$ bundle
+```
+
+And finally, run the installation generator:
+
+```bash
+$ rails generate foliate:install
+```
+
+
+## Contributing
+
+Run `rake test` to run the tests.
+
+
+## License
+
+[MIT License](https://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,29 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'yard'
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+end
+
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/foliate.rb

@@ -0,0 +1,3 @@
+require "foliate/version"
+require "foliate/config"
+require "foliate/railtie"

data/lib/foliate/config.rb

@@ -0,0 +1,31 @@
+module Foliate
+
+  class Config
+    # @return [Integer]
+    #   default number of records to allot per page (defaults to +10+)
+    attr_accessor :default_per_page
+
+    # @return [Symbol]
+    #   URL query param name for specifying page numbers (defaults to
+    #   +:page+)
+    attr_accessor :page_param
+
+    def initialize
+      @default_per_page = 10
+      @page_param = :page
+    end
+  end
+
+  # Foliate global configuration object.
+  #
+  # @return [Foliate::Config]
+  def self.config
+    @config ||= Foliate::Config.new
+  end
+
+  # @param c [Foliate::Config]
+  def self.config=(c)
+    @config = c
+  end
+
+end

data/lib/foliate/controller.rb

@@ -0,0 +1,61 @@
+require "foliate/config"
+require "foliate/pagination"
+
+module Foliate
+  module Controller
+
+    # Paginates +records+, and returns the current page of records
+    # according to <code>params[Foliate.config.page_param]</code>
+    # (typically, <code>params[:page]</code>).  Also sets the
+    # +@pagination+ instance variable for use in the view (see
+    # {Foliate::Pagination}).
+    #
+    # Returns an ActiveRecord::Relation if +records+ is an
+    # ActiveRecord::Relation.  Returns an Array if +records+ is an
+    # Array.
+    #
+    # By default, allots <code>Foliate.config.default_per_page</code>
+    # number of records per page.  This can be overridden by specifying
+    # +per_page:+.
+    #
+    # By default, if +records+ is an ActiveRecord::Relation, computes
+    # the total number of pages by performing a SQL count query.  If the
+    # underlying table is very large, this query could have a noticeable
+    # performance cost.  This can be circumvented by specifying
+    # +total_records:+, using an estimated or cached record count.
+    #
+    # @example basic pagination
+    #   @posts = paginate(Post)
+    #
+    # @example paginated search
+    #   @posts = paginate(Post.where(status: params[:show_only]))
+    #
+    # @example user-specified per_page
+    #   @posts = paginate(Post, per_page: params[:at_a_time])
+    #
+    # @example simple cached count
+    #   count = Rails.cache.fetch("Post/count", expires_in: 5.minutes){ Post.count }
+    #   @posts = paginate(Post, total_records: count)
+    #
+    # @param records [ActiveRecord::Relation, Array]
+    # @param per_page [Integer, String]
+    # @param total_records [Integer]
+    # @return [ActiveRecord::Relation, Array]
+    def paginate(records, per_page: nil, total_records: nil)
+      @pagination = Foliate::Pagination.new.tap do |p|
+        p.current_page = [params[Foliate.config.page_param].to_i, 1].max
+        p.per_page = per_page.try(&:to_i) || Foliate.config.default_per_page
+        p.total_records = total_records || (records.is_a?(Array) ?
+          records.length : records.unscope(:limit).unscope(:offset).count)
+        p.controller = params[:controller]
+        p.action = params[:action]
+        p.query_params = request.query_parameters.except(Foliate.config.page_param)
+      end
+
+      records.is_a?(Array) ?
+        records[@pagination.offset, @pagination.per_page].to_a :
+        records.limit(@pagination.per_page).offset(@pagination.offset)
+    end
+
+  end
+end

data/lib/foliate/pagination.rb

@@ -0,0 +1,111 @@
+require "foliate/config"
+
+module Foliate
+  class Pagination
+
+    # @return [Integer]
+    #   current page number
+    attr_accessor :current_page
+
+    # @return [Integer]
+    #   number of records per page
+    attr_accessor :per_page
+
+    # @return [Integer]
+    #   total number of records
+    attr_accessor :total_records
+
+    # @return [Symbol]
+    #   originating controller
+    attr_accessor :controller
+
+    # @return [Symbol]
+    #   originating controller action
+    attr_accessor :action
+
+    # @return [Hash]
+    #   originating request query params
+    attr_accessor :query_params
+
+    # Computes the total number of pages based on +total_records+ and
+    # +per_page+.
+    #
+    # @return [Integer]
+    def total_pages
+      (total_records / per_page.to_f).ceil
+    end
+
+    # Computes the record set offset based on +current_page+ and
+    # +per_page+.
+    #
+    # @return [Integer]
+    def offset
+      (current_page - 1) * per_page
+    end
+
+    # Returns linking params for a specified +page_number+.  The
+    # returned Hash is intended for use with +link_to+, +url_for+, etc.
+    #
+    # @example usage in view
+    #   link_to "First", pagination.params_for_page(1)
+    #   link_to "Last", pagination.params_for_page(pagination.total_pages)
+    #
+    # @param page_number [Integer]
+    # @return [Hash]
+    def params_for_page(page_number)
+      { controller: controller, action: action, params: query_params.merge(
+          Foliate.config.page_param => (page_number if page_number > 1)
+      ) }
+    end
+
+    # Indicates if there is an expected page previous to the current
+    # page.
+    #
+    # @return [Boolean]
+    def prev?
+      current_page > 1
+    end
+
+    # Indicates if there is an expected page beyond the current page.
+    #
+    # @return [Boolean]
+    def next?
+      current_page < total_pages
+    end
+
+    # Linking params for the previous page.  Returns nil if {#prev?} is
+    # false.  See also {#params_for_page}.
+    #
+    # @example usage in view
+    #   link_to_if pagination.prev?, "Previous", pagination.prev_page_params
+    #
+    # @return [Hash, nil]
+    def prev_page_params
+      params_for_page(current_page - 1) if prev?
+    end
+
+    # Linking params for the next page.  Returns nil if {#next?} is
+    # false.  See also {#params_for_page}.
+    #
+    # @example usage in view
+    #   link_to_if pagination.next?, "Next", pagination.next_page_params
+    #
+    # @return [Hash, nil]
+    def next_page_params
+      params_for_page(current_page + 1) if next?
+    end
+
+    # Path to the view partial.  This method exists to allow
+    # +Pagination+ objects to be passed directly to +render+ calls in
+    # the view.
+    #
+    # @example rendering view partial from view
+    #   render @pagination
+    #
+    # @return [String]
+    def to_partial_path
+      "pagination/pagination"
+    end
+
+  end
+end

data/lib/foliate/railtie.rb

@@ -0,0 +1,12 @@
+require "rails/railtie"
+require "foliate/controller"
+
+module Foliate
+  class Railtie < Rails::Railtie
+    initializer :foliate do |app|
+      ActiveSupport.on_load :action_controller do
+        ActionController::Base.send :include, Foliate::Controller
+      end
+    end
+  end
+end

data/lib/foliate/version.rb

@@ -0,0 +1,3 @@
+module Foliate
+  VERSION = "1.0.0"
+end

data/lib/generators/foliate/install/install_generator.rb

@@ -0,0 +1,20 @@
+require "foliate/config"
+require "rails/generators/base"
+
+module Foliate
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.join(__dir__, "templates")
+
+      def copy_config
+        template "config/initializer.rb.erb", "config/initializers/foliate.rb"
+        copy_file "config/locales.yml", "config/locales/foliate.yml"
+      end
+
+      def copy_view
+        copy_file "views/page_input.html.erb", "app/views/pagination/_pagination.html.erb"
+        copy_file "stylesheets/page_input.css", "app/assets/stylesheets/pagination.css"
+      end
+    end
+  end
+end

data/lib/generators/foliate/install/templates/config/initializer.rb.erb

@@ -0,0 +1,4 @@
+Foliate.config.tap do |config|
+  config.default_per_page = <%= Foliate.config.default_per_page.inspect %>
+  config.page_param = <%= Foliate.config.page_param.inspect %>
+end

data/lib/generators/foliate/install/templates/config/locales.yml

@@ -0,0 +1,5 @@
+en:
+  foliate:
+    prev: "Previous"
+    next: "Next"
+    of: "of"

data/lib/generators/foliate/install/templates/stylesheets/page_input.css

@@ -0,0 +1,26 @@
+.foliate-page-link {
+  color: rgba(0, 0, 0, 0.6);
+}
+
+.foliate-i-of-n {
+  margin: 0 1em;
+}
+
+.foliate-form {
+  display: inline-block;
+  margin: 0;
+}
+
+.foliate-page-input {
+  font-size: 1em;
+  width: 2.5em;
+  border: 1px solid rgba(0, 0, 0, 0.5);
+  border-radius: 2px;
+  line-height: 1.5em;
+  text-align: center;
+  font-family: monospace;
+}
+
+.foliate-of {
+  margin: 0 0.25em;
+}

data/lib/generators/foliate/install/templates/views/page_input.html.erb

@@ -0,0 +1,25 @@
+<div class="foliate-pagination">
+  <span class="foliate-page-link foliate-prev-link">
+    <%= link_to_if pagination.prev?, t("foliate.prev"), pagination.prev_page_params %>
+  </span>
+
+  <span class="foliate-i-of-n">
+    <form method="get" class="foliate-form">
+      <% pagination.query_params.each do |name, value| %>
+        <input type="hidden" name="<%= name %>" value="<%= value %>">
+      <% end %>
+
+      <input type="text" pattern="[0-9]*" class="foliate-page-input"
+        name="<%= Foliate.config.page_param %>"
+        value="<%= pagination.current_page %>">
+    </form>
+
+    <span class="foliate-of"><%= t("foliate.of") %></span>
+
+    <span class="foliate-total-pages"><%= pagination.total_pages %></span>
+  </span>
+
+  <span class="foliate-page-link foliate-next-link">
+    <%= link_to_if pagination.next?, t("foliate.next"), pagination.next_page_params %>
+  </span>
+</div>

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: foliate
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonathan Hefner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 
+email:
+- jonathan.hefner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/foliate.rb
+- lib/foliate/config.rb
+- lib/foliate/controller.rb
+- lib/foliate/pagination.rb
+- lib/foliate/railtie.rb
+- lib/foliate/version.rb
+- lib/generators/foliate/install/install_generator.rb
+- lib/generators/foliate/install/templates/config/initializer.rb.erb
+- lib/generators/foliate/install/templates/config/locales.yml
+- lib/generators/foliate/install/templates/stylesheets/page_input.css
+- lib/generators/foliate/install/templates/views/page_input.html.erb
+homepage: https://github.com/jonathanhefner/foliate
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Rails pagination
+test_files: []