ziya 1.0.0

data/lib/ziya/charts/candle_stick.rb

@@ -0,0 +1,11 @@
+# -----------------------------------------------------------------------------
+# Generates necessary xml for candlestick chart 
+# -----------------------------------------------------------------------------
+module Ziya::Charts
+  class CandleStick < Base
+    def initialize( license=nil, chart_id=nil)
+      super( license, chart_id )
+      @type = "candlestick"      
+    end
+  end
+end

data/lib/ziya/charts/column.rb

@@ -0,0 +1,11 @@
+# -----------------------------------------------------------------------------
+# Generates necessary xml for a StackColumn chart
+# -----------------------------------------------------------------------------
+module Ziya::Charts
+  class Column < Base
+    def initialize( license=nil, chart_id=nil)
+      super( license, chart_id )
+      @type = "column"      
+    end
+  end
+end

data/lib/ziya/charts/column_threed.rb

@@ -0,0 +1,11 @@
+# -----------------------------------------------------------------------------
+# Generates necessary xml for 3D column chart
+# -----------------------------------------------------------------------------
+module Ziya::Charts
+  class ColumnThreed < Base
+    def initialize( license=nil, chart_id=nil)
+      super( license, chart_id )
+      @type = "3d column"      
+    end
+  end
+end

data/lib/ziya/charts/floating_bar.rb

@@ -0,0 +1,11 @@
+# -----------------------------------------------------------------------------
+# Generates necessary xml for floating bar chart
+# -----------------------------------------------------------------------------
+module Ziya::Charts
+  class FloatingBar < Base
+    def initialize( license=nil, chart_id=nil)
+      super( license, chart_id )
+      @type = "floating bar"      
+    end
+  end
+end

data/lib/ziya/charts/floating_column.rb

@@ -0,0 +1,11 @@
+# -----------------------------------------------------------------------------
+# Generates necessary xml for a floating column chart
+# -----------------------------------------------------------------------------
+module Ziya::Charts
+  class FloatingColumn < Base
+    def initialize( license=nil, chart_id=nil)
+      super( license, chart_id )
+      @type = "floating column"      
+    end
+  end
+end

data/lib/ziya/charts/line.rb

@@ -0,0 +1,11 @@
+# -----------------------------------------------------------------------------
+# Generates necessary xml for a StackColumn chart
+# -----------------------------------------------------------------------------
+module Ziya::Charts
+  class Line < Base
+    def initialize( license=nil, chart_id=nil)
+      super( license, chart_id )
+      @type = "line"      
+    end
+  end
+end

data/lib/ziya/charts/mixed.rb

@@ -0,0 +1,11 @@
+# -----------------------------------------------------------------------------
+# Generates necessary xml for mixed chart 
+# -----------------------------------------------------------------------------
+module Ziya::Charts
+  class Mixed < Base
+    def initialize( license=nil, chart_id=nil )
+      super( license, chart_id )
+      @type = nil      
+    end
+  end
+end

data/lib/ziya/charts/parallel_threed_column.rb

@@ -0,0 +1,11 @@
+# -----------------------------------------------------------------------------
+# Generates necessary xml for parallel 3D column chart
+# -----------------------------------------------------------------------------
+module Ziya::Charts
+  class ParallelThreedColumn < Base
+    def initialize( license=nil, chart_id=nil)
+      super( license, chart_id )
+      @type = "parallel 3d column"      
+    end
+  end
+end

data/lib/ziya/charts/pie.rb

@@ -0,0 +1,11 @@
+# -----------------------------------------------------------------------------
+# 
+# -----------------------------------------------------------------------------
+module Ziya::Charts
+  class Pie < Base
+    def initialize( license=nil, chart_id=nil)
+      super( license, chart_id )
+      @type = "pie"      
+    end
+  end
+end

data/lib/ziya/charts/pie_threed.rb

@@ -0,0 +1,11 @@
+# -----------------------------------------------------------------------------
+# Generates necessary xml for 3D pie chart 
+# -----------------------------------------------------------------------------
+module Ziya::Charts
+  class PieThreed < Base
+    def initialize( license=nil, chart_id=nil)
+      super( license, chart_id )
+      @type = "3d pie"      
+    end
+  end
+end

data/lib/ziya/charts/polar.rb

@@ -0,0 +1,11 @@
+# -----------------------------------------------------------------------------
+# 
+# -----------------------------------------------------------------------------
+module Ziya::Charts
+  class Polar < Base
+    def initialize( license=nil, chart_id=nil)
+      super( license, chart_id )
+      @type = "polar"      
+    end
+  end
+end

data/lib/ziya/charts/scatter.rb

@@ -0,0 +1,11 @@
+# -----------------------------------------------------------------------------
+# Generates necessary xml for scatter chart 
+# -----------------------------------------------------------------------------
+module Ziya::Charts
+  class Scatter < Base
+    def initialize( license=nil, chart_id=nil)
+      super( license, chart_id )
+      @type = "scatter"      
+    end
+  end
+end         

data/lib/ziya/charts/stacked_area.rb

@@ -0,0 +1,11 @@
+# -----------------------------------------------------------------------------
+# Generates necessary xml for stacked area chart 
+# -----------------------------------------------------------------------------
+module Ziya::Charts
+  class StackedArea < Base
+    def initialize( license=nil, chart_id=nil)
+      super( license, chart_id )
+      @type = "stacked area"      
+    end
+  end
+end

data/lib/ziya/charts/stacked_bar.rb

@@ -0,0 +1,11 @@
+# -----------------------------------------------------------------------------
+# Generates necessary xml for a stacked bar chart
+# -----------------------------------------------------------------------------
+module Ziya::Charts
+  class StackedBar < Base
+    def initialize( license=nil, chart_id=nil)
+      super( license, chart_id )
+      @type = "stacked bar"      
+    end
+  end
+end

data/lib/ziya/charts/stacked_column.rb

@@ -0,0 +1,11 @@
+# -----------------------------------------------------------------------------
+# Generates necessary xml for a stack column chart
+# -----------------------------------------------------------------------------
+module Ziya::Charts
+  class StackedColumn < Base
+    def initialize( license=nil, chart_id=nil)
+      super( license, chart_id )
+      @type = "stacked column"      
+    end
+  end
+end

data/lib/ziya/charts/stacked_threed_column.rb

@@ -0,0 +1,11 @@
+# -----------------------------------------------------------------------------
+# Generates necessary xml for a stacked 3d column chart
+# -----------------------------------------------------------------------------
+module Ziya::Charts
+  class StackedThreedColumn < Base
+    def initialize( license=nil, chart_id=nil)
+      super( license, chart_id )
+      @type = "stacked 3d column"      
+    end
+  end
+end

data/lib/ziya/components/area.rb

@@ -0,0 +1,14 @@
+# -----------------------------------------------------------------------------
+# Defines an area on a chart. Typically used to embed links and buttons
+#
+# Author:: Fernand Galiana
+# Date::   Dec 15th, 2006
+# -----------------------------------------------------------------------------
+require 'ziya/components/base'
+
+module Ziya::Components
+  class Area < Base  
+    has_attribute :x, :y, :width, :height, :url, :priority, :target, :text,
+                  :font, :bold, :size, :color, :background_color, :alpha            
+  end
+end

data/lib/ziya/components/axis_category.rb

@@ -0,0 +1,69 @@
+# -----------------------------------------------------------------------------
+# Sets the label attributes for the category-axis.
+#
+# <tt>skip</tt>:          If this axis holds too many labels, the skip key allows skipping (hiding) some labels.
+#                         A zero value doesn't hide any labels. If the skip value is 1, then the first label is
+#                         displayed, the following label is skipped, and so on. If the skip value is 2, then the
+#                         first label is displayed, the following 2 are skipped, and so on. Another way to hide
+#                         labels is by passing empty strings to chart_data in place of category labels.
+#                         The default is zero.
+# <tt>font</tt>:          The font used in the category-axis. See the Fonts section below.
+#                         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>alpha</tt>:         This affects the labels' transparency, only when the embedded font is used (see the Fonts
+#                         section below.) 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 (see the Fonts
+#                         section below.) Valid values are horizontal, diagonal_up, diagonal_down, vertical_up, and
+#                         vertical_down. Polar charts also accept the value circular.
+#                         The default value is horizontal.
+# <tt>margin</tt>:        This applies to area, stacked area, and line charts only. It's a boolean value that
+#                         indicates whether to leave a margin on the left and right of the graph, or bump it against
+#                         the left and right chart borders.
+#                         The default is false (no margin.) In mixed charts, there's always a margin to algin area
+#                         and line charts with column charts.
+# <tt>min</tt>:           This applies to scatter charts only, when the category-axis is calculated like the value-axis.
+#                         This determines the minimum value to start this axis with.
+#                         The default is calculated from the chart's data.
+# <tt>max</tt>:           This applies to scatter charts only, when the category-axis is calculated like the value-axis.
+#                         This determines the maximum value to end this axis with.
+#                         The default is calculated from the chart's data.
+# <tt>steps</tt>:         This applies to scatter charts only, when the category-axis is calculated like the value-axis.
+#                         This determines 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>:        This applies to scatter charts only, when the category-axis is calculated like the value-axis.
+#                         This determines the characters to add before the value numbers (example: $10).
+#                         The default is nothing.
+# <tt>suffix</tt>:        This applies to scatter charts only, when the category-axis is calculated like the value-axis.
+#                         This determines the characters to add after the value numbers (example: 10%).
+#                         The default is nothing.
+# <tt>decimals</tt>:      This applies to scatter charts only, when the category-axis is calculated like the value-axis.
+#                         This determines 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>:  This applies to scatter charts only, when the category-axis is calculated like the value-axis.
+#                         This determines the character to use at the left of a decimal fraction (example: 1.5).
+#                         The default is '.' (dot or full stop).
+# <tt>separator</tt>:     This applies to scatter charts only, when the category-axis is calculated like the value-axis.
+#                         This determines the character to place between every group of thousands (example: 1,00,000).
+#                         The default is nothing.
+#
+# See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=axis_category
+# for additional documentation, examples and futher detail.
+# Author:: Fernand Galiana
+# Date::   Dec 15th, 2006
+# -----------------------------------------------------------------------------
+module Ziya::Components
+  class AxisCategory < Base    
+    has_attribute :skip, :font, :bold, :size, :color, :alpha, :orientation,
+                  :margin, :min, :max, :steps, :prefix, :suffix, :decimals,
+                  :decimal_char, :separator
+  end
+end

data/lib/ziya/components/axis_ticks.rb

@@ -0,0 +1,37 @@
+# ------------------------------------------------------------------------------

+# Describe the ticks configuration of the chart axis
+#
+# Sets the tick marks on the chart axes.
+#
+# <tt>value_ticks</tt>:       A boolean value that indicates whether the ticks on the value axis are visible or not.
+#                             The default is false.
+# <tt>category_ticks</tt>:    A boolean value that indicates whether the ticks on the category axis are visible or not.
+#                             The default is true.
+# <tt>position</tt>:          A string that determines where on the axis to display the ticks. Valid values are "outside",
+#                             "inside", and "centered".
+#                             The default is "outside".
+# <tt>major_thickness</tt>:   The thickness of major ticks. Major ticks are those appearing with the axis labels.
+#                             The default is 2 pixels.
+# <tt>major_color</tt>:       The color of major ticks. 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>minor_thickness</tt>:   The thickness of minor ticks. Minor ticks are those appearing between major ticks.
+#                             The default is 1 pixel.
+# <tt>minor_color</tt>:       The color of minor ticks. 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>minor_count</tt>:       This applies to the value axis only. It sets the number of minor ticks between every 2 major ticks.
+#                             The default is 4. The category axis displays minor ticks only where its labels get skipped.
+#
+# See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=axis_ticks
+# for additional documentation, examples and futher detail.
+#
+# Author:: Fernand Galiana
+# Date::   Dec 15th, 2006
+# ------------------------------------------------------------------------------
+module Ziya::Components
+  class AxisTicks < Base  
+    has_attribute :value_ticks, :category_ticks, :position, :major_thickness,
+                  :major_color, :minor_thickness, :minor_color, :minor_count                 
+  end
+end

data/lib/ziya/components/axis_value.rb

@@ -0,0 +1,59 @@
+# -----------------------------------------------------------------------------

+# 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
+  class AxisValue < Base  
+    has_attribute :min, :max, :steps, :prefix, :suffix, :decimals,
+                  :decimal_char, :separator, :show_min, :font, :bold,
+                  :size, :color, :background_color, :alpha, :orientation                
+  end
+end

data/lib/ziya/components/base.rb

@@ -0,0 +1,100 @@
+# -----------------------------------------------------------------------------

+# Abstract class representing the base class for all chart preferences
+# TODO Not getting parents inherited properties if defined as defaults
+#
+# TODO: Change attributes to be per class instance
+#
+# Author:: Fernand Galiana
+# Date::   Dec 15th, 2006
+# -----------------------------------------------------------------------------
+module Ziya::Components
+  class Base    
+    include Ziya::Utils::Text
+        
+    # class methods...
+    class << self     
+      # -----------------------------------------------------------------------
+      # defines attribute accessors for a given component
+      def has_attribute(*args)
+        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
+          attributes[class_name] = [] if attributes[class_name].nil?
+          attributes[class_name] << attribute
+          # create the accessor methods for the attribute
+          unless self.instance_methods.include?(attribute.to_s) && self.instance_methods.include?("#{attribute.to_s}=")
+            self.module_eval "attr_accessor :#{attribute}"
+          end
+        end
+      end
+    
+      # -----------------------------------------------------------------------
+      # Class accessor. Retrieve class level preferences
+      def attributes
+        @attributes ||= {}
+      end
+    end
+  
+    # -------------------------------------------------------------------------
+    # merge attributes with overriden component
+    def merge( parent_attributes, force=false )
+      attributes_for(self).each do |attr|
+        unless parent_attributes.send(attr).nil?
+          send("#{attr}=", parent_attributes.send(attr)) 
+        end
+      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)
+      end
+    end
+  
+    # -------------------------------------------------------------------------
+    # checks if a give component properties have been set. 
+    # return true if one or more props have been set. False otherwise...
+    def configured?
+      !options.empty?
+    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
+      end
+      options
+    end
+    
+    # -------------------------------------------------------------------------
+    # Turns options hash into string representation
+    def options_as_string
+      buff = []
+      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
+      end      
+      buff.join( "," )
+    end
+    
+    # -------------------------------------------------------------------------
+    # fetch attributes for a give component
+    def attributes_for( an_instance )
+      attrs = self.class.attributes[an_instance.class.name] 
+      raise "Unable to get attributes for #{an_instance}" unless attrs
+      attrs
+    end
+  end
+end