nexmo_markdown_renderer 0.3.0 → 0.4.3

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/models/tutorial.rb

@@ -63,7 +63,7 @@ module Nexmo
       end
 
       def first_step
-        subtasks.first.name
+        subtasks.first&.name
       end
 
       def prerequisite?

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo_markdown_renderer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.3
 platform: ruby
 authors:
 - Nexmo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-15 00:00:00.000000000 Z
+date: 2020-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: banzai
@@ -240,12 +240,21 @@ 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
 - lib/nexmo_markdown_renderer/filters/collapsible_filter.rb
 - lib/nexmo_markdown_renderer/filters/columns_filter.rb
 - lib/nexmo_markdown_renderer/filters/concept_list_filter.rb
+- lib/nexmo_markdown_renderer/filters/concerns/prism_code_snippet.rb
 - lib/nexmo_markdown_renderer/filters/dynamic_content_filter.rb
 - lib/nexmo_markdown_renderer/filters/external_link_filter.rb
 - lib/nexmo_markdown_renderer/filters/frontmatter_filter.rb
@@ -270,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
@@ -287,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
@@ -303,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
@@ -333,7 +345,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Middleware to render Markdown Documents in Nexmo Developer Platform.