selected_links 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62a30a37be7b8ed9394a6c728b664f415a7132ee
-  data.tar.gz: a0b6aa5bb7c513ebb8b81a1cd89788425ee72034
+  metadata.gz: 1a5ed9140ea4244863719311f15966c9d3d6de9e
+  data.tar.gz: fef8f4a290d2a7ffe36f6a511577653ece8495dd
 SHA512:
-  metadata.gz: 390d347634eeacedf9a152afb93f73def7045399ee5f87932acd291ae27a4fb5caf480216e2e8c55df0ec31c82b48d467eb80aeecd743e6209d7c1f4b84b73c8
-  data.tar.gz: 9c24559d76be4f71a83814976d0c50fa78c278f0514418f81a7d51fb783e27d95c8c40c4ca0adcec578fa9fa19b8db2f51ba93e944cc25e91d4efc8ffd341cb9
+  metadata.gz: ff25ad7a255154b401d91f053632ad2060adc9fb7bc2f90536ac7ab90ee4b3bd815bce47cb3545b0a96b419f08f17b83fd249d183ae41e978ecb541303ae25bc
+  data.tar.gz: 90b8d44449e0e41c3ae381674f090b48752af05b4fb629a426ec30e833c40aba0c2631aac39e26f29176ce7b8dcbaaf7cefd8cd1ad15522cf0e819031fefbd3d

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v0.0.3
+
+* Added ability to change the default class name for selected links
+* Added ability to pass in class name on a link to link basis
+* Changed the default class name to _active_
+
 ## v0.0.2
 
 * Added fallback behaviour support via initializer setting

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/kainage/selected_links.png)](https://travis-ci.org/kainage/selected_links)
 
-Adds a link helper to ActionView::Base to that adds a class of _selected_
+Adds a link helper to ActionView::Base to that adds a class of _active_
 to the link when matched to a pattern, usually a url.
 
 ## Installation
@@ -21,27 +21,26 @@ Or install it yourself as:
 
 ## Configuration
 
-Usage is the same as link_to and takes 2 optional arguments ```:matcher``` and ```:source```.
+Usage is the same as link_to and takes 3 optional arguments ```:matcher```, ```:source``` and ```class_name```.
 
-The default source matches to ```request.path```. This can be overridden in an initializer
+You can override the default behaviour in an initilizer file:
 
 ```ruby
 SelectedLinks.setup do |config|
-  config.default_source = 'request.url'
-end
-```
-
-You can also change the fallback behaviour to check the name if the matcher fails
+  # Change the global default source that the matcher looks to check against
+  config.default_source = 'request.path'
 
-```ruby
-SelectedLinks.setup do |config|
+  # Change the fallback behaviour to match against the name of the link if the matcher fails
   config.fallback_to_name = false
+
+  # Set the global default class name that is added to the link when a match is found
+  config.default_class_name = 'active'
 end
 ```
 
-### Useage
+### Usage
 
-To make this link have a class of _selected_ when the url is at the top level:
+To make this link have a class of _active_ when the url is at the top level:
 
 ```
 <%= selectable_link_to 'Home', root_url, :matcher => '\/\z' %>
@@ -61,7 +60,8 @@ Blocks still work and this will do the same thing as the previous example:
 <% end %>
 ```
 
-Without a matcher option and NOT in the block form, this will look for _about_ in the source:
+Without a matcher option and NOT in the block form, this will look for _about_
+in the source if the option ```fallback_to_name``` is ```true```:
 
 ```
 <%= selectable_link_to 'ABOUT', about_url %>
@@ -71,7 +71,7 @@ You can, of course, add this to links with other clases on them:
 
 ```
 <%= selectable_link_to 'ABOUT', about_url, :class => 'nav' %>
-# => <a ... class="nav selected">ABOUT</a>
+# => <a ... class="nav avtive">ABOUT</a>
 ```
 
 To override the source per link, just add a ```:source``` argument:
@@ -80,6 +80,12 @@ To override the source per link, just add a ```:source``` argument:
 <%= selectable_link_to 'ABOUT', about_url, :source => request.url %>
 ```
 
+To override the default class name added per link add ```:class_name``` argument:
+
+```
+<%= selectable_link_to 'ABOUT', about_url, :class_name => 'highlight' %>
+```
+
 ## Contributing
 
 1. Fork it

data/lib/selected_links.rb

@@ -15,6 +15,9 @@ module SelectedLinks
   mattr_accessor :fallback_to_name
   @@fallback_to_name = false
 
+  mattr_accessor :default_class_name
+  @@default_class_name = 'active'
+
   def self.setup
     yield self
   end

data/lib/selected_links/link.rb

@@ -5,14 +5,13 @@ module SelectedLinks
 
     def initialize(*args, &block)
       @name, @options, @html_options = parse_args(block_given?, *args)
-      @matcher = @html_options[:matcher]
-      @source = @html_options[:source]
+      @matcher    = @html_options.delete(:matcher)
+      @source     = @html_options.delete(:source)
+      @class_name = @html_options.delete(:class_name)
     end
 
     def generate
       merge_classes if is_match?
-      cleanup
-
       self
     end
 
@@ -27,7 +26,8 @@ module SelectedLinks
     end
 
     def merge_classes
-      @html_options.merge!({class: 'selected'}) { |key, old_v, new_v| [old_v, new_v].join(' ') }
+      name = @class_name || SelectedLinks.default_class_name
+      @html_options.merge!({class: name}) { |key, old_v, new_v| [old_v, new_v].join(' ') }
     end
 
     def is_match?
@@ -45,18 +45,5 @@ module SelectedLinks
       return false unless matcher # nil.to_s returns ""
       source =~ /#{matcher}/i
     end
-
-    def cleanup
-      remove_matcher
-      remove_source
-    end
-
-    def remove_matcher
-      @html_options.delete(:matcher)
-    end
-
-    def remove_source
-      @html_options.delete(:source)
-    end
   end
 end

data/lib/selected_links/version.rb

@@ -1,3 +1,3 @@
 module SelectedLinks
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/selected_links/link_spec.rb

@@ -15,11 +15,6 @@ describe SelectedLinks::Link do
         it "should have options" do
           @link.options.should eq 'options'
         end
-
-        it "should have have html_options of a hash with two items" do
-          @link.html_options.should be_a(Hash)
-          @link.html_options.size.should eq 2
-        end
       end
 
       context "with a block" do
@@ -37,11 +32,6 @@ describe SelectedLinks::Link do
           it "should have options" do
             @link.options.should eq 'options'
           end
-
-          it "should have have html_options of a hash with two items" do
-            @link.html_options.should be_a(Hash)
-            @link.html_options.size.should eq 2
-          end
         end
       end
     end
@@ -52,22 +42,6 @@ describe SelectedLinks::Link do
       @link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'foo')
     end
 
-    it "should remove source option" do
-      @link.send(:remove_source)
-      @link.html_options.has_key?(:source).should be_false
-    end
-
-    it "should remove matcher option" do
-      @link.send(:remove_matcher)
-      @link.html_options.has_key?(:matcher).should be_false
-    end
-
-    it "should remove both source and matcher options" do
-      @link.send(:cleanup)
-      @link.html_options.has_key?(:source).should be_false
-      @link.html_options.has_key?(:matcher).should be_false
-    end
-
     describe "url_match?" do
       it "should return true when url matches given strig" do
         @link.send(:url_match?, '/hello', 'hello').should be_true
@@ -120,44 +94,136 @@ describe SelectedLinks::Link do
   end
 
   describe "fully constructed link" do
-    context "with a matcher link" do
-      it "should have a class of selected added" do
-        @link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'foo').generate
-        @link.html_options[:class].should =~ /selected/
+    describe "with default class name" do
+      context "with a matcher link" do
+        it "should have a class of active added" do
+          @link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'foo').generate
+          @link.html_options[:class].should =~ /active/
+        end
+
+        it "should not have a class of active if there was not a match" do
+          @link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'bar').generate
+          @link.html_options[:class].should_not =~ /active/
+        end
       end
 
-      it "should not have a class of selected if there was not a match" do
-        @link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'bar').generate
-        @link.html_options[:class].should_not =~ /selected/
+      context "with a named link" do
+        it "should have a class of active added" do
+          @link = SelectedLinks::Link.new('Foo', 'options', :source => '/foo').generate
+          @link.html_options[:class].should =~ /active/
+        end
+
+        it "should not have a class of active if there was not a match" do
+          @link = SelectedLinks::Link.new('Bar', 'options', :source => '/foo').generate
+          @link.html_options[:class].should_not =~ /active/
+        end
+      end
+
+      context "with an existing class" do
+        it "should have a class of active added" do
+          @link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'foo', :class => 'nav').generate
+          @link.html_options[:class].should =~ /active/
+        end
+
+        it "should not have a class of active if there was not a match" do
+          @link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'bar', :class => 'nav').generate
+          @link.html_options[:class].should_not =~ /active/
+        end
+
+        it 'should have a space between the existing classes and the active class' do
+          @link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'foo', :class => 'nav').generate
+          @link.html_options[:class].should == 'nav active'
+        end
       end
     end
 
-    context "with a named link" do
-      it "should have a class of selected added" do
-        @link = SelectedLinks::Link.new('Foo', 'options', :source => '/foo').generate
-        @link.html_options[:class].should =~ /selected/
+    describe "with a passed in class name" do
+      context "with a matcher link" do
+        it "should have a class of passed added" do
+          @link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'foo', :class_name => 'passed').generate
+          @link.html_options[:class].should =~ /passed/
+        end
+
+        it "should not have a class of passed if there was not a match" do
+          @link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'bar', :class_name => 'passed').generate
+          @link.html_options[:class].should_not =~ /passed/
+        end
+      end
+
+      context "with a named link" do
+        it "should have a class of passed added" do
+          @link = SelectedLinks::Link.new('Foo', 'options', :source => '/foo', :class_name => 'passed').generate
+          @link.html_options[:class].should =~ /passed/
+        end
+
+        it "should not have a class of passed if there was not a match" do
+          @link = SelectedLinks::Link.new('Bar', 'options', :source => '/foo', :class_name => 'passed').generate
+          @link.html_options[:class].should_not =~ /passed/
+        end
       end
 
-      it "should not have a class of selected if there was not a match" do
-        @link = SelectedLinks::Link.new('Bar', 'options', :source => '/foo').generate
-        @link.html_options[:class].should_not =~ /selected/
+      context "with an existing class" do
+        it "should have a class of passed added" do
+          @link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'foo', :class_name => 'passed', :class => 'nav').generate
+          @link.html_options[:class].should =~ /passed/
+        end
+
+        it "should not have a class of passed if there was not a match" do
+          @link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'bar', :class_name => 'passed', :class => 'nav').generate
+          @link.html_options[:class].should_not =~ /passed/
+        end
+
+        it 'should have a space between the existing classes and the passed class' do
+          @link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'foo', :class_name => 'passed', :class => 'nav').generate
+          @link.html_options[:class].should == 'nav passed'
+        end
       end
     end
 
-    context "with an existing class" do
-      it "should have a class of selected added" do
-        @link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'foo', :class => 'nav').generate
-        @link.html_options[:class].should =~ /selected/
+    describe "with a overridden default class name" do
+      before :each do
+        SelectedLinks.default_class_name = 'selected'
+      end
+
+      context "with a matcher link" do
+        it "should have a class of selected added" do
+          @link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'foo').generate
+          @link.html_options[:class].should =~ /selected/
+        end
+
+        it "should not have a class of selected if there was not a match" do
+          @link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'bar').generate
+          @link.html_options[:class].should_not =~ /selected/
+        end
       end
 
-      it "should not have a class of selected if there was not a match" do
-        @link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'bar', :class => 'nav').generate
-        @link.html_options[:class].should_not =~ /selected/
+      context "with a named link" do
+        it "should have a class of selected added" do
+          @link = SelectedLinks::Link.new('Foo', 'options', :source => '/foo').generate
+          @link.html_options[:class].should =~ /selected/
+        end
+
+        it "should not have a class of selected if there was not a match" do
+          @link = SelectedLinks::Link.new('Bar', 'options', :source => '/foo').generate
+          @link.html_options[:class].should_not =~ /selected/
+        end
       end
 
-      it 'should have a space between the existing classes and the selected class' do
-        @link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'foo', :class => 'nav').generate
-        @link.html_options[:class].should == 'nav selected'
+      context "with an existing class" do
+        it "should have a class of selected added" do
+          @link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'foo', :class => 'nav').generate
+          @link.html_options[:class].should =~ /selected/
+        end
+
+        it "should not have a class of selected if there was not a match" do
+          @link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'bar', :class => 'nav').generate
+          @link.html_options[:class].should_not =~ /selected/
+        end
+
+        it 'should have a space between the existing classes and the selected class' do
+          @link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'foo', :class => 'nav').generate
+          @link.html_options[:class].should == 'nav selected'
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: selected_links
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Kainage
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-28 00:00:00.000000000 Z
+date: 2013-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Adds a link helper to ActionView to that adds a class of 'selected' when