navigator 5.0.0 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dab0eb7d2e4617c732442bd2f4c2eaa415c27937695986fb29a039e1a15cc5fa
-  data.tar.gz: d0961b802f500a2d42bb56581c167521a875f28e18b1d40e6779481de2d74723
+  metadata.gz: d6d51966858f7e4d95ea10f0ae9f94010b23c7f7f980d89caa717862acb9ff7c
+  data.tar.gz: d1bb4c5514d1cdc6a56f15ed3a705d0e4ab8417519f5aebd7e11656213b84c35
 SHA512:
-  metadata.gz: b50a6d57c7786456eb72202d59ff0eaaa2148aa6c27cdf627598f96b090d742e31dfc9804bb61f767c59b637647d9e816c7dabebba690df71cf156aec879a238
-  data.tar.gz: 28ae9627d9cfe4f257a5ceeaa00395fa51f449038952db0c5cd3dff254140aef3f8788622550bc49b06cb7de4db632040ca0358e48ab0a7341d9e7645ad83011
+  metadata.gz: 63f0fb171e36398ac79b7c6a1a783285a804f2f90d43c1a33f026f4a7ad528e4703e7debd92068d5ee01f78dba1625917c8745d422699852b69ea9e48abcad63
+  data.tar.gz: 486778d7294780c7c823163bcf3a47d45e2c826cfe9905b933575f13c87e67ca7dd18ca34ea5777c6fdbc494afb561258e040def7eb5b58f47f484b6d03c9ad3

data/{LICENSE.md → LICENSE.adoc}

@@ -1,4 +1,4 @@
-# Apache License
+= Apache License
 
 Version 2.0, January 2004
 
@@ -6,7 +6,7 @@ http://www.apache.org/licenses
 
 TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-## 1. Definitions
+== 1. Definitions
 
 "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by
 Sections 1 through 9 of this document.
@@ -54,14 +54,14 @@ Contribution."
 "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a
 Contribution has been received by Licensor and subsequently incorporated within the Work.
 
-## 2. Grant of Copyright License
+== 2. Grant of Copyright License
 
 Subject to the terms and conditions of this License, each Contributor hereby grants to You a
 perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to
 reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and
 distribute the Work and such Derivative Works in Source or Object form.
 
-## 3. Grant of Patent License
+== 3. Grant of Patent License
 
 Subject to the terms and conditions of this License, each Contributor hereby grants to You a
 perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
@@ -74,39 +74,38 @@ a Contribution incorporated within the Work constitutes direct or contributory p
 then any patent licenses granted to You under this License for that Work shall terminate as of the
 date such litigation is filed.
 
-## 4. Redistribution
+== 4. Redistribution
 
 You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with
 or without modifications, and in Source or Object form, provided that You meet the following
 conditions:
 
-1. You must give any other recipients of the Work or Derivative Works a copy of this License; and
+. You must give any other recipients of the Work or Derivative Works a copy of this License; and
 
-2. You must cause any modified files to carry prominent notices stating that You changed the
-   files; and
+. You must cause any modified files to carry prominent notices stating that You changed the files;
+  and
 
-3. You must retain, in the Source form of any Derivative Works that You distribute, all copyright,
-   patent, trademark, and attribution notices from the Source form of the Work, excluding those
-   notices that do not pertain to any part of the Derivative Works; and
+. You must retain, in the Source form of any Derivative Works that You distribute, all copyright,
+  patent, trademark, and attribution notices from the Source form of the Work, excluding those
+  notices that do not pertain to any part of the Derivative Works; and
 
-4. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative
-   Works that You distribute must include a readable copy of the attribution notices contained
-   within such NOTICE file, excluding those notices that do not pertain to any part of the
-   Derivative Works, in at least one of the following places: within a NOTICE text file
-   distributed as part of the Derivative Works; within the Source form or documentation, if
-   provided along with the Derivative Works; or, within a display generated by the Derivative
-   Works, if and wherever such third-party notices normally appear. The contents of the NOTICE
-   file are for informational purposes only and do not modify the License. You may add Your own
-   attribution notices within Derivative Works that You distribute, alongside or as an addendum to
-   the NOTICE text from the Work, provided that such additional attribution notices cannot be
-   construed as modifying the License.
+. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works
+  that You distribute must include a readable copy of the attribution notices contained within such
+  NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in
+  at least one of the following places: within a NOTICE text file distributed as part of the
+  Derivative Works; within the Source form or documentation, if provided along with the Derivative
+  Works; or, within a display generated by the Derivative Works, if and wherever such third-party
+  notices normally appear. The contents of the NOTICE file are for informational purposes only and
+  do not modify the License. You may add Your own attribution notices within Derivative Works that
+  You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such
+  additional attribution notices cannot be construed as modifying the License.
 
 You may add Your own copyright statement to Your modifications and may provide additional or
 different license terms and conditions for use, reproduction, or distribution of Your modifications,
 or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of
 the Work otherwise complies with the conditions stated in this License.
 
-## 5. Submission of Contributions
+== 5. Submission of Contributions
 
 Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the
 Work by You to the Licensor shall be under the terms and conditions of this License, without any
@@ -114,13 +113,13 @@ additional terms or conditions. Notwithstanding the above, nothing herein shall
 the terms of any separate license agreement you may have executed with Licensor regarding such
 Contributions.
 
-## 6. Trademarks
+== 6. Trademarks
 
 This License does not grant permission to use the trade names, trademarks, service marks, or product
 names of the Licensor, except as required for reasonable and customary use in describing the origin
 of the Work and reproducing the content of the NOTICE file.
 
-## 7. Disclaimer of Warranty
+== 7. Disclaimer of Warranty
 
 Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each
 Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -129,7 +128,7 @@ TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. Y
 responsible for determining the appropriateness of using or redistributing the Work and assume any
 risks associated with Your exercise of permissions under this License.
 
-## 8. Limitation of Liability
+== 8. Limitation of Liability
 
 In no event and under no legal theory, whether in tort (including negligence), contract, or
 otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or
@@ -139,7 +138,7 @@ License or out of the use or inability to use the Work (including but not limite
 loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial
 damages or losses), even if such Contributor has been advised of the possibility of such damages.
 
-## 9. Accepting Warranty or Additional Liability
+== 9. Accepting Warranty or Additional Liability
 
 While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee
 for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights
@@ -151,11 +150,11 @@ additional liability.
 
 END OF TERMS AND CONDITIONS
 
-Copyright 2012 [Alchemists](https://www.alchemists.io).
+Copyright 2012 link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].
 
 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](http://www.apache.org/licenses/LICENSE-2.0) of
-the License.
+compliance with the License. You may obtain a link:https://www.apache.org/licenses/LICENSE-2.0[copy]
+of the License.
 
 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

data/README.adoc

@@ -0,0 +1,498 @@
+:toc: macro
+:toclevels: 5
+:figure-caption!:
+
+= Navigator
+
+[link=http://badge.fury.io/rb/navigator]
+image::https://badge.fury.io/rb/navigator.svg[Gem Version]
+[link=https://www.alchemists.io/projects/code_quality]
+image::https://img.shields.io/badge/code_style-alchemists-brightgreen.svg[Alchemists Style Guide]
+[link=https://circleci.com/gh/bkuhlmann/navigator]
+image::https://circleci.com/gh/bkuhlmann/navigator.svg?style=svg[Circle CI Status]
+
+Enhances Rails with a DSL for menu navigation.
+
+toc::[]
+
+== 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
+
+. link:https://www.ruby-lang.org[Ruby]
+. link:https://rubyonrails.org[Ruby on Rails]
+
+== Setup
+
+To install, run:
+
+....
+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:
+
+[source,ruby]
+----
+navigation do
+  item "Dashboard", "/dashboard"
+  item "News", "/posts"
+end
+----
+
+Result:
+
+[source,html]
+----
+<ul>
+  <li><a href="/dashboard">Dashboard</a></li>
+  <li><a href="/posts">Posts</a></li>
+</ul>
+----
+
+=== Unordered List (with attributes)
+
+Code:
+
+[source,ruby]
+----
+navigation "ul", attributes: {class: "nav"} do
+  item "Dashboard", "/dashboard", item_attributes: {class: "active"}
+  item "News", "/posts"
+end
+----
+
+Result:
+
+[source,html]
+----
+<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:
+
+[source,ruby]
+----
+navigation do
+  item "Home", "/home", item_attributes: {data: {id: 1, type: "public"}}
+end
+----
+
+Result:
+
+[source,html]
+----
+<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:
+
+[source,ruby]
+----
+navigation "nav" do
+  a "Dashboard", attributes: {href: "/dashboard"}
+  a "News", attributes: {href: "/posts"}
+end
+----
+
+Result:
+
+[source,html]
+----
+<nav>
+  <a href="/dashboard">Dashboard</a>
+  <a href="/posts">Posts</a>
+</nav>
+----
+
+=== Foundation Menu
+
+Code:
+
+[source,ruby]
+----
+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:
+
+[source,html]
+----
+<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:
+
+[source,ruby]
+----
+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:
+
+[source,html]
+----
+<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:
+
+[source,ruby]
+----
+navigation "nav", activator: activator do
+  a "Home", attributes: {href: home_path}
+end
+----
+
+...but can be written as:
+
+[source,ruby]
+----
+navigation "nav", activator: activator do
+  link "Home", home_path
+end
+----
+
+When building images, the default is:
+
+[source,ruby]
+----
+navigation "nav", activator: activator do
+  img attributes: {src: "https://placehold.it/50x50", alt: "Example"}
+end
+----
+
+..but can be written as:
+
+[source,ruby]
+----
+navigation "nav", activator: activator do
+  image "https://placehold.it/50x50", "Example"
+end
+----
+
+When building menu items, the default is:
+
+[source,ruby]
+----
+navigation "nav", activator: activator do
+  li do
+    a "Home", attributes: {href: home_path}
+  end
+end
+----
+
+...but can be written as:
+
+[source,ruby]
+----
+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.
+
+Code:
+
+[source,ruby]
+----
+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:
+
+[source,html]
+----
+<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.
+
+Code:
+
+[source,ruby]
+----
+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:
+
+[source,html]
+----
+<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.
+
+Code:
+
+[source,ruby]
+----
+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:
+
+[source,html]
+----
+<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.
+
+== Development
+
+To contribute, run:
+
+....
+git clone https://github.com/bkuhlmann/navigator.git
+cd navigator
+bin/setup
+....
+
+You can also use the IRB console for direct access to all objects:
+
+....
+bin/console
+....
+
+== Tests
+
+To test, run:
+
+[source,bash]
+----
+bundle exec rake
+----
+
+To test the dummy application, run:
+
+[source,bash]
+----
+cd spec/dummy
+bin/rails server
+----
+
+== Versioning
+
+Read link:https://semver.org[Semantic Versioning] 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 link:CODE_OF_CONDUCT.adoc[CODE OF CONDUCT]. By
+participating in this project you agree to abide by its terms.
+
+== Contributions
+
+Read link:CONTRIBUTING.adoc[CONTRIBUTING] for details.
+
+== License
+
+Read link:LICENSE.adoc[LICENSE] for details.
+
+== History
+
+Read link:CHANGES.adoc[CHANGES] for details.
+
+== Credits
+
+Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].