navigator 0.9.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60d384bf293eac22d1e2c5bf78a6ee60d12b356b
-  data.tar.gz: 74e8cd838420bbfedd50c67078e8104f9efca0d3
+  metadata.gz: a40ffa146eec750cb69650d516300c6aa7e77388
+  data.tar.gz: d3022dd4a03f044859b88d1f6fe47d1007faa2f7
 SHA512:
-  metadata.gz: 7e854521b42aa636730fa379ff2ee78c5c599ef500b594ec1354f7425cee5a29e043321779ffb8dbf024267b464faf3031b65e49c35246f891c9e270aded533e
-  data.tar.gz: 1bc325481997fcb750953197a9a1079ea2139bdfe4ab3ab9555237783dde4d4b407a83d5cc6bc6c111d77d65663ee01c5b8dfac8b418c7a469d21ec3aa06d3f3
+  metadata.gz: 50bf010f6da84cbb4da2cce6db6c5671f106a782b70e321a2e107654cd6533ceb2456d4a3db5708eea072c9592855d2b98ded0844df24c3de603214c33ec99cd
+  data.tar.gz: 085e7c6c6e4768d453206e8666af056d8e345b83934dc9c0dbebdc732e7978c92d935b5771ec3d5984dfc73e95b46b5a2dabb6a64cbe6e393af7772d4895001a

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2012 [Alchemists](http://www.alchemists.io).
+Copyright (c) 2012 [Alchemists](https://www.alchemists.io).
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -11,25 +11,24 @@ Enhances Rails with a DSL for menu navigation.
 
 # Features
 
-* 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.
+- 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.
 
 # Requirements
 
 0. Any of the following Ruby VMs:
-    * [MRI 2.x.x](http://www.ruby-lang.org)
-    * [JRuby 1.x.x](http://jruby.org)
-    * [Rubinius 2.x.x](http://rubini.us)
+    - [MRI 2.x.x](http://www.ruby-lang.org)
+    - [JRuby 1.x.x](http://jruby.org)
 0. [Ruby on Rails 4.1.x](http://rubyonrails.org).
 
 # Setup
 
 For a secure install, type the following from the command line (recommended):
 
-    gem cert --add <(curl -Ls http://www.alchemists.io/gem-public.pem)
+    gem cert --add <(curl -Ls https://www.alchemists.io/gem-public.pem)
     gem install navigator --trust-policy MediumSecurity
 
 NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification while
@@ -67,8 +66,8 @@ Result:
 
 Code:
 
-    navigation "ul", class: "nav" do
-      item "Dashboard", "/dashboard", class: "active"
+    navigation "ul", attributes: {class: "nav"} do
+      item "Dashboard", "/dashboard", item_attributes: {class: "active"}
       item "News", "/posts"
     end
 
@@ -84,7 +83,7 @@ Result:
 Code:
 
     navigation do
-      item "Home", "/home", data: {id: 1, type: "public"}
+      item "Home", "/home", item_attributes: {data: {id: 1, type: "public"}}
     end
 
 Result:
@@ -93,15 +92,15 @@ Result:
       <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.*
+*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", href: "/dashboard"
-      a "News", href: "/posts"
+      a "Dashboard", attributes: {href: "/dashboard"}
+      a "News", attributes: {href: "/posts"}
     end
 
 Result:
@@ -115,27 +114,27 @@ Result:
 
 Code:
 
-    navigation "nav", class: "top-bar", "data-topbar" => nil do
-      ul nil, class: "title-area" do
-        li nil, class: "name" do
+    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", href: "/home"
+            a "Demo", attributes: {href: "/home"}
           end
         end
       end
 
-      section nil, class: "top-bar-section" do
-        ul nil, class: "left" do
+      section attributes: {class: "top-bar-section"} do
+        ul attributes: {class: "left"} do
           item "Home", "/"
           item "About", "/about"
         end
 
-        ul nil, class: "right" do
+        ul attributes: {class: "right"} do
           item "v1.0.0", '#'
         end
 
-        ul nil, class: "right" do
-          item "Login", "/login", {}, {class: "button tiny round"}
+        ul attributes: {class: "right"} do
+          item "Login", "/login", link_attributes: {class: "button tiny round"}
         end
       end
     end
@@ -171,11 +170,11 @@ Code:
 
     navigation "nav" do
       item "Dashboard", admin_dashboard_path
-      li nil, class: "dropdown" do
-        a "Manage", href: "#", class: "dropdown-toggle", "data-toggle" => "dropdown" do
-          b nil, class: "caret"
+      li attributes: {class: "dropdown"} do
+        a "Manage", attributes: {href: "#", class: "dropdown-toggle", "data-toggle" => "dropdown"} do
+          b attributes: {class: "caret"}
         end
-        ul nil, class: "dropdown-menu" do
+        ul attributes: {class: "dropdown-menu"} do
           item "Dashboard", admin_dashboard_path
           item "Users", admin_users_path
         end
@@ -204,9 +203,9 @@ The `navigation` view helper can accept an optional `Navigator::TagActivator` in
 
     # Code
     activator = Navigator::TagActivator.new search_value: request.env["PATH_INFO"]
-    navigation "nav", {}, activator do
-      a "Home", href: home_path
-      a "About", href: about_path
+    navigation "nav", activator: activator do
+      a "Home", attributes: {href: home_path}
+      a "About", attributes: {href: about_path}
     end
 
     <!-- Result -->
@@ -220,13 +219,12 @@ item URL (in this case "/home") matches the `request.env[“PATH_INFO"]` to indi
 
 `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
+- 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.
+- 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
@@ -238,9 +236,9 @@ This customization allows for more sophisticated detection/updating of active HT
                                             target_key: "data-style"
                                             target_value: "current"
 
-    navigation "nav", {}, activator do
-      a "Home", href: home_path, "data-id" => "123", data-style="info"
-      a "About", href: about_path, "data-id" => "789"
+    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"}
     end
 
     <!-- Result -->
@@ -264,9 +262,9 @@ To test the dummy application, run:
 
 Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
 
-* Patch (x.y.Z) - Incremented for small, backwards compatible bug fixes.
-* 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.
+- Patch (x.y.Z) - Incremented for small, backwards compatible bug fixes.
+- 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
 
@@ -274,11 +272,11 @@ Read [CONTRIBUTING](CONTRIBUTING.md) for details.
 
 # Credits
 
-Developed by [Brooke Kuhlmann](http://www.alchemists.io) at [Alchemists](http://www.alchemists.io)
+Developed by [Brooke Kuhlmann](https://www.alchemists.io) at [Alchemists](https://www.alchemists.io)
 
 # License
 
-Copyright (c) 2012 [Alchemists](http://www.alchemists.io).
+Copyright (c) 2012 [Alchemists](https://www.alchemists.io).
 Read the [LICENSE](LICENSE.md) for details.
 
 # History

data/app/helpers/navigator/navigation_helper.rb

@@ -1,7 +1,7 @@
 module Navigator
   module NavigationHelper
-    def navigation tag = "ul", attributes = {}, activator = navigation_activator, &block
-      raw Navigator::Menu.new(self, tag, attributes, activator, &block).render
+    def navigation tag = "ul", attributes: {}, activator: navigation_activator, &block
+      raw Navigator::Menu.new(self, tag: tag, attributes: attributes, activator: activator, &block).render
     end
 
     module_function

data/lib/navigator/menu.rb

@@ -5,16 +5,16 @@ module Navigator
       %r(^(section|h[1-6]|ul|li|a|b|em|s|small|span|strong|sub|sup)$)
     end
 
-    def initialize template, tag = "ul", attributes = {}, menu_activator = Navigator::TagActivator.new, &block
+    def initialize template, tag: "ul", attributes: {}, activator: Navigator::TagActivator.new, &block
       @template = template
-      @tag = Navigator::Tag.new tag, nil, attributes, menu_activator
-      @menu_activator = menu_activator
+      @tag = Navigator::Tag.new tag, attributes: attributes, activator: activator
+      @menu_activator = activator
       @items = []
       instance_eval(&block) if block_given?
     end
 
-    def add name, content = nil, attributes = {}, activator = menu_activator, &block
-      tag = Navigator::Tag.new name, content, attributes, activator
+    def add name, content = nil, attributes: {}, activator: menu_activator, &block
+      tag = Navigator::Tag.new name, content, attributes: attributes, activator: activator
       if block_given?
         items << tag.prefix
         items << tag.content
@@ -25,15 +25,15 @@ module Navigator
       end
     end
 
-    def item content, url, item_attributes = {}, link_attributes = {}, activator = menu_activator
+    def item content, url, item_attributes: {}, link_attributes: {}, activator: menu_activator
       link_attributes.reverse_merge! href: url
 
       if link_attributes[:href] == activator.search_value
         item_attributes[activator.target_key] = activator.target_value
       end
 
-      add "li", nil, item_attributes, activator do
-        add "a", content, link_attributes, Navigator::TagActivator.new
+      add "li", attributes: item_attributes, activator: activator do
+        add "a", content, attributes: link_attributes, activator: Navigator::TagActivator.new
       end
     end
 
@@ -43,7 +43,7 @@ module Navigator
 
     def method_missing name, *args, &block
       if method_allowed?(name.to_s)
-        add(*args.unshift(name), &block)
+        add(name, *args, &block)
       else
         template.public_send name, *args
       end

data/lib/navigator/tag.rb

@@ -3,7 +3,7 @@ module Navigator
   class Tag
     attr_reader :name, :content
 
-    def initialize name, content = nil, attributes = {}, activator = Navigator::TagActivator.new
+    def initialize name, content = nil, attributes: {}, activator: Navigator::TagActivator.new
       @name = name
       @content = content
       @attributes = attributes.with_indifferent_access

data/lib/navigator/tag_activator.rb

@@ -1,27 +1,13 @@
 module Navigator
   # Conditionally activates a tag.
   class TagActivator
-    def initialize settings = {}
-      @settings = settings.with_indifferent_access.reverse_merge search_key: :href,
-                                                                 search_value: nil,
-                                                                 target_key: :class,
-                                                                 target_value: "active"
-    end
-
-    def search_key
-      settings.fetch :search_key
-    end
-
-    def search_value
-      settings.fetch :search_value
-    end
+    attr_reader :search_key, :search_value, :target_key, :target_value
 
-    def target_key
-      settings.fetch :target_key
-    end
-
-    def target_value
-      settings.fetch :target_value
+    def initialize search_key: :href, search_value: nil, target_key: :class, target_value: "active"
+      @search_key = search_key
+      @search_value = search_value
+      @target_key = target_key
+      @target_value = target_value
     end
 
     def activatable? attributes = {}
@@ -38,9 +24,5 @@ module Navigator
 
       attributes
     end
-
-    private
-
-    attr_reader :settings
   end
 end

data/lib/navigator/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: navigator
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -30,7 +30,7 @@ cert_chain:
   fMlZDUGx3lQarp/vPjK+6XH7DLXjBEKqeIGBIpLthYUvDxJRp23C+T3liGSL32vg
   mSpxxwmK95GDFuEy2mNPaxnazdkw8c+7DbrSpzd/CnNZkRgitxOavs8=
   -----END CERTIFICATE-----
-date: 2014-07-14 00:00:00.000000000 Z
+date: 2015-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -186,6 +186,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -202,7 +230,8 @@ dependencies:
         version: '0'
 description: Enhances Rails with a DSL for menu navigation complete with sub-menus,
   nested tags, HTML attributes, etc.
-email: brooke@redalchemist.com
+email:
+- brooke@alchemists.io
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -238,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Enhances Rails with a DSL for menu navigation.