ruby-googlechart 0.6.4

data/.gitignore

@@ -0,0 +1,3 @@
+pkg
+dog
+Manifest

data/CHANGELOG

@@ -0,0 +1,30 @@
+== 0.0.1 2008-05-14
+
+* Initial release
+
+== 0.5.0 2008-11-08
+
+* Code cleanup, improved tests
+* First working gem release
+
+== 0.6.0 2008-11-12
+
+* Continued cleanup
+* Changed data scaling behavior with negative values
+
+== 0.6.1 2008-11-12
+
+* Gem cleanup (switched from newgem + hoe to echoe)
+* Fixed data scaling bug with all-zero data
+
+== 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/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 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/README.rdoc

@@ -0,0 +1,59 @@
+== 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
+
+* Line charts (line, XY, sparkline)
+* Bar charts (horizontal, vertical, grouped, stacked)
+
+== SYNOPSIS
+  
+  require 'google_chart'
+  
+  url = GoogleChart.Line(:data => [1, nil, 2, 8, 1])
+  url = GoogleChart.Bar(:data => [5, 23, 6, 14])
+  
+  url = GoogleChart.Bar do |c|
+    c.axes     = {:x => %w[Q1 Q2 Q3 Q4], :y => 0..400}
+    c.data     = [335, 285, 240, 220, 160, 175, 200, 205]
+    c.encoding = :extended
+    c.scale    = 0..400
+    c.size     = '800x375'
+    c.style    = :dash
+    c.title    = "Are You Pondering What I'm Pondering?"
+    c.type     = :line
+  end
+  url = GoogleChart.Bar do |c|
+    c.horizontal = true
+    c.grouped    = true
+    c.data       = [[5, 6, 7, 8], [23, 14, 17, 16]]
+    c.encoding   = :text
+    c.title      = 'Lorem Ipsum Dolor'
+  end
+  
+  chart = GoogleChart::LineChart.new
+  chart.type  = :sparkline
+  chart.size  = '75x25'
+  chart.data  = [1, 1, 2, 3, 5, 8, 13]
+  chart.color = 'ff0000'
+  url = chart.to_url
+
+== REQUIREMENTS
+
+* Low standards
+
+== INSTALL
+
+* sudo gem install ruby-googlechart

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ruby-googlechart"
+    gem.summary = %Q{Ruby wrapper around the Google Charts API}
+    gem.description = %Q{ruby-googlechart is yet another wrapper around the Google Charts API}
+    gem.email = "jparker@urgetopunt.com"
+    gem.homepage = "http://github.com/jparker/ruby-googlechart"
+    gem.authors = ["John Parker"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ruby-googlechart #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.6.4

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

@@ -0,0 +1,30 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'cgi'
+
+require 'array'
+
+require 'google_chart/axis'
+require 'google_chart/bar_style'
+require 'google_chart/color'
+require 'google_chart/data'
+require 'google_chart/grid_line'
+require 'google_chart/legend'
+require 'google_chart/line_style'
+require 'google_chart/range_marker'
+require 'google_chart/title'
+
+require 'google_chart/abstract_chart'
+require 'google_chart/bar_chart'
+require 'google_chart/line_chart'
+
+module GoogleChart
+  def self.Line(options = {}, &block)
+    GoogleChart::LineChart.new(options, &block).to_url
+  end
+  
+  def self.Bar(options = {}, &block)
+    GoogleChart::BarChart.new(options, &block).to_url
+  end
+end

data/lib/google_chart/abstract_chart.rb

@@ -0,0 +1,48 @@
+module GoogleChart
+  class AbstractChart
+    @@base_url     = 'http://chart.apis.google.com/chart'
+    @@default_size = '600x500'
+    
+    def initialize(options = {})
+      options.each {|key, value| send("#{key}=", value) }
+      yield self if block_given?
+    end
+    
+    def to_url
+      "#{@@base_url}?#{query_string}"
+    end
+    
+    attr_writer :size
+    
+    def size
+      @size ||= @@default_size
+      "chs=#{@size}"
+    end
+    
+    def self.inherited(klass)
+      klass.class_eval do
+        class_variable_set(:@@parameters, [])
+        register!(:chart_type, :size)
+      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
+    
+    private
+    def query_string
+      self.class.registry.map {|m| send(m) }.compact.join('&')
+    end
+  end
+end

data/lib/google_chart/axis.rb

@@ -0,0 +1,40 @@
+# <URL:http://code.google.com/apis/chart/#multiple_axes_labels>
+module GoogleChart
+  module Axis
+    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=(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].map {|l| CGI::escape(l.to_s) }.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
+    
+    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
+  end
+end

data/lib/google_chart/bar_chart.rb

@@ -0,0 +1,57 @@
+require 'matrix'
+
+module GoogleChart
+  class BarChart < AbstractChart
+    include Axis
+    include BarStyle
+    include Color
+    include Data
+    include GridLine
+    include Legend
+    include RangeMarker
+    include Title
+    
+    @@orientations = {:horizontal => 'h', :vertical => 'v'}
+    @@groupings    = {:group => 'g', :stack => 's', :overlap => 's'}
+    
+    attr_writer :orientation, :grouping
+    
+    def horizontal=(arg)
+      self.orientation = arg ? :horizontal : :vertical
+    end
+    
+    def chart_type
+      @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/bar_style.rb

@@ -0,0 +1,19 @@
+# <URL:http://code.google.com/apis/chart/#bar_width>
+module GoogleChart
+  module BarStyle
+    def self.included(klass)
+      klass.register!(:style)
+    end
+    
+    attr_writer :width
+    
+    # TODO: raise error if bar spacing > group spacing?
+    def spacing=(spacing)
+      @spacing = [spacing].flatten
+    end
+    
+    def style
+      "chbh=#{[@width, *@spacing].compact.join(',')}" if @width
+    end
+  end
+end

data/lib/google_chart/color.rb

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

data/lib/google_chart/data.rb

@@ -0,0 +1,99 @@
+# <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   = ('A'..'Z').to_a + ('a'..'z').to_a + ('0'..'9').to_a
+    alphabet   = ('A'..'Z').to_a + ('a'..'z').to_a + ('0'..'9').to_a + %w[- .]
+    @@extended = alphabet.map {|a| alphabet.map {|b| a + b }}.flatten
+    
+    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
+      set_scale
+      'chd=' + send(:"#{encoding}_encode", reduce(@data)) if @data
+    end
+    
+    private
+    def encoding
+      @encoding ||= :simple
+    end
+    
+    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.first, @scale.last
+      if min != max
+        set.map {|e| (e.to_f - min) / (max - min) * encoding_max if e }
+      else
+        set
+      end
+    end
+    
+    def simple_encode(data)
+      's:' + data.map {|set|
+        normalize(set, @@simple.size - 1).map {|e|
+          case
+          when e.nil? then '_'
+          when e <= 0 then @@simple[0]
+          when e >= @@simple.size then @@simple[-1]
+          else @@simple[e.floor]
+          end
+        }.join
+      }.join(',')
+    end
+    
+    def extended_encode(data)
+      'e:' + data.map {|set|
+        normalize(set, @@extended.size - 1).collect {|e|
+          case
+          when e.nil? then '__'
+          when e <= 0 then @@extended[0]
+          when e >= @@extended.size then @@extended[-1]
+          else @@extended[e.floor]
+          end
+        }.join
+      }.join(',')
+    end
+    
+    def text_encode(data)
+      't:' + data.map {|set|
+        normalize(set, 100).map {|e|
+          case
+          when e.nil? then -1
+          when e < 0 then 0
+          when e > 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").
+            n = (e * 10).round
+            n / (n % 10 == 0 ? 10 : 10.0)
+          end
+        }.join(',')
+      }.join('|')
+    end
+  end
+end