link_to_active_state 0.1.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head
+  - 1.8.7

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Robert May
+
+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/README.md

@@ -0,0 +1,67 @@
+# LinkToActiveState
+
+[![Build Status](https://travis-ci.org/robotmay/link_to_active_state.png?branch=master)](https://travis-ci.org/robotmay/link_to_active_state) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/robotmay/link_to_active_state) [![Dependency Status](https://gemnasium.com/robotmay/link_to_active_state.png)](https://gemnasium.com/robotmay/link_to_active_state)
+
+A simple gem to implement active states on links using the standard Rails `link_to` helper.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'link_to_active_state'
+
+*NOTE*: RubyGems.org is currently in read-only mode, so the gem doesn't yet exist there. Install from the git repo instead:
+
+    gem 'link_to_active_state', git: 'git://github.com/robotmay/link_to_active_state.git', tag: 'v0.1.2'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install link_to_active_state
+
+## Usage
+
+This gem adds a small bit of extra functionality to the default Rails `link_to` view helper. It provides a very simple way of adding classes to links based on the current path.
+
+### Examples
+
+Test the path using a string/path helper:
+```ruby
+link_to "Account", account_path, active_on: account_path
+```
+
+Using a regular expression:
+```ruby
+link_to "Account", account_path, active_on: /\/account/i
+```
+
+Or a proc:
+```ruby
+link_to "Account", account_path, active_on: lambda { request.fullpath == account_path }
+```
+
+### Custom options
+
+By default the class "active" will be added to the existing classes of the link. However you can specify your own:
+
+```ruby
+link_to "Account", account_path, active_on: /\/account/i, active_state: "highlighted"
+```
+
+You can also customise other options by using a proc:
+```ruby
+link_to "Account", account_path, active_on: /\/account/i, active_state: lambda { |html_options|
+  html_options.merge({ "data-active" => "true" })
+}
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/link_to_active_state/railtie.rb

@@ -0,0 +1,12 @@
+require "link_to_active_state"
+
+module LinkToActiveState
+  class Railtie < Rails::Railtie
+    initializer "link_to_active_state.view_helpers" do
+      ActiveSupport.on_load(:action_view) do
+        require "link_to_active_state/view_helpers/url_helper"
+        include LinkToActiveState::ViewHelpers::UrlHelper
+      end
+    end
+  end
+end

data/lib/link_to_active_state/version.rb

@@ -0,0 +1,3 @@
+module LinkToActiveState
+  VERSION = "0.1.2"
+end

data/lib/link_to_active_state/view_helpers/url_helper.rb

@@ -0,0 +1,58 @@
+require 'action_view'
+require 'link_to_active_state'
+
+module LinkToActiveState
+  module ViewHelpers
+    module UrlHelper
+      def self.included(base)
+        base.send(:alias_method_chain, :link_to, :active_state)
+      end
+
+      def link_to_with_active_state(*args, &block)
+        html_options = if block_given?
+          args.second
+        else
+          args[2]
+        end
+      
+        if html_options.present? && html_options[:active_on].present?
+          active_on = html_options[:active_on]
+
+          if is_active?(active_on)
+            active_state = html_options[:active_state] || "active"
+            case active_state
+            when Proc
+              html_options.merge(active_state.call(html_options))
+            when String
+              html_options[:class] = merge_class(html_options[:class], active_state)
+            end
+          end
+
+          html_options.delete(:active_on)
+          html_options.delete(:active_state)
+        end
+
+        link_to_without_active_state(*args, &block)
+      end
+
+      private
+      def is_active?(active_on)
+        case active_on
+        when String
+          request.fullpath == active_on
+        when Array
+          active_on.include?(request.fullpath)
+        when Regexp
+          request.fullpath =~ active_on  
+        when Proc
+          active_on.arity == 1 ? active_on.call(request) : active_on.call
+        end
+      end
+
+      def merge_class(original, new)
+        original ||= ""
+        [original, new].delete_if(&:blank?).join(" ")
+      end
+    end
+  end
+end

data/lib/link_to_active_state.rb

@@ -0,0 +1,5 @@
+require "link_to_active_state/version"
+require "link_to_active_state/railtie" if defined?(Rails)
+
+module LinkToActiveState
+end

data/link_to_active_state.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'link_to_active_state/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "link_to_active_state"
+  gem.version       = LinkToActiveState::VERSION
+  gem.authors       = ["Robert May"]
+  gem.email         = ["robotmay@gmail.com"]
+  gem.description   = %q{A simple gem to implement active states on links using the standard Rails `link_to` helper.}
+  gem.summary       = %q{Active states for links using the Rails link_to helper.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.cert_chain = ["gem-public_cert.pem"]
+  gem.signing_key = ENV['PRIVATE_KEY']
+
+  gem.add_development_dependency "rails", [">= 3.2.11"]
+  gem.add_development_dependency "rspec", ["~> 2.12.0"]
+end

data/spec/link_to_active_state/view_helpers_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+require 'action_view'
+
+module LinkToActiveState
+  module ViewHelpers
+  end
+end

data/spec/link_to_active_state_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require 'link_to_active_state/view_helpers/url_helper'
+
+module App
+  class Helper < ActionView::Base
+    include LinkToActiveState::ViewHelpers::UrlHelper
+  end
+end
+
+describe LinkToActiveState::ViewHelpers::UrlHelper do
+  let(:helper) { App::Helper.new }
+
+  context "integration with ActionView" do
+    it "aliases the original link_to helper" do
+      helper.should respond_to(:link_to_without_active_state)
+    end
+
+    it "responds to link_to_with_active_state" do
+      helper.should respond_to(:link_to_with_active_state)
+    end
+
+    it "aliases link_to_with_active_state to link_to" do
+      lt = helper.link_to "Test", "/", :active_on => lambda { true }
+      ltwas = helper.link_to_with_active_state "Test", "/", :active_on => lambda { true }
+      ltwoas = helper.link_to_without_active_state "Test", "/", :active_on => lambda { true }
+      lt.should eq(ltwas)
+      lt.should_not eq(ltwoas)
+    end
+  end
+
+  context "active states on links" do
+    let(:request) do
+      class Request
+        def fullpath
+        end
+      end
+      
+      Request.new
+    end
+
+    before(:each) do
+      helper.stub!(:request).and_return(request)
+    end
+
+    it "adds an active state when the current request path matches" do
+      request.stub!(:fullpath).and_return("/")
+      lt = helper.link_to "Home", "/", :active_on => "/"
+      lt.should match(/class=\"active\"/i)
+    end
+
+    it "doesn't add an active state when the current request doesn't match" do
+      request.stub!(:fullpath).and_return("/wibble")
+      lt = helper.link_to "Madness", "/wobble", :active_on => "/wobble"
+      lt.should_not match(/class=\"active\"/i)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'link_to_active_state'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter = :documentation
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: link_to_active_state
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- Robert May
+autorequire: 
+bindir: bin
+cert_chain:
+- !binary |-
+  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURNakNDQWhxZ0F3SUJB
+  Z0lCQURBTkJna3Foa2lHOXcwQkFRVUZBREEvTVJFd0R3WURWUVFEREFoeWIy
+  SnYKZEcxaGVURVZNQk1HQ2dtU0pvbVQ4aXhrQVJrV0JXZHRZV2xzTVJNd0VR
+  WUtDWkltaVpQeUxHUUJHUllEWTI5dApNQjRYRFRFek1ESXdNVEV5TWpBek9G
+  b1hEVEUwTURJd01URXlNakF6T0Zvd1B6RVJNQThHQTFVRUF3d0ljbTlpCmIz
+  UnRZWGt4RlRBVEJnb0praWFKay9Jc1pBRVpGZ1ZuYldGcGJERVRNQkVHQ2dt
+  U0pvbVQ4aXhrQVJrV0EyTnYKYlRDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFB
+  RGdnRVBBRENDQVFvQ2dnRUJBTjZ3aXg2bnQxSUJoZ1N5SWVNQgp5dFBwbjUx
+  NW53U3ZKaEcxZWo3WXQ5VDBmYU1DbldUcm04alp0ZHRYc0IvOVJ3SHBVb0Nx
+  Q2R0dE5ybS8xakJRCmo4ZGRUbXFQVjlMNVc3bXZiQzRhKzRZUTUreEJxRzBX
+  VjVMRFlRZWswaFhXR003WEpkL2VvODJDQU5yZ21pdTUKTXFDbmE4b3ZvQUJ0
+  cVhRYit0ODNEdEsweGRMMHJTZDV6QlA3NTJWektDOC9BRXc1RVpsVFdIOXhY
+  V3k3YXNGKwpVMG55eW13eVBLdmZ3RGgwMmM3V1JyejcvOE5DQ3l0bzdHV2Zy
+  bUQ5YzRVa0lxcnNGeDQwRlNrRVRYYXBMSXBXCjZxNTg1OWMwMCt3ZWVBSW1Y
+  OGdIbkNYVHhNZGN4eG1QUThzWjZLWi9ORXlaaDd5QXBKYVBWbVFJK20yT3Uy
+  R0EKSktNQ0F3RUFBYU01TURjd0NRWURWUjBUQkFJd0FEQWRCZ05WSFE0RUZn
+  UVVSUFhXdllacXdtSG5xdzR1TWpaaApsaUwzR2drd0N3WURWUjBQQkFRREFn
+  U3dNQTBHQ1NxR1NJYjNEUUVCQlFVQUE0SUJBUUNwV0YrQjZLNW1lZ0lICjlX
+  SnhWMlZpODF3MDBDb2F4Tk1RQkwzOEtNVURrcTR1NFY3RU9vWWRwOXFkUTJ0
+  RHdKMkNCaElSU1BTNmJOdHAKR0FNMXBlT0NYYmxzU0dveU5XUzBrTmQ4L2VX
+  VnlNQ0Z0N1BzV2k0bkFEVlRNN3VIWVI5TXRtSVE1QmJzUzhPUwp6ZXVmTVFm
+  eXVWMllwM2Erb0dGZEdyV2E2Y2ljUmh2QmxKZ2xyaVVpVUdUZi9aNDVock5R
+  MXhQOVd5UEpxVExWCmNFdkMxTGlMU0NTYi92MmxGVnBBNTF3ZGlJQzUvQ1RB
+  Z3lJTUNjN0xtVG9uY3FndkVZM2hRRnNMTlpsZkd0VnoKNU83Y0YzQ0RIdVpJ
+  RmtIbEdCZzNuQy82bjdYVjlucDhwZTk2ODhvbjROYi8yekNPd3pjd09DTTZo
+  SnluOElVZgp6ajVkUTNwMAotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
+date: 2013-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: A simple gem to implement active states on links using the standard Rails
+  `link_to` helper.
+email:
+- robotmay@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/link_to_active_state.rb
+- lib/link_to_active_state/railtie.rb
+- lib/link_to_active_state/version.rb
+- lib/link_to_active_state/view_helpers/url_helper.rb
+- link_to_active_state.gemspec
+- spec/link_to_active_state/view_helpers_spec.rb
+- spec/link_to_active_state_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Active states for links using the Rails link_to helper.
+test_files:
+- spec/link_to_active_state/view_helpers_spec.rb
+- spec/link_to_active_state_spec.rb
+- spec/spec_helper.rb