navigator 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e15bc2992a60c176f1fcd90f9318ba639cc5fb5
-  data.tar.gz: 48f85d17d275ab7e5a6911035d291425cbc298ad
+  metadata.gz: 901fe36b917fe74821492def2f73fdd4719be8cb
+  data.tar.gz: 00ad7dc0af942727f310e22cfc79a7275c228c53
 SHA512:
-  metadata.gz: 697896b1c032cd7e6f00373a5b1932e04a524ca4c7dd863d2bab03f0e6d15d1d801108c87c5e166ea443993b451d49bae8aa34894e6db9928dcd1d27286c09b0
-  data.tar.gz: cfe21d282623c79f2316444512945a4fc48445cf5ead30884944e462763ac777d302433e32218dd04dd8455116a46caac7424b1544f9b6131329654140472339
+  metadata.gz: cdd19345525e161d78c063a0d12ffb090365381ca1982b6e007596d683697f64d195f1461570d59739b8d38ad59a2c8f4932cbf601ff4c26848225dace13108a
+  data.tar.gz: 08b0b6426e00689a7479c0ca29ffbb0b01f0134134b1acae72be1a38e68f0ca8daae9a272fb6dc7eb49324f16e234789edcdeb6bec8555dee79263ad6e9ed067

data/README.md

@@ -1,14 +1,40 @@
-# Overview
+# Navigator
 
-[![Gem Version](https://badge.fury.io/rb/navigator.png)](http://badge.fury.io/rb/navigator)
-[![Code Climate GPA](https://codeclimate.com/github/bkuhlmann/navigator.png)](https://codeclimate.com/github/bkuhlmann/navigator)
-[![Code Climate Coverage](https://codeclimate.com/github/bkuhlmann/navigator/coverage.png)](https://codeclimate.com/github/bkuhlmann/navigator)
-[![Gemnasium Status](https://gemnasium.com/bkuhlmann/navigator.png)](https://gemnasium.com/bkuhlmann/navigator)
-[![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/navigator.png)](http://travis-ci.org/bkuhlmann/navigator)
-[![Gittip](http://img.shields.io/gittip/bkuhlmann.svg)](https://www.gittip.com/bkuhlmann)
+[![Gem Version](https://badge.fury.io/rb/navigator.svg)](http://badge.fury.io/rb/navigator)
+[![Code Climate GPA](https://codeclimate.com/github/bkuhlmann/navigator.svg)](https://codeclimate.com/github/bkuhlmann/navigator)
+[![Code Climate Coverage](https://codeclimate.com/github/bkuhlmann/navigator/coverage.svg)](https://codeclimate.com/github/bkuhlmann/navigator)
+[![Gemnasium Status](https://gemnasium.com/bkuhlmann/navigator.svg)](https://gemnasium.com/bkuhlmann/navigator)
+[![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/navigator.svg)](https://travis-ci.org/bkuhlmann/navigator)
+[![Patreon](https://img.shields.io/badge/patreon-donate-brightgreen.svg)](https://www.patreon.com/bkuhlmann)
 
 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.
@@ -42,7 +68,7 @@ Enhances Rails with a DSL for menu navigation.
 
 # Requirements
 
-0. [MRI 2.x.x](http://www.ruby-lang.org).
+0. [MRI 2.x.x](https://www.ruby-lang.org).
 0. [Ruby on Rails 4.1.x](http://rubyonrails.org).
 
 # Setup
@@ -238,13 +264,13 @@ When building links, the default is:
 When building images, the default is:
 
       navigation "nav", activator: activator do
-        img attributes: {src: "http://placehold.it/50x50", alt: "Example"}
+        img attributes: {src: "https://placehold.it/50x50", alt: "Example"}
       end
 
 ...but can be written as:
 
       navigation "nav", activator: activator do
-        image "http://placehold.it/50x50", "Example"
+        image "https://placehold.it/50x50", "Example"
       end
 
 When building menu items, the default is:
@@ -351,7 +377,7 @@ regular expression (i.e. `/^profile.+/`) matching one of the the `profile/*` pat
 
 To test, run:
 
-    bundle exec rspec spec
+    bundle exec rake
 
 To test the dummy application, run:
 

data/app/helpers/navigator/navigation_helper.rb

@@ -1,4 +1,5 @@
 module Navigator
+  # Navigation helper methods for the view layer.
   module NavigationHelper
     def navigation tag = "ul", attributes: {}, activator: navigation_activator, &block
       raw Navigator::Menu.new(self, tag: tag, attributes: attributes, activator: activator, &block).render

data/lib/navigator/engine.rb

@@ -1,8 +1,9 @@
 module Navigator
+  # The main engine.
   class Engine < ::Rails::Engine
     isolate_namespace Navigator
 
-    initializer "navigator.action_controller" do |app|
+    initializer "navigator.action_controller" do
       ActiveSupport.on_load :action_controller do
         helper Navigator::Engine.helpers
       end

data/lib/navigator/identity.rb

@@ -1,4 +1,5 @@
 module Navigator
+  # Gem identity information.
   module Identity
     def self.name
       "navigator"
@@ -9,11 +10,11 @@ module Navigator
     end
 
     def self.version
-      "1.3.0"
+      "1.4.0"
     end
 
     def self.label_version
-      [label, version].join " "
+      "#{label} #{version}"
     end
   end
 end

data/lib/navigator/menu.rb

@@ -2,7 +2,7 @@ module Navigator
   # Renders a HTML menu.
   class Menu
     def self.allowed_methods
-      %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)$)
+      /^(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
@@ -15,14 +15,12 @@ module Navigator
 
     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
-        instance_eval(&block)
-        items << tag.suffix
-      else
-        items << tag.render
-      end
+      return items << tag.render unless block_given?
+
+      items << tag.prefix
+      items << tag.content
+      instance_eval(&block)
+      items << tag.suffix
     end
 
     def link content = nil, url, attributes: {}, activator: menu_activator, &block
@@ -58,7 +56,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 * ""
     end
 
     private
@@ -71,7 +69,7 @@ module Navigator
 
     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 * ' '
+      attributes[activator.target_key] = [attributes[activator.target_key], activator.target_value].compact * " "
     end
   end
 end

data/lib/navigator/tag.rb

@@ -15,7 +15,7 @@ module Navigator
     end
 
     def prefix
-      ["<#{name}", format_attributes, '>'].compact * ''
+      ["<#{name}", format_attributes, ">"].compact * ""
     end
 
     def computed_content
@@ -27,7 +27,7 @@ module Navigator
     end
 
     def render
-      [prefix, computed_content, suffix].compact * ''
+      [prefix, computed_content, suffix].compact * ""
     end
 
     private
@@ -35,13 +35,12 @@ module Navigator
     attr_reader :attributes, :activator
 
     def expand_data_attributes! attrs
-      if attrs.key? :data
-        attrs.delete(:data).each { |key, value| attrs["data-#{key}"] = value }
-      end
+      return unless attrs.key? :data
+      attrs.delete(:data).each { |key, value| attrs["data-#{key}"] = value }
     end
 
     def concatenate_attributes attrs
-      activator.activate(attrs).map { |key, value| %(#{key}="#{value}") } * ' '
+      activator.activate(attrs).map { |key, value| %(#{key}="#{value}") } * " "
     end
 
     def format_attributes

data/lib/navigator/tag_activator.rb

@@ -25,7 +25,7 @@ module Navigator
 
     def activate attributes = {}
       attributes = attributes.with_indifferent_access
-      attributes[target_key] = [attributes[target_key], target_value].compact.join(' ') if activatable? attributes
+      attributes[target_key] = [attributes[target_key], target_value].compact.join(" ") if activatable? attributes
       attributes
     end
   end

data/lib/tasks/rspec.rake

@@ -0,0 +1,6 @@
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError => error
+  puts error.message
+end

data/lib/tasks/rubocop.rake

@@ -0,0 +1,6 @@
+begin
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new
+rescue LoadError => error
+  puts error.message
+end

metadata

@@ -1,36 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: navigator
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
 autorequire: 
 bindir: bin
-cert_chain:
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDeDCCAmCgAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMQ8wDQYDVQQDDAZicm9v
-  a2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQBGRYC
-  aW8wHhcNMTUwNzA1MTQ1MzExWhcNMTYwNzA0MTQ1MzExWjBBMQ8wDQYDVQQDDAZi
-  cm9va2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQB
-  GRYCaW8wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCzhOVcvLGBCceM
-  PppVpJLUKsnskWzc1VqBXmv30feKNw+MOxMQaDsIP421qwqGO/2JHY60Kuobssk+
-  8/wqZkVFF/FFKxoQjuhlhc+VWLm8jWgXd4N1kwO2yytscQTzxc5qXarwA+36fqVH
-  RhBAHhjka+HdBI+6o3CXRHJoC47iav+QpR7u/wYl3gNq6MJO3MmTKqHegEDLjRN0
-  FJAr3bRAwq03ZtTuAVA2bdKLGThehe1RRRtJHJ/PHpmL2c203/GTXYtG6C8ILZIp
-  ZroTqQ8yglCJ+3hSOmodZqSAQ0Rj7GJgtuNH81qlSrHu5sTvoZjGmEqSIhvsSJ80
-  wKoPdZnFAgMBAAGjezB5MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
-  BBSUnF478a5lB4xuOBiktJdMJv6JmDAfBgNVHREEGDAWgRRicm9va2VAYWxjaGVt
-  aXN0cy5pbzAfBgNVHRIEGDAWgRRicm9va2VAYWxjaGVtaXN0cy5pbzANBgkqhkiG
-  9w0BAQUFAAOCAQEAT7KtBXWsq1KA7NOSMeFEDeSvhrgdLwCG/37pIu0rjvx9iAW4
-  gncxV0MccqIUtaF+lekjlXkIO+rXAVjvdha23KtpFTW90dYXp4NLPnPlSdyvYzJy
-  FIAaWGvujOT8xEu4umd45q5aepE8li4bR071i5Z7F0trKNVYYrxjQFmH5SSKYRT/
-  fXtICtAh1de3z3SOSK58IMPwjuoApYBxiqlmx0Uhla7mrzCE5+NmLPit3hLH6JFK
-  aSif+qBc6oHD7EQWPF5cZkzkIURuwNwPBngZGxIKaMAgRhjGFXzUMAaq++r59cS9
-  xTfQ4k6fglKEgpnLAXiKdo2c8Ym+X4rIKFfedQ==
-  -----END CERTIFICATE-----
-date: 2015-07-05 00:00:00.000000000 Z
+cert_chain: []
+date: 2015-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -60,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: gemsmith
+  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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -89,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-stack_explorer
+  name: pry-remote
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -103,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-remote
+  name: pry-state
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -130,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  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: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -214,6 +220,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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
@@ -228,8 +248,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Enhances Rails with a DSL for menu navigation complete with sub-menus,
-  nested tags, HTML attributes, etc.
+description: Enhances Rails with a DSL for menu navigation.
 email:
 - brooke@alchemists.io
 executables: []
@@ -247,6 +266,8 @@ files:
 - lib/navigator/menu.rb
 - lib/navigator/tag.rb
 - lib/navigator/tag_activator.rb
+- lib/tasks/rspec.rake
+- lib/tasks/rubocop.rake
 homepage: https://github.com/bkuhlmann/navigator
 licenses:
 - MIT
@@ -267,7 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
 summary: Enhances Rails with a DSL for menu navigation.