curtain 0.1.2 → 0.1.3

data/README.md

@@ -20,82 +20,114 @@ Or install it yourself as:
 
 To use Curtain, you define a view and then have that view render templates:
 
-    # hello.erb
-    <h1><%= msg %></h1>
-
-    # my_view.rb
-    class MyView < Struct.new(:msg)
-      include Curtain
-    end
-
-    view = MyView.new("Hello, World!")
-    view.render("hello") # => <h1>Hello, World!</h1>
+### hello.erb
+``` erb
+<h1><%= msg %></h1>
+```
+
+### my_view.rb
+``` ruby
+class MyView
+  include Curtain
+  
+  attr_accessor :msg
+  
+  def initialize(msg)
+    @msg = msg
+  end
+end
+```
+
+``` ruby
+view = MyView.new("Hello, World!")
+view.render("hello") # => <h1>Hello, World!</h1>
+```
 
 The template is rendered in the scope of the view object, so any methods defined in the view are available to the template.  You don't have to create a subclass if you don't need to:
 
-    Curtain::View.new.render("hello", :msg => "Hello, World!")
+``` ruby
+Curtain::View.new.render("hello", :msg => "Hello, World!")
+```
 
 There is an equivalent shortcut available:
 
-    Curtain.render("hello", :msg => "Hello, World!")
+``` ruby
+Curtain.render("hello", :msg => "Hello, World!")
+```
 
 Curtain includes many useful methods.  Here's a more realistic example that shows some of the built-in methods.  If you have templates like this:
 
-    # friends.erb
-    <% cache "friends-#{current_user.id}", ttl: 5.minutes do %>
-      <% friends.each do |friend| %>
-        <%= render "profile", :profile => friend %>
-      <% end %>
-    <% end %>
-
-    # profile.erb
-    <ul>
-      <li><%= link_to profile.name, path(:profile, :id => profile.id) %></li>
-    </ul>
+### friends.erb
+``` erb
+<% cache "friends-#{current_user.id}", ttl: 5.minutes do %>
+  <% friends.each do |friend| %>
+    <%= render "profile", :profile => friend %>
+  <% end %>
+<% end %>
+```
+
+### profile.erb
+``` erb
+<ul>
+  <li><%= link_to profile.name, path(:profile, :id => profile.id) %></li>
+</ul>
+```
 
 You can use them in this way:
 
-    class ApplicationView < Curtain::View
-      attr_accessor :current_user
-    end
+``` ruby
+class ApplicationView < Curtain::View
+  attr_accessor :current_user
+end
 
-    class FriendsView < Curtain::View
-      delegate :friends, :to => :current_user
-    end
+class FriendsView < Curtain::View
+  delegate :friends, :to => :current_user
+end
 
-    view = FriendsView.new(:current_user => User.first)
+view = FriendsView.new(:current_user => User.first)
 
-    # The default template name is based on the name of the class of the view
-    view.render
+# The default template name is based on the name of the class of the view
+view.render
+```
 
 ### Variables
 
 If you don't want to define a subclass of `Curtain::View` and add attributes to it, you can also use variables.  `Curtain::View` supports the hash-like Ruby method `[]` and `[]=` to define variables that will act as locals in when the template is rendered:
 
-    # hello.erb
-    <h1><%= msg %></h1>
+### hello.erb
+``` erb
+<h1><%= msg %></h1>
+```
 
-    view = Curtain::View.new
-    view[:msg] = "Hello"
-    view.render # => "<h1>Hello</h1>"
+``` ruby
+view = Curtain::View.new
+view[:msg] = "Hello"
+view.render(:hello) # => "<h1>Hello</h1>"
+```
     
 Note that unlike locals, variables exist throughout nested scope of render calls:
 
-    # main.erb
-    foo: <%= foo %>
-    bar: <%= bar %>
-    <%= render "partial" %>
-    
-    # partial.erb
-    foo: <%= foo %>
-    bar: <%= bar %>
-    
-    class MainView < Curtain::View
-    end
+### main.erb
+``` erb
+foo: <%= foo %>
+bar: <%= bar %>
+<%= render "partial" %>
+```
     
-    view = MainView.new
-    view[:foo] = "foo"
-    view.render :bar => "bar"
+### partial.erb
+``` erb
+foo: <%= foo %>
+bar: <%= bar %>
+```
+
+``` ruby    
+class MainView < Curtain::View
+end
+
+view = MainView.new
+view[:foo] = "foo"
+view.render :bar => "bar"
+```
 
 This example would result in an error.  As the main template is first rendered, foo is defined as "foo" because it is a variable, the bar is "bar" because it is passed in as a local.  Then the partial template is rendered, and foo is still defined as "foo" because it is a variable, but since bar was a local passed to the rendering of main, it doesn't carry through to the rendering of partial.
 

data/curtain.gemspec

@@ -5,14 +5,14 @@ Gem::Specification.new do |gem|
   gem.email         = ["mail@paulbarry.com"]
   gem.description   = %q{A template rendering framework}
   gem.summary       = %q{A template rendering framework}
-  gem.homepage      = ""
+  gem.homepage      = "http://github.com/pjb3/curtain"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "curtain"
   gem.require_paths = ["lib"]
-  gem.version       = "0.1.2"
+  gem.version       = "0.1.3"
 
   gem.add_runtime_dependency "activesupport"
   gem.add_runtime_dependency "tilt"

data/lib/curtain/version.rb

@@ -1,3 +1,3 @@
 module Curtain
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: curtain
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-04 00:00:00.000000000 Z
+date: 2013-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -129,7 +129,7 @@ files:
 - test/html_helpers_test.rb
 - test/test_helper.rb
 - test/url_helpers_test.rb
-homepage: ''
+homepage: http://github.com/pjb3/curtain
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -166,3 +166,4 @@ test_files:
 - test/html_helpers_test.rb
 - test/test_helper.rb
 - test/url_helpers_test.rb
+has_rdoc: