require "graphql/field/resolve" module GraphQL # {Field}s belong to {ObjectType}s and {InterfaceType}s. # # They're usually created with the `field` helper. If you create it by hand, make sure {#name} is a String. # # @example creating a field # GraphQL::ObjectType.define do # field :name, types.String, "The name of this thing " # end # # @example handling a circular reference # # If the field's type isn't defined yet, you have two options: # # GraphQL::ObjectType.define do # # If you pass a Proc, it will be evaluated at schema build-time # field :city, -> { CityType } # # If you pass a String, it will be looked up in the global namespace at schema build-time # field :country, "CountryType" # end # # @example creating a field that accesses a different property on the object # GraphQL::ObjectType.define do # # use the `property` option: # field :firstName, types.String, property: :first_name # end # # @example defining a field, then attaching it to a type # name_field = GraphQL::Field.define do # name("Name") # type(!types.String) # description("The name of this thing") # resolve -> (object, arguments, context) { object.name } # end # # NamedType = GraphQL::ObjectType.define do # # use the `field` option: # field :name, field: name_field # end # # @example Custom complexity values # # Complexity can be a number or a proc. # # # Complexity can be defined with a keyword: # field :expensive_calculation, !types.Int, complexity: 10 # # # Or inside the block: # field :expensive_calculation_2, !types.Int do # complexity -> (ctx, args, child_complexity) { ctx[:current_user].staff? ? 0 : 10 } # end # # @example Calculating the complexity of a list field # field :items, types[ItemType] do # argument :limit, !types.Int # # Mulitply the child complexity by the possible items on the list # complexity -> (ctx, args, child_complexity) { child_complexity * args[:limit] } # end # class Field include GraphQL::Define::InstanceDefinable accepts_definitions :name, :description, :resolve, :type, :property, :deprecation_reason, :complexity, :hash_key, argument: GraphQL::Define::AssignArgument lazy_defined_attr_accessor :deprecation_reason, :description, :property, :hash_key attr_reader :resolve_proc # @return [String] The name of this field on its {GraphQL::ObjectType} (or {GraphQL::InterfaceType}) def name ensure_defined @name end attr_writer :name # @return [Hash GraphQL::Argument>] Map String argument names to their {GraphQL::Argument} implementations def arguments ensure_defined @arguments end attr_writer :arguments # @return [Numeric, Proc] The complexity for this field (default: 1), as a constant or a proc like `-> (query_ctx, args, child_complexity) { } # Numeric` def complexity ensure_defined @complexity end attr_writer :complexity def initialize @complexity = 1 @arguments = {} @resolve_proc = build_default_resolver end # Get a value for this field # @example resolving a field value # field.resolve(obj, args, ctx) # # @param object [Object] The object this field belongs to # @param arguments [Hash] Arguments declared in the query # @param context [GraphQL::Query::Context] def resolve(object, arguments, context) ensure_defined resolve_proc.call(object, arguments, context) end def resolve=(resolve_proc) ensure_defined @resolve_proc = resolve_proc || build_default_resolver end def type=(new_return_type) ensure_defined @clean_type = nil @dirty_type = new_return_type end # Get the return type for this field. def type @clean_type ||= begin ensure_defined GraphQL::BaseType.resolve_related_type(@dirty_type) end end # You can only set a field's name _once_ -- this to prevent # passing the same {Field} to multiple `.field` calls. # # This is important because {#name} may be used by {#resolve}. def name=(new_name) ensure_defined if @name.nil? @name = new_name elsif @name != new_name raise("Can't rename an already-named field. (Tried to rename \"#{@name}\" to \"#{new_name}\".) If you're passing a field with the `field:` argument, make sure it's an unused instance of GraphQL::Field.") end end # @param new_property [Symbol] A method to call to resolve this field. Overrides the existing resolve proc. def property=(new_property) ensure_defined @property = new_property self.resolve = nil # reset resolve proc end # @param new_hash_key [Symbol] A key to access with `#[key]` to resolve this field. Overrides the existing resolve proc. def hash_key=(new_hash_key) ensure_defined @hash_key = new_hash_key self.resolve = nil # reset resolve proc end def to_s "" end private def build_default_resolver GraphQL::Field::Resolve.create_proc(self) end end end