ryana-link_block 0.1.0

data/README.rdoc

@@ -0,0 +1,76 @@
+= LinkBlock
+
+LinkBlock lets you create a bunch of links that share options.
+
+== Examples
+
+  <%- link_block :controller => 'main' do |lb| -%>
+    <%= lb.link_to 'Home', :action => 'index' %>
+    <%= lb.link_to 'Products', :action => 'products' %>
+    <%= lb.link_to 'Locations', :action => 'locations' %>
+    <%= lb.link_to 'Contact', :action => 'contact' %>
+  <%- end -%>
+
+is the same as doing:
+
+  <%= link_to 'Home', :controller => 'main', :action => 'index' %>
+  <%= link_to 'Products', :controller => 'main', :action => 'products' %>
+  <%= link_to 'Locations', :controller => 'main', :action => 'locations' %>
+  <%= link_to 'Contact', :controller => 'main', :action => 'contact' %>
+
+It also supports merging html options:
+
+  <%- link_block {:controller => 'main'}, {:class => 'side_bar_link'} do |lb| -%>
+    <%= lb.link_to 'Home', :action => 'index' %>
+  <%- end -%>
+
+And appending to string routes (if you INSIST on using string routes) instead of hashes:
+
+  <%- link_block '/main/' do |lb| -%>
+    <%= lb.link_to 'Index Page', 'index' %>
+  <%- end -%>
+
+The current link gets a link_block_current appended to the class list.  This can be changed through
+the LinkBlock::Config object:
+
+  LinkBlock::Config.current_link_class = "different_name"
+
+or turned off via:
+
+  LinkBlock::Config.current_link_enabled = false
+
+== Todo
+
+Now relies on PlugTest for testing.  http://github.com/ryana/plug_test
+
+== Thanks
+
+* Dan Pickett (http://dpickett.github.com) for providing the Gem template and moral support.
+ 
+== Shameless Plug
+
+Recommend me on Working With Rails (http://workingwithrails.com/recommendation/new/person/14860-ryan-angilly) or give
+me a shout out on Twitter (http://twitter.com/angilly) @angilly if you think this is awesome.
+
+== MIT License
+
+=== Copyright (c) 2008 Ryan Angilly
+
+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/Rakefile

@@ -0,0 +1,18 @@
+# Lifted directly from http://railscasts.com/episodes/135-making-a-gem
+#
+# Thanks Ryan B.
+
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('link_block', '0.1.0') do |p|
+  p.description    = "Generate a block of link_to's that share parameters."
+  p.url            = "http://github.com/ryana/link_block"
+  p.author         = "Ryan Angilly"
+  p.email          = "ryan@angilly.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/init.rb

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

data/lib/link_block/config.rb

@@ -0,0 +1,9 @@
+module LinkBlock
+  class Config
+    cattr_accessor :current_class_name
+    @@current_class_name = "current_link"
+
+    cattr_accessor :current_class_enabled
+    @@current_class_enabled = true
+  end
+end

data/lib/link_block/view_helpers.rb

@@ -0,0 +1,56 @@
+module LinkBlock
+  module ViewHelpers
+
+    class LinkBlockBuilder
+
+      def initialize(controller, options)
+        @controller = controller
+        @url_options = options[:url_options]
+        @html_options = options[:html_options]
+      end
+
+      def link_to(*args, &block)
+        if block_given?
+          url_options = get_url_options(args.first)
+          html_options = args.second.merge(@html_options)
+          link_to(capture(&block), url_options, html_options)
+        else
+          link_text = args.first
+          url_options = get_url_options(args.second)
+          html_options = (args.third || {}).merge(@html_options)
+        end
+
+        if LinkBlock::Config.current_class_enabled and @controller.current_page?(url_options)
+          html_options[:class] ||= ""
+          html_options[:class] += " #{LinkBlock::Config.current_class_name}"
+        end
+
+        @controller.link_to(link_text, url_options, html_options) 
+      end
+
+      private
+      def get_url_options(url)
+        raise 'url params mismatch' unless url.class == @url_options.class
+
+        @url_options.class == Hash ? url.merge(@url_options) : @url_options + url
+      end
+
+    end
+
+    def link_block(*args, &block)
+      url_options = args.first
+      html_options = args.second || {}
+
+      if html_options and html_options.class != Hash
+        raise 'link_block requires html_options to be a Hash'
+      end
+
+      if url_options.class != Hash and url_options.class != String
+        raise 'link_block requires url_options to be Hash or String -- and for your sake it really should be a Hash :-)'
+      end
+
+      yield LinkBlockBuilder.new(self, :url_options => url_options, :html_options => html_options)
+    end
+
+  end
+end

data/lib/link_block.rb

@@ -0,0 +1,17 @@
+# The dirname is important, otherwise if rubygems is loaded before this,
+# (as is the case if you are using PlugTest), then the require will get
+# the installed gem instead of what you are developing.
+
+require File.dirname(__FILE__) + '/link_block/config'
+require File.dirname(__FILE__) + '/link_block/view_helpers'
+
+module LinkBlock
+  def self.enable
+    ActionView::Base.send :include, LinkBlock::ViewHelpers
+  end
+end
+ 
+#thanks will_paginate (via dpickett-tab_menu) for this snippet
+if defined?(Rails) and defined?(ActionController)
+  LinkBlock.enable
+end

data/link_block.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{link_block}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Angilly"]
+  s.date = %q{2008-12-19}
+  s.description = %q{Generate a block of link_to calls that share parameters.}
+  s.email = %q{ryan@angilly.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/link_block.rb", "lib/link_block/config.rb", "lib/link_block/view_helpers.rb"]
+  s.files = ["Manifest", "README.rdoc", "init.rb", "lib/link_block.rb", "lib/link_block/config.rb", "lib/link_block/view_helpers.rb", "test/link_block_test.rb", "Rakefile", "link_block.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/ryana/link_block}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Link_block", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{link_block}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Generate a block of link_to's that share parameters.}
+  s.test_files = ["test/link_block_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/link_block_test.rb

@@ -0,0 +1,39 @@
+require 'rubygems'
+require File.dirname(__FILE__) + '/test_helper'
+require File.dirname(__FILE__) + '/../lib/link_block'
+
+class LinkBlockTest < Test::Unit::TestCase
+
+  def setup
+    pt_setup
+  end
+
+  def test_link_block_exists
+    # Make sure we're sane
+    assert @helper.respond_to?(:link_to)
+
+    # Make sure we're included
+    assert @helper.respond_to?(:link_block)
+  end
+
+  def test_link_block_yields_simple_link_tos
+    # Tried to make this a block... was taking too long.
+    res = pt_helper do |a|
+      a.link_block(:controller => 'regular') { |lb| lb.link_to 'Sweet', :action => 'test' }
+    end
+
+    assert_select 'a', 'Sweet'
+    assert_select HTML::Selector.new("a[href=/regular/test]")
+  end
+
+  def test_link_block_attaches_class_when_link_is_current
+    res = pt_helper do |a|
+      a.link_block(:controller => 'plug_test') { |lb| lb.link_to 'Sweet', :action => 'test_action' }
+    end
+
+    assert_select 'a', 'Sweet'
+    assert_select HTML::Selector.new("a[class~=#{LinkBlock::Config.current_class_name}]")
+    assert_select HTML::Selector.new("a[href=/plug_test/test_action]")
+  end
+
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: ryana-link_block
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ryan Angilly
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-19 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Generate a block of link_to calls that share parameters.
+email: ryan@angilly.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/link_block.rb
+- lib/link_block/config.rb
+- lib/link_block/view_helpers.rb
+files: 
+- Manifest
+- README.rdoc
+- init.rb
+- lib/link_block.rb
+- lib/link_block/config.rb
+- lib/link_block/view_helpers.rb
+- test/link_block_test.rb
+- Rakefile
+- link_block.gemspec
+has_rdoc: true
+homepage: http://github.com/ryana/link_block
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Link_block
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: link_block
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Generate a block of link_to's that share parameters.
+test_files: 
+- test/link_block_test.rb