nexmo_markdown_renderer 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a77a40b7cc8162d5b8087bcf750f3cff31a5c0962991cb90d0f7d573ade580ec
-  data.tar.gz: 0c15812da744a7215555c04a4d026b8fe3a61454952a98c4b17255c86fd08104
+  metadata.gz: 41ef7bc208bcb98d22e13d771819af665bedfd65c2c5b8b1516b50bdcd0f0ed7
+  data.tar.gz: 5e6507ad1e17a66325a07b45397654798dbe0ae556a1633989ec4615a6f0569a
 SHA512:
-  metadata.gz: 6a37388e6c4173e69184d9836da5b7619a81439d49768bf3c08c89f84c53eb6257c1c142f91255fd2b0681c072dcfe37a9c94517ef210e356223a9e5ac56ac50
-  data.tar.gz: b4cf624eb1215e4379f938ae1688d416a7fb3bbcb347650363afb3b1d7b81f8e5f76b8d12efd3ad7a83177398b32f1af8969f87532a3cc6d69586d66f6a91037
+  metadata.gz: ca682dbe30887f444fe7d858ab5090e3f1f3b07da8fdfd2b015adfff08a03dace1dd4f72d1d72266b8a787f4529e235839511237a5f0fd96966eaa7c51f5a453
+  data.tar.gz: 0df50b173c98b7b3e70c8f46790e224a3eabef5220edf0cd5c11909923c2ce1bfa018e065a4b971d49af84174dc26940d2cbc9e2e51cae20ecc6da410b7ff75b

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/markdown_renderer.rb

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

data/lib/version.rb

@@ -1,7 +1,7 @@
 # :nocov:
 module Nexmo
   module Markdown
-    VERSION = '0.5.1'
+    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.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Nexmo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-17 00:00:00.000000000 Z
+date: 2020-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: banzai
@@ -276,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