RubyGems - kaminari-surface - Versions diffs - 0.1.0 - Mend

kaminari-surface 0.1.0

Files changed (76) hide show

checksums.yaml +7 -0
data/.document +5 -0
data/.gitignore +5 -0
data/.rdoc_options +16 -0
data/.rspec +1 -0
data/ChangeLog.md +4 -0
data/Gemfile +3 -0
data/LICENSE.txt +20 -0
data/README.md +96 -0
data/Rakefile +25 -0
data/TRACKER.md +17 -0
data/capture.gif +0 -0
data/example/.gitignore +17 -0
data/example/Gemfile +52 -0
data/example/Gemfile.lock +179 -0
data/example/README.rdoc +28 -0
data/example/Rakefile +6 -0
data/example/app/assets/javascripts/application.js +16 -0
data/example/app/assets/stylesheets/application.css +15 -0
data/example/app/controllers/application_controller.rb +5 -0
data/example/app/controllers/products_controller.rb +6 -0
data/example/app/helpers/application_helper.rb +2 -0
data/example/app/models/product.rb +2 -0
data/example/app/views/layouts/application.html.erb +23 -0
data/example/app/views/products/index.haml +18 -0
data/example/bin/bundle +3 -0
data/example/bin/rails +9 -0
data/example/bin/rake +9 -0
data/example/bin/setup +29 -0
data/example/bin/spring +15 -0
data/example/config.ru +4 -0
data/example/config/application.rb +26 -0
data/example/config/boot.rb +3 -0
data/example/config/database.yml +25 -0
data/example/config/environment.rb +5 -0
data/example/config/environments/development.rb +41 -0
data/example/config/environments/production.rb +79 -0
data/example/config/environments/test.rb +42 -0
data/example/config/initializers/assets.rb +11 -0
data/example/config/initializers/backtrace_silencers.rb +7 -0
data/example/config/initializers/cookies_serializer.rb +3 -0
data/example/config/initializers/filter_parameter_logging.rb +4 -0
data/example/config/initializers/inflections.rb +16 -0
data/example/config/initializers/mime_types.rb +4 -0
data/example/config/initializers/session_store.rb +3 -0
data/example/config/initializers/surface.rb +74 -0
data/example/config/initializers/wrap_parameters.rb +14 -0
data/example/config/locales/en.yml +23 -0
data/example/config/routes.rb +58 -0
data/example/config/secrets.yml +22 -0
data/example/db/migrate/20160501023444_create_products.rb +9 -0
data/example/db/schema.rb +22 -0
data/example/db/seeds.rb +7 -0
data/example/lib/tasks/seed.rake +9 -0
data/example/public/404.html +67 -0
data/example/public/422.html +67 -0
data/example/public/500.html +66 -0
data/example/public/favicon.ico +0 -0
data/example/public/robots.txt +5 -0
data/example/test/fixtures/products.yml +7 -0
data/example/test/models/product_test.rb +7 -0
data/example/test/test_helper.rb +10 -0
data/kaminari-surface.gemspec +51 -0
data/lib/kaminari/surface.rb +15 -0
data/lib/kaminari/surface/data_mapper_extension.rb +15 -0
data/lib/kaminari/surface/page_scope_methods.rb +78 -0
data/lib/kaminari/surface/paginatable_array_extension.rb +27 -0
data/lib/kaminari/surface/version.rb +5 -0
data/spec/acceptance/active_record_spec.rb +83 -0
data/spec/acceptance/data_mapper_spec.rb +83 -0
data/spec/acceptance/mongo_mapper_spec.rb +84 -0
data/spec/acceptance/mongoid_spec.rb +84 -0
data/spec/spec_helper.rb +112 -0
data/spec/surface/page_scope_methods_spec.rb +129 -0
data/spec/surface_spec.rb +8 -0
metadata +364 -0

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <div>
+      <h1>We're sorry, but something went wrong.</h1>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/example/public/favicon.ico ADDED

File without changes

data/example/public/robots.txt ADDED

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-agent: *
+# Disallow: /

data/example/test/fixtures/products.yml ADDED

@@ -0,0 +1,7 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+one:
+  name: MyString
+two:
+  name: MyString

data/example/test/models/product_test.rb ADDED

@@ -0,0 +1,7 @@
+require 'test_helper'
+class ProductTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/example/test/test_helper.rb ADDED

@@ -0,0 +1,10 @@
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../../config/environment', __FILE__)
+require 'rails/test_help'
+class ActiveSupport::TestCase
+  # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
+  fixtures :all
+  # Add more helper methods to be used by all tests here...
+end

data/kaminari-surface.gemspec ADDED

@@ -0,0 +1,51 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kaminari/surface/version'
+Gem::Specification.new do |gem|
+  gem.name          = "kaminari-surface"
+  gem.version       = Kaminari::Surface::VERSION
+  gem.summary       = %q{Surface the final search result page when desirable}
+  gem.description   = %q{An extension to Kaminari pagination that brings the final page of a search results to the surface, and prevents unnecessary paging requests.}
+  gem.license       = "MIT"
+  gem.authors       = ["James Kassemi"]
+  gem.email         = "jkassemi@gmail.com"
+  gem.homepage      = "https://github.com/jkassemi/kaminari-surface"
+  gem.files         = `git ls-files`.split($/)
+  `git submodule --quiet foreach --recursive pwd`.split($/).each do |submodule|
+    submodule.sub!("#{Dir.pwd}/",'')
+    Dir.chdir(submodule) do
+      `git ls-files`.split($/).map do |subpath|
+        gem.files << File.join(submodule,subpath)
+      end
+    end
+  end
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+  gem.add_runtime_dependency 'kaminari', '~> 0.16'
+  gem.add_development_dependency 'pry', '~> 0.10'
+  gem.add_development_dependency 'bundler', '~> 1'
+  gem.add_development_dependency 'faker', '~> 1.4'
+  gem.add_development_dependency 'rake', '~> 10.0'
+  gem.add_development_dependency 'rdoc', '~> 4.0'
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+  gem.add_development_dependency 'activerecord'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'data_mapper'
+  gem.add_development_dependency 'dm-sqlite-adapter'
+  gem.add_development_dependency 'kaminari-data_mapper'
+  gem.add_development_dependency 'mongoid'
+  gem.add_development_dependency 'kaminari-mongoid'
+  gem.add_development_dependency 'mongo_mapper'
+  gem.add_development_dependency 'kaminari-mongo_mapper'
+end

data/lib/kaminari/surface.rb ADDED

@@ -0,0 +1,15 @@
+require 'kaminari'
+require 'kaminari/surface/version'
+require 'kaminari/surface/page_scope_methods'
+Kaminari::PageScopeMethods.prepend(Kaminari::Surface::PageScopeMethods)
+require 'kaminari/surface/paginatable_array_extension'
+require 'kaminari/models/array_extension'
+Kaminari::PaginatableArray.prepend(Kaminari::Surface::PaginatableArrayExtension)
+if defined?(DataMapper)
+#  require 'kaminari/surface/data_mapper_extension'
+end

data/lib/kaminari/surface/data_mapper_extension.rb ADDED

@@ -0,0 +1,15 @@
+module Kaminari
+  module Surface
+    module DataMapperExtension
+      module Paginating
+        def all(options={})
+          super.extend Paginating
+        end
+        def per(num)
+          super.extend Paginating
+        end
+      end
+    end
+  end
+end

data/lib/kaminari/surface/page_scope_methods.rb ADDED

@@ -0,0 +1,78 @@
+module Kaminari
+  module Surface
+    module PageScopeMethods
+      def per(num)
+        fail ArgumentError if defined?(@_surface_value)
+        @_per_value = num
+        extend_state_to(super)
+      end
+      def padding(num)
+        fail ArgumentError if defined?(@_surface_value)
+        _padding = num
+        extend_state_to(super)
+      end
+      def surface(num)
+        remaining = total_count - (offset_value + per_value)
+        if remaining > 0 && remaining <= num
+          result = limit(limit_value + remaining).offset(offset_value)
+        else
+          result = self
+        end
+        @_surface_value = num
+        extend_state_to(result.extend(Kaminari::PageScopeMethods))
+      end
+      def current_page
+        offset_without_padding = offset_value
+        offset_without_padding -= @_padding if padding_enabled?
+        offset_without_padding = 0 if offset_without_padding < 0
+        (offset_without_padding / per_value) + 1
+      end
+      def total_pages
+        count_without_padding = total_count
+        count_without_padding -= @_padding if padding_enabled?
+        count_without_padding = 0 if count_without_padding < 0
+        total_pages_count = ((count_without_padding - surface_value).to_f / per_value).ceil
+        if max_pages.present? && max_pages < total_pages_count
+          max_pages
+        else
+          total_pages_count
+        end
+      end
+      def num_pages
+        total_pages
+      end
+      def per_value
+        (@_per_value || default_per_page).to_i
+      end
+      def surface_value
+        (@_surface_value || 0).to_i
+      end
+      private
+      def padding_enabled?
+        defined?(@_padding) && @_padding
+      end
+      def extend_state_to(target)
+        target.instance_variable_set(:@_per_value, @_per_value)
+        target.instance_variable_set(:@_surface_value, @_surface_value)
+        target.instance_variable_set(:@_padding, @_padding)
+        target
+      end
+    end
+  end
+end

data/lib/kaminari/surface/paginatable_array_extension.rb ADDED

@@ -0,0 +1,27 @@
+module Kaminari
+  module Surface
+    module PaginatableArrayExtension
+      def limit(*_args)
+        copy_attrs(super)
+      end
+      def offset(*_args)
+        copy_attrs(super)
+      end
+      private
+      def copy_attrs(target)
+        if defined?(@_per_value)
+          target.instance_variable_set(:@_per_value, @_per_value)
+        end
+        if defined?(@_surface_value)
+          target.instance_variable_set(:@_surface_value, @_surface_value)
+        end
+        target
+      end
+    end
+  end
+end

data/lib/kaminari/surface/version.rb ADDED

@@ -0,0 +1,5 @@
+module Kaminari
+  module Surface
+    VERSION = "0.1.0"
+  end
+end

data/spec/acceptance/active_record_spec.rb ADDED

@@ -0,0 +1,83 @@
+require 'spec_helper'
+RSpec.describe 'ActiveRecord integration' do
+  before(:context) do
+    23.times { SampleModels::ActiveRecord::Widget.create! }
+  end
+  context 'first page when no surfacing requested' do
+    subject(:widgets) { SampleModels::ActiveRecord::Widget.page(1).per(5) }
+    it 'has 5 pages' do
+      expect(widgets.total_pages).to eq(5)
+    end
+    it 'has 5 widgets' do
+      expect(widgets.size).to eq(5)
+    end
+    it 'has 23 total widgets' do
+      expect(widgets.total_count).to eq(23)
+    end
+  end
+  context 'first page when surfacing is 0' do
+    subject(:widgets) { SampleModels::ActiveRecord::Widget.page(1).per(5) }
+    it 'has 5 pages' do
+      expect(widgets.total_pages).to eq(5)
+    end
+  end
+  context 'first page when surfacing is 3' do
+    subject(:widgets) { SampleModels::ActiveRecord::Widget.page(1).per(5).surface(3) }
+    it 'has 4 pages' do
+      expect(widgets.total_pages).to eq(4)
+    end
+    it 'has 5 widgets' do
+      expect(widgets.size).to eq(5)
+    end
+  end
+  context 'last page when surfacing is 3' do
+    subject(:widgets){ SampleModels::ActiveRecord::Widget.page(4).per(5).surface(3) }
+    it 'has 8 widgets' do
+      expect(widgets.size).to eq(8)
+    end
+  end
+  context 'last page when surfacing is 8 (per + remainder)' do
+    subject(:widgets) { SampleModels::ActiveRecord::Widget.page(3).per(5).surface(8) }
+    it 'has 3 pages' do
+      expect(widgets.total_pages).to eq(3)
+    end
+    it 'has 13 widgets' do
+      expect(widgets.size).to eq(13)
+    end
+    it 'has 23 total widgets' do
+      expect(widgets.total_count).to eq(23)
+    end
+  end
+  context 'when `per` is called after `surface`' do
+    subject(:widgets){ ->{ SampleModels::ActiveRecord::Widget.page(1).surface(5).per(5) } }
+    it 'should raise an `ArgumentError`' do
+      expect(subject).to raise_error(ArgumentError)
+    end
+  end
+  context 'when `padding` is called after `surface`' do
+    subject(:widgets){ ->{ SampleModels::ActiveRecord::Widget.page(1).surface(5).padding(5) } }
+    it 'should raise an `ArgumentError`' do
+      expect(subject).to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/acceptance/data_mapper_spec.rb ADDED

@@ -0,0 +1,83 @@
+require 'spec_helper'
+RSpec.describe 'DataMapper integration' do
+  before(:context) do
+    23.times { SampleModels::DataMapper::Widget.create }
+  end
+  context 'first page when no surfacing requested' do
+    subject(:widgets) { SampleModels::DataMapper::Widget.page(1).per(5) }
+    it 'has 5 pages' do
+      expect(widgets.total_pages).to eq(5)
+    end
+    it 'has 5 widgets' do
+      expect(widgets.size).to eq(5)
+    end
+    it 'has 23 total widgets' do
+      expect(widgets.total_count).to eq(23)
+    end
+  end
+  context 'first page when surfacing is 0' do
+    subject(:widgets) { SampleModels::DataMapper::Widget.page(1).per(5) }
+    it 'has 5 pages' do
+      expect(widgets.total_pages).to eq(5)
+    end
+  end
+  context 'first page when surfacing is 3' do
+    subject(:widgets) { SampleModels::DataMapper::Widget.page(1).per(5).surface(3) }
+    it 'has 4 pages' do
+      expect(widgets.total_pages).to eq(4)
+    end
+    it 'has 5 widgets' do
+      expect(widgets.size).to eq(5)
+    end
+  end
+  context 'last page when surfacing is 3' do
+    subject(:widgets){ SampleModels::DataMapper::Widget.page(4).per(5).surface(3) }
+    it 'has 8 widgets' do
+      expect(widgets.size).to eq(8)
+    end
+  end
+  context 'last page when surfacing is 8 (per + remainder)' do
+    subject(:widgets) { SampleModels::DataMapper::Widget.page(3).per(5).surface(8) }
+    it 'has 3 pages' do
+      expect(widgets.total_pages).to eq(3)
+    end
+    it 'has 13 widgets' do
+      expect(widgets.size).to eq(13)
+    end
+    it 'has 23 total widgets' do
+      expect(widgets.total_count).to eq(23)
+    end
+  end
+  context 'when `per` is called after `surface`' do
+    subject(:widgets){ ->{ SampleModels::DataMapper::Widget.page(1).surface(5).per(5) } }
+    it 'should raise an `ArgumentError`' do
+      expect(subject).to raise_error(ArgumentError)
+    end
+  end
+  context 'when `padding` is called after `surface`' do
+    subject(:widgets){ ->{ SampleModels::DataMapper::Widget.page(1).surface(5).padding(5) } }
+    it 'should raise an `ArgumentError`' do
+      expect(subject).to raise_error(ArgumentError)
+    end
+  end
+end