nexmo_markdown_renderer 0.2.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 602526bb4c23634caec1d2f64ccdc7fc233f22e6689e5119f44af6da093cdcd8
-  data.tar.gz: ad8bd68ac0472fd15e428ee380625ded6bfd0348cdd496ba19da65dc058482a5
+  metadata.gz: 5f8453119db56f41713832d6a32fe559cd0076cef1f829e161465cb31bd81fb1
+  data.tar.gz: 5f82937effa52f7587533c3b039ed609c5095829cbec0c1bb8871306f00501c9
 SHA512:
-  metadata.gz: ee40af02f55f416a8d370f9ba3b103a9de1914bf2d8bcbc60af8bb2beb29433cb65505ef8509ab360863658c561ae534b5d3df91749c0b35bc8d387c846dff6e
-  data.tar.gz: 6a82418e449c7fd9aed46303179962c458b0e63f46b32b4a1138b244a94bb7409096b4464937e2b23c0239acc8d9f7c57ecd66f6ca4b6a5af966bf38dcf9f4cf
+  metadata.gz: 8cc17d94d7ef7d83f315747521569ad545601e9165532d94cd8bb08306b7ed4be95b11995ce76038ef51785eea8ef7809c8446fa3b5da8486059dc87a458aaac
+  data.tar.gz: d22a8f38997cacf2dbdfb00ca34f3beae65ca75f1736ff5db335207da246d7a2513eb6fa89e181964f99589d3f076ffde06f730f95f3ef7694fc22af0d13a336

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

@@ -6,10 +6,12 @@ require 'nokogiri'
 require 'open-uri'
 require 'active_model'
 require 'i18n'
+
 require_relative 'nexmo_markdown_renderer/config/load_config'
 require_relative 'nexmo_markdown_renderer/initializers/redcarpet'
 require_relative 'nexmo_markdown_renderer/initializers/i18n'
 require_relative 'nexmo_markdown_renderer/core_ext/string'
+
 require_relative 'nexmo_markdown_renderer/services/code_snippet_renderer/base'
 require_relative 'nexmo_markdown_renderer/services/code_snippet_renderer/android'
 require_relative 'nexmo_markdown_renderer/services/code_snippet_renderer/curl'
@@ -22,9 +24,30 @@ 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/doc_finder'
 require_relative 'nexmo_markdown_renderer/services/doc_finder/doc'
-Dir[File.join(__dir__, 'nexmo_markdown_renderer/models', '*.rb')].each { |file| require_relative file }
+
+require_relative 'nexmo_markdown_renderer/models/code_language'
+require_relative 'nexmo_markdown_renderer/models/code_snippet'
+require_relative 'nexmo_markdown_renderer/models/concept'
+require_relative 'nexmo_markdown_renderer/models/tutorial'
+require_relative 'nexmo_markdown_renderer/models/tutorial/file_loader'
+require_relative 'nexmo_markdown_renderer/models/tutorial/metadata'
+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 }
 require_relative 'nexmo_markdown_renderer/markdown_renderer'

data/lib/nexmo_markdown_renderer/filters/block_escape_filter.rb

@@ -1,6 +1,8 @@
 module Nexmo
   module Markdown
     class BlockEscapeFilter < Banzai::Filter
+      include Nexmo::Markdown::Concerns::PrismCodeSnippet
+
       def call(input)
         # Freeze to prevent Markdown formatting
         input.gsub(/````\n(.+?)````/m) do |_s|
@@ -8,9 +10,7 @@ module Nexmo
           formatter = Rouge::Formatters::HTML.new
           highlighted_source = formatter.format(lexer.lex($1))
 
-          output = <<~HEREDOC
-            <pre class="Vlt-prism--dark language-#{lexer.tag} Vlt-prism--copy-disabled"><code>#{highlighted_source}</code></pre>
-          HEREDOC
+          output = code_snippet_body(lexer, highlighted_source)
 
           "FREEZESTART#{Base64.urlsafe_encode64(output)}FREEZEEND"
         end

data/lib/nexmo_markdown_renderer/filters/code_filter.rb

@@ -1,43 +1,43 @@
 module Nexmo
   module Markdown
     class CodeFilter < Banzai::Filter
+      include Nexmo::Markdown::Concerns::PrismCodeSnippet
+
       def call(input)
         input.gsub(/(?!.*snippet)```code(.+?)```/m) do |_s|
           config = YAML.safe_load($1)
-    
+
           if config['config']
             configs = YAML.load_file("#{Nexmo::Markdown::Config.docs_base_path}/config/code_examples.yml")
             config = config['config'].split('.').inject(configs) { |h, k| h[k] }
           end
-    
+
           code = File.read("#{Nexmo::Markdown::Config.docs_base_path}/#{config['source']}")
           language = File.extname("#{Nexmo::Markdown::Config.docs_base_path}/#{config['source']}")[1..-1]
           lexer = language_to_lexer(language)
-    
+
           total_lines = code.lines.count
-    
+
           # Minus one since lines are not zero-indexed
           from_line = (config['from_line'] || 1) - 1
           to_line = (config['to_line'] || total_lines) - 1
-    
+
           code = code.lines[from_line..to_line].join
           code.unindent! if config['unindent']
-    
+
           highlighted_source = highlight(code, lexer)
-    
-          <<~HEREDOC
-            <pre class="Vlt-prism--dark language-#{lexer.tag} Vlt-prism--copy-disabled"><code>#{highlighted_source}</code></pre>
-          HEREDOC
+
+          code_snippet_body(lexer, highlighted_source)
         end
       end
-    
+
       private
-    
+
       def highlight(source, lexer)
         formatter = Rouge::Formatters::HTML.new
         formatter.format(lexer.lex(source))
       end
-    
+
       def language_to_lexer_name(language)
         if language_configuration[language]
           language_configuration[language]['lexer']
@@ -45,18 +45,18 @@ module Nexmo
           language
         end
       end
-    
+
       def language_to_lexer(language)
         language = language_to_lexer_name(language)
         return Rouge::Lexers::PHP.new({ start_inline: true }) if language == 'php'
-    
+
         Rouge::Lexer.find(language.downcase) || Rouge::Lexer.find('text')
       end
-    
+
       def language_configuration
         @language_configuration ||= YAML.load_file("#{GEM_ROOT}/config/code_languages.yml")
       end
     end
-    
+
   end
 end

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,38 @@
+module Nexmo
+  module Markdown
+    module Filters
+      module CodeSnippet
+        class InstallDependencies
+          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/_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)
+            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,62 @@
+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
+            else
+              raise "Unknown language: #{normalized_language}"
+            end
+          end
+
+          def normalized_language
+            if language == 'csharp'
+              'dotnet'
+            else
+              language
+            end
+          end
+        end
+      end
+    end
+  end
+end