jsonapi-materializer 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b51f422840742a6b80b48de2c10d75b2530a630d13e0caecb0c598f79089081e
-  data.tar.gz: ffbf502f4377b1814cb6ba7c8f7d5b3cd01d792ccc4fa047ccd1e2c448f83f19
+  metadata.gz: 9556e194a2e69b081bad43a8ddfbab23c55b9707a2250598222854943118b50c
+  data.tar.gz: 14653444ae546e3f3ecb4a4611b9739e247538b82d032a475b7931fe8a97f2ef
 SHA512:
-  metadata.gz: 6bb8dc1d59f884f503c4e6f993c331a69d41b7e7619f34fa2296f5cb0597e82cf128d55f27b15f2523e6d7ea1c603ed4cb8abb87c65da3d78dd2197484e4348e
-  data.tar.gz: 7689dec65ec8f3a81751c054345ae19e51d5ef1dd64245ce7bccc6226b373f168f69eeb1c51254f635a69d89e5ae70ea176eb708d98f7e234ef013a507c57756
+  metadata.gz: a0985c0cfcbdab3e5c6d6115838a3f30699e40a819cd4c00c2a58b9bf27181e5d5bce12d4da230e6d2c3ba9564df9e04a777a5086e5074c1bf6b757ff7b8d456
+  data.tar.gz: 82e6d60d6806c0d37c043bbe16783dacb9601eb9651c200decf078efc012292d87d36a605b55697e8c6ef8afeb0bc03bf300eca8104b1e707aadc4f18438e0d9

data/lib/jsonapi/materializer/collection.rb

@@ -13,13 +13,6 @@ module JSONAPI
       attr_writer(:includes)
       attr_writer(:pagination)
 
-      delegate(:first_page?, to: :object)
-      delegate(:prev_page, to: :object)
-      delegate(:total_pages, to: :object)
-      delegate(:next_page, to: :object)
-      delegate(:last_page?, to: :object)
-      delegate(:limit_value, to: :object)
-
       def as_json(*)
         {
           links: pagination,
@@ -55,11 +48,11 @@ module JSONAPI
       private def pagination
         if @pagination
           {
-            first: (pagination_link_template.expand(offset: 1, limit: limit_value).to_s unless total_pages.zero? || first_page?),
-            prev: (pagination_link_template.expand(offset: prev_page, limit: limit_value).to_s unless total_pages.zero? || first_page?),
-            self: (self_link_template unless total_pages.zero?),
-            next: (pagination_link_template.expand(offset: next_page, limit: limit_value).to_s unless total_pages.zero? || last_page?),
-            last: (pagination_link_template.expand(offset: total_pages, limit: limit_value).to_s unless total_pages.zero? || last_page?)
+            first: (pagination_link_template.expand(offset: 1, limit: @pagination.in).to_s unless @pagination.pages.zero? || @pagination.prev.nil?),
+            prev: (pagination_link_template.expand(offset: @pagination.prev, limit: @pagination.in).to_s unless @pagination.pages.zero? || @pagination.prev.nil?),
+            self: (pagination_link_template.expand(offset: @pagination.page, limit: @pagination.in).to_s unless @pagination.pages.zero?),
+            next: (pagination_link_template.expand(offset: @pagination.next, limit: @pagination.in).to_s unless @pagination.pages.zero? || @pagination.next.nil?),
+            last: (pagination_link_template.expand(offset: @pagination.pages, limit: @pagination.in).to_s unless @pagination.pages.zero? || @pagination.next.nil?)
           }.compact
         else
           {}
@@ -93,9 +86,8 @@ module JSONAPI
               end
             end
           end
-        end.uniq.map(&:as_data)
+        end.uniq.compact.map(&:as_data)
       end
-      # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
     end
   end
 end

data/lib/jsonapi/materializer/collection_spec.rb

@@ -2,9 +2,26 @@
 
 require("spec_helper")
 
+PaginationAdapter = Struct.new(:in, :page, :pages, :prev, :next)
+
 RSpec.describe(JSONAPI::Materializer::Collection) do
   let(:described_class) { ArticleMaterializer::Collection }
-  let(:collection) { described_class.new(object:, includes: [["comments"], ["author"]]) }
+  let(:collection) do
+    described_class.new(
+      object:,
+      includes: [["comments"], ["author"]],
+      pagination:
+    )
+  end
+  let(:pagination) do
+    PaginationAdapter.new(
+      10, # items in page
+      9, # current page
+      10, # total pages
+      100, # previous page
+      80 # next page
+    )
+  end
 
   describe("#as_json") do
     subject { collection.as_json.deep_stringify_keys }
@@ -54,12 +71,84 @@ RSpec.describe(JSONAPI::Materializer::Collection) do
                                             }]))
       end
 
-      it("has a links key at root with pagination") do
-        expect(subject.fetch("links")).to(eq(
-                                            "self" => "http://example.com/articles",
-                                            "next" => "http://example.com/articles?page[offset]=2&page[limit]=1",
-                                            "last" => "http://example.com/articles?page[offset]=3&page[limit]=1"
-                                          ))
+      context("when on the first page") do
+        let(:pagination) do
+          PaginationAdapter.new(
+            10, # items in page
+            1, # current page
+            10, # total pages
+            nil, # previous page
+            2 # next page
+          )
+        end
+
+        it("has a links key at root with pagination") do
+          expect(subject.fetch("links")).to(eq(
+                                              "last" => "http://example.com/articles?page[offset]=10&page[limit]=10",
+                                              "next" => "http://example.com/articles?page[offset]=2&page[limit]=10",
+                                              "self" => "http://example.com/articles?page[offset]=1&page[limit]=10"
+                                            ))
+        end
+      end
+
+      context("when on the last page") do
+        let(:pagination) do
+          PaginationAdapter.new(
+            10, # items in page
+            10, # current page
+            10, # total pages
+            9, # previous page
+            nil # next page
+          )
+        end
+
+        it("has a links key at root with pagination") do
+          expect(subject.fetch("links")).to(eq(
+                                              "first" => "http://example.com/articles?page[offset]=1&page[limit]=10",
+                                              "prev" => "http://example.com/articles?page[offset]=9&page[limit]=10",
+                                              "self" => "http://example.com/articles?page[offset]=10&page[limit]=10"
+                                            ))
+        end
+      end
+
+      context("when on the middle page") do
+        let(:pagination) do
+          PaginationAdapter.new(
+            10, # items in page
+            5, # current page
+            10, # total pages
+            4, # previous page
+            6 # next page
+          )
+        end
+
+        it("has a links key at root with pagination") do
+          expect(subject.fetch("links")).to(eq(
+                                              "first" => "http://example.com/articles?page[offset]=1&page[limit]=10",
+                                              "last" => "http://example.com/articles?page[offset]=10&page[limit]=10",
+                                              "next" => "http://example.com/articles?page[offset]=6&page[limit]=10",
+                                              "prev" => "http://example.com/articles?page[offset]=4&page[limit]=10",
+                                              "self" => "http://example.com/articles?page[offset]=5&page[limit]=10"
+                                            ))
+        end
+      end
+
+      context("when on the only page") do
+        let(:pagination) do
+          PaginationAdapter.new(
+            10, # items in page
+            1, # current page
+            1, # total pages
+            nil, # previous page
+            nil # next page
+          )
+        end
+
+        it("has a links key at root with pagination") do
+          expect(subject.fetch("links")).to(eq(
+                                              "self" => "http://example.com/articles?page[offset]=1&page[limit]=10"
+                                            ))
+        end
       end
 
       it("has a included key at root with included models") do

data/lib/jsonapi/materializer/resource/relation.rb

@@ -45,7 +45,6 @@ module JSONAPI
                                         end
                                       end
         end
-        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
 
         def using(parent)
           Resource::Relationship.new(related: self, parent:)

data/lib/jsonapi/materializer/resource.rb

@@ -204,7 +204,7 @@ module JSONAPI
               subject.relation(key).for(subject)
             end
           end
-        end.map(&:as_data)
+        end.compact.map(&:as_data)
       end
     end
   end

data/lib/jsonapi/materializer/version.rb

@@ -2,6 +2,6 @@
 
 module JSONAPI
   module Materializer
-    VERSION = "1.2.0"
+    VERSION = "2.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-materializer
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Kurtis Rainbolt-Greene
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-18 00:00:00.000000000 Z
+date: 2023-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport