Class: Graphql::Generators::RelayGenerator

Inherits:
Rails::Generators::Base
  • Object
show all
Includes:
Core
Defined in:
lib/generators/graphql/relay_generator.rb

Instance Method Summary collapse

Methods included from Core

#create_dir, #create_mutation_root_type, #insert_root_type, #module_namespacing_when_supported, #schema_file_path

Instance Method Details

#install_relay ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/generators/graphql/relay_generator.rb', line 13

def install_relay
  # Add Node, `node(id:)`, and `nodes(ids:)`
  template("node_type.erb", "#{options[:directory]}/types/node_type.rb")
  in_root do
    fields = "    # Add `node(id: ID!) and `nodes(ids: [ID!]!)`\n    include GraphQL::Types::Relay::HasNodeField\n    include GraphQL::Types::Relay::HasNodesField\n\n"
    inject_into_file "#{options[:directory]}/types/query_type.rb", fields, after: /class .*QueryType\s*<\s*[^\s]+?\n/m, force: false
  end

  # Add connections and edges
  template("base_connection.erb", "#{options[:directory]}/types/base_connection.rb")
  template("base_edge.erb", "#{options[:directory]}/types/base_edge.rb")
  connectionable_type_files = {
    "#{options[:directory]}/types/base_object.rb" => /class .*BaseObject\s*<\s*[^\s]+?\n/m,
    "#{options[:directory]}/types/base_union.rb" =>  /class .*BaseUnion\s*<\s*[^\s]+?\n/m,
    "#{options[:directory]}/types/base_interface.rb" => /include GraphQL::Schema::Interface\n/m,
  }
  in_root do
    connectionable_type_files.each do |type_class_file, sentinel|
      inject_into_file type_class_file, "    connection_type_class(Types::BaseConnection)\n", after: sentinel, force: false
      inject_into_file type_class_file, "    edge_type_class(Types::BaseEdge)\n", after: sentinel, force: false
    end
  end

  # Add object ID hooks & connection plugin
  schema_code = <<-RUBY

  # Relay-style Object Identification:

  # Return a string UUID for `object`
  def self.id_from_object(object, type_definition, query_ctx)
    # Here's a simple implementation which:
    # - joins the type name & object.id
    # - encodes it with base64:
    # GraphQL::Schema::UniqueWithinType.encode(type_definition.name, object.id)
  end

  # Given a string UUID, find the object
  def self.object_from_id(id, query_ctx)
    # For example, to decode the UUIDs generated above:
    # type_name, item_id = GraphQL::Schema::UniqueWithinType.decode(id)
    #
    # Then, based on `type_name` and `id`
    # find an object in your application
    # ...
  end
RUBY
  inject_into_file schema_file_path, schema_code, before: /^end\n/m, force: false
end