jparker-ruby-googlechart 0.6.2 → 0.6.3

data/CHANGELOG

@@ -20,3 +20,11 @@
 == 0.6.2 2008-11-20
 
 * Fixed axis label encoding to handle +nil+
+
+== 0.6.3 2008-11-23
+
+* Increased speed of Data#normalize
+* Fixed axis label and legend encoding to handle non-Strings
+* Raise ArgumentError if all data sets are empty
+* Fixed auto-scaling of data containing +nil+
+* Redesigned bar grouping (now supports overlapping) [BACKWARDS INCOMPATIBLE]

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('ruby-googlechart', '0.6.1') do |p|
+Echoe.new('ruby-googlechart', '0.6.3') do |p|
   p.description     = 'Ruby wrapper around the Google Charts API'
   p.url             = 'http://github.com/jparker/ruby-googlechart'
   p.author          = 'John Parker'

data/lib/array.rb

@@ -0,0 +1,7 @@
+unless [].respond_to?(:sum)
+  Array.class_eval do
+    def sum
+      inject(0) {|sum, n| sum + n }
+    end
+  end
+end

data/lib/google_chart.rb

@@ -3,6 +3,8 @@ $:.unshift(File.dirname(__FILE__)) unless
 
 require 'cgi'
 
+require 'array'
+
 require 'google_chart/axis'
 require 'google_chart/bar_style'
 require 'google_chart/color'

data/lib/google_chart/axis.rb

@@ -13,7 +13,7 @@ module GoogleChart
       [:x, :y, :r, :t].each do |axis|
         case axes[axis]
         when Array
-          @axis_labels << ("#{idx}:|" + axes[axis].map {|l| CGI::escape(l) if l }.join('|'))
+          @axis_labels << ("#{idx}:|" + axes[axis].map {|l| CGI::escape(l.to_s) }.join('|'))
           @axes << axis
           idx += 1
         when Range

data/lib/google_chart/bar_chart.rb

@@ -1,3 +1,5 @@
+require 'matrix'
+
 module GoogleChart
   class BarChart < AbstractChart
     include Axis
@@ -10,7 +12,7 @@ module GoogleChart
     include Title
     
     @@orientations = {:horizontal => 'h', :vertical => 'v'}
-    @@groupings    = {:grouped    => 'g', :stacked  => 's'}
+    @@groupings    = {:group => 'g', :stack => 's', :overlap => 's'}
     
     attr_writer :orientation, :grouping
     
@@ -18,14 +20,38 @@ module GoogleChart
       self.orientation = arg ? :horizontal : :vertical
     end
     
-    def grouped=(arg)
-      self.grouping = arg ? :grouped : :stacked
-    end
-    
     def chart_type
-      @grouping    ||= :stacked
+      @grouping    ||= :group
       @orientation ||= :vertical
       "cht=b#{@@orientations[@orientation]}#{@@groupings[@grouping]}"
     end
+    
+    private
+    def reduce(data)
+      if @grouping == :overlap
+        # FIXME: This is really ugly!
+        (data.size - 1).downto(1) do |i|
+          data[i].size.times do |j|
+            data[i][j] -= data[0...i].map {|set|
+              set[j].nil? || set[j] < 0 ? 0 : set[j]
+            }.sum
+          end
+        end
+        data
+      else
+        super
+      end
+    end
+    
+    def set_scale
+      if @grouping == :stack
+        if @scale.nil? && !@data.nil?
+          min = [0, @data.map {|set| set.compact.min }.compact.min].max
+          max = Matrix[*@data].column_vectors.map {|v| v.to_a.compact.sum }.max
+          @scale = min..max
+        end
+      end
+      super
+    end
   end
 end

data/lib/google_chart/data.rb

@@ -13,10 +13,14 @@ module GoogleChart
     
     def data=(data)
       @data = data.any? {|e| Array === e } ? data : [data]
+      if @data.all? {|set| set.compact.empty? }
+        raise ArgumentError, 'data must contain at least 1 non-nil value'
+      end
     end
     
     def data
-      'chd=' + send(:"#{encoding}_encode", @data) if @data
+      set_scale
+      'chd=' + send(:"#{encoding}_encode", reduce(@data)) if @data
     end
     
     private
@@ -24,17 +28,22 @@ module GoogleChart
       @encoding ||= :simple
     end
     
-    def scale
-      if @scale.nil?
-        min = [0, @data.map {|set| set.min }.min].min
-        max = @data.map {|set| set.max }.max
+    def set_scale
+      if @scale.nil? && !@data.nil?
+        min = @data.map {|set| set.compact.min }.compact.min
+        min = 0 if min > 0
+        max = @data.map {|set| set.compact.max }.compact.max
         @scale = min..max
       end
       @scale
     end
     
+    def reduce(data)
+      data
+    end
+    
     def normalize(set, encoding_max)
-      min, max = scale.min, scale.max
+      min, max = @scale.first, @scale.last
       if min != max
         set.map {|e| (e.to_f - min) / (max - min) * encoding_max if e }
       else
@@ -49,7 +58,7 @@ module GoogleChart
           when e.nil? then '_'
           when e <= 0 then @@simple[0]
           when e >= @@simple.size then @@simple[-1]
-          else @@simple[e.round]
+          else @@simple[e.floor]
           end
         }.join
       }.join(',')
@@ -62,7 +71,7 @@ module GoogleChart
           when e.nil? then '__'
           when e <= 0 then @@extended[0]
           when e >= @@extended.size then @@extended[-1]
-          else @@extended[e.round]
+          else @@extended[e.floor]
           end
         }.join
       }.join(',')

data/lib/google_chart/legend.rb

@@ -6,7 +6,7 @@ module GoogleChart
     end
     
     def legend=(legend)
-      @legend = [legend].flatten.map {|l| CGI::escape(l) }
+      @legend = [legend].flatten.map {|l| CGI::escape(l.to_s) }
     end
     
     def legend

data/ruby-googlechart.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruby-googlechart}
-  s.version = "0.6.2"
+  s.version = "0.6.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Parker"]
-  s.date = %q{2008-11-12}
+  s.date = %q{2008-11-23}
   s.description = %q{Ruby wrapper around the Google Charts API}
   s.email = %q{jparker@urgetopunt.com}
-  s.extra_rdoc_files = ["CHANGELOG", "lib/google_chart/abstract_chart.rb", "lib/google_chart/axis.rb", "lib/google_chart/bar_chart.rb", "lib/google_chart/bar_style.rb", "lib/google_chart/color.rb", "lib/google_chart/data.rb", "lib/google_chart/grid_line.rb", "lib/google_chart/legend.rb", "lib/google_chart/line_chart.rb", "lib/google_chart/line_style.rb", "lib/google_chart/range_marker.rb", "lib/google_chart/title.rb", "lib/google_chart.rb", "README.rdoc"]
-  s.files = ["CHANGELOG", "lib/google_chart/abstract_chart.rb", "lib/google_chart/axis.rb", "lib/google_chart/bar_chart.rb", "lib/google_chart/bar_style.rb", "lib/google_chart/color.rb", "lib/google_chart/data.rb", "lib/google_chart/grid_line.rb", "lib/google_chart/legend.rb", "lib/google_chart/line_chart.rb", "lib/google_chart/line_style.rb", "lib/google_chart/range_marker.rb", "lib/google_chart/title.rb", "lib/google_chart.rb", "Manifest", "Rakefile", "README.rdoc", "ruby-googlechart.gemspec", "test/google_chart/test_abstract_chart.rb", "test/google_chart/test_axis.rb", "test/google_chart/test_bar_chart.rb", "test/google_chart/test_bar_style.rb", "test/google_chart/test_color.rb", "test/google_chart/test_data.rb", "test/google_chart/test_grid_line.rb", "test/google_chart/test_legend.rb", "test/google_chart/test_line_chart.rb", "test/google_chart/test_line_style.rb", "test/google_chart/test_range_marker.rb", "test/google_chart/test_title.rb", "test/test_google_chart.rb", "test/test_helper.rb"]
+  s.extra_rdoc_files = ["CHANGELOG", "lib/array.rb", "lib/google_chart/abstract_chart.rb", "lib/google_chart/axis.rb", "lib/google_chart/bar_chart.rb", "lib/google_chart/bar_style.rb", "lib/google_chart/color.rb", "lib/google_chart/data.rb", "lib/google_chart/grid_line.rb", "lib/google_chart/legend.rb", "lib/google_chart/line_chart.rb", "lib/google_chart/line_style.rb", "lib/google_chart/range_marker.rb", "lib/google_chart/title.rb", "lib/google_chart.rb", "README.rdoc"]
+  s.files = ["CHANGELOG", "lib/array.rb", "lib/google_chart/abstract_chart.rb", "lib/google_chart/axis.rb", "lib/google_chart/bar_chart.rb", "lib/google_chart/bar_style.rb", "lib/google_chart/color.rb", "lib/google_chart/data.rb", "lib/google_chart/grid_line.rb", "lib/google_chart/legend.rb", "lib/google_chart/line_chart.rb", "lib/google_chart/line_style.rb", "lib/google_chart/range_marker.rb", "lib/google_chart/title.rb", "lib/google_chart.rb", "Manifest", "Rakefile", "README.rdoc", "ruby-googlechart.gemspec", "test/google_chart/test_abstract_chart.rb", "test/google_chart/test_axis.rb", "test/google_chart/test_bar_chart.rb", "test/google_chart/test_bar_style.rb", "test/google_chart/test_color.rb", "test/google_chart/test_data.rb", "test/google_chart/test_grid_line.rb", "test/google_chart/test_legend.rb", "test/google_chart/test_line_chart.rb", "test/google_chart/test_line_style.rb", "test/google_chart/test_range_marker.rb", "test/google_chart/test_title.rb", "test/test_google_chart.rb", "test/test_helper.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/jparker/ruby-googlechart}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Ruby-googlechart", "--main", "README.rdoc"]

data/test/google_chart/test_axis.rb

@@ -49,8 +49,8 @@ class TestAxis < Test::Unit::TestCase
       assert_match(/\bchxl=0:\|foo\+bar\|baz%7Cfroz\b/, @klass.new(:axes => {:x => ['foo bar', 'baz|froz']}).to_url)
     end
     
-    should 'convert nil labels to empty strings' do
-      assert_match(/\bchxl=0:\|foo\|\|bar\b/, @klass.new(:axes => {:x => ['foo', nil, 'bar']}).to_url)
+    should 'convert non-String labels to Strings' do
+      assert_match(/\bchxl=0:\|foo\|\|1\b/, @klass.new(:axes => {:x => ['foo', nil, 1]}).to_url)
     end
   end
   

data/test/google_chart/test_bar_chart.rb

@@ -2,19 +2,94 @@ require File.dirname(__FILE__) + '/../test_helper'
 
 class TestBarChart < Test::Unit::TestCase
   should 'have a default chart type' do
-    assert_match(/\bcht=bvs\b/, GoogleChart::BarChart.new.to_url)
+    assert_match(/\bcht=bvg\b/, GoogleChart::BarChart.new.to_url)
   end
   
   should 'support horizontal orientation' do
-    assert_match(/\bcht=bhs\b/, GoogleChart::BarChart.new(:horizontal => true).to_url)
+    assert_match(/\bcht=bhg\b/, GoogleChart::BarChart.new(:horizontal => true).to_url)
   end
   
-  should 'support grouped grouping' do
-    assert_match(/\bcht=bvg\b/, GoogleChart::BarChart.new(:grouped => true).to_url)
+  should 'support grouping' do
+    assert_match(/\bcht=bvg\b/, GoogleChart::BarChart.new(:grouping => :group).to_url)
   end
   
-  should 'support horizontal orientation and grouped grouping' do
-    assert_match(/\bcht=bhg\b/, GoogleChart::BarChart.new(:horizontal => true, :grouped => true).to_url)
+  should 'support stacking' do
+    assert_match(/\bcht=bvs\b/, GoogleChart::BarChart.new(:grouping => :stack).to_url)
+  end
+  
+  should 'support overlapping as alias for stacking' do
+    assert_match(/\bcht=bvs\b/, GoogleChart::BarChart.new(:grouping => :overlap).to_url)
+  end
+  
+  should 'support horizontal orientation with grouping' do
+    assert_match(/\bcht=bhg\b/, GoogleChart::BarChart.new(:horizontal => true, :grouping => :group).to_url)
+  end
+  
+  should 'support horizontal orientation with stacking' do
+    assert_match(/\bcht=bhs\b/, GoogleChart::BarChart.new(:horizontal => true, :grouping => :stack).to_url)
+  end
+  
+  should 'support horizontal orientation with overlapping' do
+    assert_match(/\bcht=bhs\b/, GoogleChart::BarChart.new(:horizontal => true, :grouping => :overlap).to_url)
+  end
+  
+  context 'data reduction and scaling' do
+    context 'with one data set' do
+      setup { @chart = GoogleChart::BarChart.new(:data => [0,2,3]) }
+      
+      should 'scale normally for grouping' do
+        @chart.grouping = :group
+        assert_match(/\bchd=s:Ao9\b/, @chart.to_url)
+      end
+      
+      should 'scale normally for stacking' do
+        @chart.grouping = :stack
+        assert_match(/\bchd=s:Ao9\b/, @chart.to_url)
+      end
+      
+      should 'scale normally for overlapping' do
+        @chart.grouping = :overlap
+        assert_match(/\bchd=s:Ao9\b/, @chart.to_url)
+      end
+    end
+    
+    context 'with two data sets' do
+      setup { @chart = GoogleChart::BarChart.new(:data => [[0,2,3], [0,4,6]]) }
+      
+      should 'scale normally for grouping' do
+        @chart.grouping = :group
+        assert_match(/\bchd=s:AUe,Ao9\b/, @chart.to_url)
+      end
+      
+      should 'scale based on column sums for stacking' do
+        @chart.grouping = :stack
+        assert_match(/\bchd=s:ANU,Abo\b/, @chart.to_url)
+      end
+      
+      should 'scale based on reduced data for overlapping' do
+        @chart.grouping = :overlap
+        assert_match(/\bchd=s:AUe,AUe\b/, @chart.to_url)
+      end
+    end
+    
+    context 'with three data sets' do
+      setup { @chart = GoogleChart::BarChart.new(:data => [[0,2,3], [0,4,6], [0,6,9]]) }
+      
+      should 'scale normally for grouping' do
+        @chart.grouping = :group
+        assert_match(/\bchd=s:ANU,Abo,Ao9\b/, @chart.to_url)
+      end
+      
+      should 'scale based on column sums for stacking' do
+        @chart.grouping = :stack
+        assert_match(/\bchd=s:AGK,ANU,AUe\b/, @chart.to_url)
+      end
+      
+      should 'scale based on reduced data for overlapping' do
+        @chart.grouping = :overlap
+        assert_match(/\bchd=s:ANU,ANU,AAA\b/, @chart.to_url)
+      end
+    end
   end
   
   should 'include Axis module' do

data/test/google_chart/test_data.rb

@@ -9,18 +9,50 @@ class TestData < Test::Unit::TestCase
     assert_match(/\bchd=s:AB89\b/, @klass.new(:data => [0, 1, 60, 61]).to_url)
   end
   
+  should 'raise an ArgumentError if data set is empty' do
+    assert_raise(ArgumentError, /1 non-nil value/) { @klass.new(:data => []) }
+  end
+  
+  should 'raise an ArgumentError if data set contains only nils' do
+    assert_raise(ArgumentError, /1 non-nil value/) { @klass.new(:data => [nil, nil]) }
+  end
+  
+  should 'not raise an ArgumentError if only one of many data sets contains only nils' do
+    assert_nothing_raised(ArgumentError) { @klass.new(:data => [[nil, nil], [nil, 1]]) }
+  end
+  
+  should 'auto-scale between 0 and maximum value among all data sets' do
+    assert_match(/\bchd=s:67,89\b/, @klass.new(:data => [[58, 59], [60, 61]]).to_url)
+  end
+  
+  should 'be able to auto-scale data sets with nils' do
+    assert_match(/\bchd=s:A_9\b/, @klass.new(:data => [0, nil, 100]).to_url)
+  end
+  
+  should 'be able to auto-scale data sets with one empty set' do
+    assert_match(/\bchd=s:__,A9\b/, @klass.new(:data => [[nil, nil], [0, 100]]).to_url)
+  end
+  
+  should 'encode data with high-pass filter when auto-scaling' do
+    assert_match(/\bchd=s:AAB89\b/, @klass.new(:data => [-1, 0, 1, 60, 61]).to_url)
+  end
+  
+  should 'encode data with band-pass filter when manual-scaling' do
+    assert_match(/\bchd=s:AB899\b/, @klass.new(:data => [-5, -1, 99, 100, 102], :scale => -3..100).to_url)
+  end
+  
   context 'simple encoding' do
     setup { @chart = @klass.new(:encoding => :simple) }
     
     should 'encode dataset with auto-scaling' do
       @chart.data = [0, 15, 10]
-      assert_match(/\bchd=s:A9p\b/, @chart.to_url)
+      assert_match(/\bchd=s:A9o\b/, @chart.to_url)
     end
     
     should 'encode dataset with manual scaling' do
       @chart.data = [0, 15, 10]
       @chart.scale = 0..20
-      assert_match(/\bchd=s:Auf\b/, @chart.to_url)
+      assert_match(/\bchd=s:Ate\b/, @chart.to_url)
     end
     
     should 'encode multiple datasets' do
@@ -30,27 +62,11 @@ class TestData < Test::Unit::TestCase
     end
     
     should 'encode floating point data' do
-      @chart.data = [49.5, 33.4]
+      @chart.data = [50.5, 33.4]
       @chart.scale = 0..61
       assert_match(/\bchd=s:yh\b/, @chart.to_url)
     end
     
-    should 'encode all zeros with "A"' do
-      @chart.data = [0, 0, 0]
-      assert_match(/\bchd=s:AAA\b/, @chart.to_url)
-    end
-    
-    should 'encode unchanging non-zero data with "9"' do
-      @chart.data = [1, 1, 1]
-      assert_match(/\bchd=s:999\b/, @chart.to_url)
-    end
-    
-    should 'encode out-of-bounds data' do
-      @chart.data = [62, 61, 60, 1, 0, -1]
-      @chart.scale = 0..61
-      assert_match(/\bchd=s:998BAA/, @chart.to_url)
-    end
-    
     should 'encode missing data' do
       @chart.data = [50, nil, 33]
       @chart.scale = 0..61
@@ -67,9 +83,9 @@ class TestData < Test::Unit::TestCase
     end
     
     should 'encode dataset with manual scaling' do
-      @chart.data = [0, 15, 10]
+      @chart.data = [15, 10, 0]
       @chart.scale = 0..20
-      assert_match(/\bchd=e:AAv\.gA\b/, @chart.to_url)
+      assert_match(/\bchd=e:v\.f\.AA\b/, @chart.to_url)
     end
     
     should 'encode multiple datasets' do
@@ -79,27 +95,11 @@ class TestData < Test::Unit::TestCase
     end
     
     should 'encode floating point data' do
-      @chart.data = [2281.49, 3232.50]
+      @chart.data = [2281.49, 3233.50]
       @chart.scale = 0..4095
       assert_match(/\bchd=e:jpyh\b/, @chart.to_url)
     end
     
-    should 'encode all zeros with "AA"' do
-      @chart.data = [0, 0, 0]
-      assert_match(/\bchd=e:AAAAAA\b/, @chart.to_url)
-    end
-    
-    should 'encode unchanging non-zero data with ".."' do
-      @chart.data = [1, 1, 1]
-      assert_match(/\bchd=e:\.{6}/, @chart.to_url)
-    end
-    
-    should 'encode out-of-bounds data' do
-      @chart.data = [4096, 4095, 4094, 1, 0, -1]
-      @chart.scale = 0..4095
-      assert_match(/\bchd=e:\.\.\.\.\.-ABAAAA\b/, @chart.to_url)
-    end
-    
     should 'encode missing data' do
       @chart.data = [2281, nil, 3233]
       @chart.scale = 0..4095
@@ -133,22 +133,6 @@ class TestData < Test::Unit::TestCase
       assert_match(/\bchd=t:6,14,5.2\b/, @chart.to_url)
     end
     
-    should 'encode all zeros with "0"' do
-      @chart.data = [0, 0, 0]
-      assert_match(/\bchd=t:0,0,0\b/, @chart.to_url)
-    end
-    
-    should 'encode unchanging non-zero data with "100"' do
-      @chart.data = [1, 1, 1]
-      assert_match(/\bchd=t:100,100,100\b/, @chart.to_url)
-    end
-    
-    should 'encode out-of-bounds data' do
-      @chart.data = [101, 100, 99, 1, 0, -1]
-      @chart.scale = 0..100
-      assert_match(/\bchd=t:100,100,99,1,0,0\b/, @chart.to_url)
-    end
-    
     should 'encode missing data' do
       @chart.data = [6, nil, 14]
       @chart.scale = 0..100

data/test/google_chart/test_legend.rb

@@ -20,4 +20,8 @@ class TestLegend < Test::Unit::TestCase
   should 'escape legend text for url' do
     assert_match(/\bchdl=Foo\+Bar%7CBaz\b/, @klass.new(:legend => 'Foo Bar|Baz').to_url)
   end
+  
+  should 'convert non-String legend keys to Strings' do
+    assert_match(/\bchdl=foo\|\|1\b/, @klass.new(:legend => ['foo', nil, 1]).to_url)
+  end
 end

data/test/test_google_chart.rb

@@ -62,7 +62,7 @@ class TestGoogleChart < Test::Unit::TestCase
       end
       
       should 'include chart type parameter' do
-        assert_match(/\bcht=bvs\b/, @url)
+        assert_match(/\bcht=bvg\b/, @url)
       end
       
       should 'include chart size parameter' do
@@ -88,7 +88,7 @@ class TestGoogleChart < Test::Unit::TestCase
       end
       
       should 'include chart type parameter' do
-        assert_match(/\bcht=bvs\b/, @url)
+        assert_match(/\bcht=bvg\b/, @url)
       end
       
       should 'include chart size parameter' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jparker-ruby-googlechart
 version: !ruby/object:Gem::Version 
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors: 
 - John Parker
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-12 00:00:00 -08:00
+date: 2008-11-23 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -29,6 +29,7 @@ extensions: []
 
 extra_rdoc_files: 
 - CHANGELOG
+- lib/array.rb
 - lib/google_chart/abstract_chart.rb
 - lib/google_chart/axis.rb
 - lib/google_chart/bar_chart.rb
@@ -45,6 +46,7 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - CHANGELOG
+- lib/array.rb
 - lib/google_chart/abstract_chart.rb
 - lib/google_chart/axis.rb
 - lib/google_chart/bar_chart.rb