nexmo_markdown_renderer 0.7.0 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77ca5e9a51e8e1d8d1e0d3e0fad14c48fb01ab3fc67e893e2c2e45f1061b0d5d
-  data.tar.gz: d83bcc9efe2cd831553a5dc9c362f2f6db75fd3553ebad6d312172571fdcf23a
+  metadata.gz: a7d22b5298177cc9423ba86447361a3d59f7f12428d62c2c623ee13f2760861b
+  data.tar.gz: 0c0bb88101ee6af385d924c6be9233ad98a41e106dcca73c591dac1f209a8426
 SHA512:
-  metadata.gz: 951a51a1bdebc045a64769796ce16aaa1262c3f889730485aff1051a320f4b21c658505ace846cfc0b7dd9ed6db75d8cb1046eba2481c4b4ec79b623980ce6c7
-  data.tar.gz: 4b93e1a292a403cc32726d63ff18eba1ebb6f26fc6e28e944fa4fb87eebd5682466edfa83620d21d6e1b3bf5386da4963900b620e9ec65e439552fc63b244871
+  metadata.gz: d2ed733f1228b84a32bbef3a86ee4ad56f6506218ee7dc24faa77ec032f29fede9be1fef2db733bfc1491b03faff6f485dec206d07d36a44e650b14a54a079ea
+  data.tar.gz: 4cd84845df9bdc696dee67041b0d0f3c05d43c118f99b17158dd1179320963d54c5d80a71cd87a92e4cd8997e77ea0f9e517686fe24319b8de4d1dd1a1985bb9

data/lib/nexmo_markdown_renderer.rb

@@ -32,11 +32,6 @@ require_relative 'nexmo_markdown_renderer/services/doc_finder/doc'
 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'

data/lib/nexmo_markdown_renderer/filters/i18n/smartling/frontmatter_filter.rb

@@ -1,10 +1,10 @@
-module Nexmo
+module Nexmo  
   module Markdown
     module I18n
       module Smartling
         class FrontmatterFilter < Banzai::Filter
           def call(input)
-            input.gsub(/\A\*\*\* \*\* \* \*\* \*\*\*\n*(.*\n)!?(----+|\*\*\* \*\* \* \*\* \*\*\*)\n*/m) do |_frontmatter|
+            input.gsub(/\A\*\*\* \*\* \* \*\* \*\*\*\n*(.*?\n)!?(\*\*\* \*\* \* \*\* \*\*\*|----+)\n*/m) do |_frontmatter|
               front = $1.gsub(/`products: (.*)`\n\n/) do |products|
                 "products: #{$1}\n\n"
               end

data/lib/nexmo_markdown_renderer/filters/snippet_variables_filter.rb

@@ -13,12 +13,16 @@ module Nexmo
             -- | --
           HEREDOC
           config.each do |key|
+
             details = variables[key]
             raise "#{key} is not a valid snippet variable" unless details
-            raise "#{key} does not have a description" unless details['description']
+
+            # We have some variables in the format TO_NUMBER.SMS etc, and we only want to render the first segment
+            # This can be multiple segments e.g. UUID.MODIFY.VOICE will be rendered as UUID
+            title = key.split('.').first
 
             output += <<~HEREDOC
-              `#{key}` | #{details['description']}
+              `#{title}` | #{details}
             HEREDOC
           end
 

data/lib/nexmo_markdown_renderer/models/tutorial/prerequisite.rb

@@ -1,6 +1,7 @@
 module Nexmo
   module Markdown
     class Tutorial::Prerequisite
+      attr_accessor :name
       delegate :content, :yaml, to: :@file_loader
 
       def initialize(current_step:, code_language:, name:)

data/lib/nexmo_markdown_renderer/models/use_case.rb

@@ -65,7 +65,7 @@ module Nexmo
       end
 
       private_class_method def self.files
-        Dir.glob("#{origin}/**/*.md")
+        Dir.glob("#{origin}/#{::I18n.default_locale}/**/*.md")
       end
     end
   end

data/lib/nexmo_markdown_renderer/pipelines/smartling/download.rb

@@ -6,8 +6,7 @@ module Nexmo
           def initialize(_options = {})
             super(
               I18n::Smartling::FrontmatterFilter,
-              I18n::Smartling::EscapeFilter,
-              I18n::Smartling::CodeBlockFilter
+              I18n::Smartling::EscapeFilter
             )
           end
         end

data/lib/nexmo_markdown_renderer/services/doc_finder.rb

@@ -6,8 +6,8 @@ module Nexmo
       EXCLUSIONS = ['.', '..', ::I18n.default_locale.to_s].freeze
 
       class << self
-        mattr_accessor :paths
-        mattr_accessor :dictionary
+        attr_accessor :paths
+        attr_accessor :dictionary
       end
 
       # rubocop:disable Metrics/ParameterLists
@@ -68,10 +68,11 @@ module Nexmo
 
       def self.build_key(root:, document:, product: nil, format: nil)
         path = if Pathname.new(document).extname.blank?
-                 "#{root}/#{product}/#{document}.#{format}"
-               else
-                 "#{root}/#{product}/#{document}"
-               end
+          [root, product, document].compact.join("/").concat(".#{format}")
+        else
+          [root, product, document].compact.join("/")
+        end
+
         path.gsub(%r{\/\/\/|\/\/}, '/')
       end
 

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo_markdown_renderer
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.5
 platform: ruby
 authors:
 - Nexmo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-26 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: banzai
@@ -260,7 +260,6 @@ files:
 - lib/nexmo_markdown_renderer/filters/frontmatter_filter.rb
 - lib/nexmo_markdown_renderer/filters/heading_filter.rb
 - lib/nexmo_markdown_renderer/filters/i18n/frontmatter_filter.rb
-- lib/nexmo_markdown_renderer/filters/i18n/smartling/code_block_filter.rb
 - lib/nexmo_markdown_renderer/filters/i18n/smartling/escape_filter.rb
 - lib/nexmo_markdown_renderer/filters/i18n/smartling/frontmatter_filter.rb
 - lib/nexmo_markdown_renderer/filters/icon_filter.rb
@@ -290,11 +289,7 @@ files:
 - lib/nexmo_markdown_renderer/models/code_language.rb
 - lib/nexmo_markdown_renderer/models/code_snippet.rb
 - lib/nexmo_markdown_renderer/models/concept.rb
-- lib/nexmo_markdown_renderer/models/tutorial.rb
-- lib/nexmo_markdown_renderer/models/tutorial/file_loader.rb
-- lib/nexmo_markdown_renderer/models/tutorial/metadata.rb
 - lib/nexmo_markdown_renderer/models/tutorial/prerequisite.rb
-- lib/nexmo_markdown_renderer/models/tutorial/task.rb
 - lib/nexmo_markdown_renderer/models/use_case.rb
 - lib/nexmo_markdown_renderer/pipelines/smartling/download.rb
 - lib/nexmo_markdown_renderer/pipelines/smartling/preprocessor.rb

data/lib/nexmo_markdown_renderer/filters/i18n/smartling/code_block_filter.rb

@@ -1,20 +0,0 @@
-module Nexmo
-  module Markdown
-    module I18n
-      module Smartling
-        class CodeBlockFilter < Banzai::Filter
-          def call(input)
-            input.gsub(/\n\n\s{4}(.*?)\n\n/m) do
-              <<~CODE_BLOCK
-
-                ````
-                #{$1.split(/\n\s{4}/).join("\n")}
-                ````
-              CODE_BLOCK
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/nexmo_markdown_renderer/models/tutorial.rb

@@ -1,192 +0,0 @@
-module Nexmo
-  module Markdown
-    class Tutorial
-      include ActiveModel::Model
-
-      attr_reader :name, :current_step
-      delegate :path, :yaml, to: :@file_loader
-      delegate :available_code_languages, to: :metadata
-
-      def initialize(name:, current_step:, current_product: nil, code_language: nil)
-        @name         = name
-        @current_step = current_step
-        @product      = current_product
-        @language     = code_language
-        @file_loader  = load_file!
-      end
-
-      def metadata
-        @metadata ||= Metadata.new(name: name)
-      end
-
-      def current_product
-        @current_product ||= @product || metadata.default_product
-      end
-
-      def code_language
-        @code_language ||= @language || metadata.code_language
-      end
-
-      def title
-        @title ||= yaml['title'] || metadata.title
-      end
-
-      def description
-        @description ||= yaml['description'] || metadata.description
-      end
-
-      def products
-        @products ||= yaml['products'] || metadata.products
-      end
-
-      def prerequisites
-        @prerequisites ||= (yaml['prerequisites'] || []).map do |prereq|
-          Prerequisite.new(name: prereq, code_language: code_language, current_step: current_step)
-        end
-      end
-
-      def content_for(step_name)
-        if ['introduction', 'conclusion'].include? step_name
-          raise "Invalid step: #{step_name}" unless yaml[step_name]
-
-          return yaml[step_name]['content']
-        end
-
-        path = Nexmo::Markdown::DocFinder.find(
-          root: self.class.task_content_path,
-          document: step_name,
-          language: ::I18n.locale,
-          code_language: code_language
-        ).path
-
-        File.read(path)
-      end
-
-      def first_step
-        subtasks.first&.name
-      end
-
-      def prerequisite?
-        prerequisites.map(&:name).include?(@current_step)
-      end
-
-      def next_step
-        current_task_index = subtasks.map(&:name).index(@current_step)
-        return nil unless current_task_index
-
-        subtasks[current_task_index + 1]
-      end
-
-      def previous_step
-        current_task_index = subtasks.map(&:name).index(@current_step)
-        return nil unless current_task_index
-        return nil if current_task_index <= 0
-
-        subtasks[current_task_index - 1]
-      end
-
-      def subtasks
-        @subtasks ||= begin
-          tasks = []
-
-          (yaml['tasks'] || []).map do |t|
-            tasks.push(
-              Task.make_from(
-                name: t,
-                code_language: code_language,
-                current_step: current_step
-              )
-            )
-          end
-
-          tasks.unshift(prerequisite_task)
-          tasks.unshift(introduction_task)
-          tasks.push(conclusion_task)
-
-          tasks.compact
-        end
-      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)
-          {
-            'path' => t,
-            'title' => prereq['title'],
-            'description' => prereq['description'],
-            'is_active' => t == current_step,
-            'content' => content,
-          }
-        end
-      end
-
-      def prerequisite_task
-        return if prerequisites.empty?
-
-        Task.new(
-          name: 'prerequisites',
-          title: 'Prerequisites',
-          description: 'Everything you need to complete this task',
-          current_step: current_step
-        )
-      end
-
-      def introduction_task
-        return unless yaml['introduction']
-
-        Task.new(
-          name: 'introduction',
-          title: yaml['introduction']['title'],
-          description: yaml['introduction']['description'],
-          current_step: current_step
-        )
-      end
-
-      def conclusion_task
-        return unless yaml['conclusion']
-
-        Task.new(
-          name: 'conclusion',
-          title: yaml['conclusion']['title'],
-          description: yaml['conclusion']['description'],
-          current_step: current_step
-        )
-      end
-
-      def self.load(name, current_step, current_product = nil, code_language = nil)
-        new(
-          name: name,
-          current_step: current_step,
-          current_product: current_product,
-          code_language: code_language
-        )
-      end
-
-      def load_file!
-        Tutorial::FileLoader.new(
-          root: self.class.tutorials_path,
-          code_language: code_language,
-          doc_name: name
-        )
-      end
-
-      def self.task_content_path
-        "#{Nexmo::Markdown::Config.docs_base_path}/_tutorials"
-      end
-
-      def self.tutorials_path
-        'config/tutorials'
-      end
-    end
-  end
-end

data/lib/nexmo_markdown_renderer/models/tutorial/file_loader.rb

@@ -1,32 +0,0 @@
-module Nexmo
-  module Markdown
-    class Tutorial::FileLoader
-      attr_reader :root, :code_language, :doc_name, :format
-
-      def initialize(root:, code_language:, doc_name:, format: 'yml')
-        @root          = root
-        @code_language = code_language
-        @doc_name      = doc_name
-        @format        = format
-      end
-
-      def path
-        @path ||= Nexmo::Markdown::DocFinder.find(
-          root: root,
-          document: doc_name,
-          language: ::I18n.locale,
-          code_language: code_language,
-          format: format
-        ).path
-      end
-
-      def content
-        @content ||= File.read(path)
-      end
-
-      def yaml
-        @yaml ||= YAML.safe_load(content)
-      end
-    end
-  end
-end

data/lib/nexmo_markdown_renderer/models/tutorial/metadata.rb

@@ -1,57 +0,0 @@
-module Nexmo
-  module Markdown
-    class Tutorial::Metadata
-      attr_reader :name, :file_loader
-      delegate :path, :yaml, to: :file_loader
-
-      def initialize(name:)
-        @name        = name
-        @file_loader = load_file!
-      end
-
-      def products
-        @products ||= yaml['products'] || []
-      end
-
-      def title
-        @title ||= yaml['title']
-      end
-
-      def description
-        @description ||= yaml['description']
-      end
-
-      def external_link
-        @external_link ||= yaml['external_link']
-      end
-
-      def available_code_languages
-        @available_code_languages ||= begin
-                                        DocFinder
-                                          .code_languages_for_tutorial(path: path.sub('.yml', '/'))
-                                          .map { |file_path| File.basename(Pathname.new(file_path).basename, '.yml') }
-                                          .sort_by { |l| CodeLanguage.find(l).weight }
-                                      end
-      end
-
-      def code_language
-        @code_language ||= begin
-                             available_code_languages
-                               .min_by { |k| CodeLanguage.languages.map(&:key).index(k) }
-                           end
-      end
-
-      def default_product
-        @default_product ||= products.first
-      end
-
-      def load_file!
-        Tutorial::FileLoader.new(
-          root: Tutorial.tutorials_path,
-          code_language: nil,
-          doc_name: @name
-        )
-      end
-    end
-  end
-end

data/lib/nexmo_markdown_renderer/models/tutorial/task.rb

@@ -1,49 +0,0 @@
-module Nexmo
-  module Markdown
-    class Tutorial::Task
-      attr_reader :name, :title, :description, :current_step
-
-      def initialize(name:, title:, description:, current_step:)
-        @name         = name
-        @title        = title
-        @description  = description
-        @current_step = current_step
-      end
-
-      def active?
-        @name == @current_step
-      end
-
-      def self.make_from(name:, code_language:, current_step:)
-        file_loader = Tutorial::FileLoader.new(
-          root: Tutorial.task_content_path,
-          doc_name: name,
-          code_language: code_language,
-          format: 'md'
-        )
-
-        new(
-          name: name,
-          title: file_loader.yaml['title'],
-          description: file_loader.yaml['description'],
-          current_step: current_step
-        )
-      end
-
-      def ==(other)
-        name == other.name &&
-          title == other.title &&
-          description == other.description &&
-          current_step == other.current_step
-      end
-
-      def eql?(other)
-        self == other
-      end
-
-      def hash
-        name.hash ^ title.hash ^ description.hash ^ current_step.hash
-      end
-    end
-  end
-end