navigator 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a40ffa146eec750cb69650d516300c6aa7e77388
-  data.tar.gz: d3022dd4a03f044859b88d1f6fe47d1007faa2f7
+  metadata.gz: 074bdec84f357eca1409cc391a09c56e70d02d57
+  data.tar.gz: e055f6c5572472f7d057e172dbc27c8825a87e48
 SHA512:
-  metadata.gz: 50bf010f6da84cbb4da2cce6db6c5671f106a782b70e321a2e107654cd6533ceb2456d4a3db5708eea072c9592855d2b98ded0844df24c3de603214c33ec99cd
-  data.tar.gz: 085e7c6c6e4768d453206e8666af056d8e345b83934dc9c0dbebdc732e7978c92d935b5771ec3d5984dfc73e95b46b5a2dabb6a64cbe6e393af7772d4895001a
+  metadata.gz: 90dcd0846caf6e502ca898cfd7b9501aa1fd025c2db749ce0c5df370d307a01d0a48d459b02a1e9161c71e4114f930e491faea183ee04cd29ac4fc44046b627a
+  data.tar.gz: 4f0d277cd2e7f69f42ca2b903d7261c421406d7fe3034904965e8f4a0961adc162f2c1414956ceca92b33c851e1bfaf38584badc32f0deeb02707b4b6d0d5b3d

data/README.md

@@ -14,8 +14,31 @@ Enhances Rails with a DSL for menu navigation.
 - Provides a simple 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: nav, section, h1-h6, ul, li, a, b, em, s, small, span, strong, sub, and sup.
-- Provides an "item" convenience method which combines the "li" and "a" HTML tags into a single method for less typing.
+- 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
 
@@ -197,15 +220,61 @@ Result:
       </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: "http://placehold.it/50x50", alt: "Example"}
+      end
+
+...but can be written as:
+
+      navigation "nav", activator: activator do
+        image "http://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
-      a "Home", attributes: {href: home_path}
-      a "About", attributes: {href: about_path}
+      link "Home", home_path
+      link "About", about_path
     end
 
     <!-- Result -->
@@ -237,8 +306,8 @@ This customization allows for more sophisticated detection/updating of active HT
                                             target_value: "current"
 
     navigation "nav", activator: activator do
-      a "Home", attributes: {href: home_path, "data-id" => "123", data-style="info"}
-      a "About", attributes: {href: about_path, "data-id" => "789"}
+      link "Home", home_path, attributes: {data: {id: "123", data-style="info"}}
+      link "About", about_path attributes: {data: {id: "789"}}
     end
 
     <!-- Result -->
@@ -266,13 +335,14 @@ Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
 - Minor (x.Y.z) - Incremented for new, backwards compatible public API enhancements and/or bug fixes.
 - Major (X.y.z) - Incremented for any backwards incompatible public API changes.
 
-# Contributions
+# Code of Conduct
 
-Read [CONTRIBUTING](CONTRIBUTING.md) for details.
+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.
 
-# Credits
+# Contributions
 
-Developed by [Brooke Kuhlmann](https://www.alchemists.io) at [Alchemists](https://www.alchemists.io)
+Read [CONTRIBUTING](CONTRIBUTING.md) for details.
 
 # License
 
@@ -283,3 +353,7 @@ Read the [LICENSE](LICENSE.md) for details.
 
 Read the [CHANGELOG](CHANGELOG.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).

data/lib/navigator/menu.rb

@@ -2,7 +2,7 @@ module Navigator
   # Renders a HTML menu.
   class Menu
     def self.allowed_methods
-      %r(^(section|h[1-6]|ul|li|a|b|em|s|small|span|strong|sub|sup)$)
+      %r(^(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
 
     def initialize template, tag: "ul", attributes: {}, activator: Navigator::TagActivator.new, &block
@@ -25,15 +25,23 @@ module Navigator
       end
     end
 
-    def item content, url, item_attributes: {}, link_attributes: {}, activator: menu_activator
-      link_attributes.reverse_merge! href: url
+    def link content = nil, url, attributes: {}, activator: menu_activator, &block
+      add "a", content, attributes: attributes.merge(href: url), activator: activator, &block
+    end
 
-      if link_attributes[:href] == activator.search_value
-        item_attributes[activator.target_key] = activator.target_value
-      end
+    def image url, alt = nil, attributes: {}, activator: menu_activator
+      modified_attributes = attributes.merge src: url, alt: alt
+      modified_attributes = modified_attributes.delete_if { |_, value| !value.present? }
+
+      add "img", attributes: modified_attributes, activator: activator
+    end
 
-      add "li", attributes: item_attributes, activator: activator do
-        add "a", content, attributes: link_attributes, activator: Navigator::TagActivator.new
+    def item content = nil, url, item_attributes: {}, link_attributes: {}, activator: menu_activator, &block
+      modified_item_attributes = item_attributes.clone
+      activate_item_attributes! modified_item_attributes, url, activator
+
+      add "li", attributes: modified_item_attributes, activator: activator do
+        link content, url, attributes: link_attributes, activator: Navigator::TagActivator.new, &block
       end
     end
 
@@ -60,5 +68,10 @@ module Navigator
     def method_allowed? name
       self.class.allowed_methods === name
     end
+
+    def activate_item_attributes! attributes, url, activator
+      return unless url == activator.search_value
+      attributes[activator.target_key] = [attributes[activator.target_key], activator.target_value].compact * ' '
+    end
   end
 end

data/lib/navigator/tag.rb

@@ -3,8 +3,12 @@ module Navigator
   class Tag
     attr_reader :name, :content
 
+    def self.names_without_suffix
+      %w(img input)
+    end
+
     def initialize name, content = nil, attributes: {}, activator: Navigator::TagActivator.new
-      @name = name
+      @name = String(name)
       @content = content
       @attributes = attributes.with_indifferent_access
       @activator = activator
@@ -14,12 +18,16 @@ module Navigator
       ["<#{name}", format_attributes, '>'].compact * ''
     end
 
+    def computed_content
+      self.class.names_without_suffix.include?(name) ? nil : content
+    end
+
     def suffix
-      "</#{name}>"
+      self.class.names_without_suffix.include?(name) ? nil : "</#{name}>"
     end
 
     def render
-      [prefix, content, suffix].compact * ''
+      [prefix, computed_content, suffix].compact * ''
     end
 
     private

data/lib/navigator/version.rb

@@ -1,3 +1,3 @@
 module Navigator
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: navigator
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -30,7 +30,7 @@ cert_chain:
   fMlZDUGx3lQarp/vPjK+6XH7DLXjBEKqeIGBIpLthYUvDxJRp23C+T3liGSL32vg
   mSpxxwmK95GDFuEy2mNPaxnazdkw8c+7DbrSpzd/CnNZkRgitxOavs8=
   -----END CERTIFICATE-----
-date: 2015-01-01 00:00:00.000000000 Z
+date: 2015-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -267,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Enhances Rails with a DSL for menu navigation.