masterview 0.3.0 → 0.3.1

data/CHANGELOG

@@ -1,3 +1,10 @@
+0.3.1 - November 20, 2006
+Fixed problem with deprecated/directive_base was missing registry include
+Update image_tag docs, indicating that it now simply passes through width and height rather than setting size
+Fixed problem with Ruby 1.8.5 Pathname.dirname now calls self.class.new and was getting wrong number of arguments 1 for 2 (in FileMIO)
+Accomodate change with Rails 1.2 which changed number of arguments for force_file_collision, use custom method
+
+
 0.3.0 - November 8, 2006
 Fixed compatibility of AdminPages with edge rails using dependency mechanism
 Refactored directive api using DSL to simplify and solidify creation of directives

data/RELEASE_NOTES

@@ -1,9 +1,30 @@
 = MasterView - Rails-optimized (x)html friendly template engine
 
-== Recent changes (Release 0.3.0 - Major update - refactoring of directive API (for developing directives)
-The directive API for creating directives has been refactored and simplified. This will enable directives to be developed more easily by both core developers and MasterView users. The end goal is to make it extremely simple for anyone to create their own custom directives and to share those with the community, and thus the project can live and grow into many specialty areas. The directive API refactoring is one more step towards those goals.
+== Recent changes (Release 0.3.1 - Maintenance release
+This release addresses an issue with ruby 1.8.5, fixes a problem with the
+deprecated/directive_base used for custom directives, updates a few out of
+date docs, and accomodates a change to the API of the Rails 1.2 generator
+
 
-The old directive_base.rb which provided the API for directives has been deprecated and moved to deprecated/directive_base.rb, MasterViewdevelopers which have developed custom directives should upgrade those directives to the new API as soon as possible. During the transition period one can use the original API by requiring the deprecated/directive_base.rb file and changing their directive to inherit from DirectiveBaseOld rather than DirectiveBase.
+== Recent changes (Release 0.3.0 - Major update - refactoring of directive API (for developing directives)
+The directive API for creating directives has been refactored and simplified
+and improvements have been made to better support directive extensions through
+directive load path configuration and enabling multiple namespaces in directive markup.
+This will enable directives to be developed more easily by both core developers
+and MasterView users. The end goal is to make it extremely simple for anyone to
+create their own custom directives and to share those with the community, and
+thus the project can live and grow into many specialty areas. The directive API
+refactoring is one more step towards those goals.
+
+The old directive_base.rb which provided the API and implementation framework
+for directives has been deprecated and moved to deprecated/directive_base.rb.
+MasterView developers who have developed custom directives are strongly
+encouraged to upgrade those directives to the new API as soon as possible.
+
+To provide backwards compatibility during a transition period, you can continue to
+use the original directive implementation framework by requiring the
+masterview/deprecated/directive_base.rb file in your directive implementation and
+changing the directive class to inherit from DirectiveBaseOld rather than DirectiveBase.
 
 
 == Recent changes (Release 0.2.5)

data/TODO

@@ -46,3 +46,7 @@ TODO LIST
 - liquid directives or other non-evaling safe mode which allows user created templates or parts
 
 - handle all xml syntax including processing_instruction, attlistdecl, elementdecl, entitydecl, notationdecl
+
+- more docs and examples about directive API and helpers
+
+- sitemesh style directives

data/doc/directives.html

@@ -765,7 +765,7 @@ mv:image_tag="cat.jpg"
 
           becomes
 
-        <%= image_tag 'cat.jpg', :alt => 'my cat', :size => '20x10' %>
+        <%= image_tag 'cat.jpg', :alt => 'my cat', :height => 10, :width => 20 %>
 
         Also if path isn't specified in the mv:image_tag attribute value then it will infer the path looking
         for what follows the public/images/ in the src atttribute, like so

data/doc/installation.html

@@ -79,7 +79,7 @@ for additional information and links to the <code>RubyGems</code> documentation.
 <h2>Supported Platforms</h2>
 
 <p><span class="productName">MasterView</span> has been tested
-on Ruby 1.8.4 and Rails 1.1.2 on *nix and Windows.
+on Ruby 1.8.5r3 and Rails 1.1.6 on *nix and Windows.
 </p>
 
 

data/lib/masterview/deprecated/directive_base.rb

@@ -1,11 +1,5 @@
 module MasterView
 
-  # Namespace module for built-in directive implementations
-  # that are standard with the MasterView template engine.
-  #
-  module Directives
-  end
-
   # THIS CLASS IS DEPRECATED!!! UPGRADE DIRECTIVES TO USE NEW DirectiveBase
   #
   # Base class for directive implementations.
@@ -81,6 +75,7 @@ module MasterView
   #
   class DirectiveBaseOld
     include PluginLoadTracking
+    include DirectiveMetadata
     include DirectiveHelpers
 
     # Register a class manually without regard to whether it inherits from DirectiveBase.
@@ -93,6 +88,8 @@ module MasterView
       MasterView.register_directive(directive_class)
     end
 
+    #DEPRECATED- superseded by DirectiveMetadata attribute_qname
+    #
     # Returns the fully qualified attribute name of the directive,
     # consisting of the directive namespace and the directive attribute name.
     #
@@ -111,6 +108,8 @@ module MasterView
       namespace_prefix + self.attr_name
     end
 
+    #DEPRECATED- superseded by DirectiveMetadata attribute_name
+    #
     # Returns the attribute name of the directive.
     #
     # Use full_attr_name to obtain the fully-qualified name
@@ -124,6 +123,7 @@ module MasterView
       self.default_attr_name()
     end
 
+    #DEPRECATED- superseded by DirectiveMetadata default_directive_name
     def self.default_attr_name()  #:nodoc:
       self.name.split(':').last.downcase_first_letter
     end
@@ -273,6 +273,7 @@ module MasterView
 
     # check for common html options and return the hash
     def common_html_options(attrs_lck)
+      ####CHANGED: new DirectiveBase provides more extensive list
       options = {}
       options[:id] = attrs_lck['id'] if attrs_lck['id']
       options[:class] = attrs_lck['class'] if attrs_lck['class']

data/lib/masterview/directive_registry.rb

@@ -12,7 +12,7 @@ module MasterView
 
     DEBUG_TRACE_LOADING = false #:nodoc:  ##DEBUG##
     TRACE_MD_HARDENING_SUBJECT = nil #'MasterView::DirectiveTests::TestEventsDirective'
-    DEBUG_BUILTIN_DIRECTIVE_REGISTRATION = true #:nodoc:
+    DEBUG_BUILTIN_DIRECTIVE_REGISTRATION = false #:nodoc:
     DEBUG_CURRENT = false  #:nodoc:
 
     # The DirectiveRegistry for managing the loaded directives available 

data/lib/masterview/directives/image_tag.rb

@@ -5,7 +5,8 @@ module MasterView
     # if path is specified in attr_value then it will be used exactly as listed, otherwise if attr_value is empty
     # then masterview will attempt to find the public/images in the string and infer the path from what follows.
     # otherwise it will simply use the src path.
-    # If both width and height attr values are specified then it will build the :size option from them.
+    # If width and/or height attr values are specified in the html then they will be appended to the output of the
+    # image tag helper. These are used instead of the size attribute because they are more flexible and a direct mapping.
     # Other html attributes will be passed into image_tag options.
     class ImageTag < MasterView::DirectiveBase
 

data/lib/masterview/io.rb

@@ -9,7 +9,7 @@ require File.join( File.dirname(__FILE__), 'filter_helpers' )
 
 module MasterView
 
-  # An InvalidPathError that is raised when an invalid template path is given, 
+  # An InvalidPathError that is raised when an invalid template path is given,
   # or if the path is outside of the root_path of the template
   # processing operating context.
   #
@@ -19,7 +19,7 @@ module MasterView
 # The MIO module contains facilities for template processing I/O.
 module MIO
   # IOManager which retrieves the proper MasterViewIOTree object for the type of object being requested
-  # set and access MasterViewIOTree by using accessors 
+  # set and access MasterViewIOTree by using accessors
   # IOMgr.template = FileMIOTree()
   # ftree = IOMgr.template
   # IOMgr.erb = FileMIOTree()
@@ -41,9 +41,9 @@ module MIO
 #   exist?(path)
 #   identical?(content)
 #   mtime()
-  
 
-  # mixin which encapsulates the apply filter to new MIO objects and 
+
+  # mixin which encapsulates the apply filter to new MIO objects and
   # the default filter block
   module MasterViewIOTreeMixin
     DefaultExtensionInstances = {}
@@ -53,7 +53,7 @@ module MIO
     # options[:escape_erb] = true enables erb escaping
     # options[:tidy] = true enables tidy processing to cleanup bad xhtml
     # options[:caching] = true enables caching so that reads are cached
-    # options[:logging] = true enables logging of reads and writes 
+    # options[:logging] = true enables logging of reads and writes
     # options[:default_generate] = true enables creation of default generate directive if none found
     def apply_filters(mio, options, block)
       if block
@@ -152,7 +152,7 @@ module MIO
     end
 
     def find(options = {})
-      path = options[:path] || '' 
+      path = options[:path] || ''
       path = '' if path == '.'
       found = []
       @string_hash.each { |p,v| found << p if p.starts_with?(path) }
@@ -170,7 +170,7 @@ module MIO
     def initialize
       self.default_extension = default_extension
     end
-    
+
     def path(path)
     end
 
@@ -229,7 +229,8 @@ module MIO
     include MasterViewIOIdenticalMixin
     attr_reader :pathname
 
-    def initialize(path, full_path)
+    def initialize(path, full_path=nil)
+      full_path = path if full_path.nil? # ruby 1.8.5 Pathname.dirname calls self.class.new so we need to allow for single argument
       super(full_path)
       @pathname = Pathname.for_path(path)
     end
@@ -318,7 +319,7 @@ module MIO
 
 
   module CachingMIOFilter #todo
-    def read(options={}) 
+    def read(options={})
       if options[:disable_cache]
         super
       else #caching on
@@ -342,10 +343,10 @@ module MIO
   end
 
   # checks to see that mv:generate or mv:gen_partial has been used somewhere in file
-  # and if not then it puts in a default mv:generate directive based on the following 
+  # and if not then it puts in a default mv:generate directive based on the following
   # logic. If a body tag exists then add the mv:generate directive to the body tag
   # and also add a mv:omit_tag="" directive. This is based on the assumption that we are
-  # body will be defined in a layout somewhere so we are only interested in the 
+  # body will be defined in a layout somewhere so we are only interested in the
   # internal content of it (excluding the body tag itself).
   # If a body tag does not exist, then simply add the mv:generate tag to the root element.
   #
@@ -353,7 +354,7 @@ module MIO
   # <html><body>Hello world</body></html>
   # becomes
   # <html><body mv:generate="{template_path}" mv:omit_tag="">Hello world</body></html>
-  # 
+  #
   # <div>Hello</div>
   # becomes
   # <div mv:generate="{template_path}">Hello</div>

data/lib/masterview/masterview_version.rb

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

data/test/unit/deprecated_directive_base_example_test.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+require 'test/unit'
+currentPath = File.dirname(__FILE__)
+testDirPath = File.join( currentPath, '..' )
+require File.join( currentPath, '../../lib/masterview' )
+require File.join( currentPath, '../../lib/masterview/deprecated/directive_base' )
+require File.join( testDirPath, 'test_helper' )
+require File.join( testDirPath, 'directive_test_helper' )
+
+class TestDirectiveOld < MasterView::DirectiveBaseOld
+  def stag(dcs)
+    'Hello '+attr_value
+  end
+  
+  def etag(dcs)
+  end
+
+end
+
+class TestTestDirectiveOld < Test::Unit::TestCase
+  include DirectiveTestHelpers
+
+  def setup
+    MasterView::IOMgr.erb = MasterView::MIO::StringHashMIOTree.new({}, '.rhtml', :logging => true)
+  end
+
+  def test_directive_name
+    # old formula for auto-generating directive name wasn't smart enough about camel-casing
+    assert_equal 'testDirectiveOld', TestDirectiveOld.attr_name
+    # new DirectiveMetadata follows rails-ish conventions
+    assert_equal 'test_directive_old', TestDirectiveOld.attribute_name
+  end
+
+  def test_directive_namespace
+    assert_equal MasterView::DirectiveRegistry.current.mv_extensions_namespace_prefix, TestDirectiveOld.namespace_prefix
+  end
+
+  def test_test_directive
+    template = <<-END
+      <div mv:generate='foo/bar'>
+        <head mvx:test_directive_old="woo">
+        </head>
+      </div>
+    END
+    #Note: why the trailing space from the old guy? whatever [DJL 12-Nov-2006]
+    expected = {
+      'foo/bar' => "<div>Hello woo </div>"
+    }
+    assert_template_result expected, template
+  end
+
+end

data/test/unit/deprecated_directive_base_test.rb

@@ -7,7 +7,7 @@ require File.join( currentPath, '../../lib/masterview/deprecated/directive_base'
 
 class TestDirectiveBase < Test::Unit::TestCase
   def setup
-    @base = MasterView::DirectiveBase.new('')
+    @base = MasterView::DirectiveBaseOld.new('')
   end
 
   def test_quote

data/test/unit/example_directive_base_old_test.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+require 'test/unit'
+currentPath = File.dirname(__FILE__)
+testDirPath = File.join( currentPath, '..' )
+require File.join( currentPath, '../../lib/masterview' )
+require File.join( currentPath, '../../lib/masterview/deprecated/directive_base' )
+require File.join( testDirPath, 'test_helper' )
+require File.join( testDirPath, 'directive_test_helper' )
+
+class TestDirectiveOld < MasterView::DirectiveBaseOld
+  def stag(dcs)
+    'Hello '+attr_value
+  end
+  
+  def etag(dcs)
+  end
+
+end
+
+class TestTestDirectiveOld < Test::Unit::TestCase
+  include DirectiveTestHelpers
+
+  def setup
+    MasterView::IOMgr.erb = MasterView::MIO::StringHashMIOTree.new({}, '.rhtml', :logging => true)
+  end
+
+  def test_test_directive
+    template = <<-END
+      <div mv:generate='foo/bar'>
+        <head mvx:test_directive_old="woo">
+        </head>
+      </div>
+    END
+    expected = {
+      'foo/bar' => "<div>Hello woo </div>"
+    }
+    assert_template_result expected, template
+  end
+
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: masterview
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
-date: 2006-11-08 00:00:00 -06:00
+  version: 0.3.1
+date: 2006-11-20 00:00:00 -06:00
 summary: A (x)html friendly template engine for rails with the power of layouts, and partials.
 require_paths: 
 - lib
@@ -137,6 +137,7 @@ files:
 - doc/stylesheets
 - doc/directives.html
 - doc/guide.html
+- doc/api
 - doc/screenshots
 - doc/installation.html
 - doc/configuration.html
@@ -234,6 +235,8 @@ files:
 - test/unit/directive_global_inline_erb_test.rb
 - test/unit/directive_load_path_test.rb
 - test/unit/deprecated_directive_base_test.rb
+- test/unit/example_directive_base_old_test.rb
+- test/unit/deprecated_directive_base_example_test.rb
 - test/xtras/config_initialize_standalone.rb
 - test/xtras/config-mv-logger_config.rb
 - test/fixtures/configs