RubyGems - hryk-sinatra-content-for - Versions diffs - 0.2 - Mend

hryk-sinatra-content-for 0.2

Files changed (7) hide show

data/.gitignore ADDED

@@ -0,0 +1,3 @@
+doc
+dist
+tmp

data/LICENSE ADDED

@@ -0,0 +1,22 @@
+(The MIT License)
+Copyright (c) 2008-2009 Nicolas Sanguinetti, entp.com
+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.rdoc ADDED

@@ -0,0 +1,49 @@
+= ContentFor
+Small extension for the Sinatra[http://sinatrarb.com] web framework
+that allows you to use the following helpers in your views:
+    <% content_for :some_key do %>
+      <chunk of="html">...</chunk>
+    <% end %>
+    <% yield_content :some_key %>
+This allows you to capture blocks inside views to be rendered later
+in this request. For example, to populate different parts of your
+layout from your view.
+When using this with the Haml rendering engine, you should do the
+following:
+    - content_for :some_key do
+      %chunk{ :of => "html" } ...
+    = yield_content :some_key
+<b>Note</b> that with ERB <tt>yield_content</tt> is called <b>without</b>
+an '=' block (<tt><%= %></tt>), but with Haml it uses <tt>= yield_content</tt>.
+Using an '=' block in ERB will output the content twice for each block,
+so if you have problems with that, make sure to check for this.
+== Usage
+If you're writing "classic" style apps, then requring
+<tt>sinatra/content_for</tt> should be enough. If you're writing
+"classy" apps, then you also need to call
+<tt>helpers Sinatra::ContentFor</tt> in your app definition.
+== And how is this useful?
+For example, some of your views might need a few javascript tags and
+stylesheets, but you don't want to force this files in all your pages.
+Then you can put <tt><% yield_content :scripts_and_styles %></tt> on
+your layout, inside the <head> tag, and each view can call
+<tt>content_for</tt> setting the appropriate set of tags that should
+be added to the layout.
+== Credits
+Code by foca[http://github.com/foca], inspired on the Ruby on Rails
+helpers with the same name. Haml support by mattly[http://github.com/mattly].

data/lib/sinatra/content_for.rb ADDED

@@ -0,0 +1,65 @@
+module Sinatra
+  module ContentFor
+    # Capture a block of content to be rendered later. For example:
+    #
+    #     <% content_for :head do %>
+    #       <script type="text/javascript" src="/foo.js"></script>
+    #     <% end %>
+    #
+    # You can call +content_for+ multiple times with the same key
+    # (in the example +:head+), and when you render the blocks for
+    # that key all of them will be rendered, in the same order you
+    # captured them.
+    #
+    # Your blocks can also receive values, which are passed to them
+    # by <tt>yield_content</tt>
+    def content_for(key, &block)
+      content_blocks[key.to_sym] << block if block_given?
+    end
+    # Render the captured blocks for a given key. For example:
+    #
+    #     <head>
+    #       <title>Example</title>
+    #       <% yield_content :head %>
+    #     </head>
+    #
+    # Would render everything you declared with <tt>content_for
+    # :head</tt> before closing the <tt><head></tt> tag.
+    #
+    # You can also pass values to the content blocks by passing them
+    # as arguments after the key:
+    #
+    #     <% yield_content :head, 1, 2 %>
+    #
+    # Would pass <tt>1</tt> and <tt>2</tt> to all the blocks registered
+    # for <tt>:head</tt>.
+    #
+    # *NOTICE* that you call this without an <tt>=</tt> sign. IE,
+    # in a <tt><% %></tt> block, and not in a <tt><%= %></tt> block.
+    #
+    # *NOTICE*
+    # if you call from erubis, you call this with <tt>=</tt> sign.IE,
+    #in a <tt><%= %></tt> block, and not in a <tt><% %></tt> block.
+    def yield_content(key, *args)
+      content_blocks[key.to_sym].map do |content|
+        if respond_to?(:block_is_haml?) && block_is_haml?(content)
+          capture_haml(*args, &content)
+        elsif Erubis::VERSION # this line may cause trouble..
+          content.binding.eval ' _buf = "" '
+          content.call(*args)
+        else
+          content.call
+        end
+      end.join
+    end
+    private
+      def content_blocks
+        @content_blocks ||= Hash.new {|h,k| h[k] = [] }
+      end
+  end
+  helpers ContentFor
+end

data/sinatra-content-for.gemspec ADDED

@@ -0,0 +1,34 @@
+Gem::Specification.new do |s|
+  s.name    = "sinatra-content-for"
+  s.version = "0.2"
+  s.date    = "2009-05-09"
+  s.description = "Small Sinatra extension to add a content_for helper similar to Rails'"
+  s.summary     = "Small Sinatra extension to add a content_for helper similar to Rails'"
+  s.homepage    = "http://sinatrarb.com"
+  s.authors = ["Nicolás Sanguinetti"]
+  s.email   = "contacto@nicolassanguinetti.info"
+  s.require_paths     = ["lib"]
+  s.rubyforge_project = "sinatra-ditties"
+  s.has_rdoc          = true
+  s.rubygems_version  = "1.3.1"
+  s.add_dependency "sinatra"
+  if s.respond_to?(:add_development_dependency)
+    s.add_development_dependency "contest"
+    s.add_development_dependency "sr-mg"
+    s.add_development_dependency "redgreen"
+  end
+  s.files = %w[
+.gitignore
+LICENSE
+README.rdoc
+sinatra-content-for.gemspec
+lib/sinatra/content_for.rb
+test/content_for_test.rb
+]
+end

data/test/content_for_test.rb ADDED

@@ -0,0 +1,156 @@
+ENV['RACK_ENV'] = 'test'
+begin
+  require 'rack'
+rescue LoadError
+  require 'rubygems'
+  require 'rack'
+end
+require 'contest'
+require 'sinatra/test'
+require 'haml'
+begin
+  require 'redgreen'
+rescue LoadError
+end
+require File.dirname(__FILE__) + '/../lib/sinatra/content_for'
+Sinatra::Base.set :environment, :test
+module Sinatra
+  class Base
+    set :environment, :test
+    helpers ContentFor
+  end
+end
+class Test::Unit::TestCase
+  include Sinatra::Test
+  class << self
+    alias_method :it, :test
+  end
+  def mock_app(base=Sinatra::Base, &block)
+    @app = Sinatra.new(base, &block)
+  end
+end
+class ContentForTest < Test::Unit::TestCase
+  context 'using erb' do
+    def erb_app(view)
+      mock_app {
+        layout { '<% yield_content :foo %>' }
+        get('/') { erb view }
+      }
+    end
+    it 'renders blocks declared with the same key you use when rendering' do
+      erb_app '<% content_for :foo do %>foo<% end %>'
+      get '/'
+      assert ok?
+      assert_equal 'foo', body
+    end
+    it 'does not render a block with a different key' do
+      erb_app '<% content_for :bar do %>bar<% end %>'
+      get '/'
+      assert ok?
+      assert_equal '', body
+    end
+    it 'renders multiple blocks with the same key' do
+      erb_app <<-erb_snippet
+        <% content_for :foo do %>foo<% end %>
+        <% content_for :foo do %>bar<% end %>
+        <% content_for :baz do %>WON'T RENDER ME<% end %>
+        <% content_for :foo do %>baz<% end %>
+      erb_snippet
+      get '/'
+      assert ok?
+      assert_equal 'foobarbaz', body
+    end
+    it 'passes values to the blocks' do
+      mock_app {
+        layout { '<% yield_content :foo, 1, 2 %>' }
+        get('/') { erb '<% content_for :foo do |a, b| %><i><%= a %></i> <%= b %><% end %>' }
+      }
+      get '/'
+      assert ok?
+      assert_equal '<i>1</i> 2', body
+    end
+  end
+  context 'with haml' do
+    def haml_app(view)
+      mock_app {
+        layout { '= yield_content :foo' }
+        get('/') { haml view }
+      }
+    end
+    it 'renders blocks declared with the same key you use when rendering' do
+      haml_app <<-haml_end
+- content_for :foo do
+  foo
+haml_end
+      get '/'
+      assert ok?
+      assert_equal "foo\n", body
+    end
+    it 'does not render a block with a different key' do
+      haml_app <<-haml_end
+- content_for :bar do
+  bar
+haml_end
+      get '/'
+      assert ok?
+      assert_equal "\n", body
+    end
+    it 'renders multiple blocks with the same key' do
+      haml_app <<-haml_end
+- content_for :foo do
+  foo
+- content_for :foo do
+  bar
+- content_for :baz do
+  WON'T RENDER ME
+- content_for :foo do
+  baz
+haml_end
+      get '/'
+      assert ok?
+      assert_equal "foo\nbar\nbaz\n", body
+    end
+    it 'passes values to the blocks' do
+      mock_app {
+        layout { '= yield_content :foo, 1, 2' }
+        get('/') {
+          haml <<-haml_end
+- content_for :foo do |a, b|
+  %i= a
+  =b
+haml_end
+        }
+      }
+      get '/'
+      assert ok?
+      assert_equal "<i>1</i>\n2\n", body
+    end
+  end
+end

metadata ADDED

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: hryk-sinatra-content-for
+version: !ruby/object:Gem::Version
+  version: "0.2"
+platform: ruby
+authors:
+- "Nicol\xC3\xA1s Sanguinetti"
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-05-09 00:00:00 -07:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+    version:
+- !ruby/object:Gem::Dependency
+  name: contest
+  type: :development
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+    version:
+- !ruby/object:Gem::Dependency
+  name: sr-mg
+  type: :development
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+    version:
+- !ruby/object:Gem::Dependency
+  name: redgreen
+  type: :development
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+    version:
+description: Small Sinatra extension to add a content_for helper similar to Rails'
+email: contacto@nicolassanguinetti.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE
+- README.rdoc
+- sinatra-content-for.gemspec
+- lib/sinatra/content_for.rb
+- test/content_for_test.rb
+has_rdoc: true
+homepage: http://sinatrarb.com
+licenses:
+post_install_message:
+rdoc_options: []
+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: "0"
+  version:
+requirements: []
+rubyforge_project: sinatra-ditties
+rubygems_version: 1.3.5
+signing_key:
+specification_version: 2
+summary: Small Sinatra extension to add a content_for helper similar to Rails'
+test_files: []