nexmo_markdown_renderer 0.7.3 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38cea45d573308382ed4530bfd3b3b392e87514a86df6b821881f522cb3dded4
-  data.tar.gz: 234917b592760ce49d22836c342a12c2286b70aec5671ad7fd11554e3b6a3ddf
+  metadata.gz: c5f7ec6e1a0aa5cd9d02e330977fdf11cd56e30b655f9be0d358efa630a4b509
+  data.tar.gz: c262fead10478978a755062747b2feb30514030b4c549d0ddacce0ebb0d3deb9
 SHA512:
-  metadata.gz: 536ed550435b24e2b35fe0e08b7da328e4be38aff69b90710e525286a52fdc29ee10b83a34721117da42021c32633c65fc6124971659ab6f75830bd90c82949a
-  data.tar.gz: d491156845bae84395820e5e33cc0bbba312281e72b788152f055159c48a0055cfe364287ba1f739b813022e411ab09cfcdb0a2537511db2e41936fed65411bd
+  metadata.gz: cc5bb2b5eb7c29a11eb2cb293ac1a048bb5dbf8c3bc33e6161a034ecd394ee065ebfe4e5b144eaffb14faa166851fc79108e3e65d2ae4bf4a6c0b1ff80cb00c1
+  data.tar.gz: f5563a7ad92e6e46a31792bf57644cac31118d7b9ae3d0edcd7b20515dd7f3b95acd44a3d93716facbfbafd4f456210221b87bc5bcc3dda95960347f2a561424

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'
@@ -32,11 +32,6 @@ require_relative 'nexmo_markdown_renderer/services/doc_finder/doc'
 require_relative 'nexmo_markdown_renderer/models/code_language'
 require_relative 'nexmo_markdown_renderer/models/code_snippet'
 require_relative 'nexmo_markdown_renderer/models/concept'
-require_relative 'nexmo_markdown_renderer/models/tutorial'
-require_relative 'nexmo_markdown_renderer/models/tutorial/file_loader'
-require_relative 'nexmo_markdown_renderer/models/tutorial/metadata'
-require_relative 'nexmo_markdown_renderer/models/tutorial/prerequisite'
-require_relative 'nexmo_markdown_renderer/models/tutorial/task'
 require_relative 'nexmo_markdown_renderer/models/use_case'
 
 require_relative 'nexmo_markdown_renderer/filters/code_snippet/binding'

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
@@ -21,7 +20,8 @@ module Nexmo
             @highlighted_import_source ||= ::Nexmo::Markdown::Utils.generate_code_block(
               language,
               @config,
-              unindent
+              unindent,
+              renderer
             )
           end
 

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)
@@ -19,7 +18,8 @@ module Nexmo
             @highlighted_client_source ||= ::Nexmo::Markdown::Utils.generate_code_block(
               language,
               @config,
-              unindent
+              unindent,
+              renderer
             )
           end
 

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
@@ -27,7 +26,8 @@ module Nexmo
             @highlighted_code_source ||= ::Nexmo::Markdown::Utils.generate_code_block(
               language,
               @config['code'],
-              unindent
+              unindent,
+              renderer
             )
           end
 

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

@@ -29,6 +29,7 @@ module Nexmo
         tab['class'] = 'Vlt-tabs__link'
         tab['class'] += ' Vlt-tabs__link_active' if content[:active]
         tab['role'] = 'tab'
+        tab['id'] = content[:tab_title].parameterize
 
         if content[:language]
           tab['data-language'] = content[:language].key
@@ -208,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/filters/utils.rb

@@ -26,7 +26,7 @@ module Nexmo
         start_section + file_section + line_section
       end
 
-      def self.generate_code_block(language, input, unindent)
+      def self.generate_code_block(language, input, unindent, renderer)
         return '' unless input
         filename = "#{Nexmo::Markdown::Config.docs_base_path}/#{input['source']}"
         raise "CodeSnippetFilter - Could not load #{filename} for language #{language}" unless File.exist?(filename)
@@ -42,6 +42,9 @@ module Nexmo
 
         code = code.lines[from_line..to_line].join
         code.unindent! if unindent
+
+        code = renderer.post_process(code) if renderer.respond_to?(:post_process)
+
         formatter = Rouge::Formatters::HTML.new
         formatter.format(lexer.lex(code))
       end

data/lib/nexmo_markdown_renderer/markdown_renderer.rb

@@ -8,7 +8,6 @@ module Nexmo
           PhpInlinerFilter,
           InlineEscapeFilter,
           BlockEscapeFilter,
-          ScreenshotFilter,
           AnchorFilter,
           AudioFilter,
           DynamicContentFilter,

data/lib/nexmo_markdown_renderer/models/tutorial/prerequisite.rb

@@ -1,6 +1,7 @@
 module Nexmo
   module Markdown
     class Tutorial::Prerequisite
+      attr_accessor :name
       delegate :content, :yaml, to: :@file_loader
 
       def initialize(current_step:, code_language:, name:)

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/code_snippet_renderer/curl.rb

@@ -22,6 +22,14 @@ module Nexmo
         def self.add_instructions(filename)
           ::I18n.t('services.code_snippet_renderer.add_instructions_to_file', file: filename)
         end
+
+        def self.post_process(code)
+          self.strip_single_quotes(code)
+        end
+
+        def self.strip_single_quotes(code)
+          code.gsub(/"'(\$\w+)'"/, '"\1"')
+        end
       end
     end
     

data/lib/nexmo_markdown_renderer/services/doc_finder.rb

@@ -6,8 +6,8 @@ module Nexmo
       EXCLUSIONS = ['.', '..', ::I18n.default_locale.to_s].freeze
 
       class << self
-        mattr_accessor :paths
-        mattr_accessor :dictionary
+        attr_accessor :paths
+        attr_accessor :dictionary
       end
 
       # rubocop:disable Metrics/ParameterLists
@@ -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)
@@ -68,10 +68,11 @@ module Nexmo
 
       def self.build_key(root:, document:, product: nil, format: nil)
         path = if Pathname.new(document).extname.blank?
-                 "#{root}/#{product}/#{document}.#{format}"
-               else
-                 "#{root}/#{product}/#{document}"
-               end
+          [root, product, document].compact.join("/").concat(".#{format}")
+        else
+          [root, product, document].compact.join("/")
+        end
+
         path.gsub(%r{\/\/\/|\/\/}, '/')
       end
 
@@ -91,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.3'
+    VERSION = '0.9.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.3
+  version: 0.9.0
 platform: ruby
 authors:
 - Nexmo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-10 00:00:00.000000000 Z
+date: 2021-02-02 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
@@ -274,7 +275,6 @@ files:
 - lib/nexmo_markdown_renderer/filters/partial_filter.rb
 - lib/nexmo_markdown_renderer/filters/php_inliner_filter.rb
 - lib/nexmo_markdown_renderer/filters/relative_link_filter.rb
-- lib/nexmo_markdown_renderer/filters/screenshot_filter.rb
 - lib/nexmo_markdown_renderer/filters/snippet_variables_filter.rb
 - lib/nexmo_markdown_renderer/filters/tab_filter.rb
 - lib/nexmo_markdown_renderer/filters/techio_filter.rb
@@ -289,11 +289,7 @@ files:
 - lib/nexmo_markdown_renderer/models/code_language.rb
 - lib/nexmo_markdown_renderer/models/code_snippet.rb
 - lib/nexmo_markdown_renderer/models/concept.rb
-- lib/nexmo_markdown_renderer/models/tutorial.rb
-- lib/nexmo_markdown_renderer/models/tutorial/file_loader.rb
-- lib/nexmo_markdown_renderer/models/tutorial/metadata.rb
 - lib/nexmo_markdown_renderer/models/tutorial/prerequisite.rb
-- lib/nexmo_markdown_renderer/models/tutorial/task.rb
 - lib/nexmo_markdown_renderer/models/use_case.rb
 - lib/nexmo_markdown_renderer/pipelines/smartling/download.rb
 - lib/nexmo_markdown_renderer/pipelines/smartling/preprocessor.rb

data/lib/nexmo_markdown_renderer/filters/screenshot_filter.rb

@@ -1,22 +0,0 @@
-module Nexmo
-  module Markdown
-    class ScreenshotFilter < Banzai::Filter
-      def call(input)
-        input.gsub(/```screenshot(.+?)```/m) do |_s|
-          config = YAML.safe_load($1)
-          if config['image'] && File.file?("#{Nexmo::Markdown::Config.docs_base_path}/#{config['image']}")
-            "![Screenshot](#{config['image'].gsub('public', '')})"
-          else
-            <<~HEREDOC
-              ## Missing image
-              To fix this run:
-              ```
-              $ rake screenshots:update
-              ```
-            HEREDOC
-          end
-        end
-      end
-    end
-  end
-end

data/lib/nexmo_markdown_renderer/models/tutorial.rb

@@ -1,192 +0,0 @@
-module Nexmo
-  module Markdown
-    class Tutorial
-      include ActiveModel::Model
-
-      attr_reader :name, :current_step
-      delegate :path, :yaml, to: :@file_loader
-      delegate :available_code_languages, to: :metadata
-
-      def initialize(name:, current_step:, current_product: nil, code_language: nil)
-        @name         = name
-        @current_step = current_step
-        @product      = current_product
-        @language     = code_language
-        @file_loader  = load_file!
-      end
-
-      def metadata
-        @metadata ||= Metadata.new(name: name)
-      end
-
-      def current_product
-        @current_product ||= @product || metadata.default_product
-      end
-
-      def code_language
-        @code_language ||= @language || metadata.code_language
-      end
-
-      def title
-        @title ||= yaml['title'] || metadata.title
-      end
-
-      def description
-        @description ||= yaml['description'] || metadata.description
-      end
-
-      def products
-        @products ||= yaml['products'] || metadata.products
-      end
-
-      def prerequisites
-        @prerequisites ||= (yaml['prerequisites'] || []).map do |prereq|
-          Prerequisite.new(name: prereq, code_language: code_language, current_step: current_step)
-        end
-      end
-
-      def content_for(step_name)
-        if ['introduction', 'conclusion'].include? step_name
-          raise "Invalid step: #{step_name}" unless yaml[step_name]
-
-          return yaml[step_name]['content']
-        end
-
-        path = Nexmo::Markdown::DocFinder.find(
-          root: self.class.task_content_path,
-          document: step_name,
-          language: ::I18n.locale,
-          code_language: code_language
-        ).path
-
-        File.read(path)
-      end
-
-      def first_step
-        subtasks.first&.name
-      end
-
-      def prerequisite?
-        prerequisites.map(&:name).include?(@current_step)
-      end
-
-      def next_step
-        current_task_index = subtasks.map(&:name).index(@current_step)
-        return nil unless current_task_index
-
-        subtasks[current_task_index + 1]
-      end
-
-      def previous_step
-        current_task_index = subtasks.map(&:name).index(@current_step)
-        return nil unless current_task_index
-        return nil if current_task_index <= 0
-
-        subtasks[current_task_index - 1]
-      end
-
-      def subtasks
-        @subtasks ||= begin
-          tasks = []
-
-          (yaml['tasks'] || []).map do |t|
-            tasks.push(
-              Task.make_from(
-                name: t,
-                code_language: code_language,
-                current_step: current_step
-              )
-            )
-          end
-
-          tasks.unshift(prerequisite_task)
-          tasks.unshift(introduction_task)
-          tasks.push(conclusion_task)
-
-          tasks.compact
-        end
-      end
-
-      def self.load_prerequisites(prerequisites, current_step)
-        return [] unless prerequisites
-
-        prerequisites.map do |t|
-          t_path = Nexmo::Markdown::DocFinder.find(
-            root: task_content_path,
-            document: t,
-            language: ::I18n.locale
-          ).path
-          raise "Prerequisite not found: #{t}" unless File.exist? t_path
-
-          content = File.read(t_path)
-          prereq = YAML.safe_load(content)
-          {
-            'path' => t,
-            'title' => prereq['title'],
-            'description' => prereq['description'],
-            'is_active' => t == current_step,
-            'content' => content,
-          }
-        end
-      end
-
-      def prerequisite_task
-        return if prerequisites.empty?
-
-        Task.new(
-          name: 'prerequisites',
-          title: 'Prerequisites',
-          description: 'Everything you need to complete this task',
-          current_step: current_step
-        )
-      end
-
-      def introduction_task
-        return unless yaml['introduction']
-
-        Task.new(
-          name: 'introduction',
-          title: yaml['introduction']['title'],
-          description: yaml['introduction']['description'],
-          current_step: current_step
-        )
-      end
-
-      def conclusion_task
-        return unless yaml['conclusion']
-
-        Task.new(
-          name: 'conclusion',
-          title: yaml['conclusion']['title'],
-          description: yaml['conclusion']['description'],
-          current_step: current_step
-        )
-      end
-
-      def self.load(name, current_step, current_product = nil, code_language = nil)
-        new(
-          name: name,
-          current_step: current_step,
-          current_product: current_product,
-          code_language: code_language
-        )
-      end
-
-      def load_file!
-        Tutorial::FileLoader.new(
-          root: self.class.tutorials_path,
-          code_language: code_language,
-          doc_name: name
-        )
-      end
-
-      def self.task_content_path
-        "#{Nexmo::Markdown::Config.docs_base_path}/_tutorials"
-      end
-
-      def self.tutorials_path
-        'config/tutorials'
-      end
-    end
-  end
-end

data/lib/nexmo_markdown_renderer/models/tutorial/file_loader.rb

@@ -1,32 +0,0 @@
-module Nexmo
-  module Markdown
-    class Tutorial::FileLoader
-      attr_reader :root, :code_language, :doc_name, :format
-
-      def initialize(root:, code_language:, doc_name:, format: 'yml')
-        @root          = root
-        @code_language = code_language
-        @doc_name      = doc_name
-        @format        = format
-      end
-
-      def path
-        @path ||= Nexmo::Markdown::DocFinder.find(
-          root: root,
-          document: doc_name,
-          language: ::I18n.locale,
-          code_language: code_language,
-          format: format
-        ).path
-      end
-
-      def content
-        @content ||= File.read(path)
-      end
-
-      def yaml
-        @yaml ||= YAML.safe_load(content)
-      end
-    end
-  end
-end

data/lib/nexmo_markdown_renderer/models/tutorial/metadata.rb

@@ -1,57 +0,0 @@
-module Nexmo
-  module Markdown
-    class Tutorial::Metadata
-      attr_reader :name, :file_loader
-      delegate :path, :yaml, to: :file_loader
-
-      def initialize(name:)
-        @name        = name
-        @file_loader = load_file!
-      end
-
-      def products
-        @products ||= yaml['products'] || []
-      end
-
-      def title
-        @title ||= yaml['title']
-      end
-
-      def description
-        @description ||= yaml['description']
-      end
-
-      def external_link
-        @external_link ||= yaml['external_link']
-      end
-
-      def available_code_languages
-        @available_code_languages ||= begin
-                                        DocFinder
-                                          .code_languages_for_tutorial(path: path.sub('.yml', '/'))
-                                          .map { |file_path| File.basename(Pathname.new(file_path).basename, '.yml') }
-                                          .sort_by { |l| CodeLanguage.find(l).weight }
-                                      end
-      end
-
-      def code_language
-        @code_language ||= begin
-                             available_code_languages
-                               .min_by { |k| CodeLanguage.languages.map(&:key).index(k) }
-                           end
-      end
-
-      def default_product
-        @default_product ||= products.first
-      end
-
-      def load_file!
-        Tutorial::FileLoader.new(
-          root: Tutorial.tutorials_path,
-          code_language: nil,
-          doc_name: @name
-        )
-      end
-    end
-  end
-end

data/lib/nexmo_markdown_renderer/models/tutorial/task.rb

@@ -1,49 +0,0 @@
-module Nexmo
-  module Markdown
-    class Tutorial::Task
-      attr_reader :name, :title, :description, :current_step
-
-      def initialize(name:, title:, description:, current_step:)
-        @name         = name
-        @title        = title
-        @description  = description
-        @current_step = current_step
-      end
-
-      def active?
-        @name == @current_step
-      end
-
-      def self.make_from(name:, code_language:, current_step:)
-        file_loader = Tutorial::FileLoader.new(
-          root: Tutorial.task_content_path,
-          doc_name: name,
-          code_language: code_language,
-          format: 'md'
-        )
-
-        new(
-          name: name,
-          title: file_loader.yaml['title'],
-          description: file_loader.yaml['description'],
-          current_step: current_step
-        )
-      end
-
-      def ==(other)
-        name == other.name &&
-          title == other.title &&
-          description == other.description &&
-          current_step == other.current_step
-      end
-
-      def eql?(other)
-        self == other
-      end
-
-      def hash
-        name.hash ^ title.hash ^ description.hash ^ current_step.hash
-      end
-    end
-  end
-end