derailed-ziya 2.0.8 → 2.1.0

data/README.txt

@@ -1,7 +1,6 @@
 === ZiYa
     by Fernand Galiana
-    ziya.rubyforge.org ( deprecated )
-    git://github.com/derailed/ziya.git ( preferred )
+    git://github.com/derailed/ziya.git
 
 == RELEASES
 
@@ -17,59 +16,65 @@
           - added draw button support
           - added chart_note to annotate a chart
           - added tooltip chart support
+  2.0.8 - Patches to xml/swf/5.0.7 - scroller handle fixe + Stoppped_Scolling js callback 
+          - added support for flash_to_javascript callbacks
+          - added support ids in composite charts
+          - various bug fixes 
+  2.1.0 - Refactor some of the underlying ziya code
+          - Beef up test suite
+          - changed component tree
+        - Added geographical maps support
+        - Changed the default ziyafy to install charts only by default
+          Run ziyafy --help for the various options
+        - Changed add( :composites, ... ) call to take in a hash of hash instead of id/url pair.
+          So the correct call is now of the form chart.add( :composites, :id => { :url => ... } )
+          You can now add extra attributes that will be passed to the generated image component.
   
 == DESCRIPTION:
 
-ZiYa allows you to easily display graphs in your ruby based applications by leveraging
-SWF Charts (http://www.maani.us/xml_charts/index.php) and SWF gauges (http://www.maani.us/gauge/index.php). 
-This gem bundles version 5.03 and 1.6 of these flash libraries. Incorporating flash graphs or gauge in your app 
-relieves the server by allowing for delegating graph rendering to the client side. Using this gem, you will
-be able to easily create great looking charts for your application. You will also be able
-to use the charts or gauges has a navigation scheme by embedding various link in the graphical components
-thus bring to the table an ideal scheme for reporting and dashboard like applications. Your
-managers will love you for it !!
-
-	Checkout the demo: http://ziya.liquidrail.com
-	Video            : http://www.youtube.com/watch?v=axIMmMHdXzo ( Out of date but you'll get the basics... )
-	Documentation    : http://ziya.liquidrail.com/docs
-	Forum            : http://groups.google.com/group/ziya-plugin
-	Repositories     : http://rubyforge.org/projects/ziya ( deprecated )
-	                   git://github.com/derailed/ziya.git ( preferred )
+ZiYa allows you to easily create interactive charts, gauges and maps for your web applications. ZiYa leverages
+flash which offload heavy server side processing to the client. At the root ZiYa allows you to easily generate an
+XML files that will be downloaded to the client for rendering. Using this gem, you will be able to easily create great
+looking charts for your application. You will also be able to use the charts, gauges and maps has a navigation scheme 
+by embedding various link in the graphical components thus bringing to the table an ideal scheme for reporting and dashboard
+like applications. Your manager will love you for it !!
 
+	Blog Site     : http://ziya.liquidrail.com
+	Documentation : http://ziya.liquidrail.com/docs
+	Forum         : http://groups.google.com/group/ziya-plugin
+	Repositories  : git://github.com/derailed/ziya.git
 
 == FEATURES:
 
 *  Supports a wide variety of chart/gauge types, sure to fit your needs.
+*  Geographical maps. Maps can be drillable and refreshable
 *  Relieves your server load by generating the actual chart on the client side.
-*  Allows you to style your charts just like you would an html page using css styles
-   philosophy. Each chart can be associated with a YAML file that allows you to specify
-   preferences based on SWF Charts properties. Chart stylesheets reside under 
-   public/charts/themes. Each chart type may have an associated YAML file. You can either 
-   inherit the default styles or define your own by specifying an id when you create your graph. 
-   The styles will cascade thru your graph class hierarchy and override default preferences as you
-   would in a stylesheet.
-   NOTE: XML/SWF charts are free of charge unless you need to use special features such
-   as embedded links and printing. 
-   The package cost $45 per domain, including localhost and is well worth the investment. 
-   A similar fee applies to the gauge framework.
-*  We are leveraging ERB within the YAML file to provide access to the chart/gauge state. State
-   can be passed in via the options hash when the graph/gauge is generated.
-   You can also define your own methods in helpers/ziya/xxx_helper. You can access these
-   helper methods in your style file just like you would in a rails template.
-*  Theme support. You can change the appearance and behavior of any charts by introducing
-   new themes under the public/charts/themes directory.
+*  Provides for cascading like css-styles for your charts using YAML files.
+*  Themes support. You can change the appearance and behavior of any charts by introducing new themes
 
 == REQUIREMENTS:
 
-  ZiYa depends on the logging gem version >= 0.9.0
-
-== INSTALL:
+  ZiYa depends on the logging gem version ~> 0.9.0
   
-  On rubyforge
+  ZiYa comes pre-bundled with the following packages:
+  * XML/SWF charts Version 5.07 (http://www.maani.us/xml_charts/index.php)
+  * XML/SWF gauges Version 1.6  (http://www.maani.us/gauge/index.php)
+  * DIY Maps                    (http://backspace.com/mapapp/)
   
-  sudo gem install ziya ( deprecated )
+  XML/SWF
+    * XML/SWF charts are free of charge unless you need to use special features such
+      as embedded links and printing. 
+       
+      The package cost $45 per domain, including localhost and is well worth the investment. 
+      A similar fee applies to the gauge framework.
+  
+  DIY Map
+    * This package is free for use in non-commercial applications. For commercial applications,
+    there is a $20.00 license per domain. I have chosen this package over others, as it supports
+    the interaction and configuration I was looking for, it seems stable and packs lots of features
+    for a reasonable price.
   
-  or github
+== INSTALL:
   
   sudo gem install derailed-ziya ( preferred )
   
@@ -79,74 +84,76 @@ managers will love you for it !!
   
   This will copy the necessary themes and flash files to run ZiYa in your application 
   public/charts directory.
+  
+  > ziyafy --help - for all available options.
       
 == SYNOPSIS:
   
-  This new gem version requires a client update to flash 9.0 and possibly you will
-  need to get a new license from XML/SWF >= 5.0 ( $45.0 for your domain ), if you want to use
-  advanced features suck as links and live updates. Also some api's have changed. 
-  I will try to push a new sample application and more docs in the next few weeks. 
-  So make sure you try this out first in a non production environment and report
-  bugs or side effects. I'll do my best to keep up with the demand. If anyone would like to give
-  me a hand with a tutorial app or improving the docs, I am all hears...
-  
-  When using within a rails application you will need to create a ziya.rb file in your
-  config/initializers directory ( Rails 2.0 ). 
+  This gem version requires a client update to flash 9.0 and possibly you will
+  need to get a new license from XML/SWF >= 5.0, if you want to use
+  advanced features suck as links and live updates.
   
-  NOTE: For rails version < 2.0, you can add the following code in your config/enviroment.rb directly.
+== Creating a ZiYa chart in a rails application
   
-  ziya.rb:
+  1 - Edit your environment.rb and add
+
+    environment.rb
+      
+    config.gem 'derailed-ziya', '~> 2.1.0
   
-    # Pull in the ZiYa gem framework
-    gem "ziya", ">= 2.0.0"
-    require 'ziya'
+  2 - Create a ziya.rb file under config/initializers
 
-    # Initializes the ZiYa Framework
-    Ziya.initialize( 
-      :logger      => RAILS_DEFAULT_LOGGER,
-      :helpers_dir => File.join( File.dirname(__FILE__), %w[.. .. app helpers ziya] ),
-      :themes_dir  => File.join( File.dirname(__FILE__), %w[.. .. public charts themes]) 
-    )
-  
-   This will initialize the gem. You can log the output to stdout using the ZiYa bundled logger
-   or specify a file ie File.join( File.dirname(__FILE__), %w[.. log ziya.log]. If you choose to use the 
-   ZiYa logger, you can specify the :log_level option to either :warn :info :debug or :error.
-   You will need to indicate your themes directory typically located under public/charts/themes or any location
-   you'll choose. Lastly you can specify a custom helper directory :helpers_dir, so you can use helper methods 
-   within your ZiYa stylesheets.
-   
-   NOTE: You must create the app/helpers/ziya and public/chart/themes directory in your application.
-   
-== Creating a chart
+      ziya.rb:
+
+        # Pull in the ZiYa gem framework
+        require 'derailed-ziya'
+
+        # Initializes the ZiYa Framework
+        Ziya.initialize( 
+          :logger     => RAILS_DEFAULT_LOGGER,
+          :themes_dir => File.join( File.dirname(__FILE__), %w[.. .. public charts themes]) 
+        )
+
+       This will initialize the gem. You can log the output to stdout using the ZiYa bundled logger
+       or specify a file ie File.join( File.dirname(__FILE__), %w[.. log ziya.log]. If you choose to use the 
+       ZiYa logger, you can specify the :log_level option to either :warn :info :debug or :error.
+       You will need to specify your themes directory typically located under public/charts/themes or any location
+       you'll choose.
+      
+   3 - Create a chart controller
    
-   * blee_controller.rb
+      blee_controller.rb:
    
-     class BleeController < ApplicationController
-       helper Ziya::Helper
+       class BleeController < ApplicationController
+        helper Ziya::HtmlHelpers::Charts
+        helper Ziya::YamlHelpers::Charts
        
-       # Callback from the flash movie to get the chart's data
-       def load_chart
-         # Create a bar chart with 2 series composed of 3 data points each.
-         # Chart will be rendered using the default look and feel
-         chart = Ziya::Charts::Bar.new
-         chart.add( :axis_category_text, %w[2006 2007 2008] )
-         chart.add( :series, "Dogs", [10,20,30] )
-         chart.add( :series, "Cats", [5,15,25] )
-         respond_to do |fmt|
-          fmt.xml => { render :xml => chart.to_xml }
+        # Callback from the flash movie to get the chart's data
+        def load_chart
+          # Create a bar chart with 2 series composed of 3 data points each.
+          # Chart will be rendered using the default look and feel
+          chart = Ziya::Charts::Bar.new
+          chart.add( :axis_category_text, %w[2006 2007 2008] )
+          chart.add( :series, "Dogs", [10,20,30] )
+          chart.add( :series, "Cats", [5,15,25] )
+          respond_to do |fmt|
+            fmt.xml => { render :xml => chart.to_xml }
+          end
        end
-     end
-     
-   * blee/index.html.erb
+  
+   4 - Create a view
    
-     Defines the necessary tag to embed a flash movie in your html page.
-     This will callback to your controller to fetch the necessary xml.
-     <%= ziya_chart load_chart_url, :size => "300x200" -%>
+      blee/index.html.erb:
    
-   * config/routes.rb
+        # Defines the necessary tag to embed a flash movie in your html page.
+        # This will callback to your controller to fetch the necessary xml.
+        <%= ziya_chart load_chart_url -%>
+   
+   5 - Create a named route
    
-     Creates a named route for the chart.
-     map.load_chart '/blee/load_chart', :controller => 'blee', :action => 'load_chart'
+      config/routes.rb:
+      
+       map.load_chart '/blee/load_chart', :controller => 'blee', :action => 'load_chart'
    
 == Creating a gauge
 
@@ -162,7 +169,7 @@ managers will love you for it !!
   
     class FredController < ApplicationController
       def load_gauge
-        gauge = Ziya::Gauges::Base.new( @license_key, 'my_gauge' )
+        gauge = Ziya::Gauges::Base.new( LICENCE_KEY, 'my_gauge' )
          respond_to do |fmt|
           fmt.xml => { render :xml => gauge.to_xml }
          end
@@ -171,7 +178,7 @@ managers will love you for it !!
     
    * fred/index.html.erb
    
-   <%= ziya_gauge load_gauge_url, :size => "300x200" -%>
+   <%= ziya_gauge load_gauge_url -%>
 
    * config/routes.rb
    
@@ -249,4 +256,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -25,7 +25,7 @@ PROJ.svn            = 'ziya'
 PROJ.rcov_threshold = 90.0
 PROJ.executables    = ['ziyafy']
 
-PROJ.exclude        << %w[.DS_Store$ .swo$ .swp$]
+PROJ.exclude        << %w[.DS_Store$ .swo$ .swp$ .git$]
 PROJ.tests          = FileList['test/**/test_*.rb']   
 PROJ.annotation_tags << 'BOZO'
 
@@ -41,4 +41,5 @@ end
 
 task 'gem:package' => 'manifest:assert'
 
-depend_on "logging", ">= 0.9.0"
+depend_on "logging", '~> 0.9.3'
+depend_on "color"  , '~> 1.4.0'

data/bin/ziyafy

@@ -1,25 +1,30 @@
 #!/usr/bin/env ruby            
 require 'optparse'
 require 'ostruct'
+require 'fileutils'
 
 require File.expand_path( File.join(File.dirname(__FILE__), '..', 'lib', 'ziya') )
     
+# TODO - Use main
 module Ziya
   class Ziyafy  
     # Copy necessary ZiYa components to a ruby web application
     def initialize( argv=ARGV ) 
       option_parser = default_option_parser 
       option_parser.parse!(argv)
-      puts "Installing ZiYa artifacts in `#{options.public_dir}"        
       copy_artifacts
     end                  
           
     # copies ziya artifacts to public app directory
     def copy_artifacts
-      source_dir = File.expand_path( File.join( File.dirname(__FILE__), %w[.. charts]) )
-      FileUtils.cp_r( source_dir, options.public_dir )
-      source_dir = File.expand_path( File.join( File.dirname(__FILE__), %w[.. gauges]) )
-      FileUtils.cp_r( source_dir, options.public_dir )      
+      %w[charts gauges maps].each do |s|
+        if options.send( s ) 
+          dest_dir = File.join( options.public_dir )
+          src_dir  = File.expand_path( File.join( File.dirname(__FILE__), %w[.. resources], s ) )
+          puts "Installing ZiYa artifacts in `#{dest_dir}"        
+          FileUtils.cp_r( src_dir, dest_dir )
+         end
+      end          
     end
     
     # access the options
@@ -28,6 +33,9 @@ module Ziya
         @options = OpenStruct.new 
         # Unless specified copy artifacts to the public directory
         @options.public_dir = File.join( Dir.pwd, %w[public] )
+        @options.charts     = false
+        @options.gauges     = false
+        @options.maps       = false
       end
       return @options
     end
@@ -36,7 +44,25 @@ module Ziya
     def default_option_parser #:nodoc:
       OptionParser.new do |op|
         op.separator ""
-        op.separator "Ziyafy options"
+        op.separator "ziyafy options:"
+
+        op.on( "-c", "--charts", "Copy ZiYa charts artifacts only" ) do |dir|
+          options.charts = true
+        end
+
+        op.on( "-g", "--gauges", "Copy ZiYa gauges artifacts only" ) do |dir|
+          options.gauges = true
+        end
+
+        op.on( "-m", "--maps", "Copy ZiYa maps artifacts only" ) do |dir|
+          options.maps = true
+        end
+
+        op.on( "-a", "--all", "Copy all ZiYa artifacts" ) do |dir|
+          options.charts = true
+          options.gauges = true
+          options.maps   = true
+        end
 
         op.on( "-p", "--public_dir FILE", "The location of the public app directory." ) do |dir|
           options.public_dir = dir
@@ -47,7 +73,4 @@ module Ziya
   end
 end  
 
-Ziya::Ziyafy.new(ARGV)
-
-
-    
+Ziya::Ziyafy.new(ARGV)

data/examples/charts/basic_chart.rb

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'sinatra'
+require 'builder'
+
+# require ZiYa gem and helpers
+require 'ziya'
+require 'ziya/html_helpers'
+require 'ziya/yaml_helpers'
+
+# initialize ZiYa environment
+configure do
+  Ziya.initialize( 
+    :log_level  => :debug,
+    :themes_dir => File.join( File.dirname(__FILE__), %w[public charts themes] ) )
+end
+
+helpers do
+  # add ZiYa helpers
+  include Ziya::HtmlHelpers::Charts
+  include Ziya::YamlHelpers::Charts
+  
+  # Default chart
+  def gen_chart
+    chart = Ziya::Charts::Column.new
+    chart.add :axis_category_text, %w[2007 2008 2009]
+    chart.add :series, 'dogs', [10,20,30]
+    chart.add :series, 'cats', [5,15,25]
+    chart    
+  end
+end
+
+# Setup chart and callbacks
+get '/' do
+  erb :index
+end
+
+# defines a simple column chart
+get '/load_chart' do
+  gen_chart.to_xml
+end
+
+# exact same chart as above but styled
+get '/load_themed_chart' do
+  chart = gen_chart
+  chart.add :theme , 'cool_theme'
+  chart.to_xml  
+end

data/examples/charts/public/charts/themes/cool_theme/column_chart.yml

@@ -0,0 +1,150 @@
+<%= chart :column %>
+
+  <%=comp :axis_category %>
+    shadow:  low
+
+  <%=comp :axis_value %>
+    shadow:  low
+    steps:     4
+    size:     10
+    alpha:    50
+    min:       0
+    
+  <%=comp :chart_border %>
+    top_thickness:          1
+    bottom_thickness:       2
+    left_thickness:         0
+    color:             000000
+    right_thickness:        0
+
+  <%=comp :chart_grid_h %>
+    alpha:          10
+    thickness:       1
+    type:       dashed
+
+  <%=comp :chart_label %>
+    alpha:         90
+    size:          10
+    color:     ddffff
+    position:  middle
+
+  <%=comp :chart_rect %>
+    shadow:            high
+    corner_tr:            0
+    x:                   75
+    positive_alpha:     100
+    corner_bl:           40
+    y:                   50
+    corner_tl:            0
+    height:             200
+    positive_color:  eeeeff
+    negative_color:  dddddd
+    bevel:               bg
+    corner_br:           40
+    negative_alpha:     100
+    width:              300
+
+  <%=comp :chart_transition %>
+    delay:         .5
+    order:     series
+    type:       scale
+    duration:     0.5
+
+  <%=comp :draw %>
+    components:
+      - <%= drawing :text %>
+          shadow:      high
+          alpha:         50
+          rotation:     -90
+          size:          75
+          x:            -20
+          y:            300
+          color:     f8f8ff
+          height:       200
+          h_align:   center
+          width:        300
+          text:      'animals'
+      - <%= drawing :text %>
+          shadow:       low
+          alpha:         50
+          rotation:     -90
+          size:          16
+          x:              7
+          y:            230
+          color:     000033
+          height:        50
+          h_align:   center
+          width:        300
+          v_align:   middle
+          text:      '(millions)'
+
+  <%=comp :filter %>
+    filters:
+      - <%= filter_type :shadow %>
+          blurY:       10
+          angle:       45
+          alpha:       35
+          id:        high
+          distance:     5
+          blurX:       10
+      - <%= filter_type :shadow %>
+          blurY:       5
+          angle:      45
+          alpha:      35
+          id:        low
+          distance:    2
+          blurX:       5
+      - <%= filter_type :bevel %>
+          blurY:               50
+          inner:             true
+          angle:               45
+          highlightAlpha:      50
+          id:                  bg
+          highlightColor:  ffffff
+          shadowAlpha:         10
+          blurX:               50
+          distance:            10
+      - <%= filter_type :bevel %>
+          blurY:               30
+          inner:             true
+          angle:              -80
+          highlightAlpha:      50
+          shadowColor:     000088
+          id:                blue
+          highlightColor:  ffffff
+          shadowAlpha:         25
+          blurX:                0
+          distance:            20
+      - <%= filter_type :bevel %>
+          blurY:               30
+          inner:             true
+          angle:              -80
+          highlightAlpha:      25
+          shadowColor:     000000
+          id:                gray
+          highlightColor:  ffffff
+          shadowAlpha:         20
+          blurX:                0
+          distance:            20
+
+  <%=comp :legend %>
+    shadow:             low
+    line_alpha:           0
+    size:                12
+    alpha:               90
+    x:                   75
+    fill_alpha:           8
+    y:                   27
+    margin:               5
+    height:              20
+    fill_color:      000066
+    color:           333355
+    line_thickness:       0
+    width:              300
+
+  <%=comp :series_color %>
+    colors: 666666,768bb3
+
+  <%=comp :series %>
+    set_gap:   40
+    bar_gap:  -25

data/examples/charts/views/index.erb

@@ -0,0 +1,12 @@
+<h1>ZiYa basic chart example</h1>
+
+<div style="text-align:center">
+  <div style="float:left;width:50%;border:1px black solid">
+    <h2>default theme</h2>
+    <%= ziya_chart '/load_chart' %>
+  </div>
+  <div style="width:100%;border:1px black solid">
+    <h2>custom theme</h2>
+    <%= ziya_chart '/load_themed_chart' %>  
+  </div>
+</div>