Class: GraphQLDocs::Generator

Inherits:
Object
  • Object
show all
Includes:
Helpers
Defined in:
lib/graphql-docs/generator.rb

Constant Summary

Constants included from Helpers

Helpers::SLUGIFY_PRETTY_REGEXP

Instance Attribute Summary collapse

Attributes included from Helpers

#templates

Instance Method Summary collapse

Methods included from Helpers

#graphql_enum_types, #graphql_input_object_types, #graphql_interface_types, #graphql_mutation_types, #graphql_object_types, #graphql_operation_types, #graphql_scalar_types, #graphql_union_types, #has_yaml?, #include, #markdownify, #slugify, #split_into_metadata_and_contents, #yaml_split

Constructor Details

#initialize(parsed_schema, options) ⇒ Generator

Returns a new instance of Generator.



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/graphql-docs/generator.rb', line 10

def initialize(parsed_schema, options)
  @parsed_schema = parsed_schema
  @options = options

  @renderer = @options[:renderer].new(@parsed_schema, @options)

  @graphql_operation_template = ERB.new(File.read(@options[:templates][:operations]))
  @graphql_object_template = ERB.new(File.read(@options[:templates][:objects]))
  @graphql_mutations_template = ERB.new(File.read(@options[:templates][:mutations]))
  @graphql_interfaces_template = ERB.new(File.read(@options[:templates][:interfaces]))
  @graphql_enums_template = ERB.new(File.read(@options[:templates][:enums]))
  @graphql_unions_template = ERB.new(File.read(@options[:templates][:unions]))
  @graphql_input_objects_template = ERB.new(File.read(@options[:templates][:input_objects]))
  @graphql_scalars_template = ERB.new(File.read(@options[:templates][:scalars]))
end

Instance Attribute Details

#parsed_schema ⇒ Object

Returns the value of attribute parsed_schema.



8
9
10
 
# File 'lib/graphql-docs/generator.rb', line 8

def parsed_schema
  @parsed_schema
end

Instance Method Details

#create_graphql_enum_pages ⇒ Object 



133
134
135
136
137
138
139
140
 
# File 'lib/graphql-docs/generator.rb', line 133

def create_graphql_enum_pages
  graphql_enum_types.each do |enum_type|
    opts = default_generator_options(type: enum_type)

    contents = @graphql_enums_template.result(OpenStruct.new(opts).instance_eval { binding })
    write_file('enum', enum_type[:name], contents)
  end
end

#create_graphql_input_object_pages ⇒ Object 



151
152
153
154
155
156
157
158
 
# File 'lib/graphql-docs/generator.rb', line 151

def create_graphql_input_object_pages
  graphql_input_object_types.each do |input_object_type|
    opts = default_generator_options(type: input_object_type)

    contents = @graphql_input_objects_template.result(OpenStruct.new(opts).instance_eval { binding })
    write_file('input_object', input_object_type[:name], contents)
  end
end

#create_graphql_interface_pages ⇒ Object 



124
125
126
127
128
129
130
131
 
# File 'lib/graphql-docs/generator.rb', line 124

def create_graphql_interface_pages
  graphql_interface_types.each do |interface_type|
    opts = default_generator_options(type: interface_type)

    contents = @graphql_interfaces_template.result(OpenStruct.new(opts).instance_eval { binding })
    write_file('interface', interface_type[:name], contents)
  end
end

#create_graphql_mutation_pages ⇒ Object 



115
116
117
118
119
120
121
122
 
# File 'lib/graphql-docs/generator.rb', line 115

def create_graphql_mutation_pages
  graphql_mutation_types.each do |mutation|
    opts = default_generator_options(type: mutation)

    contents = @graphql_mutations_template.result(OpenStruct.new(opts).instance_eval { binding })
    write_file('mutation', mutation[:name], contents)
  end
end

#create_graphql_object_pages ⇒ Object 



106
107
108
109
110
111
112
113
 
# File 'lib/graphql-docs/generator.rb', line 106

def create_graphql_object_pages
  graphql_object_types.each do |object_type|
    opts = default_generator_options(type: object_type)

    contents = @graphql_object_template.result(OpenStruct.new(opts).instance_eval { binding })
    write_file('object', object_type[:name], contents)
  end
end

#create_graphql_operation_pages ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/graphql-docs/generator.rb', line 84

def create_graphql_operation_pages
  graphql_operation_types.each do |query_type|
    metadata = ''
    if query_type[:name] == 'Query'
      unless @options[:landing_pages][:query].nil?
        query_landing_page = @options[:landing_pages][:query]
        query_landing_page = File.read(query_landing_page)
        if has_yaml?(query_landing_page)
          pieces = yaml_split(query_landing_page)
          pieces[2] = pieces[2].chomp
          metadata = pieces[1, 3].join("\n")
          query_landing_page = pieces[4]
        end
        query_type[:description] = query_landing_page
      end
      opts = default_generator_options(type: query_type)
      contents = @graphql_operation_template.result(OpenStruct.new(opts).instance_eval { binding })
      write_file('operation', query_type[:name], metadata + contents)
    end
  end
end

#create_graphql_scalar_pages ⇒ Object 



160
161
162
163
164
165
166
167
 
# File 'lib/graphql-docs/generator.rb', line 160

def create_graphql_scalar_pages
  graphql_scalar_types.each do |scalar_type|
    opts = default_generator_options(type: scalar_type)

    contents = @graphql_scalars_template.result(OpenStruct.new(opts).instance_eval { binding })
    write_file('scalar', scalar_type[:name], contents)
  end
end

#create_graphql_union_pages ⇒ Object 



142
143
144
145
146
147
148
149
 
# File 'lib/graphql-docs/generator.rb', line 142

def create_graphql_union_pages
  graphql_union_types.each do |union_type|
    opts = default_generator_options(type: union_type)

    contents = @graphql_unions_template.result(OpenStruct.new(opts).instance_eval { binding })
    write_file('union', union_type[:name], contents)
  end
end

#generate ⇒ Object 



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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/graphql-docs/generator.rb', line 26

def generate
  FileUtils.rm_rf(@options[:output_dir]) if @options[:delete_output]

  create_graphql_operation_pages
  create_graphql_object_pages
  create_graphql_mutation_pages
  create_graphql_interface_pages
  create_graphql_enum_pages
  create_graphql_union_pages
  create_graphql_input_object_pages
  create_graphql_scalar_pages

  unless @options[:landing_pages][:index].nil?
    write_file('static', 'index', File.read(@options[:landing_pages][:index]))
  end

  unless @options[:landing_pages][:object].nil?
    write_file('static', 'object', File.read(@options[:landing_pages][:object]))
  end

  unless @options[:landing_pages][:mutation].nil?
    write_file('operation', 'mutation', File.read(@options[:landing_pages][:mutation]))
  end

  unless @options[:landing_pages][:interface].nil?
    write_file('static', 'interface', File.read(@options[:landing_pages][:interface]))
  end

  unless @options[:landing_pages][:enum].nil?
    write_file('static', 'enum', File.read(@options[:landing_pages][:enum]))
  end

  unless @options[:landing_pages][:union].nil?
    write_file('static', 'union', File.read(@options[:landing_pages][:union]))
  end

  unless @options[:landing_pages][:input_object].nil?
    write_file('static', 'input_object', File.read(@options[:landing_pages][:input_object]))
  end

  unless @options[:landing_pages][:scalar].nil?
    write_file('static', 'scalar', File.read(@options[:landing_pages][:scalar]))
  end

  if @options[:use_default_styles]
    assets_dir = File.join(File.dirname(__FILE__), 'layouts', 'assets')
    FileUtils.mkdir_p(File.join(@options[:output_dir], 'assets'))

    sass = File.join(assets_dir, 'css', 'screen.scss')
    system `sass --sourcemap=none #{sass}:#{@options[:output_dir]}/assets/style.css`

    FileUtils.cp_r(File.join(assets_dir, 'images'), File.join(@options[:output_dir], 'assets'))
    FileUtils.cp_r(File.join(assets_dir, 'webfonts'), File.join(@options[:output_dir], 'assets'))
  end

  true
end