graphqr 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0fb5f222bd481b018d41ea5033bfa5402c5bbec
-  data.tar.gz: 4ba76746f0322bba9067fef162459c54dfa5340e
+  metadata.gz: 30f68dd1bcb6907786a2bd497b056fc44e5cd5ff
+  data.tar.gz: 33e51b0fe16f514a13afe9be920abd2f1adf4c5b
 SHA512:
-  metadata.gz: 518e94ce07c32774355fb55d1ca6a3b42c685685e942e6ca657eea13dec850c5c763f19c213cf75b4a976f97667fbdc0099c1406bd08ff880f3acc1616d77a30
-  data.tar.gz: 3693a00b845f41176bc1606461f72dbc09236fec9361759b6f5092b08a2ac2eec0af5cb818192b52f6c37b66969b34f6d78189d11e1c1b6522c36c8d22219b49
+  metadata.gz: d7b24cac875d94516b5dd8f08c69f4b6086310127acaa50daf0baf15427b9ad3c69edd3c711fbb7fb86f641ca0a94d7ce06260c0e5263a1ccdff25e62ef157b8
+  data.tar.gz: 3635d74b54fddd9b2753cd7d21872f4be500b4400060d899783b7c6d7ce88b09e50be1fbe56ce2c467c7fb3d715b68af276eedfd760a03f84bd283039a8eb257

data/README.md

@@ -20,6 +20,8 @@ Or install it yourself as:
 
     $ gem install graphqr
 
+If you'd like to use the pagination feature, you must have `pagy` installed.
+
 ## Usage
 
 TODO: Write usage instructions here

data/lib/graphqr/configuration.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module GraphQR # rubocop:disable Style/Documentation
+  ##
+  # TODO: add documentation
+  class Configuration
+    def configure
+      yield self
+    end
+
+    # Returns the selected paginator
+    def paginator
+      if instance_variable_defined? :@paginator
+        @paginator
+      else
+        set_paginator
+      end
+    end
+
+    ##
+    # Sets the preferred paginator
+    # TODO: support more than Pagy
+    def paginator=(paginator)
+      case paginator.to_sym
+      when :pagy
+        use_pagy
+      else
+        raise StandardError, "Unknown paginator: #{paginator}"
+      end
+    end
+
+    private
+
+    def set_paginator
+      use_pagy if defined?(Pagy)
+    end
+  end
+
+  class << self
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= Configuration.new # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
+    end
+    alias configuration config
+  end
+end

data/lib/graphqr/hooks.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+begin
+  require 'pagy'
+rescue LoadError
+  Kernel.warn 'Pagy not found'
+end

data/lib/graphqr/pagination/pagination_extension.rb

@@ -5,6 +5,8 @@ module GraphQR
     ##
     # TODO: add documentation
     class PaginationExtension < GraphQL::Schema::FieldExtension
+      DEFAULT_PAGINATION_ERROR = 'No paginator defined'
+
       def apply
         field.argument :per, 'Int', required: false, default_value: 25,
                                     description: 'The requested number of nodes for the page'
@@ -21,7 +23,9 @@ module GraphQR
       end
 
       def after_resolve(value:, arguments:, **_kwargs)
-        PaginationResolver.new(value, items: arguments[:per], page: arguments[:page])
+        raise GraphQL::ExecutionError, DEFAULT_PAGINATION_ERROR unless GraphQR.paginator.present?
+
+        Resolvers::PagyResolver.new(value, items: arguments[:per], page: arguments[:page]) if GraphQR.use_pagy?
       end
     end
   end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module GraphQR
+  module Pagination
+    module Resolvers
+      ##
+      # TODO: add documentation
+      class PagyResolver
+        include Pagy::Backend
+
+        def initialize(records, arguments)
+          @records = records
+          @arguments = arguments
+
+          @pagy, paginated_records = pagy(records, arguments)
+          @paginated_records = paginated_records.to_a
+        end
+
+        def cursor_from_node(item)
+          item.to_global_id.to_s
+        end
+
+        def edge_nodes
+          @paginated_records
+        end
+
+        def nodes
+          @paginated_records
+        end
+
+        def edges
+          @paginated_records
+        end
+
+        def page_info
+          @pagy
+        end
+      end
+    end
+  end
+end

data/lib/graphqr/version.rb

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

data/lib/graphqr.rb

@@ -1,30 +1,33 @@
 # frozen_string_literal: true
 
 require 'graphql'
-require 'pagy'
 
 ##
 # This module represents all the extensions we made to the graphql-ruby library
 # it contains helpers and integrations we need to keep our workflow as simple as possible.
 module GraphQR
   class << self
-    # Switches GraphQR on or off
-    def enabled=(value)
-      GraphQR.config.enabled = value
+    def paginator
+      GraphQR.config.paginator
     end
 
-    # Returns if GraphQR is turned on
-    def enabled?
-      GraphQR.config.enabled.present?
+    def use_pagy?
+      paginator == :pagy
     end
   end
 end
 
-require 'graphqr/fields/base_field'
+require 'graphqr/hooks'
 
+require 'graphqr/fields/base_field'
 require 'graphqr/pagination/types/pagination_page_info_type'
 require 'graphqr/pagination/pagination_extension'
-require 'graphqr/pagination/pagination_resolver'
+
+begin
+  require 'graphqr/pagination/resolvers/pagy_resolver'
+rescue NameError
+  Kernel.warn 'Pagy not found'
+end
 
 require 'graphqr/apply_scopes'
 require 'graphqr/authorized'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphqr
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Manuel Puyol
@@ -32,26 +32,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
-- !ruby/object:Gem::Dependency
-  name: pagy
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -165,10 +145,12 @@ files:
 - lib/graphqr/apply_scopes.rb
 - lib/graphqr/authorized.rb
 - lib/graphqr/base.rb
+- lib/graphqr/configuration.rb
 - lib/graphqr/fields/base_field.rb
+- lib/graphqr/hooks.rb
 - lib/graphqr/pagination.rb
 - lib/graphqr/pagination/pagination_extension.rb
-- lib/graphqr/pagination/pagination_resolver.rb
+- lib/graphqr/pagination/resolvers/pagy_resolver.rb
 - lib/graphqr/pagination/types/pagination_page_info_type.rb
 - lib/graphqr/permitted_fields_extension.rb
 - lib/graphqr/query_field.rb

data/lib/graphqr/pagination/pagination_resolver.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module GraphQR
-  module Pagination
-    ##
-    # TODO: add documentation
-    class PaginationResolver
-      include Pagy::Backend
-
-      def initialize(records, arguments)
-        @records = records
-        @arguments = arguments
-
-        @pagy, paginated_records = pagy(records, arguments)
-        @paginated_records = paginated_records.to_a
-      end
-
-      def cursor_from_node(item)
-        item.to_global_id.to_s
-      end
-
-      def edge_nodes
-        @paginated_records
-      end
-
-      def nodes
-        @paginated_records
-      end
-
-      def edges
-        @paginated_records
-      end
-
-      def page_info
-        @pagy
-      end
-    end
-  end
-end