kaminari-surface 0.1.0

data/spec/acceptance/mongo_mapper_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+RSpec.describe 'MongoMapper integration' do
+  before(:context) do
+    SampleModels::MongoMapper::Widget.delete_all
+    23.times { SampleModels::MongoMapper::Widget.create }
+  end
+
+  context 'first page when no surfacing requested' do
+    subject(:widgets) { SampleModels::MongoMapper::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.to_a.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::MongoMapper::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::MongoMapper::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.to_a.size).to eq(5)
+    end
+  end
+
+  context 'last page when surfacing is 3' do
+    subject(:widgets){ SampleModels::MongoMapper::Widget.page(4).per(5).surface(3) }
+
+    it 'has 8 widgets' do
+      expect(widgets.to_a.size).to eq(8)
+    end
+  end
+
+  context 'last page when surfacing is 8 (per + remainder)' do
+    subject(:widgets) { SampleModels::MongoMapper::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.to_a.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::MongoMapper::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::MongoMapper::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/mongoid_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+RSpec.describe 'Mongoid integration' do
+  before(:context) do
+    SampleModels::Mongoid::Widget.delete_all
+    23.times { SampleModels::Mongoid::Widget.create }
+  end
+
+  context 'first page when no surfacing requested' do
+    subject(:widgets) { SampleModels::Mongoid::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.to_a.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::Mongoid::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::Mongoid::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.to_a.size).to eq(5)
+    end
+  end
+
+  context 'last page when surfacing is 3' do
+    subject(:widgets){ SampleModels::Mongoid::Widget.page(4).per(5).surface(3) }
+
+    it 'has 8 widgets' do
+      expect(widgets.to_a.size).to eq(8)
+    end
+  end
+
+  context 'last page when surfacing is 8 (per + remainder)' do
+    subject(:widgets) { SampleModels::Mongoid::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.to_a.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::Mongoid::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::Mongoid::Widget.page(1).surface(5).padding(5) } }
+
+    it 'should raise an `ArgumentError`' do
+      expect(subject).to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,112 @@
+require 'rspec'
+require 'faker'
+require 'active_record'
+require 'data_mapper'
+
+require 'kaminari/surface/version'
+require 'kaminari/surface'
+
+include Kaminari::Surface
+
+# ActiveRecord
+
+require 'kaminari/models/active_record_extension'
+::ActiveRecord::Base.send :include, Kaminari::ActiveRecordExtension
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3",
+                                        :database => ":memory:")
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :widgets do |t|
+    t.string :name
+  end
+end
+
+module SampleModels
+  module ActiveRecord
+    class Widget < ::ActiveRecord::Base
+      self.table_name = 'widgets'
+
+      before_save :generate_name
+
+      def generate_name
+        self.name ||= Faker::Commerce.product_name
+      end
+    end
+  end
+end
+
+# DataMapper
+
+require 'kaminari/data_mapper'
+
+DataMapper.setup(:default, 'sqlite::memory:')
+
+module SampleModels
+  module DataMapper
+    class Widget
+      include ::DataMapper::Resource
+
+      property :id   , Serial
+      property :name , String
+
+      before :save, :generate_name
+
+      def generate_name
+        self.name ||= Faker::Commerce.product_name
+      end
+    end
+  end
+end
+
+DataMapper.finalize
+DataMapper.auto_migrate!
+
+# Mongoid
+
+require 'mongoid'
+require 'kaminari/mongoid'
+
+Mongoid.configure do |config|
+  config.sessions = {
+    default: {
+      hosts: ['0.0.0.0:27017'],
+      database: 'kaminari_test'
+    }
+  }
+end
+
+module SampleModels
+  module Mongoid
+    class Widget
+      include ::Mongoid::Document
+
+      field :name, type: String, default: ->{ Faker::Commerce.product_name }
+    end
+  end
+end
+
+# MongoMapper
+
+require 'mongo_mapper'
+require 'kaminari/mongo_mapper'
+
+module SampleModels
+  module MongoMapper
+    class Widget
+      include ::MongoMapper::Document
+      key :name, String
+
+      before_save :generate_name
+
+      private
+      def generate_name
+        self.name ||= Faker::Commerce.product_name
+      end
+    end
+  end
+end
+
+
+MongoMapper.connection = Mongo::Connection.new '0.0.0.0', 27017
+MongoMapper.database = 'kaminari_test'

data/spec/surface/page_scope_methods_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+require 'kaminari/surface/page_scope_methods'
+require 'kaminari/models/array_extension'
+require 'pry'
+
+RSpec.describe Kaminari::Surface::PageScopeMethods do
+  let(:items) do
+    Kaminari::PaginatableArray.new((1..23).to_a)
+  end
+
+  describe '#per' do
+    context 'when called after surface' do
+      subject { ->{ items.page(1).surface(5).per(5) }}
+
+      it 'should raise an `ArgumentError`' do
+        expect(subject).to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '#padding' do
+    context 'when called after surface' do
+      subject { ->{ items.page(1).surface(5).padding(5) }}
+
+      it 'should raise an `ArgumentError`' do
+        expect(subject).to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '#surface' do
+    context 'when requesting first page with 0 surface' do
+      subject { items.page(1).per(5).surface(0) }
+
+      it 'has offset 0' do
+        expect(subject.offset_value).to eq(0)
+      end
+
+      it 'has limit 5' do
+        expect(subject.limit_value).to eq(5)
+      end
+    end
+
+    context 'when requesting last page with 0 surface' do
+      subject { items.page(5).per(5).surface(0) }
+
+      it 'has offset 20' do
+        expect(subject.offset_value).to eq(20)
+      end
+
+      it 'has limit 5' do
+        expect(subject.limit_value).to eq(5)
+      end
+    end
+
+    context 'when requesting first page with 3 surface' do
+      subject { items.page(1).per(5).surface(3) }
+
+      it 'has offset 0' do
+        expect(subject.offset_value).to eq(0)
+      end
+
+      it 'has limit 5' do
+        expect(subject.limit_value).to eq(5)
+      end
+    end
+
+    context 'when requesting last page with 3 surface' do
+      subject { items.page(4).per(5).surface(3) }
+
+      it 'has offset 15' do
+        expect(subject.offset_value).to eq(15)
+      end
+
+      it 'has limit 8' do
+        expect(subject.limit_value).to eq(8)
+      end
+    end
+  end
+
+  # The implementation of `current_page` in the surfacing extension uses a stored `per_page`
+  # value instead of the `limit_value` used in the original kaminari version since the limit
+  # value may be modified by `surface`.
+  describe '#current_page' do
+    context 'when surfacing results on the last page' do
+      subject { items.page(4).per(5).surface(5).current_page }
+      it { is_expected.to be(4) }
+    end
+
+    context 'when we exceeded the page count' do
+      subject { items.page(5).per(5).surface(5).current_page }
+      it { is_expected.to be(5) } # Still respond, but empty result set
+    end
+  end
+
+  describe '#total_pages' do
+    context 'when surfacing results' do
+      subject { items.page(1).per(5).surface(5).total_pages }
+      it { is_expected.to be(4) }
+    end
+
+    context 'without surfacing' do
+      subject { items.page(1).per(5).total_pages }
+      it { is_expected.to be(5) }
+    end
+
+    context 'with 0 surface' do
+      subject { items.page(1).per(5).surface(0).total_pages }
+      it { is_expected.to be(5) }
+    end
+  end
+
+  describe '#num_pages' do
+    context 'when surfacing results' do
+      subject { items.page(1).per(5).surface(5).num_pages }
+      it { is_expected.to be(4) }
+    end
+
+    context 'without surfacing' do
+      subject { items.page(1).per(5).num_pages }
+      it { is_expected.to be(5) }
+    end
+
+    context 'with 0 surface' do
+      subject { items.page(1).per(5).surface(0).num_pages }
+      it { is_expected.to be(5) }
+    end
+  end
+end

data/spec/surface_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'kaminari/surface'
+
+describe Kaminari::Surface do
+  it "should have a VERSION constant" do
+    expect(subject.const_get('VERSION')).to_not be_empty
+  end
+end

metadata

@@ -0,0 +1,364 @@
+--- !ruby/object:Gem::Specification
+name: kaminari-surface
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Kassemi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: 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: data_mapper
+  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: dm-sqlite-adapter
+  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: kaminari-data_mapper
+  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: mongoid
+  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: kaminari-mongoid
+  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: mongo_mapper
+  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: kaminari-mongo_mapper
+  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'
+description: An extension to Kaminari pagination that brings the final page of a search
+  results to the surface, and prevents unnecessary paging requests.
+email: jkassemi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".rdoc_options"
+- ".rspec"
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TRACKER.md
+- capture.gif
+- example/.gitignore
+- example/Gemfile
+- example/Gemfile.lock
+- example/README.rdoc
+- example/Rakefile
+- example/app/assets/javascripts/application.js
+- example/app/assets/stylesheets/application.css
+- example/app/controllers/application_controller.rb
+- example/app/controllers/products_controller.rb
+- example/app/helpers/application_helper.rb
+- example/app/models/product.rb
+- example/app/views/layouts/application.html.erb
+- example/app/views/products/index.haml
+- example/bin/bundle
+- example/bin/rails
+- example/bin/rake
+- example/bin/setup
+- example/bin/spring
+- example/config.ru
+- example/config/application.rb
+- example/config/boot.rb
+- example/config/database.yml
+- example/config/environment.rb
+- example/config/environments/development.rb
+- example/config/environments/production.rb
+- example/config/environments/test.rb
+- example/config/initializers/assets.rb
+- example/config/initializers/backtrace_silencers.rb
+- example/config/initializers/cookies_serializer.rb
+- example/config/initializers/filter_parameter_logging.rb
+- example/config/initializers/inflections.rb
+- example/config/initializers/mime_types.rb
+- example/config/initializers/session_store.rb
+- example/config/initializers/surface.rb
+- example/config/initializers/wrap_parameters.rb
+- example/config/locales/en.yml
+- example/config/routes.rb
+- example/config/secrets.yml
+- example/db/migrate/20160501023444_create_products.rb
+- example/db/schema.rb
+- example/db/seeds.rb
+- example/lib/tasks/seed.rake
+- example/public/404.html
+- example/public/422.html
+- example/public/500.html
+- example/public/favicon.ico
+- example/public/robots.txt
+- example/test/fixtures/products.yml
+- example/test/models/product_test.rb
+- example/test/test_helper.rb
+- kaminari-surface.gemspec
+- lib/kaminari/surface.rb
+- lib/kaminari/surface/data_mapper_extension.rb
+- lib/kaminari/surface/page_scope_methods.rb
+- lib/kaminari/surface/paginatable_array_extension.rb
+- lib/kaminari/surface/version.rb
+- spec/acceptance/active_record_spec.rb
+- spec/acceptance/data_mapper_spec.rb
+- spec/acceptance/mongo_mapper_spec.rb
+- spec/acceptance/mongoid_spec.rb
+- spec/spec_helper.rb
+- spec/surface/page_scope_methods_spec.rb
+- spec/surface_spec.rb
+homepage: https://github.com/jkassemi/kaminari-surface
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Surface the final search result page when desirable
+test_files:
+- spec/acceptance/active_record_spec.rb
+- spec/acceptance/data_mapper_spec.rb
+- spec/acceptance/mongo_mapper_spec.rb
+- spec/acceptance/mongoid_spec.rb
+- spec/spec_helper.rb
+- spec/surface/page_scope_methods_spec.rb
+- spec/surface_spec.rb
+has_rdoc: