active_link_to 0.0.6 → 0.0.7

data/README.md

@@ -0,0 +1,128 @@
+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'.
+
+## Install
+### In Rails 3.*
+
+In Gemfile
+
+    gem 'active_link_to'
+    
+and run `bundle install`
+
+### In older Rails
+  
+    $ sudo gem install active_link_to
+
+Then you probably want to declare it in your environment.rb
+
+    config.gem 'active_link_to'
+  
+and freeze it (preferably):
+
+    $ rake gems:unpack GEM=active_link_to
+
+### 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
+
+* `:when => predefined symbol || Regexp || Array tuple of controller/actions || Boolean` - This controls
+  when link is considered to be 'active'
+* `:active_class => 'class_name'` - When link is 'active', css
+  class of that link is set to the default 'active'. This parameter 
+  allows it to be changed
+* `:inactive_class => 'class_name'` - Opposite of the :active_class
+  By default it's blank. However you can change it to whatever you want.
+* `:disable_link => Boolean` - 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_to` depends on the current
+url. Specifically, `request.fullpath` value. We covered the basic example
+already, so let's try something more fun.
+
+We want to highlight the link that matches immediate 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 weird 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

@@ -8,14 +8,8 @@ begin
     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/theworkinggroup/active_link_to"
+    gem.homepage = "http://github.com/twg/active_link_to"
     gem.authors = ["Oleg Khabarov"]
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-    gem.rubyforge_project = 'active-link-to'
-  end
-  
-  Jeweler::RubyforgeTasks.new do |rubyforge|
-    rubyforge.doc_task = "rdoc"
   end
   
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/active_link_to.gemspec

@@ -1,49 +1,45 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{active_link_to}
-  s.version = "0.0.6"
+  s.version = "0.0.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Oleg Khabarov"]
-  s.date = %q{2010-07-01}
+  s.date = %q{2011-05-10}
   s.description = %q{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}
   s.email = %q{oleg@theworkinggroup.ca}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+    "README.md"
   ]
   s.files = [
-    ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "active_link_to.gemspec",
-     "init.rb",
-     "lib/active_link_to.rb",
-     "test/active_link_to_test.rb",
-     "test/test_helper.rb"
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "active_link_to.gemspec",
+    "init.rb",
+    "lib/active_link_to.rb",
+    "test/active_link_to_test.rb",
+    "test/test_helper.rb"
   ]
-  s.homepage = %q{http://github.com/theworkinggroup/active_link_to}
-  s.rdoc_options = ["--charset=UTF-8"]
+  s.homepage = %q{http://github.com/twg/active_link_to}
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{active-link-to}
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.7.2}
   s.summary = %q{Marks currently active links}
   s.test_files = [
     "test/active_link_to_test.rb",
-     "test/test_helper.rb"
+    "test/test_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
     else
     end
   else

data/lib/active_link_to.rb

@@ -142,7 +142,7 @@ module ActiveLinkTo
   def is_active_link?(url, options = {})
     case options[:when]
     when :self, nil
-      !request.fullpath.match(/^#{Regexp.escape(url)}(\/?.*)?$/).blank?
+      !request.fullpath.match(/^#{Regexp.escape(url)}(\/.*|\?.*)?$/).blank?
     when :self_only
       !request.fullpath.match(/^#{Regexp.escape(url)}\/?(\?.*)?$/).blank?
     when Regexp

data/test/active_link_to_test.rb

@@ -12,10 +12,19 @@ class ActiveLinkToTest < Test::Unit::TestCase
     assert_equal '<a href="/not-test">name</a>', out
   end
   
+  def test_matching_self_with_similar_url
+    request.fullpath = '/test/19'
+    out = active_link_to 'name', '/test/1'
+    assert_equal '<a href="/test/1">name</a>', out
+  end
+  
   def test_matching_self_with_extra_parameters
     request.fullpath = '/test?status=what'
     out = active_link_to 'name', '/test'
     assert_equal '<a href="/test" class="active">name</a>', out
+    request.fullpath = '/test/?status=what'
+    out = active_link_to 'name', '/test'
+    assert_equal '<a href="/test" class="active">name</a>', out
   end
   
   def test_matching_self_only

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: active_link_to
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 6
-  version: 0.0.6
+  prerelease: 
+  version: 0.0.7
 platform: ruby
 authors: 
 - Oleg Khabarov
@@ -14,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-01 00:00:00 -04:00
-default_executable: 
+date: 2011-05-10 00:00:00 Z
 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
@@ -26,11 +21,10 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
-- .gitignore
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - active_link_to.gemspec
@@ -38,33 +32,30 @@ files:
 - lib/active_link_to.rb
 - test/active_link_to_test.rb
 - test/test_helper.rb
-has_rdoc: true
-homepage: http://github.com/theworkinggroup/active_link_to
+homepage: http://github.com/twg/active_link_to
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
-rubyforge_project: active-link-to
-rubygems_version: 1.3.6
+rubyforge_project: 
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Marks currently active links

data/.gitignore

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

data/README.rdoc

@@ -1,117 +0,0 @@
-= 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'.
-
-=== Install
-  
-  $ sudo gem install active_link_to
-
-Then you probably want to declare it in your environment.rb
-
-  config.gem 'active_link_to'
-  
-and freeze it (preferably):
-
-  $ rake gems:unpack GEM=active_link_to
-
-=== 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.