selected_links 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a72ed39a28bc86f1968e5917acf8d22bcafbc4ae
-  data.tar.gz: 06fe422e7a22075166d2a18c1a23ff8979e49c7e
+  metadata.gz: 62a30a37be7b8ed9394a6c728b664f415a7132ee
+  data.tar.gz: a0b6aa5bb7c513ebb8b81a1cd89788425ee72034
 SHA512:
-  metadata.gz: 92fcbf275164b2e9f23395fde587ac2762b323aba350016b4063bb95eaab2ccf62445dd9811f37219705a1d6220d6992e8f3fe629145501a23694b4b1957a3b2
-  data.tar.gz: 1773584622c80ad0f56234d433d9f7102b464b834c512cb7bd10bba5387e9fb1cff3fbf4afdd871bc0f7a8bcacbb39c12fe01bdc8691e04b6124782d3cd89559
+  metadata.gz: 390d347634eeacedf9a152afb93f73def7045399ee5f87932acd291ae27a4fb5caf480216e2e8c55df0ec31c82b48d467eb80aeecd743e6209d7c1f4b84b73c8
+  data.tar.gz: 9c24559d76be4f71a83814976d0c50fa78c278f0514418f81a7d51fb783e27d95c8c40c4ca0adcec578fa9fa19b8db2f51ba93e944cc25e91d4efc8ffd341cb9

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 .project
+/nbproject

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.0.2
+
+* Added fallback behaviour support via initializer setting
+
 ## v0.0.1
 
 * Initial Release

data/README.md

@@ -1,4 +1,6 @@
-# SelectedLinks
+# Selected Links
+
+[![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_
 to the link when matched to a pattern, usually a url.
@@ -29,6 +31,14 @@ SelectedLinks.setup do |config|
 end
 ```
 
+You can also change the fallback behaviour to check the name if the matcher fails
+
+```ruby
+SelectedLinks.setup do |config|
+  config.fallback_to_name = false
+end
+```
+
 ### Useage
 
 To make this link have a class of _selected_ when the url is at the top level:

data/lib/selected_links/action_view.rb

@@ -1,41 +1,41 @@
 require 'action_view'
 
 module SelectedLinks
-	# Usage is the same as link_to and takes an optional regex argument matcher.
-	#
-	#   <%= selectable_link_to 'Home', root_url, :matcher => '\/\z' %>
-	#
-	# That would make this link have a class of 'selected' when the url is at the top level.
-	#
-	#   <%= selectable_link_to 'Topics', topics_url, :matcher => 'topic' %>
-	#
-	# This will make the nav link selected when the url has 'topic' in it anywhere.
-	#
-	#   <% selectable_link_to community_url, :matcher => 'topic' do %>
-	#     <%= content_tag :span, 'Community', :class => 'foo' %>
-	#   <% end %>
-	#
-	# Blocks still work and this will do the same thing as the previous example.
-	#
-	#  <%= selectable_link_to 'ABOUT', about_url %>
-	#
-	# Without a matcher option and NOT in the block form, this will look for 'about' in the url.
-	module ActionView
-		def selectable_link_to(*args, &block)
-			link = Link.new(*args, &block).generate
+  # Usage is the same as link_to and takes an optional regex argument matcher.
+  #
+  #   <%= selectable_link_to 'Home', root_url, :matcher => '\/\z' %>
+  #
+  # That would make this link have a class of 'selected' when the url is at the top level.
+  #
+  #   <%= selectable_link_to 'Topics', topics_url, :matcher => 'topic' %>
+  #
+  # This will make the nav link selected when the url has 'topic' in it anywhere.
+  #
+  #   <% selectable_link_to community_url, :matcher => 'topic' do %>
+  #     <%= content_tag :span, 'Community', :class => 'foo' %>
+  #   <% end %>
+  #
+  # Blocks still work and this will do the same thing as the previous example.
+  #
+  #  <%= selectable_link_to 'ABOUT', about_url %>
+  #
+  # Without a matcher option and NOT in the block form, this will look for 'about' in the url.
+  module ActionView
+    def selectable_link_to(*args, &block)
+      link = Link.new(*args, &block).generate
 
-			# Add default source if none was given.
-			unless link.source
-				link.source = instance_eval(SelectedLinks.default_source)
-				# Can run generate again because there will for sure be no match here yet.
-				link.generate
-			end
+      # Add default source if none was given.
+      unless link.source
+        link.source = instance_eval(SelectedLinks.default_source)
+        # Can run generate again because there will for sure be no match here yet.
+        link.generate
+      end
 
-			if block_given?
-				raw link_to link.options, link.html_options, &block
-			else
-				raw link_to link.name, link.options, link.html_options
-			end
-		end
-	end
+      if block_given?
+        raw link_to link.options, link.html_options, &block
+      else
+        raw link_to link.name, link.options, link.html_options
+      end
+    end
+  end
 end

data/lib/selected_links/link.rb

@@ -1,55 +1,62 @@
 module SelectedLinks
-	class Link
-		attr_reader :name, :options, :html_options
-		attr_accessor :source
-
-		def initialize(*args, &block)
-			@name, @options, @html_options = parse_args(block_given?, *args)
-			@matcher = @html_options[:matcher]
-			@source = @html_options[:source]
-		end
-
-		def generate
-			merge_classes if is_match?
-			cleanup
-
-			self
-		end
-
-		private
-
-		def parse_args(block, *args)
-			if block
-				[nil, args.first, args.second || {}]
-			else
-				[args[0], args[1], args[2] || {}]
-			end
-		end
-
-		def merge_classes
-			@html_options.merge!({class: 'selected'}) { |key, old_v, new_v| [old_v, new_v].join(' ') }
-		end
-
-		def is_match?
-			url_match?(@source, @matcher) || url_match?(@source, @name)
-		end
-
-		def url_match?(source, matcher)
-			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
+  class Link
+    attr_reader :name, :options, :html_options
+    attr_accessor :source
+
+    def initialize(*args, &block)
+      @name, @options, @html_options = parse_args(block_given?, *args)
+      @matcher = @html_options[:matcher]
+      @source = @html_options[:source]
+    end
+
+    def generate
+      merge_classes if is_match?
+      cleanup
+
+      self
+    end
+
+    private
+
+    def parse_args(block, *args)
+      if block
+        [nil, args.first, args.second || {}]
+      else
+        [args[0], args[1], args[2] || {}]
+      end
+    end
+
+    def merge_classes
+      @html_options.merge!({class: 'selected'}) { |key, old_v, new_v| [old_v, new_v].join(' ') }
+    end
+
+    def is_match?
+      # Always return true if the source and the matcher match.
+      return true if url_match?(@source, @matcher)
+      # If not check for fallback and presence of @matcher and check again if necessary.
+      if (@matcher && SelectedLinks.fallback_to_name) || !@matcher
+        return url_match?(@source, @name)
+      else
+        return false
+      end
+    end
+
+    def url_match?(source, matcher)
+      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/railtie.rb

@@ -1,9 +1,9 @@
 module SelectedLinks
-	class Railtie < Rails::Railtie
-		initializer 'selected_links.action_view_extension' do
-			ActiveSupport.on_load :action_view do
-				include ActionView
-			end
-		end
-	end
+  class Railtie < Rails::Railtie
+    initializer 'selected_links.action_view_extension' do
+      ActiveSupport.on_load :action_view do
+        include ActionView
+      end
+    end
+  end
 end

data/lib/selected_links/version.rb

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

data/lib/selected_links.rb

@@ -3,16 +3,19 @@ require 'selected_links/link'
 require 'selected_links/action_view'
 
 if defined? Rails
-	require 'selected_links/railtie'
+  require 'selected_links/railtie'
 else
-	ActionView::Base.send(:include, SelectedLinks::ActionView)
+  ActionView::Base.send(:include, SelectedLinks::ActionView)
 end
 
 module SelectedLinks
-	mattr_accessor :default_source
-	@@default_source = 'request.path'
+  mattr_accessor :default_source
+  @@default_source = 'request.path'
 
-	def self.setup
-		yield self
-	end
+  mattr_accessor :fallback_to_name
+  @@fallback_to_name = false
+
+  def self.setup
+    yield self
+  end
 end

data/spec/selected_links/link_spec.rb

@@ -1,151 +1,164 @@
 require 'spec_helper'
 
 describe SelectedLinks::Link do
-	describe "constructing a link" do
-		context "without a block" do
-			context "with valid options" do
-				before :each do
-					@link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'foo')
-				end
-
-				it "should have a name" do
-					@link.name.should eq 'Name'
-				end
-
-				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
-				context "with valid options" do
-					before :each do
-						@link = SelectedLinks::Link.new 'options', :source => '/foo', :matcher => 'foo' do
-							'Block Content'
-						end
-					end
-
-					it "should not have a name" do
-						@link.name.should be_nil
-					end
-
-					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
-	end
-
-	describe "with valid options" do
-		before :each 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
-			end
-
-			it "should return true when url partially matches string" do
-				@link.send(:url_match?, '/hello', 'ell').should be_true
-			end
-
-			it "should return false when string does not match" do
-				@link.send(:url_match?, '/hello', 'world').should be_false
-			end
-		end
-
-		context "for a matcher match" do
-			it "should return true for a match" do
-				@link.send(:is_match?).should be_true
-			end
-
-			it "should return false for a non match" do
-				@link = SelectedLinks::Link.new('Name', 'options', :source => '/bar', :matcher => 'foo')
-				@link.send(:is_match?).should be_false
-			end
-		end
-
-		context "for a named match" do
-			it "should return true for a named match" do
-				@link = SelectedLinks::Link.new('Foo', 'options', :source => '/foo')
-				@link.send(:is_match?).should be_true
-			end
-
-			it "should return false for a non match" do
-				@link = SelectedLinks::Link.new('Bar', 'options', :source => '/foo')
-				@link.send(:is_match?).should be_false
-			end
-		end
-	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/
-			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
-
-		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
-
-		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
+  describe "constructing a link" do
+    context "without a block" do
+      context "with valid options" do
+        before :each do
+          @link = SelectedLinks::Link.new('Name', 'options', :source => '/foo', :matcher => 'foo')
+        end
+
+        it "should have a name" do
+          @link.name.should eq 'Name'
+        end
+
+        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
+        context "with valid options" do
+          before :each do
+            @link = SelectedLinks::Link.new 'options', :source => '/foo', :matcher => 'foo' do
+              'Block Content'
+            end
+          end
+
+          it "should not have a name" do
+            @link.name.should be_nil
+          end
+
+          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
+  end
+
+  describe "with valid options" do
+    before :each 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
+      end
+
+      it "should return true when url partially matches string" do
+        @link.send(:url_match?, '/hello', 'ell').should be_true
+      end
+
+      it "should return false when string does not match" do
+        @link.send(:url_match?, '/hello', 'world').should be_false
+      end
+    end
+
+    context "for a matcher match" do
+      it "should return true for a match" do
+        @link.send(:is_match?).should be_true
+      end
+
+      it "should return false for a non match" do
+        @link = SelectedLinks::Link.new('Name', 'options', :source => '/bar', :matcher => 'foo')
+        @link.send(:is_match?).should be_false
+      end
+    end
+
+    context "for a named match" do
+      it "should return true for a named match" do
+        @link = SelectedLinks::Link.new('Foo', 'options', :source => '/foo')
+        @link.send(:is_match?).should be_true
+      end
+
+      it "should return false for a non match" do
+        @link = SelectedLinks::Link.new('Bar', 'options', :source => '/foo')
+        @link.send(:is_match?).should be_false
+      end
+    end
+
+    context "fallback to named path" do
+      it "should not fallback by default" do
+        @link = SelectedLinks::Link.new('Foo', 'options', :source => '/foo', :matcher => 'bar')
+        @link.send(:is_match?).should be_false
+      end
+
+      it "should fallback when setting is on" do
+        SelectedLinks.fallback_to_name = true
+        @link = SelectedLinks::Link.new('Foo', 'options', :source => '/foo', :matcher => 'bar')
+        @link.send(:is_match?).should be_true
+      end
+    end
+  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/
+      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
+
+    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
+
+    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.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kainage
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-23 00:00:00.000000000 Z
+date: 2013-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt