nexmo_markdown_renderer 0.4.5 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fed5ac6ec1e55aa65964370c584baa463dbc160d0e27eb649489ce866298f713
-  data.tar.gz: cb14711f686b58901619ed1dea31f171d8283c1afa5eb6413cf8e989a004a421
+  metadata.gz: 77ca5e9a51e8e1d8d1e0d3e0fad14c48fb01ab3fc67e893e2c2e45f1061b0d5d
+  data.tar.gz: d83bcc9efe2cd831553a5dc9c362f2f6db75fd3553ebad6d312172571fdcf23a
 SHA512:
-  metadata.gz: 272e32a46296d8273f4242bc3a728c3bb9e6cdb8aeb53a9f8a78dc6ea30d636cb9a41122fa4eea3b1635d0e8e6702bc81b2d2075d957b1e8013b7781994ec7bb
-  data.tar.gz: af90dfafa2ae3c9de263d36edfba57ed6af5a3c16aeb44abfc974fd2856512e0ec84e4d515aff280506a93d5f290f429d58040ecc31adfd4d8117f2867d560de
+  metadata.gz: 951a51a1bdebc045a64769796ce16aaa1262c3f889730485aff1051a320f4b21c658505ace846cfc0b7dd9ed6db75d8cb1046eba2481c4b4ec79b623980ce6c7
+  data.tar.gz: 4b93e1a292a403cc32726d63ff18eba1ebb6f26fc6e28e944fa4fb87eebd5682466edfa83620d21d6e1b3bf5386da4963900b620e9ec65e439552fc63b244871

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/concerns/prism_code_snippet.rb

@@ -2,9 +2,16 @@ module Nexmo
   module Markdown
     module Concerns
       module PrismCodeSnippet
+        include OcticonsHelper
+
         def code_snippet_body(lexer, body)
           <<~HEREDOC
-            <pre class="#{prism_css_classes(lexer)}"><code>#{body}</code></pre>
+            <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>
           HEREDOC
         end
 

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

@@ -4,13 +4,23 @@ module Nexmo
       class FrontmatterFilter < Banzai::Filter
         def call(input)
           input.gsub(/\A(---.+?---)/mo) do |frontmatter|
-            frontmatter.gsub(/(\w*:)/) do |_key|
-              "```#{$1}```"
+            output = frontmatter.gsub(/^languages:\n(^\s+- ([a-zA-Z]+)\n)+/) do |languages|
+              languages.gsub(/^\s+- ([a-zA-Z]+)\n+/) do |language|
+                "  - ```#{$1}```\n\n"
+              end
             end
+            output = output.gsub(/^(\w*:)(.*)\n/) do |_key|
+              if $1 == "products:"
+                "```#{$1}#{$2}```\n\n"
+              else
+                "```#{$1}```#{$2}\n\n"
+              end
+            end
+
+            output
           end
         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,38 @@
+module Nexmo
+  module Markdown
+    module I18n
+      module Smartling
+        class FrontmatterFilter < Banzai::Filter
+          def call(input)
+            input.gsub(/\A\*\*\* \*\* \* \*\* \*\*\*\n*(.*\n)!?(----+|\*\*\* \*\* \* \*\* \*\*\*)\n*/m) do |_frontmatter|
+              front = $1.gsub(/`products: (.*)`\n\n/) do |products|
+                "products: #{$1}\n\n"
+              end
+
+              front = front.gsub(/`(.*):`(.*)/) do |_config|
+                "#{$1}: #{$2}"
+              end
+
+              front = front.gsub(/languages: \n\n(.*)\n/m) do |_languages|
+                languages = $1.split("\n\n").map do |lang|
+                  lang.gsub(/\* `(.*)`/) { |_l| "  - #{$1}" }
+                end
+                <<~LANGUAGES
+                languages:
+                #{languages.join("\n")}
+                LANGUAGES
+              end
+
+              <<~FRONTMATTER
+                ---
+                #{front}
+                ---
+
+              FRONTMATTER
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nexmo_markdown_renderer/filters/markdown_filter.rb

@@ -91,8 +91,10 @@ module Nexmo
           code.gsub! /^    /, "\t"
         end
 
-        formatter = ::Rouge::Formatters::HTMLLegacy.new(:css_class => prism_css_classes(lexer))
-        formatter.format(lexer.lex(code))
+        formatter ||= Rouge::Formatters::HTML.new
+        highlighted_source = formatter.format(lexer.lex(code))
+
+        code_snippet_body(lexer, highlighted_source)
       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/version.rb

@@ -1,7 +1,7 @@
 # :nocov:
 module Nexmo
   module Markdown
-    VERSION = '0.4.5'
+    VERSION = '0.7.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.5
+  version: 0.7.0
 platform: ruby
 authors:
 - Nexmo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-03 00:00:00.000000000 Z
+date: 2020-11-26 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
@@ -345,7 +350,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Middleware to render Markdown Documents in Nexmo Developer Platform.

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