graphql-docs 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72ec410a12852586cbdf082b669fc6dc04a04883
-  data.tar.gz: 604571380c7008a7b1e708a3b9063718d94123c6
+  metadata.gz: ff2d6fddab0c0c4dd83298aa1137a5ff50565ed4
+  data.tar.gz: 5b5f461978561689bd4b4593f0e453c2e59cdff7
 SHA512:
-  metadata.gz: cafa5a5fd565c857dcb7564f32b3e669d9ead0c0f2ed9b9a294139ee01eb5d9dce34c79387e3d71b6be548f51e46c983cc3e10689e187a507284d5efc74ec5ee
-  data.tar.gz: 679c13720eb0c6cc2aa9bdb6fed436beb9779d5d78336ac419471d9e11c6ef5b789effe8a79b8301ce2037ddb15be0de6615fde3ccb30a80befce09bbf6b5eff
+  metadata.gz: 7235b43da05965859f48c16be81e18225d80cd0f2b0d22a4748d22803431bd9dedb10eaae485105d27455d45ff1f47e135bc0e55600e879a0d4a9fa1c9f2aeba
+  data.tar.gz: 0a00134d9c51cff577e7c499a7ec6d335eb2624842da704a23f7b55bbf7cad6df6765210e4dc80d961095bd4acbf0ace2b4da561039126cc95acac857ab8207e

data/.travis.yml

@@ -25,3 +25,5 @@ matrix:
   include:
     - script: bundle exec rake rubocop
       rvm: 2.5.0
+    - script: bundle exec rake html_proofer
+      rvm: 2.5.0

data/Rakefile

@@ -14,18 +14,14 @@ end
 
 task default: :test
 
-Rake::Task[:test].enhance { Rake::Task[:html_proofer].invoke }
-
 desc 'Invoke HTML-Proofer'
 task :html_proofer do
-  if ENV['CI']
-    Rake::Task[:generate_sample].invoke('https://www.gjtorikian.com/graphql-docs')
-    require 'html-proofer'
-    output_dir = File.join(File.dirname(__FILE__), 'output')
+  Rake::Task[:generate_sample].invoke('https://www.gjtorikian.com/graphql-docs')
+  require 'html-proofer'
+  output_dir = File.join(File.dirname(__FILE__), 'output')
 
-    proofer_options = { disable_external: true, assume_extension: true }
-    HTMLProofer.check_directory(output_dir, proofer_options).run
-  end
+  proofer_options = { disable_external: true, assume_extension: true }
+  HTMLProofer.check_directory(output_dir, proofer_options).run
 end
 
 desc 'Set up a console'

data/graphql-docs.gemspec

@@ -23,7 +23,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'graphql', '~> 1.6'
 
   # rendering
-  spec.add_dependency 'html-pipeline', '~> 2.2'
+  spec.add_dependency 'html-pipeline', '~> 2.8'
+  spec.add_dependency 'escape_utils',  '~> 1.2'
   spec.add_dependency 'extended-markdown-filter', '~> 0.4'
   spec.add_dependency 'gemoji', '~> 3.0'
   spec.add_dependency 'sass', '~> 3.4'

data/lib/graphql-docs.rb

@@ -1,4 +1,3 @@
-# rubocop:disable Naming/FileName
 require 'graphql-docs/helpers'
 require 'graphql-docs/renderer'
 require 'graphql-docs/configuration'
@@ -14,6 +13,17 @@ rescue LoadError; end
 module GraphQLDocs
   class << self
     def build(options)
+      # do not let user provided values overwrite every single value
+      %i(templates landing_pages).each do |opt|
+        if options.key?(opt)
+          GraphQLDocs::Configuration::GRAPHQLDOCS_DEFAULTS[opt].each_pair do |key, value|
+            unless options[opt].key?(key)
+              options[opt][key] = value
+            end
+          end
+        end
+      end
+
       options = GraphQLDocs::Configuration::GRAPHQLDOCS_DEFAULTS.merge(options)
 
       filename = options[:filename]

data/lib/graphql-docs/generator.rb

@@ -13,20 +13,27 @@ module GraphQLDocs
 
       @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]))
+      %i(operations objects mutations interfaces enums unions input_objects scalars).each do |sym|
+        if !File.exist?(@options[:templates][sym])
+          raise IOError, "`#{sym}` template #{@options[:templates][sym]} was not found"
+        end
+        instance_variable_set("@graphql_#{sym}_template", ERB.new(File.read(@options[:templates][sym])))
+      end
+
+      %i(index object query mutation interface enum union input_object scalar).each do |sym|
+        if @options[:landing_pages][sym].nil?
+          instance_variable_set("@#{sym}_landing_page", nil)
+        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]))
+      end
     end
 
     def generate
       FileUtils.rm_rf(@options[:output_dir]) if @options[:delete_output]
 
-      create_graphql_operation_pages
+      has_query = create_graphql_query_pages
       create_graphql_object_pages
       create_graphql_mutation_pages
       create_graphql_interface_pages
@@ -35,36 +42,40 @@ module GraphQLDocs
       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]), trim: false)
+      unless @graphql_index_landing_page.nil?
+        write_file('static', 'index', @graphql_index_landing_page, trim: false)
+      end
+
+      unless @graphql_object_landing_page.nil?
+        write_file('static', 'object', @graphql_object_landing_page, trim: false)
       end
 
-      unless @options[:landing_pages][:object].nil?
-        write_file('static', 'object', File.read(@options[:landing_pages][:object]), trim: false)
+      if !@graphql_query_landing_page.nil? && !has_query
+        write_file('operation', 'query', @graphql_query_landing_page, trim: false)
       end
 
-      unless @options[:landing_pages][:mutation].nil?
-        write_file('operation', 'mutation', File.read(@options[:landing_pages][:mutation]), trim: false)
+      unless @graphql_mutation_landing_page.nil?
+        write_file('operation', 'mutation', @graphql_mutation_landing_page, trim: false)
       end
 
-      unless @options[:landing_pages][:interface].nil?
-        write_file('static', 'interface', File.read(@options[:landing_pages][:interface]), trim: false)
+      unless @graphql_interface_landing_page.nil?
+        write_file('static', 'interface', @graphql_interface_landing_page, trim: false)
       end
 
-      unless @options[:landing_pages][:enum].nil?
-        write_file('static', 'enum', File.read(@options[:landing_pages][:enum]), trim: false)
+      unless @graphql_enum_landing_page.nil?
+        write_file('static', 'enum', @graphql_enum_landing_page, trim: false)
       end
 
-      unless @options[:landing_pages][:union].nil?
-        write_file('static', 'union', File.read(@options[:landing_pages][:union]), trim: false)
+      unless @graphql_union_landing_page.nil?
+        write_file('static', 'union', @graphql_union_landing_page, trim: false)
       end
 
-      unless @options[:landing_pages][:input_object].nil?
-        write_file('static', 'input_object', File.read(@options[:landing_pages][:input_object]), trim: false)
+      unless @graphql_input_object_landing_page.nil?
+        write_file('static', 'input_object', @graphql_input_object_landing_page, trim: false)
       end
 
-      unless @options[:landing_pages][:scalar].nil?
-        write_file('static', 'scalar', File.read(@options[:landing_pages][:scalar]), trim: false)
+      unless @graphql_scalar_landing_page.nil?
+        write_file('static', 'scalar', @graphql_scalar_landing_page, trim: false)
       end
 
       if @options[:use_default_styles]
@@ -81,10 +92,10 @@ module GraphQLDocs
       true
     end
 
-    def create_graphql_operation_pages
+    def create_graphql_query_pages
       graphql_operation_types.each do |query_type|
         metadata = ''
-        if query_type[:name] == 'Query'
+        if query_type[:name] == graphql_root_types['query']
           unless @options[:landing_pages][:query].nil?
             query_landing_page = @options[:landing_pages][:query]
             query_landing_page = File.read(query_landing_page)
@@ -97,17 +108,19 @@ module GraphQLDocs
             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)
+          contents = @graphql_operations_template.result(OpenStruct.new(opts).instance_eval { binding })
+          write_file('operation', 'query', metadata + contents)
+          return true
         end
       end
+      false
     end
 
     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 })
+        contents = @graphql_objects_template.result(OpenStruct.new(opts).instance_eval { binding })
         write_file('object', object_type[:name], contents)
       end
     end

data/lib/graphql-docs/helpers.rb

@@ -21,6 +21,10 @@ module GraphQLDocs
       ::CommonMarker.render_html(string, :DEFAULT).strip
     end
 
+    def graphql_root_types
+      @parsed_schema[:root_types] || []
+    end
+
     def graphql_operation_types
       @parsed_schema[:operation_types] || []
     end

data/lib/graphql-docs/parser.rb

@@ -30,6 +30,15 @@ module GraphQLDocs
     end
 
     def parse
+
+      root_types = {}
+      ['query', 'mutation'].each do |operation|
+        unless @schema.root_type_for_operation(operation).nil?
+          root_types[operation] = @schema.root_type_for_operation(operation).name
+        end
+      end
+      @processed_schema[:root_types] = root_types
+
       @schema.types.each_value do |object|
         data = {}
 
@@ -37,7 +46,7 @@ module GraphQLDocs
 
         case object
         when ::GraphQL::ObjectType
-          if object.name == 'Query'
+          if object.name == root_types['query']
             data[:name] = object.name
             data[:description] = object.description
 
@@ -45,7 +54,7 @@ module GraphQLDocs
             data[:fields], data[:connections] = fetch_fields(object.fields, object.name)
 
             @processed_schema[:operation_types] << data
-          elsif object.name == 'Mutation'
+          elsif object.name == root_types['mutation']
             data[:name] = object.name
             data[:description] = object.description
 

data/lib/graphql-docs/version.rb

@@ -1,3 +1,3 @@
 module GraphQLDocs
-  VERSION = '1.4.0'
+  VERSION = '1.4.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-docs
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-11 00:00:00.000000000 Z
+date: 2018-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: escape_utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: extended-markdown-filter
   requirement: !ruby/object:Gem::Requirement