gerbilcharts 0.1.4 → 0.1.6

data/Manifest.txt

@@ -9,6 +9,7 @@ test/trafgen.rb
 test/test_noob.rb
 test/test_render_string.rb
 test/test_helper.rb
+test/test_scaling.rb
 lib/gerbilcharts.rb
 lib/gerbilcharts/version.rb
 lib/gerbilcharts/models.rb

data/lib/gerbilcharts/charts/area_chart.rb

@@ -3,7 +3,7 @@ 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.
+# We use a transparency to show hidden charts. Not the best looking, but has its uses.
 #
 class AreaChart < ChartBase
 

data/lib/gerbilcharts/charts/chart_base.rb

@@ -18,6 +18,16 @@ module GerbilCharts::Charts
 #
 # GerbilCharts uses a color scheme from a stylesheet.
 # The stylesheets contain the coloring for each model.
+#
+# Options common for all charts
+#
+# [+:width+]	   Width of the generated SVG chart in pixels
+# [+:height+]	   Height of the generated SVG chart in pixels
+# [+:style+]	   CSS Stylesheet to use for the chart (default = brushmetal.css see public gem directory)
+# [+:scaling_x+]   Allowed values are :auto, :auto_0, and an array [min,max] (default = :auto)
+# [+:scaling_y+]   Allowed values are :auto, :auto_0, and an array [min,max] (default = :auto)
+# [+:circle_data_points+] Draws a tiny circle around datapoints for tooltips
+#
 class ChartBase
 
 

data/lib/gerbilcharts/charts/line_chart.rb

@@ -30,7 +30,7 @@ class LineChart < ChartBase
     @thechart.add_child(GerbilCharts::Surfaces::TitlePanel.new(:orient => ORIENT_OVERLAY, :dim => 30))
     @thechart.add_child(GerbilCharts::Surfaces::LineSurface.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 => 30 ))
+    @thechart.add_child(GerbilCharts::Surfaces::VerticalAxis.new(:orient => ORIENT_WEST, :dim => 40 ))
     @thechart.add_child(GerbilCharts::Surfaces::HorizontalTimeAxis.new(:orient => ORIENT_SOUTH, :dim => 25 ))
   end
 end

data/lib/gerbilcharts/models/graph_model_group.rb

@@ -82,7 +82,31 @@ class GraphModelGroup
       yield mod.userdata if mod.hasUserData?
     end
   end
+
+  # rangeoptions
+  # [+:auto+]	 automatic rounded max and min range
+  # [+:auto_0+]  automatic rounded max and 0 min
+  # [+[min,max+] manual scaling
+  #
+  def effective_range_x(rangeopts=nil)
+  	if rangeopts.nil?
+		return effective_round_range_x
+	end
+
+	if rangeopts.to_sym == :auto
+		return effective_round_range_x
+	elsif rangeopts.to_sym = :auto_0
+		return effective_round_range_x
+	elsif  rangeopts.respond_to?('size') and rangeopts.size == 2
+    	reffx = RawRange.new
+		reffx.update(rangeopts[0])
+		reffx.update(rangeopts[1])
+		return reffx
+	end
+  end
   
+  # effective round range
+  # rounds both x and y scales, returns two ranges 
   def effective_round_range
     
     if @models.length==0
@@ -96,27 +120,56 @@ class GraphModelGroup
       reffy.update_r(m.yrange)
     end    
     
+	# todo : need to convert the round_given method to a class method
     return models[0].rounderx.round_given(reffx), models[0].roundery.round_given(reffy)
     
   end
 
+  # round the x ranges of all models
   def effective_round_range_x
     
     reffx = RawRange.new
     @models.each do |m|
       reffx.update_r(m.xrange)
     end    
-    
     return models[0].round_given_x(reffx)
   end
   
+  # rangeoptions
+  # [+:auto+]	 automatic rounded max and min range
+  # [+:auto_0+]  automatic rounded max and 0 min
+  # [+[min,max+] manual scaling
+  #
+  def effective_range_y(rangeopts=nil)
+  	if rangeopts.nil?
+		return effective_round_range_y0
+	end
+
+	if rangeopts == :auto
+		return effective_round_range_y
+	elsif rangeopts == :auto_0
+		return effective_round_range_y0
+	elsif  rangeopts.respond_to?('size') and rangeopts.size == 2
+    	reffy = RawRange.new
+		reffy.update(rangeopts[0])
+		reffy.update(rangeopts[1])
+		return reffy
+	end
+  end
+  
+  # round the y ranges of all models but minimum fixed at 0
   def effective_round_range_y0
     reffy = RawRange.new
     reffy.zeromin
     @models.each do |m|
       reffy.update_r(m.yrange)
     end    
-    
+    return @models[0].round_given_y(reffy)
+  end
+
+  def effective_round_range_y
+    reffy = RawRange.new
+    @models.each { |m| reffy.update_r(m.yrange) }   
     return @models[0].round_given_y(reffy)
   end
   
@@ -124,46 +177,42 @@ class GraphModelGroup
       return @models[0].sweep_interval
   end
   
-  # sum of model ranges 
+  # sum of model ranges  with min y being 0
   def cumulative_round_range_y0
     reffy = RawRange.new
     reffy.update(0)
     @models.each do |m|
       reffy.update(m.yrange.rmax+reffy.rmax)
     end    
-    
     return models[0].round_given_y(reffy)
   end
 
-  # sweep for an interval with max
+  # sum of model ranges  
+  def cumulative_round_range_y
+    reffy = RawRange.new
+    @models.each do |m|
+      reffy.update(m.yrange.rmax+reffy.rmax)
+    end    
+    return models[0].round_given_y(reffy)
+  end
+
+
+
+  # sweep for an interval with y scale starting 0
+  # this is most appropriate for network traffic charts
   def cumulative_sweep_round_range_y0
-      
-    rx = effective_round_range_x
-	reffy = RawRange.new
+  	reffy=RawRange.new
 	reffy.zeromin
-            
-	# prepare models for sweeping
-	sweep_pos= rx.rmin
-	sweep_to = rx.rmax
-      
-	@models.each do | mod|
-	  mod.begin_sweep
-	end
-        
-	# perform the sweep
-	while (sweep_pos<=sweep_to)  
-		acc_y = 0
-		@models.each do | mod, i|
-			acc_y +=  mod.sweep(sweep_pos)
-		end
-		sweep_pos += sweep_interval
-		reffy.update(acc_y)
-	end
+	return cumulative_sweep_round_range_y_generic(reffy)
+  end
+
+  # sweep for an interval with y scale 
+  def cumulative_sweep_round_range_y0
+  	reffy=RawRange.new
+	return cumulative_sweep_round_range_y_generic(reffy)
+  end
+
 
-    return models[0].round_given_y(reffy)
-      
-  end  
-  
   def cumulative_round_range
     
     if @models.length==0
@@ -234,6 +283,37 @@ class GraphModelGroup
     return "No activity" if @emptycaption.nil?
     return @emptycaption
   end
+
+
+private
+
+  # :nodoc:
+  def cumulative_sweep_round_range_y_generic(reffy)
+      
+    rx = effective_round_range_x
+            
+	# prepare models for sweeping
+	sweep_pos= rx.rmin
+	sweep_to = rx.rmax
+      
+	@models.each do | mod|
+	  mod.begin_sweep
+	end
+        
+	# perform the sweep
+	while (sweep_pos<=sweep_to)  
+		acc_y = 0
+		@models.each do | mod, i|
+			acc_y +=  mod.sweep(sweep_pos)
+		end
+		sweep_pos += sweep_interval
+		reffy.update(acc_y)
+	end
+
+    return models[0].round_given_y(reffy)
+      
+  end  
+  
 end
 
 end

data/lib/gerbilcharts/models/presets.rb

@@ -15,8 +15,8 @@ protected
               [20000,5000],  [50000,10000], [100000,25000], [200000,50000],
               [500000,100000],[800000,200000],
               [1000000,200000],[2000000,500000], [3000000,500000], [4000000,1000000],
-              [5000000,1000000],[6000000, 1500000],
-              [10000000,2500000], [20000000,4000000], [50000000, 10000000],
+              [5000000,1000000],[6000000, 1000000], 
+			  [8000000,2000000], [10000000,2000000], [20000000,4000000], [50000000, 10000000],
               [100000000,25000000], [500000000,100000000], 
               [1000000000,250000000] 
             ]

data/lib/gerbilcharts/models/raw_range.rb

@@ -62,6 +62,39 @@ class RawRange  < Presets
     return format_suffix(val)
   end
   
+   # provide labels for raw range
+   # 	assumes ticks = 5
+   # 	yields two items (value,string label)
+   #
+   # 	Usage example:
+   # 	r.each_label do |v,s|
+   # 	  p "Value = #{v} Label String = #{s}"
+   # 	end
+   #
+   def each_label(ticks=4)
+     
+    raise "No data points in model" if @rmax == -1  
+    
+	label_interval = (@rmax-@rmin)/ticks
+    v = @rmin
+    while (v<=@rmax) do
+      yield v, format_suffix(v)    
+      v = v+label_interval
+    end
+   end
+
+  # provide ticks (per label interval)
+  # for raw range simply divide the max and min into ticks
+  def each_tick(ticks=4)
+    
+	  label_interval = (@rmax-@rmin)/ticks
+      v = @rmin
+      while (v<@rmax) do
+        yield v
+        v = v+label_interval
+      end
+  end
+  
   
 end
 

data/lib/gerbilcharts/surfaces/area_surface.rb

@@ -9,8 +9,14 @@ class AreaSurface < Surface
     end
     
     def int_render(g)
-      rx = parent.modelgroup.effective_round_range_x
-      ry = parent.modelgroup.effective_round_range_y0
+
+
+	  range_options_x = parent.get_global_option(:scaling_x,:auto)
+	  range_options_y = parent.get_global_option(:scaling_y,:auto)
+      rx = parent.modelgroup.effective_range_x(range_options_x)
+      ry = parent.modelgroup.effective_range_y(range_options_y)
+
+	  p "range y = #{ry}"
       
       # ajax if used
       if parent.usesAjax?

data/lib/gerbilcharts/surfaces/bar_surface.rb

@@ -35,7 +35,8 @@ class BarSurface < Surface
 	 #p "Spacing =  #{parent.anchor.element_spacing} spacing"
 		  
      # atleast one model is present, chhug along  
-     ry = parent.modelgroup.effective_round_range_y0
+	 range_options_y = parent.get_global_option(:scaling_y,:auto)
+     ry = parent.modelgroup.effective_range_y(range_options_y)
      set_ajaxSurfaceContext(0,ry.rmax,"BAR") if parent.usesAjax?
      
      xpos = @bounds.left + @element_spacing 

data/lib/gerbilcharts/surfaces/grid.rb

@@ -24,13 +24,13 @@ class Grid < GraphElement
     
   protected
     
-    def grid_range_x
-      return parent.modelgroup.effective_round_range_x
-    end
+  def grid_range_x
+     return parent.modelgroup.effective_round_range_x
+  end
     
-    def grid_range_y
-      return parent.modelgroup.effective_round_range_y0
-    end
+  def grid_range_y
+     return parent.modelgroup.effective_round_range_y0
+  end
     
   
 end

data/lib/gerbilcharts/surfaces/impulse_surface.rb

@@ -9,8 +9,10 @@ class ImpulseSurface < Surface
     
     def int_render(g)
       
-      rx = parent.modelgroup.effective_round_range_x
-      ry = parent.modelgroup.effective_round_range_y0
+	  range_options_x = parent.get_global_option(:scaling_x,:auto)
+	  range_options_y = parent.get_global_option(:scaling_y,:auto)
+      rx = parent.modelgroup.effective_range_x(range_options_x)
+      ry = parent.modelgroup.effective_range_y(range_options_y)
       
 	  impulse_width = 2
 	  x2  = scale_x Time.at(0),rx

data/lib/gerbilcharts/surfaces/line_surface.rb

@@ -7,6 +7,7 @@ module GerbilCharts::Surfaces
 # Supported global options
 #
 # [+circle_data_points+]    Draw a solid circle around datapoints
+# [+scaling+]               :auto, :auto_y0
 #
 class LineSurface < Surface
     def initialize(opts={})
@@ -15,8 +16,10 @@ class LineSurface < Surface
     
     def int_render(g)
       
-      rx = parent.modelgroup.effective_round_range_x
-      ry = parent.modelgroup.effective_round_range_y0
+	  range_options_x = parent.get_global_option(:scaling_x,:auto)
+	  range_options_y = parent.get_global_option(:scaling_y,:auto)
+      rx = parent.modelgroup.effective_range_x(range_options_x)
+      ry = parent.modelgroup.effective_range_y(range_options_y)
       
       # ajax if used
       if parent.usesAjax?

data/lib/gerbilcharts/surfaces/surface.rb

@@ -4,6 +4,7 @@ module GerbilCharts::Surfaces
 # Base class for all surfaces (line,bar,pie,area,...)
 #
 class Surface < GraphElement
+
     def initialize(opts={})
       @class = "surfacepanel"
       super(opts)

data/lib/gerbilcharts/surfaces/vertical_axis.rb

@@ -21,10 +21,11 @@ class VerticalAxis < Axis
       
       return if parent.modelgroup.empty?
       
+	  p "axis = #{parent.get_global_option(:scaling_y,false)}"
 	  if @use_cumulative_y
         ry = parent.modelgroup.cumulative_sweep_round_range_y0
 	  else
-      	ry = parent.modelgroup.effective_round_range_y0
+      	ry = parent.modelgroup.effective_range_y(parent.get_global_option(:scaling_y,:auto))
 	  end
 
       ry.each_label do |val,label|

data/lib/gerbilcharts/version.rb

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

data/test/test_noob.rb

@@ -55,7 +55,8 @@ class TestChartsNoob < Test::Unit::TestCase
     mychart.render('/tmp/n_daily_traffic.svg')
     
 	# demo resuses the model in a different view (an area chart this time)
-    myareachart = GerbilCharts::Charts::AreaChart.new( :width => 450, :height => 200, :style => 'brushmetal.css')
+    myareachart = GerbilCharts::Charts::AreaChart.new( :width => 450, :height => 200, :style => 'brushmetal.css',
+		:scaling_y => :auto )
 	myareachart.modelgroup=modelgroup
     myareachart.render('/tmp/n_daily_traffic_area.svg')
 

data/test/test_scaling.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+require 'trafgen'
+
+#  Test scaling options :auto, :auto_0, [min,max]
+
+class TestChartsScaling < Test::Unit::TestCase
+
+
+  # test scaling  
+  def test_scale_1
+ 
+	tend = Time.now
+	tbegin = tend - 3600*24
+
+	# random between 2M and 6M
+	model1 = GerbilCharts::Models::BucketizedTimeSeriesGraphModel.new( "eth0", 3600 )
+	TimeSeriesDataGenerator.new(tbegin,tend,300,2000000, 6000000).each_tuple do |t,v|
+		model1.add(t,v)
+	end
+
+	# random between 4M and 10M
+	model2 = GerbilCharts::Models::BucketizedTimeSeriesGraphModel.new( "wan1", 3600 )
+	TimeSeriesDataGenerator.new(tbegin,tend,300,4000000, 10000000).each_tuple do |t,v|
+		model2.add(t,v)
+	end
+
+    modelgroup = GerbilCharts::Models::GraphModelGroup.new( "External Traffic")
+	modelgroup.add model2
+	modelgroup.add model1
+
+    
+	#  area chart with auto scaling 
+    myareachart = GerbilCharts::Charts::AreaChart.new( :width => 450, :height => 200, :style => 'brushmetal.css',
+		:scaling_y => :auto )
+	myareachart.modelgroup=modelgroup
+    myareachart.render('/tmp/n_scale_auto.svg')
+
+	#  line chart with auto_0 scaling 
+    myareachart = GerbilCharts::Charts::LineChart.new( :width => 450, :height => 200, :style => 'brushmetal.css',
+		:scaling_y => :auto_0 )
+	myareachart.modelgroup=modelgroup
+    myareachart.render('/tmp/n_scale_auto_0.svg')
+
+	#  impulse chart with manual scaling 
+     myareachart = GerbilCharts::Charts::ImpulseChart.new( :width => 450, :height => 200, :style => 'brushmetal.css',
+	 	:scaling_y => [2000000,8000000]  )
+	 myareachart.modelgroup=modelgroup
+     myareachart.render('/tmp/n_scale_manual.svg')
+
+  end   
+
+ 
+   
+end
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gerbilcharts
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors: 
 - Vivek Rajagopalan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-06 00:00:00 +05:30
+date: 2009-06-09 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,6 +47,7 @@ files:
 - test/test_noob.rb
 - test/test_render_string.rb
 - test/test_helper.rb
+- test/test_scaling.rb
 - lib/gerbilcharts.rb
 - lib/gerbilcharts/version.rb
 - lib/gerbilcharts/models.rb
@@ -152,4 +153,5 @@ test_files:
 - test/test_render_string.rb
 - test/test_models.rb
 - test/test_charts.rb
+- test/test_scaling.rb
 - test/test_Scratch.rb