graphql 0.17.2 → 0.18.0

data/spec/support/star_wars_schema.rb

@@ -1,76 +1,214 @@
-# Based on the graphql-js example
-# https://github.com/graphql/graphql-js/blob/master/src/__tests__/starWarsSchema.js
-require_relative "./star_wars_data"
+# Adapted from graphql-relay-js
+# https://github.com/graphql/graphql-relay-js/blob/master/src/__tests__/starWarsSchema.js
 
-EpisodeEnum = GraphQL::EnumType.define do
-  name("Episode")
-  description("One of the films in the Star Wars Trilogy.")
+# 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 -> (node_id, ctx) do
+    type_name, id = NodeIdentification.from_global_id(node_id)
+    STAR_WARS_DATA[type_name][id]
+  end
 
-  value("NEWHOPE",  "Released in 1977", value: 4)
-  value("EMPIRE",   "Released in 1980", value: 5)
-  value("JEDI",     "Released in 1983", value: 6)
+  type_from_object -> (object) do
+    if object == :test_error
+      :not_a_type
+    elsif object.is_a?(Base)
+      BaseType
+    elsif STAR_WARS_DATA["Faction"].values.include?(object)
+      Faction
+    elsif STAR_WARS_DATA["Ship"].values.include?(object)
+      Ship
+    else
+      nil
+    end
+  end
 end
 
-CharacterInterface = GraphQL::InterfaceType.define do
-  name("Character")
-  description("A character in the Star Wars Trilogy.")
+Ship = GraphQL::ObjectType.define do
+  name "Ship"
+  interfaces [NodeIdentification.interface]
+  global_id_field :id
+  field :name, types.String
+end
 
-  field :id, !types.String, "The id of the character."
-  field :name, types.String, "The name of the Character."
-  field :friends, -> { types[CharacterInterface] }, "The friends of the character, or an empty list if they have none."
-  field :appearsIn, types[EpisodeEnum], "Which movies they appear in."
+BaseType = GraphQL::ObjectType.define do
+  name "Base"
+  interfaces [NodeIdentification.interface]
+  global_id_field :id
+  field :name, types.String
+  field :planet, types.String
 end
 
-HumanType = GraphQL::ObjectType.define do
-  name("Human")
-  description("A humanoid creature in the Star Wars universe.")
-  field :id, !types.String, "The id of the human."
-  field :name, types.String, "The name of the human."
-  field :friends do
-    type(types[CharacterInterface])
-    description("The friends of the human, or an empty list if they have none.")
-    resolve(GET_FRIENDS)
+# Use an optional block to add fields to the connection type:
+BaseConnectionWithTotalCountType = BaseType.define_connection do
+  name "BasesConnectionWithTotalCount"
+  field :totalCount do
+    type types.Int
+    resolve -> (obj, args, ctx) { obj.object.count }
   end
-  field :appearsIn, types[EpisodeEnum], "Which movies they appear in."
-  field :homePlanet, types.String, "The home planet of the human, or null if unknown."
+end
 
-  interfaces([CharacterInterface])
+class CustomBaseEdge < GraphQL::Relay::Edge
+  def upcased_name
+    node.name.upcase
+  end
+
+  def upcased_parent_name
+    parent.name.upcase
+  end
 end
 
-DroidType = GraphQL::ObjectType.define do
-  name("Droid")
-  description("A mechanical creature in the Star Wars universe.")
-  field :id, !types.String, "The id of the droid."
-  field :name, types.String, "The name of the droid."
-  field :friends do
-    type(types[CharacterInterface])
-    description("The friends of the droid, or an empty list if they have none.")
-    resolve(GET_FRIENDS)
+CustomBaseEdgeType = BaseType.define_edge do
+  name "CustomBaseEdge"
+  field :upcasedName, types.String, property: :upcased_name
+  field :upcasedParentName, types.String, property: :upcased_parent_name
+  field :edgeClassName, types.String do
+    resolve -> (obj, args, ctx) { obj.class.name }
   end
-  field :appearsIn, types[EpisodeEnum], "Which movies they appear in."
-  field :primaryFunction, types.String, "The primary function of the droid."
+end
 
-  interfaces([CharacterInterface])
+CustomEdgeBaseConnectionType = BaseType.define_connection(edge_class: CustomBaseEdge, edge_type: CustomBaseEdgeType) do
+  name "CustomEdgeBaseConnection"
+
+  field :totalCountTimes100 do
+    type types.Int
+    resolve -> (obj, args, ctx) { obj.object.count * 100 }
+  end
 end
 
-class FindRecordField
-  def self.create(return_type, data)
-    GraphQL::Field.define do
-      type(return_type)
-      argument :id, !types.String, "The id of the #{return_type.name}."
-      resolve -> (obj, args, ctx) { data[args["id"]] }
-    end
+Faction = GraphQL::ObjectType.define do
+  name "Faction"
+  interfaces [NodeIdentification.interface]
+
+  field :id, !types.ID, resolve: GraphQL::Relay::GlobalIdResolve.new(type_name: "Faction", property: :id)
+  field :name, types.String
+  connection :ships, Ship.connection_type do
+    resolve -> (obj, args, ctx) {
+      all_ships = obj.ships.map {|ship_id| STAR_WARS_DATA["Ship"][ship_id] }
+      if args[:nameIncludes]
+        all_ships = all_ships.select { |ship| ship.name.include?(args[:nameIncludes])}
+      end
+      all_ships
+    }
+    # You can define arguments here and use them in the connection
+    argument :nameIncludes, types.String
+  end
+  connection :shipsWithMaxPageSize, Ship.connection_type, max_page_size: 2 do
+    resolve -> (obj, args, ctx) {
+      all_ships = obj.ships.map {|ship_id| STAR_WARS_DATA["Ship"][ship_id] }
+      if args[:nameIncludes]
+        all_ships = all_ships.select { |ship| ship.name.include?(args[:nameIncludes])}
+      end
+      all_ships
+    }
+    # You can define arguments here and use them in the connection
+    argument :nameIncludes, types.String
+  end
+
+  connection :bases, BaseConnectionWithTotalCountType do
+    # Resolve field should return an Array, the Connection
+    # will do the rest!
+    resolve -> (obj, args, ctx) {
+      all_bases = Base.where(id: obj.bases)
+      if args[:nameIncludes]
+        all_bases = all_bases.where("name LIKE ?", "%#{args[:nameIncludes]}%")
+      end
+      all_bases
+    }
+    argument :nameIncludes, types.String
+  end
+
+  connection :basesClone, BaseType.connection_type
+  connection :basesByName, BaseType.connection_type, property: :bases do
+    argument :order, types.String, default_value: "name"
+    resolve -> (obj, args, ctx) {
+      if args[:order].present?
+        obj.bases.order(args[:order])
+      else
+        obj.bases
+      end
+    }
   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
+
+  connection :basesAsSequelDataset, BaseConnectionWithTotalCountType do
+    argument :nameIncludes, types.String
+    resolve -> (obj, args, ctx) {
+      all_bases = SequelBase.where(faction_id: obj.id)
+      if args[:nameIncludes]
+        all_bases = all_bases.where("name LIKE ?", "%#{args[:nameIncludes]}%")
+      end
+      all_bases
+    }
+  end
+
+  connection :basesWithCustomEdge, CustomEdgeBaseConnectionType, property: :bases
+end
+
+# Define a mutation. It will also:
+#   - define a derived InputObjectType
+#   - define a derived ObjectType (for return)
+#   - define a field, accessible from {Mutation#field}
+#
+# The resolve proc takes `inputs, ctx`, where:
+#   - `inputs` has the keys defined with `input_field`
+#   - `ctx` is the Query context (like normal fields)
+#
+# Notice that you leave out clientMutationId.
+IntroduceShipMutation = GraphQL::Relay::Mutation.define do
+  # Used as the root for derived types:
+  name "IntroduceShip"
+  description "Add a ship to this faction"
+
+  # Nested under `input` in the query:
+  input_field :shipName, !types.String
+  input_field :factionId, !types.ID
+
+  # Result may have access to these fields:
+  return_field :ship, Ship
+  return_field :faction, Faction
+
+  # Here's the mutation operation:
+  resolve -> (inputs, ctx) {
+    faction_id = inputs["factionId"]
+    ship = STAR_WARS_DATA.create_ship(inputs["shipName"], faction_id)
+    faction = STAR_WARS_DATA["Faction"][faction_id]
+    { ship: ship, faction: faction }
+  }
 end
 
+QueryType = GraphQL::ObjectType.define do
+  name "Query"
+  field :rebels, Faction do
+    resolve -> (obj, args, ctx) { STAR_WARS_DATA["Faction"]["1"]}
+  end
 
-StarWarsQueryType = GraphQL::ObjectType.define do
-  name("Query")
-  field :hero do
-    argument :episode, EpisodeEnum,  "If omitted, returns the hero of the whole saga. If provided, returns the hero of that particular episode"
-    resolve -> (obj, args, ctx) { args["episode"] == 5 ? luke : artoo }
+  field :empire, Faction do
+    resolve -> (obj, args, ctx) { STAR_WARS_DATA["Faction"]["2"]}
   end
 
-  field :human, field: FindRecordField.create(HumanType, HUMAN_DATA)
-  field :droid, field: FindRecordField.create(DroidType, DROID_DATA)
+  field :largestBase, BaseType do
+    resolve -> (obj, args, ctx) { Base.find(3) }
+  end
+
+  field :node, field: NodeIdentification.field
+end
+
+MutationType = GraphQL::ObjectType.define do
+  name "Mutation"
+  # The mutation object exposes a field:
+  field :introduceShip, field: IntroduceShipMutation.field
 end
+
+StarWarsSchema = GraphQL::Schema.new(query: QueryType, mutation: MutationType)
+StarWarsSchema.node_identification = NodeIdentification

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql
 version: !ruby/object:Gem::Version
-  version: 0.17.2
+  version: 0.18.0
 platform: ruby
 authors:
 - Robert Mosolgo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-26 00:00:00.000000000 Z
+date: 2016-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
@@ -178,6 +178,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A GraphQL server implementation for Ruby. Includes schema definition,
   query parsing, static validation, type definition, and query execution.
 email:
@@ -200,7 +256,9 @@ files:
 - lib/graphql/boolean_type.rb
 - lib/graphql/define.rb
 - lib/graphql/define/assign_argument.rb
+- lib/graphql/define/assign_connection.rb
 - lib/graphql/define/assign_enum_value.rb
+- lib/graphql/define/assign_global_id_field.rb
 - lib/graphql/define/assign_object_field.rb
 - lib/graphql/define/assignment_dictionary.rb
 - lib/graphql/define/defined_object_proxy.rb
@@ -271,6 +329,18 @@ files:
 - lib/graphql/query/type_resolver.rb
 - lib/graphql/query/variable_validation_error.rb
 - lib/graphql/query/variables.rb
+- lib/graphql/relay.rb
+- lib/graphql/relay/array_connection.rb
+- lib/graphql/relay/base_connection.rb
+- lib/graphql/relay/connection_field.rb
+- lib/graphql/relay/connection_type.rb
+- lib/graphql/relay/edge.rb
+- lib/graphql/relay/edge_type.rb
+- lib/graphql/relay/global_id_resolve.rb
+- lib/graphql/relay/global_node_identification.rb
+- lib/graphql/relay/mutation.rb
+- lib/graphql/relay/page_info.rb
+- lib/graphql/relay/relation_connection.rb
 - lib/graphql/scalar_type.rb
 - lib/graphql/schema.rb
 - lib/graphql/schema/catchall_middleware.rb
@@ -352,6 +422,12 @@ files:
 - spec/graphql/query/type_resolver_spec.rb
 - spec/graphql/query/variables_spec.rb
 - spec/graphql/query_spec.rb
+- spec/graphql/relay/array_connection_spec.rb
+- spec/graphql/relay/connection_type_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/graphql/scalar_type_spec.rb
 - spec/graphql/schema/catchall_middleware_spec.rb
 - spec/graphql/schema/middleware_chain_spec.rb
@@ -452,6 +528,12 @@ test_files:
 - spec/graphql/query/type_resolver_spec.rb
 - spec/graphql/query/variables_spec.rb
 - spec/graphql/query_spec.rb
+- spec/graphql/relay/array_connection_spec.rb
+- spec/graphql/relay/connection_type_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/graphql/scalar_type_spec.rb
 - spec/graphql/schema/catchall_middleware_spec.rb
 - spec/graphql/schema/middleware_chain_spec.rb