nav_helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc636af0eafe2786f497ffe73111698409368252
+  data.tar.gz: c2b2f38b70c8272a6a7aaed53a9154b77b53528f
+SHA512:
+  metadata.gz: d6d761b6b78fbcc96dd89109be5058382abc406e7a1a8443919dc26e181b2855e0d8439bb90e437ca2831c064a6c6aa15d68a38e6c906e03bc98b242ae260694
+  data.tar.gz: 00d08c1bf7eafb3772fc64d9e17fee3a6cb5830de5d73b86e00a46bcb519a552027690a4d4c4aebe787291858f84c6f556e9b927fb2dff4209c3c8605b329ae1

data/.editorconfig

@@ -0,0 +1,11 @@
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

@@ -0,0 +1,7 @@
+/.bundle
+/Gemfile.lock
+/coverage
+/pkg/
+/tmp/
+*.gem
+/log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=doc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nav_helper.gemspec
+gemspec

data/README.md

@@ -0,0 +1,53 @@
+# NavHelper
+
+Helper for building nav links.
+
+By default, helper generates link, wrapped with `<li>` and sets class "active", if link path is path of the current page.
+```html
+<ul>
+  <%= nav_item('Home', '/') %>
+  <%= nav_item('Contacts', '/contacts') %>
+  <%= nav_item('About', '/about') %>
+</ul>
+```
+
+Also, you can customize wrapper tag and navigation root path:
+```html
+<div class="nav">
+  <%= nav_item('Posts', admin_posts_path, tag: :div, root: admin_path) %>
+  <%= nav_item('Users', admin_users_path, tag: :div, root: admin_path) %>
+</div>
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nav_helper'
+```
+
+## License
+
+Copyright (c) 2014 Okhlopkov Anatoly
+
+MIT License
+
+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/Rakefile

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

data/lib/nav_helper/version.rb

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

data/lib/nav_helper.rb

@@ -0,0 +1,33 @@
+require "nav_helper/version"
+
+module NavigationHelper
+  def current_path
+    request.path
+  end
+
+  def current_path?(path, root = '/')
+    if path == root
+      current_path == path
+    else
+      (/\A#{path}(\/.*)?\Z/ =~ current_path).present?
+    end
+  end
+
+  def nav_item(title, path = nil, options = nil, &blk)
+    path, options = title, path if block_given?
+
+    options ||= {}
+    options.reverse_merge!(tag: :li, root: nil)
+
+    tag = options.delete(:tag)
+    is_active = current_path?(path, options.delete(:root))
+
+    content_tag(tag, class: (:active if is_active)) do
+      if block_given?
+        link_to(path, options, &blk)
+      else
+        link_to(title, path, options)
+      end
+    end
+  end
+end

data/nav_helper.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nav_helper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nav_helper'
+  spec.version       = NavHelper::VERSION
+  spec.authors       = ['Okhlopkov Anatoly']
+  spec.email         = ['ohlopkov0211@gmail.com']
+  spec.summary       = 'Helper for building nav links.'
+  spec.description   = 'Helper for building nav links.'
+  spec.homepage      = 'https://github.com/VortexGrenade/nav_helper.git'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'rspec-rails'
+end

data/spec/helpers/nav_helper_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'nav_helper'
+
+describe NavigationHelper, type: [:helper] do
+  before { helper.request.path = '/foo/bar' }
+
+  describe '#current_path?' do
+    it 'checks whether given path is the page path or path to a sub-page' do
+      expect(helper.current_path?('/foo')).to be true
+      expect(helper.current_path?('/foo/bar')).to be true
+
+      expect(helper.current_path?('/fo')).to be false
+      expect(helper.current_path?('/bar/baz')).to be false
+      expect(helper.current_path?('/foo/bar/baz')).to be false
+    end
+
+    context 'root' do
+      before { helper.request.path = '/foo' }
+
+      it 'checks whether given path is the page path' do
+        expect(helper.current_path?('/foo', '/foo')).to be true
+        expect(helper.current_path?('/foo/bar', '/foo')).to be false
+
+        expect(helper.current_path?('/fo', '/foo')).to be false
+        expect(helper.current_path?('/bar', '/foo')).to be false
+      end
+    end
+  end
+
+  describe '#nav_item' do
+    it 'generates nav item' do
+      expect(helper.nav_item('Foo', '/fo')).to eq(%{<li><a href="/fo">Foo</a></li>})
+      expect(helper.nav_item('Bar', '/foo/bar')).to eq(%{<li class="active"><a href="/foo/bar">Bar</a></li>})
+    end
+
+    it 'allows custom root' do
+      helper.request.path = '/admin/foo/bar'
+
+      expect(helper.nav_item('Foo', '/admin/fo', root: '/admin')).to eq(%{<li><a href="/admin/fo">Foo</a></li>})
+      expect(helper.nav_item('Bar', '/admin/foo/bar', root: '/admin')).to eq(%{<li class="active"><a href="/admin/foo/bar">Bar</a></li>})
+      expect(helper.nav_item('Bar', '/admin', root: '/admin')).to eq(%{<li><a href="/admin">Bar</a></li>})
+    end
+
+    it 'generates nav item with block' do
+      expect(helper.nav_item('/fo') do
+        'FOO'
+      end).to eq "<li><a href=\"/fo\">FOO</a></li>"
+
+      expect(helper.nav_item('/foo/bar') do
+        'BAR'
+      end).to eq "<li class=\"active\"><a href=\"/foo/bar\">BAR</a></li>"
+    end
+  end
+end

data/spec/micro_dummy_app.rb

@@ -0,0 +1,14 @@
+ENV['RAILS_ENV'] = 'test'
+
+require 'rails'
+require 'action_controller/railtie'
+require 'rspec/rails'
+
+module Dummy
+  class Application < Rails::Application
+    config.secret_key_base = 'dummy_key'
+    config.eager_load = false
+  end
+end
+
+Rails.application.initialize!

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'micro_dummy_app'
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: nav_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Okhlopkov Anatoly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+description: Helper for building nav links.
+email:
+- ohlopkov0211@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- lib/nav_helper.rb
+- lib/nav_helper/version.rb
+- nav_helper.gemspec
+- spec/helpers/nav_helper_spec.rb
+- spec/micro_dummy_app.rb
+- spec/spec_helper.rb
+homepage: https://github.com/VortexGrenade/nav_helper.git
+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.4.2
+signing_key: 
+specification_version: 4
+summary: Helper for building nav links.
+test_files:
+- spec/helpers/nav_helper_spec.rb
+- spec/micro_dummy_app.rb
+- spec/spec_helper.rb