nexmo_markdown_renderer 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02cf9f0fd0b384358d95ad474c96cd54cf8fe78aafe85f6997d24ad4fb9d1c65
-  data.tar.gz: bcc05f2c29c9d05388d7b6e581d8db018840579929298018c90f54e82c783ab3
+  metadata.gz: cf72d97b82f7c671efe8a44e8699732332a3e59c3cbb7df3b6f87ec37a790a5d
+  data.tar.gz: 91763b45e66bf134adb6c4297b0967625a355ff0054686bfb6b70fb680f0e7f8
 SHA512:
-  metadata.gz: 7fc4caeb48ecc8cff17ec16419e297783fbee233f5e3b4020858180a7bac8a5c25a68989aebe791553b8d071ba044ab42bce6ab6300ad96f0438c403b0a04534
-  data.tar.gz: 8028421004e48576ce6186de6f80a2340b4cec2efd2b6e6a9c6a680699cb84845bf07743b402ef5cff90c1778a96b4c46cdf64bd6d492672ecd49a48ed6c4306
+  metadata.gz: 5b60124cae98030eea13ec9498733c234dee46cf704238ee3252d70743a2a96e705983100c66c97a6d0ddad7fa4f3046b37aea5912805c32bd8396016efe8698
+  data.tar.gz: '0458dfbbaf465ea60949c8e359d7db9bc3df2acbd9a2c5eba484015ce179c6225e4e647810508c38fbf578674eb31c630f92512437f05e66fd22e7d9410ff0d3'

data/lib/nexmo_markdown_renderer/filters/relative_link_filter.rb

@@ -0,0 +1,21 @@
+module Nexmo
+  module Markdown
+    class RelativeLinkFilter < Banzai::Filter
+      def call(input)
+        @input = input
+
+        document.css('a[href^="/"]').each_with_index do |link, _index|
+          link[:href] = "/#{options[:locale]}#{link[:href]}" if options[:locale]
+        end
+
+        document.to_html
+      end
+
+      private
+
+      def document
+        @document ||= Nokogiri::HTML::DocumentFragment.parse(@input)
+      end
+    end
+  end
+end

data/lib/nexmo_markdown_renderer/markdown_renderer.rb

@@ -30,18 +30,19 @@ module Nexmo
           LanguageFilter,
           ColumnsFilter,
           MarkdownFilter.new(options),
-    
+
           # As HTML
           HeadingFilter,
           LabelFilter.new(options),
           BreakFilter,
           UnfreezeFilter,
           IconFilter,
-          ExternalLinkFilter
+          ExternalLinkFilter,
+          RelativeLinkFilter.new(options)
         )
       end
 
 
     end
   end
-end
+end

data/lib/nexmo_markdown_renderer/models/concept.rb

@@ -2,16 +2,16 @@ module Nexmo
   module Markdown
     class Concept
       include ActiveModel::Model
-    
+
       ORIGIN = "#{ENV['DOCS_BASE_PATH']}/_documentation".freeze
-    
+
       FILES = [
         Dir.glob("#{ORIGIN}/#{::I18n.default_locale}/**/guides/**/*.md"),
         Dir.glob("#{ORIGIN}/#{::I18n.default_locale}/**/concepts/**/*.md"),
       ].flatten
-    
+
       attr_accessor :title, :product, :description, :navigation_weight, :document_path, :url, :ignore_in_list
-    
+
       def self.by_name(names, language)
         matches = all(language).select do |block|
           concept = "#{block.product}/#{block.filename}"
@@ -19,28 +19,28 @@ module Nexmo
           names.delete(concept) if match
           match
         end
-    
+
         raise "Could not find concepts: #{names.join(', ')}" unless names.empty?
         matches
       end
-    
+
       def self.by_product(product, language)
         all(language).select do |block|
           block.product == product
         end
       end
-    
+
       def filename
         Pathname(document_path).basename.to_s.gsub('.md', '')
       end
-    
+
       def self.all(language)
         blocks = files(language).map do |document_path|
           document = File.read(document_path)
           product = extract_product(document_path)
-    
+
           frontmatter = YAML.safe_load(document)
-    
+
           Nexmo::Markdown::Concept.new({
             title: frontmatter['title'],
             description: frontmatter['description'],
@@ -51,31 +51,31 @@ module Nexmo
             url: generate_url(document_path, language),
           })
         end
-    
+
         blocks.sort_by(&:navigation_weight)
       end
-    
+
       def self.generate_url(path, language)
         '/' + path.gsub("#{ORIGIN}/#{language}/", '').gsub('.md', '')
       end
-    
+
       def self.extract_product(path)
         # Remove the prefix
         path = path.gsub!(%r{#{ORIGIN}\/[a-z]{2}\/}, '')
-    
+
         # Each file is in the form guides/<title>.md, so let's remove the last two segments
         parts = path.split('/')
         parts = parts[0...-2]
-    
+
         # What's left once we remove the start and end of the path is our product name. This could be any number
         # of parts, but it's generally 1-2
         parts.join('/')
       end
-    
+
       def self.files(language)
         FILES.each_with_object([]) do |file, array|
           document = file.gsub("#{ORIGIN}/#{::I18n.default_locale}/", '')
-          array << Nexmo::Markdown::DocFinder.find(root: ORIGIN, document: document, language: language)
+          array << Nexmo::Markdown::DocFinder.find(root: ORIGIN, document: document, language: language).path
         end
       end
     end

data/lib/nexmo_markdown_renderer/models/tutorial.rb

@@ -3,57 +3,57 @@ module Nexmo
     class Tutorial
       include ActiveModel::Model
       attr_accessor :raw, :name, :current_step, :current_product, :title, :description, :products, :subtasks, :prerequisites
-    
+
       def content_for(step_name)
         if ['introduction', 'conclusion'].include? step_name
           raise "Invalid step: #{step_name}" unless raw[step_name]
-    
+
           return raw[step_name]['content']
         end
-    
+
         path = Nexmo::Markdown::DocFinder.find(
           root: self.class.task_content_path,
           document: step_name,
           language: ::I18n.locale
-        )
-    
+        ).path
+
         File.read(path)
       end
-    
+
       def first_step
         subtasks.first['path']
       end
-    
+
       def prerequisite?
         prerequisites.pluck('path').include?(@current_step)
       end
-    
+
       def next_step
         current_task_index = subtasks.pluck('path').index(@current_step)
         return nil unless current_task_index
-    
+
         subtasks[current_task_index + 1]
       end
-    
+
       def previous_step
         current_task_index = subtasks.pluck('path').index(@current_step)
         return nil unless current_task_index
         return nil if current_task_index <= 0
-    
+
         subtasks[current_task_index - 1]
       end
-    
+
       def self.load(name, current_step, current_product = nil)
         document_path = Nexmo::Markdown::DocFinder.find(
           root: 'config/tutorials',
           document: name,
           language: ::I18n.default_locale,
           format: 'yml'
-        )
+        ).path
         config = YAML.safe_load(File.read(document_path))
         current_product ||= config['products'].first
-    
-        Nexmo::Markdown::Tutorial.new({
+
+        new({
           raw: config,
           name: name,
           current_step: current_step,
@@ -65,18 +65,18 @@ module Nexmo
           subtasks: load_subtasks(config['introduction'], config['prerequisites'], config['tasks'], config['conclusion'], current_step),
         })
       end
-    
+
       def self.load_prerequisites(prerequisites, current_step)
         return [] unless prerequisites
-    
+
         prerequisites.map do |t|
           t_path = Nexmo::Markdown::DocFinder.find(
             root: task_content_path,
             document: t,
             language: ::I18n.locale
-          )
+          ).path
           raise "Prerequisite not found: #{t}" unless File.exist? t_path
-    
+
           content = File.read(t_path)
           prereq = YAML.safe_load(content)
           {
@@ -88,18 +88,18 @@ module Nexmo
           }
         end
       end
-    
+
       def self.load_subtasks(introduction, prerequisites, tasks, conclusion, current_step)
         tasks ||= []
-    
+
         tasks = tasks.map do |t|
           t_path = Nexmo::Markdown::DocFinder.find(
             root: task_content_path,
             document: t,
             language: ::I18n.locale
-          )
+          ).path
           raise "Subtask not found: #{t}" unless File.exist? t_path
-    
+
           subtask_config = YAML.safe_load(File.read(t_path))
           {
             'path' => t,
@@ -108,7 +108,7 @@ module Nexmo
             'is_active' => t == current_step,
           }
         end
-    
+
         if prerequisites
           tasks.unshift({
             'path' => 'prerequisites',
@@ -117,7 +117,7 @@ module Nexmo
             'is_active' => current_step == 'prerequisites',
           })
         end
-    
+
         if introduction
           tasks.unshift({
             'path' => 'introduction',
@@ -126,7 +126,7 @@ module Nexmo
             'is_active' => current_step == 'introduction',
           })
         end
-    
+
         if conclusion
           tasks.push({
             'path' => 'conclusion',
@@ -135,14 +135,14 @@ module Nexmo
             'is_active' => current_step == 'conclusion',
           })
         end
-    
+
         tasks
       end
-    
+
       def self.task_content_path
         "#{ENV['DOCS_BASE_PATH']}/_tutorials"
       end
     end
-    
+
   end
-end
+end

data/lib/nexmo_markdown_renderer/models/use_case.rb

@@ -3,25 +3,29 @@ module Nexmo
     class UseCase
       include ActiveModel::Model
       attr_accessor :title, :description, :external_link, :products, :document_path, :languages, :root
-    
+
       def body
         File.read(document_path)
       end
-    
+
+      def relative_path
+        document_path.relative_path_from(self.class.origin).sub("#{::I18n.locale}/", '').to_s.gsub('.md', '')
+      end
+
       def path
         return external_link if external_link
-        path = document_path.relative_path_from(Nexmo::Markdown::UseCase.origin).sub("#{::I18n.locale}/", '')
-        "/use-cases/#{path}".gsub('.md', '')
+
+        "/use-cases/#{relative_path}"
       end
-    
+
       def subtitle
         normalized_products = products.map do |product|
           normalise_product_title(product)
         end
-    
+
         normalized_products.sort.to_sentence
       end
-    
+
       def normalise_product_title(product)
         return 'SMS' if product == 'messaging/sms'
         return 'Voice' if product == 'voice/voice-api'
@@ -32,33 +36,33 @@ module Nexmo
         return 'Subaccounts' if product == 'account/subaccounts'
         product.camelcase
       end
-    
+
       def self.by_product(product, use_cases = [])
         use_cases = all if use_cases.empty?
         use_cases.select do |use_case|
           use_case.products.include? product
         end
       end
-    
+
       def self.by_language(language, use_cases = [])
         language = language.downcase
         use_cases = all if use_cases.empty?
-    
+
         use_cases.select do |use_case|
           use_case.languages.map(&:downcase).include? language
         end
       end
-    
+
       def self.origin
         Pathname.new("#{ENV['DOCS_BASE_PATH']}/_use_cases")
       end
-    
+
       def self.all
         files.map do |document_path|
           document_path = Pathname.new(document_path)
           document = File.read(document_path)
           frontmatter = YAML.safe_load(document)
-    
+
           Nexmo::Markdown::UseCase.new({
             title: frontmatter['title'],
             description: frontmatter['description'],
@@ -70,9 +74,9 @@ module Nexmo
           })
         end
       end
-    
+
       private
-    
+
       private_class_method def self.files
         Dir.glob("#{origin}/**/*.md")
       end

data/lib/nexmo_markdown_renderer/services/doc_finder/doc.rb

@@ -0,0 +1,12 @@
+module Nexmo
+  module Markdown
+    class DocFinder::Doc
+      attr_reader :path, :available_languages
+
+      def initialize(path:, available_languages:)
+        @path                = path
+        @available_languages = available_languages
+      end
+    end
+  end
+end

data/lib/nexmo_markdown_renderer/services/doc_finder.rb

@@ -2,14 +2,14 @@ module Nexmo
   module Markdown
     class DocFinder
       class MissingDoc < StandardError; end
-    
+
       EXCLUSIONS = ['.', '..', ::I18n.default_locale.to_s].freeze
-    
+
       class << self
         mattr_accessor :paths
         mattr_accessor :dictionary
       end
-    
+
       # rubocop:disable Metrics/ParameterLists
       def self.find(root:, document:, language: nil, product: nil, code_language: nil, format: 'md', strip_root_and_language: false)
         if strip_root_and_language
@@ -19,7 +19,7 @@ module Nexmo
           if code_language.present?
             linkable_code_language(
               root: root,
-              language: language,
+              language: language.to_s,
               product: product,
               document: document,
               code_language: code_language,
@@ -28,7 +28,7 @@ module Nexmo
           else
             non_linkable(
               root: root,
-              language: language,
+              language: language.to_s,
               product: product,
               document: document,
               format: format
@@ -38,28 +38,34 @@ module Nexmo
           raise MissingDoc, e.message
         end
       end
-    
+
       def self.linkable_code_language(root:, language:, document:, product: nil, code_language: nil, format: nil)
         key = [
           build_key(root: root, product: product, document: "#{document}/#{code_language}", format: format),
           build_key(root: root, product: product, document: document, format: format),
         ].select { |k| dictionary.key?(k) }.first
-    
-        available_language = dictionary.fetch(key).fetch(language, ::I18n.default_locale.to_s)
-        build_doc_path(root, key, available_language)
+
+        build_doc(root: root, language: language, key: key)
       end
-    
+
       def self.non_linkable(root:, language:, document:, product: nil, format: nil)
         key = build_key(root: root, product: product, document: document, format: format)
+
+        build_doc(root: root, language: language, key: key)
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      def self.build_doc(root:, language:, key:)
         if root.starts_with?('app/views')
-          dictionary.fetch(key) && key
+          DocFinder::Doc.new(path: dictionary.fetch(key) && key, available_languages: ['en'])
         else
-          available_language = dictionary.fetch(key).fetch(language.to_s, ::I18n.default_locale.to_s)
-          build_doc_path(root, key, available_language)
+          available_languages = dictionary.fetch(key)
+          available_language = available_languages.fetch(language, ::I18n.default_locale.to_s)
+
+          DocFinder::Doc.new(path: build_doc_path(root, key, available_language), available_languages: available_languages.keys)
         end
       end
-      # rubocop:enable Metrics/ParameterLists
-    
+
       def self.build_key(root:, document:, product: nil, format: nil)
         path = if Pathname.new(document).extname.blank?
                  "#{root}/#{product}/#{document}.#{format}"
@@ -68,21 +74,21 @@ module Nexmo
                end
         path.gsub(%r{\/\/\/|\/\/}, '/')
       end
-    
+
       def self.build_doc_path(root, doc, language)
         doc.gsub(root, "#{root}/#{language}")
       end
-    
+
       def self.configure
         self.paths = []
         self.dictionary = Hash.new { |hash, key| hash[key] = {} }
-    
+
         yield(self)
-    
+
         load_english
         load_languages
       end
-    
+
       def self.load_english
         paths.each do |path|
           if path.starts_with?('app/views')
@@ -98,7 +104,7 @@ module Nexmo
           end
         end
       end
-    
+
       def self.load_languages
         paths.each do |path|
           Dir.foreach(path).reject { |d| EXCLUSIONS.include? d }.each do |language|
@@ -110,10 +116,10 @@ module Nexmo
           end
         end
       end
-    
+
       def self.strip_root_and_language(root:, language:, document:)
         document.sub(%r{#{root}\/}, '').sub(%r{#{language}\/}, '')
       end
-    end    
+    end
   end
-end
+end

data/lib/nexmo_markdown_renderer.rb

@@ -21,7 +21,8 @@ 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'
-Dir[File.join(__dir__, 'nexmo_markdown_renderer/services', '*.rb')].each { |file| require_relative file }
+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 }
 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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo_markdown_renderer
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Nexmo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-24 00:00:00.000000000 Z
+date: 2020-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: banzai
@@ -206,6 +206,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.31'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.31'
 description: Middleware to render Markdown Documents in Nexmo Developer Platform.
 email:
 - devrel@nexmo.com
@@ -248,6 +262,7 @@ files:
 - lib/nexmo_markdown_renderer/filters/modal_filter.rb
 - lib/nexmo_markdown_renderer/filters/partial_filter.rb
 - lib/nexmo_markdown_renderer/filters/php_inliner_filter.rb
+- lib/nexmo_markdown_renderer/filters/relative_link_filter.rb
 - lib/nexmo_markdown_renderer/filters/screenshot_filter.rb
 - lib/nexmo_markdown_renderer/filters/tab_filter.rb
 - lib/nexmo_markdown_renderer/filters/techio_filter.rb
@@ -276,6 +291,7 @@ files:
 - lib/nexmo_markdown_renderer/services/code_snippet_renderer/ruby.rb
 - lib/nexmo_markdown_renderer/services/code_snippet_renderer/swift.rb
 - lib/nexmo_markdown_renderer/services/doc_finder.rb
+- lib/nexmo_markdown_renderer/services/doc_finder/doc.rb
 - lib/nexmo_markdown_renderer/views/code_snippets/_application_messages_dispatch.html.erb
 - lib/nexmo_markdown_renderer/views/code_snippets/_application_rtc.html.erb
 - lib/nexmo_markdown_renderer/views/code_snippets/_application_voice.html.erb
@@ -286,7 +302,6 @@ files:
 - lib/nexmo_markdown_renderer/views/code_snippets/list/plain.html.erb
 - lib/nexmo_markdown_renderer/views/concepts/list/plain.html.erb
 - lib/nexmo_markdown_renderer/views/use_case/_index.html.erb
-- lib/nexmo_markdown_renderer/views/use_case/index.html.erb
 - lib/nexmo_markdown_renderer/views/use_case/list/plain.html.erb
 - lib/nexmo_markdown_renderer/views/use_case/show.html.erb
 - lib/version.rb
@@ -313,8 +328,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Middleware to render Markdown Documents in Nexmo Developer Platform.

data/lib/nexmo_markdown_renderer/views/use_case/index.html.erb

@@ -1,48 +0,0 @@
-<h1>Use Cases</h1>
-
-
-<style>
-  .tutorial-language-link svg {
-    height: 15px;
-    width: 15px;
-  }
-</style>
-
-<strong>Filter: &nbsp;&nbsp;</strong>
-
-<div class="Vlt-dropdown">
-  <button class="Vlt-dropdown__btn">
-    Choose a language
-  </button>
-  <div class="Vlt-dropdown__panel">
-    <div class="Vlt-dropdown__panel__content">
-      <ul>
-        <% @languages.each do |lang| %>
-          <li><a class="Vlt-dropdown__link" href="<%= "#{@base_path}/#{lang.key}" %>"><svg style="height: 20px; width: 20px;" ><use xlink:href=<%= GEM_ROOT %>/lib/nexmo_markdown_renderer/assets/images/brands/<%= lang.icon %>.svg#<%= lang.icon %>"></use></svg><span><%= lang.label %></span></a></li>
-        <% end %>
-      </ul>
-    </div>
-  </div>
-</div>
-
-
-<div class="Vlt-dropdown">
-  <button class="Vlt-dropdown__btn">
-    Choose a product
-  </button>
-  <div class="Vlt-dropdown__panel">
-    <div class="Vlt-dropdown__panel__content">
-      <ul>
-        <% @products.each do |product| %>
-          <li><a class="Vlt-dropdown__link" href="/<%= product['path'] %>/use-cases/<%= @language %>"><svg style="height: 20px; width: 20px;" class="Vlt-<%= product['icon_colour'] %>"><use xlink:href="/symbol/volta-icons.svg#Vlt-icon-<%= product['icon'] %>"></use></svgc><span><%= product['name'] %></span></a></li>
-        <% end %>
-      </ul>
-    </div>
-  </div>
-</div>
-
-<br><br>
-
-<p>Get started with Nexmo with tutorials that will walk you through building a variety of practical applications</p>
-
-<%= render 'index' %>