active_link_to 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Oleg Khabarov, The Working Group Inc.
+
+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.rdoc

@@ -0,0 +1,105 @@
+= active_link_to
+
+Creates a link tag of the given +name+ using a URL created by the set of
++options+. Please see documentation for link_to, as active_link_to is
+basically a wrapper for it. This method accepts an optional +:active+
+parameter that dictates if the given link will have an extra css class
+attached that marks it as 'active'.
+
+=== Super Simple Example
+Here's a link that will have class attached if it happens to be rendered 
+on page with path /people or any child of that page like /people/123
+
+  active_link_to 'People', '/people'
+  # => <a href="/people" class="active">People</a>
+
+This is exactly the same as:
+
+  active_link_to 'People', '/people', :active => { :when => :self }
+  # => <a href="/people" class="active">People</a>
+
+=== Options
+Here's available options that can be inserted into :active hash
+* <tt>:when => predefined symbol || Regexp || Array tuple of controller/actions || Boolean</tt> - This controls
+  when link is considered to be 'active'
+* <tt>:active_class => 'class_name'</tt> - When link is 'active', css
+  class of that link is set to the default 'active'. This parameter 
+  allows it to be changed
+* <tt>:inactive_class => 'class_name'</tt> - Opposite of the :active_class
+  By default it's blank. However you can change it to whatever you want.
+* <tt>:disable_link => Boolean</tt> - When link is active, sometimes you
+  want to render span tag instead of the link. This parameter is for that.
+
+=== Examples
+Most of the functionality of active_link_helper depends on the current
+url. Specifically, request.request_uri value. We covered the basic example
+already, so let's try sometihng more fun
+
+We want to highlight the link that matches immidiate url, and not the children
+nodes as well
+
+  # For URL: /people/24
+  active_link_to 'People', people_path, :active => { :when => :self_only }
+  # => <a href="/people">People</a>
+
+  # For URL: /people
+  active_link_to 'People', people_path, :active => { :when => :self_only }
+  # => <a href="/people" class="active">People</a>
+
+If we need to set link to be active based on some regular expression, we can do
+that as well. Let's try to activate links urls of which begin with 'peop':
+
+  # For URL: /people/44
+  active_link_to 'People', people_path, :active => { :when => /^peop/ }
+  # => <a href="/people" class="active">People</a>
+
+  # For URL: /aliens/9
+  active_link_to 'People', people_path, :active => { :when => /^peop/ }
+  # => <a href="/people">People</a>
+
+What if we need to mark link active for all URLs that match a particular controller,
+or action, or both? Or any number of those at the same time? Sure, why not:
+
+  # For URL: /people/56/edit
+  # For matching multiple controllers and actions:
+  active_link_to 'Person Edit', edit_person_path(@person), :active => {
+    :when => [['people', 'aliens'], ['show', 'edit']]
+  }
+
+  # for matching all actions under given controllers:
+  active_link_to 'Person Edit', edit_person_path(@person), :active => {
+    :when => [['people', 'aliens'], []]
+  }
+
+  # for matching all controllers for a particular action
+  active_link_to 'Person Edit', edit_person_path(@person), :active => {
+    :when => [[], ['edit']]
+  }
+  # => <a href="/people" class="active">People</a>
+
+Sometimes it should be easy as setting a true or false:
+
+  active_link_to 'People', people_path, :active => { :when => true }
+  # => <a href="/people" class="active">People</a>
+
+  active_link_to 'People', people_path, :active => { :when => false }
+  # => <a href="/people">People</a>
+
+Lets see what happens when we push some css class modifier parameters
+
+  # For URL: /people/12
+  active_link_to 'People', people_path, :active => { :active_link => 'awesome_selected' }
+  # => <a href="/people" class="awesome_selected">People</a>
+
+  active_link_to 'Aliens', aliens_path, :active => { :inactive_link => 'bummer_inactive' }
+  # => <a href="/aliens" class="bummer_inactive">Aliens</a>
+
+Some wierd people think that link should change to a span if it indicated current page:
+
+  # For URL: /people
+  active_link_to 'People', people_path, :active => { :disable_link => true }
+  # => <span class="active">People</span>
+
+== Copyright
+
+Copyright (c) 2009 Oleg Khabarov, The Working Group Inc. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'active_link_to'
+    gem.summary = 'Marks currently active links'
+    gem.description = 'Extremely helpful when you need to add some logic that figures out if the link (or more often navigation item) is selected based on the current page or other arbitrary condition'
+    gem.email = "oleg@theworkinggroup.ca"
+    gem.homepage = "http://github.com/OlegK/active_link_to"
+    gem.authors = ["Oleg Khabarov"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "active_link_to #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/active_link_to.rb

@@ -0,0 +1,159 @@
+module ActiveLinkTo
+  
+  # Creates a link tag of the given +name+ using a URL created by the set of
+  # +options+. Please see documentation for link_to, as active_link_to is
+  # basically a wrapper for it. This method accepts an optional +:active+
+  # parameter that dictates if the given link will have an extra css class
+  # attached that marks it as 'active'.
+  #
+  # === Super Simple Example
+  # Here's a link that will have class attached if it happens to be rendered 
+  # on page with path /people or any child of that page like /people/123
+  # 
+  #   active_link_to 'People', '/people'
+  #   # => <a href="/people" class="active">People</a>
+  #
+  # This is exactly the same as:
+  #
+  #   active_link_to 'People', '/people', :active => { :when => :self }
+  #   # => <a href="/people" class="active">People</a>
+  #
+  # === Options
+  # Here's available options that can be inserted into :active hash
+  # * <tt>:when => predefined symbol || Regexp || Array tuple of controller/actions || Boolean</tt> - This controls
+  #   when link is considered to be 'active'
+  # * <tt>:active_class => 'class_name'</tt> - When link is 'active', css
+  #   class of that link is set to the default 'active'. This parameter 
+  #   allows it to be changed
+  # * <tt>:inactive_class => 'class_name'</tt> - Opposite of the :active_class
+  #   By default it's blank. However you can change it to whatever you want.
+  # * <tt>:disable_link => Boolean</tt> - When link is active, sometimes you
+  #   want to render span tag instead of the link. This parameter is for that.
+  #
+  # === Examples
+  # Most of the functionality of active_link_helper depends on the current
+  # url. Specifically, request.request_uri value. We covered the basic example
+  # already, so let's try sometihng more fun
+  # 
+  # We want to highlight the link that matches immidiate url, and not the children
+  # nodes as well
+  #
+  #   # For URL: /people/24
+  #   active_link_to 'People', people_path, :active => { :when => :self_only }
+  #   # => <a href="/people">People</a>
+  #
+  #   # For URL: /people
+  #   active_link_to 'People', people_path, :active => { :when => :self_only }
+  #   # => <a href="/people" class="active">People</a>
+  #
+  # If we need to set link to be active based on some regular expression, we can do
+  # that as well. Let's try to activate links urls of which begin with 'peop':
+  # 
+  #   # For URL: /people/44
+  #   active_link_to 'People', people_path, :active => { :when => /^peop/ }
+  #   # => <a href="/people" class="active">People</a>
+  # 
+  #   # For URL: /aliens/9
+  #   active_link_to 'People', people_path, :active => { :when => /^peop/ }
+  #   # => <a href="/people">People</a>
+  #
+  # What if we need to mark link active for all URLs that match a particular controller,
+  # or action, or both? Or any number of those at the same time? Sure, why not:
+  #
+  #   # For URL: /people/56/edit
+  #   # For matching multiple controllers and actions:
+  #   active_link_to 'Person Edit', edit_person_path(@person), :active => {
+  #     :when => [['people', 'aliens'], ['show', 'edit']]
+  #   }
+  #
+  #   # for matching all actions under given controllers:
+  #   active_link_to 'Person Edit', edit_person_path(@person), :active => {
+  #     :when => [['people', 'aliens'], []]
+  #   }
+  #
+  #   # for matching all controllers for a particular action
+  #   active_link_to 'Person Edit', edit_person_path(@person), :active => {
+  #     :when => [[], ['edit']]
+  #   }
+  #   # => <a href="/people" class="active">People</a>
+  #
+  # Sometimes it should be easy as setting a true or false:
+  #
+  #   active_link_to 'People', people_path, :active => { :when => true }
+  #   # => <a href="/people" class="active">People</a>
+  #
+  #   active_link_to 'People', people_path, :active => { :when => false }
+  #   # => <a href="/people">People</a>
+  #
+  # Lets see what happens when we push some css class modifier parameters
+  #
+  #   # For URL: /people/12
+  #   active_link_to 'People', people_path, :active => { :active_link => 'awesome_selected' }
+  #   # => <a href="/people" class="awesome_selected">People</a>
+  #
+  #   active_link_to 'Aliens', aliens_path, :active => { :inactive_link => 'bummer_inactive' }
+  #   # => <a href="/aliens" class="bummer_inactive">Aliens</a>
+  #
+  # Some wierd people think that link should change to a span if it indicated current page:
+  #
+  #   # For URL: /people
+  #   active_link_to 'People', people_path, :active => { :disable_link => true }
+  #   # => <span class="active">People</span>
+  #   
+  def active_link_to(*args, &block)
+    if block_given?
+      name          = capture(&block)
+      options       = args[0] || {}
+      html_options  = args[1] || {}
+    else
+      name          = args[0]
+      options       = args[1] || {}
+      html_options  = args[2] || {}
+    end
+    
+    url = url_for(options)
+    active_link_options = html_options.delete(:active) || {}
+    css_class = active_class(url, active_link_options)
+    
+    html_options[:class] ||= ''
+    html_options[:class] += " #{css_class}" if !css_class.blank?
+    html_options[:class].blank? ? html_options.delete(:class) : html_options[:class].lstrip!
+    
+    if active_link_options[:disable_link] === true
+      content_tag(:span, name, html_options)
+    else
+      link_to(name, url, html_options)
+    end
+  end
+  
+  # Returns css class name. Takes the link's URL and :active paramers
+  def active_class(url, options = {})
+    if is_active_link?(url, options)
+      options[:active_class] || 'active'
+    else
+      options[:inactive_class] || ''
+    end
+  end
+  
+  # Returns true or false. Takes the link's URL and :active parameters
+  def is_active_link?(url, options = {})
+    case options[:when]
+    when :self, nil
+      !request.request_uri.match(/^#{Regexp.escape(url)}(\/.*)?$/).blank?
+    when :self_only
+      !request.request_uri.match(/^#{Regexp.escape(url)}\/?(\?.*)?$/).blank?
+    when Regexp
+      !request.request_uri.match(options[:when]).blank?
+    when Array
+      controllers = options[:when][0]
+      actions     = options[:when][1]
+      (controllers.blank? || controllers.member?(params[:controller])) &&
+      (actions.blank? || actions.member?(params[:action]))
+    when TrueClass
+      true
+    when FalseClass
+      false
+    end
+  end
+  
+end

data/test/active_link_to_test.rb

@@ -0,0 +1,76 @@
+require 'test_helper'
+
+class ActiveLinkToTest < Test::Unit::TestCase
+  
+  def test_matching_self
+    request.request_uri = '/test'
+    out = active_link_to 'name', '/test'
+    assert_equal '<a href="/test" class="active">name</a>', out
+    out = active_link_to 'name', '/test', :active => { :when => :self }
+    assert_equal '<a href="/test" class="active">name</a>', out
+    out = active_link_to 'name', '/not-test'
+    assert_equal '<a href="/not-test">name</a>', out
+  end
+  
+  def test_matching_self_only
+    request.request_uri = '/test/fail'
+    out = active_link_to 'name', '/test/fail', :active => { :when => :self_only }
+    assert_equal '<a href="/test/fail" class="active">name</a>', out
+    out = active_link_to 'name', '/test', :active => { :when => :self_only }
+    assert_equal '<a href="/test">name</a>', out
+  end
+  
+  def test_matching_self_only_with_extra_parameters
+    request.request_uri = '/test/fail?why=because'
+    out = active_link_to 'name', '/test/fail', :active => { :when => :self_only }
+    assert_equal '<a href="/test/fail" class="active">name</a>', out
+  end
+  
+  def test_matching_custom_regex
+    request.request_uri = '/test/something_else'
+    out = active_link_to 'name', '/test', :active => { :when => /^\/te/}
+    assert_equal '<a href="/test" class="active">name</a>', out
+    out = active_link_to 'name', '/test', :active => { :when => /^\/no/}
+    assert_equal '<a href="/test">name</a>', out
+  end
+  
+  def test_matching_controller_action_touples
+    request.request_uri = '/test/23'
+    params[:controller], params[:action] = 'tests', 'show'
+    out = active_link_to 'name', '/test/23', :active => { :when => [['tests'], ['show', 'edit']]}
+    assert_equal '<a href="/test/23" class="active">name</a>', out
+    out = active_link_to 'name', '/test/23', :active => { :when => [['tests'], []]}
+    assert_equal '<a href="/test/23" class="active">name</a>', out
+    out = active_link_to 'name', '/test/23', :active => { :when => [[], ['show']]}
+    assert_equal '<a href="/test/23" class="active">name</a>', out
+    out = active_link_to 'name', '/test/23', :active => { :when => [['tests'], ['update']]}
+    assert_equal '<a href="/test/23">name</a>', out
+  end
+  
+  def test_matching_booleans
+    request.request_uri = 'doesnotmatter'
+    out = active_link_to 'name', '/test', :active => { :when => true }
+    assert_equal '<a href="/test" class="active">name</a>', out
+    out = active_link_to 'name', '/test', :active => { :when => false }
+    assert_equal '<a href="/test">name</a>', out
+  end
+  
+  def test_setting_active_class
+    request.request_uri = '/test'
+    out = active_link_to 'name', '/test', :active => { :active_class => 'new_active'}
+    assert_equal '<a href="/test" class="new_active">name</a>', out
+  end
+  
+  def test_setting_inactive_class
+    request.request_uri = '/test'
+    out = active_link_to 'name', '/not-test', :active => { :inactive_class => 'new_inactive'}
+    assert_equal '<a href="/not-test" class="new_inactive">name</a>', out
+  end
+  
+  def test_transforming_to_span
+    request.request_uri = '/test'
+    out = active_link_to 'name', '/test', :active => { :disable_link => true }
+    assert_equal '<span class="active">name</span>', out
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'test/unit'
+require 'action_controller'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'active_link_to'
+
+# need this to simulate requests that drive active_link_helper
+module FakeRequest
+  class Request
+    attr_accessor :request_uri
+  end
+  def request
+    @request ||= Request.new
+  end
+  def params
+    @params ||= {}
+  end
+end
+
+ActiveLinkTo.send :include, FakeRequest
+
+class Test::Unit::TestCase
+  
+  include ActionView::Helpers::UrlHelper
+  include ActionView::Helpers::TagHelper
+  include ActiveLinkTo
+  
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: active_link_to
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Oleg Khabarov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-01 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Extremely helpful when you need to add some logic that figures out if the link (or more often navigation item) is selected based on the current page or other arbitrary condition
+email: oleg@theworkinggroup.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/active_link_to.rb
+- test/active_link_to_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/OlegK/active_link_to
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Marks currently active links
+test_files: 
+- test/active_link_to_test.rb
+- test/test_helper.rb