masterview 0.3.2 → 0.3.3

data/lib/masterview/initializer.rb

@@ -290,6 +290,31 @@ module MasterView
     #
     attr_accessor :template_asset_base_ref_pattern
 
+    # Configuration for locations of files that MasterView will autocopy to a runtime location.
+    # This autocopy feature makes it easy to have prototypes that display properly for
+    # WYSIWYG editing and design, using files (images, stylesheets, and javascript) which are not
+    # in the standard Rails locations but are automatically copied to proper place for runtime.
+    # This is commonly used in conjunction with template_src_dir_path (which changes the
+    # location of the source MasterView templates). Developers can have their templates in a non-standard
+    # location along with images, stylesheets, and javascript, and then still have everything copied to
+    # the proper runtime locations when Rails is fired up. In debug mode, timestamps are checked on every request,
+    # in production mode, copy is done only on startup.
+    #
+    # Each entry is a hash that needs to contain
+    # :source => 'path to source folder' # absolute or relative to RAILS_ROOT
+    # :destination => 'path to place to copy to' # absolute or relative to RAILS_ROOT
+    #
+    # and can optionally have a file extension filter
+    # :extensions => [:gif, :GIF, :jpg, :JPG] # limit files copied to this array of extensions, case sensitive
+    #
+    # Default: [] (empty array) - nothing is auto copied
+    # Example usage showing three paths added to be auto copied:
+    # config.auto_copy_file_entries << { :source => 'path_to_my_images', :destination => 'public/images' }
+    # config.auto_copy_file_entries << { :source => 'path_to_my_scripts', :destination => 'public/javascripts', :extensions => [:js, :JS] } # only copy js files
+    # config.auto_copy_file_entries << { :source => 'path_to_my_css', :destination => 'public/stylesheets' }
+    attr_accessor :auto_copy_file_entries
+
+
     # === Template Generation Options
 
     # Path to the directory where Masterview template output (rhtml)
@@ -401,6 +426,15 @@ module MasterView
     # Needs to match +inline_erb_start+ and +inline_erb_end+.
     attr_accessor :inline_erb_substitution_regex
 
+    # boolean to specify whether to use the original (unpatched) rexml sax2parser.
+    # If this is not true and the REXML version is 3.1.4 -3.1.6 MasterView will use
+    # a patched version of rexml sax2parser which properly handles doctypes.
+    # If this is true or the REXML version is outside this range the original
+    # sax2 parser will be used
+    #
+    # Default: <tt>false</tt>
+    attr_accessor :use_original_rexml_sax2parser
+
     # === Rails Application Options
 
     # Boolean which specifies whether masterview templates are parsed
@@ -537,9 +571,10 @@ module MasterView
       @mv_code_base_dir = File.expand_path( File.dirname(__FILE__) )
       builtin_directives_path = File.join( mv_code_base_dir, 'directives')
       @mv_installation_dir = File.expand_path( "#{File.dirname(__FILE__)}/../.." )
+      @auto_copy_file_entries = []
 
       #ISSUE: should probably also detect std console or breakpointer launch scripts [DJL 10-Jun-2006]
-      @rails_runner_scripts_pattern = /server|dispatch|mongrel_rails|cgi/ #cgi picks up scgi and fcgi
+      @rails_runner_scripts_pattern = /server|dispatch|mongrel_rails|cgi|-e/ #cgi picks up scgi and fcgi, -e for RadRails
 
       @has_rails_context = (defined?(::RAILS_ROOT) != nil)
       decide_if_running_rails
@@ -676,6 +711,7 @@ module MasterView
       @running_rails = has_rails_context && ($PROGRAM_NAME =~ rails_runner_scripts_pattern) != nil
 
       # TODO could try checking if things are defined instead but what would we check for?? Something related to Dispatcher?
+      # Dispatcher doesn't seemed to be defined when we come through here
       # @running_rails = has_rails_context && (defined?(::Dispatcher.dispatch)) != nil
     end
 
@@ -713,12 +749,12 @@ module MasterView
 
     # Add masterview directive implementations from plugins
     # to the masterview directive load path
-    # 
+    #
     # EXPERIMENTAL PROTOTYPE - NOT YET PUBLICIZED [DJL 13-Feb-2007]
     def add_plugin_directives(*base_paths) #:nodo:
       # append plugin directives in alphabetical order, per Rails plugin loading
       plugin_directives = find_plugin_directives(base_paths)
-      plugin_directives.each { | plugin_dir_path | 
+      plugin_directives.each { | plugin_dir_path |
         add_directive_path plugin_dir_path
       }
       plugin_directives
@@ -728,7 +764,7 @@ module MasterView
       # Return list of directives paths from plugins
       def find_plugin_directives(*base_paths)
         directive_paths = []
-        find_plugins(base_paths).each do | plugin_dir_path | 
+        find_plugins(base_paths).each do | plugin_dir_path |
           next if File.basename(plugin_dir_path) == 'masterview'  #skip masterview's own built-in directives
           directive_dir_path = File.join(plugin_dir_path, 'directives')
           if File.directory?(directive_dir_path)
@@ -974,6 +1010,7 @@ module MasterView
       MasterView.const_set('InlineErbStart', config.inline_erb_start)
       MasterView.const_set('InlineErbEnd', config.inline_erb_end)
       MasterView.const_set('InlineErbSubstitutionRegex', config.inline_erb_substitution_regex)
+      MasterView.const_set('UseOriginalRexmlSax2Parser', config.use_original_rexml_sax2parser)
 
       # Rails application options
       MasterView.const_set('ParseMasterViewTemplatesAtStartup', config.parse_masterview_templates_at_startup)
@@ -996,6 +1033,8 @@ module MasterView
                                         configuration.namespace_prefix_extensions )
       initialize_logger
       initialize_mio
+      set_rexml_parser_class
+      initialize_auto_copy_files
       #Back out experiment: causes load order problems
       ##load_directives  # held off on this until logger is installed
       install_in_rails
@@ -1039,6 +1078,45 @@ module MasterView
       MasterView::LoadedFeatures[:tidy_template_read] = config.default_parser_options[:tidy]
     end
 
+    # Initialize the auto_copy_files MasterView I/O and AutoCopy setup
+    def initialize_auto_copy_files
+      require 'masterview/extras/auto_copy'
+      auto_copy_file_entries = configuration.auto_copy_file_entries
+      if auto_copy_file_entries
+        auto_copy_file_entries.each do |entry|
+          if entry[:source] && entry[:destination]
+            sourceMIO = MasterView::MIO::FileMIOTree.new(entry[:source])
+            destMIO = MasterView::MIO::FileMIOTree.new(entry[:destination])
+            extensions = entry[:extensions] || []
+            filename_patterns = extensions.collect{ |ext| "*.#{ext.to_s}" }
+            filename_patterns = ['*'] if filename_patterns.empty?
+            filename_pattern_for_log = (filename_patterns.empty?) ? '*' : filename_patterns.join(',')
+            MasterView::AutoCopy.register(sourceMIO, destMIO, filename_patterns)
+            MasterView::Log.info{ "Auto copying files from #{entry[:source]} to #{entry[:destination]} with filter #{filename_patterns.join(',')}" }
+          else
+            MasterView::Log.error{ 'config.auto_copy_file_entries entry is missing required :source or :destination values, will be ignored. entry='+entry.inspect }
+          end
+        end
+      end
+    end
+
+    # set the REXML SAX2ParserClass, use patched parser or standard SAX2Parser
+    # checks version of REXML and value of :use_patched_rexml_sax2parser
+    def set_rexml_parser_class
+      if REXML::Version < '3.1.4' # below minimum version
+        MasterView::Log.error { 'Fatal error: MasterView requires REXML version 3.1.4 or greater' }
+        raise 'Fatal error: MasterView requires REXML version 3.1.4 or greater'
+      elsif MasterView::UseOriginalRexmlSax2Parser || !['3.1.4', '3.1.5', '3.1.6'].include?(REXML::Version)
+        MasterView::Log.info { 'MasterView using REXML Sax2Parser version = '+REXML::Version }
+        require 'rexml/parsers/sax2parser'
+        MasterView.const_set('REXMLSax2ParserClass', REXML::Parsers::SAX2Parser)
+      else
+        MasterView::Log.info { 'MasterView using REXML '+REXML::VERSION+' Sax2ParserWithDoctypeFix' }
+        require 'rexml/parsers/sax2parser_with_doctype_fix'
+        MasterView.const_set('REXMLSax2ParserClass', REXML::Parsers::SAX2ParserWithDoctypeFix)
+      end
+    end
+
     #NOTE: not currently used - caused problems during startup, so reverted to original
     # scheme where loading is triggered on demand by template parsing
     # [SJL 20-Sep-2006]
@@ -1052,6 +1130,7 @@ module MasterView
       return if ! configuration.on_rails?
       enable_mv_admin_pages
       parse_templates_at_startup
+      auto_copy_at_startup
       enable_reparse_changed_templates
       enable_rails_erb_direct
       MasterView::Log.info{  'MasterView plugin initialized - Version '+MasterView::VERSION::STRING }
@@ -1074,6 +1153,10 @@ module MasterView
       end
     end
 
+    def auto_copy_at_startup #:nodoc:
+      MasterView::AutoCopy.copy_all_updated_files
+    end
+
     #--
     # DBC-style notation per DbC - rubydbc-0.1 (Andy Hunt's Design by Contract)
     #pre( MasterView::ParseMasterViewTemplatesAtStartup )

data/lib/masterview/io.rb

@@ -259,6 +259,11 @@ module MIO
       end
       written
     end
+
+    # remove - delete file
+    def remove
+      full_pathname.delete
+    end
   end
 
   class StringMIO < MIOBase
@@ -295,6 +300,11 @@ module MIO
     def exist?
       @string_hash.has_key?(self.pathname.to_s)
     end
+
+    # remove - delete hash entry
+    def remove
+      @string_hash.delete(self.pathname.to_s)
+    end
   end
 
   # used by MTimeStringHashMIOTree to create MIO objects that check
@@ -314,6 +324,7 @@ module MIO
     include MasterViewIOIdenticalMixin
     def exist?; end
     def mtime; end
+    def remove; end
   end
 
 

data/lib/masterview/masterview_version.rb

@@ -2,7 +2,7 @@ module MasterView
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 3
-    TINY  = 2
+    TINY  = 3
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/masterview/mtime_tracking_hash.rb

@@ -1,9 +1,9 @@
 module MasterView
 
   # this hash is designed to track modified times of its values
-  # this behaviour is only supported through using []= and store 
+  # this behaviour is only supported through using []= and store
   # mechanisms and thus default semantics have been excluded
-  # other update methods such as merge! have been excluded from 
+  # other update methods such as merge! have been excluded from
   # this implementation and will raise errors
   class MTimeTrackingHash < Hash
 
@@ -13,7 +13,7 @@ module MasterView
       super
       @mtimes = {}
     end
-    
+
     def []=(key, value)
       update_mtime(key)
       super
@@ -24,6 +24,11 @@ module MasterView
       super
     end
 
+    def delete(key)
+      delete_mtime(key)
+      super
+    end
+
     # returns the Time object for this key
     def mtime(key)
       @mtimes[key]
@@ -35,6 +40,10 @@ module MasterView
       @mtimes[key] = Time.now
     end
 
+    def delete_mtime(key)
+      @mtimes.delete(key)
+    end
+
     def default=(obj); raise "Not implemented"; end
     def merge!(obj,&block); raise "Not implemented"; end
     def reject!(obj,&block); raise "Not implemented"; end

data/lib/masterview/parser.rb

@@ -596,7 +596,7 @@ module MasterView
     end
 
     def generate_replace(value)
-      @renderer.append_raw ERB_EVAL_START+value+ERB_EVAL_END
+      @renderer.append_raw ERB_CONTENT_START+value+ERB_CONTENT_END
     end
 
     # handle a mv:gen_partial attribute, which calls generate and outputs a token
@@ -690,7 +690,7 @@ module MasterView
       ensure_standard_options_configured(options)
 
       begin
-        sax_parser = REXML::Parsers::SAX2ParserWithDoctypeFix.new( template )
+        sax_parser = MasterView::REXMLSax2ParserClass.new( template )
         options[:listeners].each do |listener|
           if listener.is_a? Class
             sax_parser.listen( listener.new(options) )

data/lib/masterview/rails_ext/action_controller_reparse_checking.rb

@@ -1,16 +1,16 @@
 #
 # Installs hooks to insert MasterView changed-template reparsing
 # into the Rails request dispatching handler in ActionController::Base.
-# 
+#
 # Ensures that MasterView output files are always current while running a
 # Rails application.  The <code>:rails_reparse_checking</code> option in the
-# MasterView configuration should generally be enabled/disabled in conjunction 
-# with Rails class load caching, which is normally off in a development environment 
-# configuration.  
-# 
-# Requires that MasterView templates be parsed at application startup to properly 
+# MasterView configuration should generally be enabled/disabled in conjunction
+# with Rails class load caching, which is normally off in a development environment
+# configuration.
+#
+# Requires that MasterView templates be parsed at application startup to properly
 # initialize the mechanism for detecting template changes after application startup.
-# 
+#
 
 module ActionController #:nodoc:
   class Base #:nodoc
@@ -18,10 +18,11 @@ module ActionController #:nodoc:
     # changed templates during Rails request dispatching.
     alias :process_pre_mv :process #:nodoc:
     def process(request, response, method = :perform_action, *arguments) #:nodoc:
-      MasterView::TemplateWatcher.check_updated(MasterView::IOMgr.template, MasterView::TemplateFilenamePattern ) do |mio| 
+      MasterView::TemplateWatcher.check_updated(MasterView::IOMgr.template, MasterView::TemplateFilenamePattern ) do |mio|
         MasterView::Parser.parse_mio( mio, MasterView::IOMgr.erb )
       end
+      MasterView::AutoCopy.copy_all_updated_files
       process_pre_mv(request, response, method, *arguments)
     end
   end
-end
+end

data/lib/masterview/rails_ext/action_view_erb_direct.rb

@@ -12,6 +12,8 @@
 # to rewrite this code to use the provided hooks.
 #
 
+require File.join( File.dirname(__FILE__), 'short_path_calc' )
+
 module ActionView #:nodoc:
 
   class Base #:nodoc:
@@ -20,20 +22,31 @@ module ActionView #:nodoc:
     # check MasterView paths because might not exist on file system
     alias :template_exists_pre_mv? :template_exists? #:nodoc:
     def template_exists?(template_path, extension) #:nodoc:
-      short_path = template_path+'.'+extension.to_s
-      template_exists_pre_mv?(template_path, extension) || MasterView::IOMgr.erb.path(short_path).exist?
+      found = template_exists_pre_mv?(template_path, extension)
+      #MasterView::Log.debug{ "template_exists? tpath=#{template_path} base=#{self.base_path}"}
+
+      # template is relative to view_base
+      unless found
+        short_path_no_ext = MasterView::RailsExt::ShortPathCalculator.calc_short_path(self.base_path, template_path)
+        if short_path_no_ext
+          short_path = short_path_no_ext+'.'+extension.to_s
+          found = MasterView::IOMgr.erb.path(short_path).exist?
+        end
+      end
+      found
     end
 
     # checks for the existence of the template in MasterView first before using the
     # rails file system based read_template_file
     alias :read_template_file_pre_mv :read_template_file  #:nodoc:
-    def read_template_file(template_path, extension)  #:nodoc:
-      short_path_mio = MasterView::IOMgr.erb.path(short_relative_path_mv(template_path))
-      if short_path_mio.exist?
-        short_path_mio.read
-      else # use original rails read_template_file
-        read_template_file_pre_mv(template_path, extension)
-      end
+    def read_template_file(template_path_with_ext, extension)  #:nodoc:
+      #MasterView::Log.debug{ "read_template_file tpath=#{template_path_with_ext}  base=#{self.base_path}"}
+
+      # template is relative to Rails root
+      # if short_path found and exists in mio, then read and return otherwise use original read method
+      MasterView::RailsExt::ShortPathCalculator.calc_short_path_and_retrieve(MasterView::ConfigSettings.rails_root_path, template_path_with_ext,
+                                                                             MasterView::IOMgr.erb) ||
+        read_template_file_pre_mv(template_path_with_ext, extension)
     end
 
     # I submitted a patch to rails to make this easier it was picked up in changeset 5587
@@ -47,16 +60,18 @@ module ActionView #:nodoc:
       # not stored on the file system can hook and extend appropriately
       alias :template_changed_since_pre_mv? :template_changed_since?
       def template_changed_since?(file_name, compile_time)
-        short_path_mio = (file_name && !file_name.empty?) ? MasterView::IOMgr.erb.path(short_relative_path_mv(file_name)) : nil
-        if short_path_mio && short_path_mio.exist? # mio template so use mv to check if changed
-          compile_time < short_path_mio.mtime
+        #MasterView::Log.debug { "template_changed_since? tpath=#{file_name}  base=#{self.base_path}"}
+
+        # template is relative to rails root
+        mio_mtime = MasterView::RailsExt::ShortPathCalculator.calc_short_path_and_get_mtime(MasterView::ConfigSettings.rails_root_path, file_name,
+                                                                                            MasterView::IOMgr.erb)
+        if mio_mtime
+          compile_time < mio_mtime
         else # delegate to rails original file based version
           template_changed_since_pre_mv?(file_name, compile_time)
         end
       end
 
-      public
-
     else # older rails needs to use old method
 
       # Check whether compilation is necessary.
@@ -66,15 +81,19 @@ module ActionView #:nodoc:
       # original code.
       alias :compile_template_pre_mv? :compile_template?   #:nodoc:
       def compile_template?(template, file_name, local_assigns) #:nodoc:
-        short_path_mio = (file_name && !file_name.empty?) ? MasterView::IOMgr.erb.path(short_relative_path_mv(file_name)) : nil
-        if short_path_mio && short_path_mio.exist? # mio template
+        #MasterView::Log.debug { "compile_template?  tpath=#{file_name} base=#{self.base_path}"}
+
+        # templat is relative to Rails root
+        mio_mtime = MasterView::RailsExt::ShortPathCalculator.calc_short_path_and_get_mtime(MasterView::ConfigSettings.rails_root_path, file_name,
+                                                                                            MasterView::IOMgr.erb)
+        if mio_mtime
           method_key    = file_name || template
           render_symbol = @@method_names[method_key]
 
           if @@compile_time[render_symbol] && supports_local_assigns?(render_symbol, local_assigns)
             if file_name && !@@cache_template_loading
-              need_to_compile = (@@compile_time[render_symbol] < short_path_mio.mtime) # use mio.mtime instead of File.mtime
-              MasterView::Log.debug{ 'compile_template? template_short_path = '+short_path_mio.pathname.to_s+' compile?='+need_to_compile.to_s }
+              need_to_compile = (@@compile_time[render_symbol] < mio_mtime) # use mio.mtime instead of File.mtime
+              MasterView::Log.debug{ 'compile_template? file_name = '+file_name+' compile?='+need_to_compile.to_s }
               need_to_compile
             end
           else
@@ -87,14 +106,6 @@ module ActionView #:nodoc:
 
     end
 
-
-    private
-
-    # returns the short path relative to view_base since MasterView uses relative paths exclusively
-    def short_relative_path_mv(template_path) #:nodoc:
-      (template_path.starts_with?(self.base_path)) ? template_path[self.base_path.length+1..-1] : template_path
-    end
-
   end
 
   # The TemplateError exception is raised when the compilation of the template fails. This exception then gathers a
@@ -108,10 +119,14 @@ module ActionView #:nodoc:
         return unless num = line_number
         num = num.to_i
 
-        #added/modified the following three lines to support reading from MasterView with fallback to file system
-        relative_path = (@file_path.starts_with?(@base_path)) ? @file_path[@base_path.length+1..-1] : @file_path
-        short_path_mio = (relative_path && !relative_path.empty?) ? MasterView::IOMgr.erb.path(relative_path) : nil
-        source_code = (short_path_mio && short_path_mio.exist?) ? StringIO.new(short_path_mio.read).readlines : IO.readlines(@file_path)
+        #MasterView::Log.debug { "source_extract12 tpath=#{@file_path}  base=#{@base_path}"}
+
+        # template is relative to Rails root
+
+        #added/modified the following two lines to support reading from MasterView with fallback to file system
+        filedata = MasterView::RailsExt::ShortPathCalculator.calc_short_path_and_retrieve(MasterView::ConfigSettings.rails_root_path, @file_path,
+                                                                                          MasterView::IOMgr.erb)
+        source_code = (filedata) ? StringIO.new(filedata).readlines : IO.readlines(@file_path) # mio.exists? use it, else original file read
         # source_code = IO.readlines(@file_path) # original rails 1.2 source
 
         start_on_line = [ num - SOURCE_CODE_RADIUS - 1, 0 ].max
@@ -133,10 +148,14 @@ module ActionView #:nodoc:
     class TemplateError < ActionViewError #:nodoc:
       def source_extract(indention = 0) #:nodoc:
 
-        #added/modified the following three lines to support reading from MasterView with fallback to file system
-        relative_path = (@file_name.starts_with?(@base_path)) ? @file_name[@base_path.length+1..-1] : @file_name
-        short_path_mio = (relative_path && !relative_path.empty?) ? MasterView::IOMgr.erb.path(relative_path) : nil
-        source_code = (short_path_mio && short_path_mio.exist?) ? StringIO.new(short_path_mio.read).readlines : IO.readlines(@file_name)
+        #MasterView::Log.debug { "source_extract116  tpath=#{@file_name}  base=#{@base_path}"}
+
+        # template is relative to Rails root
+
+        #added/modified the following two lines to support reading from MasterView with fallback to file system
+        filedata = MasterView::RailsExt::ShortPathCalculator.calc_short_path_and_retrieve(MasterView::ConfigSettings.rails_root_path, @file_name,
+                                                                                          MasterView::IOMgr.erb)
+        source_code = (filedata) ? StringIO.new(filedata).readlines : IO.readlines(@file_name) # mio.exists? use it, else original file read
 
         start_on_line = [ line_number - SOURCE_CODE_RADIUS - 1, 0 ].max
         end_on_line   = [ line_number + SOURCE_CODE_RADIUS - 1, source_code.length].min

data/lib/masterview/rails_ext/short_path_calc.rb

@@ -0,0 +1,127 @@
+module MasterView
+  module RailsExt
+
+    # short path calculator, computes the short relative path for given the mv_view_path, a base_path,
+    # and a template_path which may be relative or absolute. This calculator checks to see if it is
+    # absolute or relative and cleans up the ./../ returning the short_path relative to mv_view_path
+    # if it can be calculated, otherwise simply returns full_path.
+    #
+    # Example usage:
+    # short_path = MasterView::RailsExt::ShortPathCalculator.calc_short_path(view_base_path, template_path)
+    #
+    # Requires Pathname extensions
+    # Requires String#starts_with?
+    # Requires MasterView::ConfigSettings.rails_views_dir_path be set before this class is required
+    #
+    # Example data:
+    #
+    # MV_RAILS_ROOT_VIEW_DIR = /home/foo/app/views
+    # RAILS_ROOT = /home/foo/config/..
+    # RAILS_ROOT_VIEW_DIR = /home/foo/config/../app/views
+    # BASE_DIR = /home/foo/config/../app/views
+    # BASE_DIR = /home/foo/vendor/plugins/goldberg/lib/../app/views
+    # template_path = store/list # already relative, return existing
+    # template_path = /home/foo/config/../app/views/store/list # starts with RAILS_ROOT_VIEW_DIR return short
+    # template_path = /home/foo/vendor/plugins/goldberg/lib/../app/views/../../../../../app/views/store/list # cleaned starts with RAILS_ROOT_VIEW_DIR return short
+    # template_path = ../../../../../app/views/store/list # when combined with base_path and cleaned starts with RAILS_ROOT_VIEW_DIR, return short
+    # template_path = /home/foo/vendor/plugins/goldberg/lib/../app/views/not/railsroot, return nil
+    # template_path = store/list # but base_path is not RAILS_ROOT_VIEW_DIR, return nil
+    #
+    class ShortPathCalculator
+
+      PATH_NOT_FOUND = -1
+
+      class << self # class methods
+        # cleans and expands the path storing in a class instance var
+        def mv_path=(view_path)
+          @clean_mv_view_path = Pathname.for_path(view_path).expand_path.cleanpath.to_s unless view_path.nil?
+          #MasterView::Log.debug { "ShortPathCalculator.mv_path=#{@clean_mv_view_path}"}
+        end
+
+        def mv_path
+          @clean_mv_view_path
+        end
+      end
+
+      # hash of base_path to hash of template_paths containing short_path, stored as class instance variable
+      @short_path_cache = {} # one and only cache, double hash
+
+      # set mv_view_path
+      self.mv_path = MasterView::ConfigSettings.rails_views_dir_path
+
+
+      class << self # class methods
+        # class method that computes the short relative path to mv_view_path for a template_path which
+        # may be absolute or relative. If short_path cannot be calculated (not under mv_view_path)
+        # then return nil. This calculation cleans up messy paths including ./.. and
+        # resultant calculations are hashed.
+        def calc_short_path(view_base_path, template_path)
+          base_path_cache = short_path_cache(view_base_path)
+          short_path = base_path_cache.fetch(template_path, PATH_NOT_FOUND) # defaults to PATH_NOT_FOUND
+          #MasterView::Log.debug { "calc_short_path - short_path=#{short_path} using cache view_base=#{view_base_path} template_path=#{template_path}"} unless short_path == PATH_NOT_FOUND #todo comment out
+          return short_path unless short_path == PATH_NOT_FOUND # if already cached (even if nil was saved), then return it
+
+
+          clean_view_base_pathname = Pathname.for_path(view_base_path).expand_path.cleanpath # expanded and cleaned
+          clean_view_base_str = clean_view_base_pathname.to_s
+          clean_template_pathname = Pathname.for_path(template_path).expand_path(clean_view_base_pathname).cleanpath # expanded from view_base and cleaned
+          clean_template_str = clean_template_pathname.to_s
+
+
+          raise "MasterView::ConfigSettings.rails_views_dir_path is nil, need to set config.rails_views_dir_path" if mv_path.nil?
+
+          short_path = nil
+          if clean_template_str.starts_with?(mv_path) # if clean_template_path starts with MV_VIEW_DIR (both are absolute)
+            short_path = clean_template_str[mv_path.length+1..-1] # strip off MV_VIEW_DIR and return short path
+          end
+
+
+
+          #MasterView::Log.debug { "calc_short_path - short_path=#{short_path} view_base=#{view_base_path} template_path=#{template_path} RAILS_VIEW=#{@clean_mv_view_path}"} # todo comment out
+          #MasterView::Log.debug { "cspdetails- #{clean_view_base_str}+#{clean_template_str} <=> #{mv_path}"}
+          base_path_cache[template_path] = short_path # store in cache and return
+        end
+
+        # calculate the short path and if exists then retrieve the data from the mioTree, otherwise return nil
+        def calc_short_path_and_retrieve(view_base_path, template_path, mioTree)
+          calc_short_path_and_call_block(view_base_path, template_path, mioTree) do |mio|
+            mio.read
+          end
+        end
+
+        # calculate the short_path and if exists return the mtime, otherwise nil
+        def calc_short_path_and_get_mtime(view_base_path, template_path, mioTree)
+          calc_short_path_and_call_block(view_base_path, template_path, mioTree) do |mio|
+            mio.mtime
+          end
+        end
+
+        private
+
+        # get/create hash for view_base_path, class method
+        def short_path_cache(view_base_path) #:nodoc:
+          @short_path_cache[view_base_path] ||= {}
+        end
+
+        # calculate short path and if exists execute block
+        def calc_short_path_and_call_block(view_base_path, template_path, mioTree, &block)
+          short_path = calc_short_path(view_base_path, template_path)
+          if short_path
+            short_path_mio = mioTree.path(short_path)
+            if short_path_mio && short_path_mio.exist?
+              yield short_path_mio
+            else
+              nil
+            end
+          else
+            nil
+          end
+        end
+
+      end
+
+    end
+
+
+  end
+end