kaminari-surface 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46fa1f2a2c82930ab50f3ccc4fd9062406c89bd7
+  data.tar.gz: 022cbcc90e553d94b7fc78bbcd9d91149b6d50d6
+SHA512:
+  metadata.gz: d89a732e78897bc553b652fbaf3e9bdc7a1ef5550744f7b52e744ab75941dd65982ade52f866ab58d91a212e658e636f073601b19b9f7b1c317881c74b3de0b9
+  data.tar.gz: 9e505b143b04cb4a8b26860a8c22f35ddfd9174bd3195950d04f047949ce65dd9469cf154ebe386bcc1232952d43fc7b40e834a874af9894f08c5202f201e665

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+README.md
+ChangeLog.md
+
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,5 @@
+/.bundle
+/Gemfile.lock
+/html/
+/pkg/
+/vendor/cache/*.gem

data/.rdoc_options

@@ -0,0 +1,16 @@
+--- !ruby/object:RDoc::Options
+encoding: UTF-8
+static_path: []
+rdoc_include:
+  - .
+charset: UTF-8
+exclude: 
+hyperlink_all: false
+line_numbers: false
+main_page: README.md
+markup: markdown
+show_hash: false
+tab_width: 8
+title: kaminari-surface Documentation
+visibility: :protected
+webcvs:

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2016-05-09
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 James Kassemi
+
+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,96 @@
+# A Surfacing Pagination Kaminari Extension
+
+Making that last result a little closer.
+
+![screencap](https://raw.githubusercontent.com/jkassemi/kaminari-surface/master/capture.gif)
+
+## Overview
+
+Developers may implement pagination to protect against overzealous result sizes.
+With responsible pagination settings a query that returns a large number of
+results can be displayed with fewer system resources on both the client and
+the server.
+
+The client may be able to configure the `per` option to permit more results per
+page. Usually this value must be increased from an initially conservative
+value, and after the first result set is displayed.
+
+For queries that return few results the client must either make a modification
+to the `per` option manually, or must page to a last page containing few
+results. Both of these operations are unnecessary, and we can enhance the
+client experience with an application designed to more intelligently handle
+smaller response sets.
+
+Surfacing pagination prevents a second request to the server by sending the
+results that the client would ordinarily need to fetch on a subsequent page
+request if the number of results is under a threshhold. The ideal implementation
+would prevent the client from flipping through pages when there's little need to
+do so.
+
+## Installation
+
+### Rails
+
+Place `kaminari-surface` in your Gemfile (if you're sane you'll version it):
+
+    gem 'kaminari-surface'
+
+and bundle:
+
+    $ bundle
+
+## Usage
+
+Configure your query with [Kaminari](https://github.com/amatsuda/kaminari) as
+usual:
+
+    results = User.page(1).per(50)
+    results.size          # => 50
+    results.total_count   # => 100
+    results.total_pages   # => 2
+
+Use the `surface` scope to enable surface pagination on a result set. The last
+page will now include up to 50 more results:
+
+    results = User.page(1).per(50).surface(50)
+
+    results.size          # => 100
+    results.total_count   # => 100
+    results.total_pages   # => 1
+
+## Contributing
+
+Fork, address the issue, and submit a pull request. You can reach me through the
+tracker or at jkassemi@gmail.com.
+
+### Running Specs
+
+ActiveRecord and DataMapper specs run with an in-memory schema, and don't need
+any additional setup.
+
+Get a mongo server up and running on your local system (port 27017) so the
+`mongoid` and `mongo_mapper` specs can run. This can be as simple as `$ brew
+install mongodb`.
+
+    $ bundle             # to install the gems from the gemspec
+    $ bundle exec rspec  # to feel the green
+
+## Integration Goals
+
+This release is a proof of concept and designed as a drop-in implementation
+that does not affect the existing kaminari project.
+
+Directly modifying and extending kaminari would be a more maintanable solution.
+Once kinks are worked out here then a PR to the kaminari project makes a heck of
+a lot of sense.
+
+## Caveats
+
+There are some cases where the use of surfacing pagination may not be
+recommended. The following issues may pop up:
+
+1. The total number of results can no longer be determined by the client
+   using the last page number or total pages number since the result count per
+   page may vary.
+1. If a client workflow routinely involves visiting the last page of results
+   then filtering through those last results may take longer.

data/Rakefile

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler/setup'
+rescue LoadError => e
+  abort e.message
+end
+
+require 'rake'
+
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rdoc/task'
+RDoc::Task.new
+task :doc => :rdoc
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test    => :spec
+task :default => :spec

data/TRACKER.md

@@ -0,0 +1,17 @@
+# Version
+
+[x] I should have a basic rails application with kaminari pagination (prototyping)
+[x] I should be able to use a functioning prototype of the surfacing pagination (prototyping)
+[x] `README.md` should better present the solution
+[x] The surfacing pagination should be implemented as a basic ruby gem.
+
+# Backlog
+
+# Icebox
+
+[ ] `README.md` should include a series of examples
+[ ] Documentation should detail how to enable explicitly and disable globally.
+[ ] I should be able to conceptualize around an ajax pagination feature (prototyping)
+[ ] I should be able to use surfacing pagination with ajax (prototyping)
+[ ] A default surfacing pagination value should be provided so surfacing is used
+    by default if the gem is installed

data/example/.gitignore

@@ -0,0 +1,17 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+!/log/.keep
+/tmp

data/example/Gemfile

@@ -0,0 +1,52 @@
+source 'https://rubygems.org'
+
+gem 'kaminari'
+gem 'haml'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.2.1'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 5.0'
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+# Use CoffeeScript for .coffee assets and views
+gem 'coffee-rails', '~> 4.1.0'
+# See https://github.com/rails/execjs#readme for more supported runtimes
+# gem 'therubyracer', platforms: :ruby
+
+# Use jquery as the JavaScript library
+gem 'jquery-rails'
+# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
+gem 'turbolinks'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.0'
+# bundle exec rake doc:rails generates the API under doc/api.
+gem 'sdoc', '~> 0.4.0', group: :doc
+
+# Use ActiveModel has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use Unicorn as the app server
+# gem 'unicorn'
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+
+gem 'bootstrap-kaminari-views'
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug'
+
+  # Access an IRB console on exception pages or by using <%= console %> in views
+  gem 'web-console', '~> 2.0'
+
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+
+  gem 'pry'
+  gem 'faker'
+end
+

data/example/Gemfile.lock

@@ -0,0 +1,179 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.1)
+      actionpack (= 4.2.1)
+      actionview (= 4.2.1)
+      activejob (= 4.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.1)
+      actionview (= 4.2.1)
+      activesupport (= 4.2.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    actionview (4.2.1)
+      activesupport (= 4.2.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    activejob (4.2.1)
+      activesupport (= 4.2.1)
+      globalid (>= 0.3.0)
+    activemodel (4.2.1)
+      activesupport (= 4.2.1)
+      builder (~> 3.1)
+    activerecord (4.2.1)
+      activemodel (= 4.2.1)
+      activesupport (= 4.2.1)
+      arel (~> 6.0)
+    activesupport (4.2.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    binding_of_caller (0.7.2)
+      debug_inspector (>= 0.0.1)
+    bootstrap-kaminari-views (0.0.5)
+      kaminari (>= 0.13)
+      rails (>= 3.1)
+    builder (3.2.2)
+    byebug (8.2.5)
+    coderay (1.1.0)
+    coffee-rails (4.1.1)
+      coffee-script (>= 2.2.0)
+      railties (>= 4.0.0, < 5.1.x)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.10.0)
+    concurrent-ruby (1.0.1)
+    debug_inspector (0.0.2)
+    erubis (2.7.0)
+    execjs (2.6.0)
+    faker (1.4.3)
+      i18n (~> 0.5)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    haml (4.0.6)
+      tilt
+    i18n (0.7.0)
+    jbuilder (2.4.1)
+      activesupport (>= 3.0.0, < 5.1)
+      multi_json (~> 1.2)
+    jquery-rails (4.1.1)
+      rails-dom-testing (>= 1, < 3)
+      railties (>= 4.2.0)
+      thor (>= 0.14, < 2.0)
+    json (1.8.3)
+    kaminari (0.16.3)
+      actionpack (>= 3.0.0)
+      activesupport (>= 3.0.0)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.0)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0221)
+    mini_portile2 (2.0.0)
+    minitest (5.8.4)
+    multi_json (1.11.3)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.1)
+      actionmailer (= 4.2.1)
+      actionpack (= 4.2.1)
+      actionview (= 4.2.1)
+      activejob (= 4.2.1)
+      activemodel (= 4.2.1)
+      activerecord (= 4.2.1)
+      activesupport (= 4.2.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.1)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.1)
+      actionpack (= 4.2.1)
+      activesupport (= 4.2.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (11.1.2)
+    rdoc (4.2.2)
+      json (~> 1.4)
+    sass (3.4.22)
+    sass-rails (5.0.4)
+      railties (>= 4.0.0, < 5.0)
+      sass (~> 3.1)
+      sprockets (>= 2.8, < 4.0)
+      sprockets-rails (>= 2.0, < 4.0)
+      tilt (>= 1.1, < 3)
+    sdoc (0.4.1)
+      json (~> 1.7, >= 1.7.7)
+      rdoc (~> 4.0)
+    slop (3.6.0)
+    spring (1.7.1)
+    sprockets (3.6.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.0.4)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.11)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tilt (2.0.2)
+    turbolinks (2.5.3)
+      coffee-rails
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    uglifier (3.0.0)
+      execjs (>= 0.3.0, < 3)
+    web-console (2.3.0)
+      activemodel (>= 4.0)
+      binding_of_caller (>= 0.7.2)
+      railties (>= 4.0)
+      sprockets-rails (>= 2.0, < 4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bootstrap-kaminari-views
+  byebug
+  coffee-rails (~> 4.1.0)
+  faker
+  haml
+  jbuilder (~> 2.0)
+  jquery-rails
+  kaminari
+  pry
+  rails (= 4.2.1)
+  sass-rails (~> 5.0)
+  sdoc (~> 0.4.0)
+  spring
+  sqlite3
+  turbolinks
+  uglifier (>= 1.3.0)
+  web-console (~> 2.0)