ziya 1.0.0 → 2.0.0

data/lib/ziya/components/axis_value.rb

@@ -1,59 +1,16 @@
 # -----------------------------------------------------------------------------

 # Setup configuration on the chart value axis
 #
-# Sets the label attributes for the value-axis.
-#
-# <tt>min</tt>:               The minimum value to start the value-axis with.
-#                             The default is calculated from the chart's data. In 3D column charts, the minimum value
-#                             is always zero.
-# <tt>max</tt>:               The maximum value to end the value-axis with.
-#                             The default is calculated from the chart's data.
-# <tt>steps</tt>:             The number of steps between the minimum and maximum values. If the minimum value is negative,
-#                             and the maximum value is positive, then 'steps' is the number of steps between zero and the
-#                             larger of max and absolute min.
-#                             The default is 4.
-# <tt>prefix</tt>:            The characters to add before the value numbers (example: $10).
-#                             The default is nothing.
-# <tt>suffix</tt>:            The characters to add after the value numbers (example: 10%).
-#                             The default is nothing.
-# <tt>decimals</tt>:          The number of decimal places to the right of the decimal point (example: 10.45).
-#                             The default is zero (no decimals).
-# <tt>decimal_char</tt>:      The character to use at the left of a decimal fraction (example: 1.5).
-#                             The default is '.' (dot or full stop.)
-# <tt>separator</tt>:         The character to place between every group of thousands (example: 1,00,000).
-#                             The default is nothing.
-# <tt>show_min</tt>:          A boolean that indicates whether show or hide the first label in the value-axis. Hiding this
-#                             first label might be necessary if it overlaps with the first label in the category axis.
-#                             The default is true (show the first label).
-# <tt>font</tt>:              The font used in the value-axis.
-#                             The default is Arial.
-# <tt>bold</tt>:              A boolean value that indicates whether the font is bold or not.
-#                             The default is true.
-# <tt>size</tt>:              The font's size.
-#                             The default font size is calculated based on the chart size.
-# <tt>color</tt>:             The font's color. This must be a string holding triple hexadecimal values representing the red,
-#                             green, and blue components for a color.
-#                             The default is "000000" (black).
-# <tt>background_color</tt>:  This applies to Polar charts only. It determines the labels' background color to make them visible
-#                             over the graph. When omitted, axis_value labels have no background. This must be a string holding
-#                             triple hexadecimal values representing the red, green, and blue components for a color.
-#                             The default is omitted (no background).
-# <tt>alpha</tt>:             This affects the labels' transparency, only when the embedded font is used. Valid values are
-#                             0 (fully transparent) to 100 (fully opaque).
-#                             The default is 90. To hide all labels in this axis, set the alpha to 0.
-# <tt>orientation</tt>:       This affects the labels' orientation, only when the embedded font is used. Valid values are
-#                             "horizontal", "diagonal_up", "diagonal_down", "vertical_up", and "vertical_down."
-#                             The default value is "horizontal".
-#
-# See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=axis_value
-# for additional documentation, examples and futher detail.
 # Author:: Fernand Galiana
-# Date::   Dec 15th, 2006
 # -----------------------------------------------------------------------------
 module Ziya::Components
+  # Specifies the label attribute on the x or y axis depending on the chart type.
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=axis_value
+  # for additional documentation, examples and futher detail.    
   class AxisValue < Base  
     has_attribute :min, :max, :steps, :prefix, :suffix, :decimals,
                   :decimal_char, :separator, :show_min, :font, :bold,
-                  :size, :color, :background_color, :alpha, :orientation                
+                  :size, :color, :background_color, :alpha, :orientation,
+                  :shadow, :bevel, :glow, :blur
   end
 end

data/lib/ziya/components/base.rb

@@ -8,14 +8,14 @@
 # Date::   Dec 15th, 2006
 # -----------------------------------------------------------------------------
 module Ziya::Components
-  class Base    
+  class Base # :nodoc:
     include Ziya::Utils::Text
         
     # class methods...
     class << self     
       # -----------------------------------------------------------------------
       # defines attribute accessors for a given component
-      def has_attribute(*args)
+      def has_attribute(*args) # :nodoc:
         class_name = self.to_s
         args.each do |attribute|          
           # add the attribute to the collection making sure to create a new array if one doesn't exist
@@ -30,11 +30,25 @@ module Ziya::Components
     
       # -----------------------------------------------------------------------
       # Class accessor. Retrieve class level preferences
-      def attributes
+      def attributes # :nodoc:
         @attributes ||= {}
       end
     end
   
+    # -------------------------------------------------------------------------
+    # initializes component from hash
+    def initialize( opts={} )
+      opts.each_pair do |k,v|
+        self.send( "#{k}=", v )
+      end
+    end
+  
+    def ==( other )
+      self.options.each_pair do |k,v|
+        return false unless other.send( k ) == v
+      end
+    end  
+    
     # -------------------------------------------------------------------------
     # merge attributes with overriden component
     def merge( parent_attributes, force=false )
@@ -45,19 +59,34 @@ module Ziya::Components
       end
     end
   
-    # -------------------------------------------------------------------------
-    # handles simple flatten operation
-    def method_missing(method, *args)
-      case method
-        when :flatten
-          xml   = args.first
-          clazz = self.class.name.gsub!( /Ziya::Components::/, '' )
-          pref  = underscore( clazz )
-          self.class.module_eval "xml.#{pref}( #{options_as_string} )"
-        else
-          super.method_missing(method, *args)
+    def flatten( xml )
+      hash  = has_sub_components
+      clazz = demodulize( self.class.name )
+      pref  = underscore( clazz )
+      if hash and ! hash.empty?     
+        self.class.module_eval <<-XML
+         xml.#{pref}( #{options_as_string} ) do
+          hash.each{ |k,v| v.flatten( xml ) }
+         end
+        XML
+      else
+        self.class.module_eval "xml.#{pref}( #{options_as_string} )"
       end
     end
+    
+    # -------------------------------------------------------------------------
+    # handles simple flatten operation
+    # def method_missing(method, *args)
+    #   case method
+    #     when :flatten
+    #       xml   = args.first
+    #       clazz = demodulize( self.class.name )
+    #       pref  = underscore( clazz )
+    #       self.class.module_eval "xml.#{pref}( #{options_as_string} )"
+    #     else
+    #       super.method_missing(method, *args)
+    #   end
+    # end
   
     # -------------------------------------------------------------------------
     # checks if a give component properties have been set. 
@@ -66,13 +95,22 @@ module Ziya::Components
       !options.empty?
     end
       
+    # -------------------------------------------------------------------------
+    # Checks if one of the options is an array
+    def has_sub_components
+      options.each_pair do |k, v|
+        return v if v.is_a? YAML::Omap
+      end
+      nil
+    end
+    
     # -------------------------------------------------------------------------
     # calls all attribute methods and gather the various props into a hash
     def options
       options = {}
       attributes_for(self).each do |p|
-        option = self.send(p.to_sym)
-        options[p] = option if option
+        option = self.send(p.to_sym)   
+        options[p] = option unless option.nil?
       end
       options
     end
@@ -84,7 +122,7 @@ module Ziya::Components
       opts = options
       opts.keys.sort{ |a,b| a.to_s <=> b.to_s }.each do |k|
         value = opts[k]
-        buff << sprintf( ":%s => '%s'", k, value.to_s ) if value
+        buff << sprintf( ":%s => '%s'", k, value.to_s ) if !value.nil? and !value.is_a? YAML::Omap
       end      
       buff.join( "," )
     end
@@ -96,5 +134,9 @@ module Ziya::Components
       raise "Unable to get attributes for #{an_instance}" unless attrs
       attrs
     end
+    
+    # =========================================================================
+    private
+         
   end
 end

data/lib/ziya/components/bevel.rb

@@ -0,0 +1,15 @@
+# -----------------------------------------------------------------------------

+# Create a bevel filter
+#
+# Author:: Fernand
+# -----------------------------------------------------------------------------
+module Ziya::Components
+  # Specifies the bevel filter to be applied to some component ie chart_rect, axis_value, etc...
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=filter
+  # for additional documentation, examples and futher detail.    
+  class Bevel < Base  
+    has_attribute :id, :distance, :angle, :highlightColor, :highlightAlpha, 
+                  :shadowColor, :shadowAlpha, :blurX, :blurY, :strength, 
+                  :quality, :type, :knockout
+  end
+end

data/lib/ziya/components/blur.rb

@@ -0,0 +1,13 @@
+# -----------------------------------------------------------------------------

+# Create a blur filter
+#
+# Author:: Fernand Galiana
+# -----------------------------------------------------------------------------
+module Ziya::Components
+  # Specifies the blur filter to be applied to some component ie chart_rect, axis_value, etc...
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=filter
+  # for additional documentation, examples and futher detail.
+  class Blur < Base  
+    has_attribute :id, :blurX, :blurY, :quality
+  end
+end

data/lib/ziya/components/chart_border.rb

@@ -1,31 +1,12 @@
 # -----------------------------------------------------------------------------

 # Sets up chart border configuration
 #
-# Sets the chart's border attributes.
-#
-# <tt>top_thickness</tt>:     The thickness of the border's top line. In polar charts, the top_thickness is ignored.
-#                             Valid values are zero and above. Zero makes this line invisible.
-#                             The default is zero.
-# <tt>bottom_thickness</tt>:  The thickness of the border's bottom line. In polar charts, the bottom_thickness is used
-#                             for the chart's outer border Valid values are zero and above. Zero makes this line invisible.
-#                             The default is zero for pie and bar charts, and 2 for all other charts.
-# <tt>left_thickness</tt>:    The thickness of the border's left line. In polar charts, the left_thickness is used for the
-#                             value-axis. Valid values are zero and above. Zero makes this line invisible.
-#                             The default is 2 for bar charts, and 0 for all other charts
-# <tt>right_thickness</tt>:   The thickness of the border's right line. In polar charts, the right_thickness is ignored.
-#                             Valid values are zero and above. Zero makes this line invisible.
-#                             The default is zero.
-# <tt>color</tt>:             The border color. This must be a string holding triple hexadecimal values representing
-#                             the red, green, and blue components for a color.
-#                             The default is "000000" (black).
-#
-# See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=chart_border
-# for additional documentation, examples and futher detail.
-#
-# Author:: Fernand Galiana
-# Date::   Dec 15th, 2006
+# Author:: Fernand
 # -----------------------------------------------------------------------------
 module Ziya::Components
+  # Specifies how to render a chart border
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=chart_border
+  # for additional documentation, examples and futher detail.      
   class ChartBorder < Base  
     has_attribute :top_thickness, :bottom_thickness, :left_thickness,
                   :right_thickness, :color                      

data/lib/ziya/components/chart_grid_h.rb

@@ -1,27 +1,25 @@
 # -----------------------------------------------------------------------------

 # Sets up chart horizontal grid configuration
 #
-# Sets the chart's horizontal grid attributes.
-#
-# <tt>thickness</tt>:   The thickness of the grid's horizontal lines. Valid values are zero and above.
-#                       Zero makes the horizontal lines invisible.
-#                       The default is 1.
-# <tt>color</tt>:       The grid's horizontal color. This must be a string holding triple hexadecimal
-#                       values representing the red, green, and blue components for a color.
-#                       The default is "000000" (black).
-# <tt>alpha</tt>:       The grid's horizontal transparency value. Valid values are 0 (fully transparent)
-#                       to 100 (fully opaque).
-#                       The default is 20.
-# <tt>type</tt>:        The grid's horizontal line type. Valid values are solid, dotted, and dashed.
-#                       The default is solid.
-#
-# See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=chart_grid_h
-# for additional documentation, examples and futher detail.
-#
-# Author:: Fernand Galiana
-# Date::   Dec 15th, 2006
+# Author:: Fernand
 # -----------------------------------------------------------------------------
 module Ziya::Components
+  # Sets the chart's horizontal grid attributes.
+  #
+  # <tt>thickness</tt>:   The thickness of the grid's horizontal lines. Valid values are zero and above.
+  #                       Zero makes the horizontal lines invisible.
+  #                       The default is 1.
+  # <tt>color</tt>:       The grid's horizontal color. This must be a string holding triple hexadecimal
+  #                       values representing the red, green, and blue components for a color.
+  #                       The default is "000000" (black).
+  # <tt>alpha</tt>:       The grid's horizontal transparency value. Valid values are 0 (fully transparent)
+  #                       to 100 (fully opaque).
+  #                       The default is 20.
+  # <tt>type</tt>:        The grid's horizontal line type. Valid values are solid, dotted, and dashed.
+  #                       The default is solid.
+  #
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=chart_grid_h
+  # for additional documentation, examples and futher detail.  
   class ChartGridH < Base  
     has_attribute :thickness, :color, :alpha, :type           
   end

data/lib/ziya/components/chart_grid_v.rb

@@ -1,27 +1,26 @@
 # -----------------------------------------------------------------------------

 # Sets up chart vertical grid configuration
 #
-# Sets the chart's vertical grid attributes.
-#
-# <tt>thickness</tt>:   The thickness of the grid's vertical lines. Valid values are zero and above.
-#                       Zero makes the vertical lines invisible.
-#                       The default is zero.
-# <tt>color</tt>:       The grid's vertical color. This must be a string holding triple hexadecimal values
-#                       representing the red, green, and blue components for a color.
-#                       The default is "000000" (black).
-# <tt>alpha</tt>:       The grid's vertical transparency value. Valid values are 0 (fully transparent)
-#                       to 100 (fully opaque).
-#                       The default is 20.
-# <tt>type</tt>:        The grid's vertical line type. Valid values are solid, dotted, and dashed.
-#                       The default is solid.
-#
-# See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=chart_grid_v
-# for additional documentation, examples and futher detail.
-#
-# Author:: Fernand Galiana
-# Date::   Dec 15th, 2006
+# Author:: Fernand
 # -----------------------------------------------------------------------------
 module Ziya::Components
+  # Sets the chart's vertical grid attributes.
+  #
+  # <tt>thickness</tt>:   The thickness of the grid's vertical lines. Valid values are zero and above.
+  #                       Zero makes the vertical lines invisible.
+  #                       The default is zero.
+  # <tt>color</tt>:       The grid's vertical color. This must be a string holding triple hexadecimal values
+  #                       representing the red, green, and blue components for a color.
+  #                       The default is "000000" (black).
+  # <tt>alpha</tt>:       The grid's vertical transparency value. Valid values are 0 (fully transparent)
+  #                       to 100 (fully opaque).
+  #                       The default is 20.
+  # <tt>type</tt>:        The grid's vertical line type. Valid values are solid, dotted, and dashed.
+  #                       The default is solid.
+  #
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=chart_grid_v
+  # for additional documentation, examples and futher detail.
+  #  
   class ChartGridV < Base  
     has_attribute :thickness, :color, :alpha, :type                 
   end

data/lib/ziya/components/chart_guide.rb

@@ -0,0 +1,16 @@
+# -----------------------------------------------------------------------------

+# Sets up a guide lines configuration for a chart
+#
+# Author:: Fernand Galiana
+# -----------------------------------------------------------------------------
+module Ziya::Components
+  # Specifies how to configure a guide for either axis on a chart
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=chart_guide
+  # for additional documentation, examples and futher detail.        
+  class ChartGuide < Base  
+    has_attribute :horizontal, :vertical, :thickness, :color, :alpha, :type,
+      :snap_h, :snap_v, :radius, :fill_color, :line_color, :line_alpha, :line_thickness,
+      :text_h_alpha, :text_v_alpha, :prefix_h, :prefix_v, :suffix_h, :suffix_v,
+      :decimals, :decimal_char, :separator, :font, :bold, :size, :text_color, :background_color
+  end
+end

data/lib/ziya/components/chart_label.rb

@@ -0,0 +1,16 @@
+# -----------------------------------------------------------------------------

+# Sets up chart labels configuration. These are the labels on top on the chart.
+#
+# Author:: Fernand Galiana
+# -----------------------------------------------------------------------------
+module Ziya::Components
+  # Specifies the label for the chart element actual value. This can be setup to 
+  # be fixed or as a tooltip
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=chart_label
+  # for additional documentation, examples and futher detail.          
+  class ChartLabel < Base  
+    has_attribute :prefix, :suffix, :decimals, :decimal_char, :separator, :position,
+                  :hide_zero, :as_percentage, :font, :bold, :size, :color,
+                  :background_color, :alpha, :shadow, :bevel, :glow, :blur        
+  end
+end

data/lib/ziya/components/chart_pref.rb

@@ -1,22 +1,22 @@
 # -----------------------------------------------------------------------------

 # Sets up various preferences available on a given chart type
 #
-# Sets the preferences for some chart types. Each chart type has different preferences,
-# or no preferences at all.
-#
-# <tt></tt>:
-#
-# See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=chart_pref
-# for additional documentation, examples and futher detail.
-#
 # Author:: Fernand Galiana
-# Date::   Dec 15th, 2006
 # -----------------------------------------------------------------------------
 module Ziya::Components
+  # Sets the preferences for some chart types. Each chart type has different preferences,
+  # or no preferences at all.
+  #
+  # <tt></tt>:
+  #
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=chart_pref
+  # for additional documentation, examples and futher detail.
+  #  
   class ChartPref < Base  
-    has_attribute :point_shape, :fill_shape, :reverse, :type, :line_thickness,
-                  :bull_color, :bear_color, :point_size, :point_shape,
+    has_attribute :line_thickness, :point_shape, :point_size, :fill_shape,
+                  :type, :bull_color, :bear_color,
+                  :reverse, :drag, :min_x, :min_y, :max_x, :max_y,
                   :trend_thickness, :trend_alpha, :line_alpha, :rotation_x,
-                  :rotation_y, :grid             
+                  :rotation_y, :grid, :select
   end
 end

data/lib/ziya/components/chart_rect.rb

@@ -1,36 +1,37 @@
 # -----------------------------------------------------------------------------

 # Sets up the content area the chart occupies
 #
-# Sets the chart's rectangle
-#
-# <tt>x</tt>:               The horizontal position of the rectangle's upper left corner relative to the upper
-#                           left corner of the canvas (0, 0).
-# <tt>y</tt>:               The vertical position of the rectangle's upper left corner relative to the upper
-#                           left corner of the canvas (0, 0).
-# <tt>width</tt>:           The rectangle's width.
-# <tt>height</tt>:          The rectangle's height.
-# <tt>positive_color</tt>:  The chart's background color above the zero line. This must be a string holding triple
-#                           hexadecimal values representing the red, green, and blue components for a color.
-#                           The default is "FFFFFF" (white).
-# <tt>negative_color</tt>:  The chart's background color below the zero line. This must be a string holding triple
-#                           hexadecimal values representing the red, green, and blue components for a color.
-#                           The default is "000000" (black).
-# <tt>positive_alpha</tt>:  The transparency value of the background color above the zero line. Valid values are 0
-#                           (fully transparent) to 100 (fully opaque).
-#                           The default is 75.
-# <tt>negative_alpha</tt>:  The transparency value of the background color below the zero line. Valid values are 0
-#                           (fully transparent) to 100 (fully opaque).
-#                           The default is 20.
-#
-# See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=chart_rect
-# for additional documentation, examples and futher detail.
-#
 # Author:: Fernand Galiana
-# Date::   Dec 15th, 2006
 # -----------------------------------------------------------------------------
 module Ziya::Components
+  # Sets the chart's rectangle
+  #
+  # <tt>x</tt>:               The horizontal position of the rectangle's upper left corner relative to the upper
+  #                           left corner of the canvas (0, 0).
+  # <tt>y</tt>:               The vertical position of the rectangle's upper left corner relative to the upper
+  #                           left corner of the canvas (0, 0).
+  # <tt>width</tt>:           The rectangle's width.
+  # <tt>height</tt>:          The rectangle's height.
+  # <tt>positive_color</tt>:  The chart's background color above the zero line. This must be a string holding triple
+  #                           hexadecimal values representing the red, green, and blue components for a color.
+  #                           The default is "FFFFFF" (white).
+  # <tt>negative_color</tt>:  The chart's background color below the zero line. This must be a string holding triple
+  #                           hexadecimal values representing the red, green, and blue components for a color.
+  #                           The default is "000000" (black).
+  # <tt>positive_alpha</tt>:  The transparency value of the background color above the zero line. Valid values are 0
+  #                           (fully transparent) to 100 (fully opaque).
+  #                           The default is 75.
+  # <tt>negative_alpha</tt>:  The transparency value of the background color below the zero line. Valid values are 0
+  #                           (fully transparent) to 100 (fully opaque).
+  #                           The default is 20.
+  #
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=chart_rect
+  # for additional documentation, examples and futher detail.
+  #  
   class ChartRect < Base
     has_attribute :x, :y, :width, :height, :positive_color, :negative_color,
-                  :positive_alpha, :negative_alpha             
+                  :positive_alpha, :negative_alpha, 
+                  :shadow, :bevel, :blur, :glow,
+                  :corner_tl, :corner_tr, :corner_bl, :corner_br
   end
 end