weppos-helperful 0.2.2 → 0.3.0

data/CHANGELOG.rdoc

@@ -1,6 +1,15 @@
 = Changelog
 
 
+== 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!

data/README.rdoc

@@ -2,8 +2,30 @@
 
 Helperful aims to be a collection of useful and reusable Rails helpers.
 
-*WARNING*: This library has not been released yet. This package seems stable, but should be considered a development release. You should not use it in production.
-Changes to specifications may occur at any time and without notice. For the full list of changes look at the CHANGELOG file.
+
+== Rails Installation
+
+=== As a Gem
+
+This is the preferred way to install Helperful and the best way if you want install a stable version.
+
+  $ gem install weppos-helperful --source http://gems.github.com
+
+You can specify the GEM dependency in your application environment.rb file:
+
+  Rails::Initializer.run do |config|
+    
+    # other configurations
+    
+    config.gem "weppos-helperful", :lib => "helperful", :source => "http://gems.github.com"
+  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
@@ -126,6 +148,24 @@ The <tt>has_content?</tt> helper is a natural fulfillment for the original <tt>c
   <% 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.

data/helperful.gemspec

@@ -2,22 +2,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{helperful}
-  s.version = "0.2.2"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Simone Carletti"]
-  s.date = %q{2009-02-25}
+  s.date = %q{2009-03-11}
   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/content_helper.rb", "lib/helperful/deprecations.rb", "lib/helperful/title_helper.rb", "lib/helperful/version.rb", "lib/helperful.rb", "LICENSE.rdoc", "README.rdoc"]
-  s.files = ["CHANGELOG.rdoc", "helperful.gemspec", "init.rb", "install.rb", "lib/helperful/affiliations_helper.rb", "lib/helperful/content_helper.rb", "lib/helperful/deprecations.rb", "lib/helperful/title_helper.rb", "lib/helperful/version.rb", "lib/helperful.rb", "LICENSE.rdoc", "rails/init.rb", "Rakefile", "README.rdoc", "tasks/helperful_tasks.rake", "test/affiliations_helper_test.rb", "test/content_helper_test.rb", "test/fixtures/content/has_content.html.erb", "test/fixtures/content/sidebar.html.erb", "test/fixtures/content/sidebar_concatenate.html.erb", "test/fixtures/layouts/has_content.html.erb", "test/fixtures/layouts/sidebar.html.erb", "test/helperful_test.rb", "test/test_helper.rb", "test/title_helper_test.rb", "uninstall.rb", "Manifest"]
+  s.extra_rdoc_files = ["CHANGELOG.rdoc", "lib/helperful/affiliations_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"]
+  s.files = ["CHANGELOG.rdoc", "helperful.gemspec", "init.rb", "install.rb", "lib/helperful/affiliations_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/content_helper_test.rb", "test/fixtures/content/has_content.html.erb", "test/fixtures/content/has_content_is_called_alone.html.erb", "test/fixtures/content/sidebar.html.erb", "test/fixtures/content/sidebar_concatenate.html.erb", "test/fixtures/layouts/has_content.html.erb", "test/fixtures/layouts/sidebar.html.erb", "test/helperful_test.rb", "test/javascript_helper_test.rb", "test/test_helper.rb", "test/title_helper_test.rb", "uninstall.rb"]
   s.has_rdoc = true
   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.1}
   s.summary = %q{A collection of useful Rails helpers.}
-  s.test_files = ["test/affiliations_helper_test.rb", "test/content_helper_test.rb", "test/helperful_test.rb", "test/test_helper.rb", "test/title_helper_test.rb"]
+  s.test_files = ["test/affiliations_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

data/lib/helperful/content_helper.rb

@@ -91,6 +91,7 @@ module Helperful
     #   end
     #
     def has_content?(name)
+      @has_content ||= {}
       @has_content.key?(name.to_s)
     end
     

data/lib/helperful/javascript_helper.rb

@@ -0,0 +1,84 @@
+#
+# = 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
+#
+#--
+#
+#++
+
+
+module Helperful
+  
+  # 
+  # = Javascript Helper
+  # 
+  # Provides a set of helpers for working with JavaScript in your views.
+  # 
+  # ==== Requires
+  # 
+  # The following requirements are mandatory for this module.
+  # Including this helper will automatically include them unless already included.
+  # 
+  # * ActionView::Helpers::CaptureHelper
+  # * ActionView::Helpers::JavaScriptHelper
+  #
+  module JavascriptHelper
+    
+    def self.included(base)
+      base.class_eval do
+#        base.included_modules.include?(ActionView::Helpers::CaptureHelper) || include(ActionView::Helpers::CaptureHelper)
+#        base.included_modules.include?(ActionView::Helpers::JavaScriptHelper) || include(ActionView::Helpers::JavaScriptHelper)
+      end
+    end
+
+    #
+    # Mixes the features of <tt>content_for</tt> and <tt>javascript_tag</tt> into a single helper.
+    #
+    # Supports all original method options and features, including the ability to use write the content
+    # in a block and javascript tag options.
+    #
+    # ==== Examples
+    #
+    #   <% javascript_content_for :head do %>
+    #     $("#id").hide();
+    #   <% end %>
+    #
+    # The block is passed as it is to <tt>javascript_tag</tt>,
+    # then the result is stored as <tt>content_for</tt> :head.
+    # Now you can call <tt>yield</tt> and output your javascript content.
+    #
+    #   <%= yield :head %>
+    #
+    #   <script>$("#id").hide();</script>
+    #
+    # This example is equal to the following statements.
+    #
+    #   <% javascript_content_for :head do; javascript_tag do %>
+    #     $("#id").hide();
+    #   <% end; end %>
+    #
+    #   <% javascript_content_for :head do %>
+    #     <script>$("#id").hide();</script>
+    #   <% end %>
+    #
+    # You can make subsequent calls to <tt>javascript_content_for</tt> and <tt>content_for</tt>,
+    # the result for each call will be appended to the value currently stored for <tt>name</tt>. 
+    #
+    def javascript_content_for(name, content_or_options_with_block = nil, html_options = {}, &block)
+      if block_given?
+        content_for(name, javascript_tag(content_or_options_with_block, &block))
+      else
+        content_for(name, javascript_tag(content_or_options_with_block, html_options))
+      end
+    end  
+  
+  end
+end

data/lib/helperful/version.rb

@@ -19,8 +19,8 @@ module Helperful
 
   module Version
     MAJOR = 0
-    MINOR = 2
-    TINY  = 2
+    MINOR = 3
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/content_helper_test.rb

@@ -17,7 +17,11 @@ class ContentController < ActionController::Base
   def has_content
     render :layout => "has_content"
   end
-  
+
+  def has_content_is_called_alone
+    render :layout => false
+  end
+
   def rescue_action(e) raise end
 end
 
@@ -54,6 +58,12 @@ class ContentTest < ActiveSupport::TestCase
 `five' has content: this is 'five' for :five\n}, @response.body
   end
 
+  def test_has_content_is_called_alone
+    get :has_content_is_called_alone
+    assert_response :success
+    assert_equal('bar', @response.body)
+  end
+
   protected
   
     def expected_sidebar_content_for_output

data/test/fixtures/content/has_content_is_called_alone.html.erb

@@ -0,0 +1 @@
+<% if  has_content? :foo %>foo<% end %><% if !has_content? :bar %>bar<% end %>

data/test/javascript_helper_test.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+
+class JavascriptHelperTest < ActionView::TestCase
+  tests Helperful::JavascriptHelper
+
+  attr_accessor :output_buffer
+
+  def setup
+    @content_for_name = nil
+  end
+
+  def test_javascript_content_for
+    javascript_content_for(:name, "alert('hello')")
+
+    assert_dom_equal "<script type=\"text/javascript\">\n//<![CDATA[\nalert('hello')\n//]]>\n</script>",
+      @content_for_name
+  end
+
+  def test_javascript_content_for_with_options
+    javascript_content_for(:name, "alert('hello')", :id => "the_js_tag")
+
+    assert_dom_equal "<script id=\"the_js_tag\" type=\"text/javascript\">\n//<![CDATA[\nalert('hello')\n//]]>\n</script>",
+      @content_for_name
+  end
+
+  def test_javascript_content_for_with_block_in_erb
+    __in_erb_template = ''
+    javascript_content_for(:name) { concat "alert('hello')" }
+
+    assert_dom_equal "<script type=\"text/javascript\">\n//<![CDATA[\nalert('hello')\n//]]>\n</script>",
+      @content_for_name
+  end
+
+  def test_javascript_content_for_with_block_in_erb_and_options
+    __in_erb_template = ''
+    javascript_content_for(:name, :id => "the_js_tag") { concat "alert('hello')" }
+
+    assert_dom_equal "<script id=\"the_js_tag\" type=\"text/javascript\">\n//<![CDATA[\nalert('hello')\n//]]>\n</script>",
+      @content_for_name
+  end
+  
+  def test_javascript_content_for_with_subsequent_calls
+    javascript_content_for(:name, "alert('hello')")
+    javascript_content_for(:name, "alert('world')")
+
+    expected  = "<script type=\"text/javascript\">\n//<![CDATA[\nalert('hello')\n//]]>\n</script>"
+    expected += "<script type=\"text/javascript\">\n//<![CDATA[\nalert('world')\n//]]>\n</script>"
+
+    assert_dom_equal expected,
+      @content_for_name
+  end
+
+end

data/test/test_helper.rb

@@ -15,9 +15,11 @@
 #++
 
 
-require 'test/unit'
 require 'rubygems'
+gem     'rails', '2.2.2'
+
 require 'mocha'
+require 'test/unit'
 require 'active_support'
 require 'action_controller'
 require 'action_controller/cgi_ext'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: weppos-helperful
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors: 
 - Simone Carletti
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-25 00:00:00 -08:00
+date: 2009-03-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,6 +53,7 @@ extra_rdoc_files:
 - lib/helperful/affiliations_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
@@ -66,10 +67,12 @@ files:
 - lib/helperful/affiliations_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
@@ -77,15 +80,16 @@ files:
 - test/affiliations_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/content/sidebar.html.erb
 - test/fixtures/content/sidebar_concatenate.html.erb
 - test/fixtures/layouts/has_content.html.erb
 - test/fixtures/layouts/sidebar.html.erb
 - test/helperful_test.rb
+- test/javascript_helper_test.rb
 - test/test_helper.rb
 - test/title_helper_test.rb
 - uninstall.rb
-- Manifest
 has_rdoc: true
 homepage: http://code.simonecarletti.com/helperful
 post_install_message: 
@@ -121,5 +125,6 @@ test_files:
 - test/affiliations_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