station 0.0.0 → 0.0.93

data/lib/nexmo_developer/app/presenters/improve_page_presenter.rb

@@ -0,0 +1,19 @@
+class ImprovePagePresenter
+  def initialize(document_path)
+    @document_path = document_path
+  end
+
+  def github_url
+    @github_url ||= "https://github.com/#{docs_repo}/blob/#{ENV.fetch('branch', 'master')}/#{path_to_url}"
+  end
+
+  private
+
+  def path_to_url
+    @document_path&.gsub("#{Rails.configuration.docs_base_path}/", '')
+  end
+
+  def docs_repo
+    @docs_repo ||= YAML.safe_load(File.open("#{Rails.configuration.docs_base_path}/config/business_info.yml"))['docs_repo']
+  end
+end

data/lib/nexmo_developer/app/presenters/languages_dropdown_presenter.rb

@@ -0,0 +1,19 @@
+class LanguagesDropdownPresenter
+  class Option
+    def initialize(language)
+      @language = language
+    end
+
+    def code_language
+      @code_language ||= @language.key
+    end
+  end
+
+  def options
+    @options ||= languages.map { |l| Option.new(l) }
+  end
+
+  def languages
+    @languages ||= Nexmo::Markdown::CodeLanguage.languages.reject { |l| l.key == 'dotnet' }
+  end
+end

data/lib/nexmo_developer/app/presenters/locale_switcher_presenter.rb

@@ -0,0 +1,36 @@
+class LocaleSwitcherPresenter
+  LOCALES = {
+    'cn' => '简体中文',
+    'en' => 'English',
+    'ja' => '日本語',
+  }.freeze
+
+  def initialize(request)
+    @request = request
+  end
+
+  def disabled?
+    @request.controller_class == ActionDispatch::Request::PASS_NOT_FOUND
+  end
+
+  def current_locale
+    LOCALES[I18n.locale.to_s]
+  end
+
+  def locales
+    @locales ||= available_locales.map do |l|
+      OpenStruct.new(data: l, value: LOCALES[l])
+    end
+  end
+
+  def available_locales
+    @available_locales ||= begin
+      root = "#{Rails.configuration.docs_base_path}/_documentation"
+      Dir["#{root}/*"].map { |path| path.gsub("#{root}/", '') }
+    end
+  end
+
+  def multiple_locales?
+    locales.length > 1
+  end
+end

data/lib/nexmo_developer/app/presenters/navigation.rb

@@ -0,0 +1,44 @@
+class Navigation
+  IGNORED_PATHS = ['..', '.', '.DS_Store'].freeze
+  NAVIGATION    = LoadConfig.load_file('config/navigation.yml')
+  WEIGHT        = NAVIGATION['navigation_weight']
+  OVERRIDES     = NAVIGATION['navigation_overrides']
+
+  def initialize(folder)
+    @folder = folder
+  end
+
+  def options
+    @options ||= begin
+      path_to_url.tr('/', '.').split('.').inject(OVERRIDES) { |h, k| h[k] || {} }
+    end
+  end
+
+  def path_to_url
+    @path_to_url ||= begin
+      if @folder[:is_task?]
+        path = @folder[:path].sub(@folder[:root], '')
+        path.sub(%r{^/\w+/}, '').chomp('.yml')
+      else
+        path = @folder[:path].gsub("#{Rails.configuration.docs_base_path}/", '')
+        path.sub(%r{^\w+/\w+/}, '').chomp('.md')
+      end
+    end
+  end
+
+  def product
+    @product ||= begin
+      if @folder[:path].starts_with?('app/views')
+        path_to_url.split('/').first
+      else
+        DocumentationConstraint.products_for_routes.find do |p|
+          path_to_url.starts_with? p
+        end
+      end
+    end
+  end
+
+  def document
+    @document ||= path_to_url.sub("#{product}/", '')
+  end
+end

data/lib/nexmo_developer/app/presenters/page_title.rb

@@ -0,0 +1,38 @@
+class PageTitle
+  def initialize(product, document_title)
+    @product        = product
+    @document_title = document_title
+  end
+
+  def title
+    if @product && @document_title
+      "#{product_title_from_config(@product)} > #{@document_title} | #{default_title}"
+    elsif @document_title
+      "#{@document_title} | #{default_title}"
+    else
+      default_title
+    end
+  end
+
+  def product_title_from_config(product)
+    config = load_config
+    item = config['products'].select { |config_product| config_product['path'] == product }[0]
+    item['name']
+  end
+
+  def load_config
+    @load_config ||= begin
+      path ||= "#{Rails.configuration.docs_base_path}/config/products.yml"
+      raise 'You must provide a config/products.yml file in your documentation path.' unless File.exist?(path)
+
+      YAML.safe_load(File.open(path))
+    end
+  end
+
+  def default_title
+    @default_title ||= begin
+      config = YAML.safe_load(File.open("#{Rails.configuration.docs_base_path}/config/header_meta.yml"))
+      config['title']
+    end
+  end
+end

data/lib/nexmo_developer/app/presenters/product_dropdown_presenter.rb

@@ -0,0 +1,39 @@
+class ProductDropdownPresenter
+  class Option
+    def initialize(product)
+      @product = product
+    end
+
+    def path
+      @path ||= @product['path']
+    end
+
+    def icon
+      @icon ||= @product['icon']
+    end
+
+    def name
+      @name ||= @product['name']
+    end
+  end
+
+  def initialize(scope)
+    @scope = scope
+  end
+
+  def options
+    @options ||= begin
+      products.select { |p| scoped_products.include?(p['path']) }.map do |p|
+        Option.new(p)
+      end
+    end
+  end
+
+  def scoped_products
+    @scoped_products ||= @scope.map(&:products).flatten.uniq
+  end
+
+  def products
+    @products ||= Product.all.select { |p| p['dropdown'] == true }
+  end
+end

data/lib/nexmo_developer/app/presenters/sidenav.rb

@@ -0,0 +1,64 @@
+class Sidenav
+  attr_reader :request_path, :navigation, :product, :code_language, :locale
+
+  # rubocop:disable Metrics/ParameterLists
+  def initialize(request_path:, navigation:, product:, locale: nil, code_language: nil, namespace: nil)
+    @request_path  = request_path
+    @navigation    = navigation
+    @product       = product
+    @locale        = locale
+    @code_language = code_language
+    @namespace     = namespace
+
+    after_initialize!
+  end
+  # rubocop:enable Metrics/ParameterLists
+
+  def nav_items
+    @nav_items ||= items.map do |item|
+      SidenavItem.new(folder: item, sidenav: self)
+    end
+  end
+
+  def namespace
+    @namespace.presence || 'documentation'
+  end
+
+  def documentation?
+    namespace == 'documentation'
+  end
+
+  private
+
+  def after_initialize!
+    if @namespace.present?
+      @path = "app/views/#{@namespace}"
+    else
+      @path = "#{Rails.configuration.docs_base_path}/_documentation"
+    end
+  end
+
+  def children
+    @children ||= resolver.items
+  end
+
+  def items
+    if @namespace.present?
+      [{
+        title: @namespace,
+        path: @path.gsub('app/views', ''),
+        children: children,
+      }]
+    else
+      children
+    end
+  end
+
+  def resolver
+    @resolver ||= SidenavResolver.new(
+      path: @path,
+      namespace: @namespace,
+      language: I18n.locale
+    )
+  end
+end

data/lib/nexmo_developer/app/presenters/sidenav_item.rb

@@ -0,0 +1,58 @@
+class SidenavItem
+  include Rails.application.routes.url_helpers
+
+  delegate :request_path, :navigation, :product, :documentation?,
+           :namespace, :code_language, :locale, to: :@sidenav
+
+  def initialize(folder:, sidenav:)
+    @folder  = folder
+    @sidenav = sidenav
+    @options = Navigation.new(folder).options
+  end
+
+  def svg?
+    svg && svg_color
+  end
+
+  def svg
+    @options['svg'] && "/symbol/volta-icons.svg#Vlt-icon-#{@options['svg']}"
+  end
+
+  def svg_color
+    'Vlt-gray-darker'
+  end
+
+  def label?
+    label.present?
+  end
+
+  def label
+    @options['label']
+  end
+
+  def children
+    @children ||= (@folder[:children] || []).map do |child|
+      SidenavSubitem.new(folder: child, sidenav: @sidenav)
+    end
+  end
+
+  def css_classes
+    classes = ['Nxd-sidenav-badge Vlt-badge Vlt-badge--margin-left Vlt-badge--small']
+    classes << 'Vlt-bg-green-lighter Vlt-green' if label.casecmp('beta').zero?
+    classes << 'Vlt-bg-blue-lighter Vlt-blue' if label.casecmp('dev preview').zero?
+
+    classes.join(' ')
+  end
+
+  def link_url
+    "/product-lifecycle/#{label.downcase.tr(' ', '-')}"
+  end
+
+  def normalized_title
+    @normalized_title ||= TitleNormalizer.call(@folder)
+  end
+
+  def title
+    @folder[:title]
+  end
+end

data/lib/nexmo_developer/app/presenters/sidenav_resolver.rb

@@ -0,0 +1,136 @@
+class SidenavResolver
+  IGNORED_PATHS = ['..', '.', '.DS_Store'].freeze
+
+  def initialize(path:, language:, namespace: nil)
+    @path      = path
+    @language  = language
+    @namespace = namespace
+  end
+
+  def items
+    if @path.starts_with?('app/views')
+      directories(@path)[:children]
+    else
+      directories("#{@path}/#{I18n.default_locale}")[:children]
+    end
+  end
+
+  def directories(path, name = nil)
+    data = { title: (name || path), path: path }
+    data[:children] = []
+    # Find all markdown files on disk that are children
+    Dir.foreach(path) do |entry|
+      next if entry.start_with?('.')
+      next if IGNORED_PATHS.include? entry
+
+      full_path = File.join(path, entry)
+      next if documentation_index?(full_path)
+
+      if File.directory?(full_path)
+        config = if tabbed_folder?(full_path)
+                   YAML.safe_load(File.read("#{full_path}/.config.yml"))
+                 end
+
+        if config && config['tabbed']
+          data[:children] << { title: config['title'], path: full_path, is_tabbed?: true }
+        else
+          data[:children] << directories(full_path, entry)
+        end
+      else
+        doc_path = Nexmo::Markdown::DocFinder.find(root: @path, document: full_path, language: @language, strip_root_and_language: true).path
+        data[:children] << { title: entry, path: doc_path, is_file?: true }
+      end
+    end
+
+    # Do we have tasks for this product?
+    product = path.sub(%r{#{Rails.configuration.docs_base_path}/\w+/\w+/}, '')
+
+    if DocumentationConstraint.products_for_routes.include? product
+      tasks = TutorialList.by_product(product)
+
+      # If we have use cases and tutorials, output them
+      if tasks['tutorials'].any?
+        data[:children] << { title: 'tutorials', path: "/#{product}/tutorials", children: tasks['tutorials'].map(&:as_json) }
+      end
+
+      if tasks['use_cases'].any?
+        # Otherwise show use_case as the top level
+        data[:children] << { title: 'use-cases', path: "/#{product}/use-cases", children: tasks['use_cases'] }
+      end
+    end
+
+    sort_navigation(data)
+  end
+
+  def sort_navigation(context)
+    # Sort top level
+    context[:children].sort_by! do |item|
+      configuration_identifier = url_to_configuration_identifier(path_to_url(item[:path]))
+      options = configuration_identifier.split('.').inject(Navigation::OVERRIDES) { |h, k| h[k] || {} }
+
+      sort_array = []
+      sort_array << (options['navigation_weight'] || 1000) # If we have a path specific navigation weight, use that to explicitly order this
+      sort_array << (item[:is_file?] ? 0 : 1) if context[:path].include? 'code-snippets' # Directories *always* go after single files for Code Snippets (priority 1 rather than 0). This even overrides config entries
+      sort_array << item_navigation_weight(item) # If we have a config entry for this, use it. Otherwise put it at the end
+      sort_array << (item[:is_file?] ? 0 : 1) # If it's a file it gets higher priority than a directory
+      sort_array << navigation_weight_from_meta(item) # Use the config entry if we have it. Otherwise it goes to the end
+      sort_array
+    end
+
+    # Sort children if needed
+    context[:children].each do |child|
+      sort_navigation(child) if child[:children]
+    end
+
+    context
+  end
+
+  def url_to_configuration_identifier(url)
+    url.tr('/', '.')
+  end
+
+  def strip_namespace(path)
+    path = path.gsub('.yml', '').sub("#{Rails.configuration.docs_base_path}/_use_cases/", 'use-cases/')
+    path = path.gsub('.yml', '').sub('config/tutorials/', '/tutorials/')
+    path = path.gsub('.yml', '').sub("#{Rails.configuration.docs_base_path}/", '')
+    path.sub(%r{\w+/\w+/}, '')
+  end
+
+  def path_to_url(path)
+    strip_namespace(path).gsub('.md', '')
+  end
+
+  def item_navigation_weight(item)
+    key = navigation_key(item)
+    Navigation::WEIGHT[key] || 1000
+  end
+
+  def navigation_weight_from_meta(item)
+    return 1000 unless item[:is_file?]
+
+    document_meta(item)['navigation_weight'] || 1000
+  end
+
+  def document_meta(item)
+    doc = Nexmo::Markdown::DocFinder.find(root: item[:root] || @path, document: item[:path], language: @language, strip_root_and_language: true).path
+    YAML.load_file(doc)
+  end
+
+  private
+
+  def documentation_index?(path)
+    path == "#{Rails.configuration.docs_base_path}/_documentation/#{I18n.default_locale}/index.md"
+  end
+
+  def tabbed_folder?(full_path)
+    File.exist?("#{full_path}/.config.yml")
+  end
+
+  def navigation_key(item)
+    if item[:is_file?]
+      item[:title].split('.').first
+    else
+      item[:title]
+    end
+  end
+end