docgenerator 2.0.0 → 2.1.0

data/lib/docgenerator/attribute.rb

@@ -15,10 +15,10 @@ Attributes are the first parameters of element:
   element( :type, {}, 'content' )
   Element.new( {} )
 =end
-class Attribute
-  @@settings  = {}
-  @@values    = {}
-  @@sortkey    = 99  #Just a counter to get identic positions between different program runs.
+  class Attribute
+    @@settings  = {}
+    @@values    = {}
+    @@sortkey    = 99  #Just a counter to get identic positions between different program runs.
 =begin rdoc
 Generic creation of a new class to define a new Atttribute.
 Settings is a hash with generell settings.
@@ -33,169 +33,169 @@ Supported parameters:
 
 The sortkey is used for a sort-sequence of attributes inside an element
 =end  
-  def  self.create( settings = [], values = nil, sortkey = (@@sortkey += 1 ) )
-    #First some checks
-    if ! settings.kind_of?( Array )
-      raise "Type error Attribute.create: Expected Array, get #{attr.class}"
-    end
-    #Generic class creation
-    attributeclass = Class.new( Attribute )
-    #Set the flags.
-    settings.each{|setting|
-      case setting
-      when :required
-        attributeclass.class_eval('def required?(); true; end')
-      when :content
-        attributeclass.class_eval('def content?();  true; end')
-      when :unique
-        attributeclass.class_eval('def unique?();  true; end')        
-      when :html
-        attributeclass.class_eval('def html?();  true; end')
-      when :latex
-        attributeclass.class_eval('def latex?();  true; end')
-      when :texkeyval
-        attributeclass.class_eval('def texkeyval?();  true; end')
-      when :text
-        attributeclass.class_eval('def text?();  true; end')
-      when :wiki
-        attributeclass.class_eval('def wiki?();  true; end')
-      when :creole
-        attributeclass.class_eval('def creole?();  true; end')
-      else
-        DOCGENERATOR_LOGGER.error("Attribute: Unknown setting <#{setting.inspect}>") if DOCGENERATOR_LOGGER.error?
+    def  self.create( settings = [], values = nil, sortkey = (@@sortkey += 1 ) )
+      #First some checks
+      if ! settings.kind_of?( Array )
+        raise "Type error Attribute.create: Expected Array, get #{attr.class}"
       end
-    }
-    if values
-      attributeclass.class_eval("def allowed_values();  return #{values.inspect}; end")
-    end  
-    attributeclass.class_eval("def sortkey();  return #{sortkey}; end")
-    return attributeclass
-  end
+      #Generic class creation
+      attributeclass = Class.new( Attribute )
+      #Set the flags.
+      settings.each{|setting|
+        case setting
+        when :required
+          attributeclass.class_eval('def required?(); true; end')
+        when :content
+          attributeclass.class_eval('def content?();  true; end')
+        when :unique
+          attributeclass.class_eval('def unique?();  true; end')        
+        when :html
+          attributeclass.class_eval('def html?();  true; end')
+        when :latex
+          attributeclass.class_eval('def latex?();  true; end')
+        when :texkeyval
+          attributeclass.class_eval('def texkeyval?();  true; end')
+        when :text
+          attributeclass.class_eval('def text?();  true; end')
+        when :wiki
+          attributeclass.class_eval('def wiki?();  true; end')
+        when :creole
+          attributeclass.class_eval('def creole?();  true; end')
+        else
+          DOCGENERATOR_LOGGER.error("Attribute: Unknown setting <#{setting.inspect}>") if DOCGENERATOR_LOGGER.error?
+        end
+      }
+      if values
+        attributeclass.class_eval("def allowed_values();  return #{values.inspect}; end")
+      end  
+      attributeclass.class_eval("def sortkey();  return #{sortkey}; end")
+      return attributeclass
+    end
 
-  #Each attribute is assigned to an element.
-  def initialize( name, element )
-    @name  = name
-    @element  = element
-    @attr_content  = []
-    @part_of    = [element]  #list of elements, where this element is part of (normaly only one element)
-    @part_of_doc  = []      #list of documents, where this element is part of (normaly only one document)
-    #@part_of_doc  = element.part_of_doc  May not work - is empty to generation time
-                
-  end
-  #Key of the attribute
-  attr_reader :name
-  #Return class settings. Can be used for some checks.
-  def settings()
-    @@settings
-  end
-  #Check if the attribute is required.
-  #Redefined by Attribute.create and used in Element.to_s.
-  def required?();  false; end
-  #Check if the attribute can contain a "content".
-  #Redefined by Attribute.create.
-  def content?();  false; end
-  #Sometimes the content of an attribute is needed directly.
-  def content();  @attr_content; end
-  #Values may be added only once. 
-  def unique?();  false; end
-  #Check if content was added
-  def filled?();  return @attr_content.compact.size > 0; end
-  #Attribut is used for HTML.
-  def html?();  false; end
-  #Attribut is used for Text.
-  def text?();  false; end
-  #Attribut is used for Wiki.
-  def wiki?();  false; end
-  #Attribut is used for Creole.
-  def creole?();  false; end
-  #Attribute is used for latex.
-  #Only for informational reasons.
-  def latex?();  false; end
-  #Attribute is used for conTeXt.
-  #Only for informational reasons.
-  def context?();  false; end
-  #Attribute is used as a keyval-option.
-  #See also Element#texkeyval
-  def texkeyval?();  false; end
-  #Return all allowed values.
-  #Redefined by Attribute.create and used in Attributes.<<
-  #By default everything is allowed.  
-  #
-  #This method must return an Array with the allowed values or classes.
-  def allowed_values()
-    return nil
-  end
-  #Check if the given value is allowed.
-  def allowed?( value )
-    return true if allowed_values() == nil
-    allowed_values().each{|v|
-      if value == v #same value
-        return true
-      elsif v.is_a?(Regexp) and value =~ v
-        return true
-      elsif v.class == Class and value.is_a?( v ) #same class
-        return true
+    #Each attribute is assigned to an element.
+    def initialize( name, element )
+      @name  = name
+      @element  = element
+      @attr_content  = []
+      @part_of    = [element]  #list of elements, where this element is part of (normaly only one element)
+      @part_of_doc  = []      #list of documents, where this element is part of (normaly only one document)
+      #@part_of_doc  = element.part_of_doc  May not work - is empty to generation time
+                  
+    end
+    #Key of the attribute
+    attr_reader :name
+    #Return class settings. Can be used for some checks.
+    def settings()
+      @@settings
+    end
+    #Check if the attribute is required.
+    #Redefined by Attribute.create and used in Element.to_s.
+    def required?();  false; end
+    #Check if the attribute can contain a "content".
+    #Redefined by Attribute.create.
+    def content?();  false; end
+    #Sometimes the content of an attribute is needed directly.
+    def content();  @attr_content; end
+    #Values may be added only once. 
+    def unique?();  false; end
+    #Check if content was added
+    def filled?();  return @attr_content.compact.size > 0; end
+    #Attribut is used for HTML.
+    def html?();  false; end
+    #Attribut is used for Text.
+    def text?();  false; end
+    #Attribut is used for Wiki.
+    def wiki?();  false; end
+    #Attribut is used for Creole.
+    def creole?();  false; end
+    #Attribute is used for latex.
+    #Only for informational reasons.
+    def latex?();  false; end
+    #Attribute is used for conTeXt.
+    #Only for informational reasons.
+    def context?();  false; end
+    #Attribute is used as a keyval-option.
+    #See also Element#texkeyval
+    def texkeyval?();  false; end
+    #Return all allowed values.
+    #Redefined by Attribute.create and used in Attributes.<<
+    #By default everything is allowed.  
+    #
+    #This method must return an Array with the allowed values or classes.
+    def allowed_values()
+      return nil
+    end
+    #Check if the given value is allowed.
+    def allowed?( value )
+      return true if allowed_values() == nil
+      allowed_values().each{|v|
+        if value == v #same value
+          return true
+        elsif v.is_a?(Regexp) and value =~ v
+          return true
+        elsif v.class == Class and value.is_a?( v ) #same class
+          return true
+        end
+        #Check next allowed value.
+      }
+      #No allowed value is set.
+      return false
+      #~ return allowed_values().include?( value )
+    end
+    #Add a value to the attribute content.
+    def << ( value )
+      if ! self.allowed?( value )
+        @element.log.warn("Attribute '#{@name}': Incorrect value '#{value.inspect}' for #{@element.inspect}") if @element.log.warn?
+      end
+      if unique? and @attr_content.size > 0
+        @element.log.warn("Attribute #{@name}: More then one value added to #{@element.inspect} (#{value.inspect})") if @element.log.warn?
+        return self
+      end
+      if content?
+        @element << value
+      else
+        @attr_content << value
       end
-      #Check next allowed value.
-    }
-    #No allowed value is set.
-    return false
-    #~ return allowed_values().include?( value )
-  end
-  #Add a value to the attribute content.
-  def << ( value )
-    if ! self.allowed?( value )
-      @element.log.warn("Attribute '#{@name}': Incorrect value '#{value.inspect}' for #{@element.inspect}") if @element.log.warn?
     end
-    if unique? and @attr_content.size > 0
-      @element.log.warn("Attribute #{@name}: More then one value added to #{@element.inspect} (#{value.inspect})") if @element.log.warn?
-      return self
+    #Return the content.
+    def to_s()
+      #~ @attr_content.to_s() #Ruby 1.8
+      @attr_content.join()  #since Ruby 1.9
     end
-    if content?
-      @element << value
-    else
-      @attr_content << value
+    def inspect()
+      return "<#Attribute #{@name} #{@attr_content.inspect} (in #{@element.inspect}) >"
     end
-  end
-  #Return the content.
-  def to_s()
-    #~ @attr_content.to_s() #Ruby 1.8
-    @attr_content.join()  #since Ruby 1.9
-  end
-  def inspect()
-    return "<#Attribute #{@name} #{@attr_content.inspect} (in #{@element.inspect}) >"
-  end
-end #Attribute
+  end #Attribute
 
-#Definition of HTML-Tags (Sublasses of Element).
-ATTR_LANG    = Attribute.create( [ :html ], ['en', 'de'] )
-#
-HTML_ATTR_CORE  = {  
-          :id    => Attribute.create( [ :html ] ),
-          :class  => Attribute.create( [ :html ] ),
-          :style  => Attribute.create( [ :html ], [CSS, String]),  #fixme string raus
-          #~ :name  => Attribute.create( [ :html ] ),
-          :title    => Attribute.create( [ :html ] ) }
-HTML_ATTR_I18N  = {  
-          :lang    => ATTR_LANG,
-          :dir    => Attribute.create( [ :html ], ['ltr', 'rtl'] )
+  #Definition of HTML-Tags (Sublasses of Element).
+  ATTR_LANG    = Attribute.create( [ :html ], ['en', 'de'] )
+  #
+  HTML_ATTR_CORE  = {  
+            :id    => Attribute.create( [ :html ] ),
+            :class  => Attribute.create( [ :html ] ),
+            :style  => Attribute.create( [ :html ], [CSS, String]),  #fixme string raus
+            #~ :name  => Attribute.create( [ :html ] ),
+            :title    => Attribute.create( [ :html ] ) }
+  HTML_ATTR_I18N  = {  
+            :lang    => ATTR_LANG,
+            :dir    => Attribute.create( [ :html ], ['ltr', 'rtl'] )
+          }
+  HTML_ATTR_EVENTS = {  :onclick    => Attribute.create( [ :html ] ), 
+            :ondblclick    => Attribute.create( [ :html ] ), 
+            :onmousedown  => Attribute.create( [ :html ] ),
+            :onmouseup  => Attribute.create( [ :html ] ),
+            :onmouseover  => Attribute.create( [ :html ] ),
+            :onmousemove  => Attribute.create( [ :html ] ),
+            :onmouseout  => Attribute.create( [ :html ] ), 
+            :onkeypress  => Attribute.create( [ :html ] ),
+            :onkeyup    => Attribute.create( [ :html ] ), 
+            :onkeydown  => Attribute.create( [ :html ] )
         }
-HTML_ATTR_EVENTS = {  :onclick    => Attribute.create( [ :html ] ), 
-          :ondblclick    => Attribute.create( [ :html ] ), 
-          :onmousedown  => Attribute.create( [ :html ] ),
-          :onmouseup  => Attribute.create( [ :html ] ),
-          :onmouseover  => Attribute.create( [ :html ] ),
-          :onmousemove  => Attribute.create( [ :html ] ),
-          :onmouseout  => Attribute.create( [ :html ] ), 
-          :onkeypress  => Attribute.create( [ :html ] ),
-          :onkeyup    => Attribute.create( [ :html ] ), 
-          :onkeydown  => Attribute.create( [ :html ] )
-      }
-HTML_ATTR_ALL = {}
-HTML_ATTR_ALL.update(HTML_ATTR_I18N)
-HTML_ATTR_ALL.update(HTML_ATTR_EVENTS)
-HTML_ATTR_ALL.update(HTML_ATTR_CORE)
+  HTML_ATTR_ALL = {}
+  HTML_ATTR_ALL.update(HTML_ATTR_I18N)
+  HTML_ATTR_ALL.update(HTML_ATTR_EVENTS)
+  HTML_ATTR_ALL.update(HTML_ATTR_CORE)
 
-HTML_ATTR_ALIGN  = Attribute.create( [ :html ], ['left', 'center', 'right', 'justify', 'char'] )
-HTML_ATTR_VALIGN  = Attribute.create( [ :html ], ['bottom', 'top', 'middle', 'baseline'] )
+  HTML_ATTR_ALIGN  = Attribute.create( [ :html ], ['left', 'center', 'right', 'justify', 'char'] )
+  HTML_ATTR_VALIGN  = Attribute.create( [ :html ], ['bottom', 'top', 'middle', 'baseline'] )
 end #module Docgenerator