graphql-relay 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7bcced67ab9b1c147555d570968aab04fa4d695
-  data.tar.gz: 585864fd46e046a9b2566e0392732634da32e215
+  metadata.gz: 00f40fa848587c7ac0a9c6ad65500b3b22df5d6a
+  data.tar.gz: ebeaca7d3907982c6018080a7912a8586a648f32
 SHA512:
-  metadata.gz: 7048333381510bd9a4af3232e3c794cde527541ae7d6760e9bc4d46ce19773d74b905585651704138ee35be5ab58420b22c0784dc51225cbf8db53a3bb6cb163
-  data.tar.gz: 7c47839af39a5e4916496ef15259d7d9ba1b3098e3fa606d63cbe1c307fbec42ed027904709bf5e0241b4843cf78a01a26de887ee55d1d64327f3aaf3c9916ee
+  metadata.gz: 4a4c357825ab7bc6b60b9f1d32f673b1ddd1fbb40b4ce1831323937b5a3af7f6ace82536795aff425f5938d37a586f2333cc922875fdb2db471a362e4f84330d
+  data.tar.gz: 9df15d45a7005ec04d36f4352e4bd2bca0fdefbb5410291929d3d1a36adc0bb9cb93cf8b8a36ff8e69699d9e4094736e2acd4d113f052c9175d5cd03b9dc7707

data/lib/graphql/relay/base_connection.rb

@@ -2,8 +2,8 @@ module GraphQL
   module Relay
     # Subclasses must implement:
     #   - {#cursor_from_node}, which returns an opaque cursor for the given item
-    #   - {#sliced_edges}, which slices by `before` & `after`
-    #   - {#paged_edges}, which applies `first` & `last` limits
+    #   - {#sliced_nodes}, which slices by `before` & `after`
+    #   - {#paged_nodes}, which applies `first` & `last` limits
     #
     # In a subclass, you have access to
     #   - {#object}, the object which the connection will wrap

data/lib/graphql/relay/connection_field.rb

@@ -29,7 +29,7 @@ module GraphQL
       # @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.reverse_merge(DEFAULT_ARGUMENTS)
+        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)

data/lib/graphql/relay/global_node_identification.rb

@@ -6,6 +6,11 @@ module GraphQL
     # GlobalIdField depends on that, since it calls class methods
     # which delegate to the singleton instance.
     class GlobalNodeIdentification
+      class << self
+	attr_accessor :id_separator
+      end
+      self.id_separator = "-"
+
       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
@@ -54,13 +59,16 @@ module GraphQL
       # 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}")
+        if type_name.include?(self.class.id_separator) || id.include?(self.class.id_separator)
+          raise "to_global_id(#{type_name}, #{id}) contains reserved characters `#{self.class.id_separator}`"
+        end
+        Base64.strict_encode64([type_name, id].join(self.class.id_separator))
       end
 
       # Get type-name & ID from global ID
       # (This reverts the opaque transform)
       def from_global_id(global_id)
-        Base64.decode64(global_id).split("-")
+        Base64.decode64(global_id).split(self.class.id_separator)
       end
 
       # Use the provided config to

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

@@ -1,9 +1,16 @@
 class GraphQL::BaseType
   def connection_type
-    @connection_type ||= GraphQL::Relay::BaseConnection.create_type(self)
+    @connection_type ||= define_connection
   end
 
   def edge_type
     @edge_type ||= GraphQL::Relay::Edge.create_type(self)
   end
+
+  def define_connection(&block)
+    if !@connection_type.nil?
+      raise("#{name}'s connection type was already defined, can't redefine it!")
+    end
+    @connection_type = GraphQL::Relay::BaseConnection.create_type(self, &block)
+  end
 end

data/lib/graphql/relay/version.rb

@@ -1,5 +1,5 @@
 module GraphQL
   module Relay
-    VERSION = '0.5.0'
+    VERSION = '0.5.1'
   end
 end

data/spec/graphql/relay/global_node_identification_spec.rb

@@ -38,6 +38,20 @@ describe GraphQL::Relay::GlobalNodeIdentification do
     end
   end
 
+  after do
+    # Set the id_separator back to it's default after each spec, since some of
+    # them change it at runtime
+    GraphQL::Relay::GlobalNodeIdentification.id_separator = "-"
+  end
+
+  describe 'id_separator' do
+    it "allows you to change it at runtime" do
+      GraphQL::Relay::GlobalNodeIdentification.id_separator = "-zomg-"
+
+      assert_equal("-zomg-", GraphQL::Relay::GlobalNodeIdentification.id_separator)
+    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")
@@ -45,12 +59,28 @@ describe GraphQL::Relay::GlobalNodeIdentification do
       assert_equal("SomeType", type_name)
       assert_equal("123", id)
     end
+
+    it "allows you to change the id_separator" do
+      GraphQL::Relay::GlobalNodeIdentification.id_separator = "---"
+
+      global_id = node_identification.to_global_id("Type-With-UUID", "250cda0e-a89d-41cf-99e1-2872d89f1100")
+      type_name, id = node_identification.from_global_id(global_id)
+      assert_equal("Type-With-UUID", type_name)
+      assert_equal("250cda0e-a89d-41cf-99e1-2872d89f1100", id)
+    end
+
+    it "raises an error if you try and use a reserved character in the ID" do
+      err = assert_raises(RuntimeError) {
+        node_identification.to_global_id("Best-Thing", "234")
+      }
+      assert_includes err.message, "to_global_id(Best-Thing, 234) contains reserved characters `-`"
+    end
   end
 
   describe "type_from_object" do
     describe "when the return value is not a BaseType" do
       it "raises an error " do
-        err = assert_raises {
+        err = assert_raises(RuntimeError) {
           GraphQL::Relay::GlobalNodeIdentification.instance.type_from_object(:test_error)
         }
         assert_includes err.message, "not_a_type (Symbol)"

data/spec/support/star_wars_schema.rb

@@ -39,7 +39,7 @@ end
 
 # Define a connection which will wrap an ActiveRecord::Relation.
 # We use an optional block to add fields to the connection type:
-BaseConnection = GraphQL::Relay::RelationConnection.create_type(BaseType) do
+BaseType.define_connection do
   field :totalCount do
     type types.Int
     resolve -> (obj, args, ctx) { obj.object.count }
@@ -65,7 +65,7 @@ Faction = GraphQL::ObjectType.define do
     # You can define arguments here and use them in the connection
     argument :nameIncludes, types.String
   end
-  connection :bases, BaseConnection do
+  connection :bases, BaseType.connection_type do
     # Resolve field should return an Array, the Connection
     # will do the rest!
     resolve -> (obj, args, ctx) {
@@ -78,8 +78,8 @@ Faction = GraphQL::ObjectType.define do
     argument :nameIncludes, types.String
   end
 
-  connection :basesClone, BaseConnection
-  connection :basesByName, BaseConnection, property: :bases do
+  connection :basesClone, BaseType.connection_type
+  connection :basesByName, BaseType.connection_type, property: :bases do
     argument :order, types.String, default_value: "name"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-relay
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Robert Mosolgo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-19 00:00:00.000000000 Z
+date: 2015-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql