lhs 3.0.5 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e701d1bc5519eb463bc09d535a131bac92fa3e8
-  data.tar.gz: 76c44ef06141cb08c4c6d2864848fd027d4174ae
+  metadata.gz: 4b4d8da57cb83a4edce0d5a3ced7289528fc3aeb
+  data.tar.gz: cd8ca6b468931ce8a677ee0ec686a04c05798d75
 SHA512:
-  metadata.gz: 9d39a7da359c587861981788a7a56e9b61deb3736d2f10882762061ee7535f3864cd48acbfe0400ed95dd1eef0eb81fc51cc045cc59d5c944f8d9d0e0ceffa91
-  data.tar.gz: 0bfd7041d113c1ed1ee8da5321ee9b8ec5d64850225ae7a2020079d1ae8ecbe177bf3df2fe92f85a49dab90f36800f61d851856e2ff6d385e9323cf1a53f968c
+  metadata.gz: 4f4f26c5cc042bf73e69c0ff021e5ce5b32d4fabf5afe8b692b5a6ececad255759aa86eda2d78a21031f0bca8481769bce809ebf45535c8eab478b8fdbea37e0
+  data.tar.gz: 9672198becdb370e7775f8a922e613ee1ee7f28936f13672b936619e582c0cec3127bec258250e2dd14fa24db439e25d02af25b2a662d34cffd81e7faf1e2f58

data/README.md

@@ -331,3 +331,19 @@ Feedback.where(limit: 50, offset: 51)
 `total` provides total amount of items (even if paginated).
 `limit` provides amount of items per page.
 `offset` provides how many items where skipped to start the current page.
+
+## Partial Kaminari support
+
+LHS implements an interface that makes it partially working with Kaminari.
+
+For example, you can use kaminari to render paginations based on LHS Records:
+
+```ruby
+# controller
+@items = Record.where(offset: offset, limit: limit)
+```
+
+```ruby
+# view
+= paginate @items
+```

data/lib/lhs/concerns/record/pagination.rb

@@ -0,0 +1,36 @@
+require 'active_support'
+
+class LHS::Record
+
+  module Pagination
+    extend ActiveSupport::Concern
+
+    def current_page
+      offset + 1
+    end
+
+    def first_page
+      1
+    end
+
+    def last_page
+      total_pages
+    end
+
+    def prev_page
+      current_page - 1
+    end
+
+    def next_page
+      current_page + 1
+    end
+
+    def limit_value
+      limit
+    end
+
+    def total_pages
+      total / limit
+    end
+  end
+end

data/lib/lhs/record.rb

@@ -13,6 +13,7 @@ class LHS::Record
   include Includes
   include Request
   include Where
+  include Pagination
 
   delegate :_proxy, to: :_data
 

data/lib/lhs/version.rb

@@ -1,3 +1,3 @@
 module LHS
-  VERSION = "3.0.5"
+  VERSION = "3.1.0"
 end

data/spec/record/pagination_spec.rb

@@ -0,0 +1,60 @@
+require 'rails_helper'
+
+describe LHS::Record do
+  context 'pagination' do
+    let(:datastore) { 'http://local.ch/v2' }
+    let(:record) { Feedback.where(entry_id: 1) }
+    let(:total) { 200 }
+    let(:total_pages) { total / limit }
+    let(:current_page) { offset + 1 }
+    let(:prev_page) { current_page - 1 }
+    let(:next_page) { current_page + 1 }
+    let(:offset) { 0 }
+    let(:limit) { 10 }
+    let(:body_json) do
+      {
+        items: [],
+        total: total,
+        offset: offset,
+        limit: limit
+      }.to_json
+    end
+
+    before(:each) do
+      LHC.config.placeholder('datastore', datastore)
+      class Feedback < LHS::Record
+        endpoint ':datastore/feedbacks'
+      end
+      stub_request(:get, 'http://local.ch/v2/feedbacks?entry_id=1')
+        .and_return(body: body_json)
+    end
+
+    it 'responds to limit_value' do
+      expect(record.limit_value).to eq(limit)
+    end
+
+    it 'responds to total_pages' do
+      expect(record.total_pages).to eq(total_pages)
+    end
+
+    it 'responds to current_page' do
+      expect(record.current_page).to eq(current_page)
+    end
+
+    it 'responds to first_page' do
+      expect(record.first_page).to eq(1)
+    end
+
+    it 'responds to last_page' do
+      expect(record.last_page).to eq(total_pages)
+    end
+
+    it 'responds to prev_page' do
+      expect(record.prev_page).to eq(prev_page)
+    end
+
+    it 'responds to next_page' do
+      expect(record.next_page).to eq(next_page)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 3.0.5
+  version: 3.1.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
@@ -165,6 +165,7 @@ files:
 - lib/lhs/concerns/record/includes.rb
 - lib/lhs/concerns/record/mapping.rb
 - lib/lhs/concerns/record/model.rb
+- lib/lhs/concerns/record/pagination.rb
 - lib/lhs/concerns/record/request.rb
 - lib/lhs/concerns/record/where.rb
 - lib/lhs/data.rb
@@ -257,6 +258,7 @@ files:
 - spec/record/mapping_spec.rb
 - spec/record/model_name_spec.rb
 - spec/record/new_spec.rb
+- spec/record/pagination_spec.rb
 - spec/record/request_spec.rb
 - spec/record/select_spec.rb
 - spec/record/to_json_spec.rb
@@ -376,6 +378,7 @@ test_files:
 - spec/record/mapping_spec.rb
 - spec/record/model_name_spec.rb
 - spec/record/new_spec.rb
+- spec/record/pagination_spec.rb
 - spec/record/request_spec.rb
 - spec/record/select_spec.rb
 - spec/record/to_json_spec.rb