helperful 0.5.2

data/CHANGELOG.rdoc

@@ -0,0 +1,71 @@
+= Changelog
+
+
+== Release 0.5.2
+
+* CHANGED: GitHub Gem Building is Defunct. The gem is now hosted on Gemcutter (see http://github.com/blog/515-gem-building-is-defunct)
+
+
+== Release 0.5.1
+
+* ADDED: `canonical_link_tag` helper provides the ability to generate Canonical Link tags used by search engine crawlers to determine the preferred url for a page (closes #255).
+
+* CHANGED: run test against Rails 2.3.x but ensure compatibility with Rails 2.2.x.
+
+
+== Release 0.5.0
+
+* REMOVED: `sidebar` helper. It was nothing special and just a wrapper for a simple Rails execution.
+
+
+== Release 0.4.0
+
+* ADDED: `javascript` and `stylesheet` helpers.
+
+* FIXED: GitHub now requires the Manifest file to be included in the repos.
+
+
+== Release 0.3.1
+
+* FIXED: `javascript_content_for` doesn't properly concat output when called with block (closes #183).
+
+
+== Release 0.3.0
+
+* ADDED: Added `javascript_content_for helper`. `javascript_content_for` combines the features of `content_for` and `javascript_tag` (closes #149).
+
+* FIXED: `has_content?` raises an error when has_content isn't initialized (closes #179).
+
+* CHANGED: Changed status to alpha and removed development warning (closes #151).
+
+
+== Release 0.2.2
+
+* FIXED: The "Unhandled special" error message for real!
+
+
+== Release 0.2.1
+
+* FIXED: RubyGems fails to generate the documentation with the following error message "Unhandled special".
+
+
+== Release 0.2.0
+
+* ADDED: Added Helperful::ContentHelper module (subsequently renamed to Helperful::ContentHelper) with #sidebar helper for passing content_for :sidebar to the layout. Even if this is a really simple method, this method adds a bit of semantic meaning to common application usage of content_for for created sidebars.
+
+* ADDED: Added HelperfulAffiliationsHelper module (subsequently renamed to Helperful::AffiliationsHelper).
+
+* ADDED: Added HelperfulAffiliationsHelper#tradedoubler_verification_tag helper for generating Tradedoubler verifications tags (subsequently renamed to Helperful::AffiliationsHelper).
+
+* ADDED: Added #helperful method as shortcut for including helper modules from the Helperful namespace.
+
+* ADDED: Packaged library as a GEM.
+
+* CHANGED: Renamed TitleHelper to HelperfulTitleHelper to prevent conflicts with other common helpers (subsequently renamed to Helperful::TitleHelper).
+
+* CHANGED: Renamed all helper modules from HelperfulHelperName to Helperful::HelperName.
+
+
+== Release 0.1.0
+
+* ADDED: Imported TitleHelper from Gist.

data/LICENSE.rdoc

@@ -0,0 +1,24 @@
+= License
+
+(The MIT License)
+
+Copyright (c) 2008-2009 Simone Carletti <weppos@weppos.net>
+
+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/Manifest

@@ -0,0 +1,29 @@
+CHANGELOG.rdoc
+helperful.gemspec
+init.rb
+install.rb
+lib/helperful/affiliations_helper.rb
+lib/helperful/asset_tag_helper.rb
+lib/helperful/content_helper.rb
+lib/helperful/deprecations.rb
+lib/helperful/javascript_helper.rb
+lib/helperful/title_helper.rb
+lib/helperful/version.rb
+lib/helperful.rb
+LICENSE.rdoc
+Manifest
+rails/init.rb
+Rakefile
+README.rdoc
+tasks/helperful_tasks.rake
+test/affiliations_helper_test.rb
+test/asset_tag_helper_test.rb
+test/content_helper_test.rb
+test/fixtures/content/has_content.html.erb
+test/fixtures/content/has_content_is_called_alone.html.erb
+test/fixtures/layouts/has_content.html.erb
+test/helperful_test.rb
+test/javascript_helper_test.rb
+test/test_helper.rb
+test/title_helper_test.rb
+uninstall.rb

data/README.rdoc

@@ -0,0 +1,211 @@
+= Helperful
+
+Helperful aims to be a collection of useful and reusable Rails helpers.
+
+
+== Requirements
+
+* Ruby >= 1.8.6
+* Rails >= 2.2.x (tested up to Rails 2.3.3)
+
+
+== Plugin Installation
+
+=== As a Gem
+
+This is the preferred way to install Helperful and the best way if you want install a stable version.
+The GEM is hosted on {Gemcutter}[http://gemcutter.org/gems/helperful].
+
+  $ gem install helperful --source http://gemcutter.org
+
+With Rails >= 2.2, you can specify the GEM dependency in your environment.rb file so that Rails will automatically check the requirement on startup.
+
+  Rails::Initializer.run do |config|
+    
+    # other configurations
+    # ...
+    
+    config.gem "helperful", :source => "http://gemcutter.org"
+
+  end
+
+
+=== As a Plugin
+
+This is the preferred way if you want to live on the edge and install a development version.
+
+  $ script/plugin install git://github.com/weppos/helperful.git
+
+
+== Getting Started
+
+Helper methods are grouped into different files according to their scope.
+
+Before using an helper method you should include the helper file in your Rails application,
+as you would expected to do for a standard Rails helper.
+All helpers belongs to the Helperful namespace to prevent conflicts with default Rails helpers.
+Don't forget to add the namespace when including an helper from your controller.
+
+  class MyController < ApplicationController
+
+    # include the title_helper
+    helper 'helperful/title'
+
+    # include the title_helper passing the qualified the module name
+    helper Helperful::TitleHelper
+
+  end
+
+
+Moreover, the <tt>Helperful</tt> library provides a helpful method called <tt>helperful</tt>.
+It aliases the standard Rails <tt>ActionController::Base#helper</tt> method with the exception that it automatically prepends the <tt>helperful</tt> namespace when necessary.
+
+  class MyController < ApplicationController
+
+    # include the title_helper
+    helperful :title
+
+    # include the title_helper passing the qualified the module name
+    helperful Helperful::TitleHelper
+
+  end
+
+
+The following lines are equivalent:
+
+  helper    'helperful/title'
+  helper    :'helperful/title'
+  helper    Helperful::TitleHelper
+  helperful 'title'
+  helperful :title
+  helperful Helperful::TitleHelper
+
+
+The <tt>helperful</tt> methods accepts any parameter accepted by the original <tt>helper</tt> method.
+
+  helper    'helperful/title', 'helperful/affiliations'
+  helperful :title, :affiliations
+
+
+See the Rails documentation for <tt>ActionController::Base#helper</tt> method
+for more details about how to include an helper into a Rails application.
+
+Once included, all helper methods are available in the View.
+
+  <html>
+    <title><%= title 'This is a title' %></title>
+    <body>
+      <%= yield %>
+    </body>
+  </html>
+
+
+== Helpers
+
+This is a short description of all available helpers.
+Please refer to the documentation available at the beginning of any helper file for further details.
+
+=== Asset Tag Helper
+
+Provides a set of helpers for generating HTML that links views to assets such as images, javascripts, stylesheets, and feeds.
+
+=== Affiliations Helper
+
+Provides a set of helpers for working with online affiliations.
+
+The <tt>tradedoubler_verification_tag</tt> helper method returns the site verification tag required by {Tradedoubler}[http://www.tradedoubler.com/] to verify the publisher account ownership.
+
+  # In your template
+  <html>
+    <head>
+      <%= tradedoubler_verification_tag('00112233') %>
+    </head>
+    <body>
+      This is your page content.
+    </body>
+  </html>
+
+  # Will produce the following output.
+  <html>
+    <head>
+      <%= tradedoubler_verification_tag('00112233') %>
+    </head>
+    <body>
+      <!-- TradeDoubler site verification 00112233 -->
+    </body>
+  </html>
+
+=== Content Helper
+
+Provides a set of helpers for capturing and working with your page content in a more effective way.
+
+The <tt>has_content?</tt> helper is a natural fulfillment for the original <tt>content_for</tt> helper.
+
+  <% content_for :foo do %>
+    <div>This is a foo content.</div>
+  <% end %>
+
+  <% has_content? :foo  # => true %>
+  <% has_content? "foo" # => true %>
+
+
+=== Javascript Helper
+
+Provides a set of helpers for working with JavaScript in your views.
+
+The <tt>javascript_content_for</tt> helper combines the features of <tt>content_for</tt> and <tt>javascript_tag</tt> into a single helper.
+
+  <% javascript_content_for :head do %>
+    $("#id").hide();
+  <% end %>
+
+The code above looks like much more readable than the following one. Isn't it?
+
+  <% javascript_content_for :head do; javascript_tag do %>
+    $("#id").hide();
+  <% end; end %>
+
+
+=== Title Helper
+
+Provides an helper for managing page title in Rails views and layouts.
+
+  # Include the helper in your controller.
+  # You might want to include it in ApplicationController to make it available
+  # always and everywhere in your templates.
+  class ApplicationController < ActionController::Base
+    helperful :title
+  end
+
+  # Now you can use set a title in your action
+  # Example. index.html.rb
+  <h1><%= title 'This is a title' %></h1>
+
+  # And print the title with a :site decorator in your layout.
+  <html>
+    <head>
+      <title><%= title :site => 'My Cool Site!' %></title>
+    </head>
+    <body>
+      <%= yield %>
+    </body>
+  </html>
+
+Originally available at http://gist.github.com/3840.
+
+
+== Credits
+
+Author:: {Simone Carletti}[http://www.simonecarletti.com/] <weppos@weppos.net>
+
+
+== Resources
+
+* {Homepage}[http://code.simonecarletti.com/helperful]
+* {GitHub}[http://github.com/weppos/helperful]
+
+
+== License
+
+Copyright (c) 2008-2009 Simone Carletti, Helperful is released under the MIT license.
+

data/Rakefile

@@ -0,0 +1,47 @@
+$:.unshift(File.dirname(__FILE__) + "/lib")
+
+require 'rubygems'
+require 'rake'
+require 'echoe'
+require 'helperful'
+
+
+PKG_NAME    = ENV['PKG_NAME']    || Helperful::GEM
+PKG_VERSION = ENV['PKG_VERSION'] || Helperful::VERSION
+RUBYFORGE_PROJECT = nil
+
+if ENV['SNAPSHOT'].to_i == 1
+  PKG_VERSION << "." << Time.now.utc.strftime("%Y%m%d%H%M%S")
+end
+ 
+ 
+Echoe.new(PKG_NAME, PKG_VERSION) do |p|
+  p.author        = "Simone Carletti"
+  p.email         = "weppos@weppos.net"
+  p.summary       = "A collection of useful Rails helpers."
+  p.url           = "http://code.simonecarletti.com/helperful"
+  p.project       = RUBYFORGE_PROJECT
+  p.description   = <<-EOD
+    Helperful aims to be a collection of useful and reusable Rails helpers.
+  EOD
+
+  p.need_zip      = true
+
+  p.development_dependencies += ["rake  ~>0.8",
+                                 "echoe ~>3.1",
+                                 "mocha ~>0.9.7"]
+
+  p.rcov_options  = ["-Itest -x mocha,rcov,Rakefile"]
+end
+
+
+begin
+  require 'code_statistics'
+  desc "Show library's code statistics"
+  task :stats do
+    CodeStatistics.new(["Helperful", "lib"],
+                       ["Tests", "test"]).to_s
+  end
+rescue LoadError
+  puts "CodeStatistics (Rails) is not available"
+end

data/helperful.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{helperful}
+  s.version = "0.5.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Simone Carletti"]
+  s.date = %q{2009-10-12}
+  s.description = %q{    Helperful aims to be a collection of useful and reusable Rails helpers.
+}
+  s.email = %q{weppos@weppos.net}
+  s.extra_rdoc_files = ["CHANGELOG.rdoc", "lib/helperful/affiliations_helper.rb", "lib/helperful/asset_tag_helper.rb", "lib/helperful/content_helper.rb", "lib/helperful/deprecations.rb", "lib/helperful/javascript_helper.rb", "lib/helperful/title_helper.rb", "lib/helperful/version.rb", "lib/helperful.rb", "LICENSE.rdoc", "README.rdoc", "tasks/helperful_tasks.rake"]
+  s.files = ["CHANGELOG.rdoc", "helperful.gemspec", "init.rb", "install.rb", "lib/helperful/affiliations_helper.rb", "lib/helperful/asset_tag_helper.rb", "lib/helperful/content_helper.rb", "lib/helperful/deprecations.rb", "lib/helperful/javascript_helper.rb", "lib/helperful/title_helper.rb", "lib/helperful/version.rb", "lib/helperful.rb", "LICENSE.rdoc", "Manifest", "rails/init.rb", "Rakefile", "README.rdoc", "tasks/helperful_tasks.rake", "test/affiliations_helper_test.rb", "test/asset_tag_helper_test.rb", "test/content_helper_test.rb", "test/fixtures/content/has_content.html.erb", "test/fixtures/content/has_content_is_called_alone.html.erb", "test/fixtures/layouts/has_content.html.erb", "test/helperful_test.rb", "test/javascript_helper_test.rb", "test/test_helper.rb", "test/title_helper_test.rb", "uninstall.rb"]
+  s.homepage = %q{http://code.simonecarletti.com/helperful}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Helperful", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A collection of useful Rails helpers.}
+  s.test_files = ["test/affiliations_helper_test.rb", "test/asset_tag_helper_test.rb", "test/content_helper_test.rb", "test/helperful_test.rb", "test/javascript_helper_test.rb", "test/test_helper.rb", "test/title_helper_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rake>, ["~> 0.8"])
+      s.add_development_dependency(%q<echoe>, ["~> 3.1"])
+      s.add_development_dependency(%q<mocha>, ["~> 0.9.7"])
+    else
+      s.add_dependency(%q<rake>, ["~> 0.8"])
+      s.add_dependency(%q<echoe>, ["~> 3.1"])
+      s.add_dependency(%q<mocha>, ["~> 0.9.7"])
+    end
+  else
+    s.add_dependency(%q<rake>, ["~> 0.8"])
+    s.add_dependency(%q<echoe>, ["~> 3.1"])
+    s.add_dependency(%q<mocha>, ["~> 0.9.7"])
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'rails', 'init')

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/helperful.rb

@@ -0,0 +1,46 @@
+#
+# = Helperful
+#
+# A collection of useful Rails helpers.
+#
+#
+# Category::    Rails
+# Package::     Helperful
+# Author::      Simone Carletti <weppos@weppos.net>
+# Copyright::   2008-2009 The Authors
+# License::     MIT License
+#
+#--
+#
+#++
+
+
+Dir.glob(File.dirname(__FILE__) + '/helperful/*_helper.rb').each { |helper| require helper }
+require 'helperful/deprecations'
+require 'helperful/version'
+
+
+module Helperful
+  
+  NAME            = 'Helperful'
+  GEM             = 'helperful'
+  AUTHORS         = ['Simone Carletti <weppos@weppos.net>']
+  
+  
+  module ControllerMixin
+
+    def helperful(*args, &block)
+      args.flatten.each do |arg|
+        case arg
+          when String, Symbol
+            file_name = 'helperful/' + arg.to_s.underscore
+            helper(file_name)
+          else
+            helper(arg, &block)
+        end
+      end
+    end
+
+  end
+
+end