graphqr 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b962a2340faac84b6f9369947841074c52c34afa
-  data.tar.gz: 36fdff3a030711d367bd9d585228bf6f40755053
+SHA256:
+  metadata.gz: 56b827169ae4fc8970f688a1405c1cfce763fdb7619e2b5d64af996ae983de74
+  data.tar.gz: 5c6b08ea0a203fb0a3e65c7ccef3cdcf511355715fd38315ae50f536d0dcee83
 SHA512:
-  metadata.gz: 5c68aeedd464b35f796312a9be00e7a909f3d99dea883637affde7a6ff349e44483326d5d6f5a5461ba7d5a191b2813f24403eebb7840b80e3b12e7b4d1d3509
-  data.tar.gz: 77739403805caf9a8974f16248a1da4bf392d08044e3a682fccb38e7e29697c1cf22d78fb6fd17a43242c359f8811c0a41739b82063896ffbe5a80d2fa7f3f75
+  metadata.gz: 6abd868b81b35aaae90b89544e66f0a8a33e75f468ed9004e0a102d331be8e7ebead88092db3dbb6bb17edc1d1b8e1de282fa64d1e597a96af069e57379a6ffe
+  data.tar.gz: 5c52447a2c4df95b8a14f3caed8b84170667302381ee0e3b8d071f4aa38b06a3d2dd5446a2c7a3be07ceaeeab04d08a49984033d4dd85e0f6bec04784d5f7029

data/lib/graphqr.rb

@@ -37,6 +37,7 @@ end
 require 'graphqr/hooks'
 
 require 'graphqr/fields/base_field'
+require 'graphqr/pagination/resolvers/record_page_number_resolver'
 require 'graphqr/pagination/types/pagination_page_info_type'
 require 'graphqr/pagination/pagination_extension'
 

data/lib/graphqr/base_resolver.rb

@@ -2,10 +2,9 @@
 
 module GraphQR
   ##
-  # @TODO doc
+  # This is the base class for all resolvers defined by the `GraphQR` gem.
+  # It includes authorization and scoping extensions defined by the gem.
   class BaseResolver < GraphQL::Schema::Resolver
-    ##
-    # @TODO doc
     include GraphQR::ApplyScopes
     include GraphQR::Policies::AuthorizeGraphQL
   end

data/lib/graphqr/base_resolvers.rb

@@ -2,10 +2,34 @@
 
 module GraphQR
   ##
-  # @TODO doc
+  # The `BaseResolvers` module defines methods used by other extensions to define resolver classes.
+  # All resolvers defined by this module's methods inherit from `GraphQR::BaseResolver`.
   module BaseResolvers
     ##
-    # @TODO doc
+    # The method defines and returns a resolver class meant for resolving a paginated ActiveRecordRelation.
+    # The returned class implements authorization, running the `PolicyProvider`'s' `index?` action
+    # and `authorized_records` scope.
+    #
+    # The defined resolver does not implement `#unscoped_collection`. Define it before adding the query to the schema**
+    #
+    # ### Params:
+    #
+    # +type_class+: the `GraphQL::Schema::Object` of the ActiveRecordRelation
+    #
+    # +scope_class+: a `GraphQL::Schema::InputObject` which defines arguments to be used by `ApplyScopes`
+    # #### Example:
+    #   ```
+    #   class ObjectScope < GraphQL::Schema::InputObject
+    #     argument :with_relation_id, ID, required: false
+    #     ...
+    #   end
+    #   ```
+    #
+    # ### Example:
+    #
+    # ```
+    # base_collection_resolver(ObjectType, ObjectScope)
+    # ```
     def base_collection_resolver(type_class, scope_class)
       Class.new(GraphQR::BaseResolver) do
         type type_class.pagination_type, null: false
@@ -25,6 +49,21 @@ module GraphQR
       end
     end
 
+    ##
+    # The method defines and returns a resolver class meant for resolving a single ActiveRecord
+    # The returned class implements authorization, running the `PolicyProvider`'s' `show`
+    #
+    # The defined resolver does not implement `#record`. Define it before adding the query to the schema**
+    #
+    # ### Params:
+    #
+    # +type_class+: the `GraphQL::Schema::Object` of the ActiveRecord
+    #
+    # ### Example:
+    #
+    # ```
+    # base_resource_resolver(ObjectType)
+    # ```
     def base_resource_resolver(type_class)
       Class.new(GraphQR::BaseResolver) do
         type type_class, null: false

data/lib/graphqr/pagination/resolvers/pagy_resolver.rb

@@ -33,7 +33,10 @@ module GraphQR
         end
 
         def page_info
-          @pagy
+          @pagy.tap do |pagy|
+            pagy.class_eval { attr_accessor :ordered_record_ids }
+            pagy.ordered_record_ids = @records&.all? { |r| r&.respond_to?(:id) } ? @records.map(&:id) : []
+          end
         end
       end
     end

data/lib/graphqr/pagination/resolvers/record_page_number_resolver.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module GraphQR
+  module Pagination
+    module Resolvers
+      ##
+      # This is a resolver that receives the id of an object and returns the page number
+      # in which the object is located.
+      class RecordPageNumberResolver < ::GraphQL::Schema::Resolver
+        INDEX_OFFSET = 1
+
+        type Int, null: true
+
+        argument :record_id, ID, required: true
+
+        def resolve(record_id:)
+          per_page = object.vars[:items]
+          records_ids = object.ordered_record_ids
+          record_index = records_ids.find_index(record_id.to_i)
+
+          return if per_page.zero? || records_ids.blank? || record_index.blank?
+
+          record_position = (record_index + INDEX_OFFSET).to_f
+          (record_position / per_page).ceil
+        end
+      end
+    end
+  end
+end

data/lib/graphqr/pagination/types/pagination_page_info_type.rb

@@ -25,6 +25,7 @@ module GraphQR
         field :next_page, Int, null: true,
                                method: :next,
                                description: 'The previous page number or nil if there is no previous page'
+        field :record_page_number, resolver: GraphQR::Pagination::Resolvers::RecordPageNumberResolver
       end
     end
   end

data/lib/graphqr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GraphQR
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphqr
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Manuel Puyol
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-18 00:00:00.000000000 Z
+date: 2020-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -152,6 +152,7 @@ files:
 - lib/graphqr/pagination.rb
 - lib/graphqr/pagination/pagination_extension.rb
 - lib/graphqr/pagination/resolvers/pagy_resolver.rb
+- lib/graphqr/pagination/resolvers/record_page_number_resolver.rb
 - lib/graphqr/pagination/types/pagination_page_info_type.rb
 - lib/graphqr/permitted_fields_extension.rb
 - lib/graphqr/policies/authorize_graphql.rb
@@ -181,8 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Extensions and helpers for graphql-ruby