kaminari-surface 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. checksums.yaml +7 -0
  2. data/.document +5 -0
  3. data/.gitignore +5 -0
  4. data/.rdoc_options +16 -0
  5. data/.rspec +1 -0
  6. data/ChangeLog.md +4 -0
  7. data/Gemfile +3 -0
  8. data/LICENSE.txt +20 -0
  9. data/README.md +96 -0
  10. data/Rakefile +25 -0
  11. data/TRACKER.md +17 -0
  12. data/capture.gif +0 -0
  13. data/example/.gitignore +17 -0
  14. data/example/Gemfile +52 -0
  15. data/example/Gemfile.lock +179 -0
  16. data/example/README.rdoc +28 -0
  17. data/example/Rakefile +6 -0
  18. data/example/app/assets/javascripts/application.js +16 -0
  19. data/example/app/assets/stylesheets/application.css +15 -0
  20. data/example/app/controllers/application_controller.rb +5 -0
  21. data/example/app/controllers/products_controller.rb +6 -0
  22. data/example/app/helpers/application_helper.rb +2 -0
  23. data/example/app/models/product.rb +2 -0
  24. data/example/app/views/layouts/application.html.erb +23 -0
  25. data/example/app/views/products/index.haml +18 -0
  26. data/example/bin/bundle +3 -0
  27. data/example/bin/rails +9 -0
  28. data/example/bin/rake +9 -0
  29. data/example/bin/setup +29 -0
  30. data/example/bin/spring +15 -0
  31. data/example/config.ru +4 -0
  32. data/example/config/application.rb +26 -0
  33. data/example/config/boot.rb +3 -0
  34. data/example/config/database.yml +25 -0
  35. data/example/config/environment.rb +5 -0
  36. data/example/config/environments/development.rb +41 -0
  37. data/example/config/environments/production.rb +79 -0
  38. data/example/config/environments/test.rb +42 -0
  39. data/example/config/initializers/assets.rb +11 -0
  40. data/example/config/initializers/backtrace_silencers.rb +7 -0
  41. data/example/config/initializers/cookies_serializer.rb +3 -0
  42. data/example/config/initializers/filter_parameter_logging.rb +4 -0
  43. data/example/config/initializers/inflections.rb +16 -0
  44. data/example/config/initializers/mime_types.rb +4 -0
  45. data/example/config/initializers/session_store.rb +3 -0
  46. data/example/config/initializers/surface.rb +74 -0
  47. data/example/config/initializers/wrap_parameters.rb +14 -0
  48. data/example/config/locales/en.yml +23 -0
  49. data/example/config/routes.rb +58 -0
  50. data/example/config/secrets.yml +22 -0
  51. data/example/db/migrate/20160501023444_create_products.rb +9 -0
  52. data/example/db/schema.rb +22 -0
  53. data/example/db/seeds.rb +7 -0
  54. data/example/lib/tasks/seed.rake +9 -0
  55. data/example/public/404.html +67 -0
  56. data/example/public/422.html +67 -0
  57. data/example/public/500.html +66 -0
  58. data/example/public/favicon.ico +0 -0
  59. data/example/public/robots.txt +5 -0
  60. data/example/test/fixtures/products.yml +7 -0
  61. data/example/test/models/product_test.rb +7 -0
  62. data/example/test/test_helper.rb +10 -0
  63. data/kaminari-surface.gemspec +51 -0
  64. data/lib/kaminari/surface.rb +15 -0
  65. data/lib/kaminari/surface/data_mapper_extension.rb +15 -0
  66. data/lib/kaminari/surface/page_scope_methods.rb +78 -0
  67. data/lib/kaminari/surface/paginatable_array_extension.rb +27 -0
  68. data/lib/kaminari/surface/version.rb +5 -0
  69. data/spec/acceptance/active_record_spec.rb +83 -0
  70. data/spec/acceptance/data_mapper_spec.rb +83 -0
  71. data/spec/acceptance/mongo_mapper_spec.rb +84 -0
  72. data/spec/acceptance/mongoid_spec.rb +84 -0
  73. data/spec/spec_helper.rb +112 -0
  74. data/spec/surface/page_scope_methods_spec.rb +129 -0
  75. data/spec/surface_spec.rb +8 -0
  76. metadata +364 -0
@@ -0,0 +1,11 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Version of your assets, change this if you want to expire all your assets.
4
+ Rails.application.config.assets.version = '1.0'
5
+
6
+ # Add additional assets to the asset load path
7
+ # Rails.application.config.assets.paths << Emoji.images_path
8
+
9
+ # Precompile additional assets.
10
+ # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
11
+ # Rails.application.config.assets.precompile += %w( search.js )
@@ -0,0 +1,7 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
4
+ # Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
5
+
6
+ # You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
7
+ # Rails.backtrace_cleaner.remove_silencers!
@@ -0,0 +1,3 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ Rails.application.config.action_dispatch.cookies_serializer = :json
@@ -0,0 +1,4 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Configure sensitive parameters which will be filtered from the log file.
4
+ Rails.application.config.filter_parameters += [:password]
@@ -0,0 +1,16 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Add new inflection rules using the following format. Inflections
4
+ # are locale specific, and you may define rules for as many different
5
+ # locales as you wish. All of these examples are active by default:
6
+ # ActiveSupport::Inflector.inflections(:en) do |inflect|
7
+ # inflect.plural /^(ox)$/i, '\1en'
8
+ # inflect.singular /^(ox)en/i, '\1'
9
+ # inflect.irregular 'person', 'people'
10
+ # inflect.uncountable %w( fish sheep )
11
+ # end
12
+
13
+ # These inflection rules are supported but not enabled by default:
14
+ # ActiveSupport::Inflector.inflections(:en) do |inflect|
15
+ # inflect.acronym 'RESTful'
16
+ # end
@@ -0,0 +1,4 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Add new mime types for use in respond_to blocks:
4
+ # Mime::Type.register "text/richtext", :rtf
@@ -0,0 +1,3 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ Rails.application.config.session_store :cookie_store, key: '_app_session'
@@ -0,0 +1,74 @@
1
+ require 'kaminari/models/page_scope_methods'
2
+
3
+ module Kaminari
4
+ module SurfacePageScopeMethods
5
+ def per(num)
6
+ @_per = num
7
+ super
8
+ end
9
+
10
+ def surface(num)
11
+ @_surface = num
12
+
13
+ remaining = total_count - (offset_value + per_page_count)
14
+
15
+ if remaining <= num
16
+ limit(limit_value + remaining).offset(offset_value)
17
+ else
18
+ self
19
+ end
20
+ end
21
+
22
+ def current_page
23
+ offset_without_padding = offset_value
24
+ offset_without_padding -= @_padding if padding_enabled?
25
+ offset_without_padding = 0 if offset_without_padding < 0
26
+
27
+ (offset_without_padding / per_page_count) + 1
28
+ end
29
+
30
+ # def first_page?; end
31
+ # def last_page?; end
32
+ # def next_page; end
33
+ # def num_pages; end
34
+ # def out_of_range?; end
35
+ # def padding; end
36
+ # def per; end
37
+ # def prev_page; end
38
+
39
+ def total_pages
40
+ # How many pages are shown on the last page?
41
+
42
+ count_without_padding = total_count
43
+ count_without_padding -= @_padding if padding_enabled?
44
+ count_without_padding = 0 if count_without_padding < 0
45
+
46
+ total_pages_count = ((count_without_padding - surface_count).to_f / per_page_count).ceil
47
+
48
+ if max_pages.present? && max_pages < total_pages_count
49
+ max_pages
50
+ else
51
+ total_pages_count
52
+ end
53
+ end
54
+
55
+ def num_pages
56
+ total_pages
57
+ end
58
+
59
+ private
60
+ def per_page_count
61
+ (@_per || default_per_page).to_i
62
+ end
63
+
64
+ def surface_count
65
+ (@_surface || 0).to_i
66
+ end
67
+
68
+ def padding_enabled?
69
+ defined?(@_padding) && @_padding
70
+ end
71
+ end
72
+
73
+ PageScopeMethods.prepend(SurfacePageScopeMethods)
74
+ end
@@ -0,0 +1,14 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # This file contains settings for ActionController::ParamsWrapper which
4
+ # is enabled by default.
5
+
6
+ # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
7
+ ActiveSupport.on_load(:action_controller) do
8
+ wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
9
+ end
10
+
11
+ # To enable root element in JSON for ActiveRecord objects.
12
+ # ActiveSupport.on_load(:active_record) do
13
+ # self.include_root_in_json = true
14
+ # end
@@ -0,0 +1,23 @@
1
+ # Files in the config/locales directory are used for internationalization
2
+ # and are automatically loaded by Rails. If you want to use locales other
3
+ # than English, add the necessary files in this directory.
4
+ #
5
+ # To use the locales, use `I18n.t`:
6
+ #
7
+ # I18n.t 'hello'
8
+ #
9
+ # In views, this is aliased to just `t`:
10
+ #
11
+ # <%= t('hello') %>
12
+ #
13
+ # To use a different locale, set it with `I18n.locale`:
14
+ #
15
+ # I18n.locale = :es
16
+ #
17
+ # This would use the information in config/locales/es.yml.
18
+ #
19
+ # To learn more, please read the Rails Internationalization guide
20
+ # available at http://guides.rubyonrails.org/i18n.html.
21
+
22
+ en:
23
+ hello: "Hello world"
@@ -0,0 +1,58 @@
1
+ Rails.application.routes.draw do
2
+ # The priority is based upon order of creation: first created -> highest priority.
3
+ # See how all your routes lay out with "rake routes".
4
+
5
+ get 'products' => 'products#index'
6
+
7
+ # You can have the root of your site routed with "root"
8
+ # root 'welcome#index'
9
+
10
+ # Example of regular route:
11
+ # get 'products/:id' => 'catalog#view'
12
+
13
+ # Example of named route that can be invoked with purchase_url(id: product.id)
14
+ # get 'products/:id/purchase' => 'catalog#purchase', as: :purchase
15
+
16
+ # Example resource route (maps HTTP verbs to controller actions automatically):
17
+ # resources :products
18
+
19
+ # Example resource route with options:
20
+ # resources :products do
21
+ # member do
22
+ # get 'short'
23
+ # post 'toggle'
24
+ # end
25
+ #
26
+ # collection do
27
+ # get 'sold'
28
+ # end
29
+ # end
30
+
31
+ # Example resource route with sub-resources:
32
+ # resources :products do
33
+ # resources :comments, :sales
34
+ # resource :seller
35
+ # end
36
+
37
+ # Example resource route with more complex sub-resources:
38
+ # resources :products do
39
+ # resources :comments
40
+ # resources :sales do
41
+ # get 'recent', on: :collection
42
+ # end
43
+ # end
44
+
45
+ # Example resource route with concerns:
46
+ # concern :toggleable do
47
+ # post 'toggle'
48
+ # end
49
+ # resources :posts, concerns: :toggleable
50
+ # resources :photos, concerns: :toggleable
51
+
52
+ # Example resource route within a namespace:
53
+ # namespace :admin do
54
+ # # Directs /admin/products/* to Admin::ProductsController
55
+ # # (app/controllers/admin/products_controller.rb)
56
+ # resources :products
57
+ # end
58
+ end
@@ -0,0 +1,22 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Your secret key is used for verifying the integrity of signed cookies.
4
+ # If you change this key, all old signed cookies will become invalid!
5
+
6
+ # Make sure the secret is at least 30 characters and all random,
7
+ # no regular words or you'll be exposed to dictionary attacks.
8
+ # You can use `rake secret` to generate a secure secret key.
9
+
10
+ # Make sure the secrets in this file are kept private
11
+ # if you're sharing your code publicly.
12
+
13
+ development:
14
+ secret_key_base: 1403175f09cdb218c246411d485ce69c65dd86097b74cadaf9ef9f8a5127fc6d51cde1ae5ff31a452eb5e3562231b8bc2a86598612dcd15f32738881c8f13bcf
15
+
16
+ test:
17
+ secret_key_base: a30d406cd60eac4af8fd24625f1a8ea6e75061de4411af1f660df2795644f84e1a6385c73258d723def5cc7130ab37aeeb5fbd14a2811080bc2c31d21bde96e0
18
+
19
+ # Do not keep production secrets in the repository,
20
+ # instead read values from the environment.
21
+ production:
22
+ secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>
@@ -0,0 +1,9 @@
1
+ class CreateProducts < ActiveRecord::Migration
2
+ def change
3
+ create_table :products do |t|
4
+ t.string :name
5
+
6
+ t.timestamps null: false
7
+ end
8
+ end
9
+ end
@@ -0,0 +1,22 @@
1
+ # encoding: UTF-8
2
+ # This file is auto-generated from the current state of the database. Instead
3
+ # of editing this file, please use the migrations feature of Active Record to
4
+ # incrementally modify your database, and then regenerate this schema definition.
5
+ #
6
+ # Note that this schema.rb definition is the authoritative source for your
7
+ # database schema. If you need to create the application database on another
8
+ # system, you should be using db:schema:load, not running all the migrations
9
+ # from scratch. The latter is a flawed and unsustainable approach (the more migrations
10
+ # you'll amass, the slower it'll run and the greater likelihood for issues).
11
+ #
12
+ # It's strongly recommended that you check this file into your version control system.
13
+
14
+ ActiveRecord::Schema.define(version: 20160501023444) do
15
+
16
+ create_table "products", force: :cascade do |t|
17
+ t.string "name"
18
+ t.datetime "created_at", null: false
19
+ t.datetime "updated_at", null: false
20
+ end
21
+
22
+ end
@@ -0,0 +1,7 @@
1
+ # This file should contain all the record creation needed to seed the database with its default values.
2
+ # The data can then be loaded with the rake db:seed (or created alongside the db with db:setup).
3
+ #
4
+ # Examples:
5
+ #
6
+ # cities = City.create([{ name: 'Chicago' }, { name: 'Copenhagen' }])
7
+ # Mayor.create(name: 'Emanuel', city: cities.first)
@@ -0,0 +1,9 @@
1
+ task seed: :environment do
2
+ require 'faker'
3
+
4
+ Product.delete_all
5
+
6
+ 6.times do
7
+ Product.create(name: Faker::Commerce.product_name)
8
+ end
9
+ end
@@ -0,0 +1,67 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>The page you were looking for doesn't exist (404)</title>
5
+ <meta name="viewport" content="width=device-width,initial-scale=1">
6
+ <style>
7
+ body {
8
+ background-color: #EFEFEF;
9
+ color: #2E2F30;
10
+ text-align: center;
11
+ font-family: arial, sans-serif;
12
+ margin: 0;
13
+ }
14
+
15
+ div.dialog {
16
+ width: 95%;
17
+ max-width: 33em;
18
+ margin: 4em auto 0;
19
+ }
20
+
21
+ div.dialog > div {
22
+ border: 1px solid #CCC;
23
+ border-right-color: #999;
24
+ border-left-color: #999;
25
+ border-bottom-color: #BBB;
26
+ border-top: #B00100 solid 4px;
27
+ border-top-left-radius: 9px;
28
+ border-top-right-radius: 9px;
29
+ background-color: white;
30
+ padding: 7px 12% 0;
31
+ box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
32
+ }
33
+
34
+ h1 {
35
+ font-size: 100%;
36
+ color: #730E15;
37
+ line-height: 1.5em;
38
+ }
39
+
40
+ div.dialog > p {
41
+ margin: 0 0 1em;
42
+ padding: 1em;
43
+ background-color: #F7F7F7;
44
+ border: 1px solid #CCC;
45
+ border-right-color: #999;
46
+ border-left-color: #999;
47
+ border-bottom-color: #999;
48
+ border-bottom-left-radius: 4px;
49
+ border-bottom-right-radius: 4px;
50
+ border-top-color: #DADADA;
51
+ color: #666;
52
+ box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
53
+ }
54
+ </style>
55
+ </head>
56
+
57
+ <body>
58
+ <!-- This file lives in public/404.html -->
59
+ <div class="dialog">
60
+ <div>
61
+ <h1>The page you were looking for doesn't exist.</h1>
62
+ <p>You may have mistyped the address or the page may have moved.</p>
63
+ </div>
64
+ <p>If you are the application owner check the logs for more information.</p>
65
+ </div>
66
+ </body>
67
+ </html>
@@ -0,0 +1,67 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>The change you wanted was rejected (422)</title>
5
+ <meta name="viewport" content="width=device-width,initial-scale=1">
6
+ <style>
7
+ body {
8
+ background-color: #EFEFEF;
9
+ color: #2E2F30;
10
+ text-align: center;
11
+ font-family: arial, sans-serif;
12
+ margin: 0;
13
+ }
14
+
15
+ div.dialog {
16
+ width: 95%;
17
+ max-width: 33em;
18
+ margin: 4em auto 0;
19
+ }
20
+
21
+ div.dialog > div {
22
+ border: 1px solid #CCC;
23
+ border-right-color: #999;
24
+ border-left-color: #999;
25
+ border-bottom-color: #BBB;
26
+ border-top: #B00100 solid 4px;
27
+ border-top-left-radius: 9px;
28
+ border-top-right-radius: 9px;
29
+ background-color: white;
30
+ padding: 7px 12% 0;
31
+ box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
32
+ }
33
+
34
+ h1 {
35
+ font-size: 100%;
36
+ color: #730E15;
37
+ line-height: 1.5em;
38
+ }
39
+
40
+ div.dialog > p {
41
+ margin: 0 0 1em;
42
+ padding: 1em;
43
+ background-color: #F7F7F7;
44
+ border: 1px solid #CCC;
45
+ border-right-color: #999;
46
+ border-left-color: #999;
47
+ border-bottom-color: #999;
48
+ border-bottom-left-radius: 4px;
49
+ border-bottom-right-radius: 4px;
50
+ border-top-color: #DADADA;
51
+ color: #666;
52
+ box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
53
+ }
54
+ </style>
55
+ </head>
56
+
57
+ <body>
58
+ <!-- This file lives in public/422.html -->
59
+ <div class="dialog">
60
+ <div>
61
+ <h1>The change you wanted was rejected.</h1>
62
+ <p>Maybe you tried to change something you didn't have access to.</p>
63
+ </div>
64
+ <p>If you are the application owner check the logs for more information.</p>
65
+ </div>
66
+ </body>
67
+ </html>