nexmo_markdown_renderer 0.4.0 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e21f8aa58664f86273978415744faa05026ec551b1bd99a6e0f7b54f7872eff
-  data.tar.gz: ec3ea04ec8714d98ec8aa17d318999142477d58dc7a8904b96396dc982825572
+  metadata.gz: fed5ac6ec1e55aa65964370c584baa463dbc160d0e27eb649489ce866298f713
+  data.tar.gz: cb14711f686b58901619ed1dea31f171d8283c1afa5eb6413cf8e989a004a421
 SHA512:
-  metadata.gz: 9788f8896e42b0e4f84084c231669a15a588c6335b3be8df01a60f3f73b3736a6d8ec832e650943c5de8506564893a78f3c368eca93c75c1a95d4fce1cb8d267
-  data.tar.gz: 5dc5835781068ada21d52a4108381222bca7293bdff94a26668dee3110310ba61c6e97d9a1b280c04b31253cca575bdb8190aecc44851c6c623d95b1675cc9b0
+  metadata.gz: 272e32a46296d8273f4242bc3a728c3bb9e6cdb8aeb53a9f8a78dc6ea30d636cb9a41122fa4eea3b1635d0e8e6702bc81b2d2075d957b1e8013b7781994ec7bb
+  data.tar.gz: af90dfafa2ae3c9de263d36edfba57ed6af5a3c16aeb44abfc974fd2856512e0ec84e4d515aff280506a93d5f290f429d58040ecc31adfd4d8117f2867d560de

data/README.md

@@ -1,6 +1,6 @@
 # Nexmo Markdown Renderer
 
-[![Build Status](https://api.travis-ci.org/Nexmo/nexmo-markdown-renderer.svg?branch=master)](https://travis-ci.org/Nexmo/nexmo-markdown-renderer/)
+![Build Status](https://github.com/Nexmo/nexmo-markdown-renderer/workflows/CI/badge.svg)
 [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.txt)
 
 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).

data/config/code_languages.yml

@@ -109,6 +109,15 @@ languages:
     icon: ios
     dependencies: []
 
+  go:
+    weight: 12 
+    label: Go
+    lexer: go
+    icon: curl
+    dependencies:
+      - 'vonage/vonage-go-sdk'
+    run_command: 'go run {filename}'
+ 
 platforms:
   ios:
     languages:

data/lib/nexmo_markdown_renderer.rb

@@ -24,6 +24,7 @@ require_relative 'nexmo_markdown_renderer/services/code_snippet_renderer/php'
 require_relative 'nexmo_markdown_renderer/services/code_snippet_renderer/python'
 require_relative 'nexmo_markdown_renderer/services/code_snippet_renderer/ruby'
 require_relative 'nexmo_markdown_renderer/services/code_snippet_renderer/swift'
+require_relative 'nexmo_markdown_renderer/services/code_snippet_renderer/go'
 
 require_relative 'nexmo_markdown_renderer/services/doc_finder'
 require_relative 'nexmo_markdown_renderer/services/doc_finder/doc'

data/lib/nexmo_markdown_renderer/filters/code_snippet/install_dependencies.rb

@@ -5,9 +5,10 @@ module Nexmo
         class InstallDependencies
           include Renderable
 
-          def initialize(config, snippet)
+          def initialize(config, version, snippet)
             @config  = config
             @snippet = snippet
+            @version = version
           end
 
           def partial
@@ -28,7 +29,7 @@ module Nexmo
           def render
             return '' unless @config
 
-            deps = renderer.dependencies(@config)
+            deps = renderer.dependencies(@config, @version)
             ERB.new(partial).result(binding)
           end
         end

data/lib/nexmo_markdown_renderer/filters/code_snippet/renderable.rb

@@ -43,6 +43,8 @@ module Nexmo
               Nexmo::Markdown::CodeSnippetRenderer::ObjectiveC
             when 'swift'
               Nexmo::Markdown::CodeSnippetRenderer::Swift
+            when 'go'
+              Nexmo::Markdown::CodeSnippetRenderer::Go
             else
               raise "Unknown language: #{normalized_language}"
             end

data/lib/nexmo_markdown_renderer/filters/code_snippet_filter.rb

@@ -27,7 +27,7 @@ module Nexmo
       end
 
       def install_dependencies
-        @install_dependencies ||= ::Nexmo::Markdown::Filters::CodeSnippet::InstallDependencies.new(@config['dependencies'], @binding).render
+        @install_dependencies ||= ::Nexmo::Markdown::Filters::CodeSnippet::InstallDependencies.new(@config['dependencies'], @config['version'], @binding).render
       end
 
       def import_dependencies

data/lib/nexmo_markdown_renderer/filters/code_snippets_filter.rb

@@ -116,7 +116,8 @@ module Nexmo
           content['weight'] ||= defaults.weight
           content['run_command'] ||= defaults.run_command
           content['unindent'] = defaults.unindent || false
-    
+          content['version'] ||= defaults.version
+
           # If we don't have a file_name in config, use the one in the repo
           content['file_name'] ||= File.basename(content['code']['source'])
     

data/lib/nexmo_markdown_renderer/filters/markdown_filter.rb

@@ -63,7 +63,9 @@ module Nexmo
         '<figure>' \
           '<img src="'\
           "#{link}"\
-          '" alt="#{alt_text}">' \
+          '" alt="'\
+          "#{_alt_text}"\
+          '">' \
         '</figure>'
       end
 

data/lib/nexmo_markdown_renderer/filters/partial_filter.rb

@@ -5,7 +5,7 @@ module Nexmo
         input.gsub(/```partial(.+?)```/m) do |_s|
           config = YAML.safe_load($1)
           file_path = if config['source'].starts_with? 'app/views'
-                        config['source']
+                        "#{Rails.root}/#{config['source']}"
                       else
                         "#{Nexmo::Markdown::Config.docs_base_path}/#{config['source']}"
                       end

data/lib/nexmo_markdown_renderer/filters/screenshot_filter.rb

@@ -4,7 +4,7 @@ module Nexmo
       def call(input)
         input.gsub(/```screenshot(.+?)```/m) do |_s|
           config = YAML.safe_load($1)
-          if config['image'] && File.file?(config['image'])
+          if config['image'] && File.file?("#{Nexmo::Markdown::Config.docs_base_path}/#{config['image']}")
             "![Screenshot](#{config['image'].gsub('public', '')})"
           else
             <<~HEREDOC

data/lib/nexmo_markdown_renderer/filters/tab_filter.rb

@@ -10,9 +10,9 @@ module Nexmo
           @config = YAML.safe_load($3)
 
           if tabbed_folder?
-            raise "#{@config['source']} is not a directory" unless File.directory? "#{Nexmo::Markdown::Config.docs_base_path}/#{@config['source']}"
+            raise "#{@config['source']} is not a directory" unless File.directory? "#{@config['source']}"
 
-            @tabbed_config = YAML.safe_load(File.read("#{Nexmo::Markdown::Config.docs_base_path}/#{@config['source']}/.config.yml"))
+            @tabbed_config = YAML.safe_load(File.read("#{@config['source']}/.config.yml"))
             @path = @config['source']
             validate_folder_config
           else
@@ -169,7 +169,7 @@ module Nexmo
       end
 
       def content_from_folder
-        source_path = "#{Nexmo::Markdown::Config.docs_base_path}/#{@config['source']}"
+        source_path = "#{@config['source']}"
         source_path += '/*.md'
 
         files = Dir.glob(source_path)

data/lib/nexmo_markdown_renderer/filters/utils.rb

@@ -2,8 +2,8 @@ module Nexmo
   module Markdown
     class Utils
       def self.generate_source_url(code)
-        # Source example: .repos/nexmo/nexmo-java-code-snippets/ExampleClass.java
-        # Direct link on GitHub is in form https://github.com/nexmo/nexmo-java-code-snippets/blob/master/ExampleClass.java
+        # Source example: .repos/vonage/vonage-java-code-snippets/ExampleClass.java
+        # Direct link on GitHub is in form https://github.com/vonage/vonage-java-code-snippets/blob/master/ExampleClass.java
         start_section = 'https://github.com'
 
         # Insert "blob/master" and strip ".repos"
@@ -19,7 +19,7 @@ module Nexmo
             line_section += "-L#{code['to_line']}" if code['to_line']
           else
             # By default we read to the end of the file
-            line_section += "-L#{File.read(code['source']).lines.count}"
+            line_section += "-L#{File.read("#{Nexmo::Markdown::Config.docs_base_path}/#{code['source']}").lines.count}"
           end
         end
 

data/lib/nexmo_markdown_renderer/models/code_language.rb

@@ -3,8 +3,12 @@ module Nexmo
     class CodeLanguage
       include ActiveModel::Model
       attr_accessor :key, :label, :type, :dependencies, :unindent, :icon, :run_command
-      attr_writer :weight, :linkable, :languages, :lexer
-    
+      attr_writer :weight, :linkable, :languages, :lexer, :version
+
+      def version
+        @version || nil
+      end
+
       def weight
         @weight || 999
       end
@@ -72,7 +76,7 @@ module Nexmo
       end
     
       private_class_method def self.config
-        @config ||= YAML.load_file('./config/code_languages.yml')
+        @config ||= YAML.load_file("#{Nexmo::Markdown::Config.docs_base_path}/config/code_languages.yml")
       end
     end    
   end

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/android.rb

@@ -2,7 +2,7 @@ module Nexmo
   module Markdown
     module CodeSnippetRenderer
       class Android < Base
-        def self.dependencies(_deps)
+        def self.dependencies(_deps, _version)
           {
             'text' => 'See <a href="https://developer.nexmo.com/use-cases/client-sdk-android-add-sdk-to-your-app">How to Add the Nexmo Client SDK to your Android App</a>',
           }

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/curl.rb

@@ -2,7 +2,7 @@ module Nexmo
   module Markdown
     module CodeSnippetRenderer
       class Curl < Base
-        def self.dependencies(deps)
+        def self.dependencies(deps, _version)
           dependencies = deps.map(&:upcase)
           raise t('.only_permitted_dependency') unless dependencies.include?('JWT')
           {

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/dotnet.rb

@@ -2,7 +2,7 @@ module Nexmo
   module Markdown
     module CodeSnippetRenderer
       class Dotnet < Base
-        def self.dependencies(deps)
+        def self.dependencies(deps, _version)
           { 'code' => "Install-Package #{deps.join(' ')}" }
         end
     

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/go.rb

@@ -0,0 +1,23 @@
+module Nexmo
+  module Markdown
+    module CodeSnippetRenderer
+      class Go < Base
+        def self.dependencies(deps, _version)
+          { 'code' => "go get #{deps.join(' ')}" }
+        end
+    
+        def self.run_command(command, _filename, _file_path)
+          ::I18n.t('services.code_snippet_renderer.run_command', command: command)
+        end
+    
+        def self.create_instructions(filename)
+          ::I18n.t('services.code_snippet_renderer.create_instructions', filename: filename)
+        end
+    
+        def self.add_instructions(_filename)
+          ::I18n.t('services.code_snippet_renderer.add_instructions_to_code')
+        end
+      end
+    end    
+  end
+end

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/java.rb

@@ -2,16 +2,17 @@ module Nexmo
   module Markdown
     module CodeSnippetRenderer
       class Java < Base
-        def self.dependencies(deps)
+        def self.dependencies(deps, version)
+          raise "'version' not provided for Java snippet" unless version
           {
             'text' => ::I18n.t('services.code_snippet_renderer.add_instructions_to_file', file: 'build.gradle'),
-            'code' => deps.map { |d| "compile '#{d.gsub('@latest', '5.2.1')}'" }.join('<br />'),
+            'code' => deps.map { |d| "compile '#{d.gsub('@latest', version)}'" }.join('<br />'),
             'type' => 'groovy',
           }
         end
 
         def self.run_command(_command, filename, file_path)
-          package = file_path.gsub('.repos/nexmo/nexmo-java-code-snippets/src/main/java/', '').tr('/', '.').gsub(filename, '')
+          package = file_path.gsub('.repos/vonage/vonage-java-code-snippets/src/main/java/', '').tr('/', '.').gsub(filename, '')
           file = filename.gsub('.java', '')
           main = "#{package}#{filename.gsub('.java', '')}"
           chomped_package = package.chomp('.')

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/javascript.rb

@@ -2,7 +2,7 @@ module Nexmo
   module Markdown
     module CodeSnippetRenderer
       class Javascript < Base
-        def self.dependencies(deps)
+        def self.dependencies(deps, _version)
           { 'code' => "npm install #{deps.join(' ')}" }
         end
     

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/kotlin.rb

@@ -2,7 +2,7 @@ module Nexmo
   module Markdown
     module CodeSnippetRenderer
       class Kotlin < Base
-        def self.dependencies(_deps)
+        def self.dependencies(deps, _version)
           {
             'text' => 'See <a href="https://developer.nexmo.com/use-cases/client-sdk-android-add-sdk-to-your-app">How to Add the Nexmo Client SDK to your Android App</a>',
           }

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/objective_c.rb

@@ -2,7 +2,7 @@ module Nexmo
   module Markdown
     module CodeSnippetRenderer
       class ObjectiveC < Base
-        def self.dependencies(_deps)
+        def self.dependencies(_deps, _version)
           {
             'text' => 'See <a href="/client-sdk/setup/add-sdk-to-your-app/ios">How to Add the Nexmo Client SDK to your iOS App</a>',
           }

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/php.rb

@@ -2,7 +2,7 @@ module Nexmo
   module Markdown
     module CodeSnippetRenderer
       class Php < Base
-        def self.dependencies(deps)
+        def self.dependencies(deps, _version)
           { 'code' => "composer require #{deps.join(' ')}" }
         end
     

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/python.rb

@@ -2,7 +2,7 @@ module Nexmo
   module Markdown
     module CodeSnippetRenderer
       class Python < Base
-        def self.dependencies(deps)
+        def self.dependencies(deps, _version)
           { 'code' => "pip install #{deps.join(' ')}" }
         end
     

data/lib/nexmo_markdown_renderer/services/code_snippet_renderer/ruby.rb

@@ -2,7 +2,7 @@ module Nexmo
   module Markdown
     module CodeSnippetRenderer
       class Ruby < Base
-        def self.dependencies(deps)
+        def self.dependencies(deps, _version)
           { 'code' => "gem install #{deps.join(' ')}" }
         end
     

data/lib/nexmo_markdown_renderer/services/doc_finder.rb

@@ -91,9 +91,9 @@ module Nexmo
 
       def self.load_english
         paths.each do |path|
-          if path.starts_with?('app/views')
+          if defined?(Rails) && path.starts_with?("#{Rails.root}/app/views")
             Dir["#{path}/**/*.*"].each do |file|
-              dictionary[file][::I18n.default_locale.to_s] = ::I18n.default_locale.to_s
+              dictionary[file.gsub("#{Rails.root}/", '')][::I18n.default_locale.to_s] = ::I18n.default_locale.to_s
             end
           else
             path_with_locale = "#{path}/#{::I18n.default_locale}"

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.0'
+    VERSION = '0.4.5'
   end
 end
 # :nocov:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo_markdown_renderer
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.5
 platform: ruby
 authors:
 - Nexmo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-12 00:00:00.000000000 Z
+date: 2020-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: banzai
@@ -297,6 +297,7 @@ files:
 - lib/nexmo_markdown_renderer/services/code_snippet_renderer/base.rb
 - lib/nexmo_markdown_renderer/services/code_snippet_renderer/curl.rb
 - lib/nexmo_markdown_renderer/services/code_snippet_renderer/dotnet.rb
+- lib/nexmo_markdown_renderer/services/code_snippet_renderer/go.rb
 - lib/nexmo_markdown_renderer/services/code_snippet_renderer/java.rb
 - lib/nexmo_markdown_renderer/services/code_snippet_renderer/javascript.rb
 - lib/nexmo_markdown_renderer/services/code_snippet_renderer/kotlin.rb
@@ -344,7 +345,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Middleware to render Markdown Documents in Nexmo Developer Platform.