nexmo_markdown_renderer 0.3.1 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 746e034b9ef6f00f3004f92196e71c3b670cc677f931fa67cdf42252620fdc37
-  data.tar.gz: 680b76bcce7a745ee748cb4e6a5db8d2724a2727271651179a18d43dee0a1701
+  metadata.gz: e3f2fe624417d3d2acb266f3231d0155449c65c898f8be479dac44ad3e102ca8
+  data.tar.gz: acd7954ba9497e2eb70ab42593399492fd35142f35e02736daa7ed8a31cab97c
 SHA512:
-  metadata.gz: 10cfc564ff9a5544f522fcd98a77afdae52c9140846ae199db099615218ccc8be61360f27ba1c73b46fb0326c4a613ddf625b7bef19df45ba5564a022c1fb1ad
-  data.tar.gz: 31bd733108f5ebcb4608cc9bfbd7b7669902ce66cc94a922abd58a7819c6843d082a710307920efd1450b6b737b53490bcdf5c7f34ead2e07c9d2bdcb704618c
+  metadata.gz: 342774f31333d182961bdb3ccc58478f5565795d42b916de02963167d16b688ebe0816f167f0c31ace9d63c8528cc60a33366c826a00c9c7687f207b074eb5d3
+  data.tar.gz: abbd6f026b698bd3ca5bf8db2c28139403e28a3198426d23c804c7dd8668c747dcee0a9a113020f777ca2ee685ec3a7a70d32c2bd472e9cbff3c4dbdda1af61c

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/config/locales/en.yml

@@ -129,6 +129,7 @@ en:
       write_the_code: Write the code
     configure_client:
       initialize_dependencies: Initialize your dependencies
+      import_dependencies: Import dependencies
     application_messages_dispatch:
       no_application_html: If you do not have an application you can <a href="/messages/code-snippets/create-an-application">create one</a>. Make sure you also <a href="/messages/code-snippets/configure-webhooks">configure your webhooks</a>.
     application_rtc:

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'
@@ -38,6 +39,15 @@ require_relative 'nexmo_markdown_renderer/models/tutorial/prerequisite'
 require_relative 'nexmo_markdown_renderer/models/tutorial/task'
 require_relative 'nexmo_markdown_renderer/models/use_case'
 
+require_relative 'nexmo_markdown_renderer/filters/code_snippet/binding'
+require_relative 'nexmo_markdown_renderer/filters/code_snippet/renderable'
+require_relative 'nexmo_markdown_renderer/filters/code_snippet/create_application'
+require_relative 'nexmo_markdown_renderer/filters/code_snippet/initialize_dependencies'
+require_relative 'nexmo_markdown_renderer/filters/code_snippet/instructions'
+require_relative 'nexmo_markdown_renderer/filters/code_snippet/import_dependencies'
+require_relative 'nexmo_markdown_renderer/filters/code_snippet/install_dependencies'
+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 }

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

@@ -0,0 +1,41 @@
+module Nexmo
+  module Markdown
+    module Filters
+      module CodeSnippet
+        class Binding
+          def initialize(config)
+            @config = config
+          end
+
+          def language
+            @language ||= @config['language']
+          end
+
+          def lexer
+            @lexer ||= Nexmo::Markdown::CodeLanguage.find(language).lexer
+          end
+
+          def lang
+            @lang ||= @config['title'].delete('.')
+          end
+
+          def unindent
+            @unindent ||= @config['unindent']
+          end
+
+          def file_name
+            @file_name ||= @config['file_name']
+          end
+
+          def source
+            @source ||= @config['source']
+          end
+
+          def import_dependencies?
+            @config['import_dependencies']
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+module Nexmo
+  module Markdown
+    module Filters
+      module CodeSnippet
+        class CreateApplication
+          include Renderable
+
+          NGROK_URL   = 'http://demo.ngrok.io'.freeze
+          EXAMPLE_URL = 'https://example.com'.freeze
+
+          attr_reader :app
+
+          def initialize(app)
+            @app = app
+          end
+
+          def base_url
+            @base_url ||= @app['disable_ngrok'] && EXAMPLE_URL || NGROK_URL
+          end
+
+          def name
+            @name ||= @app['name'] || 'ExampleProject'
+          end
+
+          def type
+            # We should remove this default once we're sure that all Code Snippets
+            # have a type set e.g audit
+            @type ||= @app.fetch('type', 'voice')
+          end
+
+          def event_url
+            @event_url ||= @app.fetch('event_url', "#{base_url}/webhooks/events")
+          end
+
+          def answer_url
+            @answer_url ||= @app.fetch('answer_url', "#{base_url}/webhooks/answer")
+          end
+
+          def partial
+            @partial ||= begin
+                           case type
+                           when 'voice', 'rtc'
+                             File.read("#{GEM_ROOT}/lib/nexmo_markdown_renderer/views/code_snippets/_application_#{type}.html.erb")
+                           when 'messages', 'dispatch'
+                             File.read("#{GEM_ROOT}/lib/nexmo_markdown_renderer/views/code_snippets/_application_messages_dispatch.html.erb")
+                           else
+                             raise "Invalid application type when creating code snippet: '#{type}'"
+                           end
+                         end
+          end
+
+          def render
+            return '' unless @app
+
+            ERB.new(partial).result(binding)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Nexmo
+  module Markdown
+    module Filters
+      module CodeSnippet
+        class ImportDependencies
+          include OcticonsHelper
+          include Renderable
+
+          attr_reader :config
+
+          def initialize(config, snippet)
+            @config  = config
+            @snippet = snippet
+          end
+
+          def partial
+            @partial ||= File.read("#{GEM_ROOT}/lib/nexmo_markdown_renderer/views/code_snippets/_import_dependencies.html.erb")
+          end
+
+          def highlighted_import_source
+            @highlighted_import_source ||= ::Nexmo::Markdown::Utils.generate_code_block(
+              language,
+              @config,
+              unindent
+            )
+          end
+
+          def render
+            return '' unless @config
+
+            create_instructions = renderer.create_instructions(file_name).render_markdown
+            ERB.new(partial).result(binding)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module Nexmo
+  module Markdown
+    module Filters
+      module CodeSnippet
+        class InitializeDependencies
+          include OcticonsHelper
+          include Renderable
+
+          def initialize(config, snippet)
+            @config  = config
+            @snippet = snippet
+          end
+
+          def partial
+            @partial ||= File.read("#{GEM_ROOT}/lib/nexmo_markdown_renderer/views/code_snippets/_configure_client.html.erb")
+          end
+
+          def highlighted_client_source
+            @highlighted_client_source ||= ::Nexmo::Markdown::Utils.generate_code_block(
+              language,
+              @config,
+              unindent
+            )
+          end
+
+          def render
+            return '' unless @config
+
+            create_instructions = if import_dependencies?
+              renderer.add_instructions(file_name).render_markdown
+            else
+              renderer.create_instructions(file_name).render_markdown
+            end
+
+            ERB.new(partial).result(binding)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module Nexmo
+  module Markdown
+    module Filters
+      module CodeSnippet
+        class InstallDependencies
+          include Renderable
+
+          def initialize(config, version, snippet)
+            @config  = config
+            @snippet = snippet
+            @version = version
+          end
+
+          def partial
+            @partial ||= File.read("#{GEM_ROOT}/lib/nexmo_markdown_renderer/views/code_snippets/_dependencies.html.erb")
+          end
+
+          def title
+            @title ||= begin
+              # The only valid dependency for curl examples is `JWT`
+              if @config.map(&:upcase).include?('JWT')
+                ::I18n.t('filters.generate_your_jwt')
+              else
+                ::I18n.t('filters.install_dependencies')
+              end
+            end
+          end
+
+          def render
+            return '' unless @config
+
+            deps = renderer.dependencies(@config, @version)
+            ERB.new(partial).result(binding)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+module Nexmo
+  module Markdown
+    module Filters
+      module CodeSnippet
+        class Instructions
+          include OcticonsHelper
+          include Renderable
+
+          attr_reader :config
+
+          def initialize(config, snippet)
+            @config  = config
+            @snippet = snippet
+          end
+
+          def partial
+            @partial ||= begin
+              if @config['code_only']
+                File.read("#{GEM_ROOT}/lib/nexmo_markdown_renderer/views/code_snippets/_code_only.html.erb")
+              else
+                File.read("#{GEM_ROOT}/lib/nexmo_markdown_renderer/views/code_snippets/_write_code.html.erb")
+              end
+            end
+          end
+
+          def highlighted_code_source
+            @highlighted_code_source ||= ::Nexmo::Markdown::Utils.generate_code_block(
+              language,
+              @config['code'],
+              unindent
+            )
+          end
+
+          def source_url
+            @source_url ||= ::Nexmo::Markdown::Utils.generate_source_url(@config['code'])
+          end
+
+          def render
+            add_instructions = renderer.add_instructions(file_name).render_markdown
+            ERB.new(partial).result(binding)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+require 'forwardable'
+
+module Nexmo
+  module Markdown
+    module Filters
+      module CodeSnippet
+        module Renderable
+          extend Forwardable
+
+          def_delegators :@snippet, :language, :lang, :renderer, :lexer, :unindent, :file_name, :source, :import_dependencies?
+
+          def id
+            @id ||= SecureRandom.hex
+          end
+
+          def client_url
+            @client_url ||= ::Nexmo::Markdown::Utils.generate_source_url(@config)
+          end
+
+          def renderer
+            case normalized_language
+            when 'curl'
+              Nexmo::Markdown::CodeSnippetRenderer::Curl
+            when 'node'
+              Nexmo::Markdown::CodeSnippetRenderer::Javascript
+            when 'javascript'
+              Nexmo::Markdown::CodeSnippetRenderer::Javascript
+            when 'java'
+              Nexmo::Markdown::CodeSnippetRenderer::Java
+            when 'dotnet'
+              Nexmo::Markdown::CodeSnippetRenderer::Dotnet
+            when 'python'
+              Nexmo::Markdown::CodeSnippetRenderer::Python
+            when 'ruby'
+              Nexmo::Markdown::CodeSnippetRenderer::Ruby
+            when 'php'
+              Nexmo::Markdown::CodeSnippetRenderer::Php
+            when 'android'
+              Nexmo::Markdown::CodeSnippetRenderer::Android
+            when 'kotlin'
+              Nexmo::Markdown::CodeSnippetRenderer::Kotlin
+            when 'objective_c'
+              Nexmo::Markdown::CodeSnippetRenderer::ObjectiveC
+            when 'swift'
+              Nexmo::Markdown::CodeSnippetRenderer::Swift
+            when 'go'
+              Nexmo::Markdown::CodeSnippetRenderer::Go
+            else
+              raise "Unknown language: #{normalized_language}"
+            end
+          end
+
+          def normalized_language
+            if language == 'csharp'
+              'dotnet'
+            else
+              language
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Nexmo
+  module Markdown
+    module Filters
+      module CodeSnippet
+        class Run
+          include OcticonsHelper
+          include Renderable
+
+          def initialize(config, snippet)
+            @config  = config
+            @snippet = snippet
+          end
+
+          def run_command
+            @run_command ||= begin
+              if @config['run_command']
+                @config['run_command'].gsub('{filename}', file_name)
+              end
+            end
+          end
+
+          def render
+            renderer.run_command(run_command, file_name, @config['code']['source']).to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nexmo_markdown_renderer/filters/code_snippet_filter.rb

@@ -5,183 +5,46 @@ module Nexmo
 
       def call(input)
         input.gsub(/```single_code_snippet(.+?)```/m) do |_s|
-          config = YAML.safe_load($1)
+          @config = YAML.safe_load($1)
+          @binding = ::Nexmo::Markdown::Filters::CodeSnippet::Binding.new(@config)
 
-          @renderer = get_renderer(config['language'])
+          return instructions if @config['code_only']
 
-          lexer = Nexmo::Markdown::CodeLanguage.find(config['language']).lexer
-          lang = config['title'].delete('.')
-
-          application_html = generate_application_block(config['application'])
-
-          # Read the client
-          if config['client']
-            highlighted_client_source = generate_code_block(config['language'], config['client'], config['unindent'])
-          end
-
-          # Read the code
-          highlighted_code_source = generate_code_block(config['language'], config['code'], config['unindent'])
-
-          dependency_html = ''
-          if config['dependencies']
-            dependency_html = generate_dependencies(lexer.tag, config['dependencies'])
-          end
-
-          source_url = generate_source_url(config['code'])
-
-          client_html = ''
-          if highlighted_client_source
-            client_url = generate_source_url(config['client'])
-            id = SecureRandom.hex
-            create_instructions = @renderer.create_instructions(config['file_name']).render_markdown
-            erb = File.read("#{GEM_ROOT}/lib/nexmo_markdown_renderer/views/code_snippets/_configure_client.html.erb")
-            client_html = ERB.new(erb).result(binding)
-          end
-
-          add_instructions = @renderer.add_instructions(config['file_name']).render_markdown
-          if config['code_only']
-            erb = File.read("#{GEM_ROOT}/lib/nexmo_markdown_renderer/views/code_snippets/_code_only.html.erb")
-          else
-            erb = File.read("#{GEM_ROOT}/lib/nexmo_markdown_renderer/views/code_snippets/_write_code.html.erb")
-          end
-
-          code_html = ERB.new(erb).result(binding)
-
-          return code_html if config['code_only']
-
-          config['run_command'] = config['run_command'].gsub('{filename}', config['file_name']) if config['run_command']
-          run_html = @renderer.run_command(config['run_command'], config['file_name'], config['code']['source']).to_s
+          "#{prerequisites}#{instructions}#{run}"
+        end
+      end
 
-          prereqs = (application_html + dependency_html + client_html).strip
+      def prerequisites
+        @prerequisites ||= begin
+          prereqs = [application_html, install_dependencies, import_dependencies, initialize_dependencies].join.strip
           prereqs = "<h2>#{::I18n.t('.filters.prerequisites')}</h2>#{prereqs}" unless prereqs.empty?
-          prereqs + code_html + run_html
+          prereqs
         end
       end
 
-      private
-
-      def highlight(source, lexer)
-        formatter = Rouge::Formatters::HTML.new
-        formatter.format(lexer.lex(source))
+      def application_html
+        @application_html ||= ::Nexmo::Markdown::Filters::CodeSnippet::CreateApplication.new(@config['application']).render
       end
 
-      def generate_code_block(language, input, unindent)
-        filename = "#{Nexmo::Markdown::Config.docs_base_path}/#{input['source']}"
-        return '' unless input
-        raise "CodeSnippetFilter - Could not load #{filename} for language #{language}" unless File.exist?(filename)
-
-        code = File.read(filename)
-        lexer = Nexmo::Markdown::CodeLanguage.find(language).lexer
-
-        total_lines = code.lines.count
-
-        # Minus one since lines are not zero-indexed
-        from_line = (input['from_line'] || 1) - 1
-        to_line = (input['to_line'] || total_lines) - 1
-
-        code = code.lines[from_line..to_line].join
-        code.unindent! if unindent
-
-        highlight(code, lexer)
+      def install_dependencies
+        @install_dependencies ||= ::Nexmo::Markdown::Filters::CodeSnippet::InstallDependencies.new(@config['dependencies'], @config['version'], @binding).render
       end
 
-      def get_renderer(language)
-        language = 'dotnet' if language == 'csharp'
-        case language
-        when 'curl'
-          Nexmo::Markdown::CodeSnippetRenderer::Curl
-        when 'node'
-          Nexmo::Markdown::CodeSnippetRenderer::Javascript
-        when 'javascript'
-          Nexmo::Markdown::CodeSnippetRenderer::Javascript
-        when 'java'
-          Nexmo::Markdown::CodeSnippetRenderer::Java
-        when 'dotnet'
-          Nexmo::Markdown::CodeSnippetRenderer::Dotnet
-        when 'python'
-          Nexmo::Markdown::CodeSnippetRenderer::Python
-        when 'ruby'
-          Nexmo::Markdown::CodeSnippetRenderer::Ruby
-        when 'php'
-          Nexmo::Markdown::CodeSnippetRenderer::Php
-        when 'android'
-          Nexmo::Markdown::CodeSnippetRenderer::Android
-        when 'kotlin'
-          Nexmo::Markdown::CodeSnippetRenderer::Kotlin
-        when 'objective_c'
-          Nexmo::Markdown::CodeSnippetRenderer::ObjectiveC
-        when 'swift'
-          Nexmo::Markdown::CodeSnippetRenderer::Swift
-        else
-          raise "Unknown language: #{language}"
-        end
+      def import_dependencies
+        @import_dependencies ||= ::Nexmo::Markdown::Filters::CodeSnippet::ImportDependencies.new(@config['import_dependencies'], @binding).render
       end
 
-      def generate_dependencies(language, dependencies)
-        # The only valid dependency for curl examples is `JWT`
-        if dependencies.map(&:upcase).include?('JWT')
-          title = ::I18n.t('filters.generate_your_jwt')
-        else
-          title = ::I18n.t('filters.install_dependencies')
-        end
-        deps = @renderer.dependencies(dependencies)
-        id = SecureRandom.hex
-        erb = File.read("#{GEM_ROOT}/lib/nexmo_markdown_renderer/views/code_snippets/_dependencies.html.erb")
-        ERB.new(erb).result(binding)
+      def initialize_dependencies
+        @initialize_dependencies ||= ::Nexmo::Markdown::Filters::CodeSnippet::InitializeDependencies.new(@config['client'], @binding).render
       end
 
-      def generate_application_block(app)
-        return '' unless app
-
-        base_url = 'http://demo.ngrok.io'
-        base_url = 'https://example.com' if app['disable_ngrok']
-
-        app['name'] = 'ExampleProject' unless app['name']
-
-        # We should remove this default once we're sure that all Code Snippets
-        # have a type set e.g audit
-        app['type'] ||= 'voice'
-
-        if ['voice', 'rtc'].include? app['type']
-          app['event_url'] = "#{base_url}/webhooks/events" unless app['event_url']
-          app['answer_url'] = "#{base_url}/webhooks/answer" unless app['answer_url']
-          erb = File.read("#{GEM_ROOT}/lib/nexmo_markdown_renderer/views/code_snippets/_application_#{app['type']}.html.erb")
-        elsif ['messages', 'dispatch'].include? app['type']
-          erb = File.read("#{GEM_ROOT}/lib/nexmo_markdown_renderer/views/code_snippets/_application_messages_dispatch.html.erb")
-        else
-          raise "Invalid application type when creating code snippet: '#{app['type']}'"
-        end
-
-        id = SecureRandom.hex
-
-        ERB.new(erb).result(binding)
+      def instructions
+        @instructions ||= ::Nexmo::Markdown::Filters::CodeSnippet::Instructions.new(@config, @binding).render
       end
 
-      def 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
-        start_section = 'https://github.com'
-
-        # Insert "blob/master" and strip ".repos"
-        repo_path = '\\0blob/master/'
-        file_section = code['source'].sub('.repos', '').sub(%r{(-quickstart|-code-snippets|-code-snippets)/}, repo_path)
-
-        # Line highlighting
-        line_section = ''
-        if code['from_line']
-          line_section += "#L#{code['from_line']}"
-          if code['to_line']
-            # If we've provided a to_line, use that
-            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}"
-          end
-        end
-
-        start_section + file_section + line_section
+      def run
+        @run ||= ::Nexmo::Markdown::Filters::CodeSnippet::Run.new(@config, @binding).render
       end
     end
-
   end
 end

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
@@ -50,6 +50,8 @@ module Nexmo
             tab_link.content = content[:tab_title]
           elsif content[:language].key == 'objective_c' || content[:language].key == 'swift'
             tab_link.inner_html = "<svg><use xlink:href=\"/assets/images/brands/ios.svg#ios\" /></svg><span>" + content[:tab_title] + '</span>'
+          elsif content[:language].key == 'kotlin'
+            tab_link.inner_html = "<img class=\"Vlt-icon Vlt-icon--small\" src=\"/assets/images/brands/kotlin.svg#kotlin\" /><span>" + content[:tab_title] + '</span>'
           else
             tab_link.inner_html = "<svg><use xlink:href=\"/assets/images/brands/#{content[:language].key}.svg##{content[:language].key}\" /></svg><span>" + content[:tab_title] + '</span>'
           end
@@ -167,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

@@ -0,0 +1,50 @@
+module Nexmo
+  module Markdown
+    class Utils
+      def self.generate_source_url(code)
+        # 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"
+        repo_path = '\\0blob/master/'
+        file_section = code['source'].sub('.repos', '').sub(%r{(-quickstart|-code-snippets|-code-snippets)/}, repo_path)
+
+        # Line highlighting
+        line_section = ''
+        if code['from_line']
+          line_section += "#L#{code['from_line']}"
+          if code['to_line']
+            # If we've provided a to_line, use that
+            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("#{Nexmo::Markdown::Config.docs_base_path}/#{code['source']}").lines.count}"
+          end
+        end
+
+        start_section + file_section + line_section
+      end
+
+      def self.generate_code_block(language, input, unindent)
+        return '' unless input
+        filename = "#{Nexmo::Markdown::Config.docs_base_path}/#{input['source']}"
+        raise "CodeSnippetFilter - Could not load #{filename} for language #{language}" unless File.exist?(filename)
+
+        code = File.read(filename)
+        lexer = Nexmo::Markdown::CodeLanguage.find(language).lexer
+
+        total_lines = code.lines.count
+
+        # Minus one since lines are not zero-indexed
+        from_line = (input['from_line'] || 1) - 1
+        to_line = (input['to_line'] || total_lines) - 1
+
+        code = code.lines[from_line..to_line].join
+        code.unindent! if unindent
+        formatter = Rouge::Formatters::HTML.new
+        formatter.format(lexer.lex(code))
+      end
+    end
+  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_rtc.html.erb

@@ -15,7 +15,7 @@
           <p><%= ::I18n.t('.code_snippets.nexmo_needs_to_connect_html') %></p>
         <% end %>
 
-        <pre class="Vlt-prism--dark dependencies command-line Vlt-prism--copy-disabled language-bash" data-prompt='$'><code>nexmo app:create "<%=app['name'] %>" <%=app['answer_url'] %> <%=app['event_url'] %> --keyfile=private.key --type=rtc</code></pre>
+        <pre class="Vlt-prism--dark dependencies command-line Vlt-prism--copy-disabled language-bash" data-prompt='$'><code>nexmo app:create "<%= name %>" <%= answer_url %> <%= event_url %> --keyfile=private.key --type=rtc</code></pre>
 
         <h4><%= ::I18n.t('.code_snippets.application_rtc.use_your_existing_app') %></h4>
 

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

@@ -18,7 +18,7 @@
               <p><%= ::I18n.t('.code_snippets.nexmo_needs_to_connect_html') %></p>
             <% end %>
 
-            <pre class="Vlt-prism--dark dependencies command-line Vlt-prism--copy-disabled language-bash" data-prompt='$'><code>nexmo app:create "<%=app['name'] %>" <%=app['answer_url'] %> <%=app['event_url'] %> --keyfile private.key</code></pre>
+            <pre class="Vlt-prism--dark dependencies command-line Vlt-prism--copy-disabled language-bash" data-prompt='$'><code>nexmo app:create "<%= name %>" <%= answer_url %> <%= event_url %> --keyfile private.key</code></pre>
         <% end %>
     </div>
 </div>

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

@@ -7,13 +7,13 @@
     <%= create_instructions %>
     <div class="copy-wrapper">
 
-      <div class="copy-button" data-lang="<%= lang %>" data-block="<%= config['source'] %>" data-section="configure">
+      <div class="copy-button" data-lang="<%= lang %>" data-block="<%= source %>" data-section="configure">
         <%= octicon "clippy", :class => 'top left' %> <span>Copy to Clipboard</span>
       </div>
       <pre class="Vlt-prism--dark language-<%= lexer.tag %> Vlt-prism--copy-disabled"><code><%= highlighted_client_source %></code></pre>
     </div>
 
-    <p><a data-section="configure" data-lang="<%= lang %>" data-block="<%= config['source'] %>" href="<%= client_url %>">View full source</a></p>
+    <p><a data-section="configure" data-lang="<%= lang %>" data-block="<%= source %>" href="<%= client_url %>">View full source</a></p>
 
   </div>
 </div>

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

@@ -0,0 +1,18 @@
+<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.import_dependencies') %>
+  </h5>
+
+  <div id="acc<%=id %>"  class="Vlt-js-accordion__content Vlt-accordion__content Vlt-accordion__content--noborder">
+    <%= create_instructions %>
+    <div class="copy-wrapper">
+
+      <div class="copy-button" data-lang="<%= lang %>" data-block="<%= config['source'] %>" data-section="configure">
+        <%= octicon "clippy", :class => 'top left' %> <span>Copy to Clipboard</span>
+      </div>
+      <pre class="Vlt-prism--dark language-<%= lexer.tag %> Vlt-prism--copy-disabled"><code><%= highlighted_import_source %></code></pre>
+    </div>
+
+    <p><a data-section="configure" data-lang="<%= lang %>" data-block="<%= config['source'] %>" href="<%= client_url %>">View full source</a></p>
+  </div>
+</div>

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo_markdown_renderer
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.4
 platform: ruby
 authors:
 - Nexmo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-21 00:00:00.000000000 Z
+date: 2020-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: banzai
@@ -240,6 +240,14 @@ files:
 - lib/nexmo_markdown_renderer/filters/block_escape_filter.rb
 - lib/nexmo_markdown_renderer/filters/break_filter.rb
 - lib/nexmo_markdown_renderer/filters/code_filter.rb
+- lib/nexmo_markdown_renderer/filters/code_snippet/binding.rb
+- lib/nexmo_markdown_renderer/filters/code_snippet/create_application.rb
+- lib/nexmo_markdown_renderer/filters/code_snippet/import_dependencies.rb
+- lib/nexmo_markdown_renderer/filters/code_snippet/initialize_dependencies.rb
+- lib/nexmo_markdown_renderer/filters/code_snippet/install_dependencies.rb
+- lib/nexmo_markdown_renderer/filters/code_snippet/instructions.rb
+- lib/nexmo_markdown_renderer/filters/code_snippet/renderable.rb
+- lib/nexmo_markdown_renderer/filters/code_snippet/run.rb
 - lib/nexmo_markdown_renderer/filters/code_snippet_filter.rb
 - lib/nexmo_markdown_renderer/filters/code_snippet_list_filter.rb
 - lib/nexmo_markdown_renderer/filters/code_snippets_filter.rb
@@ -271,6 +279,7 @@ files:
 - lib/nexmo_markdown_renderer/filters/tooltip_filter.rb
 - lib/nexmo_markdown_renderer/filters/unfreeze_filter.rb
 - lib/nexmo_markdown_renderer/filters/use_case_list_filter.rb
+- lib/nexmo_markdown_renderer/filters/utils.rb
 - lib/nexmo_markdown_renderer/initializers/doc_finder.rb
 - lib/nexmo_markdown_renderer/initializers/i18n.rb
 - lib/nexmo_markdown_renderer/initializers/redcarpet.rb
@@ -288,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
@@ -304,6 +314,7 @@ files:
 - lib/nexmo_markdown_renderer/views/code_snippets/_code_only.html.erb
 - lib/nexmo_markdown_renderer/views/code_snippets/_configure_client.html.erb
 - lib/nexmo_markdown_renderer/views/code_snippets/_dependencies.html.erb
+- lib/nexmo_markdown_renderer/views/code_snippets/_import_dependencies.html.erb
 - lib/nexmo_markdown_renderer/views/code_snippets/_write_code.html.erb
 - lib/nexmo_markdown_renderer/views/code_snippets/list/plain.html.erb
 - lib/nexmo_markdown_renderer/views/concepts/list/plain.html.erb
@@ -334,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.0.1
 signing_key: 
 specification_version: 4
 summary: Middleware to render Markdown Documents in Nexmo Developer Platform.