graphql-relay 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b27b8ff701421ecd919a8cb16dfe819e42925769
-  data.tar.gz: c87a89aa53e9940ca8c5cf6a822aa3f73f8fec8b
+  metadata.gz: 1038ccd66be579e1ade39b942de12fd993cbdc26
+  data.tar.gz: 278b0a2e1dbbe0ddb15669e6fcfb0e4206bbab0f
 SHA512:
-  metadata.gz: badde6bd6ab29ab7ce5ae3366163491a888e40105cfbf414bbe5c54583d8441a1103d5a8a0fb195df663b410befd9f469362cb9ba5d2dfb3991363b21abd904f
-  data.tar.gz: 9d8a4799e0a570a3be0bc58aa026c9a7e87531cd7caf17705e845f0147c97d11b2e5a10bdca0ece40cfc7994435f1d7f4f162574a31113370950a53753493dd2
+  metadata.gz: e8bf419f8e9c9c55d93a2c1efe15e3e66e81772ef04fe537046205d5d42f1c84bda9c690b3075625f6d80947d2b6fcce9df7032d98507219a70426af26db85ed
+  data.tar.gz: ee7c7e669c03577c0924838f6a985b0639ee9008a5e0fbdfaa24eec75f3913e713b41eeb362802cf42eb2f32b2fd1ac851e74efdb6a2da9c59f2d5ea9ad97dd7

data/README.md

@@ -44,6 +44,8 @@ Examples:
 
 You can also add custom fields to connection objects: [Example](https://github.com/rmosolgo/graphql-relay-ruby/blob/master/spec/support/star_wars_schema.rb#L36-L43)
 
+At runtime, `graphql-relay` chooses a connection implementation to expose a collection. `graphql-relay` provides `ArrayConnection` and `RelationConnection`, but you can also provide your own with `BaseConnection.register_connection_implementation`.
+
 ### Mutations
 
 Mutations allow Relay to mutate your system. When you define a mutation, you'll be defining:
@@ -71,6 +73,7 @@ Examples:
 ## Todo
 
 - Show how to replace default connection implementations with custom ones
+- Show how to wrap a simple field in a connection field with `ConnectionField.create`
 
 ## More Resources
 

data/lib/graphql/relay/base_connection.rb

@@ -31,7 +31,10 @@ module GraphQL
         connection_type
       end
 
-      # @return [subclass of BaseConnection] a connection wrapping `items`
+      # Find a connection implementation suitable for exposing `items`
+      #
+      # @param [Object] A collection of items (eg, Array, AR::Relation)
+      # @return [subclass of BaseConnection] a connection Class for wrapping `items`
       def self.connection_for_items(items)
         implementation = CONNECTION_IMPLEMENTATIONS.find do |items_class, connection_class|
           items.is_a?(items_class)
@@ -45,6 +48,8 @@ module GraphQL
 
       # Add `connection_class` as the connection wrapper for `items_class`
       # eg, `RelationConnection` is the implementation for `AR::Relation`
+      # @param [Class] A class representing a collection (eg, Array, AR::Relation)
+      # @param [Class] A class implementing Connection methods
       def self.register_connection_implementation(items_class, connection_class)
         CONNECTION_IMPLEMENTATIONS[items_class] = connection_class
       end
@@ -59,6 +64,16 @@ module GraphQL
       # Provide easy access to provided arguments:
       METHODS_FROM_ARGUMENTS = [:first, :after, :last, :before, :order]
 
+      # @!method first
+      #   The value passed as `first:`, if there was one
+      # @!method after
+      #   The value passed as `after:`, if there was one
+      # @!method last
+      #   The value passed as `last:`, if there was one
+      # @!method before
+      #   The value passed as `before:`, if there was one
+      # @!method order
+      #   The value passed as `order:`, if there was one
       METHODS_FROM_ARGUMENTS.each do |arg_name|
         define_method(arg_name) do
           arguments[arg_name]
@@ -77,12 +92,12 @@ module GraphQL
 
       # Used by `pageInfo`
       def has_next_page
-        first && sliced_nodes.count > first
+        !!(first && sliced_nodes.count > first)
       end
 
       # Used by `pageInfo`
       def has_previous_page
-        last && sliced_nodes.count > last
+        !!(last && sliced_nodes.count > last)
       end
 
       # An opaque operation which returns a connection-specific cursor.
@@ -93,11 +108,11 @@ module GraphQL
       private
 
       def paged_nodes
-        raise NotImplementedError, "must items for this connection after paging"
+        raise NotImplementedError, "must return items for this connection after paging"
       end
 
       def sliced_nodes
-        raise NotImplementedError, "must all items for this connection after chopping off first and last"
+        raise NotImplementedError, "must return  all items for this connection after chopping off first and last"
       end
     end
   end

data/lib/graphql/relay/connection_field.rb

@@ -1,5 +1,11 @@
 module GraphQL
   module Relay
+    # Provided a GraphQL field which returns a collection of items,
+    # `ConnectionField.create` modifies that field to expose those items
+    # as a collection.
+    #
+    # The original resolve proc is used to fetch items,
+    # then a connection implementation is fetched with {BaseConnection.connection_for_items}.
     class ConnectionField
       ARGUMENT_DEFINITIONS = [
           [:first, GraphQL::INT_TYPE],
@@ -18,8 +24,10 @@ module GraphQL
       end
 
       # Turn A GraphQL::Field into a connection by:
-      # - Merging in the default argument
+      # - 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
+      # @return [GraphQL::Field] A field which serves a connections
       def self.create(underlying_field)
         underlying_field.arguments = underlying_field.arguments.merge(DEFAULT_ARGUMENTS)
         # TODO: make a public API on GraphQL::Field to expose this proc
@@ -30,6 +38,9 @@ module GraphQL
 
       private
 
+      # 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)
         -> (obj, args, ctx) {
           items = underlying_resolve.call(obj, args, ctx)

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

@@ -1,8 +1,5 @@
 class GraphQL::DefinitionHelpers::DefinedByConfig::DefinitionConfig
   # Wraps a field definition with a ConnectionField
-  # - applies default fields
-  # - wraps the resolve proc to make a connection
-  #
   def connection(name, type = nil, desc = nil, property: nil, &block)
     underlying_field = field(name, type, desc, property: property, &block)
     connection_field = GraphQL::Relay::ConnectionField.create(underlying_field)

data/lib/graphql/relay/relation_connection.rb

@@ -11,7 +11,6 @@ module GraphQL
         @order ||= (super || "id")
       end
 
-
       private
 
       # apply first / last limit results
@@ -19,7 +18,7 @@ module GraphQL
         @paged_nodes = begin
           items = sliced_nodes
           first && items = items.first(first)
-          last && items.length > last && items.last(last)
+          last && items.count > last && items = items.last(last)
           items
         end
       end
@@ -71,6 +70,8 @@ module GraphQL
         ["#{name} #{direction_marker} ?", value]
       end
     end
+
+
     if defined?(ActiveRecord)
       BaseConnection.register_connection_implementation(ActiveRecord::Relation, RelationConnection)
     end

data/lib/graphql/relay/version.rb

@@ -1,5 +1,5 @@
 module GraphQL
   module Relay
-    VERSION = '0.4.2'
+    VERSION = '0.4.3'
   end
 end

data/spec/graphql/relay/global_node_identification_spec.rb

@@ -4,12 +4,34 @@ describe GraphQL::Relay::GlobalNodeIdentification do
   let(:node_identification) { NodeIdentification }
   describe 'NodeField' do
     it 'finds objects by id' do
-      global_id = node_identification.to_global_id("Ship", "1")
-      result = query(%|{node(id: "#{global_id}") { id, ... on Ship { name } }}|)
+      global_id = node_identification.to_global_id("Faction", "1")
+      result = query(%|{
+        node(id: "#{global_id}") {
+          id,
+          ... on Faction {
+            name
+            ships(first: 1) {
+              edges {
+               node {
+                 name
+                 }
+              }
+            }
+          }
+        }
+      }|)
       expected = {"data" => {
-        "node" => {
-          "id" =>   global_id,
-          "name" => "X-Wing"
+        "node"=>{
+          "id"=>"RmFjdGlvbi0x",
+          "name"=>"Alliance to Restore the Republic",
+          "ships"=>{
+            "edges"=>[
+              {"node"=>{
+                  "name" => "X-Wing"
+                }
+              }
+            ]
+          }
         }
       }}
       assert_equal(expected, result)

data/spec/graphql/relay/page_info_spec.rb

@@ -0,0 +1,65 @@
+require "spec_helper"
+
+describe GraphQL::Relay::PageInfo do
+  def get_page_info(result)
+    result["data"]["empire"]["bases"]["pageInfo"]
+  end
+
+  def get_last_cursor(result)
+    result["data"]["empire"]["bases"]["edges"].last["cursor"]
+  end
+
+  let(:cursor_of_last_base) {
+    result = query(query_string, "first" => 3)
+    last_cursor = get_last_cursor(result)
+  }
+
+  let(:query_string) {%|
+    query getShips($first: Int, $after: String, $last: Int, $before: String, $order: String, $nameIncludes: String){
+      empire {
+        bases(first: $first, after: $after, last: $last, before: $before, order: $order, nameIncludes: $nameIncludes) {
+          edges {
+            cursor
+          }
+          pageInfo {
+            hasNextPage
+            hasPreviousPage
+          }
+        }
+      }
+    }
+  |}
+
+  describe 'hasNextPage / hasPreviousPage' do
+    it "hasNextPage is true if there are more items" do
+      result = query(query_string, "first" => 2)
+      assert_equal(true, get_page_info(result)["hasNextPage"])
+      assert_equal(false, get_page_info(result)["hasPreviousPage"], "hasPreviousPage is false if 'last' is missing")
+
+      last_cursor = get_last_cursor(result)
+      result = query(query_string, "first" => 100, "after" => last_cursor)
+      assert_equal(false, get_page_info(result)["hasNextPage"])
+      assert_equal(false, get_page_info(result)["hasPreviousPage"])
+    end
+
+    it "hasPreviousPage if there are more items" do
+      result = query(query_string, "last" => 100, "before" => cursor_of_last_base)
+      assert_equal(false, get_page_info(result)["hasNextPage"])
+      assert_equal(false, get_page_info(result)["hasPreviousPage"])
+
+      result = query(query_string, "last" => 1, "before" => cursor_of_last_base)
+      assert_equal(false, get_page_info(result)["hasNextPage"])
+      assert_equal(true, get_page_info(result)["hasPreviousPage"])
+    end
+
+
+    it "has both if first and last are present" do
+      result = query(query_string, "last" => 1, "first" => 1, "before" => cursor_of_last_base)
+      assert_equal(true, get_page_info(result)["hasNextPage"])
+      assert_equal(true, get_page_info(result)["hasPreviousPage"])
+    end
+  end
+
+
+
+end

data/spec/graphql/relay/relation_connection_spec.rb

@@ -6,10 +6,6 @@ describe GraphQL::Relay::RelationConnection do
     names = ships.map { |e| e["node"]["name"] }
   end
 
-  def get_page_info(result)
-    result["data"]["empire"]["bases"]["pageInfo"]
-  end
-
   def get_last_cursor(result)
     result["data"]["empire"]["bases"]["edges"].last["cursor"]
   end
@@ -20,9 +16,6 @@ describe GraphQL::Relay::RelationConnection do
         empire {
           bases(first: $first, after: $after, last: $last, before: $before, order: $order, nameIncludes: $nameIncludes) {
             ... basesConnection
-            pageInfo {
-              hasNextPage
-            }
           }
         }
       }
@@ -46,14 +39,6 @@ describe GraphQL::Relay::RelationConnection do
       assert_equal(3, get_names(result).length)
     end
 
-    it 'provides pageInfo' do
-      result = query(query_string, "first" => 2)
-      assert_equal(true, get_page_info(result)["hasNextPage"])
-
-      result = query(query_string, "first" => 100)
-      assert_equal(false, get_page_info(result)["hasNextPage"])
-    end
-
     it 'provides custom fileds on the connection type' do
       result = query(query_string, "first" => 2)
       assert_equal(
@@ -72,8 +57,12 @@ describe GraphQL::Relay::RelationConnection do
       result = query(query_string, "after" => last_cursor, "first" => 2)
       assert_equal(["Headquarters"], get_names(result))
 
+      last_cursor = get_last_cursor(result)
+      result = query(query_string, "before" => last_cursor, "last" => 1)
+      assert_equal(["Shield Generator"], get_names(result))
+
       result = query(query_string, "before" => last_cursor, "last" => 2)
-      assert_equal(["Death Star"], get_names(result))
+      assert_equal(["Death Star", "Shield Generator"], get_names(result))
     end
 
     it 'paginates with order' do
@@ -97,7 +86,7 @@ describe GraphQL::Relay::RelationConnection do
       assert_equal(["Death Star", "Headquarters"], get_names(result))
 
       # After the last result, find the next 2:
-      last_cursor = result["data"]["empire"]["bases"]["edges"].last["cursor"]
+      last_cursor = get_last_cursor(result)
 
       result = query(query_string, "after" => last_cursor, "first" => 2, "order" => "name")
       assert_equal(["Shield Generator"], get_names(result))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-relay
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Robert Mosolgo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-15 00:00:00.000000000 Z
+date: 2015-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -203,6 +203,7 @@ files:
 - spec/graphql/relay/array_connection_spec.rb
 - spec/graphql/relay/global_node_identification_spec.rb
 - spec/graphql/relay/mutation_spec.rb
+- spec/graphql/relay/page_info_spec.rb
 - spec/graphql/relay/relation_connection_spec.rb
 - spec/spec_helper.rb
 - spec/support/star_wars_data.rb
@@ -235,6 +236,7 @@ test_files:
 - spec/graphql/relay/array_connection_spec.rb
 - spec/graphql/relay/global_node_identification_spec.rb
 - spec/graphql/relay/mutation_spec.rb
+- spec/graphql/relay/page_info_spec.rb
 - spec/graphql/relay/relation_connection_spec.rb
 - spec/spec_helper.rb
 - spec/support/star_wars_data.rb