graphql-relay 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21069cf0c93c8778043e7e9c6fc4e4e1276ca551
-  data.tar.gz: cda365ce7b19852d7d8639344fba45c3ed0b5503
+  metadata.gz: 4efd1cd2ad74d644082dec208d0f59fee5c43973
+  data.tar.gz: 2c31b7d7c3f3661e54ec02103e622328f5c25a51
 SHA512:
-  metadata.gz: cb9fe462db0cc0f6754e5b6e671123c4d1f9306b145a560f977dfaa4d5680e83344ff12fd7a89ef8e0d774e7523a4dd1c81fe546ce481725fcc505915e3e1405
-  data.tar.gz: fec3348a276e523294f19b269b55fcd9914f7170ecd6c8bbe22813fc12f2daee76f49e581db749b0eefb2d22e37def7dc208a9c7b69207a90d7b181d206a19bb
+  metadata.gz: 7475507b89ca0adf9a061be156f06ce2a8ff96dc6b09a78f23cd1c796c862e8490feed2a0afa1a60802ded7d3384b7aedafd2a2f48a13990baafe18edc5b350d
+  data.tar.gz: 9c38cc95c267429b0047b1ee140307cef4e08bde2abe832eff76cc29e3e867b7d6b5bffad51459671bebfcec0093dbc1e6cef3f99eaeeb27e0f1d194aeb37bd1

data/README.md

@@ -23,10 +23,11 @@ bundle install
 
 Global Ids provide refetching & global identification for Relay.
 
-You should implement an object that responds to `#object_from_id(global_id)` & `#type_from_object(object)`, then pass it to `GraphQL::Relay::Node.create(implementation)`. [Example](https://github.com/rmosolgo/graphql-relay-ruby/blob/120b750cf86f1eb5c9997b588f022b2ef3a0012c/spec/support/star_wars_schema.rb#L4-L15)
+You should create `GraphQL::Relay::GlobalNodeIdentification` helper by defining `object_from_id(global_id)` & `type_from_object(object)`. The resulting object provides ID resultion methods, a find-by-global-id field and a node interface. [Example](https://github.com/rmosolgo/graphql-relay-ruby/blob/master/spec/support/star_wars_schema.rb#L9-L18)
 
-Then, you can add global id fields to your types with `global_id_field` definition helper.
- [Example](https://github.com/rmosolgo/graphql-relay-ruby/blob/master/spec/support/star_wars_schema.rb#L29)
+ObjectTypes should implement that interface with the `global_id_field` helper: [Example](https://github.com/rmosolgo/graphql-relay-ruby/blob/master/spec/support/star_wars_schema.rb#L30-L31)
+
+You should attach the field to your query type: [Example](https://github.com/rmosolgo/graphql-relay-ruby/blob/master/spec/support/star_wars_schema.rb#L121)
 
 ### Connections
 
@@ -35,9 +36,13 @@ Connections will provide arguments, pagination and `pageInfo` for `Array`s or `A
 Then, implement the field. It's different than a normal field:
   - use the `connection` helper to define it, instead of `field`
   - Call `#connection_type` on an `ObjectType` for the field's return type (eg, `ShipType.connection_type`)
-  - implement `resolve` to return an Array or an ActiveRecord::Relation, depending on the connection type.
 
-[Example 1](https://github.com/rmosolgo/graphql-relay-ruby/blob/master/spec/support/star_wars_schema.rb#L39-L51), [Example 2](https://github.com/rmosolgo/graphql-relay-ruby/blob/master/spec/support/star_wars_schema.rb#L52-L58)
+Examples:
+
+- [Connection with custom arguments](https://github.com/rmosolgo/graphql-relay-ruby/blob/master/spec/support/star_wars_schema.rb#L51-L63)
+- [Connection with a different name than the underlying property](https://github.com/rmosolgo/graphql-relay-ruby/blob/master/spec/support/star_wars_schema.rb#L77)
+
+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)
 
 ### Mutations
 
@@ -60,14 +65,15 @@ The resolve proc:
   - Must return a hash with keys matching your defined `return_field`s
 
 Examples:
-  - Definition: [example](https://github.com/rmosolgo/graphql-relay-ruby/blob/120b750cf86f1eb5c9997b588f022b2ef3a0012c/spec/support/star_wars_schema.rb#L74-L93)
-  - Mount on mutation type: [example](https://github.com/rmosolgo/graphql-relay-ruby/blob/120b750cf86f1eb5c9997b588f022b2ef3a0012c/spec/support/star_wars_schema.rb#L111)
+  - Definition: [example](https://github.com/rmosolgo/graphql-relay-ruby/blob/master/spec/support/star_wars_schema.rb#L90)
+  - Mount on mutation type: [example](https://github.com/rmosolgo/graphql-relay-ruby/blob/master/spec/support/star_wars_schema.rb#L127)
 
 ## Todo
 
-- [ ] Fix `Node.create` -- make it return one object which exposes useful info
+- Show how to replace default connection implementations with custom ones
 
 ## More Resources
 
+- [GraphQL Slack](graphql-slack.herokuapp.com), come join us in the `#ruby` channel!
 - [`graphql`](https://github.com/rmosolgo/graphql-ruby) Ruby gem
 - [`graphql-relay-js`](https://github.com/graphql/graphql-relay-js) JavaScript helpers for GraphQL and Relay

data/lib/graphql/relay.rb

@@ -4,7 +4,7 @@ require 'graphql'
 require 'graphql/relay/monkey_patches/definition_config'
 require 'graphql/relay/monkey_patches/object_type'
 
-require 'graphql/relay/node'
+require 'graphql/relay/global_node_identification'
 require 'graphql/relay/page_info'
 require 'graphql/relay/edge'
 require 'graphql/relay/base_connection'

data/lib/graphql/relay/global_id_field.rb

@@ -10,7 +10,7 @@ module GraphQL
         self.arguments = {}
         self.type = !GraphQL::ID_TYPE
         self.resolve = -> (obj, args, ctx) {
-          Node.to_global_id(type_name, obj.public_send(property))
+          GraphQL::Relay::GlobalNodeIdentification.to_global_id(type_name, obj.public_send(property))
         }
       end
     end

data/lib/graphql/relay/global_node_identification.rb

@@ -0,0 +1,86 @@
+require 'singleton'
+module GraphQL
+  module Relay
+    # This object provides helpers for working with global IDs.
+    # It's assumed you'll only have 1!
+    # GlobalIdField depends on that, since it calls class methods
+    # which delegate to the singleton instance.
+    class GlobalNodeIdentification
+      include GraphQL::DefinitionHelpers::DefinedByConfig
+      defined_by_config :object_from_id_proc, :type_from_object_proc
+      attr_accessor :object_from_id_proc, :type_from_object_proc
+
+      class << self
+        def new(*args, &block)
+          if @instance.nil?
+            @instance = super
+          else
+            raise("Can't make a second global identifier!")
+          end
+        end
+
+        def instance
+          @instance
+        end
+
+        def from_global_id(id)
+          @instance.from_global_id(id)
+        end
+
+        def to_global_id(type_name, id)
+          @instance.to_global_id(type_name, id)
+        end
+      end
+
+      # Returns `NodeInterface`, which all Relay types must implement
+      def interface
+        @interface ||= begin
+          ident = self
+          GraphQL::InterfaceType.define do
+            name "Node"
+            field :id, !types.ID
+            resolve_type -> (obj) {
+              ident.type_from_object(obj)
+            }
+          end
+        end
+      end
+
+      # Returns a field for finding objects from a global ID, which Relay needs
+      def field
+        ident = self
+        GraphQL::Field.define do
+          type(ident.interface)
+          argument :id, !types.ID
+          resolve -> (obj, args, ctx) {
+            ident.object_from_id(args[:id])
+          }
+        end
+      end
+
+      # Create a global ID for type-name & ID
+      # (This is an opaque transform)
+      def to_global_id(type_name, id)
+        Base64.strict_encode64("#{type_name}-#{id}")
+      end
+
+      # Get type-name & ID from global ID
+      # (This reverts the opaque transform)
+      def from_global_id(global_id)
+        Base64.decode64(global_id).split("-")
+      end
+
+      # Use the provided config to
+      # get a type for a given object
+      def type_from_object(object)
+        @type_from_object_proc.call(object)
+      end
+
+      # Use the provided config to
+      # get an object from a UUID
+      def object_from_id(id)
+        @object_from_id_proc.call(id)
+      end
+    end
+  end
+end

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

@@ -38,4 +38,14 @@ class GraphQL::DefinitionHelpers::DefinedByConfig::DefinitionConfig
     name || raise("You must define the type's name before creating a GlobalIdField")
     field(field_name, field: GraphQL::Relay::GlobalIdField.new(name))
   end
+
+  # Support GlobalNodeIdentification
+  attr_accessor :object_from_id_proc, :type_from_object_proc
+  def object_from_id(proc)
+    @object_from_id_proc = proc
+  end
+
+  def type_from_object(proc)
+    @type_from_object_proc = proc
+  end
 end

data/lib/graphql/relay/version.rb

@@ -1,5 +1,5 @@
 module GraphQL
   module Relay
-    VERSION = '0.3.6'
+    VERSION = '0.4.0'
   end
 end

data/spec/graphql/relay/global_node_identification_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+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 } }}|)
+      expected = {"data" => {
+        "node" => {
+          "id" =>   global_id,
+          "name" => "X-Wing"
+        }
+      }}
+      assert_equal(expected, result)
+    end
+  end
+
+  describe 'to_global_id / from_global_id ' do
+    it 'Converts typename and ID to and from ID' do
+      global_id = node_identification.to_global_id("SomeType", "123")
+      type_name, id = node_identification.from_global_id(global_id)
+      assert_equal("SomeType", type_name)
+      assert_equal("123", id)
+    end
+  end
+
+  describe 'making a second instance' do
+    it 'raises an error' do
+      err = assert_raises(RuntimeError) do
+        GraphQL::Relay::GlobalNodeIdentification.define {}
+      end
+      assert_includes(err.message, "Can't make a second")
+    end
+  end
+end

data/spec/graphql/relay/mutation_spec.rb

@@ -25,7 +25,7 @@ describe GraphQL::Relay::Mutation do
         "clientMutationId" => "1234",
         "ship" => {
           "name" => "Bagel",
-          "id" => GraphQL::Relay::Node.to_global_id("Ship", "9"),
+          "id" => NodeIdentification.to_global_id("Ship", "9"),
         },
         "faction" => {"name" => STAR_WARS_DATA["Faction"]["1"].name }
       }

data/spec/support/star_wars_schema.rb

@@ -1,29 +1,33 @@
-# Taken from graphql-relay-js
+# Adapted from graphql-relay-js
 # https://github.com/graphql/graphql-relay-js/blob/master/src/__tests__/starWarsSchema.js
 
-class NodeImplementation
-  def object_from_id(id)
-    type_name, id = GraphQL::Relay::Node.from_global_id(id)
+# This object exposes helpers for working with global IDs:
+# - global id creation & "decrypting"
+# - a find-object-by-global ID field
+# - an interface for Relay ObjectTypes to implement
+# See global_node_identification.rb for the full API.
+NodeIdentification = GraphQL::Relay::GlobalNodeIdentification.define do
+  object_from_id -> (id) do
+    type_name, id = NodeIdentification.from_global_id(id)
     STAR_WARS_DATA[type_name][id]
   end
 
-  def type_from_object(object)
+  type_from_object -> (object) do
     STAR_WARS_DATA["Faction"].values.include?(object) ? Faction : Ship
   end
 end
 
-NodeInterface, NodeField = GraphQL::Relay::Node.create(NodeImplementation.new)
-
 Ship = GraphQL::ObjectType.define do
   name "Ship"
-  interfaces [NodeInterface]
+  interfaces [NodeIdentification.interface]
+  # Explict alternative to `global_id_field` helper:
   field :id, field: GraphQL::Relay::GlobalIdField.new("Ship")
   field :name, types.String
 end
 
 BaseType = GraphQL::ObjectType.define do
   name "Base"
-  interfaces [NodeInterface]
+  interfaces [NodeIdentification.interface]
   global_id_field :id
   field :name, types.String
   field :planet, types.String
@@ -41,7 +45,7 @@ end
 
 Faction = GraphQL::ObjectType.define do
   name "Faction"
-  interfaces [NodeInterface]
+  interfaces [NodeIdentification.interface]
   field :id, field: GraphQL::Relay::GlobalIdField.new("Faction")
   field :name, types.String
   connection :ships, Ship.connection_type do
@@ -114,7 +118,7 @@ QueryType = GraphQL::ObjectType.define do
     resolve -> (obj, args, ctx) { STAR_WARS_DATA["Faction"]["2"]}
   end
 
-  field :node, field: NodeField
+  field :node, field: NodeIdentification.field
 end
 
 MutationType = GraphQL::ObjectType.define do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-relay
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - Robert Mosolgo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-27 00:00:00.000000000 Z
+date: 2015-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -192,16 +192,16 @@ files:
 - lib/graphql/relay/base_connection.rb
 - lib/graphql/relay/edge.rb
 - lib/graphql/relay/global_id_field.rb
+- lib/graphql/relay/global_node_identification.rb
 - lib/graphql/relay/monkey_patches/definition_config.rb
 - lib/graphql/relay/monkey_patches/object_type.rb
 - lib/graphql/relay/mutation.rb
-- lib/graphql/relay/node.rb
 - lib/graphql/relay/page_info.rb
 - lib/graphql/relay/relation_connection.rb
 - lib/graphql/relay/version.rb
 - spec/graphql/relay/array_connection_spec.rb
+- spec/graphql/relay/global_node_identification_spec.rb
 - spec/graphql/relay/mutation_spec.rb
-- spec/graphql/relay/node_spec.rb
 - spec/graphql/relay/relation_connection_spec.rb
 - spec/spec_helper.rb
 - spec/support/star_wars_data.rb
@@ -232,8 +232,8 @@ specification_version: 4
 summary: Relay helpers for GraphQL
 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/node_spec.rb
 - spec/graphql/relay/relation_connection_spec.rb
 - spec/spec_helper.rb
 - spec/support/star_wars_data.rb

data/lib/graphql/relay/node.rb

@@ -1,64 +0,0 @@
-require 'singleton'
-module GraphQL
-  module Relay
-    # To get a `NodeField` and `NodeInterface`,
-    # define an object that responds to:
-    #   - object_from_id
-    #   - type_from_object
-    # and pass it to `Node.create`
-    #
-    class Node
-      include Singleton
-
-      # Allows you to call methods on the class
-      def self.method_missing(method_name, *args, &block)
-        if instance.respond_to?(method_name)
-          instance.send(method_name, *args, &block)
-        else
-          super
-        end
-      end
-
-      # Return interface and field using implementation
-      def create(implementation)
-        interface = create_interface(implementation)
-        field = create_field(implementation, interface)
-        [interface, field]
-      end
-
-      # Create a global ID for type-name & ID
-      # (This is an opaque transform)
-      def to_global_id(type_name, id)
-        Base64.strict_encode64("#{type_name}-#{id}")
-      end
-
-      # Get type-name & ID from global ID
-      # (This reverts the opaque transform)
-      def from_global_id(global_id)
-        Base64.decode64(global_id).split("-")
-      end
-
-      private
-
-      def create_interface(implementation)
-        GraphQL::InterfaceType.define do
-          name "Node"
-          field :id, !types.ID
-          resolve_type -> (obj) {
-            implementation.type_from_object(obj)
-          }
-        end
-      end
-
-      def create_field(implementation, interface)
-        GraphQL::Field.define do
-          type(interface)
-          argument :id, !types.ID
-          resolve -> (obj, args, ctx) {
-            implementation.object_from_id(args[:id])
-          }
-        end
-      end
-    end
-  end
-end

data/spec/graphql/relay/node_spec.rb

@@ -1,26 +0,0 @@
-require 'spec_helper'
-
-describe GraphQL::Relay::Node do
-  describe 'NodeField' do
-    it 'finds objects by id' do
-      global_id = GraphQL::Relay::Node.to_global_id("Ship", "1")
-      result = query(%|{node(id: "#{global_id}") { id, ... on Ship { name } }}|)
-      expected = {"data" => {
-        "node" => {
-          "id" =>   global_id,
-          "name" => "X-Wing"
-        }
-      }}
-      assert_equal(expected, result)
-    end
-  end
-
-  describe 'to_global_id / from_global_id ' do
-    it 'Converts typename and ID to and from ID' do
-      global_id = GraphQL::Relay::Node.to_global_id("SomeType", "123")
-      type_name, id = GraphQL::Relay::Node.from_global_id(global_id)
-      assert_equal("SomeType", type_name)
-      assert_equal("123", id)
-    end
-  end
-end