googlecharts 0.0.2

data.tar.gz.sig

@@ -0,0 +1,4 @@
+]�b��XylU@�
+��vtl5�>�@Y.��2Q`C��pT�_8I'ǒ��R�Lu��D������z-�e��(��B�|���c�&9�k��8&���i�
+<3�x�a1�/�UA�D�3m�[�@\[Wm⑜�?�1?�0)x?c	LC�s��w�[!~_&n�YK4�?��Xs�dg��q�|>g�#kSU�"��^@3����U
+���J�ի�{�Yb)�������3��%�$D�2��}h7�S

data/History.txt

@@ -0,0 +1,7 @@
+== 0.0.2 2007-12-11
+* added support for more features and aliases
+
+== 0.0.1 2007-12-08
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Matt Aimonetti
+
+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/Manifest.txt

@@ -0,0 +1,27 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/gchart.rb
+lib/gchart/aliases.rb
+lib/gchart/version.rb
+log/debug.log
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+spec/gchart_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/rspec.rake
+tasks/website.rake
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,179 @@
+The goal of this Gem is to make the creation of Google Charts a simple and easy task.
+
+Gchart.line(  :size => '200x300', 
+              :title => "example title",
+              :bg => 'efefef',
+              :legend => ['first data set label', 'second data set label'],
+              :data => [10, 30, 120, 45, 72])
+              
+
+
+==Chart Type
+
+This gem supports the following types of charts:
+  
+  * line, 
+  * line_xy
+  * scatter
+  * bar
+  * venn
+  * pie
+  * pie_3d
+
+To create a chart, simply require Gchart and call any of the existing type:
+
+    require 'gchart'
+    Gchart.pie
+  
+  
+==Chart Title
+
+  To add a title to a chart pass the title to your chart:
+  
+    Gchart.line(:title => 'Sexy Charts!')
+    
+You can also specify the color and/or size
+    
+    Gchart.line(:title => 'Sexy Charts!', :title_color => 'FF0000', :title_size => '20')
+
+==Colors
+
+Specify a color with at least a 6-letter string of hexadecimal values in the format RRGGBB. For example:
+
+    * FF0000 = red
+    * 00FF00 = green
+    * 0000FF = blue
+    * 000000 = black
+    * FFFFFF = white
+
+You can optionally specify transparency by appending a value between 00 and FF where 00 is completely transparent and FF completely opaque. For example:
+
+    * 0000FFFF = solid blue
+    * 0000FF00 = transparent blue
+
+If you need to use multiple colors, check the doc. Usually you just need to pass :attribute => 'FF0000,00FF00'
+
+Some charts have more options than other, make sure to refer to the documentation.
+
+===Background options:
+
+If you don't set the background option, your graph will be transparent.
+
+* You have 3 types of background  http://code.google.com/apis/chart/#chart_or_background_fill
+
+- solid
+- gradient
+- stripes
+
+By default, if you set a background color, the fill will be solid:
+
+    Gchart.bar(:bg => 'efefef')
+
+However you can specify another fill type such as:
+            
+    Gchart.line(:bg => {:color => 'efefef', :type => 'gradient'})
+  
+In the above code, we decided to have a gradient background, however since we only passed one color, the chart will start by the specified color and transition to white. By the default, the gradient angle is 0. Change it as follows:
+
+    Gchart.line(:title =>'bg example', :bg => {:color => 'efefef', :type => 'gradient', :angle => 90})
+    
+For a more advance use of colors, refer to http://code.google.com/apis/chart/#linear_gradient
+
+    Gchart.line(:bg => {:color => '76A4FB,1,ffffff,0', :type => 'gradient'})
+    
+    
+The same way you set the background color, you can also set the graph background:
+
+    Gchart.line(:graph_bg => 'cccccc')
+    
+or both
+
+    Gchart.line(:bg => {:color => '76A4FB,1,ffffff,0', :type => 'gradient'}, :graph_bg => 'cccccc', :title => 'Sexy Chart')
+    
+    
+Another type of fill is stripes http://code.google.com/apis/chart/#linear_stripes
+
+    Gchart.line(:bg => {:color => 'efefef', :type => 'stripes'})
+    
+You can customize the amount of stripes, colors and width by changing the color value.
+    
+    
+== Legend & Labels
+
+You probably will want to use a legend or labels for your graph.
+
+    Gchart.line(:legend => 'legend label')
+or
+    Gchart.line(:legend => ['legend label 1', 'legend label 2'])
+    
+Will do the trick. You can also use the labels alias (makes more sense when using the pie charts)
+
+    chart = Gchart.pie(:labels => ['label 1', 'label 2'])
+
+== Multiple axis labels 
+
+Multiple axis labels are available for line charts, bar charts and scatter plots.
+
+* x = bottom x-axis
+* t = top x-axis
+* y = left y-axis
+* r = right y-axis
+
+    Gchart.line(:label_axis => 'x,y,r')
+  
+To add labels on these axis:
+
+    Gchart.line(:axis_labels => ['Jan|July|Jan|July|Jan', '0|100', 'A|B|C', '2005|2006|2007'])
+
+    
+== Data options
+
+Data are passed using an array or a nested array.    
+
+  Gchart.bar(:data => [1,2,4,67,100,41,234])  
+  
+  Gchart.bar(:data => [[1,2,4,67,100,41,234],[45,23,67,12,67,300, 250]])
+  
+By default, the graph is drawn with your max value representing 100% of the height or width of the graph. You can change that my passing the max value.
+
+  Gchart.bar(:data => [1,2,4,67,100,41,234], :max_value => 300)
+  Gchart.bar(:data => [1,2,4,67,100,41,234], :max_value => 'auto')
+  
+or if you want to use the real values from your dataset:
+
+  Gchart.bar(:data => [1,2,4,67,100,41,234], :max_value => false)
+  
+  
+You can also define a different encoding to add more granularity:
+
+  Gchart.bar(:data => [1,2,4,67,100,41,234], :encoding => 'simple') 
+  Gchart.bar(:data => [1,2,4,67,100,41,234], :encoding => 'extended') 
+  Gchart.bar(:data => [1,2,4,67,100,41,234], :encoding => 'text') 
+  
+
+==Pies:
+  
+you have 2 type of pies:
+  - Gchart.pie() the standard 2D pie
+  _ Gchart.pie_3d() the fancy 3D pie
+  
+To set labels, you can use one of these two options:
+
+    @legend = ['Matt_fu', 'Rob_fu']
+    Gchart.pie_3d(:title => @title, :labels => @legend, :data => @data, :size => '400x200')
+    Gchart.pie_3d(:title => @title, :legend => @legend, :data => @data, :size => '400x200')
+  
+  
+  
+=== try yourself
+
+Gchart.bar( :data => [[1,2,4,67,100,41,234],[45,23,67,12,67,300, 250]], 
+            :title => 'SDRuby Fu level', 
+            :legend => ['matt','patrick'], 
+            :bg => {:color => '76A4FB', :type => 'gradient'}, 
+            :bar_colors => 'ff0000,00ff00')
+
+ "http://chart.apis.google.com/chart?chs=300x200&chdl=matt|patrick&chd=s:AAANUIv,JENCN9y&chtt=SDRuby+Fu+level&chf=bg,lg,0,76A4FB,0,ffffff,1&cht=bvs&chco=ff0000,00ff00"  
+ 
+Gchart.pie(:data => [20,10,15,5,50], :title => 'SDRuby Fu level', :size => '400x200', :labels => ['matt', 'rob', 'patrick', 'ryan', 'jordan'])
+http://chart.apis.google.com/chart?cht=p&chs=400x200&chd=s:YMSG9&chtt=SDRuby+Fu+level&chl=matt|rob|patrick|ryan|jordan

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,71 @@
+require 'gchart/version'
+
+AUTHOR = 'Matt Aimonetti'  # can also be an array of Authors
+EMAIL = "mattaimonetti@gmail.com"
+DESCRIPTION = "description of gem"
+GEM_NAME = 'googlecharts' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'googlecharts' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "matt_a"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = GchartInfo::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'gchart documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,16 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile could use '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'gchart'

data/lib/gchart.rb

@@ -0,0 +1,328 @@
+$:.unshift File.dirname(__FILE__)
+require 'gchart/version'
+
+class Gchart
+
+  include GchartInfo
+  
+  @@url = "http://chart.apis.google.com/chart?"  
+  @@types = ['line', 'line_xy', 'scatter', 'bar', 'venn', 'pie', 'pie_3d']
+  @@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
+  
+  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
+    
+  class << self
+    # Support for Gchart.line(:title => 'my title', :size => '400x600')
+    def method_missing(m, options={}, format='raw')
+      if @@types.include?(m.to_s)
+        chart = new(options.merge!({:type => m}))
+        chart.send(format)
+      else
+        "#{m} is not a supported chart format, please use one of the following: #{supported_types}."
+      end  
+    end
+
+  end
+  
+  def initialize(options={})
+      @type = :line
+      @data = []
+      @width = 300
+      @height = 200
+      @horizontal = false
+      @grouped = false
+      @encoding = 'simple'
+      @max_value = 'auto'
+
+      # set the options value if definable
+      options.each do |attribute, value| 
+          send("#{attribute.to_s}=", value) if self.respond_to?("#{attribute}=")
+      end
+  end
+  
+  def self.supported_types
+    @@types.join(' ')
+  end
+  
+  # Defines the Graph size using the following format:
+  # width X height
+  def size=(size='300x200')
+    @width, @height = size.split("x").map { |dimension| dimension.to_i }
+  end
+  
+  def size
+    "#{@width}x#{@height}"
+  end
+  
+  # Sets the orientation of a bar graph
+  def orientation=(orientation='h')
+    if orientation == 'h' || orientation == 'horizontal'
+      self.horizontal = true
+    elsif orientation == 'v' || orientation == 'vertical'
+      self.horizontal = false
+    end
+  end
+  
+  # Sets the bar graph presentation (stacked or grouped)
+  def stacked=(option=true)
+   @grouped = option ? false : true
+  end
+  
+  def bg=(options)
+    if options.is_a?(String)
+      @bg_color = options
+    elsif options.is_a?(Hash)
+      @bg_color = options[:color]
+      @bg_type = options[:type]
+      @bg_angle = options[:angle]
+    end
+  end
+  
+  def graph_bg=(options)
+    if options.is_a?(String)
+      @chart_color = options
+    elsif options.is_a?(Hash)
+      @chart_color = options[:color]
+      @chart_type = options[:type]
+      @chart_angle = options[:angle]
+    end
+  end
+  
+  # load all the custom aliases
+  require 'gchart/aliases'
+  
+  protected
+  
+  # Format
+  
+  def img_tag
+    "<img src='#{query_builder}'/>"
+  end
+  
+  def raw
+    query_builder
+  end
+  
+  #
+  def jstize(string)
+    string.gsub(' ', '+')
+  end
+  
+  private
+  
+  # The title size cannot be set without specifying a color.
+  # A dark key will be used for the title color if no color is specified 
+  def set_title
+    title_params = "chtt=#{title}"
+    unless (title_color.nil? && title_size.nil? )
+      title_params << "&chts=" + (color, size = (@title_color || '454545'), @title_size).compact.join(',')
+    end
+    title_params
+  end
+  
+  def set_size
+    "chs=#{size}"
+  end
+  
+  def set_data
+    data = send("#{@encoding}_encoding", @data)
+    "chd=#{data}"
+  end
+  
+  def set_colors
+    bg_type = fill_type(@bg_type) || 's' if @bg_color
+    chart_type = fill_type(@chart_type) || 's' if @chart_color
+    
+    "chf=" + {'bg' => fill_for(bg_type, @bg_color, @bg_angle), 'c' => fill_for(chart_type, @chart_color, @chart_angle)}.map{|k,v| "#{k},#{v}" unless v.nil?}.compact.join('|')      
+  end
+  
+  # set bar, line colors
+  def set_bar_colors
+    "chco=#{@bar_colors}"
+  end
+  
+  def fill_for(type=nil, color='', angle=nil)
+    unless type.nil? 
+      case type
+        when 'lg'
+          angle ||= 0
+          color = "#{color},0,ffffff,1" if color.split(',').size == 1
+          "#{type},#{angle},#{color}"
+        when 'ls'
+          angle ||= 90
+          color = "#{color},0.2,ffffff,0.2" if color.split(',').size == 1
+          "#{type},#{angle},#{color}"
+        else
+          "#{type},#{color}"
+        end
+    end
+  end
+  
+  # A chart can have one or many legends. 
+  # Gchart.line(:legend => 'label')
+  # or
+  # Gchart.line(:legend => ['first label', 'last label'])
+  def set_legend
+    return set_labels if @type == :pie || @type == :pie_3d
+    
+    if @legend.is_a?(Array)
+      "chdl=#{@legend.map{|label| "#{label}"}.join('|')}"
+    else
+      "chdl=#{@legend}"
+    end
+    
+  end
+  
+  def set_labels
+     if @legend.is_a?(Array)
+        "chl=#{@legend.map{|label| "#{label}"}.join('|')}"
+      else
+        "chl=#{@legend}"
+      end
+  end
+  
+  def set_axis_with_labels
+    "chxt=#{@axis_with_labels}"
+  end
+  
+  def set_axis_labels
+    labels_arr = []
+    axis_labels.each_with_index{|labels,index| labels_arr << "#{index}:#{labels}"}
+    "chxl=#{labels_arr.join('|')}"
+    #"chxl=0:Jan|July|Jan|July|Jan|1:0|100|2:A|B|C|3:2005|2006|2007"
+  end
+  
+  def set_type
+    case @type
+      when :line
+        "cht=lc"
+      when :line_xy
+        "cht=lxy"
+      when :bar
+        "cht=b" + (horizontal? ? "h" : "v") + (grouped? ? "g" : "s")
+      when :pie_3d
+        "cht=p3"
+      when :pie
+        "cht=p"
+      when :venn
+        "cht=v"
+      when :scatter
+        "cht=s"
+      end
+  end
+  
+  def fill_type(type)
+    case type
+    when 'solid'
+      's'
+    when 'gradient'
+      'lg'
+    when 'stripes'
+      'ls'
+    end
+  end
+  
+  # Wraps a single dataset inside another array to support more datasets
+  def prepare_dataset(ds)
+    ds = [ds] unless ds.first.is_a?(Array)
+    ds
+  end
+  
+  def convert_to_simple_value(number)
+    if number.nil?
+      "_"
+    else
+      value = @@simple_chars[number.to_i]
+      value.nil? ? "_" : value
+    end
+  end
+  
+  # http://code.google.com/apis/chart/#simple
+  # Simple encoding has a resolution of 62 different values. 
+  # Allowing five pixels per data point, this is sufficient for line and bar charts up
+  # to about 300 pixels. Simple encoding is suitable for all other types of chart regardless of size.
+  def simple_encoding(dataset=[])
+    dataset = prepare_dataset(dataset)
+    @max_value = dataset.map{|ds| ds.max}.max if @max_value == 'auto'
+    
+    if @max_value == false || @max_value == 'false' || @max_value == :false
+      "s:" + dataset.map { |ds| ds.map { |number| convert_to_simple_value(number) }.join }.join(',')
+    else
+      "s:" + dataset.map { |ds| ds.map { |number| convert_to_simple_value( (@@simple_chars.size - 1) * number / @max_value) }.join }.join(',')
+    end
+    
+  end
+  
+  # http://code.google.com/apis/chart/#text
+  # Text encoding has a resolution of 1,000 different values, 
+  # using floating point numbers between 0.0 and 100.0. Allowing five pixels per data point, 
+  # integers (1.0, 2.0, and so on) are sufficient for line and bar charts up to about 500 pixels. 
+  # Include a single decimal place (35.7 for example) if you require higher resolution. 
+  # Text encoding is suitable for all other types of chart regardless of size.
+  def text_encoding(dataset=[])
+    dataset = prepare_dataset(dataset)
+    "t:" + dataset.map{ |ds| ds.join(',') }.join('|')
+  end
+  
+  def convert_to_extended_value(number)
+    if number.nil?
+      '__'
+    else
+      value = @@ext_pairs[number.to_i]
+      value.nil? ? "__" : value
+    end
+  end
+  
+  # http://code.google.com/apis/chart/#extended
+  # Extended encoding has a resolution of 4,096 different values 
+  # and is best used for large charts where a large data range is required.
+  def extended_encoding(dataset=[])
+    
+    dataset = prepare_dataset(dataset)
+    @max_value = dataset.map{|ds| ds.max}.max if @max_value == 'auto'
+    
+    if @max_value == false || @max_value == 'false' || @max_value == :false
+      "e:" +  dataset.map { |ds| ds.map { |number| convert_to_extended_value(number)}.join }.join(',')
+    else
+      "e:" + dataset.map { |ds| ds.map { |number| convert_to_extended_value( (@@ext_pairs.size - 1) * number / @max_value) }.join }.join(',')
+    end
+    
+  end
+  
+  
+  def query_builder
+    query_params = instance_variables.map do |var|
+      case var
+      # Set the graph size  
+      when '@width'
+        set_size unless @width.nil? || @height.nil?
+      when '@type'
+        set_type
+      when '@title'
+        set_title unless @title.nil?
+      when '@legend'
+        set_legend unless @legend.nil?
+      when '@bg_color'
+        set_colors
+      when '@chart_color'
+        set_colors
+      when '@data'
+        set_data unless @data == []
+      when '@bar_colors'
+        set_bar_colors
+      when '@axis_with_labels'
+        set_axis_with_labels
+      when '@axis_labels'
+        set_axis_labels
+      when '@custom'
+        @custom
+      end
+    end.compact
+    
+    jstize(@@url + query_params.join('&'))
+  end
+  
+end