mattetti-googlecharts 1.3.6 → 1.3.7

data/lib/gchart.rb

@@ -3,20 +3,22 @@ require 'gchart/version'
 require 'gchart/theme'
 require "open-uri"
 require "uri"
+require "cgi"
 
 class Gchart
 
   include GchartInfo
   
   @@url = "http://chart.apis.google.com/chart?"  
-  @@types = ['line', 'line_xy', 'scatter', 'bar', 'venn', 'pie', 'pie_3d', 'jstize', 'sparkline', 'meter']
+  @@types = ['line', 'line_xy', 'scatter', 'bar', 'venn', 'pie', 'pie_3d', 'jstize', 'sparkline', 'meter', 'map']
   @@simple_chars = ('A'..'Z').to_a + ('a'..'z').to_a + ('0'..'9').to_a
   @@chars = @@simple_chars + ['-', '.']
   @@ext_pairs = @@chars.map { |char_1| @@chars.map { |char_2| char_1 + char_2 } }.flatten
   @@file_name = 'chart.png'
   
   attr_accessor :title, :type, :width, :height, :horizontal, :grouped, :legend, :data, :encoding, :max_value, :bar_colors,
-                :title_color, :title_size, :custom, :axis_with_labels, :axis_labels, :bar_width_and_spacing, :id, :alt, :class
+                :title_color, :title_size, :custom, :axis_with_labels, :axis_labels, :bar_width_and_spacing, :id, :alt, :class,
+                :range_markers, :geographical_area, :map_colors, :country_codes
     
   # Support for Gchart.line(:title => 'my title', :size => '400x600')
   def self.method_missing(m, options={})
@@ -28,6 +30,8 @@ class Gchart
     @@file_name = options[:filename] unless options[:filename].nil?
     options.delete(:format)
     options.delete(:filename)
+    #update map_colors to be bar_colors
+    options.update(:bar_colors => options[:map_colors]) if options.has_key?(:map_colors)
     # create the chart and return it in the format asked for
     if @@types.include?(m.to_s)  
       chart = new(options.merge!({:type => m}))
@@ -191,6 +195,11 @@ class Gchart
     "chco=#{@bar_colors}"
   end
   
+  def set_country_codes
+    @country_codes = @country_codes.join() if @country_codes.is_a?(Array)
+    "chld=#{@country_codes}"
+  end
+  
   # set bar spacing
   # chbh=
   # <bar width in pixels>,
@@ -213,6 +222,21 @@ class Gchart
     "chbh=#{width_and_spacing_values}"
   end
   
+  def set_range_markers
+    markers = case @range_markers
+    when Hash
+      set_range_marker(@range_markers)
+    when Array
+      range_markers.collect{|marker| set_range_marker(marker)}.join('|')
+    end
+    "chm=#{markers}"
+  end
+  
+  def set_range_marker(options)
+    orientation = ['vertical', 'Vertical', 'V', 'v', 'R'].include?(options[:orientation]) ? 'R' : 'r'
+    "#{orientation},#{options[:color]},0,#{options[:start_position]},#{options[:stop_position]}#{',1' if options[:overlaid?]}"  
+  end
+  
   def fill_for(type=nil, color='', angle=nil)
     unless type.nil? 
       case type
@@ -238,7 +262,7 @@ class Gchart
     return set_labels if @type == :pie || @type == :pie_3d || @type == :meter
     
     if @legend.is_a?(Array)
-      "chdl=#{@legend.map{|label| "#{label}"}.join('|')}"
+      "chdl=#{@legend.map{|label| "#{CGI::escape(label)}"}.join('|')}"
     else
       "chdl=#{@legend}"
     end
@@ -270,6 +294,10 @@ class Gchart
     "chxl=#{labels_arr.join('|')}"
   end
   
+  def set_geographical_area
+    "chtm=#{@geographical_area}"
+  end
+  
   def set_type
     case @type
       when :line
@@ -290,6 +318,8 @@ class Gchart
         "cht=ls"
       when :meter
         "cht=gom"
+      when :map
+        "cht=t"
       end
   end
   
@@ -398,6 +428,12 @@ class Gchart
         set_axis_with_labels
       when '@axis_labels'
         set_axis_labels
+      when '@range_markers'
+        set_range_markers
+      when '@geographical_area'
+        set_geographical_area
+      when '@country_codes'
+        set_country_codes
       when '@custom'
         @custom
       end

data/spec/gchart_spec.rb

@@ -81,6 +81,7 @@ describe "generating a default Gchart" do
    Gchart.line(:axis_labels => [['Jan','July','Jan','July','Jan']]).include?(Gchart.jstize('chxl=0:|Jan|July|Jan|July|Jan')).should be_true
    Gchart.line(:axis_labels => [['Jan','July','Jan','July','Jan'], ['0','100'], ['A','B','C'], ['2005','2006','2007']]).include?(Gchart.jstize('chxl=0:|Jan|July|Jan|July|Jan|1:|0|100|2:|A|B|C|3:|2005|2006|2007')).should be_true
   end
+
   
 end
 
@@ -126,12 +127,64 @@ describe "generating different type of charts" do
     Gchart.meter.include?('cht=gom').should be_true
   end
   
+  it "should be able to generate a map chart" do
+    Gchart.map.should be_an_instance_of(String)
+    Gchart.map.include?('cht=t').should be_true
+  end
+  
   it "should not support other types" do
     Gchart.sexy.should == "sexy is not a supported chart format, please use one of the following: #{Gchart.supported_types}."
   end
   
 end
 
+
+describe "range markers" do
+
+  it "should be able to generate given a hash of range-marker options" do
+    Gchart.line(:range_markers => {:start_position => 0.59, :stop_position => 0.61, :color => 'ff0000'}).include?('chm=r,ff0000,0,0.59,0.61').should be_true
+  end
+  
+  it "should be able to generate given an array of range-marker hash options" do
+    Gchart.line(:range_markers => [
+          {:start_position => 0.59, :stop_position => 0.61, :color => 'ff0000'}, 
+          {:start_position => 0, :stop_position => 0.6, :color => '666666'}, 
+          {:color => 'cccccc', :start_position => 0.6, :stop_position => 1}
+        ]).include?(Gchart.jstize('r,ff0000,0,0.59,0.61|r,666666,0,0,0.6|r,cccccc,0,0.6,1')).should be_true
+  end
+  
+  it "should allow a :overlaid? to be set" do
+    Gchart.line(:range_markers => {:start_position => 0.59, :stop_position => 0.61, :color => 'ffffff', :overlaid? => true}).include?('chm=r,ffffff,0,0.59,0.61,1').should be_true
+    Gchart.line(:range_markers => {:start_position => 0.59, :stop_position => 0.61, :color => 'ffffff', :overlaid? => false}).include?('chm=r,ffffff,0,0.59,0.61').should be_true
+  end
+  
+  describe "when setting the orientation option" do
+    before(:each) do
+      options = {:start_position => 0.59, :stop_position => 0.61, :color => 'ff0000'}
+    end
+    
+    it "to vertical (R) if given a valid option" do
+      Gchart.line(:range_markers => options.merge(:orientation => 'v')).include?('chm=R').should be_true
+      Gchart.line(:range_markers => options.merge(:orientation => 'V')).include?('chm=R').should be_true
+      Gchart.line(:range_markers => options.merge(:orientation => 'R')).include?('chm=R').should be_true
+      Gchart.line(:range_markers => options.merge(:orientation => 'vertical')).include?('chm=R').should be_true
+      Gchart.line(:range_markers => options.merge(:orientation => 'Vertical')).include?('chm=R').should be_true
+    end
+    
+    it "to horizontal (r) if given a valid option (actually anything other than the vertical options)" do
+      Gchart.line(:range_markers => options.merge(:orientation => 'horizontal')).include?('chm=r').should be_true
+      Gchart.line(:range_markers => options.merge(:orientation => 'h')).include?('chm=r').should be_true
+      Gchart.line(:range_markers => options.merge(:orientation => 'etc')).include?('chm=r').should be_true
+    end
+
+    it "if left blank defaults to horizontal (r)" do    
+      Gchart.line(:range_markers => options).include?('chm=r').should be_true
+    end
+  end
+
+end
+
+
 describe "a bar graph" do
   
   it "should have a default vertical orientation" do
@@ -227,6 +280,13 @@ describe "a line chart" do
     @chart.include?(Gchart.jstize("chdl=first+data+set+label|n+data+set+label")).should be_true
   end
   
+  it "should escape text values in url" do
+    title = 'Chart & Title'
+    legend = ['first data & set label', 'n data set label']
+    chart = Gchart.line(:title => title, :legend => legend)
+    chart.include?(Gchart.jstize("chdl=first+data+%26+set+label|n+data+set+label")).should be_true
+  end  
+  
   it "should be able to have one legend" do
     chart = Gchart.line(:legend => 'legend label')
     chart.include?("chdl=legend+label").should be_true
@@ -378,6 +438,40 @@ describe "a google-o-meter" do
   
 end
 
+describe "a map chart" do
+  
+  before(:each) do
+    @data = [0,100,50,32]
+    @geographical_area = 'usa'
+    @map_colors = ['FFFFFF', 'FF0000', 'FFFF00', '00FF00']
+    @country_codes = ['MT', 'WY', "ID", 'SD']
+    @chart = Gchart.map(:data => @data, :encoding => 'text', :size => '400x300', 
+      :geographical_area => @geographical_area, :map_colors => @map_colors,
+      :country_codes => @country_codes)
+  end
+  
+  it "should create a map" do
+    @chart.include?('cht=t').should be_true
+  end
+  
+  it "should set the geographical area" do
+    @chart.include?('chtm=usa').should be_true
+  end
+  
+  it "should set the map colors" do
+    @chart.include?('chco=FFFFFF,FF0000,FFFF00,00FF00').should be_true
+  end
+  
+  it "should set the country/state codes" do
+    @chart.include?('chld=MTWYIDSD').should be_true
+  end
+  
+  it "should set the chart data" do
+    @chart.include?('chd=t:0,100,50,32').should be_true
+  end
+  
+end
+
 describe 'exporting a chart' do
   
   it "should be available in the url format by default" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mattetti-googlecharts
 version: !ruby/object:Gem::Version 
-  version: 1.3.6
+  version: 1.3.7
 platform: ruby
 authors: 
 - Matt Aimonetti