masterview 0.2.2 → 0.2.3

data/CHANGELOG

@@ -1,3 +1,17 @@
+0.2.3 - July 5th, 2006
+Change default development settings for enable_admin_pages = true and enable_view_rhtml = true, remains false in production.
+Change generated message in files to indicate that list.html controls layout and _messages, while new.html controls _form...
+Added check_box directive
+Added radio_button directive
+Refactored attr_value option parser
+Added select directive
+Added config setting template_asset_base_ref_pattern, index by asset type, for extracting asset refs from template design-time refs for rails helpers.
+Internal rework of directive handling to provide infrastructure for enable alt directive name spaces (separate from builtin mv: namespace).
+Std app directives dir at rails app/masterview/directives will be automatically added to load path along with builtin mv: directives if present.
+Added quote_if method to directive_base and refactored directives to utilize so logic is consolidated.
+Added collection_select directive
+
+
 0.2.2 - June 30th, 2006 - Fix bug when not generating rhtml that rails template error could not find source and thus would fail to generate rhtml error page
 
 0.2.1 - June 28th, 2006

data/RELEASE_NOTES

@@ -1,5 +1,17 @@
 = MasterView - Rails-optimized (x)html friendly template engine 
 
+== Recent changes (Release 0.2.3)
+
+Changed default development settings for enable_admin_pages and
+enable_view_rhtml = true (false in production) to make it easy
+for new users to get up and running. Added check_box, radio_button,
+select, collection_select directives. Refactor attr_value parsing 
+to be more robust taking into account nested objects. Internal rework
+of directive handling to support alternate namespaces for directives.
+Std app directives dir at rails app/masterview/directives will be
+automatically added to MasterView load path if exists.
+
+
 == Recent changes (Release 0.2.2)
 
 Fixes problem when rails encounters exception in either compiling or

data/TODO

@@ -31,4 +31,19 @@
 ??? can we tweak the admin controller for gem plugin so it puts its empty.rhtml in, say, config/masterview/admin??
 => better loc than vendor/plugins/masterview/........ if users are going to customize that guy
 
---####################
+--####################
+
+DSL for creating directives
+maybe something like
+
+event :etag => [:object, :method, :options, :html_options] do 
+  # creates @dcs, @args, @object, @method, @options, @html_options, and we already have attr_value and attrs
+  # the array of symbols is used for string args found in attr_value 
+  # here we build up the response
+  outargs = []
+  outargs << quote_if_simple_word(@object)
+  outargs << quote_if_simple_word(@method)
+  outargs << @options unless @options.to_s.empty?
+  outargs << @html_options unless @html_options.to_s.empty?
+  erb_output( 'test '+outargs.join(', ') )
+end

data/doc/configuration.html

@@ -69,8 +69,13 @@ and start using the template engine facilities in its views.
 <h2>Using MasterView in a Rails Application</h2>
 
 <p>The standard configuration of <span class="productName">MasterView</span> in
-a Rails application is to generate rhtml into the <code>RAILS_ROOT/app/views</code>
-directory from template files in <code>RAILS_ROOT/app/views/masterview</code>.
+a Rails application is to search for MasterView templates (*.html) in the normal 
+<code>RAILS_ROOT/app/views</code> directory and for rails to load the generated
+rhtml directly from <span class="productName">MasterView</span> internally. If config.generate_rhtml is set to true
+(default is false) then <span class="productName">MasterView</span> will generate its intermediate rhtml to the standard 
+<code>RAILS_ROOT/app/views</code> directory and Rails will pick it up from there 
+as normal.
+
 The <code>mv:</code> attribute markup in the masterview templates determines
 the content of the generated rhtml view templates, which are then used by the Rails controller/view dispatching mechanisms in the usual fashion.
 </p>
@@ -97,7 +102,7 @@ Options are set by assigning values to the <code>config</code> instance
 that will be used to initialize  <span class="productName">MasterView</span>.
 </p>
 
-<p>Just as with with your Rails configuration settings, you can optionally provide
+<p>Just as with your Rails configuration settings, you can optionally provide
 environment-specific settings to override or augment your standard application settings.
 To specify environment-dependent configuration settings, provide
 additional config files in an <code>environments</code> subdirectory
@@ -440,16 +445,22 @@ with the pathname of the source template file.
 </tr>
 <tr>
 <td class="setting">enable_admin_pages</td>
-<td class="default">false</td>
-<td class="description">Enable MasterView admin pages in the rails application. If config/masterview/environments/production.rb was created during installation then the default is false in production mode.
+<td class="default">true for development, otherwise false</td>
+<td class="description">Enable MasterView admin pages in the rails application. 
+<!--Too clever, just set the default and be done with it:
+If config/masterview/environments/development.rb was created during installation then the default is true in development mode (false by default in production unless changed in settings.rb).
+-->
 <div class="explanation">Enables the masterview admin controller at <code>http://yourappdomain/masterview</code>.</div>
 </td>
 </tr>
 <tr>
 <td class="setting">enable_view_rhtml</td>
-<td class="default">false</td>
-<td class="description">Enable MasterView admin pages in a rails application to be able to view the generated rhtml. When enabled it creates links on the list page to click to view the rhtml source. Requires that enable_admin_pages is true.  If config/masterview/environments/production.rb was created during installation then the default is false in production mode.
-<div class="explanation">This functionality is useful for understanding how your templates are being interpretted (ie. what rhtml is being generated by them) and for debugging. For security reasons you would probably disable this feature in production (or disable admin pages altogether).</div>
+<td class="default">true for development, otherwise false</td>
+<td class="description">Enable MasterView admin pages in a rails application to be able to view the generated rhtml. When enabled it creates links on the list page to click to view the rhtml source. Requires that enable_admin_pages is true.  
+<!--Too clever, just set the default and be done with it:
+If config/masterview/environments/development.rb was created during installation then the default is true in development mode (false by default in production unless changed in settings.rb).
+-->
+<div class="explanation">This functionality is useful for understanding how your templates are being interpreted (i.e. what rhtml is being generated by them) and for debugging. For security reasons you would probably disable this feature in production (or disable admin pages altogether).</div>
 </td>
 </tr>
 <tr>

data/doc/directives.html

@@ -214,6 +214,18 @@ Used on stylesheet <code>&lt;link&gt;</code> elements in html header section
 <td colspan="2"><a href="#form_directives">Rails Form Helper Directives</a></td>
 </tr>
 <tr>
+<td class="directive"><a href="#mv_check_box">mv:check_box</a></td>
+<td>Replaces this element with a Rails <code>check_box</code> helper</td>
+</tr>
+<tr>
+<td class="directive"><a href="#mv_collection_select">mv:collection_select</a></td>
+<td>Replaces this element with a Rails <code>collection_select</code> helper.
+<span class="explanation">(
+Used on <code>&lt;select&gt;</code> form elements
+)</span>
+</td>
+</tr>
+<tr>
 <td class="directive"><a href="#mv_form">mv:form</a></td>
 <td>Replaces the start and end tags of this element using the Rails <code>form_tag</code> and <code>form_tag</code> helpers</td>
 </tr>
@@ -233,6 +245,23 @@ Used on <code>&lt;input&gt;</code> form elements
 )</span>
 </td>
 </tr>
+<tr>
+<td class="directive"><a href="#mv_radio_button">mv:radio_button</a></td>
+<td>Replaces this element with a Rails <code>radio_button</code> helper.
+<span class="explanation">(
+Used on <code>&lt;input&gt;</code> form elements
+)</span>
+</td>
+</tr>
+<tr>
+<td class="directive"><a href="#mv_select">mv:select</a></td>
+<td>Replaces this element with a Rails <code>select</code> helper.
+<span class="explanation">(
+Used on <code>&lt;select&gt;</code> form elements
+)</span>
+</td>
+</tr>
+
 <tr>
 <td class="directive"><a href="#mv_submit">mv:submit</a></td>
 <td>Replaces this element with a <code>submit</code> input element using the Rails <code>submit_tag</code> helper.
@@ -379,7 +408,6 @@ mv:import_render=&quot;partial =&gt; &#8216;product/form&#8217;&quot;
         generates the appropriate render partial helper, but doesn't generate any additional output, it is only used for
         design time editing and can be easily sync'd up if it ever gets out of sync with the original code.
 </pre>
-<p>
 
 <a name="mv_gen_replace"></a>
 <h4>mv:gen_replace</h4>
@@ -816,6 +844,66 @@ mv:stylesheet_link=&quot;style&quot;
 <a name="form_directives"></a>
 <h3>Rails Form Helper Directives</h3>
 
+<a name="mv_check_box"></a>
+<h4>mv:check_box</h4>
+<p>
+mv:check_box=&quot;product, name&quot;
+</p>
+<pre>
+        Replaces this element with the check_box helper. It quotes the object and name if necessary, and merges any 
+	html attributes into options if supplied
+
+        &lt;input type="checkbox"  mv:check_box=&quot;product, name&quot;/&gt;
+
+          becomes
+
+        &lt;% check_box 'product', 'name' %&gt;
+
+	and 
+
+        &lt;input type="checkbox"  class=&quot;green&quot; id=&quot;cb1&quot; mv:check_box=&quot;product, name, {:readonly =&gt; true}, &apos;yes,&apos;, &apos;no&apos;&quot;/&gt;
+
+          becomes
+
+        &lt;% check_box 'product', 'name', {:readonly =&gt; true, :class =&gt; &quot;green&quot;, :id =&gt; &quot;cb1&quot;}, &apos;yes,&apos;, &apos;no&apos;&quot;%&gt;
+
+</pre>
+
+<a name="mv_collection_select"></a>
+<h4>mv:collection_select</h4>
+<p>
+mv:collection_select=&quot;product, category, Category.find_all, id, name&quot;
+</p>
+<pre>
+        Replaces the tag with a select helper, it quotes the object and method if necessary, and
+	merges any html attributes into the html_options
+
+
+	&lt;select mv:collection_select=&quot;product, category, Category.find_all, id, name&quot;&gt;
+	  &lt;option&&gt;One&lt;/option&gt;
+	  &lt;option&&gt;One&lt;/option&gt;
+	&lt;/select&gt;
+	
+          becomes
+
+        &lt;%= collection_select &apos;product&apos;, &apos;category&apos;, Category.find_all, &apos;id&apos;, &apos;name&apos; %&gt;
+
+        and
+
+
+	&lt;select size=&quot;3&quot; mv:collection_select=&quot;product, category, Category.find_all, id, name, {}, :readonly => true &quot;&gt;
+	  &lt;option&&gt;One&lt;/option&gt;
+	  &lt;option&&gt;One&lt;/option&gt;
+	&lt;/select&gt;
+	
+
+          becomes
+
+        &lt;%= collection_select &apos;product&apos;, &apos;category&apos;, Category.find_all, &apos;id&apos;, &apos;name&apos;, {}, :readonly => true, :size => 3 %&gt;
+
+
+</pre>
+
 <a name="mv_form"></a>
 <h4>mv:form</h4>
 <p>
@@ -882,6 +970,67 @@ mv:password_field=&quot;user, password&quot;
         &lt;%= password_field, user, password, :class =&gt; 'pwdStyle', :maxlength = 15, :size =&gt; 10 %&gt;
 </pre>
 
+<a name="mv_radio_button"></a>
+<h4>mv:radio_button</h4>
+<p>
+mv:radio_button=&quot;product, category, 'clothing'&quot;
+</p>
+<pre>
+        Replaces the tag with a radio_button helper, it quotes the object and method if necessary, and
+	merges any html attributes into the options
+
+
+        &lt;input type=&quot;radio&quot; mv:radio_button=&quot;product, category, 'clothing'&quot;/&gt;
+
+          becomes
+
+        &lt;%= radio_button &apos;product&apos;,&apos;category&apos;,&apos;clothing&apos; %&gt;
+
+        and
+
+        &lt;input type=&quot;radio&quot; class=&quot;green&quot; mv:radio_button=&quot;product, category, 'clothing', :readonly => true&quot;/&gt;
+
+          becomes
+
+        &lt;%= radio_button &apos;product&apos;,&apos;category&apos;,&apos;clothing&apos;, :readonly =&gt; true, :class =&gt; &apos;green&apos; %&gt;
+
+</pre>
+
+<a name="mv_select"></a>
+<h4>mv:select</h4>
+<p>
+mv:select=&quot;product, category, Category.find_all.collect{|c| [c.name, c.id]}&quot;
+</p>
+<pre>
+        Replaces the tag with a select helper, it quotes the object and method if necessary, and
+	merges any html attributes into the html_options
+
+
+	&lt;select mv:select=&quot;product, category, Category.find_all.collect{|c| [c.name, c.id]}&quot;&gt;
+	  &lt;option&&gt;One&lt;/option&gt;
+	  &lt;option&&gt;One&lt;/option&gt;
+	&lt;/select&gt;
+	
+          becomes
+
+        &lt;%= select &apos;product&apos;, &apos;category&apos;, Category.find_all.collect{|c| [c.name, c.id]} %&gt;
+
+        and
+
+
+	&lt;select size=&quot;3&quot; mv:select=&quot;product, category, Category.find_all.collect{|c| [c.name, c.id]}, {}, :readonly => true &quot;&gt;
+	  &lt;option&&gt;One&lt;/option&gt;
+	  &lt;option&&gt;One&lt;/option&gt;
+	&lt;/select&gt;
+	
+
+          becomes
+
+        &lt;%= select &apos;product&apos;, &apos;category&apos;, Category.find_all.collect{|c| [c.name, c.id]}, {}, :readonly => true, :size => 3 %&gt;
+
+
+</pre>
+
 <a name="mv_submit"></a>
 <h4>mv:submit</h4>
 <p>
@@ -981,6 +1130,10 @@ mv:text_field=&quot;object, method&quot;
 
 <!-- c -->
 <tr>
+<td class="directive"><a href="#mv_check_box">mv:check_box</a></td>
+<td>Replaces this element with a Rails <code>check_box</code> helper</td>
+</tr>
+<tr>
 <td class="directive"><a href="#mv_content">mv:content</a></td>
 <td>Replaces the content of this element with the value of the expression</td>
 </tr>
@@ -990,6 +1143,10 @@ mv:text_field=&quot;object, method&quot;
 <td class="directive"><a href="#mv_else">mv:else</a></td>
 <td>Used in conjunction with the <span class="directiveName">mv:if</span> and <span class="directiveName">mv:elsif</span> directives to allow you to create <code>if...  elsif... else... end</code> blocks</td>
 </tr>
+<tr>
+<td class="directive"><a href="#mv_elsif">mv:elsif</a></td>
+<td>Used in conjunction with the <span class="directiveName">mv:if</span> directive to allow you to create <code>if...  elsif... end</code> blocks</td>
+</tr>
 
 <!-- f -->
 <tr>
@@ -1027,8 +1184,12 @@ Used on <code>&lt;input&gt;</code> form elements
 <td>Wraps this element with an <code>if... end</code> block using the attribute contents for the condition</td>
 </tr>
 <tr>
-<td class="directive"><a href="#mv_elsif">mv:elsif</a></td>
-<td>Used in conjunction with the <span class="directiveName">mv:if</span> directive to allow you to create <code>if...  elsif... end</code> blocks</td>
+<td class="directive"><a href="#mv_image_tag">mv:image_tag</a></td>
+<td>Replaces this element using the Rails <code>image_tag</code> helper.
+<span class="explanation">(
+Used on <code>&lt;img&gt;</code> elements
+)</span>
+</td>
 </tr>
 <tr>
 <td class="directive"><a href="#mv_import">mv:import</a></td>
@@ -1097,6 +1258,14 @@ Used on <code>&lt;input&gt;</code> form elements
 
 <!-- r -->
 <tr>
+<td class="directive"><a href="#mv_radio_button">mv:radio_button</a></td>
+<td>Replaces this element with a Rails <code>radio_button</code> helper.
+<span class="explanation">(
+Used on <code>&lt;input&gt;</code> form elements
+)</span>
+</td>
+</tr>
+<tr>
 <td class="directive"><a href="#mv_replace">mv:replace</a></td>
 <td>Replaces this element and its content with the value of the expression</td>
 </tr>
@@ -1163,7 +1332,7 @@ Used on <code>&lt;input&gt;</code> form elements
 <tr>
 <td class="copyright">&copy;&nbsp;Copyright MasterView 2006</td>
 <td class="validators">
-  <a href="http://validator.w3.org/check/referer">[Valid XHTML]</a>
+  <a href="http://validator.w3.org/check/referer"><img src="http://www.w3.org/Icons/valid-xhtml10" title="Valid XHTML 1.0!" alt="Valid XHTML 1.0!" /></a>
 </td>
 </tr>
 </tbody>

data/doc/guide.html

@@ -109,7 +109,7 @@ list]
 <p>
 The generator by default will generate five masterview template files, one
 for each distinct page, list, new, edit, show, and destroy. They exist in
-the app/views/masterview directory with the filename
+the app/views directory with the filename
 controller_action.html. The layout and message partial are defined in the
 list template file and imported into the others. Similarly the new template
 defines the form partial which is imported into edit, and finally the show
@@ -183,7 +183,7 @@ with different stylesheets each will be used.
 </p>
 <p>
 Once it is done generating, the generated MasterView template file will be
-created in app/views/masterview/controller.html. This file is html and can
+created in app/views/CONTROLLER directory. This file is html and can
 be edited with any standard html editor. The rails specific logic is
 contained in simple attributes which are ignored by html editors. The
 syntax for these attributes is heavily derived from the rails helper tags

data/doc/index.html

@@ -161,7 +161,7 @@ of the re-work necessary to build out real-world views.
 
 </li>
 <li>Reduce the numbers of files, simplifying editing. Define partials and
-layouts naturallyl right in the template, no need to go to another file.
+layouts naturally right in the template, no need to go to another file.
 
 </li>
 <li>Preview in browser without running an app. Allow for dummy data in the
@@ -238,7 +238,7 @@ editors and developers would have the full power of Ruby and Rails without
 having to jump through extra hoops to use them. I looked at the available
 html template engines to see if anything fit with my style. I was
 disappointed with each of them, mainly because they all made it harder than
-straigt ERb (rhtml) and were not able to use layouts and partials easily.
+straight ERb (rhtml) and were not able to use layouts and partials easily.
 </p>
 <p>
 After all the hard work so many people have put into Ruby and Rails, I

data/doc/stylesheets/masterview.css

@@ -85,6 +85,13 @@ div#pageHeader div {
  text-align: center;
 }
 
+div#headerNav {
+ width: 800px;
+}
+div#headerNav div {
+  text-align: center;
+}
+
 div#pageBody {
   padding: 15px 20px;
 }
@@ -153,12 +160,18 @@ div#pageFooter td.copyright {
   padding-left: 20px;
   font-size: smaller;
   font-style: italic;
+  vertical-align: middle;
 }
 div#pageFooter td.validators {
   text-align: right;
   padding-right: 20px;
 }
 
+img.w3c_validator {
+  width: 88px;
+  height: 31px;
+}
+
 /* === Page content style elements  ======================================== */
 
 .productName {

data/examples/rails_app_config/masterview/environment/development.rb

@@ -14,8 +14,8 @@
 #config.reparse_changed_masterview_templates = true
 
 # Rails application options that you might want to enable for development
-#config.enable_admin_pages = false
-#config.enable_view_rhtml = false
+#config.enable_admin_pages = true
+#config.enable_view_rhtml = true
 
 # Sample of how you might want to modify logging config for development
 #config.log_level = 'WARN'

data/lib/masterview/attr_string_parser.rb

@@ -0,0 +1,105 @@
+module MasterView
+  class ClosingCharAndMode #:nodoc:
+    attr_reader :closing_char, :in_string
+
+    def initialize(closing_char, in_string) #:nodoc:
+      @closing_char = closing_char
+      @in_string = in_string
+    end
+  end
+
+  # responsible for parsing up the attr_value string into arguments for consumation by directives
+  class AttrStringParser
+    # returns array of string arguments which are trimmed(stripped) representing the arguments
+    # declared in the attr_value string
+    # handles ([{%'" arguments and embedded quotes
+    def self.parse(str)
+      parser = self.new(str)
+      parser.parse
+    end
+
+    def initialize(str)
+      @string_scanner = StringScanner.new(str)
+      @closing_char_mode_stack = []
+      @partial_percent_sequence = nil
+    end
+
+    def parse
+      args = []
+      s = []
+      implicit_hash = false
+      while( c = @string_scanner.getch ) #not nil
+        if @closing_char_mode_stack.last && @closing_char_mode_stack.last.closing_char == c # finished closing_char search
+          @closing_char_mode_stack.pop unless (c == '\'' || c == '"') && s.last == '\\' # if this was an embedded quote
+          s << c
+          next # lets skip all the rest of the logic
+        end
+        unless @closing_char_mode_stack.last && @closing_char_mode_stack.last.in_string  # unless searching for closing char and in string
+          # closings can be created ({["'%, commas break into args (if not in closing search)
+          if c == ',' && @closing_char_mode_stack.empty? && !implicit_hash # not searching for closing, found comma, strip string and push new arg
+            args << s.join.strip
+            s.clear
+            next
+          elsif @partial_percent_sequence
+            case @partial_percent_sequence
+            when '%' # @partial_percent_sequence is %
+              case c
+              when 'q', 'Q', 'r', 's', 'w'
+                @partial_percent_sequence += c
+              when '(', '{', '<', '[' # shorthand %(, %{, %<, %[
+                push_closing_char(c,true) #in_string
+              end
+            when /^%.$/ # @partial_percent_sequence is %q, %Q, %r, %s, %w
+              push_closing_char(c, true) #in_string
+            else
+              @partial_percent_sequence = nil # terminated
+            end
+          else # no partial_percent_sequence
+            case c
+            when '%'
+              @partial_percent_sequence = c if c == '%'
+            when  '\'', '"'
+              push_closing_char(c, true) #in string
+            when '(', '{', '[' # we have started into a bracket, could be hash, array, paren
+              push_closing_char(c, false) #not in string
+            when '>'
+              if s.last == '=' && @closing_char_mode_stack.empty? # we are no in closing_char search and we have a => implying the rest is a hash
+                implicit_hash = true
+              end
+            end
+          end
+        end
+        s << c
+      end
+      args << s.join.strip unless s.empty? # anything left push as arg
+      args
+    end
+
+
+    # determine the closing char for this opening char
+    # used for all the ways to quote ',", %{ [ < ( |
+    # returns nil on alphanumeric
+    def determine_closing_char(opening_char)
+      case opening_char
+      when '{': '}'
+      when '[':  ']'
+      when '(':  ')'
+      when '<':  '>'
+      when /[0-9a-zA-Z]/: nil
+      else
+        opening_char
+      end
+    end
+
+    # determine the closing char, push onto @closing_char_mode_stack
+    # clear @partial_percent_sequence
+    # if invalid opening char, nil will come back from determine so just clear
+    def push_closing_char(opening_char, in_string)
+      @partial_percent_sequence = nil
+      closing_char = determine_closing_char(opening_char)
+      @closing_char_mode_stack.push(ClosingCharAndMode.new(closing_char, in_string)) if closing_char
+    end
+
+
+  end
+end