gris_paginator 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e498dd3437d05ab8c98a4b11532efd50a94ad47
-  data.tar.gz: 51ecfe8f3116d63716843e4f49411f57e41d20b4
+  metadata.gz: d19f3500e6ae273b71844d13a04b6453e4ba5aab
+  data.tar.gz: 6f98a514b3ca501ce382052c3a99eb32f6eecce8
 SHA512:
-  metadata.gz: 97c116075f449c8ccbe5e083fd26cc93eef6e385e39f50a47ffdfe1d63c1d8cc51b73b7d1db198b13cd67d4003c338da3f112e8fb5edaae45dd10695accc1569
-  data.tar.gz: 9bffca6d2017d5b366c609336feba6903e0b817ed7dbd35bd8c58cbd78509b93cc47513a1e9beceb90e1f126cf3e12711063848f48e58091aadeed6809cc185a
+  metadata.gz: c9c86404edcce88d0dd8c34bc165d8ac3ea3fb41f8d4947f8294b602eab9ebf953dc9387792d49a6d19608247d1523e00846200b0095309645df3a503ec7f1b9
+  data.tar.gz: bdcb492370f82c52681e6fd658d4f725f0288f016d3990bcbea6c0c7304ace5e53c787694ce7a2028a1999685dc9fa1ada035c070eae44751dfc7a0104f80171

data/README.md

@@ -1,3 +1,49 @@
 # gris_paginator
 
-Simple pagination for Gris apps with Kaminari.
+[gris_paginator](https://github.com/dylanfareed/gris-paginator) provides a simple pagination helper for [Gris](https://github.com/artsy/gris) apps with [Kaminari](https://github.com/amatsuda/kaminari).
+
+gris_paginator is alpha software.
+
+---
+
+### Installation
+
+gris_paginator is [available as a gem on rubygems](https://rubygems.org/gems/gris_paginator), to install it run:
+
+```
+gem install gris_paginator
+```
+
+Otherwise, if your project uses [Bundler](http://bundler.io/), add gris_paginator to your Gemfile:
+
+```
+gem 'gris_paginator'
+```
+
+And run:
+
+```
+$ bundle install
+```
+
+---
+
+### Usage
+
+```ruby
+class RegistrationsEndpoint < Grape::API
+  namespace :registrations do
+    desc 'List existing registrations'
+    params do
+      requires :account_id, type: Integer, desc: 'Account ID to query for registrations.'
+      optional :sort, type: String, default: 'created_at DESC', desc: 'Sort order for registrations.'
+      optional :page, type: Integer, default: 1, desc: 'Current page.'
+      optional :size, type: Integer, default: 10, desc: 'Number of registrations to return per page.'
+    end
+    get do
+      conditions = { account_id: params[:account_id] }
+      paginate Registration, conditions: conditions, with: RegistrationsPresenter
+    end
+  end
+end
+```

data/lib/gris_paginator/pagination_helpers.rb

@@ -1,8 +1,11 @@
 module GrisPaginator
   module PaginationHelpers
-    def paginate(klass, conditions = {}, with: nil)
+    def paginate(klass, conditions: {}, sort: nil, with: nil)
       fail ArgumentError, ':with argument required' if with.nil?
-      present klass.where(conditions)
+      order = sort.blank? ? params[:sort] : sort
+      present klass
+        .order(order)
+        .where(conditions)
         .page(params[:page])
         .per(params[:size]),
               with: with

data/lib/gris_paginator/version.rb

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

data/spec/pagination_helpers_spec.rb

@@ -11,7 +11,7 @@ describe GrisPaginator::PaginationHelpers do
   context 'paginate' do
     before do
       total_count.times do |index|
-        Beach.create! name: index
+        Beach.create! name: "Playa Grande #{index}"
       end
       allow(endpoint).to receive(:env).and_return({})
     end
@@ -27,36 +27,67 @@ describe GrisPaginator::PaginationHelpers do
       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
+    context 'size' do
+      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
     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
+    context 'page' do
+      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 'Playa Grande 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
     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
+    context 'conditions' do
+      it 'filters collection based on conditions argument' do
+        allow(endpoint).to receive(:params).and_return({})
+        result = endpoint.paginate Beach,
+                                   conditions: { name: 'Playa Grande 1' },
+                                   with: BeachesPresenter
+        expect(result.size).to eq 1
+        expect(result.first.id).to eq 2
+        expect(result.first.name).to eq 'Playa Grande 1'
+        expect(result.current_page).to eq 1
+        expect(result.total_pages).to eq 1
+        expect(result.total_count).to eq 1
+      end
+    end
+
+    context 'sort' do
+      it 'orders collection by default without sort argument or sort params' do
+        allow(endpoint).to receive(:params).and_return({})
+        result = endpoint.paginate Beach, with: BeachesPresenter
+        expect(result.first.id).to eq Beach.first.id
+      end
+
+      it 'orders collection based on sort argument' do
+        allow(endpoint).to receive(:params).and_return({})
+        result = endpoint.paginate Beach, sort: 'id DESC',
+                                          with: BeachesPresenter
+        expect(result.first.id).to eq Beach.last.id
+      end
+
+      it 'orders collection based on sort params' do
+        allow(endpoint).to receive(:params).and_return(sort: 'id DESC')
+        result = endpoint.paginate Beach, with: BeachesPresenter
+        expect(result.first.id).to eq Beach.last.id
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gris_paginator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dylan Fareed