ziya 1.0.0 → 2.0.0

data/lib/ziya/components/chart_transition.rb

@@ -1,25 +1,24 @@
 # -----------------------------------------------------------------------------

 # Sets up a transition when the chart first renders
 #
-# Sets the transition attributes for the chart elements.
-#
-# <tt>type</tt>:      The type of the transition. Valid values are dissolve, drop, spin, scale, zoom,
-#                     blink, slide_right, slide_left, slide_up, slide_down, and none.
-#                     The default is none, which draws the chart immediately without a transition.
-# <tt>delay</tt>:     The delay in seconds before starting the transition.
-#                     The default is zero.
-# <tt>duration</tt>:  The transition's duration in seconds.
-#                     The default is 1.
-# <tt>order</tt>:     The order in which to transition the chart's parts. Valid values are series,
-#                     category, and all.
-#                     The default is all.
-#
-# See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=chart_trasition
-# for additional documentation, examples and futher detail.
 # Author:: Fernand Galiana
-# Date::   Dec 15th, 2006
 # -----------------------------------------------------------------------------
 module Ziya::Components
+  # Sets the transition attributes for the chart elements.
+  #
+  # <tt>type</tt>:      The type of the transition. Valid values are dissolve, drop, spin, scale, zoom,
+  #                     blink, slide_right, slide_left, slide_up, slide_down, and none.
+  #                     The default is none, which draws the chart immediately without a transition.
+  # <tt>delay</tt>:     The delay in seconds before starting the transition.
+  #                     The default is zero.
+  # <tt>duration</tt>:  The transition's duration in seconds.
+  #                     The default is 1.
+  # <tt>order</tt>:     The order in which to transition the chart's parts. Valid values are series,
+  #                     category, and all.
+  #                     The default is all.
+  #
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=chart_transition
+  # for additional documentation, examples and futher detail.  
   class ChartTransition < Base      
     has_attribute :type, :delay, :duration, :order                  
   end

data/lib/ziya/components/circle.rb

@@ -2,12 +2,15 @@
 # Draws a circle
 #
 # Author:: Fernand Galiana
-# Date::   Dec 15th, 2006
 # -----------------------------------------------------------------------------
 module Ziya::Components
+  # Circle component to draw a circle on the chart. Must be set up within the draw
+  # component.
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=draw
+  # for additional documentation, examples and futher detail.          
   class Circle < Base  
     has_attribute :layer, :transition, :delay, :duration, :x, :y, :radius,
                   :fill_color, :fill_alpha, :line_color, :line_alpha,
-                  :line_thickness              
+                  :line_thickness, :shadow, :bevel, :glow, :blur
   end
 end

data/lib/ziya/components/draw.rb

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

 # Sets up a drawing area on the chart to draw text, rect, circles...
 #
-# Holds any number of elements to draw. A draw element can be a circle, image (JPEG or SWF),
-# line, rectangle, or text. Use draw "image" to include SWF flash file with animation,
-# roll-over buttons, sounds, scripts, etc.
-#
-# <tt></tt>:
-#
-# See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=draw
-# for additional documentation, examples and futher detail.
-#
 # Author:: Fernand Galiana
-# Date::   Dec 15th, 2006
 # -----------------------------------------------------------------------------
 require 'ziya/ziya_helper'
 
 module Ziya::Components
+  # Sets up a drawing area on the chart to draw text, rect, circles...
+  #
+  # Holds any number of elements to draw. A draw element can be a circle, image (JPEG or SWF),
+  # line, rectangle, or text. Use draw "image" to include SWF flash file with animation,
+  # roll-over buttons, sounds, scripts, etc.
+  #
+  # <tt></tt>:
+  #
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=draw
+  # for additional documentation, examples and futher detail.
+  #  
   class Draw < Base  
     include Ziya::Helper
     
@@ -38,7 +39,7 @@ module Ziya::Components
     def gen_composites( xml, composite_urls )
       chart_path = "/charts"
       for url in composite_urls do
-        xml.image( :url => xml_swf % [ chart_path, chart_path, url] )
+        xml.image( :url => composite_url % [ chart_path, chart_path, url] )
       end
     end
   end

data/lib/ziya/components/draw_base.rb

@@ -0,0 +1,10 @@
+# -----------------------------------------------------------------------------

+# Draw base class for all draw components
+#
+# Author:: Fernand Galiana
+# -----------------------------------------------------------------------------
+module Ziya::Components
+  class DrawBase < Base  # :nodoc:
+    has_attribute :shadow, :bevel, :glow, :blur
+  end
+end

data/lib/ziya/components/filter.rb

@@ -0,0 +1,26 @@
+# -----------------------------------------------------------------------------

+# Sets various filters for enhancing charts look and feel
+#
+# Holds any number of filters. such as bevel, shadow etc. You must specify
+# and id so that other drawable component can use the filters
+#
+# Author:: Fernand
+# -----------------------------------------------------------------------------
+module Ziya::Components
+  # Specifies the various filters that can be reused across components ie blur, bevel, glow, etc...
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=filter
+  # for additional documentation, examples and futher detail.      
+  class Filter < Base      
+    has_attribute :filters
+                         
+    # -------------------------------------------------------------------------
+    # Dump has_attribute into xml element
+    def flatten( xml )
+      if filters
+        xml.filter do 
+          filters.each { |comp| comp.flatten( xml ) }
+        end
+      end
+    end
+  end
+end

data/lib/ziya/components/glow.rb

@@ -0,0 +1,14 @@
+# -----------------------------------------------------------------------------

+# Create a glow filter
+#
+# Author:: Fernand Galiana
+# -----------------------------------------------------------------------------
+module Ziya::Components
+  # Specifies the glow 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 Glow < Base  
+    has_attribute :id, :color, :alpha, :blurX, :blurY, :strength, :quality, 
+                  :inner, :knockout
+  end
+end

data/lib/ziya/components/image.rb

@@ -6,8 +6,12 @@
 # Date::   Dec 15th, 2006
 # -----------------------------------------------------------------------------
 module Ziya::Components
+  # Renders the specified image (jpg/gif) on the chart. Must be set up within the draw
+  # component.
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=draw
+  # for additional documentation, examples and futher detail.          
   class Image < Base  
     has_attribute :layer, :transition, :delay, :duration, :url, :x, :y, :width,
-                  :height, :rotation, :alpha
+                  :height, :rotation, :alpha, :bevel, :glow, :blur, :timeout, :retry
   end
 end

data/lib/ziya/components/legend.rb

@@ -0,0 +1,18 @@
+# -----------------------------------------------------------------------------

+# Sets up chart legend location
+#
+# Author:: Fernand Galiana
+# -----------------------------------------------------------------------------
+module Ziya::Components
+  # Renders a legend on the chart
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=legend
+  # for additional documentation, examples and futher detail.          
+  
+  class Legend < Base  
+    has_attribute :transition, :delay, :duration,
+      :x, :y, :width, :height, 
+      :toggle, :layout, :margin, :bullet, :font, :bold, :size, :color, :alpha,
+      :fill_color, :fill_alpha, :line_color, :line_alpha, :line_thickness,
+      :shadow, :bevel, :glow, :blur
+  end
+end

data/lib/ziya/components/line.rb

@@ -2,11 +2,15 @@
 # Draw a line on a chart
 #
 # Author:: Fernand Galiana
-# Date::   Dec 15th, 2006
 # -----------------------------------------------------------------------------
 module Ziya::Components
+  # Line component to draw a line on the chart. Must be set up within the draw
+  # component.
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=draw
+  # for additional documentation, examples and futher detail.            
   class Line < Base  
     has_attribute :layer, :transition, :delay, :duration, :x1, :y1, :x2, :y2,
-                  :line_color,:line_alpha, :line_thickness
+                  :line_color,:line_alpha, :line_thickness, 
+                  :bevel, :glow, :blur, :shadow
   end
 end

data/lib/ziya/components/link.rb

@@ -1,18 +1,18 @@
 # -----------------------------------------------------------------------------

 # Sets up clickable areas on the chart.
 #
-# Holds any number of areas, each defining a rectangle and a URL to go to when the user
-# clicks inside the rectangle. This can also be used to make refresh or print buttons.
-#
-# <tt></tt>:
-#
-# See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=link
-# for additional documentation, examples and futher detail.
-#
 # Author:: Fernand Galiana
-# Date::   Dec 15th, 2006
 # -----------------------------------------------------------------------------
 module Ziya::Components
+  # Sets up clickable areas on the chart.
+  #
+  # Holds any number of areas, each defining a rectangle and a URL to go to when the user
+  # clicks inside the rectangle. This can also be used to make refresh or print buttons.
+  #
+  # <tt></tt>:
+  #
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=link
+  # for additional documentation, examples and futher detail.  
   class Link < Base  
     has_attribute :areas
                      

data/lib/ziya/components/link_data.rb

@@ -1,19 +1,18 @@
 # -----------------------------------------------------------------------------

 # Sets up a handler for clickable chart elements
 #
-# Sets the URL of a script responsible for processing clicks on chart elements.
-# This enables drilling down into charts.
-#
-# <tt></tt>:
-#
-# See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=link_data
-# for additional documentation, examples and futher detail.
-#
 # Author:: Fernand Galiana
-# Date::   Dec 15th, 2006
 # -----------------------------------------------------------------------------
 module Ziya::Components
+  # Sets the URL of a script responsible for processing clicks on chart elements.
+  # This enables drilling down into charts.
+  #
+  # <tt></tt>:
+  #
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=link_data
+  # for additional documentation, examples and futher detail.
+  #  
   class LinkData < Base  
-    has_attribute :url, :target
+    has_attribute :url, :target, :timeout, :retry, :spinning_wheel
   end
 end

data/lib/ziya/components/rect.rb

@@ -2,12 +2,17 @@
 # Draw a rectangle on a chart
 #
 # Author:: Fernand Galiana
-# Date::   Dec 15th, 2006
 # -----------------------------------------------------------------------------
 module Ziya::Components
+  # Rect component to draw a rectangle on the chart. Must be set up within the draw
+  # component.
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=draw
+  # for additional documentation, examples and futher detail.            
   class Rect < Base  
     has_attribute :layer, :transition, :delay, :duration, :x, :y, :width,
                   :height, :fill_color, :fill_alpha, :line_color, :line_alpha,
-                  :line_thickness
+                  :line_thickness,
+                  :corner_tl, :corner_tr, :corner_bl, :corner_br,
+                  :shadow, :bevel, :blur, :bevel
   end
 end

data/lib/ziya/components/scroll.rb

@@ -0,0 +1,26 @@
+# -----------------------------------------------------------------------------
+# Embeds a scroller in a given chart
+#
+# Author:: Fernand Galiana
+# Date::   Dec 15th, 2006
+# -----------------------------------------------------------------------------
+require 'ziya/components/base'
+
+module Ziya::Components
+  # Specifies the ability to scroll a chart by setting single or double sliders
+  # on the chart.
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=scroll
+  # for additional documentation, examples and futher detail.
+  #  
+  class Scroll < Base  
+    has_attribute :x, :y, :width, :height, :alpha,
+                  :transition, :delay, :duration,
+                  :url_button_1_idle, :url_button_1_over, :url_button_1_press,
+                  :url_button_2_idle, :url_button_2_over, :url_button_2_press,
+                  :url_slider_body, :url_slider_handle_1, :url_slider_handle_2,
+                  :button_length, :slider_handle_length, :gap, :button_speed, 
+                  :buttons_together, :start, :span, :drag, :reverse_handle,
+                  :scroll_detail, :stop_detail,
+                  :timeout, :retry         
+  end
+end

data/lib/ziya/components/shadow.rb

@@ -0,0 +1,14 @@
+# -----------------------------------------------------------------------------

+# Create a shadow filter
+#
+# Author:: Fernand Galiana
+# -----------------------------------------------------------------------------
+module Ziya::Components
+  # Specifies the shadow 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 Shadow < Base  
+    has_attribute :id, :distance, :angle, :color, :alpha, 
+                  :blurX, :blurY, :strength, :quality, :inner, :knockout, :hideObject
+  end
+end

data/lib/ziya/components/text.rb

@@ -5,9 +5,13 @@
 # Date::   Dec 15th, 2006
 # -----------------------------------------------------------------------------
 module Ziya::Components
+  # Text component to draw text on the chart. Must be set up within the draw
+  # component.
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=draw
+  # for additional documentation, examples and futher detail.            
   class Text < Base  
     has_attribute :layer, :transition, :delay, :duration, :x, :y, :width,
                   :height, :h_align, :v_align, :rotation, :font, :bold, :size,
-                  :color, :alpha, :text              
+                  :color, :alpha, :shadow, :bevel, :glow, :blur, :text
   end
 end

data/lib/ziya/components/update.rb

@@ -0,0 +1,19 @@
+# -----------------------------------------------------------------------------

+# Sets up handler for refresh the chart content. The refresh xml can only refresh
+# parts of the chart that have changed.
+#
+# Author:: Fernand Galiana
+# -----------------------------------------------------------------------------
+module Ziya::Components
+  # Updates the chart at intervals, without reloading the web page. This makes it possible
+  # to display charts with live data, change the chart's look over time for emphasis, or
+  # create a slideshow from different charts.
+  #
+  # <tt></tt>:
+  #
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=live_update
+  # for additional documentation, examples and futher detail.  
+  class Update < Base  
+    has_attribute :url, :delay, :timeout, :retry, :mode, :span
+  end
+end

data/lib/ziya/gauges/base.rb

@@ -0,0 +1,172 @@
+module Ziya::Gauges
+  class Base
+    include Ziya::Helpers::BaseHelper
+
+    attr_accessor :license, :design_id
+    attr_reader   :type, :components
+    attr_reader   :options
+    
+    def initialize( license, design_id )
+      @license   = license
+      @design_id = design_id
+      
+      # load up associated helper
+      loaded = load_helper( Ziya.helpers_dir ) if Ziya.helpers_dir
+      Ziya.logger.warn( ">>> ZiYa -- no helper for gauge `#{design_id}" ) unless loaded
+
+      # init defaults
+      @options = default_options      
+    end
+          
+    # -------------------------------------------------------------------------
+    # provides for overiding basic functionality
+    #
+    # <tt>gauge_color</tt>::   Legend color
+    # <tt>legend_color</tt>::  Gauge color
+    def set_preferences( opts={} )
+      options.merge!( opts )
+    end
+
+    # -------------------------------------------------------------------------    
+    # render gauge to xml
+    def to_xml
+      render_xml
+    end    
+   
+    # =========================================================================
+    protected
+
+      # inject update behavior
+      def render_extra_components
+        if options[:url]
+          Ziya::Gauges::Support::Update.new(
+            :url        => options[:url],
+            :retry      => options[:retry] || 0,
+            :timeout    => options[:timeout] || 30,
+            :delay_type => options[:delay_type] || 1,
+            :delay      => options[:delay] || 30 ).flatten( @xml )
+        end
+      end
+
+      # -------------------------------------------------------------------------
+      # setup thermometer default options
+      def default_options
+        { 
+          :x            => 20,
+          :y            => 20,
+          :gauge_color  => "ff0000",
+          :legend_color => "cc0000",
+        }
+      end
+               
+    # =========================================================================     
+    private
+
+      # retrieve bundled design directory
+      def bundled_designs_dir
+        Ziya.path( %w[gauges designs] )
+      end
+      
+      # -----------------------------------------------------------------------
+      # Load up ERB style helpers
+      def load_helper( helper_dir )
+        Dir.foreach(helper_dir) do |helper_file|
+          unless helper_file =~ /^(#{design_id}_helper).rb$/ or helper_file =~ /^(base_helper).rb$/
+            next
+          end
+          Ziya.logger.info( ">>> ZiYa loading custom helper `#{$1}" )
+          # BOZO !! This will only work in rails ??
+          if defined? RAILS_ROOT
+            require_dependency File.join(helper_dir, $1) 
+          else
+            require File.join(helper_dir, $1)
+          end
+          helper_module_name = "Ziya::" + $1.gsub(/(^|_)(.)/) { $2.upcase }        
+          # helper_module_name = $1.to_s.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
+          Ziya.logger.debug( "Include module #{helper_module_name}")
+          Ziya::Gauges::Base.class_eval("include #{helper_module_name}") 
+          true
+        end
+        false
+      end        
+
+      # -----------------------------------------------------------------------
+      # merge components with user overrides
+      def merge_comps( original, override )
+        override.each do |k,v|
+          if original.has_key? k
+            original[k] = v
+          else
+            original << [k,v]
+          end
+        end
+      end
+      
+      # -----------------------------------------------------------------------
+      # renders design components
+      def render_components
+        # First check bundled design dir for std design
+        std_design = inflate( self, bundled_designs_dir, design_id )
+        # Now check for user overrides
+        usr_design = inflate( self, Ziya.designs_dir, design_id )
+                
+        design = usr_design
+        if std_design and usr_design
+          design = std_design
+          merge_comps( design.components, usr_design.components )
+          # design.components.merge!( usr_design.components )
+        elsif std_design
+          design = std_design
+        end        
+# Ziya.logger.debug "!!!! Design\n#{design.to_yaml}"
+        # flatten components to xml
+        design.components.each do |name, value|
+# Ziya.logger.debug "Processing #{name}"          
+          value.flatten( @xml )
+        end            
+      end
+      
+      # -----------------------------------------------------------------------
+      # renders chart to xml
+      def render_xml
+        @xml = Builder::XmlMarkup.new
+        @xml.gauge do
+          @xml.license( @license ) unless @license.nil?
+          render_extra_components          
+          render_components
+        end
+        @xml.to_s.gsub( /<to_s\/>/, '' )        
+      end
+
+      # -----------------------------------------------------------------------
+      # Parse erb template if any
+      def erb_render( yml )
+        # b = binding
+        ERB.new( yml ).result binding   
+      end
+            
+      # -----------------------------------------------------------------------
+      # Load yaml file associated with class if any
+      def inflate( clazz, designs_dir, design )
+        class_name  = underscore( demodulize( clazz.to_s ) )
+        begin
+          file_name = "#{designs_dir}/#{design}.yml"
+          Ziya.logger.debug ">>> ZiYa attempt to load design file '#{file_name}"    
+          return nil unless File.exists?( file_name )          
+          yml = IO.read( file_name )
+# Ziya.logger.debug ">>> Unprocessed yaml...\n#{yml}\n"        
+          processed = erb_render( yml )
+# Ziya.logger.debug ">>> Processed yaml...\n#{processed}"
+          load = YAML::load( processed )
+          Ziya.logger.info ">>> ZiYa successfully loaded design file `#{file_name}"        
+          return load
+        rescue SystemCallError => boom
+          Ziya.logger.error boom
+        rescue => bang
+          Ziya.logger.error ">>> ZiYa -- Error encountered loading design file `#{file_name} -- #{bang}" 
+          bang.backtrace.each { |l| Ziya.logger.error( l ) }
+        end
+        nil
+      end    
+  end
+end