nexmo_markdown_renderer 0.4.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3f2fe624417d3d2acb266f3231d0155449c65c898f8be479dac44ad3e102ca8
-  data.tar.gz: acd7954ba9497e2eb70ab42593399492fd35142f35e02736daa7ed8a31cab97c
+  metadata.gz: 41ef7bc208bcb98d22e13d771819af665bedfd65c2c5b8b1516b50bdcd0f0ed7
+  data.tar.gz: 5e6507ad1e17a66325a07b45397654798dbe0ae556a1633989ec4615a6f0569a
 SHA512:
-  metadata.gz: 342774f31333d182961bdb3ccc58478f5565795d42b916de02963167d16b688ebe0816f167f0c31ace9d63c8528cc60a33366c826a00c9c7687f207b074eb5d3
-  data.tar.gz: abbd6f026b698bd3ca5bf8db2c28139403e28a3198426d23c804c7dd8668c747dcee0a9a113020f777ca2ee685ec3a7a70d32c2bd472e9cbff3c4dbdda1af61c
+  metadata.gz: ca682dbe30887f444fe7d858ab5090e3f1f3b07da8fdfd2b015adfff08a03dace1dd4f72d1d72266b8a787f4529e235839511237a5f0fd96966eaa7c51f5a453
+  data.tar.gz: 0df50b173c98b7b3e70c8f46790e224a3eabef5220edf0cd5c11909923c2ce1bfa018e065a4b971d49af84174dc26940d2cbc9e2e51cae20ecc6da410b7ff75b

data/lib/nexmo_markdown_renderer.rb

@@ -51,4 +51,6 @@ require_relative 'nexmo_markdown_renderer/filters/code_snippet/run'
 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 }
+Dir[File.join(__dir__, 'nexmo_markdown_renderer/filters/i18n/smartling', '*.rb')].each { |file| require_relative file }
+Dir[File.join(__dir__, 'nexmo_markdown_renderer/pipelines/smartling', '*.rb')].each { |file| require_relative file }
 require_relative 'nexmo_markdown_renderer/markdown_renderer'

data/lib/nexmo_markdown_renderer/filters/i18n/frontmatter_filter.rb

@@ -11,6 +11,5 @@ module Nexmo
         end
       end
     end
-    
   end
-end
+end

data/lib/nexmo_markdown_renderer/filters/i18n/smartling/code_block_filter.rb

@@ -0,0 +1,20 @@
+module Nexmo
+  module Markdown
+    module I18n
+      module Smartling
+        class CodeBlockFilter < Banzai::Filter
+          def call(input)
+            input.gsub(/\n\n\s{4}(.*?)\n\n/m) do
+              <<~CODE_BLOCK
+
+                ````
+                #{$1.split(/\n\s{4}/).join("\n")}
+                ````
+              CODE_BLOCK
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nexmo_markdown_renderer/filters/i18n/smartling/escape_filter.rb

@@ -0,0 +1,13 @@
+module Nexmo
+  module Markdown
+    module I18n
+      module Smartling
+        class EscapeFilter < Banzai::Filter
+          def call(input)
+            input.gsub('\-', '-').gsub('\|', '|').gsub('\[', '[').gsub('\]', ']').gsub('\(', '(').gsub('\)', ')').gsub(/^>\s\n+/, "\n")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nexmo_markdown_renderer/filters/i18n/smartling/frontmatter_filter.rb

@@ -0,0 +1,22 @@
+module Nexmo
+  module Markdown
+    module I18n
+      module Smartling
+        class FrontmatterFilter < Banzai::Filter
+          def call(input)
+            input.gsub(/\A\*\*\* \*\* \* \*\* \*\*\*\n*([^-]*)\n*-+/m) do |_frontmatter|
+              front = $1.gsub(/`(.*):`(.*)/) do |_config|
+                "#{$1}: #{$2}"
+              end
+              <<~FRONTMATTER
+                ---
+                #{front}
+                ---
+              FRONTMATTER
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nexmo_markdown_renderer/filters/snippet_variables_filter.rb

@@ -0,0 +1,34 @@
+module Nexmo
+  module Markdown
+    class SnippetVariablesFilter < Banzai::Filter
+      def call(input)
+        input.gsub(/```snippet_variables(.+?)```/m) do |_s|
+          config = YAML.safe_load(Regexp.last_match(1))
+
+          raise 'No variables provided' unless config
+          raise 'Must provide an array' unless config.is_a?(Array)
+
+          output = <<~HEREDOC
+            Key | Description
+            -- | --
+          HEREDOC
+          config.each do |key|
+            details = variables[key]
+            raise "#{key} is not a valid snippet variable" unless details
+            raise "#{key} does not have a description" unless details['description']
+
+            output += <<~HEREDOC
+              `#{key}` | #{details['description']}
+            HEREDOC
+          end
+
+          output
+        end
+      end
+
+      def variables
+        @variables ||= YAML.safe_load(File.read("#{Nexmo::Markdown::Config.docs_base_path}/config/code_snippet_variables.yml"))
+      end
+    end
+  end
+end

data/lib/nexmo_markdown_renderer/filters/tooltip_filter.rb

@@ -2,7 +2,7 @@ module Nexmo
   module Markdown
     class TooltipFilter < Banzai::Filter
       def call(input)
-        input.gsub(/\^\[([a-zA-Z0-9\s:\-]+)\]\((.+?)\)/) do
+        input.gsub(/\^\[([\p{Han}a-zA-Z0-9\s:\-]+)\]\((.+?)\)/) do
           tooltip = <<~HEREDOC
             <span class="Vlt-tooltip Vlt-tooltip--top" title="#{$2}" tabindex="0">
               #{$1}&nbsp;

data/lib/nexmo_markdown_renderer/markdown_renderer.rb

@@ -29,6 +29,7 @@ module Nexmo
           ConceptListFilter.new(options),
           LanguageFilter,
           ColumnsFilter,
+          SnippetVariablesFilter,
           MarkdownFilter.new(options),
 
           # As HTML

data/lib/nexmo_markdown_renderer/models/code_snippet.rb

@@ -3,20 +3,20 @@ module Nexmo
     class CodeSnippet
       include ActiveModel::Model
       attr_accessor :title, :product, :category, :navigation_weight, :document_path, :url
-    
+
       def self.by_product(product)
         all.select do |block|
           block.product == product
         end
       end
-    
+
       def self.all
         blocks = files.map do |document_path|
           document = File.read(document_path)
           product = extract_product(document_path)
-    
+
           frontmatter = YAML.safe_load(document)
-    
+
           Nexmo::Markdown::CodeSnippet.new({
             title: frontmatter['title'],
             navigation_weight: frontmatter['navigation_weight'] || 999,
@@ -26,47 +26,50 @@ module Nexmo
             url: generate_url(document_path),
           })
         end
-    
+
         blocks.sort_by(&:navigation_weight)
       end
-    
+
       def self.generate_url(path)
         '/' + path.gsub(%r{#{origin}/\w{2}/}, '').gsub('.md', '')
       end
-    
+
       def self.extract_product(path)
         # Remove the prefix
         path = path.gsub!(%r{#{origin}/\w{2}/}, '')
-    
+
         # Each file is in the form code-snippets/<title>.md, so let's remove everything after code-snippets
         path = path.gsub(%r{/code-snippets/.*}, '')
-    
+
         path
       end
-    
+
       def self.extract_category(path)
         # Remove the prefix
         path = path.gsub(%r{#{origin}/\w{2}/}, '')
-    
+
         # Each file is in the form code-snippets/<title>.md, so let's capture everything after code-snippets
         path = path.gsub(%r{.*/code-snippets/(.*)$}, '\1')
-    
+
         parts = path.split('/')
         parts = parts[0...-1]
-    
+
         return nil if parts.empty?
-    
+
         parts.join('/').tr('-', ' ').humanize
       end
-    
+
       def self.files
-        Dir.glob("#{origin}/**/code-snippets/**/*.md")
+        root = "#{origin}/#{::I18n.default_locale}"
+        Dir.glob("#{root}/**/code-snippets/**/*.md").map do |path|
+          DocFinder.find(root: origin, document: path.gsub(root, ''), language: ::I18n.locale).path
+        end
       end
-    
+
       def self.origin
         "#{Nexmo::Markdown::Config.docs_base_path}/_documentation"
       end
     end
-    
+
   end
 end

data/lib/nexmo_markdown_renderer/pipelines/smartling/download.rb

@@ -0,0 +1,17 @@
+module Nexmo
+  module Markdown
+    module Pipelines
+      module Smartling
+        class Download < Banzai::Pipeline
+          def initialize(_options = {})
+            super(
+              I18n::Smartling::FrontmatterFilter,
+              I18n::Smartling::EscapeFilter,
+              I18n::Smartling::CodeBlockFilter
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nexmo_markdown_renderer/pipelines/smartling/preprocessor.rb

@@ -0,0 +1,15 @@
+module Nexmo
+  module Markdown
+    module Pipelines
+      module Smartling
+        class Preprocessor < Banzai::Pipeline
+          def initialize(_options = {})
+            super(
+              I18n::FrontmatterFilter
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,9 +1,9 @@
-<div class="Vlt-box Vlt-box--lesspadding Nxd-accordion-emphasis">
-  <h5 class="Vlt-js-accordion__trigger Vlt-accordion__trigger" data-accordion="acc<%= id %>" tabindex="0">
+<div class="Vlt-box Vlt-box--lesspadding Nxd-accordion-emphasis Vlt-accordion">
+  <button class="Vlt-accordion__trigger" data-accordion="acc<%= id %>" tabindex="0">
     <%= app['use_existing'] ? ::I18n.t('.code_snippets.use_your_app') : ::I18n.t('.code_snippets.create_an_app') %>
-  </h5>
+  </button>
 
-  <div id="acc<%=id %>"  class="Vlt-js-accordion__content Vlt-accordion__content Vlt-accordion__content--noborder">
+  <div id="acc<%=id %>" class="Vlt-accordion__content Vlt-accordion__content--noborder">
     <%= ::I18n.t('.code_snippets.application_messages_dispatch.no_application_html') %>
   </div>
 </div>

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

@@ -1,9 +1,9 @@
-<div class="Vlt-box Vlt-box--lesspadding Nxd-accordion-emphasis">
-    <h5 class="Vlt-js-accordion__trigger Vlt-accordion__trigger" data-accordion="acc<%= id %>" tabindex="0">
+<div class="Vlt-box Vlt-box--lesspadding Nxd-accordion-emphasis Vlt-accordion">
+    <button class="Vlt-accordion__trigger" data-accordion="acc<%= id %>" tabindex="0">
       <%= ::I18n.t('.code_snippets.create_an_app') %>
-    </h5>
+    </button>
 
-    <div id="acc<%=id %>" class="Vlt-js-accordion__content Vlt-accordion__content Vlt-accordion__content--noborder">
+    <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>

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

@@ -1,9 +1,9 @@
-<div class="Vlt-box Vlt-box--lesspadding Nxd-accordion-emphasis">
-    <h5 class="Vlt-js-accordion__trigger Vlt-accordion__trigger" data-accordion="acc<%= id %>" tabindex="0">
+<div class="Vlt-box Vlt-box--lesspadding Nxd-accordion-emphasis Vlt-accordion">
+    <button class="Vlt-accordion__trigger" data-accordion="acc<%= id %>" tabindex="0">
         <%= app['use_existing'] ? ::I18n.t('.code_snippets.use_your_app') : ::I18n.t('.code_snippets.create_an_app') %>
-    </h5>
+    </button>
 
-    <div id="acc<%=id %>"  class="Vlt-js-accordion__content Vlt-accordion__content Vlt-accordion__content--noborder">
+    <div id="acc<%=id %>" class="Vlt-accordion__content Vlt-accordion__content--noborder">
         <% if app['use_existing'] %>
             <p><%= app['use_existing'] %></p>
         <% else %>

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

@@ -1,9 +1,9 @@
-<div class="Vlt-box Vlt-box--lesspadding Nxd-accordion-emphasis">
-	<h5 class="Vlt-js-accordion__trigger Vlt-accordion__trigger" data-accordion="acc<%= id %>" tabindex="0">
-          <%= ::I18n.t('.code_snippets.configure_client.initialize_dependencies') %>
-	</h5>
+<div class="Vlt-box Vlt-box--lesspadding Nxd-accordion-emphasis Vlt-accordion">
+  <button class="Vlt-accordion__trigger" data-accordion="acc<%= id %>" tabindex="0">
+    <%= ::I18n.t('.code_snippets.configure_client.initialize_dependencies') %>
+  </button>
 
-	<div id="acc<%=id %>"  class="Vlt-js-accordion__content Vlt-accordion__content Vlt-accordion__content--noborder">
+  <div id="acc<%=id %>" class="Vlt-accordion__content Vlt-accordion__content--noborder">
     <%= create_instructions %>
     <div class="copy-wrapper">
 

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

@@ -1,7 +1,7 @@
-<div class="Vlt-box Vlt-box--lesspadding Nxd-accordion-emphasis">
-	<h5 class="Vlt-js-accordion__trigger Vlt-accordion__trigger" data-accordion="acc<%= id %>" tabindex="0"><%= title %></h5>
+<div class="Vlt-box Vlt-box--lesspadding Vlt-accordion Nxd-accordion-emphasis">
+	<button class="Vlt-accordion__trigger" data-accordion="acc<%= id %>" tabindex="0"><%= title %></button>
 
-	<div id="acc<%= id %>" class="Vlt-js-accordion__content Vlt-accordion__content Vlt-accordion__content--noborder">
+	<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>

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

@@ -1,9 +1,9 @@
-<div class="Vlt-box Vlt-box--lesspadding Nxd-accordion-emphasis">
-  <h5 class="Vlt-js-accordion__trigger Vlt-accordion__trigger" data-accordion="acc<%= id %>" tabindex="0">
+<div class="Vlt-box Vlt-box--lesspadding Nxd-accordion-emphasis Vlt-accordion">
+  <button class="Vlt-accordion__trigger" data-accordion="acc<%= id %>" tabindex="0">
     <%= ::I18n.t('.code_snippets.configure_client.import_dependencies') %>
-  </h5>
+  </button>
 
-  <div id="acc<%=id %>"  class="Vlt-js-accordion__content Vlt-accordion__content Vlt-accordion__content--noborder">
+  <div id="acc<%=id %>" class="Vlt-accordion__content Vlt-accordion__content--noborder">
     <%= create_instructions %>
     <div class="copy-wrapper">
 

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo_markdown_renderer
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Nexmo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-03 00:00:00.000000000 Z
+date: 2020-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: banzai
@@ -260,7 +260,9 @@ files:
 - lib/nexmo_markdown_renderer/filters/frontmatter_filter.rb
 - lib/nexmo_markdown_renderer/filters/heading_filter.rb
 - lib/nexmo_markdown_renderer/filters/i18n/frontmatter_filter.rb
-- lib/nexmo_markdown_renderer/filters/i18n/smartling_converter_filter.rb
+- lib/nexmo_markdown_renderer/filters/i18n/smartling/code_block_filter.rb
+- lib/nexmo_markdown_renderer/filters/i18n/smartling/escape_filter.rb
+- lib/nexmo_markdown_renderer/filters/i18n/smartling/frontmatter_filter.rb
 - lib/nexmo_markdown_renderer/filters/icon_filter.rb
 - lib/nexmo_markdown_renderer/filters/indent_filter.rb
 - lib/nexmo_markdown_renderer/filters/inline_escape_filter.rb
@@ -274,6 +276,7 @@ files:
 - 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
 - lib/nexmo_markdown_renderer/filters/tooltip_filter.rb
@@ -293,6 +296,8 @@ files:
 - 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
 - lib/nexmo_markdown_renderer/services/code_snippet_renderer/android.rb
 - lib/nexmo_markdown_renderer/services/code_snippet_renderer/base.rb
 - lib/nexmo_markdown_renderer/services/code_snippet_renderer/curl.rb

data/lib/nexmo_markdown_renderer/filters/i18n/smartling_converter_filter.rb

@@ -1,22 +0,0 @@
-module Nexmo
-  module Markdown
-    module I18n
-      class SmartlingConverterFilter < Banzai::Filter
-        def call(input)
-          input = input.gsub(/\A\*\*\* \*\* \* \*\* \*\*\*\n*(.*)\n*------------------------------------------/m) do |_frontmatter|
-            front = $1.gsub(/`(.*):`(.*)/) do |_config|
-              "#{$1}:#{$2}"
-            end
-            <<~FRONTMATTER
-              ---
-              #{front}
-              ---
-            FRONTMATTER
-          end
-          input.gsub('\-', '-').gsub('\|', '|')
-        end
-      end
-    end
-    
-  end
-end