docs, preparing for 0.8.0 release

History.txt

@@ -1,17 +1,39 @@
-== 0.8.0
+== 0.8.0 - 2010-07-07
 
-* deprecating to_s in favor of to_html
-* to_text does some formatting 
+Core:
+* deprecated to_s in favor of to_html
+* to_text does some formatting
 * barebones Sass support
 * "depends_on" is the new way to include JS and CSS files (replacing "external"). More flexible calling structure.
 * line wrapping via the :max_length parameter to to_html
+* line wrapping preserves leading and trailing spaces
 * jquery method takes optional first parameter (:load or :ready)
-* Rails 2.3.8 compatibility
 * delegate method_missing to parent widget
-* To render from a Rails context, you must now go through Erector::Rails.render; do not call to_s(:parent => @view) directly
 * 'embed' and 'param' are now self-closing tags (as per browser warnings)
+* Converted Widget#context to take a params hash.
+* Exposed an Output object, with rather useful #placeholder method 
+* Defined Widget#output to delegate to #parent if @parent is not already set.
+* Removed :parent param for Output#initialize in favor of a block.
+* Page#extra_widgets
+* Page only emits externals from widgets that have been rendered on it
+* in-memory widget caching (still experimental)
+
+Rails:
+* Compatibility with Rails 2.3.5 HTML safety
+* Rails 2.3.8 compatibility
+* To render from a Rails context, you must now go through Erector::Rails.render; do not call to_s(:parent => @view) directly
+* rails_xss plugin support
+* additional render :widget options passed to to_s. This means that you can do:
+      render :widget => MyWidget, :content_method_name => :my_content
+* Widget#h is now idempotent
+
+Bugs:
+* [bug] http://github.com/pivotal/erector/issues/#issue/5
+* [bug] http://github.com/pivotal/erector/issues/closed#issue/3
+* [bug] double-rendering
+
 
-== 0.7.3
+== 0.7.3 - 2009-12-01
 * fix bug in pass-block-to-new inline page rendering
 * externals can accept a File (or any IO, actually)
 

lib/erector/output.rb

@@ -51,6 +51,10 @@ def <<(s)
       self
     end
 
+    # Inserts a blank string into the output stream and returns a pointer to it.
+    # If the caller holds on to this pointer, she can later go back and insert text
+    # earlier in the stream. This is used for, e.g., inserting stuff inside the
+    # HEAD element that is not known until after the entire page renders.
     def placeholder
       s = ""
       buffer << s
@@ -83,6 +87,8 @@ def undent
       @indentation -= 1 if prettyprint
     end
 
+    # always append a newline, regardless of prettyprint setting
+    #todo: test
     def append_newline
       buffer << "\n"
       @current_line_length = 0

web/release_notes.html

@@ -28,8 +28,11 @@ <h3>External Links:</h3>
     <div class="main">
       <h1 class="title">Erector - Release Notes</h1>
       <div class="body"><h2>0.8.0</h2>
+<p>
+Core:
+</p>
 <ul>
-<li>deprecating to_s in favor of to_html
+<li>deprecated to_s in favor of to_html
 
 </li>
 <li>to_text does some formatting
@@ -45,25 +48,84 @@ <h1 class="title">Erector - Release Notes</h1>
 <li>line wrapping via the :max_length parameter to to_html
 
 </li>
-<li>jquery method takes optional first parameter (:load or :ready)
+<li>line wrapping preserves leading and trailing spaces
 
 </li>
-<li>Rails 2.3.8 compatibility
+<li>jquery method takes optional first parameter (:load or :ready)
 
 </li>
 <li>delegate method_missing to parent widget
 
+</li>
+<li>&#8216;embed&#8217; and &#8216;param&#8217; are now self-closing tags (as
+per browser warnings)
+
+</li>
+<li>Converted Widget#context to take a params hash.
+
+</li>
+<li>Exposed an Output object, with rather useful #placeholder method
+
+</li>
+<li>Defined Widget#output to delegate to #parent if @parent is not already set.
+
+</li>
+<li>Removed :parent param for Output#initialize in favor of a block.
+
+</li>
+<li>Page#extra_widgets
+
+</li>
+<li>Page only emits externals from widgets that have been rendered on it
+
+</li>
+<li>in-memory widget caching (still experimental)
+
+</li>
+</ul>
+<p>
+Rails:
+</p>
+<ul>
+<li>Compatibility with Rails 2.3.5 HTML safety
+
+</li>
+<li>Rails 2.3.8 compatibility
+
 </li>
 <li>To render from a Rails context, you must now go through
 Erector::Rails.render; do not call to_s(:parent =&gt; @view) directly
 
 </li>
-<li>&#8216;embed&#8217; and &#8216;param&#8217; are now self-closing tags (as
-per browser warnings)
+<li>rails_xss plugin support
+
+</li>
+<li>additional render :widget options passed to to_s. This means that you can
+do:
+
+<pre>
+    render :widget =&gt; MyWidget, :content_method_name =&gt; :my_content
+</pre>
+</li>
+<li>Widget#h is now idempotent
+
+</li>
+</ul>
+<p>
+Bugs:
+</p>
+<ul>
+<li>[bug] http://github.com/pivotal/erector/issues/#issue/5
+
+</li>
+<li>[bug] http://github.com/pivotal/erector/issues/closed#issue/3
+
+</li>
+<li>[bug] double-rendering
 
 </li>
 </ul>
-<h2>0.7.3</h2>
+<h2>0.7.3 - 2009-12-01</h2>
 <ul>
 <li>fix bug in pass-block-to-new inline page rendering