nexmo_markdown_renderer 0.6.0 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41ef7bc208bcb98d22e13d771819af665bedfd65c2c5b8b1516b50bdcd0f0ed7
-  data.tar.gz: 5e6507ad1e17a66325a07b45397654798dbe0ae556a1633989ec4615a6f0569a
+  metadata.gz: 223be8922220948e621ffb0b0c8ff486358f8262b3507071f7fc78817f6d0e24
+  data.tar.gz: 933d10ac4261586660cbc3642fbd9f6b2ed78249222d822b76b1798f708cf0da
 SHA512:
-  metadata.gz: ca682dbe30887f444fe7d858ab5090e3f1f3b07da8fdfd2b015adfff08a03dace1dd4f72d1d72266b8a787f4529e235839511237a5f0fd96966eaa7c51f5a453
-  data.tar.gz: 0df50b173c98b7b3e70c8f46790e224a3eabef5220edf0cd5c11909923c2ce1bfa018e065a4b971d49af84174dc26940d2cbc9e2e51cae20ecc6da410b7ff75b
+  metadata.gz: 46ebc7af03925d304df282b1fe09bbcd6bb3d6be83ca6e02db2b2220dfeff924f6e0d640be7ff2cf8416566653123a7472f822de75aa2162262e34c005ab6808
+  data.tar.gz: 7cfe33bd3212392b6654a60ac2148817525abb530080701359648d9d6e67603063755db5eca09e1ee4b534f5490b4113a5b94116d5a178c06da6e324f75557ba

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,9 +4,20 @@ 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

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

@@ -1,17 +1,33 @@
-module Nexmo
+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|
+            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

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

@@ -13,12 +13,16 @@ module Nexmo
             -- | --
           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']
+
+            # We have some variables in the format TO_NUMBER.SMS etc, and we only want to render the first segment
+            # This can be multiple segments e.g. UUID.MODIFY.VOICE will be rendered as UUID
+            title = key.split('.').first
 
             output += <<~HEREDOC
-              `#{key}` | #{details['description']}
+              `#{title}` | #{details}
             HEREDOC
           end
 

data/lib/nexmo_markdown_renderer/models/use_case.rb

@@ -65,7 +65,7 @@ module Nexmo
       end
 
       private_class_method def self.files
-        Dir.glob("#{origin}/**/*.md")
+        Dir.glob("#{origin}/#{::I18n.default_locale}/**/*.md")
       end
     end
   end

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

@@ -6,8 +6,7 @@ module Nexmo
           def initialize(_options = {})
             super(
               I18n::Smartling::FrontmatterFilter,
-              I18n::Smartling::EscapeFilter,
-              I18n::Smartling::CodeBlockFilter
+              I18n::Smartling::EscapeFilter
             )
           end
         end

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

@@ -5,7 +5,7 @@ module Nexmo
         class Preprocessor < Banzai::Pipeline
           def initialize(_options = {})
             super(
-              I18n::FrontmatterFilter
+              I18n::FrontmatterFilter,
             )
           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

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo_markdown_renderer
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.4
 platform: ruby
 authors:
 - Nexmo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-25 00:00:00.000000000 Z
+date: 2020-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: banzai
@@ -260,7 +260,6 @@ 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/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

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

@@ -1,20 +0,0 @@
-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