RubyGems - toolmantim-sinatra-content-for - Versions diffs - 0.2.1 - Mend

toolmantim-sinatra-content-for 0.2.1

Files changed (7) hide show

data/.gitignore ADDED Viewed

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

data/LICENSE ADDED Viewed

@@ -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.md ADDED Viewed

@@ -0,0 +1,52 @@
+# 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
+<strong>Note</strong> that with ERB <code>yield_content</code> is called <strong>without</strong>
+an '=' block (<code><%= %></code>), but with Haml it uses <code>= yield\_content</code>.
+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
+<code>sinatra/content_for</code> should be enough. If you're writing
+"classy" apps, then you also need to call
+<code>helpers Sinatra::ContentFor</code> 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 <code><% yield\_content :scripts\_and\_styles %></code> on
+your layout, inside the <head> tag, and each view can call
+<code>content_for</code> setting the appropriate set of tags that should
+be added to the layout.
+## How is this different from [foca](http://github.com/foca)'s version?
+This code was based on [foca's version](http://github.com/foca), which supports passing block values to the content, which means lazy rendering of the blocks. This plays havoc with anything that assumes that views are rendered before layouts, such as setting instance variables and the [fancyviews](http://github.com/quackingduck/fancyviews) plugin.
+## Credits
+Original code by [foca](http://github.com/foca), inspired on the Ruby on Rails helpers with the same name. Haml support by [macodely](http://github.com/macodely). Modified by me (Tim Lucas) for the above reasons.

data/lib/sinatra/content_for.rb ADDED Viewed

@@ -0,0 +1,44 @@
+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.
+    def content_for(key, &block)
+      content_blocks[key.to_sym] << begin
+        if respond_to?(:block_is_haml?) && block_is_haml?(block)
+          capture_haml(&block)
+        else
+          block.call
+        end
+      end
+    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.
+    def yield_content(key)
+      content_blocks[key.to_sym].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 Viewed

@@ -0,0 +1,34 @@
+Gem::Specification.new do |s|
+  s.name    = "sinatra-content-for"
+  s.version = "0.2.1"
+  s.date    = "2009-08-11"
+  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.md
+sinatra-content-for.gemspec
+lib/sinatra/content_for.rb
+test/content_for_test.rb
+]
+end

data/test/content_for_test.rb ADDED Viewed

@@ -0,0 +1,130 @@
+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
+  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
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: toolmantim-sinatra-content-for
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- "Nicol\xC3\xA1s Sanguinetti"
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-08-11 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.md
+- 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: []