ziya 1.0.0 → 2.0.0

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

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

+# Create an animation to scale a component
+#
+# Author:: Fernand Galiana
+# -----------------------------------------------------------------------------
+require 'ziya/gauges/support/base'
+
+module Ziya::Gauges::Support
+  class Scale < Base  
+    has_attribute :x, :y, :start_scale, :end_scale, :step, :direction,
+                  :shake_span, :shake_frequency, :shake_snap,
+                  :shadow_alpha, :shadow_x_offset, :shadow_y_offset, 
+                  :components                  
+  end  
+end

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

@@ -0,0 +1,21 @@
+# -----------------------------------------------------------------------------

+# Draws text for a gauge
+#
+# Author:: Fernand Galiana
+# -----------------------------------------------------------------------------
+require 'ziya/gauges/support/base'
+
+module Ziya::Gauges::Support
+  class Text < Base  
+    has_attribute :x, :y, :width, :height, :rotation, :font, :bold, :size, :align,
+                  :color, :alpha, :text
+                  
+    def flatten( xml )
+      opts = options
+      txt = opts.delete( :text )
+      xml.text( opts ) do
+        xml.text! txt.to_s
+      end
+    end                  
+  end
+end

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

@@ -0,0 +1,12 @@
+# -----------------------------------------------------------------------------

+# Draws a rectangle for a gauge
+#
+# Author:: Fernand Galiana
+# -----------------------------------------------------------------------------
+require 'ziya/gauges/support/base'
+
+module Ziya::Gauges::Support
+  class Update < Base  
+    has_attribute :url, :delay, :delay_type, :stop_sound, :retry, :timeout
+  end
+end

data/lib/ziya/gauges/thermo.rb

@@ -0,0 +1,121 @@
+# -----------------------------------------------------------------------------
+# Thermometer gauge 
+#
+# TODO Need to figure out ordering different than alpha
+#
+# Author: Fernand
+# -----------------------------------------------------------------------------
+module Ziya::Gauges
+  class Thermo < Base
+  
+    # creates a thermometer gauge.
+    # <tt>license</tt> the xml/swf gauge license key
+    # <tt>design_id</tt> the name of the design file containing components
+    # to override default design.
+    def initialize( license, design_id="thermo" )
+      super( license, design_id )
+    end
+
+    # -----------------------------------------------------------------------
+    # provides for overiding basic functionality
+    #
+    # <tt>title</tt>::         String representing gauge title or null for none.
+    # <tt>gauge_color</tt>::   Legend color
+    # <tt>legend_color</tt>::  Gauge color
+    # <tt>due_point</tt>::     Set temperature level
+    def set_preferences( opts={} )
+      super( opts )
+      options[:end_scale] = normalize_and_scale( options[:due_point] )
+    end
+  
+    # =========================================================================
+    protected
+    
+      # -------------------------------------------------------------------------
+      # setup thermometer default options
+      def default_options
+        { 
+          :x            => 20,
+          :y            => 20,
+          :due_point    => 40,
+          :gauge_color  => "ff0000",
+          :legend_color => "cc0000",
+          :title        => "weather"
+        }
+      end
+
+    # =========================================================================
+    private
+                
+      # -----------------------------------------------------------------------
+      # converts temp is F to a % 
+      def normalize_and_scale( due_point )
+        return 100 if due_point > 120
+        return 0 if due_point < 20
+        due_point - 20
+      end
+    
+      # -----------------------------------------------------------------------
+      # draws farenheit scale
+      def draw_farenheit_scale( start_temp, end_temp )
+        i     = start_temp
+        buff  = []
+        count = 0
+        x = options[:x] + 60
+        y = options[:y] + 153
+        while( i <= end_temp ) do
+      		line = Ziya::Gauges::Support::Line.new( 
+      		  :x1        => x, 
+      		  :y1        => y-i, 
+      		  :x2        => x+8, 
+      		  :y2        => y-i, 
+      		  :thickness => 2 )
+      		buff << "#{indent}#{line.to_comp_yaml( "linef_#{count}", 2 )}"
+      		text = Ziya::Gauges::Support::Text.new( 
+      		  :x     => x+8,  
+      		  :y     => (y-8)-i,  
+      		  :width => 100,  
+      		  :align => 'left', 
+      		  :size  => 10, 
+      		  :color => 'aaaaaa', 
+      		  :text  => i.to_s )
+      		buff << "#{indent}#{text.to_comp_yaml( "textf_#{count}", 2 )}"
+      		i     += 20
+      		count += 1
+      	end
+      	buff.join( "\n" )
+      end
+  
+      # -----------------------------------------------------------------------
+      # draws celsius scale
+      def draw_celsius_scale( start_temp, end_temp )
+        i     = start_temp
+        ratio = 1.7
+        buff  = []
+        count = 0
+        x = options[:x] + 10
+        y = options[:y] + 118        
+        while( i <= end_temp ) do
+      		line = Ziya::Gauges::Support::Line.new( 
+      		  :x1        => x, 
+      		  :y1        => y-(i*ratio), 
+      		  :x2        => x+8, 
+      		  :y2        => y-(i*ratio), 
+      		  :thickness => 2 )
+      		buff << "#{indent}#{line.to_comp_yaml( "linec_#{count}", 2 )}"
+      		text = Ziya::Gauges::Support::Text.new( 
+      		  :x     => x - 20,  
+      		  :y     => (y-8)-(i*ratio),  
+      		  :width => 20,  
+      		  :align => 'right', 
+      		  :size  => 10, 
+      		  :color => 'aaaaaa', 
+      		  :text  => i.to_s )
+      		buff << "#{indent}#{text.to_comp_yaml( "text_c_#{count}", 2 )}"
+      		i     += 10
+      		count += 1
+      	end
+      	buff.join( "\n" )
+      end    
+  end
+end

data/lib/ziya/helpers/base_helper.rb

@@ -1,11 +1,42 @@
 require "ziya/utils/text"
+require "ziya/ziya_helper"
 
 module Ziya::Helpers
   module BaseHelper
-    include Ziya::Utils::Text
+    include Ziya::Utils::Text, Ziya::Helper
+
+    # -------------------------------------------------------------------------
+    # generates a swf chart path from the given url. Used as helper to embed 
+    # chart 
+    def chart_url( url, swf_chart_dir="/charts" )
+      gen_composite_path( swf_chart_dir, url )
+    end
+    
+    # -------------------------------------------------------------------------
+    # indent yaml content vy multiples of 2 spaces
+    def indent( multiple= 1 )
+      "  " * multiple
+    end
+
+    # -------------------------------------------------------------------------
+    # YAML Convenience for gauge class   
+    def gauge( class_name )
+      "--- #{clazz( class_name, 'Gauges' )}\n#{dials}" 
+    end
     
-    # =========================================================================
-    # TODO Move to helper
+    # -------------------------------------------------------------------------
+    # YAML Convenience for gauge component declaration   
+    def dial( comp_class, comp_name=nil )
+      clazz = clazz( comp_class, "Gauges::Support" )
+      comp_name ? "- :#{comp_name}: #{clazz}" : "- #{clazz}"
+    end
+
+    # -------------------------------------------------------------------------
+    # YAML dials declaration   
+    def dials
+      "components: !omap"
+    end
+        
     # -------------------------------------------------------------------------
     # YAML Convenience for component declaration   
     def component( component_name )
@@ -18,19 +49,21 @@ module Ziya::Helpers
     def drawing( class_name )
       clazz( class_name, :Components )
     end
-
+    alias_method :filter_type, :drawing
+    alias_method :area       , :drawing
+    
     # -------------------------------------------------------------------------
     # YAML Convenience for chart class   
     def chart( class_name )
       "--- #{clazz( class_name, :Charts )}" 
     end
-   
+       
    # -------------------------------------------------------------------------
     # YAML Convenience for chart name setting       
     def clazz( class_name, module_name=nil )
       buff = "!ruby/object:Ziya::"
       buff << "#{module_name}::" unless module_name.nil?
-      buff << "#{camelize(class_name.to_s)}\n"
+      buff << "#{camelize(class_name.to_s)}"
       buff
     end               
   end

data/lib/ziya/utils/text.rb

@@ -29,5 +29,11 @@ module Ziya::Utils
     def classify(string)
       camelize(string.to_s.sub(/.*\./, ''))
     end
+    
+    # strip out module name and return bare class name
+    def demodulize( clazz )
+      clazz.gsub( /^.*::/, '' )
+    end
+    
   end  
 end

data/lib/ziya/version.rb

@@ -1,6 +1,6 @@
 module Ziya
   module Version
-    MAJOR = 1
+    MAJOR = 2
     MINOR = 0
     TINY  = 0
     

data/lib/ziya/ziya_helper.rb

@@ -10,84 +10,311 @@ require 'erb'
 
 module Ziya
   module Helper    
-    # const accessor...
-    def xml_swf()    "%s/charts.swf?library_path=%s/charts_library&xml_source=%s"; end
     
+    # -------------------------------------------------------------------------
+    # generates a javascript tag to include the js script to create object and
+    # embed tags
+    def ziya_javascript_include_tag
+      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 language="javascript" type="text/javascript">
+          var requiredMajorVersion = 9;
+          var requiredMinorVersion = 0;
+          var requiredRevision = 45;
+        </script>
+       JS
+    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 = { :width          => "400",
+                  :height         => "300",
+                  :bgcolor        => "000000",
+                  :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,
+      }.merge!(chart_options)
+
+      # Setup options for opaque mode
+      setup_wmode( options )      
+      
+      # setup width and height
+      setup_movie_size( options )
+      
+      xml_swf_path = charts_swf % [options[:swf_path], escape_url(url)]
+      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 necessary html tags to display a gauge.  
+    def ziya_gauge( url, gauge_options={} )
+      options = { :width          => "200",
+                  :height         => "200",
+                  :align          => "middle",
+                  :scale          => "noscale",
+                  :salign         => "",
+                  :class          => "",        
+                  :id             => "ziya_gauge",
+                  :swf_path       => gauge_path,
+                  :use_cache      => false,
+                  :timeout        => false,
+                  :retry          => 2,
+                  :use_stage      => false
+                }.merge!(gauge_options)
+                      
+      generate_old_style_flash_tag( url, gauges_swf, options )
+    end
+        
     # -------------------------------------------------------------------------------------
-    # Generates chart object tag with given url to fetch the xml data  
-    # -------------------------------------------------------------------------------------            
+    # generates neccessary html tags to display a chart.
     def ziya_chart( url, chart_options = {} )
       options = { :width          => "400",
                   :height         => "300",
-                  :align          => "left",
-                  :class          => "",        
+                  :tag_type       => "embed",
+                  :align          => "l",
+                  :salign         => "tl",
+                  :scale          => "noscale",
+                  :class          => "",   
                   :id             => "ziya_chart",
                   :swf_path       => chart_path,
-                  :cache          => false,
+                  :use_cache      => false,
                   :timeout        => nil,
-                  :use_stage      => true,
-                  :style          => ""
+                  :use_stage      => false
                 }.merge!(chart_options)
+    
+      generate_flash_tag( url, charts_swf, "charts.swf", options )
+    end   
+        
+    # flash chart library path
+    def gen_composite_path( swf_chart_dir, url )
+      composite_url % [swf_chart_dir, swf_chart_dir, escape_url( url )] 
+    end
+    
+    # =========================================================================
+    # private                               
 
-      # Escape url
-      url = CGI.escape( url.gsub( /&amp;/, '&' ) )
+      # Const accessors...
+      def mime()          "application/x-shockwave-flash"; end
+      def composite_url() "%s/charts.swf?library_path=%s/charts_library&xml_source=%s" end
+      def charts_swf()    "library_path=%s/charts_library&xml_source=%s"; end      
+      def plugin_url()    "http://www.macromedia.com/go/getflashplayer"; end
+      def gauges_swf()    "%s/gauge.swf?xml_source=%s"; end              
+      def gauge_path()    "/gauges"; 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
 
-      # Set the wmode to opaque if a bgcolor is specified. If not set to
-      # transparent mode unless user overrides it
-      if options[:bgcolor]
-        options[:wmode] = "opaque" unless options[:wmode]
-      else
-        options[:wmode]   = "transparent" unless options[:wmode]
-        options[:bgcolor] = "#FFFFFF"
+      # generates swf path
+      def gen_swf_path( path_directive, swf_dir, url )
+        path_directive % [swf_dir, escape_url( url )]
       end
-      color_param  = tag( 'param', {:name => 'bgcolor', :value => options[:bgcolor]}, true )
-      color_param += tag( 'param', {:name  => "wmode", :value => options[:wmode]}, true )
 
-      # Check args for size option (Submitted by Sam Livingston-Gray)                                  
-      if options[:size] =~ /(\d+)x(\d+)/
-        options[:width]  = $1
-        options[:height] = $2
-        options.delete :size
+      def generate_old_style_flash_tag( url, swf_path, 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 = swf_path % [options[:swf_path], url]
+        xml_swf_path << "&timestamp=#{Time.now.to_i}" if options[:use_cache] == true
+        xml_swf_path << "&timeout=#{options[:timeout]}&retry=#{options[:retry]}" if options[:timeout] == true
+        xml_swf_path << "&stage_width=#{options[:width]}&stage_height=#{options[:height]}" if options[:use_stage] == true
+        tags = <<-TAGS
+          <object codebase="#{codebase}" classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" id="#{options[:id]}" height="#{options[:height]}" width="#{options[:width]}">
+            <param name="scale" value="noscale">
+            <param name="align" value="#{options[:align]}">            
+            <param name="bgcolor" value="#{options[:bgcolor]}">
+            <param name="wmode" value="#{options[:wmode]}">                                  
+            <param name="movie" value="#{xml_swf_path}">
+            <param name="menu" value="true">
+            <param name="allowFullScreen" value="true">
+            <param name="allowScriptAccess" value="sameDomain">            
+            <param name="quality" value="high">
+            <param name="play" value="true">                        
+            <param name="devicefont" value="false">
+            <embed scale="noscale"
+              allowfullscreen="true" 
+              allowscriptaccess="sameDomain" 
+              bgcolor="#{options[:bgcolor]}" 
+              devicefont="false" 
+              src="#{xml_swf_path}" 
+              menu="true" 
+              name="#{options[:id]}" 
+              play="true" 
+              pluginspage="http://www.macromedia.com/go/getflashplayer" 
+              quality="high" 
+              salign="#{options[:salign]}" 
+              src="#{xml_swf_path}" 
+              type="application/x-shockwave-flash" 
+              wmode="#{options[:wmode]}" 
+              salign="#{options[:salign]}" 
+              height="#{options[:height]}" 
+              width="#{options[:width]}">
+         </object>        
+        TAGS
+      end
+      
+      # generated the object and embed tag necessary for the flash movie
+      def generate_flash_tag( 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 << "&timestamp=#{Time.now.to_i}" if options[:cache] == false
+        xml_swf_path << "&timeout=#{options[:timeout]}" if options[:timeout]
+        xml_swf_path << "&stage_width=#{options[:width]}&stage_height=#{options[:height]}" if options[:use_stage] == true 
+        
+        # if options[:tag_type] == "object"
+          tags = <<-TAGS
+          <object codebase="#{codebase}" classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" 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[:swf_path]}/#{swf_file}">            
+            <param name="FlashVars"         value="#{xml_swf_path}&chart_id=#{options[:id]}">
+            <param name="menu"              value="true">
+            <param name="allowFullScreen"   value="true">
+            <param name="allowScriptAccess" value="sameDomain">            
+            <param name="quality"           value="high">
+            <param name="play"              value="true">                        
+            <param name="devicefont"        value="false">
+              <embed scale="noscale" 
+                allowfullscreen="true" 
+                allowscriptaccess="sameDomain" 
+                bgcolor="#{options[:bgcolor]}" 
+                devicefont="false" 
+                flashvars="#{xml_swf_path}" 
+                menu="true" 
+                name="#{options[:id]}" 
+                play="true" 
+                pluginspage="http://www.macromedia.com/go/getflashplayer" 
+                quality="high" 
+                salign="#{options[:salign]}" 
+                src="#{options[:swf_path]}/#{swf_file}" 
+                type="application/x-shockwave-flash" 
+                wmode="#{options[:wmode]}" 
+                align="#{options[:align]}" 
+                height="#{options[:height]}" 
+                width="#{options[:width]}"/>            
+         </object>        
+        TAGS
+      # else
+       #    tags = <<-TAGS
+       #      <embed scale="noscale" 
+       #        allowfullscreen="true" 
+       #        allowscriptaccess="sameDomain" 
+       #        bgcolor="#{options[:bgcolor]}" 
+       #        devicefont="false" 
+       #        flashvars="#{xml_swf_path}" 
+       #        menu="true" 
+       #        name="#{options[:id]}" 
+       #        play="true" 
+       #        pluginspage="http://www.macromedia.com/go/getflashplayer" 
+       #        quality="high" 
+       #        salign="#{options[:salign]}" 
+       #        src="#{options[:swf_path]}/#{swf_file}" 
+       #        type="application/x-shockwave-flash" 
+       #        wmode="#{options[:wmode]}" 
+       #        align="#{options[:align]}" 
+       #        height="#{options[:height]}" 
+       #        width="#{options[:width]}"/>
+       #    TAGS
+       # end 
+       tags
+      end
+              
+      # escape url    
+      def escape_url( url )
+        CGI.escape( url.gsub( /&amp;/, '&' ) )
       end
-                             
-      xml_swf_path = xml_swf % [options[:swf_path], options[:swf_path], url ]
-      xml_swf_path << "&timestamp=#{Time.now.to_i}" if options[:cache] == false
-      xml_swf_path << "&timeout=#{options[:timeout]}" if options[:timeout]
-      xml_swf_path << "&stage_width=#{options[:width]}&stage_height=#{options[:height]}" if options[:use_stage] == true 
-      content_tag( 'object',
-        tag( 'param',
-         {:name  => "movie",
-         :value =>  xml_swf_path}, true ) +
-        tag( 'param', 
-         {:name  => "quality",
-         :value => "high"}, true )  +
-        content_tag( 'embed', nil, 
-         :src           => xml_swf_path,
-         :quality       => 'high', 
-         :bgcolor       => options[:bgcolor],
-         :wmode         => options[:wmode], 
-         :width         => options[:width], 
-         :height        => options[:height], 
-         :name          => options[:id], 
-         :swLiveConnect => "true", 
-         :type          => "application/x-shockwave-flash",
-         :pluginspage   => "http://www.macromedia.com/go/getflashplayer") +
-        color_param,
-        :classid     => class_id,
-        :codebase    => codebase,
-        :data        => xml_swf_path, 
-        :style       => options[:style],
-        :width       => options[:width], :height => options[:height], 
-        :stage_width => options[:width], :stage_height => options[:height], :id => options[:id] )
-    end   
     
-    # =========================================================================
-    private                               
+      # setup up wmode
+      # 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
 
-       # Const accessors...
-       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=6,0,0,0"; 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
     
       # All this stolen form rails to make Ziya work with other fmks....    
       def tag(name, options = nil, open = false, escape = true)