graphql-page_cursors 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff87f78e643f6c03c976c91e44d541ccfdb3f9dd1f45614bf9113e048f7125c2
-  data.tar.gz: 1d0ee957ef5f769cf006e06f88a89fd0481aa5842b6830d1d70dcc0c8fdedf3f
+  metadata.gz: 86e6f9c53e954f6da661bd84e583650bf1238c9c20708e7d8b271670d9132917
+  data.tar.gz: b145ce2ebc6d45729da5adfe14901cd992f6dec597ca3c84537015b361cc0389
 SHA512:
-  metadata.gz: 9334ae540c56fc0ee2cc9e928e1e17b45f65bf54660162746d1fab70e07a89b1cab4e21122a0d9526575366748765cfe0079b6146d38a2f2f3b517fb92107fcd
-  data.tar.gz: 00ec1948134ea669e920e57e33d958d2455980c445e51a3e78c68e6ee6d8c58b4606d11aab0ac2855cf55caae87006624e2a8fe8eaba3303da8b540cd90eadcf
+  metadata.gz: fd4075765ff52c8d216824e21b62f265522498f196fcd07eb297c344382823ffd797e2856b07dfa9454847193fa108f67815acfe4afe41ef18dae41d06afc6a9
+  data.tar.gz: 957064f909047bb83a7761e8d75f21f31ee4bba38d47812ec6c3380f6a7b4a5ed6ed06e3f0a0becb2c02b42e76a1a128674f6a5ebf176b4bd3ae2beaaf99e821

data/.rubocop.yml

@@ -4,5 +4,9 @@ AllCops:
   NewCops: enable
   TargetRubyVersion: 2.7.1
 
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
 Style/Documentation:
   Enabled: false

data/lib/graphql/page_cursors.rb

@@ -2,6 +2,8 @@
 
 require 'graphql'
 
+require 'page_cursor_resolver'
+
 module GraphQL
   class PageCursor < GraphQL::Schema::Object
     field :cursor, String, 'first cursor on the page', null: false
@@ -21,116 +23,23 @@ module GraphQL
     field :total_pages, Int, null: true
     field :total_count, Int, null: true
 
-    MAX_CURSOR_COUNT = 5
+    attr_reader :resolver
 
-    def page_cursors
-      return if total_pages <= 1
+    def initialize(object, context)
+      super(object, context)
+      @resolver = PageCursorResolver.new(object, context)
+    end
 
-      {
-        around: around_cursors,
-        first: first_cursor,
-        last: last_cursor,
-        previous: previous_cursor
-      }.compact
+    def page_cursors
+      resolver.page_cursors
     end
 
     def total_pages
-      return 0 if object.items.size.zero?
-      return 1 if nodes_per_page.nil?
-
-      (object.items.size.to_f / nodes_per_page).ceil
+      resolver.total_pages
     end
 
     def total_count
-      object.items.size
-    end
-
-    private
-
-    def around_cursors
-      around_page_numbers.map { |page_num| page_cursor(page_num) }
-    end
-
-    def first_cursor
-      exceeds_max_cursor_count = total_pages > MAX_CURSOR_COUNT
-      include_first_cursor =
-        exceeds_max_cursor_count && around_page_numbers.exclude?(1)
-      return unless include_first_cursor
-
-      page_cursor(1)
-    end
-
-    def last_cursor
-      exceeds_max_cursor_count = total_pages > MAX_CURSOR_COUNT
-      include_last_cursor =
-        exceeds_max_cursor_count && around_page_numbers.exclude?(total_pages)
-      return unless include_last_cursor
-
-      page_cursor(total_pages)
-    end
-
-    def previous_cursor
-      include_previous_cursor = current_page > 1
-      return unless include_previous_cursor
-
-      page_cursor(current_page - 1)
-    end
-
-    def page_cursor(page_num)
-      {
-        cursor: cursor_for_page(page_num),
-        is_current: current_page == page_num,
-        page: page_num
-      }
-    end
-
-    def cursor_for_page(page_num)
-      return '' if page_num == 1
-
-      after_cursor = (page_num - 1) * nodes_per_page
-      encode(after_cursor.to_s)
-    end
-
-    def current_page
-      nodes_before / nodes_per_page + 1
-    end
-
-    def around_page_numbers # rubocop:disable Metrics/AbcSize
-      if total_pages <= MAX_CURSOR_COUNT
-        (1..total_pages).to_a
-      elsif current_page <= 3
-        (1..4).to_a
-      elsif current_page >= total_pages - 2
-        ((total_pages - 3)..total_pages).to_a
-      else
-        [current_page - 1, current_page, current_page + 1]
-      end
-    end
-
-    def nodes_before
-      node_offset(object.edge_nodes.first) - 1
-    end
-
-    def nodes_after
-      node_offset(object.edge_nodes.last)
-    end
-
-    def node_offset(node)
-      # this was previously accomplished by calling a private method:
-      # object.send(:offset_from_cursor, object.cursor_from_node(object.edge_nodes.first))
-      object.items.index(node) + 1
-    end
-
-    def nodes_per_page
-      object.first || object.last
-    end
-
-    # borrowed from https://graphql-ruby.org/api-doc/1.10.6/Base64Bp.html
-    def encode(value)
-      str = Base64.strict_encode64(value)
-      str.tr!('+/', '-_')
-      str.delete!('=')
-      str
+      resolver.total_count
     end
   end
 end

data/lib/page_cursor.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+class PageCursor
+  def self.as_hash(current_page, page_number, per_page)
+    new(current_page, page_number, per_page).to_hash
+  end
+
+  attr_reader :current_page, :page_number, :per_page
+
+  def initialize(current_page, page_number, per_page)
+    @current_page = current_page
+    @page_number = page_number
+    @per_page = per_page
+  end
+
+  def to_hash
+    {
+      cursor: encoded_cursor,
+      is_current: current?,
+      page: page_number
+    }
+  end
+
+  private
+
+  def current?
+    current_page == page_number
+  end
+
+  def encoded_cursor
+    previous_page = page_number - 1
+    return '' if previous_page.zero?
+
+    after_cursor = previous_page * per_page
+    encoded = Base64.strict_encode64(after_cursor.to_s)
+    encoded.tr('+/', '-_').delete('=')
+  end
+end

data/lib/page_cursor_resolver.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require 'page_cursor'
+
+class PageCursorResolver
+  MAX_CURSOR_COUNT = 5
+
+  attr_reader :object, :context
+
+  def initialize(object, context)
+    @object = object
+    @context = context
+  end
+
+  def page_cursors
+    return if total_pages <= 1
+
+    {
+      around: around_cursors,
+      first: first_cursor,
+      last: last_cursor,
+      previous: previous_cursor
+    }.compact
+  end
+
+  def total_pages
+    return 0 if object_items.size.zero?
+    return 1 if nodes_per_page.nil?
+
+    (object_items.size.to_f / nodes_per_page).ceil
+  end
+
+  def total_count
+    object_items.size
+  end
+
+  private
+
+  def object_items
+    return object.nodes unless object.respond_to?(:items)
+
+    object.items
+  end
+
+  def around_cursors
+    around_page_numbers.map { |page_num| page_cursor(page_num) }
+  end
+
+  def first_cursor
+    exceeds_max_cursor_count = total_pages > MAX_CURSOR_COUNT
+    include_first_cursor =
+      exceeds_max_cursor_count && !around_page_numbers.include?(1)
+    return unless include_first_cursor
+
+    page_cursor(1)
+  end
+
+  def last_cursor
+    exceeds_max_cursor_count = total_pages > MAX_CURSOR_COUNT
+    include_last_cursor =
+      exceeds_max_cursor_count && !around_page_numbers.include?(total_pages)
+    return unless include_last_cursor
+
+    page_cursor(total_pages)
+  end
+
+  def previous_cursor
+    include_previous_cursor = current_page > 1
+    return unless include_previous_cursor
+
+    page_cursor(current_page - 1)
+  end
+
+  def page_cursor(page_number)
+    PageCursor.as_hash(current_page, page_number, nodes_per_page)
+  end
+
+  def current_page
+    nodes_before / nodes_per_page + 1
+  end
+
+  def around_page_numbers # rubocop:disable Metrics/AbcSize
+    if total_pages <= MAX_CURSOR_COUNT
+      (1..total_pages).to_a
+    elsif current_page <= 3
+      (1..4).to_a
+    elsif current_page >= total_pages - 2
+      ((total_pages - 3)..total_pages).to_a
+    else
+      [current_page - 1, current_page, current_page + 1]
+    end
+  end
+
+  def nodes_before
+    node_offset(object.edge_nodes.first) - 1
+  end
+
+  def nodes_after
+    node_offset(object.edge_nodes.last)
+  end
+
+  def node_offset(node)
+    # this was previously accomplished by calling a private method:
+    # object.send(:offset_from_cursor, object.cursor_from_node(object.edge_nodes.first))
+    object_items.index(node) + 1
+  end
+
+  def nodes_per_page
+    object.first || object.last
+  end
+end

data/lib/page_cursors/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class PageCursors
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-page_cursors
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jon Allured
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-11 00:00:00.000000000 Z
+date: 2020-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -104,6 +104,8 @@ files:
 - bin/setup
 - graphql-page_cursors.gemspec
 - lib/graphql/page_cursors.rb
+- lib/page_cursor.rb
+- lib/page_cursor_resolver.rb
 - lib/page_cursors/version.rb
 homepage: https://github.com/artsy/graphql-page_cursors
 licenses: