nexmo_markdown_renderer 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a7ee181316166581904d3090d0921bdd910fd04f3b82c3f0c79466c18c9161b
-  data.tar.gz: 47df143beda5e33479d632ad8de13e6b9af55103fe581d1d368ec75101c6bacf
+  metadata.gz: 5d556fff7ca8b92dfaa71da286fd16d2e54d4ce8d13b2d11433d55bf4f049d69
+  data.tar.gz: 3d38cdbd687132a0e4a014893ada68e292c723d1698a97aa9761ac1275374c24
 SHA512:
-  metadata.gz: 9d394cb2a18d09357457307975ce286ec1d933cb38012ff735c342f211d1b381dda8707b5e012a5eee45c28caf57085bf52ab8d485005fff631a2dfc9044bc87
-  data.tar.gz: ecdeb294a4f147299e62863dc0120acc626e07d93eaa2433a2df67db42ba4dca81a4d09c782a353ee992aef26aa6be43409d5cfc7f37dca7f82e55166fca27c3
+  metadata.gz: 5d748be0b975cdc9cc403719e06b1bb9ba0ac2532823bd48c770c1234c85fc240c3060b5ab9367c09698db6f759c973a178362a9b4d05e98876b0c30a06f4516
+  data.tar.gz: ed02f86a2d2c91f66e6c8419998831ca2ae9119f5ec50a48a7e3dd9b294487dc50771863b76d3d63a0ea85f4680b995c7ada2fce663be9d96a18666b871f0447

data/config/locales/en.yml

@@ -152,7 +152,7 @@ en:
       run_command: >-
         ## Run your code
           Save this file to your machine and run it:
-            <pre class='highlight bash run-command'><code>%{command}</code></pre>
+            <pre class="Vlt-prism--dark command-line language-bash Vlt-prism--copy-disabled" data-prompt="$"><code>%{command}</code></pre>
 
       curl:
         only_permitted_dependency: The only permitted curl dependency is `jwt`
@@ -173,4 +173,4 @@ en:
 
             Run the following `gradle` command to execute your application, replacing `%{chomped_package}` with the package containing `%{file}`:
 
-            <pre class="highlight bash run-command"><code>gradle run -Pmain=%{main}</code></pre>
+            <pre class="language-shell Vlt-prism--dark command-line Vlt-prism--copy-disabled" data-prompt="$"><code>gradle run -Pmain=%{main}</code></pre>

data/lib/nexmo_markdown_renderer/filters/block_escape_filter.rb

@@ -7,15 +7,15 @@ module Nexmo
           lexer = Rouge::Lexer.find('text')
           formatter = Rouge::Formatters::HTML.new
           highlighted_source = formatter.format(lexer.lex($1))
-    
+
           output = <<~HEREDOC
-            <pre class="highlight #{lexer.tag}"><code>#{highlighted_source}</code></pre>
+            <pre class="Vlt-prism--dark language-#{lexer.tag} Vlt-prism--copy-disabled"><code>#{highlighted_source}</code></pre>
           HEREDOC
-    
+
           "FREEZESTART#{Base64.urlsafe_encode64(output)}FREEZEEND"
         end
       end
     end
-    
+
   end
-end
+end

data/lib/nexmo_markdown_renderer/filters/code_filter.rb

@@ -26,7 +26,7 @@ module Nexmo
           highlighted_source = highlight(code, lexer)
     
           <<~HEREDOC
-            <pre class="highlight #{lexer.tag}"><code>#{highlighted_source}</code></pre>
+            <pre class="Vlt-prism--dark language-#{lexer.tag} Vlt-prism--copy-disabled"><code>#{highlighted_source}</code></pre>
           HEREDOC
         end
       end

data/lib/nexmo_markdown_renderer/filters/code_snippet_filter.rb

@@ -2,33 +2,33 @@ module Nexmo
   module Markdown
     class CodeSnippetFilter < Banzai::Filter
       include OcticonsHelper
-    
+
       def call(input)
         input.gsub(/```single_code_snippet(.+?)```/m) do |_s|
           config = YAML.safe_load($1)
-    
+
           @renderer = get_renderer(config['language'])
-    
+
           lexer = Nexmo::Markdown::CodeLanguage.find(config['language']).lexer
           lang = config['title'].delete('.')
-    
+
           application_html = generate_application_block(config['application'])
-    
+
           # Read the client
           if config['client']
             highlighted_client_source = generate_code_block(config['language'], config['client'], config['unindent'])
           end
-    
+
           # Read the code
           highlighted_code_source = generate_code_block(config['language'], config['code'], config['unindent'])
-    
+
           dependency_html = ''
           if config['dependencies']
             dependency_html = generate_dependencies(lexer.tag, config['dependencies'])
           end
-    
+
           source_url = generate_source_url(config['code'])
-    
+
           client_html = ''
           if highlighted_client_source
             client_url = generate_source_url(config['client'])
@@ -37,54 +37,54 @@ module Nexmo
             erb = File.read("#{GEM_ROOT}/lib/nexmo_markdown_renderer/views/code_snippets/_configure_client.html.erb")
             client_html = ERB.new(erb).result(binding)
           end
-    
+
           add_instructions = @renderer.add_instructions(config['file_name']).render_markdown
           if config['code_only']
             erb = File.read("#{GEM_ROOT}/lib/nexmo_markdown_renderer/views/code_snippets/_code_only.html.erb")
           else
             erb = File.read("#{GEM_ROOT}/lib/nexmo_markdown_renderer/views/code_snippets/_write_code.html.erb")
           end
-    
+
           code_html = ERB.new(erb).result(binding)
-    
+
           return code_html if config['code_only']
-    
+
           config['run_command'] = config['run_command'].gsub('{filename}', config['file_name']) if config['run_command']
           run_html = @renderer.run_command(config['run_command'], config['file_name'], config['code']['source']).to_s
-    
+
           prereqs = (application_html + dependency_html + client_html).strip
           prereqs = "<h2>#{::I18n.t('.filters.prerequisites')}</h2>#{prereqs}" unless prereqs.empty?
           prereqs + code_html + run_html
         end
       end
-    
+
       private
-    
+
       def highlight(source, lexer)
         formatter = Rouge::Formatters::HTML.new
         formatter.format(lexer.lex(source))
       end
-    
+
       def generate_code_block(language, input, unindent)
         filename = "#{Nexmo::Markdown::Config.docs_base_path}/#{input['source']}"
         return '' unless input
         raise "CodeSnippetFilter - Could not load #{filename} for language #{language}" unless File.exist?(filename)
-    
+
         code = File.read(filename)
         lexer = Nexmo::Markdown::CodeLanguage.find(language).lexer
-    
+
         total_lines = code.lines.count
-    
+
         # Minus one since lines are not zero-indexed
         from_line = (input['from_line'] || 1) - 1
         to_line = (input['to_line'] || total_lines) - 1
-    
+
         code = code.lines[from_line..to_line].join
         code.unindent! if unindent
-    
+
         highlight(code, lexer)
       end
-    
+
       def get_renderer(language)
         language = 'dotnet' if language == 'csharp'
         case language
@@ -116,7 +116,7 @@ module Nexmo
           raise "Unknown language: #{language}"
         end
       end
-    
+
       def generate_dependencies(language, dependencies)
         # The only valid dependency for curl examples is `JWT`
         if dependencies.map(&:upcase).include?('JWT')
@@ -129,19 +129,19 @@ module Nexmo
         erb = File.read("#{GEM_ROOT}/lib/nexmo_markdown_renderer/views/code_snippets/_dependencies.html.erb")
         ERB.new(erb).result(binding)
       end
-    
+
       def generate_application_block(app)
         return '' unless app
-    
+
         base_url = 'http://demo.ngrok.io'
         base_url = 'https://example.com' if app['disable_ngrok']
-    
+
         app['name'] = 'ExampleProject' unless app['name']
-    
+
         # We should remove this default once we're sure that all Code Snippets
         # have a type set e.g audit
         app['type'] ||= 'voice'
-    
+
         if ['voice', 'rtc'].include? app['type']
           app['event_url'] = "#{base_url}/webhooks/events" unless app['event_url']
           app['answer_url'] = "#{base_url}/webhooks/answer" unless app['answer_url']
@@ -151,21 +151,21 @@ module Nexmo
         else
           raise "Invalid application type when creating code snippet: '#{app['type']}'"
         end
-    
+
         id = SecureRandom.hex
-    
+
         ERB.new(erb).result(binding)
       end
-    
+
       def generate_source_url(code)
         # Source example: .repos/nexmo/nexmo-java-code-snippets/ExampleClass.java
         # Direct link on GitHub is in form https://github.com/nexmo/nexmo-java-code-snippets/blob/master/ExampleClass.java
         start_section = 'https://github.com'
-    
+
         # Insert "blob/master" and strip ".repos"
         repo_path = '\\0blob/master/'
         file_section = code['source'].sub('.repos', '').sub(%r{(-quickstart|-code-snippets|-code-snippets)/}, repo_path)
-    
+
         # Line highlighting
         line_section = ''
         if code['from_line']
@@ -178,10 +178,10 @@ module Nexmo
             line_section += "-L#{File.read(code['source']).lines.count}"
           end
         end
-    
+
         start_section + file_section + line_section
       end
     end
-    
+
   end
-end
+end

data/lib/nexmo_markdown_renderer/filters/markdown_filter.rb

@@ -39,7 +39,7 @@ module Nexmo
       end
     
       def table(header, body)
-        '<div class="Vlt-table Vlt-table--data Vlt-table--bordered">' \
+        '<div class="Vlt-table Vlt-table--bordered">' \
         '<table>' \
           "<thead>#{header}</thead>" \
           "<tbody>#{body}</tbody>" \
@@ -75,6 +75,20 @@ module Nexmo
           '</ol>' \
         end
       end
+
+      def block_code(code, language)
+        lexer = ::Rouge::Lexer.find_fancy(language, code) || ::Rouge::Lexers::PlainText
+
+        # XXX HACK: Redcarpet strips hard tabs out of code blocks,
+        # so we assume you're not using leading spaces that aren't tabs,
+        # and just replace them here.
+        if lexer.tag == 'make'
+          code.gsub! /^    /, "\t"
+        end
+
+        formatter = ::Rouge::Formatters::HTMLLegacy.new(:css_class => "Vlt-prism--dark language-#{lexer.tag} Vlt-prism--copy-disabled")
+        formatter.format(lexer.lex(code))
+      end
     end
   end
 end

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/java.rb

@@ -4,29 +4,29 @@ module Nexmo
       class Java < Base
         def self.dependencies(deps)
           {
-            'text' => t('services.code_snippet_renderer.add_instructions_to_file', file: 'build.gradle'),
+            'text' => ::I18n.t('services.code_snippet_renderer.add_instructions_to_file', file: 'build.gradle'),
             'code' => deps.map { |d| "compile '#{d.gsub('@latest', '5.2.1')}'" }.join('<br />'),
             'type' => 'groovy',
           }
         end
-    
+
         def self.run_command(_command, filename, file_path)
           package = file_path.gsub('.repos/nexmo/nexmo-java-code-snippets/src/main/java/', '').tr('/', '.').gsub(filename, '')
           file = filename.gsub('.java', '')
           main = "#{package}#{filename.gsub('.java', '')}"
           chomped_package = package.chomp('.')
-    
-          ::I18n.t('.run_command', chomped_package: chomped_package, package: package, main: main, file: file)
+
+          ::I18n.t('services.code_snippet_renderer.java.run_command', chomped_package: chomped_package, package: package, main: main, file: file)
         end
-    
+
         def self.create_instructions(filename)
-          ::I18n.t('.create_instructions', file: filename.gsub('.java', ''))
+          ::I18n.t('services.code_snippet_renderer.java.create_instructions', file: filename.gsub('.java', ''))
         end
-    
+
         def self.add_instructions(filename)
-          ::I18n.t('.add_instructions', file: filename.gsub('.java', ''))
+          ::I18n.t('services.code_snippet_renderer.java.add_instructions', file: filename.gsub('.java', ''))
         end
       end
-    end    
+    end
   end
-end
+end

data/lib/nexmo_markdown_renderer/views/code_snippets/_code_only.html.erb

@@ -2,5 +2,5 @@
   <div class="copy-button" data-lang="<%= lang %>" data-block="<%= config['source'] %>" data-section="code">
     <%= octicon "clippy", :class => 'top left' %> <span><%= ::I18n.t('.copy-to-clipboad') %></span>
   </div>
-  <pre class="highlight <%= lexer.tag %> main-code"><code><%= highlighted_code_source %></code></pre>
+  <pre class="language-<%= lexer.tag %> main-code Vlt-prism--dark Vlt-prism--copy-disabled"><code><%= highlighted_code_source %></code></pre>
 </div>

data/lib/nexmo_markdown_renderer/views/code_snippets/_configure_client.html.erb

@@ -10,7 +10,7 @@
       <div class="copy-button" data-lang="<%= lang %>" data-block="<%= config['source'] %>" data-section="configure">
         <%= octicon "clippy", :class => 'top left' %> <span>Copy to Clipboard</span>
       </div>
-      <pre class="highlight copy-to-clipboard <%= config['title'] %>"><code><%= highlighted_client_source %></code></pre>
+      <pre class="Vlt-prism--dark language-<%= lexer.tag %> Vlt-prism--copy-disabled"><code><%= highlighted_client_source %></code></pre>
     </div>
 
     <p><a data-section="configure" data-lang="<%= lang %>" data-block="<%= config['source'] %>" href="<%= client_url %>">View full source</a></p>

data/lib/nexmo_markdown_renderer/views/code_snippets/_dependencies.html.erb

@@ -4,7 +4,7 @@
 	<div id="acc<%= id %>" class="Vlt-js-accordion__content Vlt-accordion__content Vlt-accordion__content--noborder">
 		    <p><%=deps['text']%></p>
         <% if deps['code'] %>
-		    <pre class="highlight <%= deps['type'] || 'bash' %> dependencies"><code><%=deps['code']%></code></pre>
+		    <pre class="Vlt-prism--dark language-<%= deps['type'] || 'bash' %> dependencies command-line Vlt-prism--copy-disabled" data-prompt='$'><code><%=deps['code']%></code></pre>
         <% end %>
 	</div>
 </div>

data/lib/nexmo_markdown_renderer/views/code_snippets/_write_code.html.erb

@@ -5,7 +5,7 @@
   <div class="copy-button" data-lang="<%= lang %>" data-block="<%= config['source'] %>" data-section="code">
     <%= octicon "clippy", :class => 'top left' %> <span><%= ::I18n.t('.code_snippets.copy_to_clipboard') %></span>
   </div>
-  <pre class="highlight <%= lexer.tag %> main-code"><code><%= highlighted_code_source %></code></pre>
+  <pre class="language-<%= lexer.tag %> main-code Vlt-prism--dark Vlt-prism--copy-disabled"><code><%= highlighted_code_source %></code></pre>
 
 </div>
 

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo_markdown_renderer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Nexmo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-16 00:00:00.000000000 Z
+date: 2020-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: banzai
@@ -329,7 +329,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.0
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Middleware to render Markdown Documents in Nexmo Developer Platform.