nexmo-oas-renderer 0.7.1 → 0.8.0

data/lib/nexmo/oas/renderer/filters/collapsible.rb

@@ -1,27 +0,0 @@
-module Nexmo
-  module OAS
-    module Renderer
-      module Filters
-        class Collapsible < Banzai::Filter
-          def call(input)
-            input.gsub(/^\|\s(\#{1,6})(\s)?(.+?)\n^\|\n(.+?)\n\n/m) do |_s|
-              heading = $3
-              body = $4.gsub(/^\|\n/, "\n")
-              body = body.gsub(/^\|\s/, '')
-              parsed_body = MarkdownPipeline.new.call(body)
-
-              <<~HEREDOC
-                <div class="Vlt-accordion Vlt-box Vlt-box--lesspadding Nxd-accordion-emphasis">
-                  <h5 class="Vlt-accordion__trigger"  tabindex="0">#{heading}</h5>
-                  <div class="Vlt-accordion__content Vlt-accordion__content--noborder">
-                    #{parsed_body}
-                  </div>
-                </div>
-              HEREDOC
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/nexmo/oas/renderer/filters/columns.rb

@@ -1,50 +0,0 @@
-module Nexmo
-  module OAS
-    module Renderer
-      module Filters
-        class Columns < Banzai::Filter
-          def call(input)
-            input.gsub!(%r{{column\:([1-4])\/([1-4])}\n(.+?){end}}m) do
-              s = []
-              s << row_start if $1 == '1'
-              s << column_start($2)
-              s << $3
-              s << column_end
-              s << row_end if $1 == $2
-              s.join('')
-            end
-
-            input
-          end
-
-          private
-
-          def row_start
-            "FREEZESTART#{Base64.urlsafe_encode64('<div class="row">')}FREEZEEND\n"
-          end
-
-          def row_end
-            close_tag
-          end
-
-          def close_tag
-            "FREEZESTART#{Base64.urlsafe_encode64('</div>')}FREEZEEND"
-          end
-
-          def column_start(columns)
-            html = "<div class='column small-12 medium-#{part_size(columns)}'>"
-            "FREEZESTART#{Base64.urlsafe_encode64(html)}FREEZEEND\n"
-          end
-
-          def column_end
-            "FREEZESTART#{Base64.urlsafe_encode64('</div>')}FREEZEEND\n"
-          end
-
-          def part_size(columns)
-            12 / Integer(columns)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/nexmo/oas/renderer/filters/concept_list.rb

@@ -1,33 +0,0 @@
-module Nexmo
-  module OAS
-    module Renderer
-      module Filters
-        class ConceptList < Banzai::Filter
-          def call(input)
-            input.gsub(/```concept_list(.+?)```/m) do |_s|
-              config = YAML.safe_load($1)
-
-              raise 'concept_list filter takes a YAML config' if config.nil?
-              raise "concept_list filter requires 'product' or 'concepts' key" unless config['product'] || config['concepts']
-
-              if config['product']
-                @product = config['product']
-                @concepts = Concept.by_product(@product)
-              elsif config['concepts']
-                @concepts = Concept.by_name(config['concepts'])
-              end
-
-              @concepts.reject!(&:ignore_in_list)
-
-              return '' if @concepts.empty?
-
-              erb = File.read("#{API.root}/views/concepts/list/plain.html.erb")
-              html = ERB.new(erb).result(binding)
-              "FREEZESTART#{Base64.urlsafe_encode64(html)}FREEZEEND"
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/nexmo/oas/renderer/filters/dynamic_content.rb

@@ -1,30 +0,0 @@
-module Nexmo
-  module OAS
-    module Renderer
-      module Filters
-        class DynamicContent < Banzai::Filter
-          def call(input)
-            input.gsub(/(\s|^)\[\~(.+?)\~\](\s|$)/) do
-              content = environment_value($2) || config_value($2) || "VALUE NOT SET: #{$2}"
-              "#{$1}#{content}#{$3}"
-            end
-          end
-
-          private
-
-          def environment_value(key)
-            return nil unless ENV['DYNAMIC_CONTENT']
-            @environment_dynamic_content ||= YAML.safe_load(ENV['DYNAMIC_CONTENT'])
-            @environment_dynamic_content ||= YAML.safe_load(temp)
-            @environment_dynamic_content[key]
-          end
-
-          def config_value(key)
-            @config_dynamic_content ||= YAML.load_file("#{API.root}/config/dynamic_content.yml")
-            @config_dynamic_content[key]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/nexmo/oas/renderer/filters/external_link.rb

@@ -1,32 +0,0 @@
-module Nexmo
-  module OAS
-    module Renderer
-      module Filters
-        class ExternalLink < Banzai::Filter
-          def call(input)
-            @input = input
-
-            document.css('a').each_with_index do |link, _index|
-              if link['href']&.start_with?('http') && link['class'] && !link['class'].include?('no-external-marker')
-                link['target'] = '_blank'
-                if link.css('svg').empty?
-                  link.add_child <<~HEREDOC
-                    &nbsp;<svg class="Vlt-icon Vlt-icon--smaller Vlt-icon--text-bottom Vlt-blue-dark"><use xlink:href="/assets/symbol/volta-icons.svg#Vlt-icon-open"></use></svg>
-                  HEREDOC
-                end
-              end
-            end
-
-            @document.to_html
-          end
-
-          private
-
-          def document
-            @document ||= Nokogiri::HTML::DocumentFragment.parse(@input)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/nexmo/oas/renderer/filters/frontmatter.rb

@@ -1,14 +0,0 @@
-module Nexmo
-  module OAS
-    module Renderer
-      module Filters
-        class Frontmatter < Banzai::Filter
-          def call(input)
-            # Remove frontmatter from the input
-            input.gsub(/\A(---.+?---)/mo, '')
-          end
-        end
-      end
-    end
-  end
-end

data/lib/nexmo/oas/renderer/filters/heading.rb

@@ -1,61 +0,0 @@
-module Nexmo
-  module OAS
-    module Renderer
-      module Filters
-        class Heading < Banzai::Filter
-          def call(input)
-            @input = input
-            @headings = []
-
-            heading_tag_list = %w[h1 h2 h3 h4 h5 h6]
-            headings = document.children.select do |child|
-              heading_tag_list.include? child.name
-            end
-
-            headings.each do |heading|
-              parameterized_heading = parameterized_heading_without_collision(heading)
-              heading['id'] = parameterized_heading
-              heading['data-id'] = SecureRandom.hex
-              heading['class'] = heading[:class]
-              heading['class'] += ' Vlt-title--icon'
-
-              heading.prepend_child <<~HEREDOC
-                <a href="##{parameterized_heading}" class="heading-permalink">
-                  <svg class="Vlt-grey"><use xlink:href=\"/assets/symbol/volta-icons.svg#Vlt-icon-link\" /></svg>
-                </a>
-              HEREDOC
-            end
-
-            @document.to_html
-          end
-
-          private
-
-          def document
-            @document ||= Nokogiri::HTML::DocumentFragment.parse(@input)
-          end
-
-          def parameterized_heading_without_collision(heading)
-            parameterized_heading = nil
-            index = nil
-
-            loop do
-              if index
-                parameterized_heading = "#{heading.text.parameterize}-#{index}"
-                index += 1
-              else
-                parameterized_heading = heading.text.parameterize
-                index = 2
-              end
-
-              break if @headings.exclude? parameterized_heading
-            end
-
-            @headings << parameterized_heading
-            parameterized_heading
-          end
-        end
-      end
-    end
-  end
-end

data/lib/nexmo/oas/renderer/filters/icon.rb

@@ -1,22 +0,0 @@
-module Nexmo
-  module OAS
-    module Renderer
-      module Filters
-        class Icon < Banzai::Filter
-          def call(input)
-            input.gsub!('✅', '<svg class="Vlt-green Vlt-icon Vlt-icon--small"><use xlink:href="/assets/symbol/volta-icons.svg#Vlt-icon-check" /></svg>')
-            input.gsub!('❌', '<svg class="Vlt-red Vlt-icon Vlt-icon--small"><use xlink:href="/assets/symbol/volta-icons.svg#Vlt-icon-cross" /></svg>')
-
-            input.gsub!(/\[icon="(.+?)"\]/) do
-              <<~HEREDOC
-                <svg class="Vlt-green Vlt-icon Vlt-icon--small"><use xlink:href="/assets/symbol/volta-icons.svg#Vlt-icon-#{$1}" /></svg>
-              HEREDOC
-            end
-
-            input
-          end
-        end
-      end
-    end
-  end
-end

data/lib/nexmo/oas/renderer/filters/indent.rb

@@ -1,20 +0,0 @@
-module Nexmo
-  module OAS
-    module Renderer
-      module Filters
-        class Indent < Banzai::Filter
-          def call(input)
-            input.gsub(/^^\s{4}\-\>\s(.+?)$/) do
-              body = MarkdownPipeline.new.call($1)
-              <<~HEREDOC
-                <div class="indent">
-                  #{body}
-                </div>
-              HEREDOC
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/nexmo/oas/renderer/filters/inline_escape.rb

@@ -1,17 +0,0 @@
-module Nexmo
-  module OAS
-    module Renderer
-      module Filters
-        class InlineEscape < Banzai::Filter
-          def call(input)
-            # Freeze to prevent Markdown formatting
-            input.gsub(/``(.+?)``/) do |_s|
-              frozen_code = Base64.urlsafe_encode64("<code>#{$1}</code>")
-              "FREEZESTART#{frozen_code}FREEZEEND"
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/nexmo/oas/renderer/filters/js_sequence_diagram.rb

@@ -1,21 +0,0 @@
-module Nexmo
-  module OAS
-    module Renderer
-      module Filters
-        class JsSequenceDiagram < Banzai::Filter
-          def call(input)
-            input.gsub(/```js_sequence_diagram(.+?)```/m) do |_s|
-              diagram = <<~HEREDOC
-                <div class="js-diagram">
-                  #{$1}
-                </div>
-              HEREDOC
-
-              "FREEZESTART#{Base64.urlsafe_encode64(diagram)}FREEZEEND"
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/nexmo/oas/renderer/filters/label.rb

@@ -1,32 +0,0 @@
-module Nexmo
-  module OAS
-    module Renderer
-      module Filters
-        class Label < Banzai::Filter
-          def call(input)
-            input.gsub(/\[(GET|POST|PUT|DELETE|OPTIONS)\]/i) do |_s|
-              "<span class='Vlt-badge #{class_name($1)}'>#{$1}</span> "
-            end
-          end
-
-          private
-
-          def class_name(text)
-            case text
-            when 'POST'
-              'Vlt-badge--green'
-            when 'GET'
-              'Vlt-badge--blue'
-            when 'DELETE'
-              'Vlt-badge--red'
-            when 'PUT'
-              'Vlt-badge--yellow'
-            when 'OPTIONS'
-              'Vlt-badge--grey'
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/nexmo/oas/renderer/filters/language.rb

@@ -1,15 +0,0 @@
-module Nexmo
-  module OAS
-    module Renderer
-      module Filters
-        class Language < Banzai::Filter
-          def call(input)
-            input.gsub(/\[(.+?)\]\(lang:.+?(?:'(.+?)'|"(.+?)")\)/) do |_s|
-              "<span lang='#{$2}'>#{$1}</span>"
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/nexmo/oas/renderer/filters/markdown.rb

@@ -1,85 +0,0 @@
-require_relative '../lib/redcarpet'
-
-module Nexmo
-  module OAS
-    module Renderer
-      module Filters
-        class Markdown < Banzai::Filter
-          def call(input)
-            markdown.render(input)
-          end
-
-          private
-
-          def renderer
-            @renderer ||= VoltaRender.new(options)
-          end
-
-          def markdown
-            @markdown ||= Redcarpet::Markdown.new(renderer, {
-              no_intra_emphasis: true,
-              tables: true,
-              strikethrough: true,
-              superscript: true,
-              underline: true,
-              highlight: true,
-              fenced_code_blocks: true,
-              disable_indented_code_blocks: true,
-              start_inline: true,
-            })
-          end
-        end
-
-        class VoltaRender < HTML
-          def initialize(options)
-            @options = options
-            super(options)
-          end
-
-          def paragraph(text)
-            return text if @options[:skip_paragraph_surround]
-            "<p>#{text}</p>"
-          end
-
-          def table(header, body)
-            '<div class="Vlt-table Vlt-table--data Vlt-table--bordered">' \
-              '<table>' \
-              "<thead>#{header}</thead>" \
-              "<tbody>#{body}</tbody>" \
-              '</table>' \
-              '</div>'
-          end
-
-          def block_quote(quote)
-            '<div class="Vlt-callout Vlt-callout--tip">' \
-              '<i></i>' \
-              '<div class="Vlt-callout__content">' \
-              "#{quote}" \
-              '</div>' \
-              '</div>'
-          end
-
-          def image(link, _title, _alt_text)
-            '<figure>' \
-              '<img src="'\
-              "#{link}"\
-              '" alt="#{alt_text}">' \
-              '</figure>'
-          end
-
-          def list(contents, list_type)
-            if "#{list_type}" == 'unordered'
-              '<ul class="Vlt-list Vlt-list--simple">' \
-                "#{contents}" \
-                '</ul>'
-            else
-              '<ol class="Vlt-list Vlt-list--simple">' \
-                "#{contents}" \
-                '</ol>' \
-            end
-          end
-        end
-      end
-    end
-  end
-end