navigator 5.0.0 → 5.5.0

data/lib/navigator/identity.rb

@@ -3,20 +3,9 @@
 module Navigator
   # Gem identity information.
   module Identity
-    def self.name
-      "navigator"
-    end
-
-    def self.label
-      "Navigator"
-    end
-
-    def self.version
-      "5.0.0"
-    end
-
-    def self.version_label
-      "#{label} #{version}"
-    end
+    NAME = "navigator"
+    LABEL = "Navigator"
+    VERSION = "5.5.0"
+    VERSION_LABEL = "#{LABEL} #{VERSION}"
   end
 end

data/lib/navigator/menu.rb

@@ -3,11 +3,11 @@
 module Navigator
   # Renders a HTML menu.
   class Menu
-    # rubocop:disable Metrics/LineLength
+    # rubocop:disable Layout/LineLength
     def self.allowed_methods
       /^(div|section|header|h[1-6]|nav|ul|li|a|img|b|em|s|small|span|strong|sub|sup|form|label|select|option|input|button)$/
     end
-    # rubocop:enable Metrics/LineLength
+    # rubocop:enable Layout/LineLength
 
     def initialize template,
                    tag: "ul",
@@ -19,12 +19,12 @@ module Navigator
       @tag = Navigator::Tag.new tag, attributes: attributes, activator: activator
       @menu_activator = activator
       @items = []
-      instance_eval(&block) if block_given?
+      instance_eval(&block) if block
     end
 
     def add name, content = nil, attributes: {}, activator: menu_activator, &block
       tag = Navigator::Tag.new name, content, attributes: attributes, activator: activator
-      return items << tag.render unless block_given?
+      return items << tag.render unless block
 
       items << tag.prefix
       items << tag.content
@@ -71,7 +71,7 @@ module Navigator
     end
 
     def render
-      [tag.prefix, tag.content, items.compact.join(""), tag.suffix].compact * ""
+      [tag.prefix, tag.content, items.compact.join, tag.suffix].compact.join
     end
 
     private

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: navigator
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.5.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIC/jCCAeagAwIBAgIBAjANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
-  a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0xOTAyMTcxNjAxMTFaFw0yMDAyMTcx
-  NjAxMTFaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
+  MIIC/jCCAeagAwIBAgIBAzANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
+  a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0yMDAzMTUxNDQ1MzJaFw0yMTAzMTUx
+  NDQ1MzJaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
   IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6l1qpXTiomH1RfMRloyw7MiE
   xyVx/x8Yc3EupdH7uhNaTXQGyORN6aOY//1QXXMHIZ9tW74nZLhesWMSUMYy0XhB
   brs+KkurHnc9FnEJAbG7ebGvl/ncqZt72nQvaxpDxvuCBHgJAz+8i5wl6FhLw+oT
@@ -20,15 +20,15 @@ cert_chain:
   D5vkU0YlAm1r98BymuJlcQ1qdkVEI1d48ph4kcS0S0nv1RiuyVb6TCAR3Nu3VaVq
   3fPzZKJLZBx67UvXdbdicWPiUR75elI4PXpLIic3xytaF52ZJYyKZCNZJhNwfQID
   AQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU0nzow9vc
-  2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBANgfX7kPZkJvsbdWMvbe
-  DUUYxRTqTUzCDpLd2p3sQvgLMKjTNSKt6CFq/kh+98b6RCgO6DqiVfxvOEq02dvf
-  ebMN/ylQqan2FgiAs1rpP0/D4C0MlBjoDktsT+2IyLol1KmkDB20ExJ4Sf1GRNdA
-  hpWOtcgqHtmrc7xzgB6BuyoYufrKKUlCO3ewTM4C375D2qO7hIdKuMOO3CdPMtSk
-  OrWpbzCL+nbbXqeoqiHgZaUvcyyQrGj5sQRxMTzuMXzzQxtHnuTuKrcz16HMTX/O
-  dKvURM+1PwDCzC5tvRwjhUJIizau6+MtkFCvJHmaAj1aZL3odcPejHj5Hxt/0CUW
-  y84=
+  2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBAIHhAlD3po4sTYqacXaQ
+  XI9jIhrfMy//2PgbHWcETtlJPBeNUbbSNBABcllUHKqYsVDlSvSmss034KSWNR8F
+  bF1GcloicyvcCC4y6IoW4it0COAcdeaaxkxiBSgKdQFpff9REnDlIKK4uQ9lLxIo
+  Y2G5xubiziKZkyfWFuSr67PIjW3Bu673D1JVBArhA1qbgQmYQcy1CkGOjo+iO8Nf
+  7u/QSfBHb+r/bXhKscDgPpnKwbUmvgO2+94zJG9KsrmIydlzYfsD09aXKx0t6Xy4
+  2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
+  QWc=
   -----END CERTIFICATE-----
-date: 2020-01-01 00:00:00.000000000 Z
+date: 2020-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -45,240 +45,30 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: bundler-audit
+  name: refinements
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: capybara
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: gemsmith
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '14.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '14.0'
-- !ruby/object:Gem::Dependency
-  name: git-cop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-- !ruby/object:Gem::Dependency
-  name: pg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.4'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.78'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.78'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.37'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.37'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.17'
-  type: :development
+        version: '7.16'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
-description: 
+        version: '7.16'
+description:
 email:
 - brooke@alchemists.io
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
-- LICENSE.md
+- README.adoc
+- LICENSE.adoc
 files:
-- LICENSE.md
-- README.md
+- LICENSE.adoc
+- README.adoc
 - app/helpers/navigator/navigation_helper.rb
 - lib/navigator.rb
 - lib/navigator/engine.rb
@@ -286,14 +76,15 @@ files:
 - lib/navigator/menu.rb
 - lib/navigator/tag.rb
 - lib/navigator/tag_activator.rb
-homepage: https://github.com/bkuhlmann/navigator
+homepage: https://www.alchemists.io/projects/navigator
 licenses:
 - Apache-2.0
 metadata:
-  source_code_uri: https://github.com/bkuhlmann/navigator
-  changelog_uri: https://github.com/bkuhlmann/navigator/blob/master/CHANGES.md
   bug_tracker_uri: https://github.com/bkuhlmann/navigator/issues
-post_install_message: 
+  changelog_uri: https://www.alchemists.io/projects/navigator/changes.html
+  documentation_uri: https://www.alchemists.io/projects/navigator
+  source_code_uri: https://github.com/bkuhlmann/navigator
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -308,8 +99,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.0
+signing_key:
 specification_version: 4
 summary: Enhances Rails with a DSL for menu navigation.
 test_files: []

data/README.md

@@ -1,419 +0,0 @@
-<p align="center">
-  <img src="navigator.png" alt="Navigator Icon"/>
-</p>
-
-# Navigator
-
-[![Gem Version](https://badge.fury.io/rb/navigator.svg)](http://badge.fury.io/rb/navigator)
-[![Code Climate Maintainability](https://api.codeclimate.com/v1/badges/2f8632ec1f734ea9561a/maintainability)](https://codeclimate.com/github/bkuhlmann/navigator/maintainability)
-[![Code Climate Test Coverage](https://api.codeclimate.com/v1/badges/2f8632ec1f734ea9561a/test_coverage)](https://codeclimate.com/github/bkuhlmann/navigator/test_coverage)
-[![Circle CI Status](https://circleci.com/gh/bkuhlmann/navigator.svg?style=svg)](https://circleci.com/gh/bkuhlmann/navigator)
-
-Enhances Rails with a DSL for menu navigation.
-
-<!-- Tocer[start]: Auto-generated, don't remove. -->
-
-## Table of Contents
-
-  - [Features](#features)
-  - [Requirements](#requirements)
-  - [Setup](#setup)
-  - [Usage](#usage)
-    - [Unordered List (simple)](#unordered-list-simple)
-    - [Unordered List (with attributes)](#unordered-list-with-attributes)
-    - [Unordered List (with multiple data attributes)](#unordered-list-with-multiple-data-attributes)
-    - [Nav (with links)](#nav-with-links)
-    - [Foundation Menu](#foundation-menu)
-    - [Bootstrap Dropdown](#bootstrap-dropdown)
-    - [Menu Helpers](#menu-helpers)
-  - [Customization](#customization)
-  - [Tests](#tests)
-  - [Versioning](#versioning)
-  - [Code of Conduct](#code-of-conduct)
-  - [Contributions](#contributions)
-  - [License](#license)
-  - [History](#history)
-  - [Credits](#credits)
-
-<!-- Tocer[finish]: Auto-generated, don't remove. -->
-
-## Features
-
-- Provides a DSL for building navigation menus.
-- Supports auto-detection/highlighting of active menu items based on current path (customizable for
-  non-path usage too).
-- Supports sub-menus, nested tags, HTML attributes, etc.
-- Supports the following HTML tags:
-    - div
-    - section
-    - header
-    - h1 - h6
-    - nav
-    - ul
-    - li
-    - a
-    - img
-    - b
-    - em
-    - s
-    - small
-    - span
-    - strong
-    - sub
-    - sup
-    - form
-    - label
-    - select
-    - option
-    - input
-    - button
-- Provides `link`, `image`, and `item` convenience methods for succinct ways to build commonly used
-  menu elements.
-
-## Requirements
-
-1. [Ruby 2.6.x](https://www.ruby-lang.org).
-1. [Ruby on Rails 5.x.x](http://rubyonrails.org).
-
-## Setup
-
-Type the following to install:
-
-    gem install navigator
-
-Add the following to your Gemfile:
-
-    gem "navigator"
-
-## Usage
-
-The following are examples using the navigation view helper:
-
-### Unordered List (simple)
-
-Code:
-
-    navigation do
-      item "Dashboard", "/dashboard"
-      item "News", "/posts"
-    end
-
-Result:
-
-    <ul>
-      <li><a href="/dashboard">Dashboard</a></li>
-      <li><a href="/posts">Posts</a></li>
-    </ul>
-
-### Unordered List (with attributes)
-
-Code:
-
-    navigation "ul", attributes: {class: "nav"} do
-      item "Dashboard", "/dashboard", item_attributes: {class: "active"}
-      item "News", "/posts"
-    end
-
-Result:
-
-    <ul class="nav">
-      <li class="active"><a href="/dashboard">Dashboard</a></li>
-      <li><a href="/posts">Posts</a></li>
-    </ul>
-
-### Unordered List (with multiple data attributes)
-
-Code:
-
-    navigation do
-      item "Home", "/home", item_attributes: {data: {id: 1, type: "public"}}
-    end
-
-Result:
-
-    <ul>
-      <li data-id="1" data-type="public"><a href="/home">Home</a></li>
-    </ul>
-
-*TIP: Nested data-- attributes can be applied to any menu item in the same manner as Rails view
-helpers.*
-
-### Nav (with links)
-
-Code:
-
-    navigation "nav" do
-      a "Dashboard", attributes: {href: "/dashboard"}
-      a "News", attributes: {href: "/posts"}
-    end
-
-Result:
-
-    <nav>
-      <a href="/dashboard">Dashboard</a>
-      <a href="/posts">Posts</a>
-    </nav>
-
-### Foundation Menu
-
-Code:
-
-    navigation "nav", attributes: {class: "top-bar", "data-topbar" => nil} do
-      ul attributes: {class: "title-area"} do
-        li attributes: {class: "name"} do
-          h1 do
-            a "Demo", attributes: {href: "/home"}
-          end
-        end
-      end
-
-      section attributes: {class: "top-bar-section"} do
-        ul attributes: {class: "left"} do
-          item "Home", "/"
-          item "About", "/about"
-        end
-
-        ul attributes: {class: "right"} do
-          item "v1.0.0", '#'
-        end
-
-        ul attributes: {class: "right"} do
-          item "Login", "/login", link_attributes: {class: "button tiny round"}
-        end
-      end
-    end
-
-Result:
-
-    <nav class="top-bar" data-topbar="">
-      <ul class="title-area">
-        <li class="name">
-          <h1><a href="/" class="active">Demo</a></h1>
-        </li>
-      </ul>
-
-      <section class="top-bar-section">
-        <ul class="left">
-          <li class="active"><a href="/">Home</a></li>
-          <li><a href="/about">About</a></li>
-        </ul>
-
-        <ul class="right">
-          <li><a href="#">v1.0.0</a></li>
-        </ul>
-
-        <ul class="right">
-          <li><a class="button tiny round" href="/login">Login</a></li>
-        </ul>
-      </section>
-    </nav>
-
-### Bootstrap Dropdown
-
-Code:
-
-    navigation "nav" do
-      item "Dashboard", admin_dashboard_path
-      li attributes: {class: "dropdown"} do
-        a "Manage", attributes: {href: "#", class: "dropdown-toggle", "data-toggle" => "dropdown"} do
-          b attributes: {class: "caret"}
-        end
-        ul attributes: {class: "dropdown-menu"} do
-          item "Dashboard", admin_dashboard_path
-          item "Users", admin_users_path
-        end
-      end
-    end
-
-Result:
-
-    <ul class="nav">
-      <li><a href="/admin/dashboard">Dashboard</a></li>
-      <li class="dropdown">
-        <a data-toggle="dropdown" class="dropdown-toggle" href="#">
-          Manage
-          <b class="caret"></b>
-        </a>
-        <ul class="dropdown-menu">
-          <li><a href="/admin/dashboard">Dashboard</a></li>
-          <li><a href="/admin/users">Users</a></li>
-        </ul>
-      </li>
-    </ul>
-
-### Menu Helpers
-
-There are several convenience methods, in addition to the standard HTML tags, that can make for
-shorter lines of code. The following describes each:
-
-When building links, the default is:
-
-      navigation "nav", activator: activator do
-        a "Home", attributes: {href: home_path}
-      end
-
-...but can be written as:
-
-      navigation "nav", activator: activator do
-        link "Home", home_path
-      end
-
-When building images, the default is:
-
-      navigation "nav", activator: activator do
-        img attributes: {src: "https://placehold.it/50x50", alt: "Example"}
-      end
-
-...but can be written as:
-
-      navigation "nav", activator: activator do
-        image "https://placehold.it/50x50", "Example"
-      end
-
-When building menu items, the default is:
-
-      navigation "nav", activator: activator do
-        li do
-          a "Home", attributes: {href: home_path}
-        end
-      end
-
-...but can be written as:
-
-      navigation "nav", activator: activator do
-        item "Home", "/dashboard"
-      end
-
-These are just a few, simple, examples of what can be achieved. See the specs for additional usage
-and customization.
-
-## Customization
-
-The `navigation` view helper can accept an optional `Navigator::TagActivator` instance. Example:
-
-    # Code
-    activator = Navigator::TagActivator.new search_value: request.env["PATH_INFO"]
-
-    navigation "nav", activator: activator do
-      link "Home", home_path
-      link "About", about_path
-    end
-
-    <!-- Result -->
-    <nav>
-      <a href="/home" class="active">Home</a>
-      <a href="/about" class="active">About</a>
-    </nav>
-
-This is the default behavior for all navigation menus and is how menu items automaticaly get the
-"active" class when the item URL (in this case "/home") matches the `request.env[“PATH_INFO"]` to
-indicate current page/active tab.
-
-`Navigator::TagActivator` instances can be configured as follows:
-
-- search_key = Optional. The HTML tag attribute to search for. Default: :href.
-- search_value = Required. The value to match against the search_key value in order to update the
-  value of the target_key. Default: nil.
-- target_key = Optional. The HTML tag attribute key value to update when the search_value and
-  search_key value match. Default: :class.
-- target_value = Optional. The value to be applied to the target_key value. If no value exists, then
-  the value is added. Otherwise, if a value exists then the value is appended to the existing value.
-  Default: "active".
-
-This customization allows for more sophisticated detection/updating of active HTML tags. For
-example, the example code (above) could be rewritten to use `data-*` attributes and customized
-styles as follows:
-
-    # Code
-    activator = Navigator::TagActivator.new search_key: "data-id",
-                                            search_value: "123",
-                                            target_key: "data-style"
-                                            target_value: "current"
-
-    navigation "nav", activator: activator do
-      link "Home", home_path, attributes: {data: {id: "123", data-style="info"}}
-      link "About", about_path attributes: {data: {id: "789"}}
-    end
-
-    <!-- Result -->
-    <nav>
-      <a href="/home" data-id="123" data-style="info current">Home</a>
-      <a href="/about" data-id="789">About</a>
-    </nav>
-
-Lastly, the search value can be a *regular expression* to make things easier when dealing with
-complicated routes, sub- menus, etc. Example:
-
-      # Code
-      profile_activator = Navigator::TagActivator.new search_value: /^profile.+/
-
-      navigation do
-        item "Dashboard", dashboard_path
-        li activator: profile_activator do
-          link "Profile", '#'
-
-          ul do
-            item "Addresses", profile_addresses_path
-            item "Emails", profile_emails_path
-          end
-        end
-      end
-
-      <!-- Result -->
-      <ul>
-        <li><a href="/dashboard">Dashboard</a></li>
-        <li class="active">
-          <a href="#">Profile</a>
-          <ul>
-            <li><a href="profile/addresses">Addresses</a></li>
-            <li><a href="profile/emails">Emails</a></li>
-          </ul>
-        </li>
-      </ul>
-
-Assuming either the `Addresses` or `Emails` menu item was clicked, the `Profile` menu item would be
-active due to the regular expression (i.e. `/^profile.+/`) matching one of the the `profile/*`
-paths.
-
-## Tests
-
-To test, run:
-
-    bundle exec rake
-
-To test the dummy application, run:
-
-    cd spec/dummy
-    bin/rails server
-
-## Versioning
-
-Read [Semantic Versioning](https://semver.org) for details. Briefly, it means:
-
-- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
-- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
-- Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
-
-## Code of Conduct
-
-Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By
-participating in this project you agree to abide by its terms.
-
-## Contributions
-
-Read [CONTRIBUTING](CONTRIBUTING.md) for details.
-
-## License
-
-Copyright 2012 [Alchemists](https://www.alchemists.io).
-Read [LICENSE](LICENSE.md) for details.
-
-## History
-
-Read [CHANGES](CHANGES.md) for details.
-Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).
-
-## Credits
-
-Developed by [Brooke Kuhlmann](https://www.alchemists.io) at
-[Alchemists](https://www.alchemists.io).