lhs 7.2.5 → 7.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c375618ed280267c2a1dbf38604b1924c43fa6e4
-  data.tar.gz: 88d0a5d78565d170db988070b4968dfe7dc9adcc
+  metadata.gz: af216b090a45a83dea5acd0a3af1492932999f59
+  data.tar.gz: a46a8f31fe3f31f577fcb97585c13f23739128da
 SHA512:
-  metadata.gz: ecf2eb96d8f92288659c89fa838567ac4125929268ff5bb63fe2a4fd46fb7723808687f0c6deefad86aa8cd128574118211f8e3e0730ef4fbae05b84014fcd95
-  data.tar.gz: bdb3fb946afc13ef8f726fbae6b1b32c2fb50be840c3fdd43bebca8812b954636ba6e150bd98b6b3c37bc94d5c9f418faa31aaa1c9bc8d57b0ebd8790d198c59
+  metadata.gz: ca258fd031bec87565cc8db528d7aeb6887719cba1bc96eb62b6a9ed09b3c70d0b3c9d99c92750bd187cf26ea70e1d381c7be641ee8c27e1fe772ef5eead1fcd
+  data.tar.gz: 863c29e31f101e9b8acb69d274998e48503d71176ac26bcd3001e18d6f05fce49daf0c85462fec705e12482b1589aedfaee8bc626056c62afea7f99e8caa21fd

data/README.md

@@ -766,6 +766,15 @@ The kaminari’s page parameter is in params[:page]. For example, you can use ka
 = paginate @items
 ```
 
+### Pagination Links
+
+When endpoints provide indicators for current page position with links (like `next` and `previous`), LHS provides some functionalities to interact/use those links/information:
+
+`next?` Tells you if there is a next link or not.
+
+`previous?` Tells you if there is a previous link or not.
+
+
 ## Automatic Detection of Collections
 
 How to configure endpoints for automatic collection detection?

data/lib/lhs/collection.rb

@@ -9,7 +9,8 @@ class LHS::Collection < LHS::Proxy
 
   delegate :select, :length, :size, to: :_collection
   delegate :_record, :_raw, to: :_data
-  delegate :limit, :count, :total, :limit, :offset, :current_page, :start, to: :_pagination
+  delegate :limit, :count, :total, :offset, :current_page, :start,
+           :next?, :previous?, to: :_pagination
 
   def _pagination
     _record.pagination(_data)

data/lib/lhs/pagination.rb

@@ -49,6 +49,14 @@ class LHS::Pagination
     total_pages
   end
 
+  def next?
+    data._raw[:next].present?
+  end
+
+  def previous?
+    data._raw[:previous].present?
+  end
+
   def prev_page
     current_page - 1
   end

data/lib/lhs/version.rb

@@ -1,3 +1,3 @@
 module LHS
-  VERSION = "7.2.5"
+  VERSION = "7.3.0"
 end

data/spec/record/pagination_links_spec.rb

@@ -0,0 +1,70 @@
+require 'rails_helper'
+
+describe LHS::Record do
+  context 'pagination links' do
+    before(:each) do
+      class Customer < LHS::Record
+        endpoint 'http://datastore/customer'
+      end
+    end
+
+    let!(:request) do
+      stub_request(:get, "http://datastore/customer#{query}")
+        .to_return(body: body)
+    end
+
+    let(:query) { "?name=#{name}&page=#{page}" }
+
+    let(:customers) do
+      Customer.where(name: name, page: page)
+    end
+
+    context 'next and previous link is present' do
+      let(:name) { 'Simpl' }
+      let(:page) { 2 }
+      let(:body) do
+        {
+          next: "http://datastore/customer?name=#{name}&page=3",
+          previous: "http://datastore/customer?name=#{name}&page=1",
+          items: [{ name: 'Simplificator' }]
+        }.to_json
+      end
+
+      it 'tells me that there is a next link' do
+        expect(customers.next?).to eq true
+        expect(customers.previous?).to eq true
+      end
+    end
+
+    context 'next link is present, previous is not' do
+      let(:name) { 'Simpl' }
+      let(:page) { 2 }
+      let(:body) do
+        {
+          next: "http://datastore/customer?name=#{name}&page=3",
+          items: [{ name: 'Simplificator' }]
+        }.to_json
+      end
+
+      it 'tells me that there is a next link' do
+        expect(customers.next?).to eq true
+        expect(customers.previous?).to eq false
+      end
+    end
+
+    context 'no next link and no previous link is present' do
+      let(:name) { 'Simplificator' }
+      let(:page) { 1 }
+      let(:body) do
+        {
+          items: [{ name: 'Simplificator' }]
+        }.to_json
+      end
+
+      it 'tells me that there is no next link' do
+        expect(customers.next?).to eq false
+        expect(customers.previous?).to eq false
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 7.2.5
+  version: 7.3.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
@@ -335,6 +335,7 @@ files:
 - spec/record/options_spec.rb
 - spec/record/paginatable_collection_spec.rb
 - spec/record/pagination_chain_spec.rb
+- spec/record/pagination_links_spec.rb
 - spec/record/pagination_spec.rb
 - spec/record/persisted_spec.rb
 - spec/record/references_spec.rb
@@ -487,6 +488,7 @@ test_files:
 - spec/record/options_spec.rb
 - spec/record/paginatable_collection_spec.rb
 - spec/record/pagination_chain_spec.rb
+- spec/record/pagination_links_spec.rb
 - spec/record/pagination_spec.rb
 - spec/record/persisted_spec.rb
 - spec/record/references_spec.rb