masterview 0.1.5 → 0.2.0

data/lib/masterview/extras/init_rails_erb_mv_direct.rb

@@ -0,0 +1,117 @@
+#!/usr/bin/env ruby
+
+#--
+# Copyright (c) 2006 Jeff Barczewski
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+#
+# Setup hook to intercept template_exist? calls and read_template_file
+# so that rails can find masterview templates. MasterView cannot use the 
+# provided hooks because rails always assumes everything is file based
+# and that there will be a file for each thing to render. If the 
+# template dispatching code is enriched in the future we may be able 
+# to rewrite this code to use the provided hooks
+# 
+#
+
+MasterView::Log.info { 'Adding hooks to enable Rails to read erb directly from MasterView' }
+
+module ActionView #:nodoc:
+  class Base #:nodoc:
+
+    # checks for template existence, uses standard rails file based check first and if not found
+    # 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?
+    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
+    end
+
+    # Check whether compilation is necessary.
+    # Since rails compile_templat? is file based there was no easy way to hook into
+    # this, so much of this method had to be duplicated.
+    # If file_name exists in MasterView then check mtime from it otherwise defer to 
+    # 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
+        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
+          end
+        else
+          true
+        end
+      else # use original file based mtime checking
+        compile_template_pre_mv?(template, file_name, local_assigns)
+      end
+    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
+end
+
+
+
+module ActionController #:nodoc:
+  module Layout #:nodoc:
+    module ClassMethods
+
+      # get list of layout template paths, original rails implementation assumes everything is file based
+      # so this method is enhanced to pull layouts out of MasterView and concatenate them to the list
+      # from rails
+      alias :layout_list_pre_mv :layout_list
+      def layout_list
+        mv_layouts = []
+        MasterView::IOMgr.erb.find do |mio|
+         mv_layouts << "#{template_root}/"+mio.pathname.to_s if mio.pathname.to_s.starts_with?('layouts/')
+        end
+        layout_list_pre_mv.concat( mv_layouts )
+      end
+
+    end
+  end
+end
+

data/lib/masterview/extras/init_rails_reparse_checking.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+
+#--
+# Copyright (c) 2006 Jeff Barczewski
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+#
+# Setup hook 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.  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
+# to detect template changes after application startup.
+# 
+
+#--
+# DBC-style notation per DbC - rubydbc-0.1 (Andy Hunt's Design by Contract)
+#pre( MasterView::ParseMasterViewTemplatesAtStartup )
+#pre( MasterView::ReparseChangedMasterViewTemplates )
+#pre( defined?(ActionController) &&  ActionController::Base.perform_caching )
+#++
+#
+
+MasterView::Log.info { 'Adding hook to allow MasterView to check for templates that have changed when processing a request' }
+
+module ActionController #:nodoc:
+  class Base #:nodoc
+    # Install hook to enable MasterView to detect and automatically reparse
+    # 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::Parser.parse_mio( mio, MasterView::IOMgr.erb )
+      end
+      process_pre_mv(request, response, method, *arguments)
+    end
+  end
+end

data/lib/masterview/extras/watcher.rb

@@ -1,31 +1,25 @@
-require 'find'
-
 module MasterView
-  class TemplateFileWatcher
-    # Check path for filenames matching filename_pattern and if found
-    # exec block passing in the full path name. 
-    # filename_pattern is a wildcard pattern similar to those used in shells
-    # If check_subdirectories is true then the system will recurse into 
-    # subdirectories looking for filename matches as well.
-    # returns an array of files that were modified and the block was run for
-    def self.check(path, filename_pattern, check_subdirectories, &block)
-      files_run = []
-      return files_run unless File.exist?(path)
+  class TemplateWatcher
 
-      full_path = File.expand_path(path)
-      Find.find(full_path) do |f|
-        if !File.directory?(f) && File.fnmatch?(filename_pattern, f)
-          mtime = File.mtime(f)
-          @@file_mtimes ||= {}
-          unless @@file_mtimes[f] == mtime
-            yield f
-            @@file_mtimes[f] = File.mtime(f)
-            files_run << f
-          end
+    # check all the templates in the MIOTree to see if their mtimes
+    # is newer than what we have saved in @@template_mtimes.
+    # If newer, then run block and add path to array to be returned
+    # If filename_pattern is specified then it will filter the results
+    # returns array of paths that were newer
+    def self.check_updated(template_mio_tree, filename_pattern, &block)
+      template_paths_run = []
+      template_mio_tree.find(:pattern => filename_pattern) do |mio|
+        mtime = mio.mtime
+        @@template_mtimes ||= {}
+        unless @@template_mtimes[mio.pathname.to_s] == mtime
+          yield mio
+          @@template_mtimes[mio.pathname.to_s] = mtime
+          template_paths_run << mio.pathname.to_s
         end
       end
-      files_run
+      template_paths_run
     end
+
   end
 end
 

data/lib/masterview/filter_helpers.rb

@@ -0,0 +1,26 @@
+module MasterView
+  module TidyHelper
+    def self.tidy(html)
+      Tidy.path = ::MasterView::TidyPath unless Tidy.path
+      xml = Tidy.open do |tidy|
+        tidy.options.output_xml = true
+        tidy.options.indent = true
+        tidy.options.wrap = 0
+        xml = tidy.clean(html)
+      end
+      xml = ::MasterView::EscapeErbHelper.escape_erb(xml)
+      ::MasterView::Log.debug { 'tidy corrected xml='+xml }
+      xml
+    end
+
+
+  end
+
+  module EscapeErbHelper
+    def self.escape_erb(html)
+      html = html.gsub(/<%/, InlineErbStart)
+      html.gsub!(/%>/, InlineErbEnd)
+      html
+    end
+  end
+end