graphql-relay 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72df43a2a611dfb93bb640fa8796d5afc308355b
-  data.tar.gz: c9bd23e5f3afd777bf8e43d538b9f53a26556a3c
+  metadata.gz: a058f8b464d8faae1b7937bee2f0da2d2f821d3b
+  data.tar.gz: 224cf4b1ea77755508505d43ae5ed15fbd9a3b0b
 SHA512:
-  metadata.gz: c276a95e9777af270a4c0affa60904cb3312c1c1a8f82031c46ffb1268bb7509ddf80275992719cb735e3f5e6de96274b9848c0bc3235c8063d4b702bcfc4459
-  data.tar.gz: eafed64a5566fa095032681a62e22527255700abf4e225abd89da7d0c5d379d43fd4641746b8afd8e1840c40ea6af23e9e2a01df16c68f4322682b0f183a123e
+  metadata.gz: 959da8064bacec3964fe0e449bcf142547ac792604ceed31636281476d817f216538fc86275b72883ae0a028bb47bfcb96219d305edd266da29317073bbb0632
+  data.tar.gz: 35373b6b9c72e102c54f23a9abc2d9dc6271c2e0d4ef3cc43e8b899cc39ce7843a71ca242653eaad77d98752d0e8f2b9aacc7e804db8dff10cb1796423bccbff

data/README.md

@@ -126,6 +126,14 @@ connection :featured_comments, CommentType.connection_type do
 end
 ```
 
+#### Maximum Page Size
+
+You can limit the number of results with `max_page_size:`:
+
+```ruby
+connection :featured_comments, CommentType.connection_type, max_page_size: 50
+```
+
 #### Connection types
 
 You can customize a connection type with `.define_connection`:
@@ -146,9 +154,9 @@ Now, `PostType.connection_type` will include a `totalCount` field.
 
 Maybe you need to make a connection object yourself (for example, to return a connection type from a mutation). You can create a connection object like this:
 
-```
-items = ...   # your collection objects
-args = {}     # stub out arguments for this connection object
+```ruby
+items = [...]     # your collection objects
+args = {}         # stub out arguments for this connection object
 connection_class = GraphQL::Relay::BaseConnection.connection_for_items(items)
 connection_class.new(items, args)
 ```
@@ -310,7 +318,6 @@ https://medium.com/@gauravtiwari/graphql-and-relay-on-rails-first-relay-powered-
 
 ## Todo
 
-- Add a `max_page_size` config for connections?
 - Refactor some RelationConnection issues:
   - fix [unbounded count in page info](https://github.com/rmosolgo/graphql-relay-ruby/blob/88b3d94f75a6dd4c8b2604743108db31f66f8dcc/lib/graphql/relay/base_connection.rb#L79-L86), [details](https://github.com/rmosolgo/graphql-relay-ruby/issues/1)
 

data/lib/graphql/relay/array_connection.rb

@@ -16,8 +16,9 @@ module GraphQL
       def paged_nodes
         @paged_nodes = begin
           items = sliced_nodes
-          first && items = items.first(first)
-          last && items.length > last && items.last(last)
+          limit = [first, last, max_page_size].compact.min
+          first && items = items.first(limit)
+          last && items.length > last && items.last(limit)
           items
         end
       end

data/lib/graphql/relay/base_connection.rb

@@ -8,6 +8,7 @@ module GraphQL
     # In a subclass, you have access to
     #   - {#object}, the object which the connection will wrap
     #   - {#first}, {#after}, {#last}, {#before} (arguments passed to the field)
+    #   - {#max_page_size} (the specified maximum page size that can be returned from a connection)
     #
     class BaseConnection
       # Just to encode data in the cursor, use something that won't conflict
@@ -60,11 +61,16 @@ module GraphQL
         CONNECTION_IMPLEMENTATIONS[items_class.name] = connection_class
       end
 
-      attr_reader :object, :arguments
+      attr_reader :object, :arguments, :max_page_size
 
-      def initialize(object, arguments)
+      # Make a connection, wrapping `object`
+      # @param The collection of results
+      # @param Query arguments
+      # @param max_page_size [Int] The maximum number of results to return
+      def initialize(object, arguments, max_page_size: nil)
         @object = object
         @arguments = arguments
+        @max_page_size = max_page_size
       end
 
       # Provide easy access to provided arguments:

data/lib/graphql/relay/connection_field.rb

@@ -27,12 +27,13 @@ module GraphQL
       # - Merging in the default arguments
       # - Transforming its resolve function to return a connection object
       # @param [GraphQL::Field] A field which returns items to be wrapped as a connection
+      # @param max_page_size [Integer] The maximum number of items which may be requested (if a larger page is requested, it is limited to this number)
       # @return [GraphQL::Field] A field which serves a connections
-      def self.create(underlying_field)
+      def self.create(underlying_field, max_page_size: nil)
         underlying_field.arguments = DEFAULT_ARGUMENTS.merge(underlying_field.arguments)
         # TODO: make a public API on GraphQL::Field to expose this proc
         original_resolve = underlying_field.instance_variable_get(:@resolve_proc)
-        underlying_field.resolve = get_connection_resolve(underlying_field.name, original_resolve)
+        underlying_field.resolve = get_connection_resolve(underlying_field.name, original_resolve, max_page_size: max_page_size)
         underlying_field
       end
 
@@ -41,14 +42,14 @@ module GraphQL
       # Wrap the original resolve proc
       # so you capture its value, then wrap it in a
       # connection implementation
-      def self.get_connection_resolve(field_name, underlying_resolve)
+      def self.get_connection_resolve(field_name, underlying_resolve, max_page_size: nil)
         -> (obj, args, ctx) {
           items = underlying_resolve.call(obj, args, ctx)
           if items == GraphQL::Query::DEFAULT_RESOLVE
             items = obj.public_send(field_name)
           end
           connection_class = GraphQL::Relay::BaseConnection.connection_for_items(items)
-          connection_class.new(items, args)
+          connection_class.new(items, args, max_page_size: max_page_size)
         }
       end
     end

data/lib/graphql/relay/monkey_patches/definition_config.rb

@@ -1,8 +1,8 @@
 class GraphQL::DefinitionHelpers::DefinedByConfig::DefinitionConfig
   # Wraps a field definition with a ConnectionField
-  def connection(name, type = nil, desc = nil, property: nil, &block)
+  def connection(name, type = nil, desc = nil, property: nil, max_page_size: nil, &block)
     underlying_field = field(name, type, desc, property: property, &block)
-    connection_field = GraphQL::Relay::ConnectionField.create(underlying_field)
+    connection_field = GraphQL::Relay::ConnectionField.create(underlying_field, max_page_size: max_page_size)
     fields[name.to_s] = connection_field
   end
 

data/lib/graphql/relay/mutation.rb

@@ -28,7 +28,7 @@ module GraphQL
     #
     #   MutationType = GraphQL::ObjectType.define do
     #     # The mutation object exposes a field:
-    #     field :updateName, UpdateNameMutation.field
+    #     field :updateName, field: UpdateNameMutation.field
     #   end
     #
     #   # Then query it:

data/lib/graphql/relay/relation_connection.rb

@@ -19,8 +19,9 @@ module GraphQL
       def paged_nodes
         @paged_nodes = begin
           items = sliced_nodes
-          first && items = items.first(first)
-          last && items.count > last && items = items.last(last)
+          limit = [first, last, max_page_size].compact.min
+          first && items = items.first(limit)
+          last && items.count > last && items = items.last(limit)
           items
         end
       end
@@ -76,7 +77,9 @@ module GraphQL
       def create_order_condition(table, column, value, direction_marker)
         table_name = ActiveRecord::Base.connection.quote_table_name(table)
         name = ActiveRecord::Base.connection.quote_column_name(column)
-        if (ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR >= 2) || ActiveRecord::VERSION::MAJOR > 4
+        if ActiveRecord::VERSION::MAJOR == 5
+          casted_value = object.table.able_to_type_cast? ? object.table.type_cast_for_database(column, value) : value
+        elsif ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR >= 2
           casted_value = object.table.engine.columns_hash[column].cast_type.type_cast_from_user(value)
         else
           casted_value = object.table.engine.columns_hash[column].type_cast(value)

data/lib/graphql/relay/version.rb

@@ -1,5 +1,5 @@
 module GraphQL
   module Relay
-    VERSION = '0.6.2'
+    VERSION = '0.7.0'
   end
 end

data/spec/graphql/relay/relation_connection_spec.rb

@@ -94,6 +94,44 @@ describe GraphQL::Relay::RelationConnection do
       result = query(query_string, "last" => 1, "nameIncludes" => "ea", "before" => before)
       assert_equal(["Death Star"], get_names(result))
     end
+
+    it "applies the maximum limit for relation connection types" do
+      limit_query_string = %|
+        query getShips($first: Int){
+          empire {
+            basesWithMaxLimitRelation(first: $first) {
+              edges {
+                node {
+                  name
+                }
+              }
+            }
+          }
+        }
+      |
+
+      result = query(limit_query_string, "first" => 3)
+      assert_equal(2, result["data"]["empire"]["basesWithMaxLimitRelation"]["edges"].size)
+    end
+
+    it "applies the maximum limit for relation connection types" do
+      limit_query_string = %|
+        query getShips($first: Int){
+          empire {
+            basesWithMaxLimitArray(first: $first) {
+              edges {
+                node {
+                  name
+                }
+              }
+            }
+          }
+        }
+      |
+
+      result = query(limit_query_string, "first" => 3)
+      assert_equal(2, result["data"]["empire"]["basesWithMaxLimitArray"]["edges"].size)
+    end
   end
 
   describe "without a block" do

data/spec/support/star_wars_schema.rb

@@ -82,6 +82,14 @@ Faction = GraphQL::ObjectType.define do
   connection :basesByName, BaseType.connection_type, property: :bases do
     argument :order, types.String, default_value: "name"
   end
+
+  connection :basesWithMaxLimitRelation, BaseType.connection_type, max_page_size: 2 do
+    resolve -> (object, args, context) { Base.all }
+  end
+
+  connection :basesWithMaxLimitArray, BaseType.connection_type, max_page_size: 2 do
+    resolve -> (object, args, context) { Base.all.to_a }
+  end
 end
 
 # Define a mutation. It will also:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-relay
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Robert Mosolgo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-11 00:00:00.000000000 Z
+date: 2016-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql