Merge pull request #56 from ind1go/filename-context

Pass filename through to HTML pipeline

Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 gem 'commonmarker', '~> 0.16', require: false

Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 

graphql-docs.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'graphql-docs/version'

lib/graphql-docs.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'graphql-docs/helpers'
 require 'graphql-docs/renderer'
 require 'graphql-docs/configuration'

lib/graphql-docs/configuration.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GraphQLDocs
  module Configuration
  GRAPHQLDOCS_DEFAULTS = {

lib/graphql-docs/generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'erb'
 require 'sass'
 
@@ -210,8 +211,9 @@ def write_file(type, name, contents, trim: true)
  contents.gsub!(/^\s{4}/m, ' ')
  end
 
- contents = @renderer.render(contents, type: type, name: name)
- File.write(File.join(path, 'index.html'), contents) unless contents.nil?
+ filename = File.join(path, 'index.html')
+ contents = @renderer.render(contents, type: type, name: name, filename: filename)
+ File.write(filename, contents) unless contents.nil?
  end
  end
 end

lib/graphql-docs/helpers.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GraphQLDocs
  module Helpers
  SLUGIFY_PRETTY_REGEXP = Regexp.new("[^[:alnum:]._~!$&'()+,;=@]+").freeze

lib/graphql-docs/parser.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'graphql'
 
 module GraphQLDocs

lib/graphql-docs/renderer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'html/pipeline'
 require 'yaml'
 require 'extended-markdown-filter'
@@ -36,17 +37,17 @@ def initialize(parsed_schema, options)
  @pipeline = HTML::Pipeline.new(filters, @pipeline_config[:context])
  end
 
- def render(contents, type: nil, name: nil)
- opts = { base_url: @options[:base_url] }.merge({ type: type, name: name}).merge(helper_methods)
+ def render(contents, type: nil, name: nil, filename: nil)
+ opts = { base_url: @options[:base_url], output_dir: @options[:output_dir] }.merge({ type: type, name: name, filename: filename}).merge(helper_methods)
 
- contents = to_html(contents)
+ contents = to_html(contents, context: { filename: filename })
  return contents if @graphql_default_layout.nil?
  opts[:content] = contents
  @graphql_default_layout.result(OpenStruct.new(opts).instance_eval { binding })
  end
 
- def to_html(string)
- @pipeline.to_html(string)
+ def to_html(string, context: {})
+ @pipeline.to_html(string, context)
  end
 
  private

lib/graphql-docs/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GraphQLDocs
  VERSION = '1.4.1'
 end

test/graphql-docs/generator_test.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class GeneratorTest < Minitest::Test
  class CustomRenderer
  def initialize(_, _)
  end
 
- def render(contents, type: nil, name: nil)
+ def render(contents, type: nil, name: nil, filename: nil)
  to_html(contents)
  end
 

test/graphql-docs/graphql-docs_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class GraphQLDocsTest < Minitest::Test

test/graphql-docs/parser_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class ParserTest < Minitest::Test

test/graphql-docs/renderer_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class RendererTest < Minitest::Test
@@ -19,4 +20,35 @@ def test_that_html_conversion_works
 
  assert_equal '<p><strong>R2D2</strong></p>', contents
  end
+
+ def test_that_filename_accessible_to_filters
+ @renderer = GraphQLDocs::Renderer.new(@parsed_schema, GraphQLDocs::Configuration::GRAPHQLDOCS_DEFAULTS.merge({
+ pipeline_config: {
+ pipeline:
+ %i(ExtendedMarkdownFilter
+ EmojiFilter
+ TableOfContentsFilter
+ AddFilenameFilter),
+ context: {
+ gfm: false,
+ asset_root: 'https://a248.e.akamai.net/assets.github.com/images/icons'
+ }
+ }
+ }))
+ contents = @renderer.render('<span id="fill-me"></span>', type: 'Droid', name: 'R2D2', filename: '/this/is/the/filename')
+ assert_match %r{<span id="fill-me">/this/is/the/filename</span>}, contents
+ end
+end
+
+class AddFilenameFilter < HTML::Pipeline::Filter
+ def call
+ doc.search('span[@id="fill-me"]').each do |span|
+ span.inner_html=(context[:filename])
+ end
+ doc
+ end
+
+ def validate
+ needs :filename
+ end
 end

test/test_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'graphql-docs'