com.lightbend.paradox.markdown.Breadcrumbs.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of paradox_2.10 Show documentation

Paradox is a markdown documentation tool for software projects.

The newest version!

/*
 * Copyright © 2015 - 2019 Lightbend, Inc. 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.lightbend.paradox.markdown

import scala.collection.JavaConverters._

import com.lightbend.paradox.tree.Tree.Location
import org.pegdown.ast._

/**
 * Create markdown list for breadcrumbs path to a page location.
 */
object Breadcrumbs {

  /**
   * Convert a location path into a markdown list.
   * Note: locations are ordered from current location up to root.
   */
  def markdown(leadingBreadcrumbs: List[(String, String)], locations: List[Location[Page]]): BulletListNode =
    locations match {
      case current :: parents => crumbs(current.tree.label.base, current.tree.label.path, leadingBreadcrumbs, locations.reverse)
      case _                  => list(Nil)
    }

  private def crumbs(base: String, active: String, leadingBreadcrumbs: List[(String, String)], locations: List[Location[Page]]): BulletListNode = {
    val lead = leadingBreadcrumbs map { case (label, url) => item(url, "", labelNode(label), active) }
    list(lead ++ (locations map pageItem(base, active)))
  }

  private def list(items: List[ListItemNode]): BulletListNode = {
    new BulletListNode(new SuperNode(items.map(n => n: Node).asJava))
  }

  private def pageItem(base: String, active: String)(location: Location[Page]): ListItemNode = {
    val page = location.tree.label
    item(base + page.path, page.path, page.label, active)
  }

  private def item(url: String, path: String, label: Node, active: String): ListItemNode = {
    new ListItemNode(new SuperNode(link(url, path, label, active)))
  }

  private def link(url: String, path: String, label: Node, active: String): Node = {
    if (path == active) label // no link for current location
    else new ExpLinkNode("", url, label)
  }

  private def labelNode(label: String): Node = new SuperNode(new TextNode(label))

}