gerbilcharts 0.0.3

data/History.txt

@@ -0,0 +1,11 @@
+== 0.0.3 2008-11-8
+
+* Initial package as a gem 
+  * Thanks to newgem / hoe we now have GerbilCharts as a gem
+  * Cleaned and refactored svg,models,surfaces,charts
+  * Tests written for charts
+
+== 0.0.1 2008-10-14
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,21 @@
+Copyright (c) 2008 Vivek Rajagopalan 
+Copyright (c) 2008 Unleash Networks Pvt Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/Manifest.txt

@@ -0,0 +1,75 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+setup.rb
+test/trafgen.rb
+test/test_noob.rb
+test/test_helper.rb
+lib/gerbilcharts.rb
+lib/gerbilcharts/version.rb
+lib/gerbilcharts/models.rb
+lib/gerbilcharts/svgdc.rb
+lib/gerbilcharts/surfaces.rb
+lib/gerbilcharts/charts.rb
+lib/gerbilcharts/public/brushmetal.css
+lib/gerbilcharts/public/gerbil.js
+lib/gerbilcharts/models/bucketized_timeseries_graph_model.rb
+lib/gerbilcharts/models/graph_model_group.rb
+lib/gerbilcharts/models/graph_model.rb
+lib/gerbilcharts/models/monotonous_graph_model.rb
+lib/gerbilcharts/models/presets.rb
+lib/gerbilcharts/models/raw_range.rb
+lib/gerbilcharts/models/round_range.rb
+lib/gerbilcharts/models/round_time_range.rb
+lib/gerbilcharts/models/discrete_time_range.rb
+lib/gerbilcharts/models/sampled_timeseries_graph_model.rb
+lib/gerbilcharts/models/time_series_graph_model.rb
+lib/gerbilcharts/models/simple_timeseries_model_group.rb
+lib/gerbilcharts/surfaces/area_surface.rb
+lib/gerbilcharts/surfaces/axis.rb
+lib/gerbilcharts/surfaces/bar_surface.rb
+lib/gerbilcharts/surfaces/basic_grid.rb
+lib/gerbilcharts/surfaces/chart.rb
+lib/gerbilcharts/surfaces/graph_element.rb
+lib/gerbilcharts/surfaces/grid.rb
+lib/gerbilcharts/surfaces/horizontal_axis.rb
+lib/gerbilcharts/surfaces/horizontal_name_axis.rb
+lib/gerbilcharts/surfaces/horizontal_time_axis.rb
+lib/gerbilcharts/surfaces/impulse_surface.rb
+lib/gerbilcharts/surfaces/legend.rb
+lib/gerbilcharts/surfaces/line_surface.rb
+lib/gerbilcharts/surfaces/mark_band.rb
+lib/gerbilcharts/surfaces/panel.rb
+lib/gerbilcharts/surfaces/pie_surface.rb
+lib/gerbilcharts/surfaces/rect.rb
+lib/gerbilcharts/surfaces/stacked_area_surface.rb
+lib/gerbilcharts/surfaces/stacked_grid.rb
+lib/gerbilcharts/surfaces/surface_background.rb
+lib/gerbilcharts/surfaces/surface.rb
+lib/gerbilcharts/surfaces/title_panel.rb
+lib/gerbilcharts/surfaces/tracker.rb
+lib/gerbilcharts/surfaces/vertical_axis.rb
+lib/gerbilcharts/charts/area_chart.rb
+lib/gerbilcharts/charts/bar_chart_compact.rb
+lib/gerbilcharts/charts/bar_chart.rb
+lib/gerbilcharts/charts/chart_base.rb
+lib/gerbilcharts/charts/impulse_chart.rb
+lib/gerbilcharts/charts/line_chart.rb
+lib/gerbilcharts/charts/stacked_area_chart.rb
+lib/gerbilcharts/svgdc/svgdc.rb
+lib/gerbilcharts/svgdc/svg_element.rb
+lib/gerbilcharts/svgdc/filters.rb
+lib/gerbilcharts/svgdc/transformations.rb
+lib/gerbilcharts/svgdc/presentation_attributes.rb
+lib/gerbilcharts/svgdc/svg_win.rb
+lib/gerbilcharts/svgdc/svg_custom_win.rb
+lib/gerbilcharts/svgdc/svg_shape.rb
+lib/gerbilcharts/svgdc/svg_circle.rb
+lib/gerbilcharts/svgdc/svg_line.rb
+lib/gerbilcharts/svgdc/svg_polygon.rb
+lib/gerbilcharts/svgdc/svg_polyline.rb
+lib/gerbilcharts/svgdc/svg_rect.rb
+lib/gerbilcharts/svgdc/svg_text.rb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+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.
+
+

data/README.txt

@@ -0,0 +1,174 @@
+= gerbilcharts
+
+* http://gerbilcharts.rubyforge.com
+
+== DESCRIPTION:
+
+SVG based charting library especially suited for timeseries data.
+
+== FEATURES/PROBLEMS:
+
+* Many predefined models
+* Many chart types
+* Customize via stylesheets instead of calls to setFont, setLineStyle, setColor etc
+* Interactive show tooltips, handle clicks on chart objects
+* Ajax enabled. gerbil.js allows each chart to autoupdate itself with new SVG elements.
+
+Known issues :
+* Requires a browser that can handle SVG such as Firefox/Opera.
+* IE + Adobe SVG Viewer works but has some problems w/ Ajax
+* Still needs some work on negative numbers
+* Needs better min/max/avg plotting on bucketized data
+
+===Note on stylesheets
+GerbilCharts uses stylesheets to customize appearances of almost all visual
+elements (colors, fonts, line strokes, fills). You can use the supplied
+stylesheet (eg, brushmetal.css) or derive your own from it. GerbilCharts
+searches for stylesheets in the working directory and the public directory of
+the gerbilcharts gem.
+
+== SYNOPSIS:
+
+===Simple timeseries example
+Assumes all models (data series) have values at discrete time points.
+
+  require 'rubygems'
+  gem 'gerbilcharts'
+  require 'gerbilcharts'
+
+  # test  sales figures of 3 sales people
+  # use a simple timeseries model 
+  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
+  mychart.render('/tmp/monthly_sales.svg')
+
+To view the chart:
+* firefox /tmp/monthly_sales.svg
+
+
+===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.
+
+	require 'rubygems'
+	gem 'gerbilcharts'
+	require 'gerbilcharts'
+
+	# Helper class to generate time series data for test purposes
+	class TimeSeriesDataGenerator
+	
+		attr_reader	:tuples_array
+	
+		# allows you to generate controlled random data
+		# tm_from, tm_to = start,end  time (a Time object)
+		# avg_resolution_secs = generate a sample approx this many seconds. Varies randomly +/-25%
+		# max,min = max and min value
+		def initialize(tm_from, tm_to, avg_resolution_secs, min_val, max_val)
+			@tuples_array=[]
+			tm_tmp = tm_from
+			
+			while tm_tmp < tm_to
+				@tuples_array << [ tm_tmp, min_val + (max_val - min_val)*rand ]
+				tm_tmp = tm_tmp + avg_resolution_secs *( 1 + (rand-0.5)/4)
+			end
+		end
+	
+		# iterator
+		def each_tuple
+			@tuples_array.each do |t,v|
+				yield t,v
+			end
+		end
+	end
+
+
+	# create an impulse chart 450x200 using the supplied brushmetal theme
+	mychart = GerbilCharts::Charts::ImpulseChart.new( :width => 450, :height => 200, :style => 'brushmetal.css')
+	
+	# generate traffic sample 1 (eth0) at approx 5 min intervals and feed into a bucketizer model of 15 min
+	tend = Time.now
+	tbegin = tend - 3600*24
+	model1 = GerbilCharts::Models::BucketizedTimeSeriesGraphModel.new( "eth0", 900 )
+	TimeSeriesDataGenerator.new(tbegin,tend,300,200000, 6000000).each_tuple do |t,v|
+	model1.add(t,v)
+	end
+	
+	# generate traffic sample 2(wan1) at approx 5 min intervals and feed into a bucketizer model of 15 min
+	model2 = GerbilCharts::Models::BucketizedTimeSeriesGraphModel.new( "wan1", 900 )
+	TimeSeriesDataGenerator.new(tbegin,tend,300,500000, 2000000).each_tuple do |t,v|
+	model2.add(t,v)
+	end
+	
+	# add these models to a modelgroup and render it
+	modelgroup = GerbilCharts::Models::GraphModelGroup.new( "External Traffic")
+	modelgroup.add model1
+	modelgroup.add model2
+	mychart.modelgroup=modelgroup
+	mychart.render('/tmp/daily_traffic.svg')
+
+	# attach the same model to a stacked area chart and show it 
+	# this demonstrates how the views can be changed dynamically
+
+	mysachart = GerbilCharts::Charts::StackedAreaChart.new( :width => 450, :height => 200, :style => 'brushmetal.css')
+	mysachart.modelgroup=modelgroup
+	mysachart.render('/tmp/daily_traffic_stacked_area.svg')	
+
+To view the charts:
+* firefox /tmp/daily_traffic.svg 
+* firefox /tmp/daily_traffic_stacked_area.svg
+ 
+
+===Tooltips example
+GerbilCharts can be interactive just like Flash charts. This is accomplished by a combination of SVG and
+Javascript. The Javascript is packaged in the file gerbil.js (requires prototype.js)
+
+Todo: A sample please (extract from Web Trisul)
+
+===Time selector example
+You can even select time intervals from the SVG using gerbil.js.
+
+Todo: A sample please (extract from Web Trisul)
+
+
+== REQUIREMENTS:
+
+* builder gem
+
+
+== INSTALL:
+
+* sudo gem install gerbilcharts
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Vivek Rajagopalan (vivek at unleashnetworks )
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/lib/gerbilcharts.rb

@@ -0,0 +1,18 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+# =GerbilCharts 
+#
+# Time Series Ajax Enabled Charting 
+#
+# Author:: Vivek Rajagopalan
+# Date:: 28 Oct 2008
+module GerbilCharts
+end
+
+require 'rubygems'
+
+require 'gerbilcharts/models'
+require 'gerbilcharts/svgdc'
+require 'gerbilcharts/surfaces'
+require 'gerbilcharts/charts'

data/lib/gerbilcharts/charts.rb

@@ -0,0 +1,16 @@
+# = GerbilCharts charts
+#
+# Predefined charts. We have put together various components and 
+# created ready to use charts ! You can also create your own charts by
+# combining elements like surfaces, axis, legends, titles, markers, etc
+#
+
+module GerbilCharts::Charts;end;
+
+require 'gerbilcharts/charts/chart_base'
+require 'gerbilcharts/charts/area_chart'
+require 'gerbilcharts/charts/bar_chart_compact'
+require 'gerbilcharts/charts/bar_chart'
+require 'gerbilcharts/charts/impulse_chart'
+require 'gerbilcharts/charts/line_chart'
+require 'gerbilcharts/charts/stacked_area_chart'

data/lib/gerbilcharts/charts/area_chart.rb

@@ -0,0 +1,36 @@
+module GerbilCharts::Charts
+
+
+# =Area Chart
+# Draws each model in a shaded area. 
+# We use a transparency to show hidden models. Not the best looking, but has its uses.
+#
+class AreaChart < ChartBase
+
+  def initialize(opt={})
+    super(opt)
+  end
+  
+  def create_chart_elements
+    
+    # anchor (line surface)
+    @thechart.create_filter(GerbilCharts::SVGDC::LinearGradientVertical.new("vertgrad","rgb(255,255,255)","rgb(224,224,224)"))
+    
+    # other elements
+    @thechart.add_child(GerbilCharts::Surfaces::SurfaceBackground.new(:orient => ORIENT_OVERLAY))
+    @thechart.add_child(GerbilCharts::Surfaces::BasicGrid.new(:orient => ORIENT_OVERLAY))
+    @thechart.add_child(GerbilCharts::Surfaces::TitlePanel.new(:orient => ORIENT_OVERLAY, :dim => 30))
+    @thechart.add_child(GerbilCharts::Surfaces::AreaSurface.new(:orient => ORIENT_OVERLAY),:anchor => true)
+    @thechart.add_child(GerbilCharts::Surfaces::Legend.new(:orient=> ORIENT_OVERLAY, :dim => 100))  
+    @thechart.add_child(GerbilCharts::Surfaces::VerticalAxis.new(:orient => ORIENT_WEST, :dim => 40 ))
+    @thechart.add_child(GerbilCharts::Surfaces::HorizontalTimeAxis.new(:orient => ORIENT_SOUTH, :dim => 25 ))
+    
+    # optional features
+    if @feature_timetracker
+        @thechart.add_child(GerbilCharts::Surfaces::Tracker.new(:orient => ORIENT_SOUTH, :dim => 10 ))
+    end
+  end
+  
+end
+   
+end

data/lib/gerbilcharts/charts/bar_chart.rb

@@ -0,0 +1,33 @@
+module GerbilCharts::Charts
+
+# =Bar Chart
+# A standard bar chart. 
+# The latest values of each model is presented as a separate bar.
+#
+class BarChart < ChartBase
+
+  attr_reader       :staggerlabels
+  
+  def initialize(opt={})
+    super(opt)
+    
+    @staggerlabels = 2
+    @staggerlabels = opt[:stagger] if opt[:stagger]
+  end
+  
+  def create_chart_elements
+    
+    # anchor (line surface)
+    @thechart.create_filter(GerbilCharts::SVGDC::LinearGradientVertical.new("vertgrad","rgb(255,255,255)","rgb(224,224,224)"))
+    
+    # other elements
+    @thechart.add_child(GerbilCharts::Surfaces::SurfaceBackground.new(:orient => ORIENT_OVERLAY))
+    @thechart.add_child(GerbilCharts::Surfaces::TitlePanel.new(:orient => ORIENT_OVERLAY, :dim => 30, :just => :right))
+    @thechart.add_child(GerbilCharts::Surfaces::BarSurface.new(:orient => ORIENT_OVERLAY), :anchor => true)
+    @thechart.add_child(GerbilCharts::Surfaces::VerticalAxis.new(:orient => ORIENT_WEST, :dim => 40 ))
+    @thechart.add_child(GerbilCharts::Surfaces::HorizontalNameAxis.new(:orient => ORIENT_SOUTH, :dim => (15 * @staggerlabels.to_i), :stagger => @staggerlabels))
+  end
+end
+
+
+end

data/lib/gerbilcharts/charts/bar_chart_compact.rb

@@ -0,0 +1,26 @@
+module GerbilCharts::Charts
+
+# =Compact bar chart
+# Tighter layout than a regular bar chart. 
+#
+class BarChartCompact < ChartBase
+
+  def initialize(opt={})
+    super(opt)
+  end
+  
+  def create_chart_elements
+    
+    # anchor (line surface)
+    @thechart.create_filter(GerbilCharts::SVGDC::LinearGradientVertical.new("vertgrad","rgb(255,255,255)","rgb(224,224,224)"))
+    
+    # other elements
+    @thechart.add_child(GerbilCharts::Surfaces::SurfaceBackground.new(:orient => ORIENT_OVERLAY))
+    @thechart.add_child(GerbilCharts::Surfaces::TitlePanel.new(:orient => ORIENT_OVERLAY, :dim => 30, :just => :right))
+    @thechart.add_child(GerbilCharts::Surfaces::BarSurface.new(:orient => ORIENT_OVERLAY),:anchor => true)
+    @thechart.add_child(GerbilCharts::Surfaces::HorizontalNameAxis.new(:orient => ORIENT_SOUTH, :dim => 30, :stagger => 2 ))
+  end
+end
+
+
+end

data/lib/gerbilcharts/charts/chart_base.rb

@@ -0,0 +1,123 @@
+module GerbilCharts::Charts
+
+# =Chart base - sets up a container for surfaces
+#
+# You can put together various chart elements and create your own
+# chart types. In  fact, all the charts in this module are nothing 
+# but a composition of various surfaces
+#
+# The logic goes something like this :
+# 1. A reddish gradient background
+# 2. A stacked area surface to represent our data
+# 3. Title overlay
+# 4. Vertical labels on WEST
+# 5. Horiz labels on SOUTH
+# 6. Legend on EAST
+#
+# *A note on stylesheets*
+#
+# GerbilCharts uses a color scheme from a stylesheet.
+# The stylesheets contain the coloring for each model.
+class ChartBase
+
+
+  # orientations (same as Surfaces::) 
+  ORIENT_NORTH=1
+  ORIENT_SOUTH=2
+  ORIENT_EAST=3
+  ORIENT_WEST=4
+  ORIENT_NORTHEAST=5
+  ORIENT_NORTHWEST=6
+  ORIENT_SOUTHEAST=7
+  ORIENT_SOUTHWEST=8
+  ORIENT_OVERLAY=9
+
+
+  attr_reader     :thechart
+  attr_reader     :renderopts
+  attr_reader     :feature_timetracker
+  
+  def initialize(opt={})
+  
+    # suck out local options
+    @enabletimetracker=false
+    if opt[:enabletimetracker]
+        @feature_timetracker=opt[:enabletimetracker]
+        opt.delete :enabletimetracker
+    end
+    
+    # pass on options to chart object
+    @thechart = GerbilCharts::Surfaces::Chart.new(opt)
+    @renderopts = {}
+  end
+
+  def set_renderoptions=(opts)
+  	@renderopts.merge!(opts)
+  end
+  
+  def setmodelgroup(themodel)
+    @thechart.set_modelgroup(themodel)
+    
+    # automatically set hrefs
+    if themodel.hasHref?
+      sethref(themodel.href)
+    end
+  end
+
+  def modelgroup=(themodelgroup)
+	setmodelgroup(themodelgroup)
+  end
+  
+  # render options
+  #   :file => filename
+  #   :string => return a string
+  def render_base
+    create_chart_elements
+    @thechart.render(@renderopts)
+  end
+  
+  def render(outfile)
+    @renderopts.merge!( :file => outfile )
+    render_base
+  end
+  
+  def render_all(opts)
+    @renderopts.merge!(opts)  
+    render_base
+  end
+  
+  # render xfrag
+  def render_frag(xfrag)
+    @renderopts.merge!( :xfrag => xfrag )
+    render_base
+  end
+  
+  # render string
+  def render_string(str)
+    @renderopts.merge!( :string => xfrag )
+    render_base
+  end
+  
+  # click chart title to go somewhere else
+  def sethref(href)
+    @thechart.sethref(href)
+  end
+  
+  # all sub charts override this to create custom layouts
+  def create_chart_elements
+        
+  end
+  
+  # Ajax options (callback frequecy, URL, etc)
+  def setAjaxOptions(h)
+    @thechart.set_ajaxOptions(h)
+  end
+
+  # Ajax context (custom parameters required by server)
+  def setAjaxContext(h)
+    @thechart.set_ajaxContext(h)
+  end
+end
+
+end
+