trejo 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* Initial release

data/Gemfile

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

data/README.md

@@ -0,0 +1,58 @@
+# Trejo
+
+Trejo provides `nav_item` helper to render navigation links. An `active` class is applied to the link when the requested path matches the link url.
+
+## Installation
+
+Add it to your Gemfile and run the `bundle` command to install it.
+
+ ```ruby
+ gem 'trejo'
+ ```
+
+## Usage
+
+If the current path is `/home`, then the following
+
+ ```
+ <nav>
+   <%= nav_item 'Home', '/home' %>
+   <%= nav_item 'Blog', '/blog' %>
+ </nav>
+ ```
+
+generates
+
+ ```
+ <nav>
+   <a href='/home' class='active'>Home</a>
+   <a href='/blog'>Blog</a>
+ </nav>
+ ```
+
+Trejo assumes that the link url is the root of the resource, and ignores query parameters by default. So the above example also works if the requested path is `/home/index?foo=bar`.
+
+The default css class applied to the link is `active`. This can be overridden by passing a `class` option with the desired class.
+
+ ```
+ <%= nav_item 'Home', '/home', class: 'current-section' %>
+ ```
+
+generates
+
+ ```
+ <a href='/home' class='current-section'>Home</a>
+ ```
+
+If you need more granularity in the criteria for determining an active link, you can supply a regular expression in the `selected ` option. So if the current path is `/home?foo=bar`, then the following
+
+ ```
+ <%= nav_item 'Home', '/home?foo=bar', selected: /^\/home\?foo=\w+/ %>
+ ```
+
+generates
+
+ ```
+ <a class='active'>Home</a>
+ ```
+

data/Rakefile

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

data/lib/trejo/railtie.rb

@@ -0,0 +1,9 @@
+require 'trejo/view_helpers'
+
+module Trejo
+  class Railtie < Rails::Railtie
+    initializer 'trejo.view_helpers' do
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/trejo/version.rb

@@ -0,0 +1,3 @@
+module Trejo
+  VERSION = "0.0.1"
+end

data/lib/trejo/view_helpers.rb

@@ -0,0 +1,16 @@
+module Trejo
+  module ViewHelpers
+    def nav_item name, url, options={}
+      current_path = request.fullpath
+
+      selected = if options[:selected]
+        current_path =~ options[:selected]
+      else
+        current_path =~ /^#{Regexp.escape(url)}.*(?:\?.*)?/
+      end
+
+      link_class = options[:class] || 'active' if selected
+      link_to name, url, class: link_class
+    end
+  end
+end

data/lib/trejo.rb

@@ -0,0 +1,2 @@
+require 'trejo/version'
+require 'trejo/railtie' if defined?(Rails)

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'action_view'
+require 'trejo/view_helpers'

data/spec/trejo/view_helpers_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+include ActionView::Helpers::UrlHelper
+class TrejoHelperTestClass; end
+
+describe Trejo::ViewHelpers do
+  before do
+    @trejo = TrejoHelperTestClass.new
+    @trejo.extend Trejo::ViewHelpers
+  end
+
+  describe '#nav_item' do
+    context 'by default' do
+      context 'when the link path matches the requested path' do
+        before do
+          request = stub fullpath: '/home'
+          @trejo.stub(:request).and_return(request)
+
+          @nav_item = @trejo.nav_item('Home', '/home')
+        end
+
+        it 'returns a selected nav item' do
+          expect(@nav_item).to eq('<a href="/home" class="active">Home</a>')
+        end
+      end
+
+      context 'when the link path does not match the requested path' do
+        before do
+          request = stub fullpath: '/home'
+          @trejo.stub(:request).and_return(request)
+
+          @nav_item = @trejo.nav_item('Blog', '/blog')
+        end
+
+        it 'returns an unselected nav item' do
+          expect(@nav_item).to eq('<a href="/blog">Blog</a>')
+        end
+      end
+
+      context 'ignores query parameters' do
+        context 'and when the link path matches the requested path' do
+          before do
+            request = stub fullpath: '/home?page=2'
+            @trejo.stub(:request).and_return(request)
+
+            @nav_item = @trejo.nav_item('Home', '/home')
+          end
+
+          it 'returns a selected nav item' do
+            expect(@nav_item).to eq('<a href="/home" class="active">Home</a>')
+          end
+        end
+      end
+
+      context 'assumes the link path is the root' do
+        context 'and when the requested path includes a nested path' do
+          before do
+            request = stub fullpath: '/home/index'
+            @trejo.stub(:request).and_return(request)
+            @nav_item = @trejo.nav_item('Home', '/home')
+          end
+
+          it 'returns a selected nav item' do
+            expect(@nav_item).to eq('<a href="/home" class="active">Home</a>')
+          end
+        end
+
+        context 'and when the requested path includes a different root path' do
+          before do
+            request = stub fullpath: '/blog/index'
+            @trejo.stub(:request).and_return(request)
+            @nav_item = @trejo.nav_item('Home', '/home')
+          end
+
+          it 'returns an unselected nav item' do
+            expect(@nav_item).to eq('<a href="/home">Home</a>')
+          end
+        end
+
+        context 'and when query parameters are present' do
+          before do
+            request = stub fullpath: '/home/index?foo=bar&walter=sobchak'
+            @trejo.stub(:request).and_return(request)
+            @nav_item = @trejo.nav_item('Home', '/home')
+          end
+
+          it 'returns a selected nav item' do
+            expect(@nav_item).to eq('<a href="/home" class="active">Home</a>')
+          end
+        end
+      end
+    end
+
+    context 'when the selection criteria is a regex' do
+      before do
+        request = stub fullpath: '/home?page=2'
+        @trejo.stub(:request).and_return(request)
+      end
+
+      context 'when the requested path matches the criteria' do
+        before do
+          @nav_item = @trejo.nav_item('Home', '/home', selected: /^\/home/)
+        end
+
+        it 'returns a selected nav item' do
+          expect(@nav_item).to eq('<a href="/home" class="active">Home</a>')
+        end
+      end
+
+      context 'when the requested path does not match the criteria' do
+        before do
+          @nav_item = @trejo.nav_item('Blog', '/blog', selected: /^\/blog/)
+        end
+
+        it 'returns a unselected nav item' do
+          expect(@nav_item).to eq('<a href="/blog">Blog</a>')
+        end
+      end
+    end
+
+    context 'when a css class is supplied' do
+      before do
+        request = stub fullpath: '/home'
+        @trejo.stub(:request).and_return(request)
+
+        @nav_item = @trejo.nav_item('Home', '/home', class: 'current-section')
+      end
+
+      it 'returns a selected nav item with that class' do
+        expect(@nav_item).to eq('<a href="/home" class="current-section">Home</a>')
+      end
+    end
+  end
+end

data/trejo.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "trejo/version"
+
+Gem::Specification.new do |s|
+  s.name        = "trejo"
+  s.version     = Trejo::VERSION
+  s.authors     = ["Boram Yoon"]
+  s.email       = ["boram@me.com"]
+  s.homepage    = "http://github.com/boram/trejo"
+  s.summary     = %q{Navigation link helper}
+  s.description = %q{Navigation links with active states based on current path}
+
+  s.rubyforge_project = "trejo"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = '>= 1.9.3'
+  s.add_dependency 'actionpack', ['>= 3.0.0']
+  s.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: trejo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Boram Yoon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Navigation links with active states based on current path
+email:
+- boram@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG
+- Gemfile
+- README.md
+- Rakefile
+- lib/trejo.rb
+- lib/trejo/railtie.rb
+- lib/trejo/version.rb
+- lib/trejo/view_helpers.rb
+- spec/spec_helper.rb
+- spec/trejo/view_helpers_spec.rb
+- trejo.gemspec
+homepage: http://github.com/boram/trejo
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: trejo
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Navigation link helper
+test_files:
+- spec/spec_helper.rb
+- spec/trejo/view_helpers_spec.rb