Merge pull request #66 from gjtorikian/support-erb-landings

Support ERB templates for landing pages

README.md

@@ -96,6 +96,12 @@ GraphQLDocs.build(options)
 
 If your `render` method returns `nil`, the `Generator` will not attempt to write any HTML file.
 
+### Templates
+
+The layouts for the individual GraphQL pages are ERB templates, but you can also use ERB templates for your static landing pages.
+
+If you want to add additional variables for your landing pages, you can add define a `variables` hash within the `landing_pages` option.
+
 ### Helper methods
 
 In your ERB layouts, there are several helper methods you can use. The helper methods are:

lib/graphql-docs/configuration.rb

@@ -48,7 +48,9 @@ module Configuration
  enum: "#{File.dirname(__FILE__)}/landing_pages/enum.md",
  union: "#{File.dirname(__FILE__)}/landing_pages/union.md",
  input_object: "#{File.dirname(__FILE__)}/landing_pages/input_object.md",
- scalar: "#{File.dirname(__FILE__)}/landing_pages/scalar.md"
+ scalar: "#{File.dirname(__FILE__)}/landing_pages/scalar.md",
+
+ variables: {} # only used for ERB landing pages
  },
 
  classes: {

lib/graphql-docs/generator.rb

@@ -27,7 +27,23 @@ def initialize(parsed_schema, options)
  elsif !File.exist?(@options[:landing_pages][sym])
  raise IOError, "`#{sym}` landing page #{@options[:landing_pages][sym]} was not found"
  end
- instance_variable_set("@graphql_#{sym}_landing_page", File.read(@options[:landing_pages][sym]))
+
+ landing_page_contents = File.read(@options[:landing_pages][sym])
+ metadata = ''
+
+ if File.extname((@options[:landing_pages][sym])) == '.erb'
+ opts = @options.merge(@options[:landing_pages][:variables]).merge(helper_methods)
+ if has_yaml?(landing_page_contents)
+ metadata, landing_page = split_into_metadata_and_contents(landing_page_contents, parse: false)
+ erb_template = ERB.new(landing_page)
+ else
+ erb_template = ERB.new(landing_page_contents)
+ end
+
+ landing_page_contents = erb_template.result(OpenStruct.new(opts).instance_eval { binding })
+ end
+
+ instance_variable_set("@graphql_#{sym}_landing_page", metadata + landing_page_contents)
  end
  end
 

lib/graphql-docs/helpers.rb

@@ -62,7 +62,7 @@ def graphql_scalar_types
  @parsed_schema[:scalar_types] || []
  end
 
- def split_into_metadata_and_contents(contents)
+ def split_into_metadata_and_contents(contents, parse: true)
  opts = {}
  pieces = yaml_split(contents)
  if pieces.size < 4
@@ -72,7 +72,11 @@ def split_into_metadata_and_contents(contents)
  end
  # Parse
  begin
- meta = YAML.load(pieces[2]) || {}
+ if parse
+ meta = YAML.load(pieces[2]) || {}
+ else
+ meta = pieces[2]
+ end
  rescue Exception => e # rubocop:disable Lint/RescueException
  raise "Could not parse YAML for #{name}: #{e.message}"
  end

test/graphql-docs/fixtures/landing_pages/object.erb

@@ -0,0 +1,6 @@
+---
+title: Variable Objects
+---
+# Objects
+
+<%= some_var %> in GraphQL represent the resources that you can access.

test/graphql-docs/generator_test.rb

@@ -155,6 +155,21 @@ def test_that_missing_landing_pages_are_reported
  end
  end
 
+ def test_that_erb_landing_pages_work
+ options = deep_copy(GraphQLDocs::Configuration::GRAPHQLDOCS_DEFAULTS)
+ options[:output_dir] = @output_dir
+ options[:landing_pages][:object] = File.join(fixtures_dir, 'landing_pages', 'object.erb')
+ options[:landing_pages][:variables] = { some_var: 'wowie!!' }
+
+ generator = GraphQLDocs::Generator.new(@tiny_results, options)
+ generator.generate
+
+ object = File.read File.join(@output_dir, 'object', 'index.html')
+
+ assert_match /Variable Objects/, object
+ assert_match /wowie!!/, object
+ end
+
  def test_that_broken_yaml_is_caught
  options = deep_copy(GraphQLDocs::Configuration::GRAPHQLDOCS_DEFAULTS)
  options[:landing_pages][:index] = File.join(fixtures_dir, 'landing_pages', 'broken_yaml.md')