Module: GraphQL::Rails

Extended by:
Rails
Included in:
Rails
Defined in:
lib/graphql/rails/dsl.rb,
lib/graphql/rails/types.rb,
lib/graphql/rails/config.rb,
lib/graphql/rails/engine.rb,
lib/graphql/rails/fields.rb,
lib/graphql/rails/schema.rb,
lib/graphql/rails/version.rb,
lib/graphql/rails/callbacks.rb,
lib/graphql/rails/operations.rb,
lib/graphql/rails/extensions/cancan.rb,
lib/graphql/rails/extensions/mongoid.rb,
lib/graphql/rails/node_identification.rb,
lib/graphql/rails/controller_extensions.rb,
app/controllers/graphql/rails/schema_controller.rb

Defined Under Namespace

Modules: ControllerExtensions, Mongoid, Schema, Types Classes: DSL, Engine, Fields, Operations, SchemaController

Constant Summary collapse

VERSION = 
'0.0.6'
NodeIdentification =

Implements globally-unique object IDs for Relay compatibility.

GraphQL::Relay::GlobalNodeIdentification.define do
  # TODO: Add security checks.
  object_from_id -> (id, ctx) do
    Types.lookup(*NodeIdentification.from_global_id(id))
  end

  type_from_object -> (obj) do
    Types.resolve(obj.class)
  end
end

Instance Method Summary collapse

Instance Method Details

#config ⇒ Object

Configuration for this gem.



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/graphql/rails/config.rb', line 11

def config
  @config ||= OpenStruct.new({
    # Should graphql-ruby be placed into debug mode?
    :debug => ::Rails.env.development?,

    # Should the GraphiQL web interface be served?
    :graphiql => ::Rails.env.development?,

    # Should names be converted to lowerCamelCase per GraphQL convention?
    # For example, should :get_user_tasks become 'getUserTasks'?
    :camel_case => true,

    # Should object IDs be globally unique?
    # This is necessary to conform to the Relay Global Object ID spec.
    :global_ids => true,

    # Maximum nesting for GraphQL queries.
    # Specify nil for unlimited nesting depth.
    :max_depth => 8,

    # Should the following extensions be loaded?
    :mongoid => defined?(::Mongoid),
    :cancan => defined?(::CanCan),
  })
end

#configure {|config| ... } ⇒ Object

Yields the configuration object to a block, per convention.

Yields:



6
7
8
 
# File 'lib/graphql/rails/config.rb', line 6

def configure
  yield config
end