ruby-googlechart 0.6.4

data/lib/google_chart/grid_line.rb

@@ -0,0 +1,21 @@
+# <URL:http://code.google.com/apis/chart/#grid>
+module GoogleChart
+  module GridLine
+    def self.included(klass)
+      klass.register!(:grid)
+    end
+    
+    @@grid_line_styles  = { :solid => [1,0], :dash => [3,2], :dot => [1,2] }
+    @@default_grid_step = 0
+    
+    def grid=(grid)
+      grid[:x] ||= @@default_grid_step
+      grid[:y] ||= @@default_grid_step
+      @grid = [grid[:x], grid[:y], *@@grid_line_styles[grid[:style]]].compact.join(',')
+    end
+    
+    def grid
+      "chg=#{@grid}" if @grid
+    end
+  end
+end

data/lib/google_chart/legend.rb

@@ -0,0 +1,16 @@
+# <URL:http://code.google.com/apis/chart/#chdl>
+module GoogleChart
+  module Legend
+    def self.included(klass)
+      klass.register!(:legend)
+    end
+    
+    def legend=(legend)
+      @legend = [legend].flatten.map {|l| CGI::escape(l.to_s) }
+    end
+    
+    def legend
+      "chdl=#{@legend.join('|')}" if @legend
+    end
+  end
+end

data/lib/google_chart/line_chart.rb

@@ -0,0 +1,24 @@
+module GoogleChart
+  class LineChart < AbstractChart
+    @@chart_types = { :line => 'lc', :xy => 'lxy', :sparkline => 'ls' }
+    
+    include Axis
+    include Color
+    include Data
+    include GridLine
+    include Legend
+    include LineStyle
+    include RangeMarker
+    include Title
+    
+    def chart_type
+      @chart_type ||= @@chart_types[:line]
+      'cht=' + @chart_type if @chart_type
+    end
+    
+    def chart_type=(chart_type)
+      @chart_type = @@chart_types[chart_type]
+    end
+    alias_method :type=, :chart_type=
+  end
+end

data/lib/google_chart/line_style.rb

@@ -0,0 +1,36 @@
+# <URL:http://code.google.com/apis/chart/#line_styles>
+module GoogleChart
+  module LineStyle
+    def self.included(klass)
+      klass.register!(:style)
+    end
+    
+    @@styles = { :solid => [1,1,0], :dash => [1,3,2], :dot => [1,1,2] }
+    
+    @@default_style = :solid
+    @@default_width = 1
+    
+    def style=(style)
+      @style = [style].flatten
+    end
+    
+    def width=(width)
+      @width = [width].flatten
+    end
+    
+    def style
+      @style ||= []
+      @width ||= []
+      
+      # Pad @style and @width with defaults until they are equal in length
+      (@style.size - @width.size).times { @width << @@default_width }
+      (@width.size - @style.size).times { @style << @@default_style }
+      
+      unless @style.empty?
+        'chls=' + (0...@style.size).map {|i|
+          @@styles[@style[i]].map {|n| n * @width[i] }.join(',')
+        }.join('|')
+      end
+    end
+  end
+end

data/lib/google_chart/range_marker.rb

@@ -0,0 +1,26 @@
+# <URL:http://code.google.com/apis/chart/#hor_line_marker>
+module GoogleChart
+  module RangeMarker
+    def self.included(klass)
+      klass.register!(:ranges)
+    end
+    
+    @@range_marker_orientations = { :h => 'r', :v => 'R' }
+    
+    def ranges=(ranges)
+      @ranges = ranges.any? {|e| e.is_a?(Array) } ? ranges : [ranges]
+    end
+    
+    def ranges
+      unless @ranges.nil? || @ranges.empty?
+        'chm=' + @ranges.collect {|r|
+          r[0] = @@range_marker_orientations[r[0]]
+          r[1..-1] = ['000000cc', *r[1..-1]] if r.size == 3
+          # The middle parameter is required by Google Charts but ignored for range markers
+          r = r[0..1] + ['x'] + r[2..-1]
+          r.join(',')
+        }.join('|')
+      end
+    end
+  end
+end

data/lib/google_chart/title.rb

@@ -0,0 +1,16 @@
+# <URL:http://code.google.com/apis/chart/#chtt>
+module GoogleChart
+  module Title
+    def self.included(klass)
+      klass.register!(:title)
+    end
+    
+    def title=(title)
+      @title = CGI::escape(title)
+    end
+    
+    def title
+      "chtt=#{@title}" if @title
+    end
+  end
+end

data/ruby-googlechart.gemspec

@@ -0,0 +1,90 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ruby-googlechart}
+  s.version = "0.6.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Parker"]
+  s.date = %q{2009-11-15}
+  s.description = %q{ruby-googlechart is yet another wrapper around the Google Charts API}
+  s.email = %q{jparker@urgetopunt.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/array.rb",
+     "lib/google_chart.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",
+     "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.homepage = %q{http://github.com/jparker/ruby-googlechart}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby wrapper around the Google Charts API}
+  s.test_files = [
+    "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"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+

data/test/google_chart/test_abstract_chart.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class TestAbstractChart < Test::Unit::TestCase
+  should 'require descendent classes to define #chart_type method' do
+    klass = Class.new(GoogleChart::AbstractChart)
+    assert_raise(NoMethodError, /chart_type/) { klass.new.to_url }
+    
+    klass.class_eval { def chart_type() end }
+    assert_nothing_raised { klass.new.to_url }
+  end
+  
+  should 'allow descendent classes to maintain distinct parameter registries' do
+    klass = Class.new(GoogleChart::AbstractChart)
+    another_klass = Class.new(GoogleChart::AbstractChart)
+    assert_not_same(another_klass.registry, klass.registry)
+  end
+  
+  should 'begin URLs with Google Charts base URL' do
+    assert_match(%r{\Ahttp://chart\.apis\.google\.com/chart\?}, Class.new(MockChart).new.to_url)
+  end
+  
+  should 'have a default chart size' do
+    assert_match(/\bchs=600x500\b/, Class.new(MockChart).new.to_url)
+  end
+  
+  should 'accept custom chart sizes' do
+    assert_match(/\bchs=800x375\b/, Class.new(MockChart).new(:size => '800x375').to_url)
+  end
+end

data/test/google_chart/test_axis.rb

@@ -0,0 +1,74 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class TestAxis < Test::Unit::TestCase
+  def setup
+    @klass = Class.new(MockChart).class_eval { include GoogleChart::Axis }
+  end
+  
+  should 'not display axis parameter by default' do
+    url = @klass.new.to_url
+    assert_no_match(/\bchx[lrt]=/, url)
+  end
+  
+  context 'axis types' do
+    should 'display bottom x-axis' do
+      assert_match(/\bchxt=x\b/, @klass.new(:axes => {:x => true}).to_url)
+    end
+    
+    should 'display top x-axis' do
+      assert_match(/\bchxt=t\b/, @klass.new(:axes => {:t => true}).to_url)
+    end
+    
+    should 'display left y-axis' do
+      assert_match(/\bchxt=y\b/, @klass.new(:axes => {:y => true}).to_url)
+    end
+    
+    should 'display right y-axis' do
+      assert_match(/\bchxt=r\b/, @klass.new(:axes => {:r => true}).to_url)
+    end
+    
+    should 'display multiple axes' do
+      assert_match(/\bchxt=x,y,r\b/, @klass.new(:axes => {:x => true, :y => true, :r => true}).to_url)
+    end
+  end
+  
+  context 'axis labels' do
+    should 'dsiplay enumerated axis labels' do
+      assert_match(/\bchxt=x&chxl=0:\|foo\|bar\|baz\b/, @klass.new(:axes => {:x => %w[foo bar baz]}).to_url)
+    end
+    
+    should 'display enumerated axis labels for multiple axes' do
+      assert_match(/\bchxt=x,y&chxl=0:\|foo\|bar\|baz\|1:\|0\|5\|10\b/, @klass.new(:axes => {:x => %w[foo bar baz], :y => %w[0 5 10]}).to_url)
+    end
+    
+    should 'display enumerated axis labels for subset of axes' do
+      assert_match(/\bchxt=x,y,r&chxl=0:\|foo\|bar\|2:\|baz\|froz\b/, @klass.new(:axes => {:x => %w[foo bar], :y => true, :r => %w[baz froz]}).to_url)
+    end
+    
+    should 'escape axis labels for url' do
+      assert_match(/\bchxl=0:\|foo\+bar\|baz%7Cfroz\b/, @klass.new(:axes => {:x => ['foo bar', 'baz|froz']}).to_url)
+    end
+    
+    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
+  
+  context 'axis ranges' do
+    should 'dsiplay axis label ranges' do
+      assert_match(/\bchxt=x&chxr=0,8,16/, @klass.new(:axes => {:x => 8..16}).to_url)
+    end
+    
+    should 'display multiple axis label ranges' do
+      assert_match(/\bchxt=x,y&chxr=0,6,14\|1,5,23\b/, @klass.new(:axes => {:x => 6..14, :y => 5..23}).to_url)
+    end
+    
+    should 'display axis label ranges for subset of axes' do
+      assert_match(/\bchxr=0,0,5\|2,0,100\b/, @klass.new(:axes => {:x => 0..5, :y => true, :r => 0..100}).to_url)
+    end
+  end
+  
+  should 'display multiple types of axis labels' do
+    assert_match(/\bchxt=x,y,r&chxl=0:\|foo\|bar\|baz&chxr=2,5,23\b/, @klass.new(:axes => {:x => %w[foo bar baz], :y => true, :r => 5..23}).to_url)
+  end
+end

data/test/google_chart/test_bar_chart.rb

@@ -0,0 +1,126 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class TestBarChart < Test::Unit::TestCase
+  should 'have a default chart type' do
+    assert_match(/\bcht=bvg\b/, GoogleChart::BarChart.new.to_url)
+  end
+  
+  should 'support horizontal orientation' do
+    assert_match(/\bcht=bhg\b/, GoogleChart::BarChart.new(:horizontal => true).to_url)
+  end
+  
+  should 'support grouping' do
+    assert_match(/\bcht=bvg\b/, GoogleChart::BarChart.new(:grouping => :group).to_url)
+  end
+  
+  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
+    assert GoogleChart::Axis === GoogleChart::BarChart.new
+  end
+  
+  should 'include BarStyle module' do
+    assert GoogleChart::BarStyle === GoogleChart::BarChart.new
+  end
+  
+  should 'include Color module' do
+    assert GoogleChart::Color === GoogleChart::BarChart.new
+  end
+  
+  should 'include Data module' do
+    assert GoogleChart::Data === GoogleChart::BarChart.new
+  end
+  
+  should 'include GridLine module' do
+    assert GoogleChart::GridLine === GoogleChart::BarChart.new
+  end
+  
+  should 'include Legend module' do
+    assert GoogleChart::Legend === GoogleChart::BarChart.new
+  end
+  
+  should 'include RangeMarker module' do
+    assert GoogleChart::RangeMarker === GoogleChart::BarChart.new
+  end
+  
+  should 'include Title module' do
+    assert GoogleChart::Title === GoogleChart::BarChart.new
+  end
+end