ziya 2.0.6 → 2.0.7

data/Manifest.txt

@@ -31,6 +31,7 @@ charts/charts_library/piim.swf
 charts/charts_library/pino.swf
 charts/charts_library/pono.swf
 charts/charts_library/scno.swf
+charts/full_screen.swf
 charts/scripts/output_jpg.php
 charts/sliders/black.swf
 charts/sliders/preview_handle_1.swf
@@ -75,11 +76,13 @@ lib/ziya/components/axis_value.rb
 lib/ziya/components/base.rb
 lib/ziya/components/bevel.rb
 lib/ziya/components/blur.rb
+lib/ziya/components/button.rb
 lib/ziya/components/chart_border.rb
 lib/ziya/components/chart_grid_h.rb
 lib/ziya/components/chart_grid_v.rb
 lib/ziya/components/chart_guide.rb
 lib/ziya/components/chart_label.rb
+lib/ziya/components/chart_note.rb
 lib/ziya/components/chart_pref.rb
 lib/ziya/components/chart_rect.rb
 lib/ziya/components/chart_transition.rb
@@ -101,6 +104,7 @@ lib/ziya/components/series_color.rb
 lib/ziya/components/series_explode.rb
 lib/ziya/components/shadow.rb
 lib/ziya/components/text.rb
+lib/ziya/components/tooltip.rb
 lib/ziya/components/update.rb
 lib/ziya/gauges/base.rb
 lib/ziya/gauges/radial.rb

data/README.txt

@@ -12,6 +12,11 @@ ziya
   2.0.4 - Fixed missing encoding on composite urls - published gem on github
   2.0.5 - Fixed merb app support issue
   2.0.6 - Updates to support xml/swf 5.0.5
+  2.0.7 - Updates to support xm/swf 5.0.7
+          - added parameters for the ziya_js helpers ( Tx Brian ! )
+          - added draw button support
+          - added chart_note to annotate a chart
+          - added tooltip chart support
   
 == DESCRIPTION:
 

data/lib/ziya/charts/base.rb

@@ -5,6 +5,8 @@
 #
 # TODO !! Match helpers with chart class name
 # TODO !! Add accessor for specifying refresh look and data links on comps
+# TODO Figure out the equiv require_dep for merb if any ??
+# TODO Refact and clean up. 
 #
 # Author:: Fernand Galiana
 # Date::   Dec 15th, 2006
@@ -12,8 +14,6 @@
 require 'ziya/helpers/base_helper'
 require 'yaml'
 
-# TODO Figure out the equiv require_dep for merb if any ??
-# TODO Refact and clean up. 
 module Ziya::Charts
   # The mother ship of all charts. This class figures out how to generate the 
   # correct xml to render the chart on the client side. This class handles loading
@@ -30,6 +30,7 @@ module Ziya::Charts
         @components = [
           :axis_category, :axis_ticks, :axis_value, 
           :chart_rect, :chart_border, :chart_grid_h, :chart_grid_v,
+          :chart_note, :tooltip,
           :chart_transition, :chart_label, :chart_guide, :legend,
           :filter, :draw, 
           :series_color, :series, :series_explode, 
@@ -55,6 +56,7 @@ module Ziya::Charts
       @license     = license
       @options     = {}
       @series_desc = []
+      @annotations = []
       @theme       = default_theme
       @render_mode = Base.mode_reset
       initialize_components
@@ -72,14 +74,12 @@ module Ziya::Charts
     # renders everything
     def self.mode_reset() 0; end
     
-    # -------------------------------------------------------------------------
-    # Default ZiYa theme
+    # default ZiYa theme
     def default_theme # :nodoc:
       File.join( Ziya.themes_dir, %w[default] )
     end
     
-    # -------------------------------------------------------------------------
-    # Load up ERB style helpers
+    # load up ERB style helpers
     def load_helpers( helper_dir ) # :nodoc:    
       Dir.foreach(helper_dir) do |helper_file| 
         next unless helper_file =~ /^([a-z][a-z_]*_helper).rb$/
@@ -122,12 +122,20 @@ module Ziya::Charts
     # <tt>:axis_category_label</tt>::  Array of strings representing the x axis
     #                                  labels. This is supported only for Scatter and Bubble charts.
     #                                  This value is optional. Specify nil for no label change.    
-    # <tt>:series</tt>::               Specifies the series name and chart data points.
+    # <tt>:series</tt>::               Specifies the series name and chart data points as an array.
     #                                  The series name will be used to display chart legends.
     #                                  You must have at least one of these tag defined.
-    #                                  You may also specify an array of strings to identifies the 
-    #                                  custom labels that will be used on top of the chart 
-    #                                  elements
+    #                                  The data values may be specified as a straight up array of
+    #                                  strings or numbers but also as an array of hash representing
+    #                                  the data points and their attributes such as note, label, tooltip, effect, etc..
+    # Examples:
+    #  Plain old series with integer data points
+    #  my_chart.add( :series, "series A", [ 10, 20, 30] )
+    #
+    #  Specifying custom series labels
+    #  my_chart.add( :series, "series A", [ { :value => 10, :label => 'l1' }, { :value => 20, :label => 'l2' } ] )
+    #  You may specify the following attributes in the data point hash : :note, :label, :tooltip and effects such as :shadow, :glow, etc...
+    #
     # <tt>:axis_value_label</tt>::     Array of strings representing the ticks on the x/y
     #                                  axis depending on the chart type. This is symmetrical
     #                                  to the <tt>axis_category_label</tt> tag for the opposite
@@ -233,8 +241,7 @@ module Ziya::Charts
     # =========================================================================
     private
 
-    # -------------------------------------------------------------------------
-    # Inflate object state based on object hierarchy
+    # inflate object state based on object hierarchy
     def setup_state( state )
       override = self.class.name == state.class.name
       Base.components.each do |comp| 
@@ -242,8 +249,7 @@ module Ziya::Charts
       end
     end    
             
-    # -------------------------------------------------------------------------
-    # Load yaml file associated with class if any
+    # load yaml file associated with class if any
     def inflate( clazz, theme, instance=nil )
       class_name  = underscore(clazz.to_s.gsub( /Ziya::Charts/, '' )).gsub( /\//, '' )      
       class_name += '_chart' unless class_name.match( /.?_chart$/ ) 
@@ -265,104 +271,28 @@ module Ziya::Charts
       nil
     end
         
-    # -------------------------------------------------------------------------
-    # Parse erb template if any
+    # parse erb template if any
     def erb_render(fixture_content)
       b = binding
       ERB.new(fixture_content).result b      
     end
                               
-    # -------------------------------------------------------------------------
-    # Generates xml element for given data set
-    # TODO Lame ! Refact...
-    def gen_data_points( series_name, labels=nil )
-      values  = @options[series_name]
-      labels.insert( 0, nil ) if labels
+    # generates category axis data points
+    def gen_axis_category
+      categories = @options[:axis_category_text]
       @xml.row do
-        if values.respond_to? :each
-          values.each do |c|
-            if c.nil?
-              @xml.null 
-            elsif c.instance_of? String 
-              if labels and !labels.empty?
-                label = labels.shift                
-                if label
-                  @xml.string( :label => label ) { |x| x.text!( c ) }
-                else
-                  @xml.string( c )
-                end
-              else
-                @xml.string( c )
-              end
-            elsif c.respond_to? :zero?
-              if labels and !labels.empty?
-                label = labels.shift
-                if label
-                  @xml.number( :label => label ) { |x| x.text!( c.to_s ) } 
-                else
-                  @xml.number( c )
-                end
-              else
-                @xml.number( c )
-              end
-            end
+        categories.each do |category|
+          case
+            when category.nil?                 : @xml.null
+            when category.instance_of?(String) : @xml.string( category )
+            when category.respond_to?(:zero?)  : @xml.number( category )
+            when category.is_a?(Hash)          : gen_row_data( category.delete( :value ), category, @xml )
+            else puts "No match"
           end
-        else
-          @xml.string( values )
         end
-      end              
+      end
     end
             
-    # # -------------------------------------------------------------------------
-    # # Generates custom axis values
-    # def gen_axis_value_text( values )
-    #   return if values.nil? or values.empty?
-    #   @xml.axis_value_text do 
-    #     values.each { |v| @xml.string( v ) }
-    #   end
-    # end
-        
-    # # -------------------------------------------------------------------------
-    # # Check if the series are named
-    # def named_series?( names )
-    #   names.each do |name|
-    #     next unless name.to_s.index( 'series_' )
-    #     return @options[name][0].instance_of?(String) if @options[name] and !@options[name].empty?
-    #   end
-    #   false
-    # end
-    
-    # # -------------------------------------------------------------------------
-    # # Check if the options have custom labels ie :label_xxx tag
-    # def has_labels( names )
-    #   names.each do |name|
-    #     next unless name.to_s.index( 'labels_' )
-    #     return @options[name].size if @options[name] and !@options[name].empty?
-    #   end
-    #   0
-    # end    
-    
-    # # -------------------------------------------------------------------------
-    # # Generates custom labels
-    # def gen_labels( series_name, is_default=false )
-    #   cltn  = @options[series_name]
-    #   cltn.insert( 0, nil ) unless is_default
-    #   @xml.row do        
-    #     cltn.each { |c| ((c.nil? or c.to_s.empty?) ? @xml.null : @xml.string( c )) }
-    #   end              
-    # end    
-    
-    # # ------------------------------------------------------------------------
-    # # Generates default series labels
-    # def gen_default_labels( size )
-    #   labels = []
-    #   size.times { |i| labels << nil }
-    #   @xml.row do        
-    #     labels.each { |c| @xml.null }
-    #   end     
-    # end                
-
-    # ------------------------------------------------------------------------
     # generates chart data row
     # TODO Validate options !!
     def gen_row_data( value, opts=nil, xml=@xml )
@@ -373,19 +303,16 @@ module Ziya::Charts
       end        
     end
     
-    # -------------------------------------------------------------------------
     # generates string chart_value
     def gen_string_data( value, opts, xml )
       opts ? xml.string( opts ) { |x| x.text!( value ) } : xml.string( value )
     end
     
-    # -------------------------------------------------------------------------
     # generates number chart_value
     def gen_number_data( value, opts, xml )
       opts ? xml.number( opts ) { |x| x.text!( value.to_s ) } : xml.number( value )
     end
     
-    # -------------------------------------------------------------------------
     # generates chart data points    
     # BOZO !! Check args on hash
     def gen_chart_data( series )
@@ -409,15 +336,14 @@ module Ziya::Charts
       end
     end
     
-    # -------------------------------------------------------------------------
-    # Lay down graph data points and labels if any
+    # lay down graph data points and labels if any
     # TODO Validate series sizes/label sizes
     def setup_series
       raise "You must specify an axis_category_text with your series." if !@series_desc.empty? and ! @options[:axis_category_text]
       
       if @options[:axis_category_text]
         @xml.chart_data do 
-          gen_data_points( :axis_category_text )
+          gen_axis_category
           # render xml for each series
           @series_desc.each do |series|
             gen_chart_data( series )
@@ -445,8 +371,7 @@ module Ziya::Charts
       
     end
     
-    # -------------------------------------------------------------------------
-    # Walk up class hierarchy to find chart inheritance classes
+    # walk up class hierarchy to find chart inheritance classes
     def ancestors
       ancestors = self.class.ancestors.reverse
       allow = false
@@ -456,14 +381,12 @@ module Ziya::Charts
       end.compact!
     end
     
-    # -------------------------------------------------------------------------
-    # Check if we should do the all monty or just render the instance styles
+    # check if we should do the all monty or just render the instance styles
     def render_parents?      
       (@render_mode == Base.mode_reset)
     end
     
-    # -------------------------------------------------------------------------
-    # Load up look and feel data
+    # load up look and feel data
     def load_lnf     
       unless @partial
         ancestors.each do |super_class|
@@ -490,8 +413,7 @@ module Ziya::Charts
       end
     end
         
-    # -------------------------------------------------------------------------
-    # Generates xml for look and feel data
+    # generates xml for look and feel data
     def setup_lnf
       load_lnf
       unless @partial
@@ -506,7 +428,7 @@ module Ziya::Charts
       end      
     end
 
-    # -------------------------------------------------------------------------  
+    # load up the allowable chart components
     def initialize_components
       # Setup instance vars
       Base.components.each do |comp|

data/lib/ziya/components/area.rb

@@ -10,8 +10,7 @@ module Ziya::Components
   # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=link
   # for additional documentation, examples and futher detail.
   class Area < Base  
-    has_attribute :x, :y, :width, :height, :url, :priority, :target, :text,
-                  :font, :bold, :size, :color, :background_color, :alpha,
-                  :timeout, :retry, :spinning_wheel           
+    has_attribute :x, :y, :width, :height, :url, :priority, :target, :tooltip,
+                  :timeout, :retry, :spinning_wheel
   end
 end

data/lib/ziya/components/button.rb

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

+# Draws a button on a chart
+#
+# Author:: Fernand Galiana
+# -----------------------------------------------------------------------------
+module Ziya::Components
+  # Button component to draw a a button 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 Button < Base  
+    has_attribute :layer, :transition, :delay, :duration,
+                  :url_idle, :url_over, :url_press, :x, :y,
+                  :width, :height, :alpha, 
+                  :bevel, :glow, :blur, :shadow,
+                  :timeout, :retry
+  end
+end

data/lib/ziya/components/chart_guide.rb

@@ -9,8 +9,10 @@ module Ziya::Components
   # 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,
+      :snap_h, :snap_v, :connect, 
+      :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
+      :decimals, :decimal_char, :separator, :font, :bold, :size, :text_color,
+      :background_color
   end
 end

data/lib/ziya/components/chart_note.rb

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

+# Describes the look and feel for a chart annotation. An annotation must be
+# added using the Chart#add( :series) call using the hash definition ie
+#
+# chart.add( :series, "fred", [ { :value => 10, :note => "Hi there !"} ] )
+#
+# Author:: Fernand Galiana
+# -----------------------------------------------------------------------------
+module Ziya::Components
+  # Specifies an annotation look and feel on a chart. 
+  # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=chart_note
+  # for additional documentation, examples and futher detail.          
+  class ChartNote < Base  
+    has_attribute :type, :x, :y, :offset_x, :offset_y,
+                  :font, :bold, :size, :color, :alpha, 
+                  :background_color, :background_alpha, :shadow, :bevel, :glow, :blur        
+  end
+end

data/lib/ziya/components/tooltip.rb

@@ -0,0 +1,20 @@
+# -----------------------------------------------------------------------------

+# Describes the look and feel for a chart annotation. An annotation must be
+# added using the Chart#add( :series) call using the hash definition ie
+#
+# chart.add( :series, "fred", [ { :value => 10, :tooltip => "Hi there !"} ] )
+#
+# 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=tooltip
+  # for additional documentation, examples and futher detail.          
+  class Tooltip < Base  
+    has_attribute :font, :bold, :size, :color, :alpha, 
+                  :background_color, :background_alpha, 
+                  :duration,
+                  :shadow, :bevel, :glow, :blur        
+  end
+end

data/lib/ziya/version.rb

@@ -2,7 +2,7 @@ module Ziya
   module Version
     MAJOR = 2
     MINOR = 0
-    TINY  = 6
+    TINY  = 7
     
     # Returns the version string for the library.
     def self.version

data/lib/ziya/ziya_helper.rb

@@ -11,17 +11,22 @@ module Ziya
     
     # generates a javascript tag to include the js script to create object and
     # embed tags
-    def ziya_javascript_include_tag
+    def ziya_javascript_include_tag( opts={} )
+      options = { :swf_path   => chart_path,
+                  :major_vers => 9,
+                  :minor_vers => 0,
+                  :req_vers   => 45 }.merge!( opts )
+      
       js = <<-JS
         <script language="javascript" type="text/javascript">
           AC_FL_RunContent = 0;
           DetectFlashVer = 0;
         </script>
-        <script src="/charts/AC_RunActiveContent.js" language="javascript"></script>
+        <script src="#{options[:swf_path]}/AC_RunActiveContent.js" language="javascript"></script>
         <script language="javascript" type="text/javascript">
-          var requiredMajorVersion = 9;
-          var requiredMinorVersion = 0;
-          var requiredRevision = 45;
+          var requiredMajorVersion = #{options[:major_vers]};
+          var requiredMinorVersion = #{options[:minor_vers]};
+          var requiredRevision = #{options[:req_vers]};
         </script>
        JS
     end

data/release_notes.txt

@@ -1,4 +1,10 @@
 2.0.0 - Gem release - Update to xml/swf 5.0.2 added xml/gauge 1.6 
 2.0.1 - Update for xml/swf 5.0.3
 2.0.2 - Changed logging required to 0.9.X - Update to xml/swf 5.0.4
-2.0.3 - README file update - Thanks to Paul James !
+2.0.3 - README file update - Thanks to Paul James !
+2.0.4 - Fixed missing encoding on composite urls - published gem on github
+2.0.5 - Fixed merb app support issue
+2.0.6 - Updates to support xml/swf 5.0.5 
+  Fixed configuration with stacked 3d area charts
+  Added support for nil url in ziya_chart_helper - This allows to get a js callback when the
+  chart loads and populate the charts xml via javascript

data/spec/ziya_helper_spec.rb

@@ -37,7 +37,7 @@ describe Ziya::Helper do
     end
      
     it "should generate the correct js based chart tag" do
-      ziya_chart_js( @url ).should == "        <script language=\"javascript\" type=\"text/javascript\">\n        if (AC_FL_RunContent == 0 || DetectFlashVer == 0) {\n          alert( \"This page requires AC_RunActiveContent.js.\" );\n        } \n        else {\n          var hasRightVersion = DetectFlashVer(requiredMajorVersion, requiredMinorVersion, requiredRevision);\n          if( hasRightVersion ) { \n            AC_FL_RunContent(\n              'codebase'         , 'http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=9,0,45,0',\n              'width'            , '400',\n              'height'           , '300',\n              'scale'            , 'noscale',\n              'salign'           , 'tl',\n              'bgcolor'          , '000000',\n              'wmode'            , 'opaque',\n              'movie'            , '/charts/charts',\n              'src'              , '/charts/charts',\n              'FlashVars'        , 'library_path=/charts/charts_library&xml_source=%2Ffred%2Fblee%2Fduh', \n              'id'               , 'ziya_chart',\n              'name'             , 'ziya_chart',\n              'menu'             , 'true',\n              'allowFullScreen'  , 'true',\n              'allowScriptAccess','sameDomain',\n              'quality'          , 'high',\n              'align'            , 'l',\n              'pluginspage'      , 'http://www.macromedia.com/go/getflashplayer',\n              'play'             , 'true',\n              'devicefont'       , 'false'\n            ); \n          } \n          else { \n            var alternateContent = 'This content requires the Adobe Flash Player. '\n            + '<u><a href=http://www.macromedia.com/go/getflash/>Get Flash</a></u>.';\n            document.write(alternateContent); \n          }\n        }\n        </script>\n"
+      ziya_chart_js( @url ).should == "        <script language=\"javascript\" type=\"text/javascript\">\n        if (AC_FL_RunContent == 0 || DetectFlashVer == 0) {\n          alert( \"This page requires AC_RunActiveContent.js.\" );\n        } \n        else {\n          var hasRightVersion = DetectFlashVer(requiredMajorVersion, requiredMinorVersion, requiredRevision);\n          if( hasRightVersion ) { \n            AC_FL_RunContent(\n              'codebase'         , 'http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=9,0,45,0',\n              'width'            , '400',\n              'height'           , '300',\n              'scale'            , 'noscale',\n              'salign'           , 'tl',\n              'bgcolor'          , '000000',\n              'wmode'            , 'opaque',\n              'movie'            , '/charts/charts',\n              'src'              , '/charts/charts',\n              'FlashVars'        , 'library_path=/charts/charts_library&xml_source=%2Ffred%2Fblee%2Fduh&chart_id=ziya_chart', \n              'id'               , 'ziya_chart',\n              'name'             , 'ziya_chart',\n              'menu'             , 'true',\n              'allowFullScreen'  , 'true',\n              'allowScriptAccess','sameDomain',\n              'quality'          , 'high',\n              'align'            , 'l',\n              'pluginspage'      , 'http://www.macromedia.com/go/getflashplayer',\n              'play'             , 'true',\n              'devicefont'       , 'false'\n            ); \n          } \n          else { \n            var alternateContent = 'This content requires the Adobe Flash Player. '\n            + '<u><a href=http://www.macromedia.com/go/getflash/>Get Flash</a></u>.';\n            document.write(alternateContent); \n          }\n        }\n        </script>\n"
     end
        
     it "should set the wmode to opaque if bg_color is set" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ziya
 version: !ruby/object:Gem::Version 
-  version: 2.0.6
+  version: 2.0.7
 platform: ruby
 authors: 
 - Fernand Galiana
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-01 00:00:00 -06:00
+date: 2008-10-11 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,6 +67,7 @@ files:
 - charts/charts_library/pino.swf
 - charts/charts_library/pono.swf
 - charts/charts_library/scno.swf
+- charts/full_screen.swf
 - charts/scripts/output_jpg.php
 - charts/sliders/black.swf
 - charts/sliders/preview_handle_1.swf
@@ -111,11 +112,13 @@ files:
 - lib/ziya/components/base.rb
 - lib/ziya/components/bevel.rb
 - lib/ziya/components/blur.rb
+- lib/ziya/components/button.rb
 - lib/ziya/components/chart_border.rb
 - lib/ziya/components/chart_grid_h.rb
 - lib/ziya/components/chart_grid_v.rb
 - lib/ziya/components/chart_guide.rb
 - lib/ziya/components/chart_label.rb
+- lib/ziya/components/chart_note.rb
 - lib/ziya/components/chart_pref.rb
 - lib/ziya/components/chart_rect.rb
 - lib/ziya/components/chart_transition.rb
@@ -137,6 +140,7 @@ files:
 - lib/ziya/components/series_explode.rb
 - lib/ziya/components/shadow.rb
 - lib/ziya/components/text.rb
+- lib/ziya/components/tooltip.rb
 - lib/ziya/components/update.rb
 - lib/ziya/gauges/base.rb
 - lib/ziya/gauges/radial.rb