jsonapi-materializer 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2f61a86bda571eb041aa543a16338d80c82b742708f90be0c321e45f27eb97e
-  data.tar.gz: fb22fbb7a3998c2ca6563c85a65b12980fae019feb96972523850c8074160485
+  metadata.gz: 9556e194a2e69b081bad43a8ddfbab23c55b9707a2250598222854943118b50c
+  data.tar.gz: 14653444ae546e3f3ecb4a4611b9739e247538b82d032a475b7931fe8a97f2ef
 SHA512:
-  metadata.gz: 1a27fc6d325e69296ae5ce9e73a21caf13194eba084b71f127a81574c63fe839cba0be3701b2be43f812efa7e9d22428f20891d46703eb30fe7d2cba73d2f3b8
-  data.tar.gz: 7c661026d63ac185e4f7d01db31b83547945d3903c14775273dbe06b05455a57209286efc5237c764b26853c3a8bfe733c4064aa3b081e1fd38e287a675a36c3
+  metadata.gz: a0985c0cfcbdab3e5c6d6115838a3f30699e40a819cd4c00c2a58b9bf27181e5d5bce12d4da230e6d2c3ba9564df9e04a777a5086e5074c1bf6b757ff7b8d456
+  data.tar.gz: 82e6d60d6806c0d37c043bbe16783dacb9601eb9651c200decf078efc012292d87d36a605b55697e8c6ef8afeb0bc03bf300eca8104b1e707aadc4f18438e0d9

data/lib/jsonapi/materializer/collection.rb

@@ -13,47 +13,18 @@ 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: if pagination
-                   {
-                     first: (links_pagination.expand(offset: 1, limit: limit_value).to_s unless total_pages.zero? || first_page?),
-                     prev: (links_pagination.expand(offset: prev_page, limit: limit_value).to_s unless total_pages.zero? || first_page?),
-                     self: (links_self unless total_pages.zero?),
-                     next: (links_pagination.expand(offset: next_page, limit: limit_value).to_s unless total_pages.zero? || last_page?),
-                     last: (links_pagination.expand(offset: total_pages, limit: limit_value).to_s unless total_pages.zero? || last_page?)
-                   }.compact
-                 else
-                   {}
-                 end,
-          data: resources,
-          included:
-        }.transform_values(&:presence).compact
+          links: pagination,
+          included:,
+          meta:
+        }.transform_values(&:presence).compact.merge(data: resources)
       end
 
       private def materializers
         @materializers ||= object.map { |subobject| self.class.module_parent.new(object: subobject, selects:, includes:) }
       end
 
-      private def links_pagination
-        Addressable::Template.new(
-          "#{origin}/#{type}?page[offset]={offset}&page[limit]={limit}"
-        )
-      end
-
-      private def links_self
-        Addressable::Template.new(
-          "#{origin}/#{type}"
-        ).pattern
-      end
-
       private def origin
         self.class.module_parent.instance_variable_get(:@origin)
       end
@@ -74,6 +45,36 @@ module JSONAPI
         @includes || []
       end
 
+      private def pagination
+        if @pagination
+          {
+            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
+          {}
+        end
+      end
+
+      private def pagination_link_template
+        Addressable::Template.new(
+          "#{origin}/#{type}?page[offset]={offset}&page[limit]={limit}"
+        )
+      end
+
+      private def self_link_template
+        Addressable::Template.new(
+          "#{origin}/#{type}"
+        ).pattern
+      end
+
+      private def meta
+        {}
+      end
+
       private def included
         @included ||= materializers.flat_map do |materializer|
           includes.flat_map do |path|
@@ -85,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/relationship.rb

@@ -24,8 +24,7 @@ module JSONAPI
             links: {
               self: links_self,
               related: links_related
-            },
-            meta: {}
+            }
           }.transform_values(&:presence).compact
         end
 

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.1.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.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Kurtis Rainbolt-Greene
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-08 00:00:00.000000000 Z
+date: 2023-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport