masterview 0.2.5 → 0.3.0

data/lib/masterview/directives/elsif.rb

@@ -1,24 +1,25 @@
 module MasterView
   module Directives
 
-    #outputs an elsif/end block around the text tags and remove previous end (from if)
+    # outputs an elsif/end block around the text tags and remove previous end (from if)
+    # 
     class Elsif < MasterView::DirectiveBase
-      def priority
-        DirectivePriorities::High
-      end
 
-      def stag(directive_call_stack)
+      metadata :priority => 'High',
+        :category => 'erb',
+        :description => 'Used in conjunction with the mv:if directive to allow you to create if... elsif... end blocks'
+
+      # remove the last <% end -%> from the parent tag's content and add a <% else -%> instead.
+      # This is a continuation of previous if or elsif statement.
+      event :before_stag do
         tag = @directive_call_stack.context[:tag]
-        delete_last_in_parent(tag, erb('end') )
-        ret = []
-        ret << erb('elsif '+attr_value)
-        ret << directive_call_stack.render
+        delete_last_in_parent(tag, erb_eval('end') )
+        render erb_eval( 'elsif', attr_value )
       end
 
-      def etag(directive_call_stack)
-        ret = []
-        ret << directive_call_stack.render
-        ret << erb('end')
+      # output <% end -%> after everything
+      event :after_etag do
+        render erb_eval( 'end' )
       end
 
     end

data/lib/masterview/directives/eval.rb

@@ -0,0 +1,20 @@
+module MasterView
+  module Directives
+
+    # outputs a <% attr_value %> before the element
+    # example: <foo><bar mv:eval="i = 1">baz</bar></foo>
+    # becomes: <foo><% i = 1 %><bar>baz</bar></foo>
+    # Inspired by Sergey Shalatskly's silent tag
+    class Eval < MasterView::DirectiveBase
+
+      metadata :priority => 'MediumHigh',
+        :category => 'erb',
+        :description => 'Inserts an rhtml evaluation expression for the attribute value prior to the element'
+
+      event :before_stag do
+        render erb_eval( attr_value )
+      end
+
+    end
+  end
+end

data/lib/masterview/directives/form.rb

@@ -1,19 +1,66 @@
 module MasterView
   module Directives
 
-    # creates start_form_tag and end_form_tag from values in form
+    # creates form_tag block and ending form tag from values in form
+    #
     class Form < MasterView::DirectiveBase
-      def stag(directive_call_stack)
-        options = {}
-        options[:multipart] = true if attr_lckv_matches('enctype', 'multipart/form-data')
-        options[:method] = 'get' if attr_lckv_matches('method', 'get')
-        merge_hash_attr_value!(1, options)
-        erb_content('form_tag ' + attr_value)
+
+      metadata :priority => :default,
+        :category => 'form',
+        :description => 'Replaces the start and end tags of the element using the Rails form_tag helper and an ending form tag',
+        :element_usage => 'form'
+
+      attr_arg :url_for_options
+      attr_arg :options, :append_element_attrs => [:common_html, :method]
+      attr_arg :parameters_for_url, :varargs => true
+
+      event :stag do
+        merge_hash_into_str( {:multipart => true}, @options ) if element_attrs.get_lowercase_str_value('enctype') == 'multipart/form-data'
+        render erb_content( 'form_tag', :url_for_options, :options, :parameters_for_url )
       end
 
-      def etag(directive_call_stack)
-        erb_content('end_form_tag')
+      event :etag do
+        render '</form>'
       end
+
     end
+
   end
 end
+
+
+
+=begin
+
+module MasterView
+  module Directives
+
+    # once rails 1.2 is released we can use the form_tag block method of the helper but this does not work prior to rails 1.2
+    # creates form_tag block from values in form
+    #
+    class Form < MasterView::DirectiveBase
+
+      metadata :priority => :default,
+        :category => 'form',
+        :description => 'Replaces the start and end tags of the element using the Rails form_tag block helper',
+        :element_usage => 'form'
+
+      attr_arg :url_for_options
+      attr_arg :options, :append_element_attrs => [:common_html, :method]
+      attr_arg :parameters_for_url, :varargs => true
+
+      event :stag do
+        merge_hash_into_str( {:multipart => true}, @options ) if element_attrs.get_lowercase_str_value('enctype') == 'multipart/form-data'
+        render erb_eval( prepare_output('form_tag', :url_for_options, :options, :parameters_for_url)+' do' ) # call prepare_output directly so do won't be embedded in method call
+      end
+
+      event :etag do
+        render erb_eval( 'end' )
+      end
+
+    end
+  end
+end
+
+=end
+

data/lib/masterview/directives/form_remote.rb

@@ -0,0 +1,26 @@
+module MasterView
+  module Directives
+
+    # creates form_remote_tag and closing form tag from values in form
+    #
+    class FormRemote < MasterView::DirectiveBase
+
+      metadata :priority => :default,
+        :category => 'form',
+        :description => 'Replaces the start and end tags of the element using the Rails form_remote_tag helper and </form> for Ajax-enabled form submission using the Prototype library',
+        :element_usage => 'form'
+
+      attr_arg :options, :append_element_attrs => [:common_html, :method]
+
+      event :stag do
+        merge_hash_into_str( {:multipart => true}, @options ) if element_attrs.get_lowercase_str_value('enctype') == 'multipart/form-data'
+        render erb_content( 'form_remote_tag', :options )
+      end
+
+      event :etag do
+        render '</form>'
+      end
+
+    end
+  end
+end

data/lib/masterview/directives/global_inline_erb.rb

@@ -3,24 +3,21 @@ module MasterView
 
     #outputs a block around the text tags, if left bracket count is higher than right
     #assume that the end is a right bracket otherwise use end
-    class Global_inline_erb < MasterView::DirectiveBase
+    class GlobalInlineErb < MasterView::DirectiveBase
+
+      metadata :priority => 'Low',
+        :global_directive? => true,
+        :category => 'erb',
+        :description => 'Inline substitution notation for Erb expressions'
+
       def initialize(attribute_value = nil)
         super(attribute_value)
       end
 
-      def priority
-        DirectivePriorities::Low
-      end
-      
-      def global_directive?
-        true
-      end
-
-      def stag(dcs)
-        attrs.each do |key, value|
+      event :before_stag do
+        element_attrs.each do |key, value|
           replace_with_erb!( value )
         end
-        dcs.render
       end
 
       def characters(dcs)
@@ -28,12 +25,11 @@ module MasterView
         dcs.render
       end
 
-      private
-
       def replace_with_erb!(value)
         subs = value.gsub!( MasterView::InlineErbSubstitutionRegex, '<%\1%>' )
       end
 
+
     end
   end
 end

data/lib/masterview/directives/hidden_field.rb

@@ -1,29 +1,20 @@
 module MasterView
   module Directives
 
-    class Hidden_field < MasterView::DirectiveBase
-      def stag(dcs)
-        #eat
-      end
-
-      def etag(dcs)
-        args = parse_attr_value
-        obj = args[0]
-        method = args[1]
+    class HiddenField < MasterView::DirectiveBase
 
-        obj = quote_if(obj)
-        method = quote_if(method)
+      metadata :priority => :default,
+        :category => 'form',
+        :description => 'Replaces the element with a hidden input element using the Rails hidden_tag helper',
+        :element_usage => 'input'
 
-        options = {}
-        options.merge! common_html_options(attrs_lck)
-        remove_strings_from_attr_value!
-        merge_hash_attr_value!(0, options)
+      attr_arg :obj, :quote => true
+      attr_arg :method, :quote => true
+      attr_arg :value, :default => nil
+      attr_arg :options, :append_element_attrs => [:common_html]
 
-        a = []
-        a << 'hidden_field '+ obj
-        a << method
-        a << attr_value unless attr_value.strip.empty?
-        erb_content(a.join(', '))
+      event :element do
+        render erb_content( 'hidden_field', :obj, :method, :value, :options )
       end
 
     end

data/lib/masterview/directives/if.rb

@@ -1,22 +1,23 @@
 module MasterView
   module Directives
 
-    #outputs an if/end block around the text tags
+    # outputs an if/end block around the text tags
+    # 
     class If < MasterView::DirectiveBase
-      def priority
-        DirectivePriorities::High
-      end
 
-      def stag(directive_call_stack)
-        ret = []
-        ret << erb('if '+attr_value)
-        ret << directive_call_stack.render
+      metadata :priority => 'High',
+        :category => 'erb',
+        :description => 'Wraps the element with an if... end block using the attribute value for the condition'
+
+      #TODO: omit element entirely if attr_value == 'false'
+      #TODO: don't need to generate conditional block wrapping if attr_value == 'true'
+
+      event :before_stag do
+        render erb_eval( 'if', attr_value )
       end
 
-      def etag(directive_call_stack)
-        ret = []
-        ret << directive_call_stack.render
-        ret << erb('end')
+      event :after_etag do
+        render erb_eval( 'end' )
       end
 
     end

data/lib/masterview/directives/image_tag.rb

@@ -4,42 +4,34 @@ module MasterView
     # creates a image_tag.
     # 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. 
+    # 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.
     # Other html attributes will be passed into image_tag options.
-    class Image_tag < MasterView::DirectiveBase
+    class ImageTag < MasterView::DirectiveBase
 
       # /public\/images\/(.*)/
       IMAGE_SRC_EXTRACT_REGEX = MasterView::ConfigSettings.template_asset_base_ref_pattern[:images]
 
-      def stag(dcs)
-      end
-
-      def etag(dcs)
-        src = attrs_lck['src']
-        if attr_value.empty? && src
-          match = IMAGE_SRC_EXTRACT_REGEX.match(src)
-          image_loc = (match) ? match[1] : src
-        else
-          image_loc = attr_value
+      metadata :priority => :default,
+        :category => 'asset',
+        :description => 'Replaces the element using the Rails image_tag helper.',
+        :element_usage => 'img'
+
+      attr_arg :src
+      attr_arg :options, :append_element_attrs => [:common_html]
+
+      event :element do
+        if (@src.nil? or @src.empty?) and src_attr = element_attrs[:src]
+          if match = IMAGE_SRC_EXTRACT_REGEX.match(src_attr)
+            @src = match[1]
+          else
+            @src = src_attr
+          end
         end
-
-        image_tag_params = quote(image_loc)
-        attrs.delete('src') # delete this if exists, path has already been specified
-
-        width = attrs_lck['width']
-        height = attrs_lck['height']
-        if width && height
-          attrs.delete('width') #delete these since being used in size
-          attrs.delete('height')
-          attrs[:size] = "#{width}x#{height}"
-        end
-
-        options = symbolize_sort_and_serialize_hash_to_str(attrs)
-        image_tag_params += (', '+options) unless options.empty?
-        
-        erb_content('image_tag ' + image_tag_params)
+        @src = quote(@src) unless @src.nil?
+        render erb_content('image_tag', :src, :options)
       end
+
     end
 
   end

data/lib/masterview/directives/import.rb

@@ -3,20 +3,13 @@ module MasterView
 
     # just eat this output since it is only used for design time
     class Import < MasterView::DirectiveBase
-      def priority
-        DirectivePriorities::VeryHigh
-      end
 
-      def stag(dcs)
-        #output nothing
-      end
-      
-      def etag(dcs)
-        tag = dcs.context[:tag]
-        tag.content = [] # clear out any content including from children
-        nil
-      end
+      metadata :priority => 'VeryHigh',
+        :category => 'processing',
+        :description => 'Design-time directive to mark a snapshot of generated code'
 
+      event :element, :render => :nothing
+      
     end
   end
 end

data/lib/masterview/directives/import_render.rb

@@ -1,27 +1,15 @@
 module MasterView
   module Directives
 
-    # just eat this output since it is only used for design time
-    class Import_render < MasterView::DirectiveBase
-      def priority
-        DirectivePriorities::VeryHigh
-      end
+    # output the render partial after expanding keywords
+    class ImportRender < MasterView::DirectiveBase
 
-      # need to expand keywords
-      def initialize(attribute_value)
-        super(attribute_value)
-        @attribute_value = Renderer.last_renderer.keyword_expander.expand_keywords(attribute_value)
-      end
+      metadata :priority => 'VeryHigh',
+        :category => 'processing',
+        :description => 'Design-time directive to mark a snapshot of generated partial code, outputs render partial after expanding keywords'
 
-      def stag(dcs)
-        #output nothing
-      end
-      
-      def etag(dcs)
-        tag = dcs.context[:tag]
-        tag.content = [] # clear out any content including from children
-        ret = []
-        ret << erb_content('render( '+attr_value+' )')
+      event :element do
+        render erb_content( 'render', self.renderer.keyword_expander.expand_keywords(attr_value) )
       end
 
     end

data/lib/masterview/directives/insert_generated_comment.rb

@@ -5,25 +5,22 @@ module MasterView
     # and should not be edited, else changes could be lost. The standard generated-file
     # comment includes the path to the original file that should be edited.
     # 
-    class Insert_generated_comment < MasterView::DirectiveBase
+    class InsertGeneratedComment < MasterView::DirectiveBase
 
       # Configured value for generated comment text is eval'd to support #{template_path} field substitution
       Comment_eval_template = 'comment_text = "' + MasterView::GeneratedCommentText + '"'
 
-      def priority
-        DirectivePriorities::VeryLow
-      end
+      metadata :priority => 'VeryLow',
+        :category => 'internal'
+
+      attr_arg :comment_template_path
 
-      def stag(directive_call_stack)
-        # do variable substitution to fill in any slots in the template
-        template_path = attr_value
+      event :after_stag do
+        template_path = @comment_template_path
         comment_text = ''
         eval(Comment_eval_template, binding)
         comment = "\n<%\n#{comment_text}\n-%>" # "\n#{ERB_EVAL_START.strip()}\n#{comment_text}\n#{ERB_EVAL_END.strip()}"
-
-        ret = []
-        ret << directive_call_stack.render
-        ret << comment
+        render comment
       end
 
     end

data/lib/masterview/directives/javascript_include.rb

@@ -1,25 +1,34 @@
 module MasterView
   module Directives
 
-    #creates a link_to
-    class Javascript_include < MasterView::DirectiveBase
+    #creates a javascript_include asset helper
+    #
+    class JavascriptInclude < MasterView::DirectiveBase
 
       # /public\/javascripts\/(.*)/
       JAVASCRIPT_SRC_EXTRACT_REGEX = MasterView::ConfigSettings.template_asset_base_ref_pattern[:javascripts]
 
-      def stag(dcs)
-      end
+      metadata :priority => :default,
+        :category => 'asset',
+        :description => 'Replaces the element with the Rails javascript_include_tag helper',
+        :element_usage => 'script'
+
+      attr_arg :src, :varargs => true
 
-      def etag(dcs)
-        src = attrs_lck['src']
-        if attr_value.empty? && src
-          match = JAVASCRIPT_SRC_EXTRACT_REGEX.match(src)
-          js_loc = quote( (match) ? match[1] : src )
-        else
-          js_loc = attr_value.starts_with?(':') ? attr_value : quote(attr_value) 
+      event :element do
+        if @src.nil? or @src.empty?
+          if src_attr = element_attrs[:src]
+            if match = JAVASCRIPT_SRC_EXTRACT_REGEX.match(src_attr)
+              @src = [match[1]]
+            else
+              @src = [src_attr]
+            end
+          end
         end
-        erb_content('javascript_include_tag ' + js_loc)
+        @src.collect! { |x| x.starts_with?(':') ? x : quote(x) }
+        render erb_content('javascript_include_tag', :src)
       end
+
     end
 
   end

data/lib/masterview/directives/link_to.rb

@@ -2,16 +2,22 @@ module MasterView
   module Directives
 
     #creates a link_to
-    class Link_to < MasterView::DirectiveBase
-      def stag(dcs)
-      end
+    class LinkTo < MasterView::DirectiveBase
+
+      metadata :priority => :default,
+        :category => 'link',
+        :description => 'Replaces the element using the Rails link_to helper',
+        :element_usage => 'a'
 
-      def etag(dcs)
-        remove_strings_from_attr_value!
-        prepend_to_attr_value! quote( content_str ) #prepend quoted link name
-        self.content=''
-        erb_content('link_to ' + attr_value)
+      attr_arg :name do |value, args| if value.include?('=>') : args.unshift(value); end; nil; end # if hash push back on, discard name
+      attr_arg :options, :default => {}
+      attr_arg :html_options, :default => {}, :append_element_attrs => [:common_html]
+      attr_arg :params, :varargs => true
+
+      event :element do
+        render erb_content('link_to', quote(content_string), :options, :html_options, :params)
       end
+
     end
   end
 end

data/lib/masterview/directives/link_to_function.rb

@@ -0,0 +1,22 @@
+module MasterView
+  module Directives
+
+    #creates a link_to_function
+    class LinkToFunction < MasterView::DirectiveBase
+
+      metadata :priority => :default,
+        :category => 'link',
+        :description => 'Replaces the element with the Rails link_to_function helper which creates a link which calls a JavaScript function.',
+        :element_usage => 'a'
+
+      attr_arg :function
+      attr_arg :html_options, :append_element_attrs => [:common_html]
+
+      event :element do
+        @function = quote(@function, '"') unless @function.strip =~ /^('|")/ # quote unless already quoted, use double quote
+        render erb_content('link_to_function', quote(content_string), :function, :html_options)
+      end
+
+    end
+  end
+end

data/lib/masterview/directives/link_to_if.rb

@@ -1,21 +1,23 @@
 module MasterView
   module Directives
 
-    class Link_to_if < MasterView::DirectiveBase
-      def stag(dcs)
-      end
+    class LinkToIf < MasterView::DirectiveBase
+
+      metadata :priority => :default,
+        :category => 'link',
+        :description => 'Replaces the element using the Rails link_to_if helper',
+        :element_usage => 'a'
 
-      def etag(dcs)
-        args = parse_attr_value
-        condition = args[0]
-        remove_strings_from_attr_value!
-        a = []
-        a << 'link_to_if '+condition
-        a << quote(content_str)
-        a << attr_value unless attr_value.strip.empty?
-        self.content=''
-        erb_content(a.join(', '))
+      attr_arg :condition
+      attr_arg :name do |value, args| if value.include?('=>') : args.unshift(value); end; nil; end # if hash push back on, discard name
+      attr_arg :options, :default => {}
+      attr_arg :html_options, :default => {}, :append_element_attrs => [:common_html]
+      attr_arg :params, :varargs => true #including the block
+
+      event :element do
+        render erb_content('link_to_if', :condition, quote(content_string), :options, :html_options, :params)
       end
+
     end
   end
 end

data/lib/masterview/directives/link_to_remote.rb

@@ -2,16 +2,21 @@ module MasterView
   module Directives
 
     #creates a link_to_remote
-    class Link_to_remote < MasterView::DirectiveBase
-      def stag(dcs)
-      end
+    class LinkToRemote < MasterView::DirectiveBase
+
+      metadata :priority => :default,
+        :category => 'link',
+        :description => 'Replaces the element using the Rails link_to_remote helper',
+        :element_usage => 'a'
 
-      def etag(dcs)
-        remove_strings_from_attr_value!
-        prepend_to_attr_value! quote( content_str ) #prepend quoted link name
-        self.content=''
-        erb_content('link_to_remote ' + attr_value)
+      attr_arg :name do |value, args| if value.include?('=>') : args.unshift(value); end; nil; end # if hash push back on, discard name
+      attr_arg :options, :default => {}
+      attr_arg :html_options, :default => {}, :append_element_attrs => [:common_html]
+
+      event :element do
+        render erb_content('link_to_remote', quote(content_string), :options, :html_options)
       end
+
     end
   end
 end