masterview 0.1.5 → 0.2.0

data/lib/masterview.rb

@@ -28,76 +28,39 @@
 # MasterView is a ruby/rails optimized HTML/XHTML friendly template engine. 
 # It is designed to use the full power and productivity of rails including 
 # layouts, partials, and rails html helpers while still being editable/styleable 
-# in a WYSIWYG HTML editor.  
+# in a WYSIWYG HTML editor.
+# 
+# The MasterView template engine supports a number of configuration settings
+# which allow a client to easily customize its operation.
+# See MasterView::Configuration for a complete description of the
+# supported configuration options.
+# 
+#--
+#TODO: add some documentation in MasterView::DirectiveBase for directive developers:
+# Reference the MV logger using <code>MasterView::Log</code>
+#++
+#
 
+#--
+# Drop the main masterview directory in the plugin dir out of the load path
+# We only needed it around long enough to get this file loaded.
+# Everything else comes out of the subdirectories.
+#++
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
+# MasterView template engine
 module MasterView
-  # set to true to have exceptions rescued
-  RescueExceptions = true
-
-  # :tidy - run tidy before parsing (set TidyPath), :escape_erb - escapes <% %> before parsing
-  DefaultParserOptions = { :tidy => false, :escape_erb => true }
-
-  # paths to load directives from, append your own paths to load custom directives
-  DefaultDirectiveLoadPaths = [ File.join( File.dirname(__FILE__), 'masterview/directives') ]
-
-  # prefix attributes in html with this value
-  NamespacePrefix = 'mv:'
-
-  # relative path under RAILS_ROOT/app/views where masterview templates are loaded
-  TemplateSrcRelativePath = 'masterview'
-
-  # masterview template filename pattern
-  TemplateFilenamePattern = '*.html'
-
-  # extension to use for partials if not provided
-  PartialExtension = '.rhtml'
-
-  # relative path to RAILS_ROOT/app/views where erb (rhtml) will be generated
-  TemplateDestRelativePath = ''
-
-  # boolean which determines whether warning comments will be ommitted (not generated) in rhtml indicating 
-  # the generated file should not be manually edited, false = generate the warning comments
-  OmitGeneratedComments = false
-
-  # template for comment inserted in generated files from MasterView master
-  GeneratedCommentTemplate = <<-END
-#    WARNING - This is a generated file created by MasterView. 
-#    Do not edit - changes will be lost when this file is re-generated.
-# 
-#    To make changes, edit the MasterView source file located at: 
-  END
-
-  # relative path from RAILS_ROOT to where backup files should be created before rebuilding/updating a template file, use nil to suppress backups
-  DirectoryForRebuildBackups = 'tmp/masterview/rebuild/backups'
-
-  # enable MasterView Admin pages
-  EnableMasterViewAdminPages = true
-
-  # boolean which determines whether masterview files will be parsed during rails load and watched on requests.
-  # If true then masterview files will be parsed on rails loading. Additionally if
-  # this is true and the ActionController::Base.perform_caching is false (normally in development mode)
-  # then the masterview files will again be checked (using modified time) to see if any files need to 
-  # be re-parsed. In production mode ActionController::Base.perform_caching is normally true and thus
-  # masterview files will only be parsed on first load. 
-  # If this constant is set to false then no automatic watching or parsing occurs, it would be assumed
-  # that the parsing would have been manually triggered prior.
-  AutoParseMasterViewFiles = true
-
-  # xhtml safe substitution for '<%', make sure to update InlineErbSubstitutionRegex if changed
-  InlineErbStart = '{{{'
-
-  # xhtml safe substitution for '%>', make sure to update InlineErbSubstitutionRegex if changed
-  InlineErbEnd = '}}}'
-
-  # regex used to find escaped InlineErb, needs to match InlineErbStart and InlineErbEnd
-  InlineErbSubstitutionRegex = /\{\{\{(([^}]|\}[^}]|\}\}[^}])*)\}\}\}/
+end
 
-  # sets path to tidy library on this system so masterview templates will be first run through tidy before parsing, 
-  # required if DefaultParserOptions :tidy => true
-  # This allows invalid xhtml to be corrected before parsing
-  TidyPath = '/usr/lib/libtidy.so'
+# Ensure that the initializer gets run in order to load and install configuration settings.
+# Detect here whether the Initializer has been explicitly run by the client's startup.
+# Otherwise, we arrived here from a simple "require 'masterview'" and need to
+# fire up the initializer ourselves to load config settings before the plugin code
+# is loaded below and then to perform final installation configuration.
+should_run_initializer = defined?(MasterView::ConfigSettings).nil?
+if should_run_initializer
+  require 'masterview/initializer'
+  MasterView::Initializer.run(:initialize_configuration)  # bail out at load_plugin to continue below
 end
 
 #external requires
@@ -109,6 +72,9 @@ require 'strscan'
 require 'find'
 require 'erb'
 require 'stringio'
+require 'set'
+require 'pathname'
+require 'ostruct'
 
 #external gem requires
 require 'facets/core/string/blank'
@@ -122,36 +88,25 @@ begin
 rescue LoadError
   # Tidy was not available to load
 end
-# log4r is required in section below
 
 #internal requires
 require 'masterview/masterview_version'
+require 'masterview/pathname_extensions'
+require 'masterview/filter_helpers'
+require 'masterview/mtime_tracking_hash'
+require 'masterview/io'
+require 'masterview/keyword_expander'
 require 'masterview/string_extensions'
 require 'masterview/plugin_load_tracking'
 require 'masterview/directive_helpers'
 require 'masterview/directive_base'
-require 'masterview/runtime_helpers'
 require 'masterview/parser'
 require 'masterview/analyzer'
 require 'masterview/template_spec'
-include MasterView::RuntimeHelpers
-
-# set these constants after everything has been required
-module MasterView
-  DefaultSerializer = FileSerializer
 
-  # setup logger
-  begin 
-    require 'log4r' 
-    include Log4r # will use log4r if available, otherwise default to logger
+require 'masterview/runtime_helpers'
+include MasterView::RuntimeHelpers
 
-    # Logger which will be used to output debug, warn, and error messages, will use log4r if available, otherwise logger
-    Log = Logger.new 'MasterView'
-    Log.outputters = Outputter.stdout
-  rescue LoadError, NameError # else fallback to built in logger 
-    require 'logger'
-    Log = Logger.new STDOUT # :nodoc:
-  end
+if should_run_initializer
+  MasterView::Initializer.run(:complete_plugin_installation, MasterView::ConfigSettings)
 end
-
-

data/test/fixtures/configs/fake_rails_app_with_config/config/masterview/environments/development.rb

@@ -0,0 +1,12 @@
+# Development environment config settings for the MasterView plugin.
+#
+# The MasterView configuration specification is referenced through +config+.
+# 
+# Settings specified here will take precedence over those specified in the 
+# general MasterView config in +config/masterview/settings.rb+.
+#
+
+# set development-mode config settings here
+
+# Try running in a test mode with some alternate templates
+config.template_src_dir_path = 'app/mv_test_templates'

data/test/fixtures/configs/fake_rails_app_with_config/config/masterview/environments/production.rb

@@ -0,0 +1,11 @@
+# Development environment config settings for the MasterView plugin.
+#
+# The MasterView configuration specification is referenced through +config+.
+# 
+# Settings specified here will take precedence over those specified in the 
+# general MasterView config in +config/masterview/settings.rb+.
+#
+
+# set production-mode config settings here
+# Only use the MasterView admin pages for development
+config.enable_admin_pages = false

data/test/fixtures/configs/fake_rails_app_with_config/config/masterview/settings.rb

@@ -0,0 +1,23 @@
+# Global config settings for the MasterView plugin.
+# 
+# This code is run at plugin load time, after the base rails framework
+# has been loaded and configured, but before any application-specific config
+# in +environment.rb+ is run.
+# 
+# The MasterView configuration specification is referenced through +config+.
+# 
+# General settings can be overridden for specific environments by providing
+# additional settings values in +config/masterview/environments/#{environment}.rb+.
+# 
+# See Rails::Configuration for details on the available configuration settings.
+# 
+
+# MasterView templates are used to generate pages handled by the content controller in this application
+#config.template_src_dir_abs_path( File.join( config.root_path, 'app/views-masterview-templates' ) )
+config.template_dst_dir_path = 'app/views/content'
+
+# generate a more concise generated-file warning comment that the standard MV comment
+config.generated_file_comment = "# -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --"
+config.generated_file_comment << "\n# DO NOT EDIT - generated by MasterView from template file:\n"
+config.generated_file_comment << '#   #{template_path}'  # carefully avoid premature substitution eval
+config.generated_file_comment << "\n# -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --"

data/test/fixtures/templates/product.html

@@ -0,0 +1,256 @@
+<html mv:generate="layouts/product.rhtml">
+  <head>
+    <title>Product: {{{= controller.action_name }}}</title>
+    <link rel="stylesheet" type="text/css" href="../../../public/stylesheets/scaffold.css" mv:stylesheet_link="scaffold"/>
+
+      <!--
+           These stylesheets below are for design time use to allow working with only one visible section at a time, especially 
+           when trying to use absolute positioning. You may comment/uncomment which ever section you wish to work with.
+	   You may comment all of them out to work with all at design time. These stylesheets will not be used at runtime
+      -->
+      <link rel="stylesheet" type="text/css" href="./extra/show_only_new.css" mv:replace=""/>
+      <!-- <link rel="stylesheet" type="text/css" href="./extra/show_only_edit.css" mv:replace=""/> -->
+      <!-- <link rel="stylesheet" type="text/css" href="./extra/show_only_show.css" mv:replace=""/> -->
+      <!-- <link rel="stylesheet" type="text/css" href="./extra/show_only_list.css" mv:replace=""/> -->
+      <!-- <link rel="stylesheet" type="text/css" href="./extra/show_only_destroy.css" mv:replace=""/> -->
+
+      <script type="text/javascript" src="../../../public/javascripts/prototype.js" mv:javascript_include=":defaults"></script>
+      <script type="text/javascript" src="../../../public/javascripts/effects.js" mv:replace=""></script>
+      <script type="text/javascript" src="../../../public/javascripts/dragdrop.js" mv:replace=""></script>
+      <script type="text/javascript" src="../../../public/javascripts/controls.js" mv:replace=""></script>
+      <script type="text/javascript" src="../../../public/javascripts/application.js" mv:replace=""></script>
+  </head>
+  <body>
+
+    <div class="messages" mv:if="@flash[:notice]" mv:content="@flash[:notice]">
+      messages here - Note: Other divs are hidden at design time, disable extra/show_only_new.css or import different extra/*.css to work with other sections (extra stylesheets are show_only_edit.css, show_only_show.css, show_only_list.css, show_only_destroy.css)
+    </div>
+
+    <div class="main">
+      <div id="product_content" mv:replace="@content_for_layout">
+	<div id="product_new" mv:generate="product/new.rhtml" mv:preview="showOne" class="new_div">
+	  <div class="product_new sidebar">
+	    <h1>Tasks:</h1>
+	    <ul>
+	      <li><a class="list_link" href="#" mv:link_to=":action => 'list'">Back to overview</a></li>
+	    </ul> 
+	  </div>
+
+	  <div class="product_new content">
+	    <h1>Products</h1>
+
+	    <form mv:form=":action => 'new'">
+
+	    <div class="form">	
+	      <h2>Creating product</h2>
+
+	      <div id="product_form" mv:gen_partial=":partial => 'product/form'">
+		<div class="error_messages" mv:replace="error_messages_for :product">
+		  error messages
+		</div>
+		<br/>
+		<!--[form:product]-->
+<div class="form_div product_form_div">
+
+  <div class="record">
+    <div class="label"><label for="product_name">Name:</label></div>
+    <div class="field"><input type="text" name="product_name" mv:text_field="'product', 'name'"/></div>
+  </div>
+
+  <div class="record">
+    <div class="label"><label for="product_description">Description:</label></div>
+    <div class="field"><textarea name="product_description" rows="5" mv:text_area="'product', 'description'"></textarea></div>
+  </div>
+
+  <div class="record">
+    <div class="label"><label for="product_cost">Cost:</label></div>
+    <div class="field"><input type="text" name="product_cost" mv:text_field="'product', 'cost'"/></div>
+  </div>
+
+  <div class="record">
+    <div class="label"><label for="product_price">Price:</label></div>
+    <div class="field"><input type="text" name="product_price" mv:text_field="'product', 'price'"/></div>
+  </div>
+
+</div>
+<!--[eoform:product]-->
+
+	      </div>
+
+	    </div>
+
+	    <br/>
+	    <div class="product_new operations">
+	      <input type="submit" value="OK" class="primary save_button" mv:submit=""/>
+	      <input type="button" value="Cancel" class="cancel_button" style="width: auto;" onclick="window.location.href = '{{{= url_for :action => %q{list} }}}';" />
+	    </div>
+
+	    </form>
+	  </div>
+	</div>
+
+
+	<div id="product_edit" mv:generate="product/edit.rhtml" mv:preview="showOne" class="edit_div">
+	  <div class="product_edit sidebar">
+	    <h1>Tasks:</h1>
+	    <ul>
+	      <li><a class="list_link" href="#" mv:link_to=":action => 'list'">Back to overview</a></li>
+	    </ul> 
+	  </div>
+
+	  <div class="product_edit content">
+	    <h1>Products</h1>
+
+	    <form mv:form=":action => 'edit', :id => @product.id">
+
+	    <div class="form">	
+	      <h2>Editing product</h2>
+	      <div mv:replace="render :partial => 'form'" mv:preview="copyOf:product_form">
+		copyOf:product_form
+	      </div>
+	    </div>
+
+	    <br/>
+	    <div class="product_edit operations">
+ 	      <input type="submit" value="OK" class="primary save_button" mv:submit=""/>
+	      <input type="button" value="Cancel" class="cancel_button" style="width: auto;" onclick="window.location.href = '{{{= url_for :action => %q{list} }}}';" />         </div>
+
+	    </form>
+	  </div>
+	</div>
+
+
+	<div id="product_list" mv:generate="product/list.rhtml" mv:preview="showOne" class="list_div">
+	  <div class="product_list sidebar">
+	    <h1>Tasks:</h1>
+	    <ul>
+	      <li><a class="new_link" href="#" mv:link_to=":action => 'new'">Create new product</a></li>
+	    </ul> 
+	  </div>
+
+	  <div class="product_list content">
+	    <h1>Products</h1>
+
+	    <div class="list">	
+	      <table border="1" class="product_list_table" cellpadding="5">
+	      <tr>
+		<!--[listhead:product]-->
+<th class="th_name">Name</th>
+<th class="th_description">Description</th>
+<th class="th_cost">Cost</th>
+<th class="th_price">Price</th>
+<!--[eolisthead:product]-->
+
+	      </tr>
+	      <tr mv:gen_partial=":partial => 'product/product', :collection => @products">
+		<!--[listline:product]-->
+
+<td class="td_name" mv:content="h product.send(:name)">product Name</td>
+<td class="td_description" mv:content="h product.send(:description)">product Description</td>
+<td class="td_cost" mv:content="h product.send(:cost)">product Cost</td>
+<td class="td_price" mv:content="h product.send(:price)">product Price</td>
+<td><a class="show_link" href="#" mv:link_to=":action => 'show', :id => product">Show</a></td>
+<td><a class="edit_link" href="#" mv:link_to=":action => 'edit', :id => product">Edit</a></td>
+<td><a class="destroy_link" href="#" mv:link_to=":action => 'destroy', :id => product">Destroy</a></td>
+
+<!--[eolistline:product]-->
+
+	      </tr>
+	      </table>
+
+	      <a class="previous_link" href="#" mv:if="@product_pages.current.previous" mv:link_to=":page => @product_pages.current.previous">Previous page</a>
+	      <a class="next_link" href="#" mv:if="@product_pages.current.next" mv:link_to=":page => @product_pages.current.next">Next page</a>
+
+	    </div>                      
+	  </div>
+	</div>
+
+
+	<div id="product_show" mv:generate="product/show.rhtml" mv:preview="showOne" class="show_div">
+	  <div class="product_show sidebar">
+	    <h1>Tasks:</h1>
+	    <ul>
+	      <li><a class="list_link" href="#" mv:link_to=":action => 'list'">Back to overview</a></li>
+	      <li><a class="edit_link" href="#" mv:link_to=":action => 'edit', :id => @product.id">Edit this product</a></li>
+	    </ul>
+	  </div>
+
+	  <div class="product_show content">
+	    <h1>Products</h1>
+
+	    <div id="product_show_partial" class="form" mv:gen_partial=":partial => 'product/show'">
+		<!--[show:product]-->
+<div class="show_div product_show_div">
+
+  <div class="record">
+    <div class="label"><label>Name:</label></div>
+    <div class="field" mv:content="h @product.send(:name)">product Name</div>
+  </div>
+
+  <div class="record">
+    <div class="label"><label>Description:</label></div>
+    <div class="field" mv:content="h @product.send(:description)">product Description</div>
+  </div>
+
+  <div class="record">
+    <div class="label"><label>Cost:</label></div>
+    <div class="field" mv:content="h @product.send(:cost)">product Cost</div>
+  </div>
+
+  <div class="record">
+    <div class="label"><label>Price:</label></div>
+    <div class="field" mv:content="h @product.send(:price)">product Price</div>
+  </div>
+
+</div><!--[eoshow:product]-->
+
+	    </div>
+
+	  </div>
+	</div>
+
+      <div id="product_destroy" mv:generate="product/destroy.rhtml" mv:preview="showOne" class="destroy_div">
+	<div class="product_destroy sidebar">
+	  <h1>Tasks:</h1>
+	  <ul>
+	    <li><a class="list_link" href="#" mv:link_to=":action => 'list'">Back to overview</a></li>
+	    <li><a class="show_link" href="#" mv:link_to=":action => 'show', :id => @product.id">Show this product</a></li>
+	  </ul> 
+	</div>
+
+	<div class="product_destroy content">
+	  <h1>Products</h1>
+
+	  <div class="error_messages" mv:replace="error_messages_for :product">
+	    error messages
+	  </div>
+
+	  <div class="messages">Are you sure you want to delete this item?</div>
+	  <br/>
+	    <form mv:form=":action => 'destroy', :id => @product.id">
+	      <div mv:replace="render :partial => 'show'" mv:preview="copyOf:product_show_partial">
+		copyOf:product_show_partial
+	      </div>
+
+	      <br/>
+	      <div class="product_edit operations">
+		<input type="submit" value="Delete" mv:submit="" class="save_button"/>
+		<input type="button" value="Cancel" class="cancel_button" style="width: auto;" onclick="window.location.href = '{{{= url_for :action => %q{list} }}}';" />         
+	      </div>
+	    </form>
+	  </div>
+	</div>
+      </div>
+    </div>
+
+    <script type="text/javascript" mv:replace="" src="./extra/mvpreview.js"></script>
+    <script type="text/javascript" mv:replace="">
+      mvpreview.preparePage( 'product', {showOneSection: 'product_list' } );  
+    </script>
+
+    </body>
+</html>
+
+
+
+

data/test/fixtures/templates/test.import

@@ -0,0 +1,80 @@
+<html mv:import="layouts/product.rhtml">
+  <head>
+    <title>Product: {{{= controller.action_name }}}</title>
+    <link href="../../../public/stylesheets/scaffold.css" mv:stylesheet_link="scaffold" rel="stylesheet" type="text/css"/>
+
+      <!--
+           These stylesheets below are for design time use to allow working with only one visible section at a time, especially 
+           when trying to use absolute positioning. You may comment/uncomment which ever section you wish to work with.
+	   You may comment all of them out to work with all at design time. These stylesheets will not be used at runtime
+      -->
+      <link href="./extra/show_only_new.css" mv:replace="" rel="stylesheet" type="text/css"/>
+      <!-- <link rel="stylesheet" type="text/css" href="./extra/show_only_edit.css" mv:replace=""/> -->
+      <!-- <link rel="stylesheet" type="text/css" href="./extra/show_only_show.css" mv:replace=""/> -->
+      <!-- <link rel="stylesheet" type="text/css" href="./extra/show_only_list.css" mv:replace=""/> -->
+      <!-- <link rel="stylesheet" type="text/css" href="./extra/show_only_destroy.css" mv:replace=""/> -->
+
+      <script mv:javascript_include=":defaults" src="../../../public/javascripts/prototype.js" type="text/javascript"></script>
+      <script mv:replace="" src="../../../public/javascripts/effects.js" type="text/javascript"></script>
+      <script mv:replace="" src="../../../public/javascripts/dragdrop.js" type="text/javascript"></script>
+      <script mv:replace="" src="../../../public/javascripts/controls.js" type="text/javascript"></script>
+      <script mv:replace="" src="../../../public/javascripts/application.js" type="text/javascript"></script>
+  </head>
+  <body>
+
+    <div class="messages" mv:content="@flash[:notice]" mv:if="@flash[:notice]">
+      messages here - Note: Other divs are hidden at design time, disable extra/show_only_new.css or import different extra/*.css to work with other sections (extra stylesheets are show_only_edit.css, show_only_show.css, show_only_list.css, show_only_destroy.css)
+    </div>
+
+    <div class="main">
+      <div id="product_content" mv:replace="@content_for_layout">
+	<div class="new_div" id="product_new" mv:generate="product/test.rhtml" mv:preview="showOne">
+	  Test world
+
+	      <div id="product_form" mv:import_render=":partial => 'product/form'">
+		<div class="error_messages" mv:replace="error_messages_for :product">
+		  error messages
+		</div>
+		<br/>
+		<!--[form:product]-->
+<div class="form_div product_form_div">
+
+  <div class="record">
+    <div class="label"><label for="product_name">Name:</label></div>
+    <div class="field"><input mv:text_field="'product', 'name'" name="product_name" type="text"/></div>
+  </div>
+
+  <div class="record">
+    <div class="label"><label for="product_description">Description:</label></div>
+    <div class="field"><textarea mv:text_area="'product', 'description'" name="product_description" rows="5"/></div>
+  </div>
+
+  <div class="record">
+    <div class="label"><label for="product_cost">Cost:</label></div>
+    <div class="field"><input mv:text_field="'product', 'cost'" name="product_cost" type="text"/></div>
+  </div>
+
+  <div class="record">
+    <div class="label"><label for="product_price">Price:</label></div>
+    <div class="field"><input mv:text_field="'product', 'price'" name="product_price" type="text"/></div>
+  </div>
+
+</div>
+<!--[eoform:product]-->
+
+	      </div>
+
+	    more test
+
+	</div>
+      </div>
+    </div>
+
+    <script mv:replace="" src="./extra/mvpreview.js" type="text/javascript"></script>
+    <script mv:replace="" type="text/javascript">
+      mvpreview.preparePage( 'product', {showOneSection: 'product_list' } );  
+    </script>
+
+    </body>
+</html>
+.

data/test/test_helper.rb

@@ -5,18 +5,20 @@ require File.join( currentPath, '../lib/masterview' )
 
 MasterView::OmitGeneratedComments = true #turn off the generated comments to make it easier for us to test
 
+
 module Test
   module Unit
     module Assertions
         def assert_template_result(expected, template, options={}, message=nil)
+          #options[:template_pathname] = Pathname.for_path(options.delete(:template_path)) if options[:template_path]
           output_hash = {}
-          full_options = options.merge( { :serializer => MasterView::HashSerializer.new(output_hash) } )
+          full_options = options.merge( { :output_mio_tree => MasterView::IOMgr.erb } )
           MasterView::Parser.parse(template, full_options)
-          output_hash.each do |key,value|
+          MasterView::IOMgr.erb.string_hash.each do |key,value|
             value.gsub!( /([^=]>)\s+/, '\1' ) #remove whitespace after tag but not => 
             value.gsub!( /(\s{2,}|\n\s*)/, ' ') #change double space or newline and spaces into single space 
           end
-          assert_equal expected, output_hash, message
+          assert_equal expected, MasterView::IOMgr.erb.string_hash, message
         end 
     end
   end

data/test/tmp/template/foo.txt

@@ -0,0 +1 @@
+helloworld