navbar_highlighter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e600823e9f39cd89f4c1b3521a1179806502a061
+  data.tar.gz: 2ffada4a0eeef512a2985d0142ff35f8bc75fb69
+SHA512:
+  metadata.gz: 6c88f2bb7a843565f2967ea8ed0405a030a8b4a97c64948a1ed8994aef60b95a9b1b40397d2dc64f16375c53364b066a3c75941917e686a18c02be6ba84f26ba
+  data.tar.gz: 70b58e14979ff058d17b20d4e2da7f4c2e5c499285654cd869e3ce07c3caf63e86a89be9fd6299df52985e0b04819772abbaf755657e02d201680d9c71c6c5b0

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at abhishek.kanojia@vinsol.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in navbar_highlighter.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    navbar_highlighter (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  navbar_highlighter!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Abhishek Kanojia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# Navbar-Highlighter
+
+Navbar highlighter provides an easier way to activate link based on controller and action used by rails.
+
+**Usecase:**  You want to activate certain links when user is hits `static` controller's `index` action. you just need to add `data-controller='controller_name'` and `data-action='action_name'` in order to add specified class to it when user hits this controller's action.
+
+## Usage
+
+Add `navbar_highlighter` to Gemfile and `bundle install`
+```ruby
+gem 'navbar_highlighter'
+```
+
+Add the following to your `app/assets/javascripts/application.js`:
+
+    //= require navbar_highlighter
+
+Now, Initialize navbar highlighter using following code, this can be done in a separate js file. for example: `navbar_highlighter_init.js`
+
+If you are doing so, don't forget to add it to `asset.rb` like so:
+    `Rails.application.config.assets.precompile += %w( navbar_highlighter_init.js )`
+
+
+    (function(){
+      var data = {
+        // navbar you want to use.
+        navBar: $('[data-navbar=highlight]'),
+
+        // navbar links class selector
+        linkSelectorClass: 'primary-link',
+
+        // name of the class you want to add to activate a link
+        classNameToAdd: 'active-link'
+      },
+
+      linkHighlighter = new NavbarHighlighter(data);
+      linkHighlighter.init();
+
+    })();
+
+#### 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>
+
+**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.
+## 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "navbar_highlighter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/navbar_highlighter.rb

@@ -0,0 +1,8 @@
+require "navbar_highlighter/version"
+require 'navbar_highlighter/helper' if defined? ActionView
+
+module NavbarHighlighter
+  module Rails
+    require "navbar_highlighter/engine"
+  end
+end

data/lib/navbar_highlighter/engine.rb

@@ -0,0 +1,6 @@
+module NavbarHighlighter
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/navbar_highlighter/helper.rb

@@ -0,0 +1,10 @@
+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}' >")
+    end.html_safe
+  end
+end
+
+ActionView::Base.send :include, Helper

data/lib/navbar_highlighter/version.rb

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

data/navbar_highlighter.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "navbar_highlighter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "navbar_highlighter"
+  spec.version       = NavbarHighlighter::VERSION
+  spec.authors       = ["Abhishek Kanojia"]
+  spec.email         = ["abhishek.kanojia3193@gmail.com"]
+
+  spec.summary       = %q{This gem provides an easy way to change navbar links based on controller and action in ruby on rails.}
+  spec.description   = %q{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. }
+  spec.homepage      = "https://github.com/abhikanojia/navbar_highlighter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  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

@@ -0,0 +1,32 @@
+function NavbarHighlighter(data) {
+  this.linkSelectorClass = data.linkSelectorClass;
+  this.navBar = data.navBar;
+  this.classNameToAdd = data.classNameToAdd;
+  this.actionName = $('meta[name=action]').attr('content');
+  this.controllerName = $('meta[name=controller]').attr('content');
+}
+
+NavbarHighlighter.prototype.getControllerSelector = function() {
+  return '[data-controller=' + this.controllerName + ']';
+};
+
+NavbarHighlighter.prototype.getActionSelector = function() {
+  return '[data-action=' + this.actionName + ']';
+};
+
+NavbarHighlighter.prototype.classSelector = function(className) {
+  return '.' + className;
+};
+
+NavbarHighlighter.prototype.init = function() {
+
+  this.navBar.find(
+    this.classSelector(this.linkSelectorClass)
+  ).removeClass(this.classNameToAdd);
+
+  this.navBar.find(
+    $(this.getControllerSelector() + this.getActionSelector())
+  ).addClass(this.classNameToAdd);
+
+};
+

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: navbar_highlighter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Abhishek Kanojia
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-06 00:00:00.000000000 Z
+dependencies:
+- !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: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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. '
+email:
+- abhishek.kanojia3193@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/navbar_highlighter.rb
+- lib/navbar_highlighter/engine.rb
+- lib/navbar_highlighter/helper.rb
+- lib/navbar_highlighter/version.rb
+- navbar_highlighter.gemspec
+- vendor/assets/javascripts/navbar_highlighter.js
+homepage: https://github.com/abhikanojia/navbar_highlighter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: This gem provides an easy way to change navbar links based on controller
+  and action in ruby on rails.
+test_files: []