linkety 0.1.0

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/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Derrick Reimer
+
+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,29 @@
+# Linkety
+
+Linkety is a collection of handy link helpers for Rails views.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'linkety'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install linkety
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test

data/lib/linkety.rb

@@ -0,0 +1,3 @@
+require "linkety/version"
+require "linkety/view_helpers"
+require "linkety/railtie" if defined?(Rails)

data/lib/linkety/railtie.rb

@@ -0,0 +1,9 @@
+require "linkety/view_helpers"
+
+module Linkety
+  class Railtie < Rails::Railtie
+    initializer "linkety.view_helpers" do
+      ActionView::Base.send(:include, ViewHelpers)
+    end
+  end
+end

data/lib/linkety/version.rb

@@ -0,0 +1,3 @@
+module Linkety
+  VERSION = "0.1.0"
+end

data/lib/linkety/view_helpers.rb

@@ -0,0 +1,112 @@
+module Linkety
+  module ViewHelpers
+    # Public: Generates an HTML anchor tag in either an active or inactive 
+    # state, depending on a given truth value.
+    # 
+    # If the truth value is true, this method will generate a link 
+    # that has an 'active' class (or whatever class name you optionally
+    # specify for :active_class). 
+    #
+    # If the truth value is false, this method will generate a link by 
+    # default with an href of '#' (or whatever you specify for :inactive_url) 
+    # and with an added 'inactive' class (or whatever you specify for 
+    # :inactive_class).
+    #
+    # truth   - A Boolean truth value.
+    # text    - A String of anchor text.
+    # url     - A String URL.
+    # options - A Hash of options. In addition to the regular #link_to options,
+    #           you may set the following:
+    #           :active_class   - A String class to add if the link is active 
+    #                             (default: 'active').
+    #           :inactive_class - A String class to add if the link is inactive
+    #                             (default: 'inactive').
+    #           :inactive_url   - A String URL for when the link is inactive
+    #                             (default: '#').
+    #
+    # Returns a String anchor tag.
+    def active_link_to_if(truth, text, url, options = {})
+      active_class   = options[:active_class]   || "active"
+      inactive_class = options[:inactive_class] || "inactive"
+      inactive_url   = options[:inactive_url]   || "#"
+      klasses        = (options.delete(:class)  || "").split(' ')
+      
+      klasses << (truth ? active_class : inactive_class)
+      url = inactive_url unless truth
+      
+      link_to(text, url, options.merge(:class => klasses.join(' ')))
+    end
+    
+    # Public: Generates an HTML anchor tag in either an inactive or active 
+    # state, depending on a given truth value. (See #active_link_to_if for more 
+    # details.)
+    #
+    # truth   - A Boolean truth value.
+    # text    - A String of anchor text.
+    # url     - A String URL.
+    # options - A Hash of options. In addition to the regular #link_to options,
+    #           you may set the following:
+    #           :active_class   - A String class to add if the link is active 
+    #                             (default: 'active').
+    #           :inactive_class - A String class to add if the link is inactive
+    #                             (default: 'inactive').
+    #           :inactive_url   - A String URL for when the link is inactive
+    #                             (default: '#').
+    #
+    # Returns a String anchor tag.
+    def inactive_link_to_if(truth, text, url, options = {})
+      active_link_to_if(!truth, text, url, options)
+    end
+    
+    # Public: Generates an HTML anchor tag that has a 'current' class if
+    # the current request path matches the link path.
+    #
+    # text    - A String of anchor text.
+    # url     - A String URL.
+    # options - A Hash of options. In addition to the regular #link_to options,
+    #           you may set the following:
+    #           :current_class - The String class to add if the link is current
+    #                            (default: 'current').
+    #           :pattern       - A Regexp pattern to match against the current 
+    #                            path (default: the link URL path).
+    #
+    # Returns a String anchor tag.
+    def current_link_to(text, url, options = {})
+      current_class = options[:current_class] || "current"
+      klasses       = (options.delete(:class) || "").split(' ')
+      href_path     = extract_path(url)
+      pattern       = options[:pattern] || Regexp.new(href_path)
+
+      klasses << current_class if current_path =~ pattern
+      link_to(text, url, options.merge(:class => klasses.join(' ')))
+    end
+    
+    # Private: The path of the current request.
+    #
+    # Returns a String.
+    def current_path
+      raise "A Request object must be present" unless request
+      fullpath = request.fullpath.split("?")[0]
+      extract_path(fullpath)
+    end
+    
+    # Private: Extract just the path portion of a URL without the query string.
+    #
+    # uri - A String URL.
+    #
+    # Examples
+    #
+    #   extract_path("http://google.com/foo/bar")
+    #   => "/foo/bar"
+    #
+    #   extract_path("/foo/bar/que?order=asc")
+    #   => "/foo/bar/que"
+    #
+    # Returns a String.
+    def extract_path(uri)
+      matches = /(^\w+)*(:\/\/){0,1}(\w|\.)*(\/.*)/.match(uri)
+      path = matches ? matches[4] : ""
+      path.split("?")[0] || ""
+    end
+  end
+end

data/linkety.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/linkety/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Derrick Reimer"]
+  gem.email         = ["derrickreimer@gmail.com"]
+  gem.description   = %q{A collection of handy link helpers for Rails views}
+  gem.summary       = %q{Linkety is a collection of handy link helpers for Rails views.}
+  gem.homepage      = "https://github.com/djreimer/linkety"
+
+  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.name          = "linkety"
+  gem.require_paths = ["lib"]
+  gem.version       = Linkety::VERSION
+  
+  gem.add_development_dependency "shoulda-context", "~> 1.0"
+  gem.add_development_dependency "activesupport", "~> 3.0"
+  gem.add_development_dependency "actionpack", "~> 3.0"
+end

data/test/linkety/view_helpers_test.rb

@@ -0,0 +1,188 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+class Linkety::ViewHelpersTest < Test::Unit::TestCase
+  include ActionView::Helpers::UrlHelper
+  include Linkety::ViewHelpers
+  
+  attr_accessor :request
+  
+  def request_for_path(path)
+    request = MiniTest::Mock.new
+    request.expect(:fullpath, path)
+    request
+  end
+  
+  def extract_text(tag)
+    groups = /<a.*>(.*)<\/a>/.match(tag)
+    text = groups ? groups[1].to_s : ""
+  end
+  
+  def extract_attribute(attribute, tag)
+    groups = /#{attribute}=("|')([^"']*)("|')/.match(tag)
+    klasses = groups ? groups[2] : ""
+    klasses.split(' ') || []
+  end
+  
+  def extract_classes(tag)
+    extract_attribute("class", tag)
+  end
+  
+  def extract_href(tag)
+    extract_attribute("href", tag)[0] || ""
+  end
+  
+  context "test helpers" do
+    context "#extract_classes" do
+      should "work with single quotes" do
+        tag = "<a href='http://google.com' class='one two three'>Google</a>"
+        assert_equal ["one", "two", "three"], extract_classes(tag)
+      end
+
+      should "work with double quotes" do
+        tag = "<a href='http://google.com' class=\"one two three\">Google</a>"
+        assert_equal ["one", "two", "three"], extract_classes(tag)
+      end
+      
+      should "return an empty array if no classes" do
+        tag = "<a href='http://google.com' class=''>Google</a>"
+        assert_equal [], extract_classes(tag)
+      end
+      
+      should "return an empty array if class attribute not set" do
+        tag = "<a href='http://google.com'>Google</a>"
+        assert_equal [], extract_classes(tag)
+      end
+    end
+
+    context "#extract_href" do
+      should "return the URL" do
+        tag = "<a href='http://google.com' class='one two three'>Google</a>"
+        assert_equal "http://google.com", extract_href(tag)
+      end
+      
+      should "return an empty string if href is not set" do
+        tag = "<a class='one two three'>Google</a>"
+        assert_equal "", extract_href(tag)
+      end
+    end
+    
+    context "#extract_text" do
+      should "return the anchor text" do
+        tag = "<a href='http://google.com' class='one two three'>Google</a>"
+        assert_equal "Google", extract_text(tag)
+      end
+      
+      should "return an empty string if link has not text" do
+        tag = "<a href='http://google.com' class='one two three'></a>"
+        assert_equal "", extract_text(tag)
+      end
+    end
+  end
+  
+  context "#active_link_to_if" do
+    should "be active if true" do
+      tag = active_link_to_if(true, "Foobar", "http://google.com")
+      assert extract_classes(tag).include?("active")
+    end
+    
+    should "be inactive if false" do
+      tag = active_link_to_if(false, "Foobar", "http://google.com")
+      assert extract_classes(tag).include?("inactive")
+    end
+    
+    should "change inactive URL to a hash" do
+      tag = active_link_to_if(false, "Foobar", "http://google.com")
+      assert_equal "#", extract_href(tag)
+    end
+    
+    should "append to given classes" do
+      tag = active_link_to_if(false, "Foobar", "http://google.com", :class => "one two")
+      klasses = extract_classes(tag)
+      assert klasses.include?("one")
+      assert klasses.include?("two")
+      assert klasses.include?("inactive")
+    end
+    
+    should "use custom active class" do
+      tag = active_link_to_if(true, "Foobar", "http://google.com", :active_class => "enabled")
+      assert extract_classes(tag).include?("enabled")
+    end
+    
+    should "use custom inactive class" do
+      tag = active_link_to_if(false, "Foobar", "http://google.com", :active_class => "disabled")
+      assert extract_classes(tag).include?("disabled")
+    end
+    
+    should "use custom inactive URL" do
+      tag = active_link_to_if(false, "Foobar", "http://google.com", :inactive_url => "http://yahoo.com")
+      assert_equal "http://yahoo.com", extract_href(tag)
+    end
+    
+    should "have the right text" do
+      tag = active_link_to_if(true, "Foobar", "http://google.com")
+      assert_equal "Foobar", extract_text(tag)
+    end
+  end
+  
+  context "#current_link_to_if" do
+    should "match current for full URL links" do
+      @request = request_for_path("/search")
+      tag = current_link_to("Google", "http://google.com/search")
+      assert extract_classes(tag).include?("current")
+    end
+    
+    should "not match different full URL links" do
+      @request = request_for_path("http://google.com/foo")
+      tag = current_link_to("Google", "http://google.com/search")
+      assert !extract_classes(tag).include?("current")
+    end
+    
+    should "match current for path links" do
+      @request = request_for_path("/search")
+      tag = current_link_to("Google", "/search")
+      assert extract_classes(tag).include?("current")
+    end
+    
+    should "not match different path links" do
+      @request = request_for_path("/foo")
+      tag = current_link_to("Google", "http://google.com/search")
+      assert !extract_classes(tag).include?("current")
+    end
+    
+    should "match root path" do
+      @request = request_for_path("/")
+      tag = current_link_to("Google", "http://google.com/")
+      assert extract_classes(tag).include?("current")
+    end
+    
+    should "match current with a query string" do
+      @request = request_for_path("/search?q=ruby")
+      tag = current_link_to("Google", "http://google.com/search")
+      assert extract_classes(tag).include?("current")
+    end
+    
+    should "match current with additional segments" do
+      @request = request_for_path("/search/foo/bar")
+      tag = current_link_to("Google", "http://google.com/search")
+      assert extract_classes(tag).include?("current")
+    end
+    
+    should "use custom current class" do
+      @request = request_for_path("/search")
+      tag = current_link_to("Google", "http://google.com/search", :current_class => "active")
+      assert extract_classes(tag).include?("active")
+    end
+    
+    should "use custom pattern" do
+      @request = request_for_path("/foobar")
+      tag = current_link_to("Google", "http://google.com/search", :pattern => /foobar/)
+      assert extract_classes(tag).include?("current")
+    end
+    
+    should "have the right text" do
+      @request = request_for_path("/")
+      tag = current_link_to("Foobar", "http://google.com/")
+      assert_equal "Foobar", extract_text(tag)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'linkety'
+require 'minitest/autorun'
+require 'shoulda-context'
+require 'action_view'

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: linkety
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Derrick Reimer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-22 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda-context
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :development
+  version_requirements: *id003
+description: A collection of handy link helpers for Rails views
+email: 
+- derrickreimer@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/linkety.rb
+- lib/linkety/railtie.rb
+- lib/linkety/version.rb
+- lib/linkety/view_helpers.rb
+- linkety.gemspec
+- test/linkety/view_helpers_test.rb
+- test/test_helper.rb
+homepage: https://github.com/djreimer/linkety
+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.24
+signing_key: 
+specification_version: 3
+summary: Linkety is a collection of handy link helpers for Rails views.
+test_files: 
+- test/linkety/view_helpers_test.rb
+- test/test_helper.rb