nexmo_markdown_renderer 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe1875b3974959e1290b19d8e480b455fa5259b78567b607a4b66b86634ccfad
-  data.tar.gz: 9e33c425c055ef2b52ac3e9abf70c596bcf86ad92f0f8ea4f69ea7732f3001ed
+  metadata.gz: 746e034b9ef6f00f3004f92196e71c3b670cc677f931fa67cdf42252620fdc37
+  data.tar.gz: 680b76bcce7a745ee748cb4e6a5db8d2724a2727271651179a18d43dee0a1701
 SHA512:
-  metadata.gz: 25002e68f5f4db9e9de3d9360a82b3d93c4de70e56a00bdffa6e09ed89a0967a115c50f5b13cd875cfc386c66bbc359b15d5d191619be4f0f3420d250c04786c
-  data.tar.gz: c2b6fc824c865d72f523e50a56b74647393bb8fb98fe9e63f96d48435867511eeb141f6d856ac47c6eae2d8661fdbbeb5d53d557dab5307c5a5525da775291b2
+  metadata.gz: 10cfc564ff9a5544f522fcd98a77afdae52c9140846ae199db099615218ccc8be61360f27ba1c73b46fb0326c4a613ddf625b7bef19df45ba5564a022c1fb1ad
+  data.tar.gz: 31bd733108f5ebcb4608cc9bfbd7b7669902ce66cc94a922abd58a7819c6843d082a710307920efd1450b6b737b53490bcdf5c7f34ead2e07c9d2bdcb704618c

data/lib/nexmo_markdown_renderer.rb

@@ -38,6 +38,7 @@ require_relative 'nexmo_markdown_renderer/models/tutorial/prerequisite'
 require_relative 'nexmo_markdown_renderer/models/tutorial/task'
 require_relative 'nexmo_markdown_renderer/models/use_case'
 
+Dir[File.join(__dir__, 'nexmo_markdown_renderer/filters/concerns', '*.rb')].each { |file| require_relative file }
 Dir[File.join(__dir__, 'nexmo_markdown_renderer/filters', '*.rb')].each { |file| require_relative file }
 Dir[File.join(__dir__, 'nexmo_markdown_renderer/filters/i18n', '*.rb')].each { |file| require_relative file }
 require_relative 'nexmo_markdown_renderer/markdown_renderer'

data/lib/nexmo_markdown_renderer/filters/block_escape_filter.rb

@@ -1,6 +1,8 @@
 module Nexmo
   module Markdown
     class BlockEscapeFilter < Banzai::Filter
+      include Nexmo::Markdown::Concerns::PrismCodeSnippet
+
       def call(input)
         # Freeze to prevent Markdown formatting
         input.gsub(/````\n(.+?)````/m) do |_s|
@@ -8,9 +10,7 @@ module Nexmo
           formatter = Rouge::Formatters::HTML.new
           highlighted_source = formatter.format(lexer.lex($1))
 
-          output = <<~HEREDOC
-            <pre class="Vlt-prism--dark language-#{lexer.tag} Vlt-prism--copy-disabled"><code>#{highlighted_source}</code></pre>
-          HEREDOC
+          output = code_snippet_body(lexer, highlighted_source)
 
           "FREEZESTART#{Base64.urlsafe_encode64(output)}FREEZEEND"
         end

data/lib/nexmo_markdown_renderer/filters/code_filter.rb

@@ -1,43 +1,43 @@
 module Nexmo
   module Markdown
     class CodeFilter < Banzai::Filter
+      include Nexmo::Markdown::Concerns::PrismCodeSnippet
+
       def call(input)
         input.gsub(/(?!.*snippet)```code(.+?)```/m) do |_s|
           config = YAML.safe_load($1)
-    
+
           if config['config']
             configs = YAML.load_file("#{Nexmo::Markdown::Config.docs_base_path}/config/code_examples.yml")
             config = config['config'].split('.').inject(configs) { |h, k| h[k] }
           end
-    
+
           code = File.read("#{Nexmo::Markdown::Config.docs_base_path}/#{config['source']}")
           language = File.extname("#{Nexmo::Markdown::Config.docs_base_path}/#{config['source']}")[1..-1]
           lexer = language_to_lexer(language)
-    
+
           total_lines = code.lines.count
-    
+
           # Minus one since lines are not zero-indexed
           from_line = (config['from_line'] || 1) - 1
           to_line = (config['to_line'] || total_lines) - 1
-    
+
           code = code.lines[from_line..to_line].join
           code.unindent! if config['unindent']
-    
+
           highlighted_source = highlight(code, lexer)
-    
-          <<~HEREDOC
-            <pre class="Vlt-prism--dark language-#{lexer.tag} Vlt-prism--copy-disabled"><code>#{highlighted_source}</code></pre>
-          HEREDOC
+
+          code_snippet_body(lexer, highlighted_source)
         end
       end
-    
+
       private
-    
+
       def highlight(source, lexer)
         formatter = Rouge::Formatters::HTML.new
         formatter.format(lexer.lex(source))
       end
-    
+
       def language_to_lexer_name(language)
         if language_configuration[language]
           language_configuration[language]['lexer']
@@ -45,18 +45,18 @@ module Nexmo
           language
         end
       end
-    
+
       def language_to_lexer(language)
         language = language_to_lexer_name(language)
         return Rouge::Lexers::PHP.new({ start_inline: true }) if language == 'php'
-    
+
         Rouge::Lexer.find(language.downcase) || Rouge::Lexer.find('text')
       end
-    
+
       def language_configuration
         @language_configuration ||= YAML.load_file("#{GEM_ROOT}/config/code_languages.yml")
       end
     end
-    
+
   end
 end

data/lib/nexmo_markdown_renderer/filters/concerns/prism_code_snippet.rb

@@ -0,0 +1,22 @@
+module Nexmo
+  module Markdown
+    module Concerns
+      module PrismCodeSnippet
+        def code_snippet_body(lexer, body)
+          <<~HEREDOC
+            <pre class="#{prism_css_classes(lexer)}"><code>#{body}</code></pre>
+          HEREDOC
+        end
+
+        def code_language_to_prism(code_language)
+          code_language == 'objective_c' && 'objectivec' || code_language
+        end
+
+        def prism_css_classes(lexer)
+          code_language = code_language_to_prism(lexer.tag)
+          "main-code Vlt-prism--dark language-#{code_language} Vlt-prism--copy-disabled"
+        end
+      end
+    end
+  end
+end

data/lib/nexmo_markdown_renderer/filters/markdown_filter.rb

@@ -1,16 +1,17 @@
 module Nexmo
   module Markdown
     class MarkdownFilter < Banzai::Filter
+
       def call(input)
         markdown.render(input)
       end
-    
+
       private
-    
+
       def renderer
         @renderer ||= VoltaRender.new(options)
       end
-    
+
       def markdown
         @markdown ||= Redcarpet::Markdown.new(renderer, {
           no_intra_emphasis: true,
@@ -27,17 +28,19 @@ module Nexmo
     end
 
     class VoltaRender < HTML
+      include Nexmo::Markdown::Concerns::PrismCodeSnippet
+
       def initialize(options)
         @options = options
         super(options)
       end
-    
+
       def paragraph(text)
         return text if @options[:skip_paragraph_surround]
-    
+
         "<p>#{text}</p>"
       end
-    
+
       def table(header, body)
         '<div class="Vlt-table Vlt-table--bordered">' \
         '<table>' \
@@ -46,7 +49,7 @@ module Nexmo
         '</table>' \
         '</div>'
       end
-    
+
       def block_quote(quote)
         '<div class="Vlt-callout Vlt-callout--tip">' \
           '<i></i>' \
@@ -55,7 +58,7 @@ module Nexmo
           '</div>' \
         '</div>'
       end
-    
+
       def image(link, _title, _alt_text)
         '<figure>' \
           '<img src="'\
@@ -63,7 +66,7 @@ module Nexmo
           '" alt="#{alt_text}">' \
         '</figure>'
       end
-    
+
       def list(contents, list_type)
         if "#{list_type}" == 'unordered'
           '<ul class="Vlt-list Vlt-list--simple">' \
@@ -86,7 +89,7 @@ module Nexmo
           code.gsub! /^    /, "\t"
         end
 
-        formatter = ::Rouge::Formatters::HTMLLegacy.new(:css_class => "Vlt-prism--dark language-#{lexer.tag} Vlt-prism--copy-disabled")
+        formatter = ::Rouge::Formatters::HTMLLegacy.new(:css_class => prism_css_classes(lexer))
         formatter.format(lexer.lex(code))
       end
     end

data/lib/nexmo_markdown_renderer/filters/tab_filter.rb

@@ -1,15 +1,17 @@
 module Nexmo
   module Markdown
     class TabFilter < Banzai::Filter
+      include Nexmo::Markdown::Concerns::PrismCodeSnippet
+
       def call(input)
         input.gsub(/^(\s*)```tabbed_(examples|content|folder)(.+?)```/m) do |_s|
           @indentation = $1
           @mode = $2
           @config = YAML.safe_load($3)
-    
+
           if tabbed_folder?
             raise "#{@config['source']} is not a directory" unless File.directory? "#{Nexmo::Markdown::Config.docs_base_path}/#{@config['source']}"
-    
+
             @tabbed_config = YAML.safe_load(File.read("#{Nexmo::Markdown::Config.docs_base_path}/#{@config['source']}/.config.yml"))
             @path = @config['source']
             validate_folder_config
@@ -19,28 +21,28 @@ module Nexmo
           html
         end
       end
-    
+
       private
-    
+
       def create_tabs(content)
         tab = Nokogiri::XML::Element.new 'div', @document
         tab['class'] = 'Vlt-tabs__link'
         tab['class'] += ' Vlt-tabs__link_active' if content[:active]
         tab['role'] = 'tab'
-    
+
         if content[:language]
           tab['data-language'] = content[:language].key
           tab['data-language-type'] = content[:language].type
           tab['data-language-linkable'] = content[:language].linkable?
         end
-    
+
         if content[:platform]
           tab['data-language'] = content[:platform].languages.map(&:key).join(',')
           tab['data-platform'] = content[:platform].key
           tab['data-platform-type'] = content[:platform].type
           tab['data-platform-linkable'] = content[:platform].linkable?
         end
-    
+
         tab_link = Nokogiri::XML::Element.new 'span', @document
         if content[:language]
           # We don't currently have icons for JSON/XML
@@ -56,37 +58,37 @@ module Nexmo
         else
           tab_link.content = content[:tab_title]
         end
-    
+
         tab.add_child(tab_link)
         @tabs.add_child(tab)
       end
-    
+
       def create_content(content)
         tabs_panel = Nokogiri::XML::Element.new 'div', @document
         tabs_panel['class'] = 'Vlt-tabs__panel'
         tabs_panel['class'] += ' Vlt-tabs__panel_active' if content[:active]
-    
+
         element = Nokogiri::XML::Element.new 'p', @document
         element['aria-labelledby'] = "\"#{content[:id]}\""
         element['aria-hidden'] = true
         element.inner_html = content[:body]
-    
+
         tabs_panel.add_child(element)
         @tabs_content.add_child(tabs_panel)
       end
-    
+
       def tabbed_code_examples?
         @mode == 'examples'
       end
-    
+
       def tabbed_content?
         @mode == 'content'
       end
-    
+
       def tabbed_folder?
         @mode == 'folder'
       end
-    
+
       def html
         html = <<~HEREDOC
           <div class="Vlt-tabs">
@@ -95,97 +97,97 @@ module Nexmo
               </div>
           </div>
         HEREDOC
-    
+
         @document = Nokogiri::HTML::DocumentFragment.parse(html)
         @tabs = @document.at_css('.Vlt-tabs__header')
         @tabs_content = @document.at_css('.Vlt-tabs__content')
-    
+
         contents.each do |content|
           create_tabs(content)
           create_content(content)
         end
-    
+
         source = @document.to_html
-    
+
         "#{@indentation}FREEZESTART#{Base64.urlsafe_encode64(source)}FREEZEEND"
       end
-    
+
       def contents
         list = content_from_folder if tabbed_folder?
         list ||= content_from_source if @config['source']
         list ||= content_from_tabs if @config['tabs']
-    
+
         list ||= []
-    
+
         return list unless list.any?
-    
+
         list = resolve_language(list)
-    
+
         if tabbed_code_examples?
           list = format_code(list)
           list = resolve_code(list)
           list = resolve_tab_title(list)
         end
-    
+
         list = sort_contents(list)
         resolve_active_tab(list)
-    
+
         list
       end
-    
+
       def validate_config
         return if @config && (@config['source'] || @config['tabs'])
-    
+
         raise 'Source or tabs must be present in this tabbed_example config'
       end
-    
+
       def validate_folder_config
         return if @tabbed_config && @tabbed_config['tabbed'] == true
-    
+
         raise 'Tabbed must be set to true in the folder config YAML file'
       end
-    
+
       def content_from_source
         source_path = "#{Nexmo::Markdown::Config.docs_base_path}/#{@config['source']}"
         source_path += '/*' if tabbed_code_examples?
         source_path += '/*.md' if tabbed_content?
-    
+
         files = Dir.glob(source_path)
         raise "Empty content_from_source file list in #{source_path}" if files.empty?
-    
+
         files.map do |content_path|
           raise "Could not find content_from_source file: #{content_path}" unless File.exist? content_path
-    
+
           source = File.read(content_path)
-    
+
           next generate_tabbed_code_examples(source, content_path) if tabbed_code_examples?
-    
+
           generate_tabbed_content(source) if tabbed_content?
         end
       end
-    
+
       def content_from_folder
         source_path = "#{Nexmo::Markdown::Config.docs_base_path}/#{@config['source']}"
         source_path += '/*.md'
-    
+
         files = Dir.glob(source_path)
         raise "Empty content_from_source file list in #{source_path}" if files.empty?
-    
+
         files.map do |content_path|
           raise "Could not find content_from_source file: #{content_path}" unless File.exist? content_path
-    
+
           source = File.read(content_path)
-    
+
           generate_tabbed_content(source)
         end
       end
-    
+
       def content_from_tabs
         @config['tabs'].map do |title, config|
           raise "Could not find content_from_tabs file: #{Nexmo::Markdown::Config.docs_base_path}/#{@config['source']}" unless File.exist? "#{Nexmo::Markdown::Config.docs_base_path}/#{@config['source']}"
-    
+
           source = File.read("#{Nexmo::Markdown::Config.docs_base_path}/#{@config['source']}")
-    
+
           config.symbolize_keys.merge({
             id: SecureRandom.hex,
             source: source,
@@ -193,22 +195,22 @@ module Nexmo
           })
         end
       end
-    
+
       def generate_tabbed_content(source)
         content = {
           id: SecureRandom.hex,
           source: source,
         }
-    
+
         content[:frontmatter] = YAML.safe_load(source)
         content[:language_key] = content[:frontmatter]['language']
         content[:platform_key] = content[:frontmatter]['platform']
         content[:tab_title] = content[:frontmatter]['title']
         content[:body] = Nexmo::Markdown::Renderer.new(options).call(source)
-    
+
         content
       end
-    
+
       def generate_tabbed_code_examples(source, content_path)
         content = {
           id: SecureRandom.hex,
@@ -216,24 +218,24 @@ module Nexmo
         }
         language_key = File.basename(content_path, '.*').downcase
         content[:language_key] = language_key
-    
+
         content
       end
-    
+
       def resolve_language(contents)
         contents.map do |content|
           if content[:language_key]
             content[:language] = CodeLanguage.find(content[:language_key])
           end
-    
+
           if content[:platform_key]
             content[:platform] = CodeLanguage.find(content[:platform_key])
           end
-    
+
           content
         end
       end
-    
+
       def format_code(contents)
         contents.each do |content|
           if content[:from_line] || content[:to_line]
@@ -243,43 +245,42 @@ module Nexmo
             to_line = (content[:to_line] || total_lines) - 1
             content[:source] = lines[from_line..to_line].join
           end
-    
+
           content[:source].unindent! if content[:unindent]
         end
       end
-    
+
       def resolve_code(contents)
         contents.map do |content|
           @formatter ||= Rouge::Formatters::HTML.new
           lexer = content[:language].lexer
           highlighted_source = @formatter.format(lexer.lex(content[:source]))
-          body = <<~HEREDOC
-            <pre class="Vlt-prism--dark language-#{lexer.tag} Vlt-prism--copy-disabled"><code>#{highlighted_source}</code></pre>
-          HEREDOC
-    
+
+          body = code_snippet_body(lexer, highlighted_source)
+
           content.merge!({ body: body })
         end
       end
-    
+
       def resolve_tab_title(contents)
         contents.map do |content|
           content.merge!({ tab_title: content[:language].label })
         end
       end
-    
+
       def sort_contents(contents)
         contents.sort_by do |content|
           next content[:language].weight if content[:language]
-    
+
           next content[:frontmatter]['menu_weight'] || 999 if content[:frontmatter]
-    
+
           999
         end
       end
-    
+
       def resolve_active_tab(contents)
         active_index = nil
-    
+
         if options[:code_language]
           contents.each_with_index do |content, index|
             %i[language_key platform_key].each do |key|
@@ -287,10 +288,10 @@ module Nexmo
             end
           end
         end
-    
+
         @tabs['data-has-initial-tab'] = active_index.present?
         active_index ||= 0
-    
+
         contents[active_index][:active] = true
       end
     end

data/lib/nexmo_markdown_renderer/models/tutorial.rb

@@ -63,7 +63,7 @@ module Nexmo
       end
 
       def first_step
-        subtasks.first.name
+        subtasks.first&.name
       end
 
       def prerequisite?

data/lib/version.rb

@@ -1,7 +1,7 @@
 # :nocov:
 module Nexmo
   module Markdown
-    VERSION = '0.3.0'
+    VERSION = '0.3.1'
   end
 end
 # :nocov:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo_markdown_renderer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Nexmo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-15 00:00:00.000000000 Z
+date: 2020-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: banzai
@@ -246,6 +246,7 @@ files:
 - lib/nexmo_markdown_renderer/filters/collapsible_filter.rb
 - lib/nexmo_markdown_renderer/filters/columns_filter.rb
 - lib/nexmo_markdown_renderer/filters/concept_list_filter.rb
+- lib/nexmo_markdown_renderer/filters/concerns/prism_code_snippet.rb
 - lib/nexmo_markdown_renderer/filters/dynamic_content_filter.rb
 - lib/nexmo_markdown_renderer/filters/external_link_filter.rb
 - lib/nexmo_markdown_renderer/filters/frontmatter_filter.rb