graphql_rails 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8937aa0faf2ed71af96882a43adb9518a454591784d17a1cf22e6c7486a5e90
-  data.tar.gz: a4ade684332f5d86f9bfeaf782dfad0a3d9732ef80f731ec071dd0f782ab420e
+  metadata.gz: 84843dfb2dd6c8069ceca77154dfe4f4c81322ef312c8aff9be52256fce1f24b
+  data.tar.gz: df3429323db4fd4810ea247e9336d5ede5fb8642683f777f89ce73b901144b26
 SHA512:
-  metadata.gz: 3297c4a8ecf0613b6458b10aa9ac19537e4697e95b9d984864e9ff8b28f06d4e2777402340fded49db42d48729f1d3fea6de36037a62069c80da96b0c8a9aec4
-  data.tar.gz: 2704a4e4417461da176ef7d3feb8f716b79b6677c3f25a1fcebcb42745461a444289d0b1f267a025f67db81cb8347323b05797d739bdbfedfa0f4f6eb81a65ac
+  metadata.gz: ff6b7212f18149590204f784755df54eeb2aa8fa93f2f8e242b86f203983cd2b556c5b3ae93ebef3e441cc094d750b6d3d935518eda15e54e8b775b366c979cc
+  data.tar.gz: a00e8e0f625dbfe527cfc3fcc9ec89ab83f3256e72b1ec4efc986a752dcb78c53f412880cf1b1426125be019b95126bcf6bc62025c9824006f0f02eba3017544

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphql_rails (0.2.4)
+    graphql_rails (0.3.0)
       activesupport (>= 4)
       graphql (~> 1)
 

data/README.md

@@ -47,8 +47,8 @@ class User # works with any class including ActiveRecord
     # most common attributes, like :id, :name, :title has default type, so you don't have to specify it (but you can!)
     c.attribute :id
 
-    c.attribute :email, :string
-    c.attribute :surname, :string
+    c.attribute :email, type: :string
+    c.attribute :surname, type: :string
   end
 end
 ```

data/lib/graphql_rails/controller.rb

@@ -3,6 +3,7 @@
 require 'active_support/hash_with_indifferent_access'
 require 'graphql_rails/controller/configuration'
 require 'graphql_rails/controller/request'
+require 'graphql_rails/controller/format_results'
 
 module GraphqlRails
   # base class for all graphql_rails controllers
@@ -26,15 +27,14 @@ module GraphqlRails
     end
 
     def call(method_name)
-      begin
-        self.class.controller_configuration.before_actions.each { |action_name| send(action_name) }
-        response = public_send(method_name)
-        render response if graphql_request.no_object_to_return?
-      rescue StandardError => error
-        render error: error
-      end
+      call_with_rendering(method_name)
 
-      graphql_request.object_to_return
+      FormatResults.new(
+        graphql_request.object_to_return,
+        action_config: self.class.action(method_name),
+        params: params,
+        graphql_context: graphql_request.context
+      ).call
     end
 
     protected
@@ -55,6 +55,14 @@ module GraphqlRails
 
     private
 
+    def call_with_rendering(method_name)
+      self.class.controller_configuration.before_actions.each { |action_name| send(action_name) }
+      response = public_send(method_name)
+      render response if graphql_request.no_object_to_return?
+    rescue StandardError => error
+      render error: error
+    end
+
     def grapqhl_errors_from_render_params(rendering_params)
       return [] unless rendering_params.is_a?(Hash)
       return [] if rendering_params.keys.count != 1

data/lib/graphql_rails/controller/action.rb

@@ -59,9 +59,22 @@ module GraphqlRails
       end
 
       def default_type
-        type = default_inner_return_type
-        type = type.to_list_type.to_non_null_type if route.collection?
-        type
+        return default_collection_type if route.collection?
+        default_inner_return_type
+      end
+
+      def default_collection_type
+        if action_config.paginated?
+          default_connection_type
+        else
+          default_inner_return_type.to_list_type.to_non_null_type
+        end
+      end
+
+      def default_connection_type
+        model_graphql_type.define_connection do
+          field :total, types.Int, resolve: ->(obj, _args, _ctx) { obj.nodes.size }
+        end
       end
 
       def action_relative_path

data/lib/graphql_rails/controller/action_configuration.rb

@@ -7,7 +7,7 @@ module GraphqlRails
   class Controller
     # stores all graphql_rails contoller specific config
     class ActionConfiguration
-      attr_reader :attributes, :return_type
+      attr_reader :attributes, :return_type, :pagination_options
 
       def initialize
         @attributes = {}
@@ -20,6 +20,11 @@ module GraphqlRails
         self
       end
 
+      def paginated(pagination_options = {})
+        @pagination_options = pagination_options
+        permit(:before, :after, first: :int, last: :int)
+      end
+
       def description(new_description = nil)
         if new_description
           @description = new_description
@@ -43,6 +48,10 @@ module GraphqlRails
         @can_return_nil
       end
 
+      def paginated?
+        !!pagination_options # rubocop:disable Style/DoubleNegation
+      end
+
       private
 
       def permit_attribute(name, type = nil)

data/lib/graphql_rails/controller/format_results.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module GraphqlRails
+  class Controller
+    # Convers raw controller results in to graphql-friendly format
+    class FormatResults
+      def initialize(original_result, action_config:, params:, graphql_context:)
+        @original_result = original_result
+        @action_config = action_config
+        @controller_params = params
+        @graphql_context = graphql_context
+      end
+
+      def call
+        if action_config.paginated? && original_result
+          paginated_result
+        else
+          original_result
+        end
+      end
+
+      private
+
+      attr_reader :original_result, :action_config, :controller_params, :graphql_context
+
+      def paginated_result
+        pagination_params = controller_params.slice(:first, :last, :before, :after)
+        pagination_options = action_config.pagination_options.merge(context: graphql_context)
+
+        GraphQL::Relay::BaseConnection
+          .connection_for_nodes(original_result)
+          .new(original_result, pagination_params, pagination_options)
+      end
+    end
+  end
+end

data/lib/graphql_rails/router.rb

@@ -10,7 +10,9 @@ require 'graphql_rails/router/resource_routes_builder'
 module GraphqlRails
   # graphql router that mimics Rails.application.routes
   class Router
-    RAW_ACTION_NAMES = %i[rescue_from query_analyzer instrument default_max_page_size].freeze
+    RAW_ACTION_NAMES = %i[
+      rescue_from query_analyzer instrument cursor_encoder default_max_page_size
+    ].freeze
 
     def self.draw(&block)
       router = new

data/lib/graphql_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GraphqlRails
-  VERSION = '0.2.4'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Povilas Jurčys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-11 00:00:00.000000000 Z
+date: 2018-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -110,6 +110,7 @@ files:
 - lib/graphql_rails/controller/action_configuration.rb
 - lib/graphql_rails/controller/configuration.rb
 - lib/graphql_rails/controller/controller_function.rb
+- lib/graphql_rails/controller/format_results.rb
 - lib/graphql_rails/controller/request.rb
 - lib/graphql_rails/errors/error.rb
 - lib/graphql_rails/errors/execution_error.rb