link_to_active_state 0.1.2 → 1.0.0

data/.public_cert.pem

@@ -0,0 +1,20 @@
+-----BEGIN CERTIFICATE-----
+MIIDMjCCAhqgAwIBAgIBADANBgkqhkiG9w0BAQUFADA/MREwDwYDVQQDDAhyb2Jv
+dG1heTEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
+MB4XDTEzMDIwMTEyMjAzOFoXDTE0MDIwMTEyMjAzOFowPzERMA8GA1UEAwwIcm9i
+b3RtYXkxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
+bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAN6wix6nt1IBhgSyIeMB
+ytPpn515nwSvJhG1ej7Yt9T0faMCnWTrm8jZtdtXsB/9RwHpUoCqCdttNrm/1jBQ
+j8ddTmqPV9L5W7mvbC4a+4YQ5+xBqG0WV5LDYQek0hXWGM7XJd/eo82CANrgmiu5
+MqCna8ovoABtqXQb+t83DtK0xdL0rSd5zBP752VzKC8/AEw5EZlTWH9xXWy7asF+
+U0nyymwyPKvfwDh02c7WRrz7/8NCCyto7GWfrmD9c4UkIqrsFx40FSkETXapLIpW
+6q5859c00+weeAImX8gHnCXTxMdcxxmPQ8sZ6KZ/NEyZh7yApJaPVmQI+m2Ou2GA
+JKMCAwEAAaM5MDcwCQYDVR0TBAIwADAdBgNVHQ4EFgQURPXWvYZqwmHnqw4uMjZh
+liL3GgkwCwYDVR0PBAQDAgSwMA0GCSqGSIb3DQEBBQUAA4IBAQCpWF+B6K5megIH
+9WJxV2Vi81w00CoaxNMQBL38KMUDkq4u4V7EOoYdp9qdQ2tDwJ2CBhIRSPS6bNtp
+GAM1peOCXblsSGoyNWS0kNd8/eWVyMCFt7PsWi4nADVTM7uHYR9MtmIQ5BbsS8OS
+zeufMQfyuV2Yp3a+oGFdGrWa6cicRhvBlJglriUiUGTf/Z45hrNQ1xP9WyPJqTLV
+cEvC1LiLSCSb/v2lFVpA51wdiIC5/CTAgyIMCc7LmToncqgvEY3hQFsLNZlfGtVz
+5O7cF3CDHuZIFkHlGBg3nC/6n7XV9np8pe9688on4Nb/2zCOwzcwOCM6hJyn8IUf
+zj5dQ3p0
+-----END CERTIFICATE-----

data/README.md

@@ -2,7 +2,8 @@
 
 [![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.
+A simple gem to implement active states on links using the standard Rails `link_to` helper. 
+This can be helpful in navigation lists or buttons to give them a class when the current URL matches a condition on the link helper.
 
 ## Installation
 
@@ -10,7 +11,7 @@ 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:
+Or install from the repository:
 
     gem 'link_to_active_state', git: 'git://github.com/robotmay/link_to_active_state.git', tag: 'v0.1.2'
 
@@ -33,6 +34,11 @@ Test the path using a string/path helper:
 link_to "Account", account_path, active_on: account_path
 ```
 
+Which, if the `request.fullpath` matches `account_path`, will result in:
+```html
+<a href="/account" class="active">Account</a>
+```
+
 Using a regular expression:
 ```ruby
 link_to "Account", account_path, active_on: /\/account/i
@@ -51,6 +57,10 @@ By default the class "active" will be added to the existing classes of the link.
 link_to "Account", account_path, active_on: /\/account/i, active_state: "highlighted"
 ```
 
+```html
+<a href="/account" class="highlighted">Account</a>
+```
+
 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|
@@ -58,6 +68,26 @@ link_to "Account", account_path, active_on: /\/account/i, active_state: lambda {
 }
 ```
 
+```html
+<a href="/account" data-active="true">Account</a>
+```
+
+### Wrappers
+
+If you need an active class on an li tag, for use in a Bootstrap nav for example:
+```ruby
+link_to "Account", account_path, active_on: account_path, active_wrapper: :li
+```
+
+Which will result in:
+```html
+<li class="active">
+  <a href="/account" class="active">Account</a>
+</li>
+```
+
+Note the li tag is included as part of the html generated by the link_to helper and should not be added separately.
+
 ## Contributing
 
 1. Fork it

data/lib/link_to_active_state/version.rb

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

data/lib/link_to_active_state/view_helpers/url_helper.rb

@@ -14,7 +14,7 @@ module LinkToActiveState
         else
           args[2]
         end
-      
+
         if html_options.present? && html_options[:active_on].present?
           active_on = html_options[:active_on]
 
@@ -32,7 +32,15 @@ module LinkToActiveState
           html_options.delete(:active_state)
         end
 
-        link_to_without_active_state(*args, &block)
+        if html_options.present? && html_options[:active_wrapper]
+          element = html_options.delete(:active_wrapper)
+
+          content_tag(element, html_options) do
+            link_to_without_active_state(*args, &block)
+          end
+        else
+          link_to_without_active_state(*args, &block)
+        end
       end
 
       private
@@ -43,7 +51,7 @@ module LinkToActiveState
         when Array
           active_on.include?(request.fullpath)
         when Regexp
-          request.fullpath =~ active_on  
+          request.fullpath =~ active_on
         when Proc
           active_on.arity == 1 ? active_on.call(request) : active_on.call
         end

data/link_to_active_state.gemspec

@@ -17,9 +17,6 @@ Gem::Specification.new do |gem|
   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_spec.rb

@@ -34,7 +34,7 @@ describe LinkToActiveState::ViewHelpers::UrlHelper do
         def fullpath
         end
       end
-      
+
       Request.new
     end
 
@@ -42,16 +42,41 @@ describe LinkToActiveState::ViewHelpers::UrlHelper 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)
+    context "when the current request path matches" do
+
+      it "adds an active state" do
+        request.stub!(:fullpath).and_return("/")
+        lt = helper.link_to "Home", "/", :active_on => "/"
+        lt.should match(/class=\"active\"/i)
+      end
+
+      it "encloses link in an element with active state if active_wrapper is true" do
+        request.stub!(:fullpath).and_return("/")
+        lt = helper.link_to "Home", "/", :active_on => "/", :active_wrapper => :li
+        lt.should match(/li class=\"active\"/i)
+      end
+
+      it "doesn't enclose link in an element if active_wrapper is not specified" do
+        request.stub!(:fullpath).and_return("/")
+        lt = helper.link_to "Home", "/", :active_on => "/"
+        lt.should_not match(/li class=\"active\"/i)
+      end
     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)
+    context "when the current request doesn't match" do
+      it "doesn't add an active state" do
+        request.stub!(:fullpath).and_return("/wibble")
+        lt = helper.link_to "Madness", "/wobble", :active_on => "/wobble"
+        lt.should_not match(/class=\"active\"/i)
+      end
+
+      it "encloses link in an element if active_wrapper is true" do
+        request.stub!(:fullpath).and_return("/wibble")
+        lt = helper.link_to "Home", "/", :active_on => "/", :active_wrapper => :li
+        lt.should match(/<li>/i)
+      end
+
     end
+
   end
 end

metadata

@@ -1,42 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: link_to_active_state
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
   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
+cert_chain: []
+date: 2013-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -79,6 +52,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .public_cert.pem
 - .travis.yml
 - Gemfile
 - LICENSE.txt
@@ -112,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Active states for links using the Rails link_to helper.