nexmo_markdown_renderer 0.7.6 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7800ee97436dd0317d85c054ba7293f1207c2e0ac9e90b1f1f443df61319d51
-  data.tar.gz: cf859ca6c2f8d165e4057242f460dc4e0bdabe4419a4e25f94e0c1611181ccf2
+  metadata.gz: b99304f43d7530fad183956d84883ee41eae9fe3fd124e212f0da02f4d4c5436
+  data.tar.gz: e79325576839554fcdd82fe761b6c74c539fc15c61046841d6e9f4fd3fa24a79
 SHA512:
-  metadata.gz: 00fa691a0b76fabaa820fbc90bd68b87ab0a9a7bf4fa87a949f153fa4031845000375ec661f721154932db2f357bc4358ff1e6f8cc28d7808c52288db655ecee
-  data.tar.gz: fb66fcd2e4582e40ac53dfc1bd74af9ddaa13c22f71e9f0d62ab45bcc9986a51ad5c5801bc6e0dccfbe42f93e50682fc3bfd26d18eb0e2616f10f7ea90227419
+  metadata.gz: 10e9ee85633c905346fcca22afc6e60425971740866b17fb3b95da36c5c2c2abba2799d1fb5358c785c2af27c42fb2f59b3924233420a9d4fba3f7b4975e32e5
+  data.tar.gz: b3ec25cfa5e861d617d97e0a6a20da1ff8b74c4dd02196642a160875970acbaf225cfe995e47ed0a8d3401d52fc1e5c45cf3e468d86f16b348b5d49fa3f14331

data/README.md

@@ -6,11 +6,15 @@
 This gem facilitates the presentation of markdown documents in a Rails app by applying custom filters for tabs, code snippets, icons, indentation and more. It is used in the [Nexmo Developer Platform](https://developer.nexmo.com).
 
 * [Installation and Usage](#installation-and-usage)
+    * [In An Application](#in-an-application)
+    * [CLI Standlone](#cli-standalone)
 * [Contributing](#contributing)
 * [License](#license)
 
 ## Installation and Usage
 
+### In An Application
+
 To use this gem you must install it in your application's Gemfile:
 
 ```ruby
@@ -45,6 +49,22 @@ Passing in a markdown file:
 rendered = content.call("/_documentation/example/example_markdown.md")
 ```
 
+### CLI Standalone
+
+To use the markdown renderer with the built-in CLI, you first must install the gem locally:
+
+```bash
+$ gem install nexmo-markdown-renderer
+```
+
+Once the gem is installed you can use the CLI to generate HTML output for a provided markdown file. To do so, you must specify both a path to the documentation folder and the specific markdown file you wish to render:
+
+```bash
+$ DOCS_BASE_PATH=path/to/docs bundle exec nexmo-markdown-renderer render _documentation/path/sample.md
+```
+
+The converted HTML output will be displayed in your console.
+
 ## Contributing
 
 We ❤️ contributions from everyone! [Bug reports](https://github.com/Nexmo/nexmo-markdown-renderer/issues), [bug fixes](https://github.com/Nexmo/nexmo-markdown-renderer/pulls) and feedback on the gem is always appreciated. Look at the [Contributor Guidelines](https://github.com/Nexmo/nexmo-markdown-renderer/blob/master/CONTRIBUTING.md) for more information.

data/config/locales/en.yml

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

data/lib/nexmo_markdown_renderer.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 GEM_ROOT = File.expand_path("../..", __FILE__)
 require 'banzai'
-require 'octicons_helper'
 require 'nokogiri'
 require 'open-uri'
 require 'active_model'
+require 'action_view'
 require 'i18n'
 
 require_relative 'nexmo_markdown_renderer/config/load_config'

data/lib/nexmo_markdown_renderer/cli.rb

@@ -0,0 +1,11 @@
+require "thor"
+require_relative "../nexmo_markdown_renderer"
+require_relative "initializers/doc_finder"
+module Nexmo::Markdown
+  class CLI < Thor
+    desc "render FILE", "passes FILE throught the pipeline and renders it as html"
+    def render(file)
+      puts Nexmo::Markdown::Renderer.new.call(File.read("#{ENV['DOCS_BASE_PATH']}/#{file}")).to_s
+    end
+  end
+end

data/lib/nexmo_markdown_renderer/config/load_config.rb

@@ -2,8 +2,8 @@ module Nexmo
   module Markdown
     class Config
       def self.docs_base_path
-        @docs_base_path ||= (defined?(Rails) && Rails.application != nil && Rails.application.configuration.docs_base_path) || ENV.fetch('DOCS_BASE_PATH', '.')
+        @docs_base_path ||= ENV.fetch('DOCS_BASE_PATH', '.')
       end
     end
   end
-end
+end

data/lib/nexmo_markdown_renderer/filters/code_snippet/import_dependencies.rb

@@ -3,7 +3,6 @@ module Nexmo
     module Filters
       module CodeSnippet
         class ImportDependencies
-          include OcticonsHelper
           include Renderable
 
           attr_reader :config

data/lib/nexmo_markdown_renderer/filters/code_snippet/initialize_dependencies.rb

@@ -3,7 +3,6 @@ module Nexmo
     module Filters
       module CodeSnippet
         class InitializeDependencies
-          include OcticonsHelper
           include Renderable
 
           def initialize(config, snippet)

data/lib/nexmo_markdown_renderer/filters/code_snippet/instructions.rb

@@ -3,7 +3,6 @@ module Nexmo
     module Filters
       module CodeSnippet
         class Instructions
-          include OcticonsHelper
           include Renderable
 
           attr_reader :config

data/lib/nexmo_markdown_renderer/filters/code_snippet/run.rb

@@ -3,7 +3,6 @@ module Nexmo
     module Filters
       module CodeSnippet
         class Run
-          include OcticonsHelper
           include Renderable
 
           def initialize(config, snippet)

data/lib/nexmo_markdown_renderer/filters/code_snippet_filter.rb

@@ -1,7 +1,6 @@
 module Nexmo
   module Markdown
     class CodeSnippetFilter < Banzai::Filter
-      include OcticonsHelper
 
       def call(input)
         input.gsub(/```single_code_snippet(.+?)```/m) do |_s|

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

@@ -2,16 +2,10 @@ module Nexmo
   module Markdown
     module Concerns
       module PrismCodeSnippet
-        include OcticonsHelper
 
-        def code_snippet_body(lexer, body)
+        def code_snippet_body(lexer, body, options = {})
           <<~HEREDOC
-            <div class="copy-wrapper">
-              <div class="copy-button" data-lang="#{code_language_to_prism(lexer.tag)}" data-section="code">
-                #{octicon "clippy", :class => 'top left'} <span>#{::I18n.t('code_snippets.copy_to_clipboard') }</span>
-              </div>
-              <pre class="#{prism_css_classes(lexer)}"><code>#{body}</code></pre>
-            </div>
+            <pre class="#{prism_css_classes(lexer)}" data-lang="#{code_language_to_prism(lexer.tag)}" data-section="code" data-block="#{options[:block]}"><code>#{body}</code></pre>
           HEREDOC
         end
 
@@ -21,7 +15,7 @@ module Nexmo
 
         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"
+          "main-code Vlt-prism--dark language-#{code_language}"
         end
       end
     end

data/lib/nexmo_markdown_renderer/filters/markdown_filter.rb

@@ -60,13 +60,12 @@ module Nexmo
       end
 
       def image(link, _title, _alt_text)
-        '<figure>' \
-          '<img src="'\
-          "#{link}"\
-          '" alt="'\
-          "#{_alt_text}"\
-          '">' \
-        '</figure>'
+        <<~IMAGE
+          <figure>
+            <img src="#{link}" alt="#{_alt_text}">
+            <figcaption class="Vlt-center"><em>#{_alt_text}</em></figcaption>
+          </figure>
+        IMAGE
       end
 
       def list(contents, list_type)
@@ -94,7 +93,7 @@ module Nexmo
         formatter ||= Rouge::Formatters::HTML.new
         highlighted_source = formatter.format(lexer.lex(code))
 
-        code_snippet_body(lexer, highlighted_source)
+        code_snippet_body(lexer, highlighted_source, @options)
       end
     end
   end

data/lib/nexmo_markdown_renderer/filters/partial_filter.rb

@@ -4,7 +4,7 @@ module Nexmo
       def call(input)
         input.gsub(/```partial(.+?)```/m) do |_s|
           config = YAML.safe_load($1)
-          file_path = if config['source'].starts_with? 'app/views'
+          file_path = if config['source'].start_with? 'app/views'
                         "#{Rails.root}/#{config['source']}"
                       else
                         "#{Nexmo::Markdown::Config.docs_base_path}/#{config['source']}"

data/lib/nexmo_markdown_renderer/filters/tab_filter.rb

@@ -209,7 +209,9 @@ module Nexmo
         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[:body] = Nexmo::Markdown::Renderer.new(
+          options.merge(block: content[:tab_title].parameterize)
+        ).call(source)
 
         content
       end

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

@@ -3,7 +3,7 @@ module Nexmo
     module CodeSnippetRenderer
       class Base
         def self.inherited(base)
-          base.extend ActionView::Helpers::TranslationHelper
+          base.extend ::ActionView::Helpers::TranslationHelper
           base.instance_variable_set :@virtual_path, "services.#{base.name.underscore.tr('/', '.')}"
         end
       end

data/lib/nexmo_markdown_renderer/services/doc_finder.rb

@@ -56,7 +56,7 @@ module Nexmo
       # rubocop:enable Metrics/ParameterLists
 
       def self.build_doc(root:, language:, key:)
-        if root.starts_with?('app/views')
+        if root.start_with?('app/views')
           DocFinder::Doc.new(path: dictionary.fetch(key) && key, available_languages: ['en'])
         else
           available_languages = dictionary.fetch(key)
@@ -92,7 +92,7 @@ module Nexmo
 
       def self.load_english
         paths.each do |path|
-          if defined?(Rails) && path.starts_with?("#{Rails.root}/app/views")
+          if defined?(Rails::Application) && path.start_with?("#{Rails.root}/app/views")
             Dir["#{path}/**/*.*"].each do |file|
               dictionary[file.gsub("#{Rails.root}/", '')][::I18n.default_locale.to_s] = ::I18n.default_locale.to_s
             end

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

@@ -6,7 +6,7 @@
     <div id="acc<%=id %>" class="Vlt-accordion__content Vlt-accordion__content--noborder">
         <p><%= ::I18n.t('.code_snippets.nexmo_application_contains_html') %></p>
         <h4><%= ::I18n.t('.code_snippets.install_the_cli') %></h4>
-        <pre class="Vlt-prism--dark dependencies command-line Vlt-prism--copy-disabled language-bash" data-prompt='$'><code>npm install -g nexmo-cli</code></pre>
+        <pre class="Vlt-prism--dark dependencies command-line language-bash" data-prompt='$'><code>npm install -g nexmo-cli</code></pre>
 
         <h4><%= ::I18n.t('.code_snippets.create_an_app') %></h4>
         <p><%= ::I18n.t('.code_snippets.once_you_have_the_cli_installed_html') %></p>
@@ -15,7 +15,7 @@
           <p><%= ::I18n.t('.code_snippets.nexmo_needs_to_connect_html') %></p>
         <% end %>
 
-        <pre class="Vlt-prism--dark dependencies command-line Vlt-prism--copy-disabled language-bash" data-prompt='$'><code>nexmo app:create "<%= name %>" <%= answer_url %> <%= event_url %> --keyfile=private.key --type=rtc</code></pre>
+        <pre class="Vlt-prism--dark dependencies command-line language-bash" data-prompt='$'><code>nexmo app:create "<%= name %>" <%= answer_url %> <%= event_url %> --keyfile=private.key --type=rtc</code></pre>
 
         <h4><%= ::I18n.t('.code_snippets.application_rtc.use_your_existing_app') %></h4>
 

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

@@ -9,7 +9,7 @@
         <% else %>
             <p><%= ::I18n.t('.code_snippets.nexmo_application_contains_html') %></p>
             <h4><%= ::I18n.t('.code_snippets.install_the_cli') %></h4>
-            <pre class="Vlt-prism--dark dependencies command-line Vlt-prism--copy-disabled language-bash" data-prompt='$'><code>npm install -g nexmo-cli</code></pre>
+            <pre class="Vlt-prism--dark dependencies command-line language-bash" data-prompt='$'><code>npm install -g nexmo-cli</code></pre>
 
             <h4><%= ::I18n.t('.code_snippets.create_an_app') %></h4>
             <p><%= ::I18n.t('.code_snippets.once_you_have_the_cli_installed_html') %></p>
@@ -18,7 +18,7 @@
               <p><%= ::I18n.t('.code_snippets.nexmo_needs_to_connect_html') %></p>
             <% end %>
 
-            <pre class="Vlt-prism--dark dependencies command-line Vlt-prism--copy-disabled language-bash" data-prompt='$'><code>nexmo app:create "<%= name %>" <%= answer_url %> <%= event_url %> --keyfile private.key</code></pre>
+            <pre class="Vlt-prism--dark dependencies command-line language-bash" data-prompt='$'><code>nexmo app:create "<%= name %>" <%= answer_url %> <%= event_url %> --keyfile private.key</code></pre>
         <% end %>
     </div>
 </div>

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

@@ -1,6 +1 @@
-<div class="copy-wrapper">
-  <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="language-<%= lexer.tag %> main-code Vlt-prism--dark Vlt-prism--copy-disabled"><code><%= highlighted_code_source %></code></pre>
-</div>
+<pre class="language-<%= lexer.tag %> main-code Vlt-prism--dark" data-lang="<%= lang %>" data-block="<%= config['source'] %>" data-section="code"><code><%= highlighted_code_source %></code></pre>

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

@@ -5,13 +5,7 @@
 
   <div id="acc<%=id %>" class="Vlt-accordion__content Vlt-accordion__content--noborder">
     <%= create_instructions %>
-    <div class="copy-wrapper">
-
-      <div class="copy-button" data-lang="<%= lang %>" data-block="<%= source %>" data-section="configure">
-        <%= octicon "clippy", :class => 'top left' %> <span>Copy to Clipboard</span>
-      </div>
-      <pre class="Vlt-prism--dark language-<%= lexer.tag %> Vlt-prism--copy-disabled"><code><%= highlighted_client_source %></code></pre>
-    </div>
+    <pre class="Vlt-prism--dark language-<%= lexer.tag %>" data-lang="<%= lang %>" data-block="<%= source %>" data-section="configure"><code><%= highlighted_client_source %></code></pre>
 
     <p><a data-section="configure" data-lang="<%= lang %>" data-block="<%= 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-accordion__content Vlt-accordion__content--noborder">
 		    <p><%=deps['text']%></p>
         <% if deps['code'] %>
-		    <pre class="Vlt-prism--dark language-<%= deps['type'] || 'bash' %> dependencies command-line Vlt-prism--copy-disabled" data-prompt='$'><code><%=deps['code']%></code></pre>
+		    <pre class="Vlt-prism--dark language-<%= deps['type'] || 'bash' %> dependencies command-line" data-prompt='$'><code><%=deps['code']%></code></pre>
         <% end %>
 	</div>
 </div>

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

@@ -5,13 +5,7 @@
 
   <div id="acc<%=id %>" class="Vlt-accordion__content Vlt-accordion__content--noborder">
     <%= create_instructions %>
-    <div class="copy-wrapper">
-
-      <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="Vlt-prism--dark language-<%= lexer.tag %> Vlt-prism--copy-disabled"><code><%= highlighted_import_source %></code></pre>
-    </div>
+    <pre class="Vlt-prism--dark language-<%= lexer.tag %>" data-lang="<%= lang %>" data-block="<%= config['source'] %>" data-section="configure"><code><%= highlighted_import_source %></code></pre>
 
     <p><a data-section="configure" data-lang="<%= lang %>" data-block="<%= config['source'] %>" href="<%= client_url %>">View full source</a></p>
   </div>

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

@@ -1,13 +1,7 @@
 <h2 class="Vlt-title--margin-top3"><%= ::I18n.t('.code_snippets.write_code.write_the_code') %></h2>
 <%= add_instructions %>
 
-<div class="copy-wrapper">
-  <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="language-<%= lexer.tag %> main-code Vlt-prism--dark Vlt-prism--copy-disabled"><code><%= highlighted_code_source %></code></pre>
-
-</div>
+<pre class="language-<%= lexer.tag %> main-code Vlt-prism--dark" data-lang="<%= lang %>" data-block="<%= config['source'] %>" data-section="code"><code><%= highlighted_code_source %></code></pre>
 
 <p><a data-section="code" data-lang="<%= lang %>" data-block="<%= config['source'] %>" href="<%= source_url %>"><%= ::I18n.t('.code_snippets.write_code.view_full_source') %></a></p>
 

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo_markdown_renderer
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.8.0
 platform: ruby
 authors:
 - Nexmo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-14 00:00:00.000000000 Z
+date: 2021-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: banzai
@@ -25,63 +25,63 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.1.2
 - !ruby/object:Gem::Dependency
-  name: octicons_helper
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.2'
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.2'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 2.0.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 2.0.7
 - !ruby/object:Gem::Dependency
-  name: rouge
+  name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.7
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.7
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: activemodel
+  name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -233,6 +233,7 @@ files:
 - config/dynamic_content.yml
 - config/locales/en.yml
 - lib/nexmo_markdown_renderer.rb
+- lib/nexmo_markdown_renderer/cli.rb
 - lib/nexmo_markdown_renderer/config/load_config.rb
 - lib/nexmo_markdown_renderer/core_ext/string.rb
 - lib/nexmo_markdown_renderer/filters/anchor_filter.rb