gchart 0.3.0 → 0.4.0

data/CHANGELOG.txt

@@ -1,3 +1,12 @@
+== 0.4.0 (2007-12-28)
+
+  * New committer, Abhay Kumar
+  * Implement all three encodings. Fix extended encoding calculation.
+  * Support bar thickness/spacing for bar charts
+  * (bug #16565 fixed) GChart now tells you when your chart is too big.
+  * Pushed some bar chart params logic down where it belongs
+  * Enforce pie chart spec: pie charts only take one set of data
+
 == 0.3.0 (2007-12-24)
   
   * Breaking change: labels --> legend

data/Rakefile

@@ -20,5 +20,12 @@ Spec::Rake::SpecTask.new do |t|
   t.spec_opts = ["--options", "spec/spec.opts"]
 end
 
+desc "Run all specs and get coverage statistics"
+Spec::Rake::SpecTask.new('spec:rcov') do |t|
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+  t.rcov = true
+  t.spec_opts = ["--options", "spec/spec.opts"]
+end
+
 Rake::Task[:default].prerequisites.clear
 task :default => :spec

data/lib/gchart.rb

@@ -6,8 +6,9 @@ end
 
 module GChart
   URL   = "http://chart.apis.google.com/chart"
-  CHARS = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-.".split("")
-  PAIRS = CHARS.collect { |first| CHARS.collect { |second| first + second } }.flatten
+  SIMPLE_CHARS = ('A'..'Z').to_a + ('a'..'z').to_a + ('0'..'9').to_a
+  EXTENDED_CHARS = ('A'..'Z').to_a + ('a'..'z').to_a + ('0'..'9').to_a + %w[- .]
+  EXTENDED_PAIRS = EXTENDED_CHARS.collect { |first| EXTENDED_CHARS.collect { |second| first + second } }.flatten
 
   class << self
     # Convenience constructor for GChart::Line.
@@ -34,12 +35,19 @@ module GChart
     # Encode +n+ as a string. +n+ is normalized based on +max+.
     # +encoding+ can currently only be :extended.
     def encode(encoding, n, max)
-      unless encoding == :extended
+      case encoding
+      when :simple
+        return "_" if n.nil?
+        SIMPLE_CHARS[((n/max.to_f) * (SIMPLE_CHARS.size - 1)).round]
+      when :text
+        return "-1" if n.nil?
+        ((((n/max.to_f) * 1000.0).round)/10.0).to_s
+      when :extended
+        return "__" if n.nil?
+        EXTENDED_PAIRS[((n/max.to_f) * (EXTENDED_PAIRS.size - 1)).round]
+      else
         raise ArgumentError, "unsupported encoding: #{encoding.inspect}"
       end
-
-      return "__" if n.nil?
-      PAIRS[(n * (PAIRS.size - 1) / max).to_i]
     end
   end
 end

data/lib/gchart/bar.rb

@@ -7,6 +7,9 @@ module GChart
     
     attr_reader :orientation
     
+    attr_reader :thickness
+    attr_reader :spacing
+    
     def initialize(*args, &block)
       @grouped = false
       @orientation = :horizontal
@@ -30,6 +33,26 @@ module GChart
       @orientation == :vertical
     end
     
+    def thickness=(thickness)
+      raise ArgumentError, "Invalid thickness: #{thickness.inspect}" if thickness.nil? || thickness < 1
+      @thickness = thickness
+    end
+    
+    def spacing=(spacing)
+      raise ArgumentError, "Invalid spacing: #{spacing.inspect}" if spacing.nil? || spacing < 1
+      @spacing = spacing
+    end
+
+    # overrides GChart::Base#query_params
+    def query_params(params={}) #:nodoc:
+      values = []
+      values << thickness if thickness
+      values << spacing if thickness && spacing
+      
+      params["chbh"] = values.join(",") unless values.empty?
+      super(params)
+    end
+  
     def render_chart_type #:nodoc:
       "b#{@orientation.to_s[0..0]}#{grouped? ? "g" : "s"}"
     end

data/lib/gchart/base.rb

@@ -37,15 +37,23 @@ module GChart
       yield(self) if block_given?
     end
 
-    # Sets the chart's width, in pixels. Raises +ArgumentError+ if +width+ is less than 1.
+    # Sets the chart's width, in pixels. Raises +ArgumentError+
+    # if +width+ is less than 1 or greater than 1,000.
     def width=(width)
-      raise ArgumentError, "Invalid width: #{width.inspect}" if width.nil? || width < 1
+      if width.nil? || width < 1 || width > 1_000
+        raise ArgumentError, "Invalid width: #{width.inspect}"
+      end
+
       @width = width
     end
 
-    # Sets the chart's height, in pixels. Raises +ArgumentError+ if +height+ is less than 1.
+    # Sets the chart's height, in pixels. Raises +ArgumentError+
+    # if +height+ is less than 1 or greater than 1,000.
     def height=(height)
-      raise ArgumentError, "Invalid height: #{height.inspect}" if height.nil? || height < 1
+      if height.nil? || height < 1 || height > 1_000
+        raise ArgumentError, "Invalid height: #{height.inspect}"         
+      end
+      
       @height = height
     end
 
@@ -54,9 +62,14 @@ module GChart
       "#{width}x#{height}"
     end
 
-    # Sets the chart's size as "WIDTHxHEIGHT".
+    # Sets the chart's size as "WIDTHxHEIGHT". Raises +ArgumentError+
+    # if +width+ * +height+ is greater than 300,000 pixels.
     def size=(size)
       self.width, self.height = size.split("x").collect { |n| Integer(n) }
+      
+      if (width * height) > 300_000
+        raise ArgumentError, "Invalid size: #{size.inspect} yields a graph with more than 300,000 pixels"
+      end
     end
 
     # Returns the chart's URL.
@@ -79,9 +92,9 @@ module GChart
 
     protected
     
-    def query_params #:nodoc:
-      params = { "cht" => render_chart_type, "chs" => size }
-    
+    def query_params(raw_params={}) #:nodoc:
+      params = raw_params.merge("cht" => render_chart_type, "chs" => size)
+      
       render_data(params)
       render_title(params)
       render_colors(params)
@@ -106,7 +119,7 @@ module GChart
     end
     
     def render_title(params) #:nodoc:
-      params["chtt"] = title.tr("\n", "|").gsub(/\s+/, "+") if title
+      params["chtt"] = title.tr("\n ", "|+") if title
     end
     
     def render_colors(params) #:nodoc:

data/lib/gchart/pie.rb

@@ -1,10 +1,20 @@
 module GChart
   class Pie < GChart::Base
+    # A single array of chart data. Raises +ArgumentError+
+    # if more than one data set is provided.
+    def data=(data)
+      if data.is_a?(Array) and data.first.is_a?(Array) and data.size > 1
+        raise ArgumentError, "Pie charts only have one data set" 
+      end
+      
+      super(data)
+    end
+    
     def render_chart_type #:nodoc:
       "p"
     end
     
-    def render_legend(params)
+    def render_legend(params) #:nodoc:
       params["chl"] = legend.join("|") if legend
     end
   end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module GChart
-  VERSION = "0.3.0"  
+  VERSION = "0.4.0"  
 end

data/spec/gchart/bar_spec.rb

@@ -22,3 +22,59 @@ describe GChart::Bar do
     GChart::Bar.new(:orientation => :vertical).render_chart_type.should == "bvs"
   end
 end
+
+describe GChart::Bar, "#orientation" do
+  before(:each) { @chart = GChart::Bar.new }
+  
+  it "complains if orientation is invalid" do
+    lambda { @chart.orientation = :monkey }.should raise_error(ArgumentError)
+  end
+end
+
+describe GChart::Bar, "#thickness" do
+  before(:each) { @chart = GChart::Bar.new }
+  
+  it "can be specified" do
+    @chart.thickness = 10
+    @chart.thickness.should == 10
+  end
+  
+  it "complains about negative numbers" do
+    lambda { @chart.thickness = -1 }.should raise_error(ArgumentError)
+  end
+end
+
+describe GChart::Bar, "#spacing" do
+  before(:each) { @chart = GChart::Bar.new }
+  
+  it "can be specified" do
+    @chart.spacing = 2
+    @chart.spacing.should == 2
+  end
+  
+  it "complains about negative numbers" do
+    lambda { @chart.spacing = -1 }.should raise_error(ArgumentError)
+  end
+end
+
+describe GChart::Bar, "#query_params" do
+  before(:each) { @chart = GChart::Bar.new }
+  
+  it "contains the chart's type" do
+    @chart.query_params["cht"].should =~ /b(h|v)(g|s)/
+  end
+  
+  it "contains the chart's bar height" do
+    @chart.thickness = 10
+    @chart.query_params.keys.include?("chbh").should be_true
+    @chart.query_params["chbh"].should == "10"
+    @chart.spacing = 2
+    @chart.query_params.keys.include?("chbh").should be_true
+    @chart.query_params["chbh"].should == "10,2"
+  end
+  
+  it "it does not contain a bar height without a thickness" do
+    @chart.spacing = 2
+    @chart.query_params.keys.include?("chbh").should be_false
+  end
+end

data/spec/gchart/base_spec.rb

@@ -52,6 +52,12 @@ describe GChart::Base, "#size" do
     lambda { @chart.width = -1 }.should raise_error(ArgumentError)
     lambda { @chart.height= -1 }.should raise_error(ArgumentError)
   end
+  
+  it "complains about sizes that are out of bounds (300,000 pixel graph limit, 1000 pixel side limit)" do
+    lambda { @chart.size = "491x611" }.should raise_error(ArgumentError)
+    lambda { @chart.size = "1001x300" }.should raise_error(ArgumentError)
+    lambda { @chart.size = "300x1001" }.should raise_error(ArgumentError)
+  end
 end
 
 describe GChart::Base, "#render_chart_type" do

data/spec/gchart/pie_spec.rb

@@ -5,3 +5,25 @@ describe GChart::Pie do
     GChart::Pie.new.render_chart_type.should == "p"
   end
 end
+
+describe GChart::Pie, "#query_params" do
+  before(:each) { @chart = GChart::Pie.new }
+  
+  it "contains the chart's type" do
+    @chart.query_params["cht"].should == "p"
+  end
+  
+  it "contains the chart's legend" do
+    @chart.legend = ["foo"]
+    @chart.query_params.keys.include?("chl").should be_true
+    @chart.query_params["chl"].should == "foo"
+  end
+end
+
+describe GChart::Pie, "#data" do
+  it "complains if you provide more than one set of data" do
+    lambda { GChart::Pie.new(:data => [1, 2, 3]) }.should_not raise_error(ArgumentError)
+    lambda { GChart::Pie.new(:data => [[1, 2, 3]]) }.should_not raise_error(ArgumentError)
+    lambda { GChart::Pie.new(:data => [[1, 2, 3], [3, 2, 1]]) }.should raise_error(ArgumentError)
+  end
+end

data/spec/gchart_spec.rb

@@ -7,8 +7,32 @@ describe GChart do
 end
 
 describe GChart, ".encode" do
-  it "only supports the extended encoding" do
-    lambda { GChart.encode(:simple, 4, 10) }.should raise_error(ArgumentError)
+  it "supports the simple, text, and extended encoding" do
+    lambda { GChart.encode(:simple, 4, 10) }.should_not raise_error(ArgumentError)
+    lambda { GChart.encode(:text, 4, 10) }.should_not raise_error(ArgumentError)
+    lambda { GChart.encode(:extended, 4, 10) }.should_not raise_error(ArgumentError)
+    lambda { GChart.encode(:monkey, 4, 10) }.should raise_error(ArgumentError)
+  end
+  
+  it "implements the simple encoding" do
+    expected = {
+      0 => "A", 19 => "T", 27 => "b", 53 => "1", 61 => "9",
+      12 => "M", 39 => "n", 57 => "5", 45 => "t", 51 => "z"
+    }
+    
+    expected.each do |original, encoded|
+      GChart.encode(:simple, original, 61).should == encoded
+    end
+  end
+  
+  it "implements the text encoding" do
+    expected = {
+      0 => "0.0", 10 => "10.0", 58 => "58.0", 95 => "95.0", 30 => "30.0", 8 => "8.0", 63 => "63.0", 100 => "100.0"
+    }
+    
+    expected.each do |original, encoded|
+      GChart.encode(:text, original, 100).should == encoded
+    end
   end
 
   it "implements the extended encoding" do
@@ -24,16 +48,18 @@ describe GChart, ".encode" do
   end
   
   it "encodes nil correctly" do
+    GChart.encode(:simple, nil, 1).should == "_"
+    GChart.encode(:text, nil, 1).should == "-1"
     GChart.encode(:extended, nil, 1).should == "__"
   end
 end
 
 describe GChart, ".line" do
   it "can render a basic line URL" do
-    expected = { "cht" => "lc", "chs" => "300x200", "chd" => "e:AAAo..", "chtt" => "test" }
+    expected = { "cht" => "lc", "chs" => "300x200", "chd" => "e:AAAp..", "chtt" => "test" }
     chart = GChart.line(:title => "test", :data => [1, 100, 10000])
 
     chart.query_params.should == expected
-    chart.to_url.should == "http://chart.apis.google.com/chart?chs=300x200&cht=lc&chtt=test&chd=e:AAAo.."
+    chart.to_url.should == "http://chart.apis.google.com/chart?chs=300x200&cht=lc&chtt=test&chd=e:AAAp.."
   end
 end

data/spec/spec.opts

@@ -0,0 +1,7 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse
+--backtrace

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gchart
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - John Barnette
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2007-12-24 00:00:00 -08:00
+date: 2007-12-28 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -19,7 +19,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.3.0
+        version: 1.4.0
     version: 
 description: "== PROBLEMS/TODO  * Add support fills (area or background), grid lines, shape markers, range markers  * Support shorthand colors and color names * Make venn data specification friendlier  There are lots of missing features. Until they're implemented, you can directly specify query parameters using the :extras key, e.g.,  # provides a legend for each data set g = GChart.line(:data => [[1, 2], [3, 4]], :extras => { \"chdl\" => [\"First\", \"Second\"] })"
 email: jbarnette@rubyforge.org