graphiti 1.2.41 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71f32a89c9442ab11825e9fef78897d0b3a6b3b91e4cca1c714b074c6cb009b6
-  data.tar.gz: faeaaab30063200334a6e8f9d0203a4b7274d5dba2918a7ae8143e4e234cf58c
+  metadata.gz: c694cce2123c7ba03ae53b53b61b9aaa5c353681e28a93722bc73569845ea2e2
+  data.tar.gz: 2305bdf6566d1bcba126dbe893dd64f6f011367151e0a283185fba62781d0d02
 SHA512:
-  metadata.gz: c5b9868ae015f0e881940bada465fc62bf859b61921a4e2c78c7dad8f86be8ef8cb7c6826d02b5e94ad2c3d36a4c9b73c7d0b5c5a1c31cf231e8becd62da202f
-  data.tar.gz: 9f027306154a0fc833459182c14386424fcedbf196f53784c203ad0f42fb76190b890c7f7782e092d64da0cc05751a70de6eaa085543ab73dc70d55fea363c4a
+  metadata.gz: 3d9d20b0b87720079461b0ce245970da308362616cb4c21c4232fb85c585a62694f3bdb874db3cf8d80e94e02ff3078c119e0a0a46e95dbdb94e439dbf5a1af8
+  data.tar.gz: 9cf83060d95a7789351f3f0979ccf46012238975248159d8a5fccd0e457b512cfc127b3a4295c46f668b80717dfec2152fea025d00a82a1ffcdd42edde9e5c7f

data/lib/graphiti/adapters/abstract.rb

@@ -244,14 +244,15 @@ module Graphiti
       # @param scope The scope object we are chaining
       # @param [Integer] current_page The current page number
       # @param [Integer] per_page The number of results per page
+      # @param [Integer] offset The offset to start from
       # @return the scope
       #
       # @example ActiveRecord default
       #   # via kaminari gem
-      #   def paginate(scope, current_page, per_page)
+      #   def paginate(scope, current_page, per_page, offset)
       #     scope.page(current_page).per(per_page)
       #   end
-      def paginate(scope, current_page, per_page)
+      def paginate(scope, current_page, per_page, offset)
         raise "you must override #paginate in an adapter subclass"
       end
 

data/lib/graphiti/adapters/active_record.rb

@@ -184,8 +184,11 @@ module Graphiti
       end
 
       # (see Adapters::Abstract#paginate)
-      def paginate(scope, current_page, per_page)
-        scope.page(current_page).per(per_page)
+      def paginate(scope, current_page, per_page, offset)
+        scope = scope.page(current_page) if current_page
+        scope = scope.per(per_page) if per_page
+        scope = scope.padding(offset) if offset
+        scope
       end
 
       # (see Adapters::Abstract#count)

data/lib/graphiti/adapters/null.rb

@@ -178,7 +178,7 @@ module Graphiti
       end
 
       # (see Adapters::Abstract#paginate)
-      def paginate(scope, current_page, per_page)
+      def paginate(scope, current_page, per_page, offset)
         scope
       end
 

data/lib/graphiti/delegates/pagination.rb

@@ -14,11 +14,19 @@ module Graphiti
           links[:self] = pagination_link(current_page)
           links[:first] = pagination_link(1)
           links[:last] = pagination_link(last_page)
-          links[:prev] = pagination_link(current_page - 1) unless current_page == 1
-          links[:next] = pagination_link(current_page + 1) unless current_page == last_page
+          links[:prev] = pagination_link(current_page - 1) if has_previous_page?
+          links[:next] = pagination_link(current_page + 1) if has_next_page?
         end.select { |k, v| !v.nil? }
       end
 
+      def has_next_page?
+        current_page != last_page && last_page.present?
+      end
+
+      def has_previous_page?
+        current_page != 1
+      end
+
       private
 
       def pagination_params
@@ -30,13 +38,14 @@ module Graphiti
 
         uri = URI(@proxy.resource.endpoint[:url].to_s)
 
+        page_params = {
+          number: page,
+          size: page_size
+        }
+        page_params[:offset] = offset if offset
+
         # Overwrite the pagination query params with the desired page
-        uri.query = pagination_params.merge({
-          page: {
-            number: page,
-            size: page_size
-          }
-        }).to_query
+        uri.query = pagination_params.merge(page: page_params).to_query
         uri.to_s
       end
 
@@ -46,8 +55,11 @@ module Graphiti
         elsif page_size == 0 || item_count == 0
           return nil
         end
-        @last_page = (item_count / page_size)
-        @last_page += 1 if item_count % page_size > 0
+
+        count = item_count
+        count = item_count - offset if offset
+        @last_page = (count / page_size)
+        @last_page += 1 if count % page_size > 0
         @last_page
       end
 
@@ -82,6 +94,14 @@ module Graphiti
         @current_page ||= (page_param[:number] || 1).to_i
       end
 
+      def offset
+        @offset ||= begin
+          if (value = page_param[:offset])
+            value.to_i
+          end
+        end
+      end
+
       def page_size
         @page_size ||= (page_param[:size] ||
                         @proxy.resource.default_page_size ||

data/lib/graphiti/errors.rb

@@ -733,6 +733,12 @@ module Graphiti
       end
     end
 
+    class UnsupportedBeforeCursor < Base
+      def message
+        "Passing in page[before] and page[number] is not supported. Please create an issue if you need it!"
+      end
+    end
+
     class InvalidInclude < Base
       def initialize(resource, relationship)
         @resource = resource

data/lib/graphiti/hash_renderer.rb

@@ -101,6 +101,10 @@ module Graphiti
           hash[:_type] = jsonapi_type.to_s
         end
 
+        if (fields_list || []).include?(:_cursor)
+          hash[:_cursor] = cursor
+        end
+
         if (fields_list || []).include?(:__typename)
           resource_class = @resource.class
           if polymorphic_subclass?
@@ -142,6 +146,10 @@ module Graphiti
       nodes = get_nodes(serializers, opts)
       add_nodes(hash, top_level_key, options, nodes, @graphql)
       add_stats(hash, top_level_key, options, @graphql)
+      if @graphql
+        add_page_info(hash, serializers, top_level_key, options)
+      end
+
       hash
     end
 
@@ -160,7 +168,7 @@ module Graphiti
 
     def get_nodes(serializers, opts)
       if serializers.is_a?(Array)
-        serializers.map do |s|
+        serializers.each_with_index.map do |s, index|
           s.to_hash(**opts)
         end
       else
@@ -191,5 +199,31 @@ module Graphiti
         end
       end
     end
+
+    # NB - this is only for top-level right now
+    # The casing here is GQL-specific, we can update later if needed.
+    def add_page_info(hash, serializers, top_level_key, options)
+      if (fields = options[:fields].try(:[], :page_info))
+        info = {}
+
+        if fields.include?(:has_next_page)
+          info[:hasNextPage] = options[:proxy].pagination.has_next_page?
+        end
+
+        if fields.include?(:has_previous_page)
+          info[:hasPreviousPage] = options[:proxy].pagination.has_previous_page?
+        end
+
+        if fields.include?(:start_cursor)
+          info[:startCursor] = serializers.first.cursor
+        end
+
+        if fields.include?(:end_cursor)
+          info[:endCursor] = serializers.last.cursor
+        end
+
+        hash[top_level_key][:pageInfo] = info
+      end
+    end
   end
 end

data/lib/graphiti/query.rb

@@ -32,7 +32,9 @@ module Graphiti
     end
 
     def pagination_links?
-      if Graphiti.config.pagination_links_on_demand
+      if action == :find
+        false
+      elsif Graphiti.config.pagination_links_on_demand
         [true, "true"].include?(@params[:pagination_links])
       else
         Graphiti.config.pagination_links
@@ -189,12 +191,13 @@ module Graphiti
           (@params[:page] || {}).each_pair do |name, value|
             if legacy_nested?(name)
               value.each_pair do |k, v|
-                hash[k.to_sym] = v.to_i
+                hash[k.to_sym] = cast_page_param(k.to_sym, v)
               end
             elsif nested?(name)
-              hash[name.to_s.split(".").last.to_sym] = value
-            elsif top_level? && [:number, :size].include?(name.to_sym)
-              hash[name.to_sym] = value.to_i
+              param_name = name.to_s.split(".").last.to_sym
+              hash[param_name] = cast_page_param(param_name, value)
+            elsif top_level? && Scoping::Paginate::PARAMS.include?(name.to_sym)
+              hash[name.to_sym] = cast_page_param(name.to_sym, value)
             end
           end
         end
@@ -238,6 +241,18 @@ module Graphiti
 
     private
 
+    def cast_page_param(name, value)
+      if [:before, :after].include?(name)
+        decode_cursor(value)
+      else
+        value.to_i
+      end
+    end
+
+    def decode_cursor(cursor)
+      JSON.parse(Base64.decode64(cursor)).symbolize_keys
+    end
+
     # Try to find on this resource
     # If not there, follow the legacy logic of scalling all other
     # resource names/types

data/lib/graphiti/renderer.rb

@@ -66,6 +66,7 @@ module Graphiti
         options[:meta] ||= proxy.meta
         options[:meta][:stats] = proxy.stats unless proxy.stats.empty?
         options[:meta][:debug] = Debugger.to_a if debug_json?
+        options[:proxy] = proxy
 
         renderer.render(records, options)
       end

data/lib/graphiti/resource.rb

@@ -28,11 +28,12 @@ module Graphiti
       serializer
     end
 
-    def decorate_record(record)
+    def decorate_record(record, index = nil)
       unless record.instance_variable_get(:@__graphiti_serializer)
         serializer = serializer_for(record)
         record.instance_variable_set(:@__graphiti_serializer, serializer)
         record.instance_variable_set(:@__graphiti_resource, self)
+        record.instance_variable_set(:@__graphiti_index, index) if index
       end
     end
 

data/lib/graphiti/resource/configuration.rb

@@ -92,7 +92,8 @@ module Graphiti
           :relationships_writable_by_default,
           :filters_accept_nil_by_default,
           :filters_deny_empty_by_default,
-          :graphql_entrypoint
+          :graphql_entrypoint,
+          :cursor_paginatable
 
         class << self
           prepend Overrides

data/lib/graphiti/scope.rb

@@ -85,8 +85,8 @@ module Graphiti
     # Used to ensure the resource's serializer is used
     # Not one derived through the usual jsonapi-rb logic
     def assign_serializer(records)
-      records.each do |r|
-        @resource.decorate_record(r)
+      records.each_with_index do |r, index|
+        @resource.decorate_record(r, index)
       end
     end
 

data/lib/graphiti/scoping/filter.rb

@@ -171,14 +171,18 @@ module Graphiti
       type = Graphiti::Types[filter[:type]]
       array_or_string = [:string, :array].include?(type[:canonical_name])
       if (arr = value.scan(/\[.*?\]/)).present? && array_or_string
-        value = arr.map { |json|
-          begin
-            JSON.parse(json)
-          rescue
-            raise Errors::InvalidJSONArray.new(resource, value)
-          end
-        }
-        value = value[0] if value.length == 1
+        begin
+          value = arr.map { |json|
+            begin
+              JSON.parse(json)
+            rescue
+              raise Errors::InvalidJSONArray.new(resource, value)
+            end
+          }
+          value = value[0] if value.length == 1
+        rescue Errors::InvalidJSONArray => e
+          raise(e) if type[:canonical_name] == :array
+        end
       else
         value = parse_string_arrays(value, !!filter[:single])
       end

data/lib/graphiti/scoping/paginate.rb

@@ -1,6 +1,7 @@
 module Graphiti
   class Scoping::Paginate < Scoping::Base
     DEFAULT_PAGE_SIZE = 20
+    PARAMS = [:number, :size, :offset, :before, :after]
 
     def apply
       if size > resource.max_page_size
@@ -33,24 +34,67 @@ module Graphiti
 
     # Apply default pagination proc via the Resource adapter
     def apply_standard_scope
-      resource.adapter.paginate(@scope, number, size)
+      meth = resource.adapter.method(:paginate)
+
+      if meth.arity == 4 # backwards-compat
+        resource.adapter.paginate(@scope, number, size, offset)
+      else
+        resource.adapter.paginate(@scope, number, size)
+      end
     end
 
     # Apply the custom pagination proc
     def apply_custom_scope
-      resource.instance_exec(@scope, number, size, resource.context, &custom_scope)
+      resource.instance_exec \
+        @scope,
+        number,
+        size,
+        resource.context,
+        offset,
+        &custom_scope
     end
 
     private
 
     def requested?
-      ![page_param[:size], page_param[:number]].all?(&:nil?)
+      !PARAMS.map { |p| page_param[p] }.all?(&:nil?)
     end
 
     def page_param
       @page_param ||= (query_hash[:page] || {})
     end
 
+    def offset
+      offset = nil
+
+      if (value = page_param[:offset])
+        offset = value.to_i
+      end
+
+      if before_cursor&.key?(:offset)
+        if page_param.key?(:number)
+          raise Errors::UnsupportedBeforeCursor
+        end
+
+        offset = before_cursor[:offset] - (size * number) - 1
+        offset = 0 if offset.negative?
+      end
+
+      if after_cursor&.key?(:offset)
+        offset = after_cursor[:offset]
+      end
+
+      offset
+    end
+
+    def after_cursor
+      page_param[:after]
+    end
+
+    def before_cursor
+      page_param[:before]
+    end
+
     def number
       (page_param[:number] || 1).to_i
     end

data/lib/graphiti/serializer.rb

@@ -45,6 +45,23 @@ module Graphiti
       end
     end
 
+    def cursor
+      starting_offset = 0
+      page_param = @proxy.query.pagination
+      if (page_number = page_param[:number])
+        page_size = page_param[:size] || @resource.default_page_size
+        starting_offset = (page_number - 1) * page_size
+      end
+
+      if (cursor = page_param[:after])
+        starting_offset = cursor[:offset]
+      end
+
+      current_offset = @object.instance_variable_get(:@__graphiti_index)
+      offset = starting_offset + current_offset + 1 # (+ 1 b/c o-base index)
+      Base64.encode64({offset: offset}.to_json).chomp
+    end
+
     def as_jsonapi(kwargs = {})
       super(**kwargs).tap do |hash|
         strip_relationships!(hash) if strip_relationships?

data/lib/graphiti/util/serializer_attributes.rb

@@ -28,6 +28,12 @@ module Graphiti
 
         existing = @serializer.send(applied_method)
         @serializer.send(:"#{applied_method}=", [@name] | existing)
+
+        @serializer.meta do
+          if !!@resource.try(:cursor_paginatable?) && !Graphiti.context[:graphql]
+            {cursor: cursor}
+          end
+        end
       end
 
       private

data/lib/graphiti/version.rb

@@ -1,3 +1,3 @@
 module Graphiti
-  VERSION = "1.2.41"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphiti
 version: !ruby/object:Gem::Version
-  version: 1.2.41
+  version: 1.3.0
 platform: ruby
 authors:
 - Lee Richmond
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-23 00:00:00.000000000 Z
+date: 2021-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-serializable
@@ -361,7 +361,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Easily build jsonapi.org-compatible APIs