jparker-ruby-googlechart 0.5.0

data/History.txt

@@ -0,0 +1,6 @@
+== 0.0.1 2008-05-14
+
+* 1 major enhancement:
+  * Initial release
+  * Bar chart support
+  * Line chart support

data/Manifest.txt

@@ -0,0 +1,52 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+TODO.txt
+config/hoe.rb
+config/requirements.rb
+lib/google_chart.rb
+lib/google_chart/axes.rb
+lib/google_chart/bar.rb
+lib/google_chart/bar_styles.rb
+lib/google_chart/base.rb
+lib/google_chart/colors.rb
+lib/google_chart/data.rb
+lib/google_chart/grid_lines.rb
+lib/google_chart/legends.rb
+lib/google_chart/line.rb
+lib/google_chart/line_styles.rb
+lib/google_chart/range_markers.rb
+lib/google_chart/sizes.rb
+lib/google_chart/titles.rb
+ruby-googlechart.gemspec
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/google_chart/test_axes.rb
+test/google_chart/test_bar.rb
+test/google_chart/test_bar_styles.rb
+test/google_chart/test_base.rb
+test/google_chart/test_colors.rb
+test/google_chart/test_data.rb
+test/google_chart/test_grid_lines.rb
+test/google_chart/test_legends.rb
+test/google_chart/test_line.rb
+test/google_chart/test_line_styles.rb
+test/google_chart/test_range_markers.rb
+test/google_chart/test_sizes.rb
+test/google_chart/test_titles.rb
+test/test_google_chart.rb
+test/test_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/README.txt

@@ -0,0 +1,65 @@
+= ruby-googlechart
+
+* http://github.com/jparker/ruby-googlechart
+
+== DESCRIPTION:
+
+ruby-googlechart is a ruby library which provides object-oriented
+access to the Google Charts API.
+
+This library has largely been done as an exercise. These other ruby
+libraries are more mature and may be better suited to your needs:
+
+* http://googlecharts.rubyforge.org/
+* http://code.google.com/p/gchartrb/
+
+== FEATURES/PROBLEMS:
+
+* Limited support for Line and Bar charts
+
+== SYNOPSIS:
+  
+  url = GoogleChart.Line(:data => [1, nil, 2, 8, 1])
+  
+  url = GoogleChart.Line do |c|
+    c.type     = :line
+    c.size     = '800x375'
+    c.data     = [335, 285, 240, 220, 160, 175, 200, 205]
+    c.scale    = 0..400
+    c.encoding = :extended
+    c.title    = 'Chart Title'
+  end
+
+== REQUIREMENTS:
+
+* newgem >= 1.0.3
+* hoe >= 1.8.0
+
+== INSTALL:
+
+* sudo gem install jparker-ruby-googlechart -s http://gems.github.com/
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 John Parker
+
+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,25 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/google_chart'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('ruby-googlechart', GoogleChart::VERSION) do |p|
+  p.developer('John Parker', 'jparker@urgetopunt.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+

data/lib/google_chart/axes.rb

@@ -0,0 +1,40 @@
+# <URL:http://code.google.com/apis/chart/#multiple_axes_labels>
+module GoogleChart
+  module Axes
+    def self.included(klass)
+      klass.register!(:axes)
+    end
+    
+    # TODO: Add support for axis label positions/styles, support for multiple label sets per axis
+    
+    def axes
+      unless @axes.nil? || @axes.empty?
+        [
+          'chxt=' + @axes.join(','),
+          @axis_labels.empty? ? nil : 'chxl=' + @axis_labels.join('|'),
+          @axis_ranges.empty? ? nil : 'chxr=' + @axis_ranges.join('|')
+        ].compact.join('&')
+      end
+    end
+    
+    def axes=(axes)
+      idx = 0
+      @axes, @axis_labels, @axis_ranges = [], [], []
+      [:x, :y, :r, :t].each do |axis|
+        case axes[axis]
+        when Array
+          @axis_labels << ("#{idx}:|" + axes[axis].collect {|l| CGI::escape(l) }.join('|'))
+          @axes << axis
+          idx += 1
+        when Range
+          @axis_ranges << ("#{idx},#{axes[axis].first},#{axes[axis].last}")
+          @axes << axis
+          idx += 1
+        when true
+          @axes << axis
+          idx += 1
+        end
+      end
+    end
+  end
+end

data/lib/google_chart/bar.rb

@@ -0,0 +1,27 @@
+module GoogleChart
+  class Bar < Base
+    include Axes
+    include BarStyles
+    include Colors
+    include Data
+    include GridLines
+    include Legends
+    include RangeMarkers
+    include Sizes
+    include Titles
+    
+    attr_writer :horizontal, :grouped
+    
+    def chart_type
+      'cht=b' + (horizontal? ? 'h' : 'v') + (grouped? ? 'g' : 's')
+    end
+    
+    def horizontal?
+      @horizontal
+    end
+    
+    def grouped?
+      @grouped
+    end
+  end
+end

data/lib/google_chart/bar_styles.rb

@@ -0,0 +1,25 @@
+# <URL:http://code.google.com/apis/chart/#bar_width>
+module GoogleChart
+  module BarStyles
+    def self.included(klass)
+      klass.register!(:style)
+    end
+    
+    attr_writer :width
+    
+    def style
+      "chbh=#{[@width, *@spacing].compact.join(',')}" if @width
+    end
+    
+    # Spacing can be given as a single number for space between bars within a
+    # group or as an array of numbers with the first element as the space
+    # between bars within a group and the second element as the space between
+    # groups. If not provided, the default spacing between groups is 8 pixels.
+    # 
+    # TODO: Should we raise an error if bar spacing is greater than group
+    # spacing? This would visually group bars from different groups.
+    def spacing=(spacing)
+      @spacing = [spacing].flatten
+    end
+  end
+end

data/lib/google_chart/base.rb

@@ -0,0 +1,42 @@
+module GoogleChart
+  class Base
+    @@base_url = 'http://chart.apis.google.com/chart'
+    
+    def initialize(options = {})
+      options.each {|key, value| send("#{key}=", value) }
+      yield self if block_given?
+    end
+    
+    def self.inherited(klass)
+      klass.class_eval do
+        class_variable_set(:@@parameters, [])
+        register!(:chart_type)
+      end
+    end
+    
+    def self.register!(*parameters)
+      parameters.each do |parameter|
+        registry.push(parameter) unless registered?(parameter)
+      end
+    end
+    
+    def self.registered?(parameter)
+      registry.include?(parameter)
+    end
+    
+    def self.registry
+      class_variable_get :@@parameters
+    end
+    
+    # Collect all of the registered chart parameters and join them together
+    # to form the URL for the chart to be generated.
+    def to_url
+      "#{@@base_url}?#{query_string}"
+    end
+    
+    private
+    def query_string
+      self.class.registry.map {|m| send(m) }.compact.join('&')
+    end
+  end
+end

data/lib/google_chart/colors.rb

@@ -0,0 +1,14 @@
+# <URL:http://code.google.com/apis/chart/#line_bar_pie_colors>
+module GoogleChart
+  module Colors
+    def self.included(klass)
+      klass.register!(:color)
+    end
+    
+    attr_writer :color
+    
+    def color
+      'chco=' + [@color].flatten.join(',') if @color
+    end
+  end
+end

data/lib/google_chart/data.rb

@@ -0,0 +1,91 @@
+# <URL:http://code.google.com/apis/chart/#chart_data>
+module GoogleChart
+  module Data
+    def self.included(klass)
+      klass.register!(:data)
+    end
+    
+    attr_writer :encoding, :scale
+    
+    @@simple_encoding   = ('A'..'Z').to_a + ('a'..'z').to_a + ('0'..'9').to_a
+    @@extended_alphabet = ('A'..'Z').to_a + ('a'..'z').to_a + ('0'..'9').to_a + %w[- .]
+    @@extended_encoding = @@extended_alphabet.collect {|a|
+      @@extended_alphabet.collect {|b| a + b }
+    }.flatten
+    
+    def data
+      'chd=' + send(:"#{encoding}_encode", @data) if @data
+    end
+    
+    def data=(data)
+      @data = data.any? {|e| e.is_a?(Array) } ? data : [data]
+    end
+    
+    private
+    def encoding
+      @encoding || :simple
+    end
+    
+    def scale?
+      @scale
+    end
+    
+    def scale_set(set, range)
+      if scale?
+        min, max = set.min, set.max
+        if min < 0
+          set.collect! {|n| n - min }
+          max -= min
+        end
+        set.collect {|n| (n * range).to_f / max if n }
+      else
+        set
+      end
+    end
+    
+    def simple_encode(data)
+      's:' + data.collect {|set|
+        scale_set(set, @@simple_encoding.size - 1).collect {|n|
+          case
+          when n.nil? then '_'
+          when n <= 0 then @@simple_encoding[0]
+          when n >= @@simple_encoding.size then @@simple_encoding[-1]
+          else @@simple_encoding[n.round]
+          end
+        }.join
+      }.join(',')
+    end
+    
+    def extended_encode(data)
+      'e:' + data.collect {|set|
+        scale_set(set, @@extended_encoding.size - 1).collect {|n|
+          case
+          when n.nil? then '__'
+          when n <= 0 then @@extended_encoding[0]
+          when n >= @@extended_encoding.size then @@extended_encoding[-1]
+          else @@extended_encoding[n.round]
+          end
+        }.join
+      }.join(',')
+    end
+    
+    def text_encode(data)
+      't:' + data.collect {|set|
+        scale_set(set, 100).collect {|n|
+          case
+          when n.nil? then -1
+          when n < 0 then 0
+          when n > 100 then 100
+          else
+            # More than one decimal place yields negligible resolution at the
+            # potentially great cost of one extra character in the URL. Avoid
+            # this by rounding to the nearest tenth. Further round down to an
+            # integer when possible to save the extra two characters (".0").
+            m = (n * 10).round
+            m / (m % 10 == 0 ? 10 : 10.0)
+          end
+        }.join(',')
+      }.join('|')
+    end
+  end
+end

data/lib/google_chart/grid_lines.rb

@@ -0,0 +1,21 @@
+# <URL:http://code.google.com/apis/chart/#grid>
+module GoogleChart
+  module GridLines
+    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
+      'chg=' + @grid if @grid
+    end
+    
+    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
+  end
+end

data/lib/google_chart/legends.rb

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

data/lib/google_chart/line.rb

@@ -0,0 +1,24 @@
+module GoogleChart
+  class Line < Base
+    @@chart_types = { :line => 'lc', :xy => 'lxy', :sparkline => 'ls' }
+    
+    include Axes
+    include Colors
+    include Data
+    include GridLines
+    include Legends
+    include LineStyles
+    include RangeMarkers
+    include Sizes
+    include Titles
+    
+    def chart_type
+      @chart_type ||= @@chart_types[:line]
+      'cht=' + @chart_type if @chart_type
+    end
+    
+    def type=(chart_type)
+      @chart_type = @@chart_types[chart_type]
+    end
+  end
+end

data/lib/google_chart/line_styles.rb

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

data/lib/google_chart/range_markers.rb

@@ -0,0 +1,26 @@
+# <URL:http://code.google.com/apis/chart/#hor_line_marker>
+module GoogleChart
+  module RangeMarkers
+    def self.included(klass)
+      klass.register!(:ranges)
+    end
+    
+    @@range_marker_orientations = { :h => 'r', :v => 'R' }
+    
+    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
+    
+    def ranges=(ranges)
+      @ranges = ranges.any? {|e| e.is_a?(Array) } ? ranges : [ranges]
+    end
+  end
+end

data/lib/google_chart/sizes.rb

@@ -0,0 +1,16 @@
+# <URL:http://code.google.com/apis/chart/#chart_size>
+module GoogleChart
+  module Sizes
+    def self.included(klass)
+      klass.register!(:size)
+    end
+    
+    attr_writer :size
+    
+    @@default_size = '600x500'
+    
+    def size
+      'chs=' + (@size ? @size : @@default_size)
+    end
+  end
+end

data/lib/google_chart/titles.rb

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

data/lib/google_chart.rb

@@ -0,0 +1,29 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'google_chart/axes'
+require 'google_chart/bar_styles'
+require 'google_chart/colors'
+require 'google_chart/data'
+require 'google_chart/grid_lines'
+require 'google_chart/legends'
+require 'google_chart/line_styles'
+require 'google_chart/range_markers'
+require 'google_chart/sizes'
+require 'google_chart/titles'
+
+require 'google_chart/base'
+require 'google_chart/bar'
+require 'google_chart/line'
+
+module GoogleChart
+  VERSION = '0.5.0'
+  
+  def self.Line(options = {}, &block)
+    GoogleChart::Line.new(options, &block).to_url
+  end
+  
+  def self.Bar(options = {}, &block)
+    GoogleChart::Bar.new(options, &block).to_url
+  end
+end

data/test/google_chart/test_axes.rb

@@ -0,0 +1,70 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class TestAxes < Test::Unit::TestCase
+  def setup
+    @klass = Class.new(MockChart).class_eval { include GoogleChart::Axes }
+  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
+  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.rb

@@ -0,0 +1,55 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class TestBar < Test::Unit::TestCase
+  should 'have a default chart type' do
+    assert_match(/\bcht=bvs\b/, GoogleChart::Bar.new.to_url)
+  end
+  
+  should 'support horizontal orientation' do
+    assert_match(/\bcht=bhs\b/, GoogleChart::Bar.new(:horizontal => true).to_url)
+  end
+  
+  should 'support grouped grouping' do
+    assert_match(/\bcht=bvg\b/, GoogleChart::Bar.new(:grouped => true).to_url)
+  end
+  
+  should 'support horizontal orientation and grouped grouping' do
+    assert_match(/\bcht=bhg\b/, GoogleChart::Bar.new(:horizontal => true, :grouped => true).to_url)
+  end
+  
+  should 'include Axes module' do
+    assert GoogleChart::Axes === GoogleChart::Bar.new
+  end
+  
+  should 'include BarStyles module' do
+    assert GoogleChart::BarStyles === GoogleChart::Bar.new
+  end
+  
+  should 'include Colors module' do
+    assert GoogleChart::Colors === GoogleChart::Bar.new
+  end
+  
+  should 'include Data module' do
+    assert GoogleChart::Data === GoogleChart::Bar.new
+  end
+  
+  should 'include GridLines module' do
+    assert GoogleChart::GridLines === GoogleChart::Bar.new
+  end
+  
+  should 'include Legends module' do
+    assert GoogleChart::Legends === GoogleChart::Bar.new
+  end
+  
+  should 'include RangeMarkers module' do
+    assert GoogleChart::RangeMarkers === GoogleChart::Bar.new
+  end
+  
+  should 'include Sizes module' do
+    assert GoogleChart::Sizes === GoogleChart::Bar.new
+  end
+  
+  should 'include Titles module' do
+    assert GoogleChart::Titles === GoogleChart::Bar.new
+  end
+end

data/test/google_chart/test_bar_styles.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class TestBarStyles < Test::Unit::TestCase
+  def setup
+    @klass = Class.new(MockChart).class_eval { include GoogleChart::BarStyles }
+  end
+  
+  should 'not display bar style parameter by default' do
+    assert_no_match(/\bchbh=/, @klass.new.to_url)
+  end
+  
+  should 'display with custom bar width' do
+    assert_match(/\bchbh=10\b/, @klass.new(:width => 10).to_url)
+  end
+  
+  should 'display with custom bar width and spacing' do
+    assert_match(/\bchbh=8,6\b/, @klass.new(:width => 8, :spacing => 6).to_url)
+  end
+  
+  should 'display with custom bar width, spacing and group spacing' do
+    assert_match(/\bchbh=10,4,12\b/, @klass.new(:width => 10, :spacing => [4,12]).to_url)
+  end
+end

data/test/google_chart/test_base.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class TestBase < Test::Unit::TestCase
+  should 'require descendent classes to define #chart_type method' do
+    klass = Class.new(GoogleChart::Base)
+    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::Base)
+    another_klass = Class.new(GoogleChart::Base)
+    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
+end

data/test/google_chart/test_colors.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class TestColors < Test::Unit::TestCase
+  def setup
+    @klass = Class.new(MockChart).class_eval { include GoogleChart::Colors }
+  end
+  
+  should 'not display color parameter by default' do
+    assert_no_match(/\bchco=/, @klass.new.to_url)
+  end
+  
+  should 'display single color parameter' do
+    assert_match(/\bchco=ff0000\b/, @klass.new(:color => 'ff0000').to_url)
+  end
+  
+  should 'display multiple color parameters' do
+    assert_match(/\bchco=ff0000,00ff00,0000ff\b/, @klass.new(:color => %w[ff0000 00ff00 0000ff]).to_url)
+  end
+  
+  should 'convert 3-digit colors to 6-digit colors'
+end

data/test/google_chart/test_data.rb

@@ -0,0 +1,81 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class TestData < Test::Unit::TestCase
+  def setup
+    @klass = Class.new(MockChart).class_eval { include GoogleChart::Data }
+  end
+  
+  should 'use simple encoding by default' do
+    assert_match(/\bchd=s:AB89\b/, @klass.new(:data => [0,1,60,61]).to_url)
+  end
+  
+  context 'simple encoding' do
+    should 'encode single dataset' do
+      assert_match(/\bchd=s:Af9\b/, @klass.new(:data => [0, 31, 61], :encoding => :simple).to_url)
+    end
+    
+    should 'encode multiple datasets' do
+      assert_match(/\bchd=s:JP,YH\b/, @klass.new(:data => [[9, 15], [24, 7]], :encoding => :simple).to_url)
+    end
+    
+    should 'encode missing data' do
+      assert_match(/\bchd=s:y_h\b/, @klass.new(:data => [50, nil, 33], :encoding => :simple).to_url)
+    end
+    
+    should 'encode floating point data' do
+      assert_match(/\bchd=s:yh\b/, @klass.new(:data => [49.5, 33.4], :encoding => :simple).to_url)
+    end
+    
+    should 'scale data based on maximum value by default'
+    
+    should 'scale data using custom scale'
+  end
+  
+  context 'extended encoding' do
+    should 'encode single dataset' do
+      assert_match(/\bchd=e:AA\.\.gA\b/, @klass.new(:data => [0, 4095, 2048], :encoding => :extended).to_url)
+    end
+    
+    should 'encode multiple datasets' do
+      assert_match(/\bchd=e:jpyh,JPYH\b/, @klass.new(:data => [[2281, 3233], [591, 1543]], :encoding => :extended).to_url)
+    end
+    
+    should 'encode missing data' do
+      assert_match(/\bchd=e:jp__yh\b/, @klass.new(:data => [2281, nil, 3233], :encoding => :extended).to_url)
+    end
+    
+    should 'encode floating point data' do
+      assert_match(/\bchd=e:jpyh\b/, @klass.new(:data => [2281.4, 3232.5], :encoding => :extended).to_url)
+    end
+    
+    should 'scale data based on maximum value by default'
+    
+    should 'scale data using custom scale'
+  end
+  
+  context 'text encoding' do
+    should 'encode single dataset' do
+      assert_match(/\bchd=t:6,14,5.2\b/, @klass.new(:data => [6, 14, 5.23], :encoding => :text).to_url)
+    end
+    
+    should 'encode multiple datasets' do
+      assert_match(/\bchd=t:6,14\|5,23\b/, @klass.new(:data => [[6, 14], [5, 23]], :encoding => :text).to_url)
+    end
+    
+    should 'encode missing data' do
+      assert_match(/\bchd=t:6,-1,14\b/, @klass.new(:data => [6, nil, 14], :encoding => :text).to_url)
+    end
+    
+    should 'round floating point data to nearest 10th' do
+      assert_match(/\bchd=t:6.1,8.2\b/, @klass.new(:data => [6.14, 8.16], :encoding => :text).to_url)
+    end
+    
+    should 'round floating point data to nearest integer when possible' do
+      assert_match(/\bchd=t:6,14\b/, @klass.new(:data => [5.95, 14.04], :encoding => :text).to_url)
+    end
+    
+    should 'scale data based on maximum value by default'
+    
+    should 'scale data using custom scale'
+  end
+end

data/test/google_chart/test_grid_lines.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class TestGridLines < Test::Unit::TestCase
+  def setup
+    @klass = Class.new(MockChart).class_eval { include GoogleChart::GridLines }
+  end
+  
+  should 'not display grid lines by default' do
+    assert_no_match(/\bchg=/, @klass.new.to_url)
+  end
+  
+  should 'display vertical grid lines' do
+    assert_match(/\bchg=5,0\b/, @klass.new(:grid => {:x => 5}).to_url)
+  end
+  
+  should 'display horizontal grid lines' do
+    assert_match(/\bchg=0,5\b/, @klass.new(:grid => {:y => 5}).to_url)
+  end
+  
+  should 'display horizontal and vertical grid lines' do
+    assert_match(/\bchg=6,14\b/, @klass.new(:grid => {:x => 6, :y => 14}).to_url)
+  end
+  
+  should 'display solid grid lines' do
+    assert_match(/\bchg=8,16,1,0\b/, @klass.new(:grid => {:x => 8, :y => 16, :style => :solid}).to_url)
+  end
+  
+  should 'display dashed grid lines' do
+    assert_match(/\bchg=8,16,3,2\b/, @klass.new(:grid => {:x => 8, :y => 16, :style => :dash}).to_url)
+  end
+  
+  should 'display dotted grid lines' do
+    assert_match(/\bchg=8,16,1,2\b/, @klass.new(:grid => {:x => 8, :y => 16, :style => :dot}).to_url)
+  end
+end

data/test/google_chart/test_legends.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class TestLegends < Test::Unit::TestCase
+  def setup
+    @klass = Class.new(MockChart).class_eval { include GoogleChart::Legends }
+  end
+  
+  should 'not display legend by default' do
+    assert_no_match(/\bchdl=/, @klass.new.to_url)
+  end
+  
+  should 'display legend for single dataset' do
+    assert_match(/\bchdl=Foo\b/, @klass.new(:legend => 'Foo').to_url)
+  end
+  
+  should 'display legend for multiple datasets' do
+    assert_match(/\bchdl=Foo\|Bar\|Baz\b/, @klass.new(:legend => %w[Foo Bar Baz]).to_url)
+  end
+  
+  should 'escape legend text for url' do
+    assert_match(/\bchdl=Foo\+Bar%7CBaz\b/, @klass.new(:legend => 'Foo Bar|Baz').to_url)
+  end
+end

data/test/google_chart/test_line.rb

@@ -0,0 +1,55 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class TestLine < Test::Unit::TestCase
+  should 'have a default chart type' do
+    assert_match(/\bcht=lc\b/, GoogleChart::Line.new.to_url)
+  end
+  
+  should 'support xy chart type' do
+    assert_match(/\bcht=lxy\b/, GoogleChart::Line.new(:type => :xy).to_url)
+  end
+  
+  should 'support sparkline chart type' do
+    assert_match(/\bcht=ls\b/, GoogleChart::Line.new(:type => :sparkline).to_url)
+  end
+  
+  should 'support line as chart type' do
+    assert_match(/\bcht=lc\b/, GoogleChart::Line.new(:type => :line).to_url)
+  end
+  
+  should 'include Axes module' do
+    assert GoogleChart::Axes === GoogleChart::Line.new
+  end
+  
+  should 'include Colors module' do
+    assert GoogleChart::Colors === GoogleChart::Line.new
+  end
+  
+  should 'include Data module' do
+    assert GoogleChart::Data === GoogleChart::Line.new
+  end
+  
+  should 'include GridLines module' do
+    assert GoogleChart::GridLines === GoogleChart::Line.new
+  end
+  
+  should 'include Legends module' do
+    assert GoogleChart::Legends === GoogleChart::Line.new
+  end
+  
+  should 'include LineStyles module' do
+    assert GoogleChart::LineStyles === GoogleChart::Line.new
+  end
+  
+  should 'include RangeMarkers module' do
+    assert GoogleChart::RangeMarkers === GoogleChart::Line.new
+  end
+  
+  should 'include Sizes module' do
+    assert GoogleChart::Sizes === GoogleChart::Line.new
+  end
+  
+  should 'include Titles module' do
+    assert GoogleChart::Titles === GoogleChart::Line.new
+  end
+end

data/test/google_chart/test_line_styles.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class TestLineStyles < Test::Unit::TestCase
+  def setup
+    @klass = Class.new(MockChart).class_eval { include GoogleChart::LineStyles }
+  end
+  
+  should 'not include line styles by default' do
+    assert_no_match(/\bchls=/, @klass.new.to_url)
+  end
+  
+  should 'support solid lines' do
+    assert_match(/\bchls=1,1,0\b/, @klass.new(:style => :solid).to_url)
+  end
+  
+  should 'support dashed lines' do
+    assert_match(/\bchls=1,3,2\b/, @klass.new(:style => :dash).to_url)
+  end
+  
+  should 'support dotted lines' do
+    assert_match(/\bchls=1,1,2\b/, @klass.new(:style => :dot).to_url)
+  end
+  
+  should 'support multiple line styles' do
+    assert_match(/\bchls=1,3,2\|1,1,2\|1,1,0\b/, @klass.new(:style => [:dash, :dot, :solid]).to_url)
+  end
+  
+  should 'support custom line width' do
+    assert_match(/\bchls=2,2,0\b/, @klass.new(:width => 2).to_url)
+  end
+  
+  should 'support named line style with custom width' do
+    assert_match(/\bchls=2,6,4\b/, @klass.new(:style => :dash, :width => 2).to_url)
+  end
+  
+  should 'support multiple line styles and multiple custom widths' do
+    assert_match(/\bchls=2,2,4\|3,9,6\b/, @klass.new(:style => [:dot, :dash], :width => [2, 3]).to_url)
+  end
+  
+  should 'use default line width if there are more styles than widths' do
+    assert_match(/\bchls=2,2,4\|1,3,2\|1,1,0\b/, @klass.new(:style => [:dot, :dash, :solid], :width => 2).to_url)
+  end
+  
+  should 'use default line style if there are more widths than styles' do
+    assert_match(/\bchls=2,2,4\|3,3,0\|2,2,0\b/, @klass.new(:style => :dot, :width => [2, 3, 2]).to_url)
+  end
+end

data/test/google_chart/test_range_markers.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class TestRangeMarkers < Test::Unit::TestCase
+  def setup
+    @klass = Class.new(MockChart).class_eval { include GoogleChart::RangeMarkers }
+  end
+  
+  should 'not have range markers by default' do
+    assert_no_match(/\bchm=/, @klass.new.to_url)
+  end
+  
+  should 'display horizontal range markers' do
+    assert_match(/\bchm=r,000000cc,x,0.45,0.55\b/, @klass.new(:ranges => [:h, 0.45, 0.55]).to_url)
+  end
+  
+  should 'display vertical range markers' do
+    assert_match(/\bchm=R,000000cc,x,0.45,0.55\b/, @klass.new(:ranges => [:v, 0.45, 0.55]).to_url)
+  end
+  
+  should 'display multiple range markers' do
+    assert_match(/\bchm=r,000000cc,x,0.1,0.2\|R,000000cc,x,0.3,0.4\b/, @klass.new(:ranges => [[:h, 0.1, 0.2], [:v, 0.3, 0.4]]).to_url)
+  end
+  
+  should 'display range markers with custom colors' do
+    assert_match(/\bchm=r,abcdef,x,0.4,0.6\b/, @klass.new(:ranges => [:h, 'abcdef', 0.4, 0.6]).to_url)
+  end
+end

data/test/google_chart/test_sizes.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class TestSizes < Test::Unit::TestCase
+  def setup
+    @klass = Class.new(MockChart).class_eval { include GoogleChart::Sizes }
+  end
+  
+  should 'have a default size' do
+    assert_match(/\bchs=600x500\b/, @klass.new.to_url)
+  end
+  
+  should 'accept custom size' do
+    assert_match(/\bchs=800x375\b/, @klass.new(:size => '800x375').to_url)
+  end
+end

data/test/google_chart/test_titles.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class TestTitles < Test::Unit::TestCase
+  def setup
+    @klass = Class.new(MockChart).class_eval { include GoogleChart::Titles }
+  end
+  
+  should 'not have a title by default' do
+    assert_no_match(/\bchtt=/, @klass.new.to_url)
+  end
+  
+  should 'url-encode title' do
+    assert_match(/\bchtt=foo\+bar\b/, @klass.new(:title => 'foo bar').to_url)
+  end
+end

data/test/test_google_chart.rb

@@ -0,0 +1,97 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestGoogleChart < Test::Unit::TestCase
+  context '#Line' do
+    context 'with hash parameters' do
+      setup do
+        @url = GoogleChart.Line(:size => '1000x300', :data => [[35, 41], [50, 33]])
+      end
+      
+      should 'return Google Chart URL' do
+        assert_match(%r{\Ahttp://chart\.apis\.google\.com/chart\?}, @url)
+      end
+      
+      should 'include chart type parameter' do
+        assert_match(/\bcht=lc\b/, @url)
+      end
+      
+      should 'include chart size parameter' do
+        assert_match(/\bchs=1000x300\b/, @url)
+      end
+      
+      should 'include chart data parameter' do
+        assert_match(/\bchd=s:jp,yh\b/, @url)
+      end
+    end
+    
+    context 'with block parameters' do
+      setup do
+        @url = GoogleChart.Line do |c|
+          c.size = '800x375'
+          c.data = [[35, 41], [50, 33]]
+        end
+      end
+      
+      should 'return Google Chart URL' do
+        assert_match(%r{\Ahttp://chart\.apis\.google\.com/chart\?}, @url)
+      end
+      
+      should 'include chart type parameter' do
+        assert_match(/\bcht=lc\b/, @url)
+      end
+      
+      should 'include chart size parameter' do
+        assert_match(/\bchs=800x375\b/, @url)
+      end
+      
+      should 'include chart data parameter' do
+        assert_match(/\bchd=s:jp,yh\b/, @url)
+      end
+    end
+  end
+  
+  context '#Bar' do
+    context 'with hash parameters' do
+      setup do
+        @url = GoogleChart.Bar(:size => '1000x300', :data => [[35, 41], [50, 33]])
+      end
+      
+      should 'return Google Chart URL' do
+        assert_match(%r{\Ahttp://chart\.apis\.google\.com/chart\?}, @url)
+      end
+      
+      should 'include chart type parameter' do
+        assert_match(/\bcht=bvs\b/, @url)
+      end
+      
+      should 'include chart size parameter' do
+        assert_match(/\bchs=1000x300\b/, @url)
+      end
+    end
+    
+    context 'with block parameters' do
+      setup do
+        @url = GoogleChart.Bar do |c|
+          c.size = '800x375'
+          c.data = [[35, 41], [50, 33]]
+        end
+      end
+      
+      should 'return Google Chart URL' do
+        assert_match(%r{\Ahttp://chart\.apis\.google\.com/chart\?}, @url)
+      end
+      
+      should 'include chart type parameter' do
+        assert_match(/\bcht=bvs\b/, @url)
+      end
+      
+      should 'include chart size parameter' do
+        assert_match(/\bchs=800x375\b/, @url)
+      end
+      
+      should 'include chart data parameter' do
+        assert_match(/\bchd=s:jp,yh\b/, @url)
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'test/unit'
+require 'rubygems'
+require 'shoulda'
+require 'redgreen' unless ENV['TM_MODE']
+require File.dirname(__FILE__) + '/../lib/google_chart'
+
+class MockChart < GoogleChart::Base
+  def chart_type
+    'cht=mock'
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: jparker-ruby-googlechart
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- John Parker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-11 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    version: 
+description: ruby-googlechart is a ruby library which provides object-oriented access to the Google Charts API
+email: jparker@urgetopunt.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- Rakefile
+- README.txt
+- lib/google_chart.rb
+- lib/google_chart/axes.rb
+- lib/google_chart/bar.rb
+- lib/google_chart/bar_styles.rb
+- lib/google_chart/base.rb
+- lib/google_chart/colors.rb
+- lib/google_chart/data.rb
+- lib/google_chart/grid_lines.rb
+- lib/google_chart/legends.rb
+- lib/google_chart/line.rb
+- lib/google_chart/line_styles.rb
+- lib/google_chart/range_markers.rb
+- lib/google_chart/sizes.rb
+- lib/google_chart/titles.rb
+has_rdoc: false
+homepage: http://github.com/jparker/ruby-googlechart
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby wrapper for the Google Charts API
+test_files: 
+- test/test_helper.rb
+- test/test_google_chart.rb
+- test/google_chart/test_axes.rb
+- test/google_chart/test_bar.rb
+- test/google_chart/test_bar_styles.rb
+- test/google_chart/test_base.rb
+- test/google_chart/test_colors.rb
+- test/google_chart/test_data.rb
+- test/google_chart/test_grid_lines.rb
+- test/google_chart/test_legends.rb
+- test/google_chart/test_line.rb
+- test/google_chart/test_line_styles.rb
+- test/google_chart/test_range_markers.rb
+- test/google_chart/test_sizes.rb
+- test/google_chart/test_titles.rb