graphql-docs 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9927fcaa99294d832438c2e32b14d36e75da6208bbd320c689b323960ddf9e0
-  data.tar.gz: 9033c5e6ce19659232675b03b56a18ef33e7bc7d8903913b4858c4e3fa60b93c
+  metadata.gz: c06368e890af03ce399e5d4531d0a5973da8e8063511f68c3a3dccab3411e51e
+  data.tar.gz: a5122bc69a78683981d5b7782dd8299659f1abd2f391cdefd73ab790f919532b
 SHA512:
-  metadata.gz: e5a88d674aadea5199215b96ec816ab79512caab5e7d5d1c786a9a537aa5abb806c557d3f8e1552ec305af456050dcdb11eee2f4022fc5a114ed259ca1819f24
-  data.tar.gz: 2b8aa52f4fbfa76ff9db32dca0c157ea4989380da1fb5755ef9f4428bf523fd4a09d2afb41cb0573506d5a0e3a10c7957173ea6ca8184add61bde1405e52c67f
+  metadata.gz: 514e90e4ea3adc0cd60b40aa604f9e6c74168a42f46e7829bd720891f87c642dcba1401faacc25f8154f580c65fa820fd88e871b323ecac498b3e9f1721a5bbf
+  data.tar.gz: d62e5f13da7c60938f809c49f8c3dd405ae0dc4cbed72474bf6426237c7a468d7ce045f4dafb9587b4a6b1a0c34d43a1febddb14d952d9eca50a71322e911c19

data/.travis.yml

@@ -1,29 +1,23 @@
+sudo: false
 language: ruby
+cache: bundler
+
 rvm:
   - 2.3.6
   - 2.4.3
   - 2.5.0
+  - 2.6.0
 
 git:
   depth: 10
 
-env:
-  global:
-    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
-
-sudo: false
-cache: bundler
-
-addons:
-  apt:
-    sources:
-      - kalakris-cmake
-    packages:
-      - cmake
+before_install:
+  - gem update --system
+  - gem install bundler
 
 matrix:
   include:
     - script: bundle exec rake rubocop
-      rvm: 2.5.0
+      rvm: 2.6.0
     - script: bundle exec rake html_proofer
-      rvm: 2.5.0
+      rvm: 2.6.0

data/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:

data/graphql-docs.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'graphql', '~> 1.6'
+  spec.add_dependency 'graphql', '~> 1.8'
 
   # rendering
   spec.add_dependency 'commonmarker', '~> 0.16'
@@ -32,7 +32,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'sass', '~> 3.4'
 
   spec.add_development_dependency 'awesome_print'
-  spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'html-proofer', '~> 3.4'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-focus', '~> 1.1'

data/lib/graphql-docs/configuration.rb

@@ -48,7 +48,9 @@ module GraphQLDocs
         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: {

data/lib/graphql-docs/generator.rb

@@ -27,7 +27,23 @@ module GraphQLDocs
         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
 

data/lib/graphql-docs/helpers.rb

@@ -62,7 +62,7 @@ module GraphQLDocs
       @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 @@ module GraphQLDocs
       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

data/lib/graphql-docs/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module GraphQLDocs
-  VERSION = '1.6.1'.freeze
+  VERSION = '1.7.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-docs
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-13 00:00:00.000000000 Z
+date: 2019-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: commonmarker
   requirement: !ruby/object:Gem::Requirement
@@ -122,20 +122,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: html-proofer
   requirement: !ruby/object:Gem::Requirement