ziya 2.0.7 → 2.1.6

data/lib/ziya/{components → charts/support}/rect.rb

@@ -3,7 +3,7 @@
 #
 # Author:: Fernand Galiana
 # -----------------------------------------------------------------------------
-module Ziya::Components
+module Ziya::Charts::Support
   # 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

data/lib/ziya/{components → charts/support}/scroll.rb

@@ -4,9 +4,7 @@
 # Author:: Fernand Galiana
 # Date::   Dec 15th, 2006
 # -----------------------------------------------------------------------------
-require 'ziya/components/base'
-
-module Ziya::Components
+module Ziya::Charts::Support
   # 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

data/lib/ziya/{components → charts/support}/series.rb

@@ -3,9 +3,7 @@
 #
 # Author:: Fernand Galiana
 # -----------------------------------------------------------------------------
-require 'ziya/components/base'
-
-module Ziya::Components
+module Ziya::Charts::Support
   # Specifies the gap betwen cols/bars and gap between series for column and bar
   # charts only.
   # See http://www.maani.us/xml_charts/index.php?menu=Reference&submenu=series

data/lib/ziya/{components → charts/support}/series_color.rb

@@ -11,7 +11,7 @@
 # Author:: Fernand Galiana
 # Date::   Dec 15th, 2006
 # -----------------------------------------------------------------------------
-module Ziya::Components
+module Ziya::Charts::Support
   class SeriesColor < Base    
     has_attribute :colors
   

data/lib/ziya/{components → charts/support}/series_explode.rb

@@ -14,7 +14,7 @@
 # Author:: Fernand Galiana
 # Date::   Dec 15th, 2006
 # -----------------------------------------------------------------------------
-module Ziya::Components
+module Ziya::Charts::Support
   class SeriesExplode < Base    
     has_attribute :numbers
   

data/lib/ziya/{components → charts/support}/shadow.rb

@@ -3,7 +3,7 @@
 #
 # Author:: Fernand Galiana
 # -----------------------------------------------------------------------------
-module Ziya::Components
+module Ziya::Charts::Support
   # 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.      

data/lib/ziya/{components → charts/support}/text.rb

@@ -4,7 +4,7 @@
 # Author:: Fernand Galiana
 # Date::   Dec 15th, 2006
 # -----------------------------------------------------------------------------
-module Ziya::Components
+module Ziya::Charts::Support
   # 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
@@ -13,5 +13,13 @@ module Ziya::Components
     has_attribute :layer, :transition, :delay, :duration, :x, :y, :width,
                   :height, :h_align, :v_align, :rotation, :font, :bold, :size,
                   :color, :alpha, :shadow, :bevel, :glow, :blur, :text
+
+    # -------------------------------------------------------------------------
+    # Dump has_attribute into xml element
+    def flatten( xml )
+      opts = options.clone
+      text = opts.delete( :text )
+      xml.text( opts ) { |x| x.text!( text.to_s ) }
+    end                  
   end
 end

data/lib/ziya/{components → charts/support}/tooltip.rb

@@ -6,7 +6,7 @@
 #
 # Author:: Fernand Galiana
 # -----------------------------------------------------------------------------
-module Ziya::Components
+module Ziya::Charts::Support
   # 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

data/lib/ziya/{components → charts/support}/update.rb

@@ -4,7 +4,7 @@
 #
 # Author:: Fernand Galiana
 # -----------------------------------------------------------------------------
-module Ziya::Components
+module Ziya::Charts::Support
   # 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.

data/lib/ziya/core_ext/string.rb

@@ -0,0 +1,31 @@
+# -----------------------------------------------------------------------------
+# Various text utils. Yes indeed lifted from Inflector.
+#
+# Author:: Fernand Galiana
+# Date::   Dec 15th, 2006
+# -----------------------------------------------------------------------------
+class String
+  # Pulled from the Rails Inflector class and modified slightly to fit our needs.
+  def camelize_it()
+    self.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
+  end
+
+  # Same as Rails Inflector but eliminating inflector dependency
+  def underscore
+    self.to_s.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+    downcase
+  end
+
+  # Pulled from the Rails Inflector class and modified slightly to fit our needs.
+  def classify
+    self.sub(/.*\./, '').camelize_it
+  end
+  
+  # strip out module name and return bare class name
+  def demodulize
+    self.gsub( /^.*::/, '' )
+  end    
+end

data/lib/ziya/gauges/base.rb

@@ -1,6 +1,11 @@
+require 'ziya/yaml_helpers/gauges'
+require 'ziya/html_helpers/gauges'
+require 'erb'
+require 'cgi'
+
 module Ziya::Gauges
   class Base
-    include Ziya::Helpers::BaseHelper
+    include Ziya::YamlHelpers::Gauges, Ziya::HtmlHelpers::Gauges
 
     attr_accessor :license, :design_id
     attr_reader   :type, :components
@@ -12,7 +17,7 @@ module Ziya::Gauges
       
       # 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
+      Ziya.logger.debug( ">>> ZiYa -- no helper for gauge `#{design_id}" ) unless loaded
 
       # init defaults
       @options = default_options      
@@ -64,7 +69,7 @@ module Ziya::Gauges
 
       # retrieve bundled design directory
       def bundled_designs_dir
-        Ziya.path( %w[gauges designs] )
+        Ziya.path( %w[resources gauges designs] )
       end
       
       # -----------------------------------------------------------------------
@@ -74,7 +79,7 @@ module Ziya::Gauges
           unless helper_file =~ /^(#{design_id}_helper).rb$/ or helper_file =~ /^(base_helper).rb$/
             next
           end
-          Ziya.logger.info( ">>> ZiYa loading custom helper `#{$1}" )
+          Ziya.logger.debug( ">>> ZiYa loading custom helper `#{$1}" )
           # BOZO !! This will only work in rails ??
           if defined? RAILS_ROOT
             require_dependency File.join(helper_dir, $1) 
@@ -118,7 +123,7 @@ module Ziya::Gauges
         elsif std_design
           design = std_design
         end        
-# Ziya.logger.debug "!!!! Design\n#{design.to_yaml}"
+# Ziya.logger.info "!!!! Design #{design_id} -- \n#{design.to_yaml}"
         # flatten components to xml
         design.components.each do |name, value|
 # Ziya.logger.debug "Processing #{name}"          
@@ -148,23 +153,23 @@ module Ziya::Gauges
       # -----------------------------------------------------------------------
       # Load yaml file associated with class if any
       def inflate( clazz, designs_dir, design )
-        class_name  = underscore( demodulize( clazz.to_s ) )
+        class_name  = clazz.to_s.demodulize.underscore
         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"        
+# Ziya.logger.info ">>> Unprocessed yaml...\n#{yml}\n"        
           processed = erb_render( yml )
-# Ziya.logger.debug ">>> Processed yaml...\n#{processed}"
+# Ziya.logger.info ">>> Processed yaml...\n#{processed}"
           load = YAML::load( processed )
-          Ziya.logger.info ">>> ZiYa successfully loaded design file `#{file_name}"        
+          Ziya.logger.debug ">>> ZiYa successfully loaded design file `#{file_name}"        
           return load
         rescue SystemCallError => boom
-          Ziya.logger.error boom
+          Ziya.logger.debug boom
         rescue => bang
-          Ziya.logger.error ">>> ZiYa -- Error encountered loading design file `#{file_name} -- #{bang}" 
-          bang.backtrace.each { |l| Ziya.logger.error( l ) }
+          Ziya.logger.info ">>> ZiYa -- Error encountered loading design file `#{file_name} -- #{bang}" 
+          bang.backtrace[0..3].each { |l| Ziya.logger.debug( l ) }
         end
         nil
       end    

data/lib/ziya/gauges/support/base.rb

@@ -1,32 +1,24 @@
 module Ziya::Gauges::Support
-  class Base < Ziya::Components::Base
-    include Ziya::Helpers::BaseHelper
+  class Base < Ziya::Charts::Support::Base
+    include Ziya::YamlHelpers::Gauges
     
     # -----------------------------------------------------------------------
     # converts component to yaml style component for yaml parser consumption
     def to_comp_yaml( name, indent_multiplier=1 )
       buff = []
       tab  = indent( indent_multiplier )
-      buff << "#{dial( demodulize( self.class.name ), name )}"
+      buff << "#{dial( self.class.name.demodulize, name )}"
       options.each_pair do |k,v|
         if v.is_a? YAML::Omap
           buff << "#{tab}#{indent}#{dials}"
           v.each do |name, comp|
-            buff << "#{tab}#{indent(2)}#{dial( demodulize(comp.class.name), name )}"
+            buff << "#{tab}#{indent(2)}#{dial( comp.class.name.demodulize, name )}"
             comp.options.each_pair { |k,v| buff << "#{tab}#{indent(4)}#{k}: #{v}"}
           end          
         else
           buff << "#{tab}#{indent(1)}#{k}: #{v}" if options[k] and !options[k].to_s.empty?
         end
       end
-    
-      # if ( self.respond_to? :dials )
-      #   buff << "#{tab}dials:"
-      #   for dial in dials do
-      #     buff << "#{tab}#{dial( demodulize( dial.class.name ) )}"
-      #     dial.options.each_pair { |k,v| buff << "#{tab}#{tab}#{k}: #{v}"}
-      #   end
-      # end
       buff.join( "\n" )
     end        
   end

data/lib/ziya/gauges/support/radial_numbers.rb

@@ -12,7 +12,7 @@ module Ziya::Gauges::Support
     has_attribute :start_num, :end_num, 
                   :font, :size, :bold, :width, :height, :align
 
-    # overrides flatten to generate a series of radial tick marksß
+    # overrides flatten to generate a series of radial tick marks
     def flatten( xml )
       number = start_num
       i      = start_angle

data/lib/ziya/html_helpers.rb

@@ -0,0 +1 @@
+Ziya.require_all_libs_relative_to __FILE__, "html_helpers"

data/lib/ziya/html_helpers/base.rb

@@ -0,0 +1,91 @@
+require 'ziya/core_ext/string'
+
+module Ziya
+  module HtmlHelpers
+    module Base
+
+      def mime()        "application/x-shockwave-flash"; end
+      def plugin_url()  "http://www.macromedia.com/go/getflashplayer"; end
+
+      # Set the wmode to opaque if a bgcolor is specified. If not set to
+      # transparent mode unless user overrides it    
+      def setup_wmode( options )
+        if options[:bgcolor]
+          options[:wmode] = "opaque" unless options[:wmode]
+        else
+          options[:wmode]   = "transparent" unless options[:wmode]
+          options[:bgcolor] = "#FFFFFF"
+        end
+      end
+  
+      # Check args for size option in the format wXy (Submitted by Sam Livingston-Gray)                                  
+      def setup_movie_size( options )
+        if options[:size] =~ /(\d+)x(\d+)/
+          options[:width]  = $1
+          options[:height] = $2
+          options.delete :size
+        end
+      end
+    
+      # escape url    
+      def escape_url( url )
+        url ? CGI.escape( url.gsub( /&/, '&' ) ) : url
+      end
+   
+      # # All this stolen form rails to make Ziya work with other fmks....    
+      def tag(name, options = nil, open = false, escape = true)
+       "<#{name}#{tag_options(options, escape) if options}" + (open ? ">" : " />")
+      end    
+        
+      def escape_once(html)
+        html.to_s.gsub(/[\"><]|&(?!([a-zA-Z]+|(#\d+));)/) { |special| escape_chars[special] }
+      end
+        
+      def tag_options(options, escape = true)
+        unless !options or options.empty?
+          attrs = []
+          if escape
+            options.each do |key, value|
+              next unless value
+              key = key.to_s
+              value = escape_once(value)
+              attrs << %(#{key}="#{value}")
+            end
+          else
+            attrs = options.map { |key, value| %(#{key}="#{value}") }
+          end
+          " #{attrs.sort * ' '}" unless attrs.empty?
+        end
+      end
+      #   
+      # def content_tag(name, content_or_options_with_block = nil, options = nil, escape = true, &block)
+      #   if block_given?
+      #     options = content_or_options_with_block if content_or_options_with_block.is_a?(Hash)
+      #     content = capture_block(&block)
+      #     content_tag = content_tag_string(name, content, options, escape)
+      #     block_is_within_action_view?(block) ? concat(content_tag, block.binding) : content_tag
+      #   else
+      #     content = content_or_options_with_block
+      #     content_tag_string(name, content, options, escape)
+      #   end
+      # end
+      #   
+      # def capture_block( *args, &block )
+      #     block.call(*args)
+      # end
+      #   
+      # def content_tag_string(name, content, options, escape = true)
+      #   tag_options = tag_options(options, escape) if options
+      #   "<#{name}#{tag_options}>#{content}</#{name}>"
+      # end
+      # 
+      # def block_is_within_action_view?(block)
+      #   eval("defined? _erbout", block.binding)
+      # end  
+      #   
+      def escape_chars 
+        { '&' => '&amp;', '"' => '&quot;', '>' => '&gt;', '<' => '&lt;' }
+      end          
+    end
+  end
+end

data/lib/ziya/html_helpers/charts.rb

@@ -0,0 +1,200 @@
+# Generates necessary html flash tag to support ZiYa
+#
+# TODO -- Rewrite to use content tag block instead...
+#
+# Author: Fernand Galiana
+
+module Ziya::HtmlHelpers::Charts
+  include Ziya::HtmlHelpers::Base
+    
+  # generates a javascript tag to include the js script to create object and
+  # embed tags
+  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="#{options[:swf_path]}/AC_RunActiveContent.js" language="javascript"></script>
+      <script language="javascript" type="text/javascript">
+        var requiredMajorVersion = #{options[:major_vers]};
+        var requiredMinorVersion = #{options[:minor_vers]};
+        var requiredRevision = #{options[:req_vers]};
+      </script>
+     JS
+  end
+       
+  def default_chart_options
+    { 
+      :width          => "400",
+      :height         => "300",
+      :bgcolor        => "ffffff",
+      :wmode          => "opaque",
+      :menu           => true,
+      :full_screen    => true,
+      :align          => "l",
+      :salign         => "tl",
+      :scale          => "noscale",
+      :use_cache      => false,
+      :timeout        => nil,
+      :retry          => 2,
+      :use_stage      => false,                  
+      :id             => "ziya_chart",
+      :swf_path       => chart_path,
+      :asset_url      => chart_path
+    }
+  end
+  
+  # generates necessary object and embed tags to display a flash movie on various 
+  # browsers using javascript
+  def ziya_chart_js( url, chart_options={} )
+    options = default_chart_options.merge( chart_options )
+
+    # Setup options for opaque mode
+    setup_wmode( options )      
+    
+    # setup width and height
+    setup_movie_size( options )
+    
+    flash_vars   = url ? charts_swf : charts_swf_base
+    xml_swf_path = flash_vars % [options[:swf_path], escape_url(url)]
+    xml_swf_path << "&chart_id=#{options[:id]}"
+    xml_swf_path << "&timestamp=#{Time.now.to_i}" if options[:cache] == false
+    xml_swf_path << "&timeout=#{options[:timeout]}&retry=#{options[:retry]}" if options[:timeout]
+    xml_swf_path << "&stage_width=#{options[:width]}&stage_height=#{options[:height]}" if options[:use_stage] == true 
+    
+    js = <<-JS
+      <script language="javascript" type="text/javascript">
+      if (AC_FL_RunContent == 0 || DetectFlashVer == 0) {
+        alert( "This page requires AC_RunActiveContent.js." );
+      } 
+      else {
+        var hasRightVersion = DetectFlashVer(requiredMajorVersion, requiredMinorVersion, requiredRevision);
+        if( hasRightVersion ) { 
+          AC_FL_RunContent(
+            'codebase'         , 'http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=9,0,45,0',
+            'width'            , '#{options[:width]}',
+            'height'           , '#{options[:height]}',
+            'scale'            , '#{options[:scale]}',
+            'salign'           , '#{options[:salign]}',
+            'bgcolor'          , '#{options[:bgcolor]}',
+            'wmode'            , '#{options[:wmode]}',
+            'movie'            , '#{options[:swf_path]}/charts',
+            'src'              , '#{options[:swf_path]}/charts',
+            'FlashVars'        , '#{xml_swf_path}', 
+            'id'               , '#{options[:id]}',
+            'name'             , '#{options[:id]}',
+            'menu'             , '#{options[:menu]}',
+            'allowFullScreen'  , '#{options[:full_screen]}',
+            'allowScriptAccess','sameDomain',
+            'quality'          , 'high',
+            'align'            , '#{options[:align]}',
+            'pluginspage'      , 'http://www.macromedia.com/go/getflashplayer',
+            'play'             , 'true',
+            'devicefont'       , 'false'
+          ); 
+        } 
+        else { 
+          var alternateContent = 'This content requires the Adobe Flash Player. '
+          + '<u><a href=http://www.macromedia.com/go/getflash/>Get Flash</a></u>.';
+          document.write(alternateContent); 
+        }
+      }
+      </script>
+    JS
+  end
+            
+  # generates neccessary html tags to display a chart.
+  def ziya_chart( url, chart_options = {} )
+    options = default_chart_options.merge( chart_options )
+  
+    flash_vars = url ? charts_swf : charts_swf_base
+    _ziya_chart( url, flash_vars, "charts.swf", options )
+  end   
+        
+  # genereates composite chart urls
+  def gen_composite_path( swf_chart_dir, url, chart_id=null )
+    buff = ""
+    if url
+      buff = composite_url % [swf_chart_dir, swf_chart_dir, escape_url( url )] 
+    else
+      buff = composite_base_url % [swf_chart_dir, "/charts" ]
+    end
+    buff << "&chart_id=#{chart_id}" if chart_id
+    buff
+  end
+    
+  # =========================================================================
+  # private                               
+
+  # Const accessors...
+  def composite_base_url() "%s/charts.swf?library_path=%s/charts_library" end        
+  def composite_url()      "#{composite_base_url}&xml_source=%s" end
+  def charts_swf_base()    "library_path=%s/charts_library"; end      
+  def charts_swf()         "#{charts_swf_base}&xml_source=%s"; end      
+  def chart_path()         "/charts"; end       
+  def class_id()           "clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" end
+  def codebase()           "http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=9,0,45,0"; end
+
+  # generates swf path
+  def gen_swf_path( path_directive, swf_dir, url )
+    path_directive % [swf_dir, escape_url( url )]        
+  end
+      
+  # generated the object and embed tag necessary for the flash movie
+  def _ziya_chart( url, swf_path, swf_file, options )
+    # Setup options for opaque mode
+    setup_wmode( options )      
+    
+    # setup width and height
+    setup_movie_size( options )
+    
+    color_param  = tag( 'param', {:name => 'bgcolor', :value => options[:bgcolor]}, true )
+    color_param += tag( 'param', {:name  => "wmode", :value => options[:wmode]}, true )
+
+    xml_swf_path = gen_swf_path( swf_path, options[:swf_path], url )
+    xml_swf_path << "&amp;timestamp=#{Time.now.to_i}" if options[:cache] == false
+    xml_swf_path << "&amp;timeout=#{options[:timeout]}" if options[:timeout]
+    xml_swf_path << "&amp;stage_width=#{options[:width]}&amp;stage_height=#{options[:height]}" if options[:use_stage] == true 
+    
+    tags = <<-TAGS
+    <object codebase="#{codebase}" classid="#{class_id}" id="#{options[:id]}" height="#{options[:height]}" width="#{options[:width]}">
+      <param name="scale"             value="noscale"/>
+      <param name="salign"            value="#{options[:salign]}"/>            
+      <param name="bgcolor"           value="#{options[:bgcolor]}"/>
+      <param name="wmode"             value="#{options[:wmode]}"/>                                  
+      <param name="movie"             value="#{options[:asset_url]}/#{swf_file}"/>
+      <param name="Flashvars"         value="#{xml_swf_path}&amp;chart_id=#{options[:id]}"/>
+      <param name="menu"              value="true"/>
+      <param name="allowFullScreen"   value="true"/>
+      <param name="allowScriptAccess" value="#{options[:script_access]}"/>            
+      <param name="quality"           value="high"/>
+      <param name="play"              value="true"/>                        
+      <param name="devicefont"        value="false"/>
+        <embed scale="noscale" 
+          allowfullscreen   = "true" 
+          allowscriptaccess = "#{options[:script_access]}" 
+          bgcolor           = "#{options[:bgcolor]}" 
+          devicefont        = "false" 
+          flashvars         = "#{xml_swf_path}&amp;chart_id=#{options[:id]}" 
+          menu              = "true" 
+          name              = "#{options[:id]}" 
+          play              = "true" 
+          pluginspage       = "#{plugin_url}" 
+          quality           = "high" 
+          salign            = "#{options[:salign]}" 
+          src               = "#{options[:asset_url]}/#{swf_file}" 
+          type              = "#{mime}" 
+          wmode             = "#{options[:wmode]}" 
+          align             = "#{options[:align]}" 
+          height            = "#{options[:height]}" 
+          width             = "#{options[:width]}"/>            
+     </object>        
+    TAGS
+  end
+end