gchart 0.4.2 → 0.5.0

data/lib/gchart/map.rb

@@ -0,0 +1,71 @@
+module GChart
+  class Map < GChart::Base
+    AREAS = %w[africa asia europe middle_east south_america usa world]
+    attr_accessor :area
+    attr_accessor :area_codes
+    attr_accessor :background
+    
+    def initialize(*args, &block)
+      super(*args, &block)
+      # Set some sane defaults so that the only requirement is data
+      @area = 'world' #default
+      @background = 'dfdfff' #make it look like water
+      @colors = ['ffffff','f8fcf8','006c00']
+      #Set the maximum size for maps (this is a better default because
+      # it is also the proper aspect ratio)
+      @width = '440'
+      @height = '220'
+    end
+    
+    # Map data can be in the form {"VA'=>5,'NY'=>1} or [['VA',5],['NY',1]]
+    # Raises +ArgumentError+ if data does not fit these forms.
+    def data=(data)
+      if data.is_a?(Array) && data.any?{ |pair| pair.size != 2 }
+        raise ArgumentError, "Data array must contain [area],[value] pairs"
+      end
+      # 'unzip' the data into separate arrays
+      area_data, values = data.to_a.transpose
+
+      # Reject malformed area codes
+      if area_data.any?{ |code| code !~ /^\w\w$/}
+        raise ArgumentError, "Area data must have exactly two characters" 
+      end
+      @area_codes = area_data.join.upcase
+      super(values)
+    end
+    
+    def render_chart_type #:nodoc:
+      "t"
+    end
+    
+    def area=(area)
+      raise ArgumentError unless AREAS.include? area
+      @area = area
+    end
+    
+    # overrides GChart::Base#query_params
+    def query_params(params={}) #:nodoc:
+      params["chtm"] = area unless area.empty?
+      params["chld"] = area_codes if area_codes
+      params["chf"] = "bg,s,#{@background}" if @background
+      super(params)
+    end
+    
+    # overrides GChart::Base#render_data
+    def render_data(params)
+      super(params)
+      # Maps require at least one data point. Add a "missing value".
+      # It may be better to refactor the base class.
+      params["chd"] << '__' if params["chd"] =~ /e:$/
+    end
+    
+    def render_title(params) #:nodoc:
+      nil #N/A for map
+    end 
+    
+    def render_legend(params) #:nodoc:
+      nil #N/A for map
+    end
+    
+  end
+end

data/lib/gchart/meter.rb

@@ -0,0 +1,29 @@
+module GChart
+  class Meter < GChart::Base
+    attr_accessor :label
+    
+    def render_chart_type #:nodoc:
+      "gom"
+    end
+    
+    # The data for a meter is a single data point expressed as a percent
+    def render_data(params)
+      value = data.is_a?(Array) ? data.flatten.first : data
+      params["chd"] = "t:#{value.to_f}"
+    end
+    
+    def label=(string)
+      return if string.nil?
+      if (string.is_a?(Array) && string.size > 1) or string.include?("|")
+        raise ArgumentError, "Meter can only have one label"
+      end
+      @label = string.to_s
+    end
+    
+    # Commandeer render_legend to render the label
+    def render_legend(params)
+      self.label = legend if self.label.nil? # Can use legend instead of label
+      params["chl"] = label if label
+    end
+  end
+end

data/lib/gchart/sparkline.rb

@@ -0,0 +1,15 @@
+module GChart
+  class Sparkline < GChart::Base
+    # Sparklines are essentially the same as line charts, but without
+    # axis lines. Because they are often placed within text, the default
+    # size should be smaller.
+    def initialize(*args, &block)
+      super(*args, &block)
+      @width = "60"
+      @height = "20"
+    end
+    def render_chart_type #:nodoc:
+      "ls"
+    end
+  end
+end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module GChart
-  VERSION = "0.4.2"  
+  VERSION = "0.5.0".freeze  
 end

data/spec/gchart/axis/bottom_axis_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../../helper")
+
+describe GChart::BottomAxis do
+  before(:each) { @axis = GChart::Axis.create(:bottom) }
+
+  it "describes its axis_type_label as 'x'" do
+    @axis.axis_type_label.should == 'x'
+  end
+
+  it "describes its range_marker_type_label as being vertical ('R')" do
+    @axis.range_marker_type_label.should == 'R'
+  end
+end

data/spec/gchart/axis/left_axis_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../../helper")
+
+describe GChart::LeftAxis do
+  before(:each) { @axis = GChart::Axis.create(:left) }
+
+  it "describes its axis_type_label as 'y'" do
+    @axis.axis_type_label.should == 'y'
+  end
+
+  it "describes its range_marker_type_label as being horizontal ('r')" do
+    @axis.range_marker_type_label.should == 'r'
+  end
+end

data/spec/gchart/axis/right_axis_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../../helper")
+
+describe GChart::RightAxis do
+  before(:each) { @axis = GChart::Axis.create(:right) }
+
+  it "describes its axis_type_label as 'r'" do
+    @axis.axis_type_label.should == 'r'
+  end
+
+  it "describes its range_marker_type_label as being horizontal ('r')" do
+    @axis.range_marker_type_label.should == 'r'
+  end
+end

data/spec/gchart/axis/top_axis_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../../helper")
+
+describe GChart::TopAxis do
+  before(:each) { @axis = GChart::Axis.create(:top) }
+
+  it "describes its axis_type_label as 't'" do
+    @axis.axis_type_label.should == 't'
+  end
+
+  it "describes its range_marker_type_label as being vertical ('R')" do
+    @axis.range_marker_type_label.should == 'R'
+  end
+end

data/spec/gchart/axis_spec.rb

@@ -0,0 +1,216 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../helper")
+
+describe GChart::Axis do
+  before(:each) { @axis = GChart::Axis.create(:bottom) }
+
+  it "blows up when you try to create it with new" do
+    lambda { GChart::Axis.new }.should raise_error(NoMethodError)
+  end
+
+  describe ".create" do
+    {
+      :top    => GChart::TopAxis,    :right => GChart::RightAxis,
+      :bottom => GChart::BottomAxis, :left  => GChart::LeftAxis
+    }.each do |axis_type, axis_class|
+      it "can create a #{axis_class}" do
+        axis = GChart::Axis.create(axis_type)
+        axis.should be_instance_of(axis_class)
+      end
+    end
+
+    it "explodes with an invalid axis_type" do
+      lambda { GChart::Axis.create(:middle) }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe ".validate!" do
+    it "will validate all axis attributes as working with each other by not blowing up" do
+      @axis.validate!
+    end
+  end
+
+  describe ".labels" do
+    it "will contain an array of labels" do
+      @axis.labels = %w(Mon Tue Wed Thu Fri)
+    end
+  end
+
+  describe ".label_positions" do
+    it "will contain an array of label_positions" do
+      @axis.label_positions = [0, 25, 50, 75, 100]
+    end
+  end
+
+  describe ".validate!" do
+    it "will blow up if there are labels and label_positions, but their sizes don't match" do
+      @axis.labels = %w(Mon Tue Wed Thu Fri)
+      @axis.label_positions = [0, 25, 50]
+      lambda { @axis.validate! }.should raise_error(ArgumentError)
+    end
+
+    it "will be happy when there is 1 label_position for every label" do
+      @axis.labels = %w(Mon Tue Wed Thu Fri)
+      @axis.label_positions = [0, 25, 50, 75, 100]
+      @axis.validate!
+    end
+
+    it "will be happy if there are labels but no label_positions" do
+      @axis.labels = %w(Mon Tue Wed Thu Fri)
+      @axis.validate!
+    end
+
+    it "will be happy if there are label_positions but no labels" do
+      @axis.label_positions = [0, 25, 50, 75, 100]
+      @axis.validate!
+    end
+
+    it "will blow up if label_positions contains non-numeric values" do
+      @axis.label_positions = %w(a e h l)
+      lambda { @axis.validate! }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe ".range" do
+    it "will contain a range from which to derive labels" do
+      @axis.range = 0..1300
+    end
+  end
+
+  describe ".validate!" do
+    it "will blow up if range() does not contain a range" do
+      @axis.range = [0, 50, 100]
+      lambda { @axis.validate! }.should raise_error(ArgumentError)
+    end
+
+    it "will blow up if range() contains a range of non-numeric values" do
+      @axis.range = 'a'..'z'
+      lambda { @axis.validate! }.should raise_error(ArgumentError)
+    end
+
+    it "will be content if a range is used in combination with labels" do
+      @axis.range = 0..100
+      @axis.labels = [25, 50, 75]
+      @axis.validate!
+    end
+
+    it "will be content if a range is used in combination with labels and label_positions both" do
+      @axis.range = 0..100
+      @axis.labels = %w(25 50 75)
+      @axis.label_positions = [25, 50, 75]
+      @axis.validate!
+    end
+  end
+
+  describe ".text_color" do
+    it "will contain the color in which to draw axis labelings" do
+      @axis.text_color = :green
+    end
+  end
+
+  describe ".font_size" do
+    it "will contain the font_size for the labels on the axis" do
+      @axis.font_size = 12
+    end
+  end
+
+  describe ".text_alignment" do
+    it "will contain the information on how to align labels on the axis" do
+      @axis.text_alignment = :right
+    end
+  end
+
+  describe ".validate!" do
+    it "will be happy if the text_color is a valid color" do
+      @axis.text_color = 'ff0199aa'
+      @axis.validate!
+    end
+
+    it "will blow up if the text_color is not a valid color" do
+      @axis.text_color = :rgb_freakout
+      lambda { @axis.validate! }.should raise_error(ArgumentError)
+    end
+
+    it "will be happy if font_size is specified along with text_color" do
+      @axis.text_color = 'bbb'
+      @axis.font_size = 12
+      @axis.validate!
+    end
+
+    it "will blow up if font_size is given without a corresponding text_color" do
+      @axis.font_size = 12
+      lambda { @axis.validate! }.should raise_error(ArgumentError)
+    end
+
+    it "will blow up if the text_color is valid but the font_size is not numeric" do
+      @axis.text_color = :black
+      @axis.font_size = "13.5"
+      lambda { @axis.validate! }.should raise_error(ArgumentError)
+    end
+
+    it "will be happy if text_alignment is specified with both font_size and text_color" do
+      @axis.text_alignment = :center
+      @axis.font_size = 11.5
+      @axis.text_color = :cyan
+      @axis.validate!
+    end
+
+    it "will blow up if text_alignment is given without both font_size and text_color" do
+      @axis.text_alignment = :left
+      lambda { @axis.validate! }.should raise_error(ArgumentError)
+    end
+
+    it "will blow up if text_alignment is given with a valid font_size but no text_color" do
+      @axis.text_alignment = :left
+      @axis.font_size = 10
+      lambda { @axis.validate! }.should raise_error(ArgumentError)
+    end
+
+    it "will blow up if text_alignment is given with a valid text_color but no font_size" do
+      @axis.text_alignment = :left
+      @axis.text_color = :magenta
+      lambda { @axis.validate! }.should raise_error(ArgumentError)
+    end
+
+    it "will blow up if font_size and text_color are valid, but text_alignment isn't in TEXT_ALIGNMENT table" do
+      @axis.text_color = :magenta
+      @axis.font_size = 12
+      @axis.text_alignment = :upper
+      lambda { @axis.validate! }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe ".range_markers" do
+    it "will contain an array of ranges of markers and their colors" do
+      @axis.range_markers = [[45..70, :magenta], [75..90, :pink]]
+    end
+  end
+
+  describe ".validate!" do
+    it "be happy when range_markers contains an array of 2-element subarrays of ranges and colors" do
+      @axis.range_markers = [[45..70, :magenta], [75..90, :pink]]
+      @axis.validate!
+    end
+
+    it "will bomb if any element in range_markers is not an array of 2 elements" do
+      @axis.range_markers = ["string", :thistle]
+      lambda { @axis.validate! }.should raise_error(ArgumentError)
+
+      @axis.range_markers = [[:one, :two, :three], [:un, :deux, :trois]]
+      lambda { @axis.validate! }.should raise_error(ArgumentError)
+    end
+
+    it "will bomb if the 1st element in any of the 2-element arrays in range_markers is not a numeric range" do
+      @axis.range_markers = [[75, :blue], [75..100, :green]]
+      lambda { @axis.validate! }.should raise_error(ArgumentError)
+
+      @axis.range_markers = [['a'..'z', :blue], [75..10, :green]]
+      lambda { @axis.validate! }.should raise_error(ArgumentError)
+    end
+
+    it "will bomb if the 2nd element in any of the 2-element arrays in range_markers is not a valid color" do
+      @axis.range_markers = [[75..90, :blue], [75..100, :cyantiago]]
+      lambda { @axis.validate! }.should raise_error(ArgumentError)
+    end
+  end
+
+end

data/spec/gchart/base_spec.rb

@@ -98,6 +98,27 @@ describe GChart::Base, "#query_params" do
     @chart.query_params["chtt"].should == "foo|bar"
   end
   
+  it "contains the chart's data colors" do
+    @chart.colors = ["cccccc", "eeeeee", :salmon3, "49d", :red]
+    @chart.query_params["chco"].should == "cccccc,eeeeee,cd7054,4499dd,ff0000"
+
+    @chart.colors = []
+    @chart.query_params["chco"].should be_nil
+  end
+
+  it "contains the chart's background colors" do
+    @chart.query_params["chf"].should be_nil
+
+    @chart.entire_background = :red
+    @chart.query_params["chf"].should == "bg,s,ff0000"
+
+    @chart.chart_background = "704"
+    @chart.query_params["chf"].should == "bg,s,ff0000|c,s,770044"
+
+    @chart.entire_background = nil
+    @chart.query_params["chf"].should == "c,s,770044"
+  end
+
   it "contains the chart's colors" do
     @chart.colors = ["cccccc", "eeeeee"]
     @chart.query_params["chco"].should == "cccccc,eeeeee"
@@ -154,3 +175,89 @@ describe GChart::Base, "#write" do
     result.should == "PAYLOAD"
   end
 end
+
+describe GChart::Base, "#axis" do
+  before(:each) do
+    @chart = GChart::Line.new
+    @axis = @chart.axis(:bottom)
+  end
+
+  it "instantiates a new GChart::Axis of the proper axis_type" do
+    chart = GChart::Line.new
+    axis  = chart.axis(:bottom)
+    axis.is_a?(GChart::BottomAxis).should == true
+  end
+
+  it "pushes the new axis to the chart's set of axes" do
+    chart = GChart::Line.new
+    axis  = chart.axis(:bottom)
+    chart.axes.first.should == axis
+  end
+
+  [GChart::Line, GChart::Bar, GChart::Scatter].each do |chart_type|
+    it "renders axis information when chart axes are present and chart is of proper type" do
+      chart = chart_type.new
+      axis  = chart.axis(:left)
+      chart.to_url.should =~ /chxt/
+    end
+  end
+
+  [GChart::Pie3D, GChart::Pie, GChart::Venn, GChart::XYLine].each do |chart_type|
+    it "should not render axis information when chart axes are present but chart is not of proper type" do
+      chart = chart_type.new
+      axis  = chart.axis(:left)
+      chart.to_url.should_not =~ /chxt/
+    end
+  end
+end
+
+describe GChart::Base, "#entire_background" do
+  it "sets the background color for the entire chart" do
+    chart = GChart.line
+    chart.entire_background = :blue
+  end
+end
+
+describe GChart::Base, "#chart_background" do
+  it "sets the background color for just the chart area of the chart image" do
+    chart = GChart.bar
+    chart.chart_background = "876"
+  end
+end
+
+describe GChart::Base, "#render_backgrounds" do
+  before(:each) do
+    @chart = GChart::Line.new
+  end
+
+  it "verifies that background colors are valid colors" do
+    @chart.chart_background = :cyan
+    @chart.to_url
+
+    @chart.entire_background = 'f37'
+    @chart.to_url
+  end
+
+  it "blows up if either of the background colors are invalid" do
+    @chart.chart_background = :redneck_skin
+    lambda { @chart.to_url }.should raise_error(ArgumentError)
+
+    @chart.chart_background = nil
+    @chart.entire_background = 'f375'
+    lambda { @chart.to_url }.should raise_error(ArgumentError)
+  end
+
+  it "renders chart background information correctly" do
+    @chart.to_url.should_not =~ /chf=/
+
+    @chart.chart_background = 'f3A'
+    @chart.to_url.should =~ /chf=c,s,ff33AA/
+
+    @chart.entire_background = :yellow
+    @chart.to_url.should =~ /chf=bg,s,ffff00%7Cc,s,ff33AA/
+
+    @chart.chart_background = nil
+    @chart.to_url.should_not =~ /chf=bg,s,ffff00%7Cc,s,ff33AA/
+    @chart.to_url.should =~ /chf=bg,s,ffff00/
+  end
+end