gerbilcharts 0.0.3 → 0.1.4

data/History.txt

@@ -1,3 +1,14 @@
+== 0.0.5 2009-06-05
+* Changes
+  * Support render_to_string to inline render in browser
+  * New test case for testing string rendering
+  * New sample demonstrates integration with a Ruby on Rails app
+
+== 0.0.4 2008-11-10
+* Changes
+  * Demonstrate tooltips
+  * Gradient style for line chart (need to make this an option)
+
 == 0.0.3 2008-11-8
 
 * Initial package as a gem 

data/Manifest.txt

@@ -7,6 +7,7 @@ Rakefile
 setup.rb
 test/trafgen.rb
 test/test_noob.rb
+test/test_render_string.rb
 test/test_helper.rb
 lib/gerbilcharts.rb
 lib/gerbilcharts/version.rb

data/PostInstall.txt

@@ -1,7 +1,2 @@
-
-For more information on gerbilcharts, see http://gerbilcharts.rubyforge.org
-
-NOTE: Change this information in PostInstall.txt 
-You can also delete it if you don't want it.
-
+Thanks for installing GerbilCharts SVG
 

data/README.txt

@@ -55,6 +55,57 @@ Assumes all models (data series) have values at discrete time points.
 To view the chart:
 * firefox /tmp/monthly_sales.svg
 
+===Rails example
+The most common use of gerbilcharts will be in a Rails application. Here is a guide to quickly get you on board. You can skip the first three steps if you already have a rails app up and running.
+
+First install gerbilcharts
+	sudo gem install gerbilcharts
+
+Generate a test app called gtest
+	rails generate gtest
+
+Create a controller
+	cd gtest
+	ruby script/generate controller tgerbil
+
+Copy the following code into app/controllers/tgerbil_controller.rb
+
+
+		require 'gerbilcharts'
+
+		class GerbtController < ApplicationController
+
+				# render inline to browser without using a temp file
+				def tgerb
+
+				  # test  sales figures of 3 sales people
+				  # use a simple timeseries model 
+				  # output to string finally
+					mychart = GerbilCharts::Charts::LineChart.new( :width => 350, :height => 200, :style => 'brushmetal.css',
+															   :circle_data_points => true )
+
+					mychart.modelgroup = GerbilCharts::Models::SimpleTimeSeriesModelGroup.new( 
+								   :title => "Sales figures",
+								   :timeseries  =>  (1..6).collect { |month| Time.local(2008,month) },
+								   :models =>       [ ["Bruce", 1,  10, 18, 28, 80,  122],
+													  ["Rex"  , 112,22, 45, 70, 218, 309], 
+													  ["Buzo" , 0,  23, 25, 40, 18,  59] 
+													]
+								 )
+
+					send_data mychart.render_string, :disposition => 'inline', :type => 'image/svg+xml'
+
+
+				  end   
+		end
+
+
+Start the web server
+	ruby script/server
+
+
+Point to website and test out the chart at http://localhost:3000/tgerbil/tgerb
+
 
 ===Bucketizer example
 This is a typical use of gerbilcharts. A number of timeseries data sources of various resolutions are bucketized uniformly and shown on a variety of charts. In this example, data points at varying intervals of approx 5 mins are collated into 15 min buckets using the BucketizedTimeSeriesGraphModel. This sample also shows the seperation of the data from the view. In the sample below, we switch the view from an ImpulseChart to a StackedAreaChart without touching the model.
@@ -126,6 +177,48 @@ To view the charts:
 * firefox /tmp/daily_traffic.svg 
 * firefox /tmp/daily_traffic_stacked_area.svg
  
+== Bucketizer rails example
+Use the bucketizer if you want to present timeseries data at a lower resolution that that of the incoming stream. The sample code is shown below. Copy paste this code into a controller to test the bucketizer
+
+
+		require 'gerbilcharts'
+
+		class GerbtController < ApplicationController
+
+		  # use the bucketized model only if we want the output to have a lower resolution 
+		  # than the incoming data
+		  def tbucket
+
+			 # create a model group, this houses the individual models
+			 modelgroup  = GerbilCharts::Models::GraphModelGroup.new("Price trends")
+
+			 # bucketized models, we create one and add it to the group
+			 bucket1  = GerbilCharts::Models::BucketizedTimeSeriesGraphModel.new("Selling Price",60)
+			 tbeg = Time.local( 1978, "jun", 5, 9, 10, 0, 0)
+			 
+			 # generate some random values at random resolution between 5 and 30 seconds
+			 # the timestamps of incoming data start from jun 5 9:10 AM :w
+			 100.times do |c|
+				 tbeg  =  tbeg + 5 + rand*30
+				 bucket1.add tbeg, rand*1000
+			 end
+
+			 # add all models to the group , we will chart the group
+			 modelgroup.add(bucket1)
+
+			 # create a area chart
+			 mychart = GerbilCharts::Charts::AreaChart.new( :width => 350, :height => 200, 
+															:style => 'brushmetal.css')
+
+			 # connect the model group to the chart
+			 mychart.setmodelgroup(modelgroup)
+
+			 send_data mychart.render_string, :disposition => 'inline', :type => 'image/svg+xml'
+
+		   end
+
+			
+		end
 
 ===Tooltips example
 GerbilCharts can be interactive just like Flash charts. This is accomplished by a combination of SVG and

data/lib/gerbilcharts/charts/chart_base.rb

@@ -93,9 +93,10 @@ class ChartBase
   end
   
   # render string
-  def render_string(str)
-    @renderopts.merge!( :string => xfrag )
+  def render_string
+    @renderopts.merge!( :string => "" )
     render_base
+	@renderopts[:string]
   end
   
   # click chart title to go somewhere else

data/lib/gerbilcharts/charts/line_chart.rb

@@ -20,6 +20,9 @@ class LineChart < ChartBase
   end
   
   def create_chart_elements
+	
+    # anchor (line surface)
+    @thechart.create_filter(GerbilCharts::SVGDC::LinearGradientVertical.new("vertgrad","rgb(255,255,255)","rgb(192,192,192)"))
     
     # other elements
     @thechart.add_child(GerbilCharts::Surfaces::SurfaceBackground.new(:orient => ORIENT_OVERLAY))

data/lib/gerbilcharts/surfaces/axis.rb

@@ -22,7 +22,7 @@ class Axis < GraphElement
     end
     
     def get_stagger_off(level, offset)
-        p "stager levles = #{@stagger_levels}"        
+        #p "stager levles = #{@stagger_levels}"        
       return (level % @stagger_levels) * offset
     end
     

data/lib/gerbilcharts/surfaces/bar_surface.rb

@@ -26,7 +26,7 @@ class BarSurface < Surface
 	 # see if the element spacing or width need to be adjusted to fit
 	 nmodels = parent.modelgroup.count
 	 delta = @bounds.width - (nmodels * (@element_width + @element_spacing) + @element_spacing)
-	 p "delta = #{delta} width = #{@bounds.width}"
+	 #p "delta = #{delta} width = #{@bounds.width}"
 	 if delta < 0
 		delta_per_item = delta/(nmodels+1)
 		@element_width += delta_per_item

data/lib/gerbilcharts/surfaces/chart.rb

@@ -25,6 +25,11 @@ class Chart < GraphElement
     @needslayout=false
   end
   
+  # We search for the javascript code in the javascripts directory
+  # This works with Ruby on Rails applications, if you want to change it
+  # pass a :javascripts => { "file:///gerbil.js" => false }
+  # The second parameter says if you want the js inlined in the HTML.
+  #
   def set_defaults
      @javascripts = { "/javascripts/gerbil.js" => false, "/javascripts/prototype.js" => false }
   end

data/lib/gerbilcharts/svgdc/svgdc.rb

@@ -209,6 +209,7 @@ class SVGDC
    doc.instruct!
    doc.declare! :DOCTYPE, :svg, :PUBLIC,"-//W3C//DTD SVG 1.1//EN","http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"
    
+
    render_to_frag(doc,opts)
    
    # return the svg_string
@@ -225,7 +226,7 @@ class SVGDC
   
   # synonym for render_to_file with no options
   def render(opts={})
-      render_to_string(opts[:string],opts) if opts[:string]
+      opts[:string]=render_to_string(opts) if opts[:string]
       render_to_file(opts[:file],opts)     if opts[:file]
       render_to_frag(opts[:xfrag],opts)  if opts[:xfrag]
   end

data/lib/gerbilcharts/version.rb

@@ -1,8 +1,8 @@
 module GerbilCharts
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 0
-    TINY  = 3
+    MINOR = 1
+    TINY  = 4
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/test_render_string.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+require 'trafgen'
+
+# test if render to string works correctly
+class TestRenderString  < Test::Unit::TestCase
+
+
+  # test  sales figures of 3 sales people
+  # use a simple timeseries model 
+  # output to string finally
+  def test_string_render
+ 
+    mychart = GerbilCharts::Charts::LineChart.new( :width => 350, :height => 200, :style => 'brushmetal.css',
+												   :circle_data_points => true )
+
+    modelgroup = GerbilCharts::Models::SimpleTimeSeriesModelGroup.new( 
+				   :title => "Sales figures",
+				   :timeseries  =>  (1..6).collect { |month| Time.local(2008,month) },
+				   :models =>       [ ["Bruce", 1,  10, 18, 28, 80,  122],
+									  ["Rex"  , 112,22, 45, 70, 218, 309], 
+									  ["Buzo" , 0,  23, 25, 40, 18,  59] 
+									]
+				 )
+
+	mychart.modelgroup=modelgroup
+
+	strout =  mychart.render_string
+
+	# a large enough string (basic test a large enough string generated)
+	assert strout.size > 1000 
+
+	# the string SVG is present in the out (very basic test)
+	assert strout.match("SVG")
+  end   
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gerbilcharts
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Vivek Rajagopalan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-10 00:00:00 +05:30
+date: 2009-06-06 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.7.0
+        version: 1.8.0
     version: 
 description: SVG based charting library for timeseries data
 email: 
@@ -45,6 +45,7 @@ files:
 - setup.rb
 - test/trafgen.rb
 - test/test_noob.rb
+- test/test_render_string.rb
 - test/test_helper.rb
 - lib/gerbilcharts.rb
 - lib/gerbilcharts/version.rb
@@ -113,13 +114,10 @@ files:
 - lib/gerbilcharts/svgdc/svg_text.rb
 has_rdoc: true
 homepage: http://gerbilcharts.rubyforge.org
+licenses: []
+
 post_install_message: |+
-  
-  For more information on gerbilcharts, see http://gerbilcharts.rubyforge.org
-  
-  NOTE: Change this information in PostInstall.txt 
-  You can also delete it if you don't want it.
-  
+  Thanks for installing GerbilCharts SVG
   
 rdoc_options: 
 - --main
@@ -141,16 +139,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: gerbilcharts
-rubygems_version: 1.3.0
+rubygems_version: 1.3.4
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: SVG based charting library for timeseries data
 test_files: 
-- test/test_charts.rb
-- test/test_ranges.rb
 - test/test_gerbilcharts.rb
-- test/test_noob.rb
+- test/test_ranges.rb
+- test/test_helper.rb
 - test/test_svgdc.rb
+- test/test_noob.rb
+- test/test_render_string.rb
 - test/test_models.rb
-- test/test_helper.rb
+- test/test_charts.rb
 - test/test_Scratch.rb