navbar_highlighter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e600823e9f39cd89f4c1b3521a1179806502a061
-  data.tar.gz: 2ffada4a0eeef512a2985d0142ff35f8bc75fb69
+  metadata.gz: 91314c4d4c2c928ad9d65908ab7ca568653c9d88
+  data.tar.gz: be88fb072e50d2cc366157ac7b66692a1b8c1a79
 SHA512:
-  metadata.gz: 6c88f2bb7a843565f2967ea8ed0405a030a8b4a97c64948a1ed8994aef60b95a9b1b40397d2dc64f16375c53364b066a3c75941917e686a18c02be6ba84f26ba
-  data.tar.gz: 70b58e14979ff058d17b20d4e2da7f4c2e5c499285654cd869e3ce07c3caf63e86a89be9fd6299df52985e0b04819772abbaf755657e02d201680d9c71c6c5b0
+  metadata.gz: 125abda44364b43824c682c03cdf53bd202b29c4ecc2de33940246760f8518d8eb9e07a9583071a61964aa6cb25f32eb4e9154ada7a7a8cd1d4709f2bf1b3d15
+  data.tar.gz: fb9f40317f0863d78878eba0bc05e6a80056f00ca2071395b4e369995212d58501b5d95b2ae1829c748cf3d3a3805714dcbaf1813f5168e6fdb7584777752344

data/README.md

@@ -1,4 +1,4 @@
-# Navbar-Highlighter
+ # Navbar-Highlighter
 
 Navbar highlighter provides an easier way to activate link based on controller and action used by rails.
 
@@ -37,16 +37,40 @@ If you are doing so, don't forget to add it to `asset.rb` like so:
       linkHighlighter.init();
 
     })();
+Add`<%= navbar_highlighter_tags %>` to any layout that you are using.
 
-#### Add `data-controller='controller-name'` and `data-action='action-name'` to the links you want to add class based on controller and action.
+---
+##### Add `data-controller='controller-name'` and `data-action='action-name'` to the links you want to add class based on controller and action.
+
+---
 
 #### Add `data-navbar='highlight'` to navbar just like below snippet:
 
-<script src="https://gist.github.com/abhikanojia/02583e5a383ef77fe5b5125a95421d6c.js"></script>
+
+    <nav data-navbar="highlight">
+      <ul class="primary-nav-list">
+        <li class="primary-menu">
+          <a href="/" class="primary-link" data-controller="sessions" data-action="index">
+            Home
+          </a>
+        </li>
+
+        <li class="primary-menu">
+          <a href="/users" class="primary-link" data-controller="users" data-action="index" data-parent='sessions'>
+          <!-- Adding data-parent='controller_name' will add active-link class to parent link i.e Home link in this case. -->
+          Users
+          </a>
+        </li>
+        <ul>
+    </nav>
+
 
 **Note:**
 
 As user hits `sessions_controller` `index` action `Home` link will be active, and when user clicks `Users` link `Users` link will be get `active-link` class.
+# New feature
+Adding a `data-parent='controller_name'` to link will add class to parent link as well as the child link.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/abhikanojia/navbar_highlighter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
@@ -58,3 +82,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the NavbarHighlighter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/abhikanojia/navbar_highlighter/blob/master/CODE_OF_CONDUCT.md).
+

data/lib/navbar_highlighter/helper.rb

@@ -1,8 +1,9 @@
 module Helper
   def navbar_highlighter_tags
     ''.tap do |str|
-      str.concat("<meta name='controller' content='#{controller_name}' >")
-      str.concat("<meta name='action' content='#{action_name}' >")
+      str.concat("<meta name='controller' content='#{controller_name}'>")
+      str.concat("\n")
+      str.concat("<meta name='action' content='#{action_name}'>")
     end.html_safe
   end
 end

data/lib/navbar_highlighter/version.rb

@@ -1,3 +1,3 @@
 module NavbarHighlighter
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/navbar_highlighter.gemspec

@@ -21,7 +21,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'jquery-rails', '~> 4.3'
+  spec.add_dependency 'rails', '~> 5.1.4'
+
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
 end

data/vendor/assets/javascripts/navbar_highlighter.js

@@ -6,8 +6,12 @@ function NavbarHighlighter(data) {
   this.controllerName = $('meta[name=controller]').attr('content');
 }
 
-NavbarHighlighter.prototype.getControllerSelector = function() {
-  return '[data-controller=' + this.controllerName + ']';
+NavbarHighlighter.prototype.getControllerSelector = function(selector) {
+  if(selector) {
+    return '[data-controller=' + selector + ']';
+  } else {
+    return '[data-controller=' + this.controllerName + ']';
+  }
 };
 
 NavbarHighlighter.prototype.getActionSelector = function() {
@@ -18,15 +22,26 @@ NavbarHighlighter.prototype.classSelector = function(className) {
   return '.' + className;
 };
 
+NavbarHighlighter.prototype.highlightParentIfExist = function(element) {
+  var dataParent = element.data('parent');
+  if(dataParent) {
+    $(this.getControllerSelector(dataParent)).addClass(this.classNameToAdd);
+  }
+};
+
 NavbarHighlighter.prototype.init = function() {
 
   this.navBar.find(
     this.classSelector(this.linkSelectorClass)
   ).removeClass(this.classNameToAdd);
 
-  this.navBar.find(
+  var element = this.navBar.find(
     $(this.getControllerSelector() + this.getActionSelector())
-  ).addClass(this.classNameToAdd);
+  );
+
+  element.addClass(this.classNameToAdd);
+
+  this.highlightParentIfExist(element);
 
 };
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: navbar_highlighter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Abhishek Kanojia
@@ -11,47 +11,61 @@ cert_chain: []
 date: 2018-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
+        version: '4.3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '4.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
 description: 'This gem provides an easy way to change navbar links based on controller
   and action in ruby on rails. Usecase: Can be used to activate certain link based
   on controller. '
@@ -62,7 +76,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rspec"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper