gris_paginator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3e498dd3437d05ab8c98a4b11532efd50a94ad47
+  data.tar.gz: 51ecfe8f3116d63716843e4f49411f57e41d20b4
+SHA512:
+  metadata.gz: 97c116075f449c8ccbe5e083fd26cc93eef6e385e39f50a47ffdfe1d63c1d8cc51b73b7d1db198b13cd67d4003c338da3f112e8fb5edaae45dd10695accc1569
+  data.tar.gz: 9bffca6d2017d5b366c609336feba6903e0b817ed7dbd35bd8c58cbd78509b93cc47513a1e9beceb90e1f126cf3e12711063848f48e58091aadeed6809cc185a

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+.ruby-gemset
+.rspec

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,10 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-08-07 21:57:08 -0400 using RuboCop version 0.32.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+Style/Documentation:
+  Enabled: false

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Dylan Fareed
+
+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,3 @@
+# gris_paginator
+
+Simple pagination for Gris apps with Kaminari.

data/Rakefile

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new
+
+desc 'Run RuboCop'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+  task.options = %w(-D --auto-correct)
+end
+
+task default: [:rubocop, :spec]

data/gris_paginator.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gris_paginator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gris_paginator'
+  spec.version       = GrisPaginator::VERSION
+  spec.authors       = ['Dylan Fareed']
+  spec.email         = %w(email@dylanfareed.com)
+  spec.summary       = 'Simple pagination for Gris apps with Kaminari.'
+  spec.description   = 'Simple pagination for Gris apps with Kaminari.'
+  spec.homepage      = 'https://github.com/dylanfareed/gris-paginator'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'gris'
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'kaminari'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'database_cleaner'
+end

data/lib/gris_paginator/pagination_helpers.rb

@@ -0,0 +1,13 @@
+module GrisPaginator
+  module PaginationHelpers
+    def paginate(klass, conditions = {}, with: nil)
+      fail ArgumentError, ':with argument required' if with.nil?
+      present klass.where(conditions)
+        .page(params[:page])
+        .per(params[:size]),
+              with: with
+    end
+
+    Grape::Endpoint.send :include, self if defined? Grape
+  end
+end

data/lib/gris_paginator/version.rb

@@ -0,0 +1,3 @@
+module GrisPaginator
+  VERSION = '0.0.1'
+end

data/lib/gris_paginator.rb

@@ -0,0 +1,6 @@
+require 'gris'
+require 'kaminari/grape'
+require 'active_record'
+
+require 'gris_paginator/version'
+require 'gris_paginator/pagination_helpers'

data/spec/beaches_helper.rb

@@ -0,0 +1,26 @@
+RSpec.configure do |config|
+  config.before(:all) do
+    ActiveRecord::Base.establish_connection(
+      adapter: 'sqlite3', database: ':memory:'
+    )
+
+    ActiveRecord::Schema.define(version: 1) do
+      create_table :beaches do |t|
+        t.string :name
+      end
+    end
+
+    class Beach < ActiveRecord::Base
+    end
+
+    module BeachPresenter
+      include Gris::Presenter
+      property :name, type: String
+    end
+
+    module BeachesPresenter
+      include Gris::PaginatedPresenter
+      collection :to_a, extend: BeachPresenter, as: :beaches, embedded: true
+    end
+  end
+end

data/spec/pagination_helpers_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe GrisPaginator::PaginationHelpers do
+  let(:endpoint) do
+    Grape::Endpoint.new(
+      Grape::Util::InheritableSetting.new, path: '/', method: :get, root: false
+    )
+  end
+  let(:total_count) { 20 }
+
+  context 'paginate' do
+    before do
+      total_count.times do |index|
+        Beach.create! name: index
+      end
+      allow(endpoint).to receive(:env).and_return({})
+    end
+
+    it 'raises an ArgumentError without a presenter' do
+      expect { endpoint.paginate(Beach) }.to raise_error ArgumentError
+    end
+
+    it 'returns an ActiveRecord_Relation that responds to total_count' do
+      allow(endpoint).to receive(:params).and_return({})
+      result = endpoint.paginate(Beach, with: BeachesPresenter)
+      expect(result.class).to be Beach::ActiveRecord_Relation
+      expect(result.total_count).to eq total_count
+    end
+
+    it 'limits the result set count based on params[:size]' do
+      per_page = 10
+      allow(endpoint).to receive(:params).and_return(size: per_page)
+      result = endpoint.paginate(Beach, with: BeachesPresenter)
+      expect(result.size).to eq per_page
+      expect(result.current_page).to eq 1
+      expect(result.total_pages).to eq total_count / per_page
+      expect(result.total_count).to eq total_count
+    end
+
+    it 'jumps to the page of results corresponding to params[:page]' do
+      per_page = 2
+      page = 2
+      allow(endpoint).to receive(:params).and_return(size: per_page, page: page)
+      result = endpoint.paginate(Beach, with: BeachesPresenter)
+      expect(result.size).to eq per_page
+      expect(result.first.name).to eq '2'
+      expect(result.current_page).to eq page
+      expect(result.total_pages).to eq total_count / per_page
+      expect(result.total_count).to eq total_count
+    end
+
+    it 'filters collection based on conditions argument' do
+      allow(endpoint).to receive(:params).and_return({})
+      result = endpoint.paginate(Beach, { name: '2' }, with: BeachesPresenter)
+      expect(result.size).to eq 1
+      expect(result.first.name).to eq '2'
+      expect(result.current_page).to eq 1
+      expect(result.total_pages).to eq 1
+      expect(result.total_count).to eq 1
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'gris'
+require 'beaches_helper'
+require 'gris_paginator'
+require 'byebug'
+require 'database_cleaner'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.before do
+    DatabaseCleaner.clean
+  end
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: gris_paginator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dylan Fareed
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gris
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: rspec
+  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: byebug
+  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: rubocop
+  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: database_cleaner
+  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: Simple pagination for Gris apps with Kaminari.
+email:
+- email@dylanfareed.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- gris_paginator.gemspec
+- lib/gris_paginator.rb
+- lib/gris_paginator/pagination_helpers.rb
+- lib/gris_paginator/version.rb
+- spec/beaches_helper.rb
+- spec/pagination_helpers_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dylanfareed/gris-paginator
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Simple pagination for Gris apps with Kaminari.
+test_files:
+- spec/beaches_helper.rb
+- spec/pagination_helpers_spec.rb
+- spec/spec_helper.rb