masterview 0.2.5 → 0.3.0

data/lib/masterview/masterview_info.rb

@@ -29,6 +29,55 @@
 #++
 
 module MasterView
+
+  module ConfigInfoHelpers #:nodoc:
+
+    # HTML fragment templates; optionally include class/style attributes to control rendering
+    DEFAULT_RENDERING_OPTIONS = {
+      :title => '<h1>%s</h1>',  #parms: config settings title
+      :preamble => '<p><b>MasterView Version:</b> %s</p>',  #parms: MasterView version
+      :container => "<table%s>\n<tbody>%s</tbody>\n</table>",  #parms: :container_attrs, section/property entries
+      :container_attrs => '',
+      :section_entry => '<tr%s><td colspan="2">%s</td></tr>', #parms: :section_attrs, section_name
+      :section_attrs => 'style="background-color: #dcdcdc; font-weight: bold; margin-top: 6px;"',
+      :option_entry => '<tr><td%s>%s</td><td%s>%s</td></tr>',  #parms: :option_name_attrs, option_name, :option_value_attrs, option_value
+      :option_name_attrs => 'style="padding-left: 6px; padding-right: 6px; font-weight: bold;"',
+      :option_value_attrs => '',
+      :postscript => '',
+    }
+
+    ELEMENTS_WITH_ATTRS = [ :container, :section_entry ]
+
+    # get the option parameter value; provide default in not specified in client params.
+    def self.getOption(option_name, params, defaults=DEFAULT_RENDERING_OPTIONS)
+      params.fetch( option_name, defaults[option_name] )
+    end
+
+    # Get the option parameter value for an html element; provide default in not specified in client params.
+    # Resolve any element attributes so rendering can focus on filling in content entries
+    def self.getHtmlTemplate(element_option_name, params, defaults=DEFAULT_RENDERING_OPTIONS)
+      element_template = getOption( element_option_name, params, defaults )
+      return element_template if element_template == :none
+      if ELEMENTS_WITH_ATTRS.include? element_option_name
+        attrs_option_name = "#{element_option_name.to_s.split('_')[0]}_attrs".to_sym  # :foo_attrs
+        element_attrs = getOption( attrs_option_name, params, defaults )
+        # ensure separator space for ' style="xxx"' on the section entry style/class attr(s)
+        element_attrs.insert(0, ' ') if (element_attrs && element_attrs != '' && element_attrs[0...1] != ' ')
+        element_template = element_template.sub(  '%s', element_attrs )  # resolve the first parm slot in the template to the attrs
+      elsif element_option_name == :option_entry
+        # double-up: attrs/value template parm pair for both option_name and option_value
+        option_entry_name_attrs = getOption( :option_name_attrs, params, defaults )
+        option_entry_value_attrs = getOption( :option_value_attrs, params, defaults )
+        # ensure separator space for ' style="xxx"' on the option name/value style/class attr(s)
+        option_entry_name_attrs.insert(0, ' ') if (option_entry_name_attrs && option_entry_name_attrs != '' && option_entry_name_attrs[0...1] != ' ')
+        option_entry_value_attrs.insert(0, ' ') if (option_entry_value_attrs && option_entry_value_attrs != '' && option_entry_value_attrs[0...1] != ' ')
+        element_template = element_template % [ option_entry_name_attrs, '%s', option_entry_value_attrs, '%s' ]  # install the optional style settings once, just plug in option name/value hereafter
+      end
+      element_template
+    end
+
+  end
+
   module Info #:nodoc:
 
     PROP_CATEGORY_ROOTS = 'MasterView Roots'
@@ -43,50 +92,48 @@ module MasterView
       [ PROP_CATEGORY_ROOTS, 
           [ :mv_installation_dir, :rails_app?, :on_rails? ] ],
       [ PROP_CATEGORY_GENERAL_OPTIONS, 
-          [ :root_path, :config_dir_path, :environment  ] ],  #:directive_paths
+          [ :root_path, :config_dir_path, :environment  ] ],  #:directive_load_path
       [ PROP_CATEGORY_TEMPLATE_SRC_OPTIONS, 
           [ :template_src_dir_path, :template_filename_pattern ] ],
       [ PROP_CATEGORY_TEMPLATE_GEN_OPTIONS, 
           [ :template_dst_dir_path, :output_filename_extension, :generated_file_default_extension, :include_generated_file_comment ] ],
       [ PROP_CATEGORY_TEMPLATE_PARSE_OPTIONS, 
-          [ :default_parser_options, :namespace_prefix ] ],
+          [ :default_parser_options, :namespace_prefix, :namespace_prefix_extensions ] ],
       [ PROP_CATEGORY_RAILS_APP_OPTIONS, 
           [ :parse_masterview_templates_at_startup, :reparse_changed_masterview_templates, :generate_rhtml_files ] ]
       ]
 
     PROPERTY_CATEGORIES = CATEGORIZED_PROPERTY_SPECS.collect { | catEntry | catEntry[0] }
 
+    def self.getHtmlTemplate(element_option_name, params)
+      ConfigInfoHelpers.getHtmlTemplate( element_option_name, params )#, defaults=ConfigInfoHelpers.::DEFAULT_RENDERING_OPTIONS
+    end
 
-    # Answer an html rendering
+    # Answer an html rendering of the Configuration
+    # Optionally provide HTML fragment templates and class/style attributes to customize rendering
     def self.to_html( params={} )
 
+      config = MasterView::ConfigSettings
+
       # unpack the supported keyword args
-      # Provide HTML fragment templates; optionally include class/style attributes to control rendering
-      title_html_template = params.fetch( :title, '<h1>%s</h1>' )  #parms: MV Config title
-      preamble_html_template = params.fetch( :preamble, '<p><b>MasterView Version:</b> %s</p>' )  #parms: MasterView version
-      config_settings_html_template = params.fetch( :table, "<table>\n<tbody>%s</tbody>\n</table>" % ['%s'] ) #parms: section/property table rows
-      section_entry_attrs = params.fetch( :section_attrs, 'style="background-color: #dcdcdc; font-weight: bold; margin-top: 6px;"' )
-      section_entry_html_template = params.fetch( :section_entry, '<tr%s><td colspan="2">%s</td></tr>' ) #parms: :section_attrs, section_name
-      option_entry_name_attrs = params.fetch( :option_name_attrs, 'style="padding-left: 6px; padding-right: 6px; font-weight: bold;"' )
-      option_entry_value_attrs = params.fetch( :option_value_attrs, '' )
-      option_entry_html_template = params.fetch( :option_entry, '<tr><td%s>%s</td><td%s>%s</td></tr>' ) #parms: :option_name_attrs, option_name, :option_value_attrs, option_value
-      postscript_html = params.fetch( :postscript, '' )  #'<div style="padding-top: 6px;">(back to <a href=".">Admin home</a>)</div>'
+      title_html_template = getHtmlTemplate( :title, params )  #parms: config settings title
+      preamble_html_template = getHtmlTemplate( :preamble, params ) #parms: MasterView version
+      config_settings_html_template = getHtmlTemplate( :container, params ) #parms: section/option entries
+      section_entry_html_template = getHtmlTemplate( :section_entry, params ) #parms: :section_attrs, section_name
+      option_entry_html_template = getHtmlTemplate( :option_entry, params ) #parms: :option_name_attrs, option_name, :option_value_attrs, option_value
+      postscript_html = getHtmlTemplate( :postscript, params )
 
       # prepare our templates for convenient use during the generation loop below
       config_settings_html_start, config_settings_html_end = config_settings_html_template.split('%s')
-      # ensure separator space for ' style="xxx"' on the section entry style/class attr(s)
-      section_entry_attrs.insert(0, ' ') if (section_entry_attrs && section_entry_attrs != '' && section_entry_attrs[0...1] != ' ')
-      section_entry_html_template = section_entry_html_template % [ section_entry_attrs, '%s' ]  # install the optional style setting once, just plug in section_name hereafter
-      # ensure separator space for ' style="xxx"' on the option name/value style/class attr(s)
-      option_entry_name_attrs.insert(0, ' ') if (option_entry_name_attrs && option_entry_name_attrs != '' && option_entry_name_attrs[0...1] != ' ')
-      option_entry_value_attrs.insert(0, ' ') if (option_entry_value_attrs && option_entry_value_attrs != '' && option_entry_value_attrs[0...1] != ' ')
-      option_entry_html_template = option_entry_html_template % [ option_entry_name_attrs, '%s', option_entry_value_attrs, '%s' ]  # install the optional style settings once, just plug in option name/value hereafter
 
       # and off we go at last
-      config = MasterView::ConfigSettings
       html = []
-      html << title_html_template % [ 'MasterView Configuration' ] if title_html_template  # allow client to suppress
-      html << preamble_html_template % [ MasterView::VERSION::STRING ] if preamble_html_template
+      unless title_html_template == :none  # allow client to suppress
+        html << title_html_template % [ 'MasterView Configuration' ]
+      end
+      unless preamble_html_template == :none  # allow client to suppress
+        html << preamble_html_template % [ MasterView::VERSION::STRING ]
+      end
       html << config_settings_html_start
       CATEGORIZED_PROPERTY_SPECS.each { | section_name, options | 
         html << section_entry_html_template % section_name
@@ -114,4 +161,163 @@ module MasterView
     end
 
   end
+
+  module DirectivesInfo #:nodoc:
+
+    DEFAULT_RENDERING_OPTIONS = ConfigInfoHelpers::DEFAULT_RENDERING_OPTIONS.clone
+    #config_notes template parms: default directive priority level name
+    DEFAULT_RENDERING_OPTIONS[:config_notes] = '<div style="font-style: italic;"><b>Note:</b> default directive priority level is <b>%s</b>.</div>'
+    # priority label 'default (Med)' gets wrapped regardless of width, so give up
+    #DEFAULT_RENDERING_OPTIONS[:option_value_attrs] = 'style="width: 140px;"'
+    DEFAULT_RENDERING_OPTIONS[:option_subentry_entry] = '<tr><td colspan="2" style="font-style: italic; padding-left: 20px;">%s</td></tr>'
+    
+    def self.getHtmlTemplate(element_option_name, params)
+      ConfigInfoHelpers.getHtmlTemplate( element_option_name, params, DEFAULT_RENDERING_OPTIONS )
+    end
+
+    # Answer an html rendering of the Configuration
+    # Optionally provide HTML fragment templates and class/style attributes to customize rendering
+    def self.to_html( params={} )
+
+      default_priority = MasterView::DirectiveMetadata::DirectivePriorities::Default
+      default_priority = MasterView::DirectiveMetadata.get_priority_name(default_priority)
+
+      # organize the directives info we want to present
+      directive_load_path = MasterView::DirectiveLoadPath.current
+      directive_registry = MasterView::DirectiveRegistry.current
+      namespaces = directive_registry.loaded_namespaces.sort
+      directives = {}
+      namespaces.each { | ns_name | directives[ns_name] = {} }
+      directive_registry.loaded_classes.each { | directive_class |
+        ns_name = directive_class.namespace_name
+        attr_name = directive_class.attribute_name
+        directives[ns_name][attr_name] = directive_class
+      }
+
+      # unpack the supported keyword args
+      title_html_template = getHtmlTemplate( :title, params )  #parms: config settings title
+      preamble_html_template = getHtmlTemplate( :preamble, params ) #parms: MasterView version
+      config_notes_html_template = getHtmlTemplate( :config_notes, params ) #parms: default priority level
+      config_settings_html_template = getHtmlTemplate( :container, params ) #parms: section/option entries
+      section_entry_html_template = getHtmlTemplate( :section_entry, params ) #parms: :section_attrs, section_name
+      option_entry_html_template = getHtmlTemplate( :option_entry, params ) #parms: :option_name_attrs, option_name, :option_value_attrs, option_value
+      option_subentry_entry_html_template = getHtmlTemplate( :option_subentry_entry, params ) #parms: value
+      postscript_html = getHtmlTemplate( :postscript, params )
+
+      # prepare our templates for convenient use during the generation loop below
+      config_settings_html_start, config_settings_html_end = config_settings_html_template.split('%s')
+
+      # and off we go at last
+      config = MasterView::ConfigSettings
+      html = []
+      unless title_html_template == :none  # allow client to suppress
+        html << title_html_template % [ 'MasterView Configuration' ]
+      end
+      unless preamble_html_template == :none  # allow client to suppress
+        html << preamble_html_template % [ MasterView::VERSION::STRING ]
+      end
+      unless config_notes_html_template == :none  # allow client to suppress
+        html << config_notes_html_template % [ default_priority ]
+      end
+      html << config_settings_html_start
+      # Loaded directives
+      namespaces.each { | ns_name |
+        html << section_entry_html_template % "#{ns_name}: Namespace Directives"
+        directives_map = directives[ns_name]  ###[attr_name] = directive_class
+        directives_map.keys.sort.each { | attr_name |
+          directive_class = directives_map[attr_name]
+          attr_qname = directive_class.attribute_qname
+          priority = MasterView::DirectiveMetadata.get_priority_label(directive_class.priority)
+          description = priority  #too verbose: "priority #{priority}"
+          html << option_entry_html_template % [ attr_qname, description ]
+          description = directive_class.metadata_values[:description]
+          if description
+            html << option_subentry_entry_html_template % description
+          end
+        }
+      }
+      # load path
+      html << section_entry_html_template % 'Directives Load Path'
+      directive_load_path.each { | dpe |
+          option_name = dpe.dir_path
+          option_value = '&nbsp;'  #TODO: dpe.options.inspect
+          html << option_entry_html_template % [ option_name, option_value ]
+      }
+      html << config_settings_html_end
+      unless postscript_html == :none  # allow client to suppress
+        html << postscript_html
+      end
+      html.join("\n")
+
+    end
+
+  end
+
+  module FeaturesInfo #:nodoc:
+
+    # Jeff's original rendering
+    CONTAINER_HTML = "<table%s>\n<thead>\n  <tr><th>Feature</th><th>Loaded</th></tr>\n</thead>\n<tbody>\n%s\n</tbody>\n</table>"
+
+    DEFAULT_RENDERING_OPTIONS = ConfigInfoHelpers::DEFAULT_RENDERING_OPTIONS.clone
+    #DEFAULT_RENDERING_OPTIONS[:container] = CONTAINER_HTML
+    DEFAULT_RENDERING_OPTIONS[:section_entry] = '<tr%s><td>%s</td><td>%s</td></tr>' #parms: :section_attrs, section_name
+    DEFAULT_RENDERING_OPTIONS[:section_attrs] = 'style="background-color: #dcdcdc; font-weight: bold; margin-top: 6px;"'
+    DEFAULT_RENDERING_OPTIONS[:option_name_attrs] = ''
+    #already is: DEFAULT_RENDERING_OPTIONS[:option_value_attrs] = ''
+
+    def self.getHtmlTemplate(element_option_name, params)
+      ConfigInfoHelpers.getHtmlTemplate( element_option_name, params, DEFAULT_RENDERING_OPTIONS )
+    end
+
+    FEATURE_SPECS = [
+      # [ <option_name>, <label>, <type> ]
+      [ :tidy_template_read, 'Filter templates through tidy on read', 'boolean' ],
+      [ :rails_parse_at_startup, 'Parse templates at startup', 'boolean' ],
+      [ :rails_reparse_checking, 'Reparse modified templates', 'boolean' ],
+      [ :rails_erb_mv_direct, 'Read ERB directly from MasterView', 'boolean' ],
+    ]
+
+    # Answer an html rendering of the Loaded Features
+    # Optionally provide HTML fragment templates and class/style attributes to customize rendering
+    def self.to_html( params={} )
+
+      features = MasterView::LoadedFeatures
+
+      # unpack the supported keyword args
+      title_html_template = getHtmlTemplate( :title, params )  #parms: config settings title
+      preamble_html_template = getHtmlTemplate( :preamble, params ) #parms: MasterView version
+      config_settings_html_template = getHtmlTemplate( :container, params ) #parms: section/option entries
+      section_entry_html_template = getHtmlTemplate( :section_entry, params ) #parms: :section_attrs, section_name
+      option_entry_html_template = getHtmlTemplate( :option_entry, params ) #parms: :option_name_attrs, option_name, :option_value_attrs, option_value
+      option_subentry_entry_html_template = params.fetch( :option_subentry_entry, '<tr><td colspan="2" style="font-style: italic; padding-left: 20px;">%s</td></tr>' )
+      postscript_html = ConfigInfoHelpers.getHtmlTemplate( :postscript, params )
+
+      # prepare our templates for convenient use during the generation loop below
+      config_settings_html_start, config_settings_html_end = config_settings_html_template.split('%s')
+
+      # and off we go at last
+      config = MasterView::ConfigSettings
+      html = []
+      unless title_html_template == :none  # allow client to suppress
+        html << title_html_template % [ 'MasterView Configuration' ]
+      end
+      unless preamble_html_template == :none  # allow client to suppress
+        html << preamble_html_template % [ MasterView::VERSION::STRING ]
+      end
+      html << config_settings_html_start
+      # Loaded features
+      html << section_entry_html_template % [ 'Feature', 'Loaded' ]
+      FEATURE_SPECS.each {| option_name, label, value_type |
+        option_value = features[option_name]
+        option_value = option_value ? 'true' : 'false' if value_type == 'boolean'
+        html << option_entry_html_template % [ label, option_value ]
+      }
+      html << config_settings_html_end
+      html << postscript_html if postscript_html
+      html.join("\n")
+
+    end
+
+  end
+
 end

data/lib/masterview/masterview_version.rb

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