selected_links 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a72ed39a28bc86f1968e5917acf8d22bcafbc4ae
+  data.tar.gz: 06fe422e7a22075166d2a18c1a23ff8979e49c7e
+SHA512:
+  metadata.gz: 92fcbf275164b2e9f23395fde587ac2762b323aba350016b4063bb95eaab2ccf62445dd9811f37219705a1d6220d6992e8f3fe629145501a23694b4b1957a3b2
+  data.tar.gz: 1773584622c80ad0f56234d433d9f7102b464b834c512cb7bd10bba5387e9fb1cff3fbf4afdd871bc0f7a8bcacbb39c12fe01bdc8691e04b6124782d3cd89559

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* Initial Release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kainage
+
+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,79 @@
+# SelectedLinks
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'selected_links'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install selected_links
+
+## Configuration
+
+Usage is the same as link_to and takes 2 optional arguments ```:matcher``` and ```:source```.
+
+The default source matches to ```request.path```. This can be overridden in an initializer
+
+```ruby
+SelectedLinks.setup do |config|
+  config.default_source = 'request.url'
+end
+```
+
+### Useage
+
+To make this link have a class of _selected_ when the url is at the top level:
+
+```
+<%= selectable_link_to 'Home', root_url, :matcher => '\/\z' %>
+```
+
+To make the link selected when the url has _topic_ anywhere in it:
+
+```
+<%= selectable_link_to 'Topics', topics_url, :matcher => 'topic' %>
+```
+
+Blocks still work and this will do the same thing as the previous example:
+
+```
+<% selectable_link_to community_url, :matcher => 'topic' do %>
+  <%= content_tag :span, 'Community', :class => 'foo' %>
+<% end %>
+```
+
+Without a matcher option and NOT in the block form, this will look for _about_ in the source:
+
+```
+<%= selectable_link_to 'ABOUT', about_url %>
+```
+
+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>
+```
+
+To override the source per link, just add a ```:source``` argument:
+
+```
+<%= selectable_link_to 'ABOUT', about_url, :source => request.url %>
+```
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/selected_links.rb

@@ -0,0 +1,18 @@
+require "selected_links/version"
+require 'selected_links/link'
+require 'selected_links/action_view'
+
+if defined? Rails
+	require 'selected_links/railtie'
+else
+	ActionView::Base.send(:include, SelectedLinks::ActionView)
+end
+
+module SelectedLinks
+	mattr_accessor :default_source
+	@@default_source = 'request.path'
+
+	def self.setup
+		yield self
+	end
+end

data/lib/selected_links/action_view.rb

@@ -0,0 +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
+
+			# 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
+end

data/lib/selected_links/link.rb

@@ -0,0 +1,55 @@
+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
+end

data/lib/selected_links/railtie.rb

@@ -0,0 +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
+end

data/lib/selected_links/version.rb

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

data/selected_links.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'selected_links/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "selected_links"
+  spec.version       = SelectedLinks::VERSION
+  spec.authors       = ["Kainage"]
+  spec.email         = ["kainage@gmail.com"]
+  spec.description   = %q{Add a selected class to a link when criteria is matched}
+  spec.summary       = %q{Adds a link helper to ActionView to that adds a class of 'selected' when matched to a pattern}
+  spec.homepage      = "https://github.com/kainage/selected_links"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency "actionpack"
+end

data/spec/selected_links/link_spec.rb

@@ -0,0 +1,151 @@
+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
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'selected_links'

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: selected_links
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kainage
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add a selected class to a link when criteria is matched
+email:
+- kainage@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/selected_links.rb
+- lib/selected_links/action_view.rb
+- lib/selected_links/link.rb
+- lib/selected_links/railtie.rb
+- lib/selected_links/version.rb
+- selected_links.gemspec
+- spec/selected_links/link_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kainage/selected_links
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Adds a link helper to ActionView to that adds a class of 'selected' when
+  matched to a pattern
+test_files:
+- spec/selected_links/link_spec.rb
+- spec/spec_helper.rb