seer 0.7.0 → 0.9.0

data/Rakefile

@@ -20,6 +20,7 @@ begin
        "lib/seer/chart.rb",
        "lib/seer/column_chart.rb",
        "lib/seer/gauge.rb",
+       "lib/seer/geomap.rb",
        "lib/seer/line_chart.rb",
        "lib/seer/pie_chart.rb",
        "lib/seer/visualization_helper.rb",

data/lib/seer.rb

@@ -5,10 +5,11 @@ module Seer
   require 'seer/bar_chart'
   require 'seer/column_chart'
   require 'seer/gauge'
+  require 'seer/geomap'
   require 'seer/line_chart'
   require 'seer/pie_chart'
   
-  VISUALIZERS = [:area_chart, :bar_chart, :column_chart, :gauge, :line_chart, :pie_chart]
+  VISUALIZERS = [:area_chart, :bar_chart, :column_chart, :gauge, :geomap, :line_chart, :pie_chart]
   
   def self.valid_hex_number?(val) #:nodoc:
     return false unless val.is_a?(String) && ! val.empty?
@@ -52,6 +53,10 @@ module Seer
     Gauge.render(data, args)
   end
 
+  def self.geomap(data, args)
+    Geomap.render(data, args)
+  end
+
   def self.line_chart(data, args)
     LineChart.render(data, args)
   end

data/lib/seer/geomap.rb

@@ -0,0 +1,166 @@
+module Seer
+
+  # Geomap creates a map of a country, continent, or region, with colors and values assigned to
+  # specific regions. Values are displayed as a color scale, and you can specify optional hovertext 
+  # for regions.
+  #
+  # =USAGE=
+  # 
+  # In your view:
+  #
+  #   <div id="my_geomap_container" class="chart"></div>
+  #
+  #   <%= Seer::visualize(
+  #         @widgets,
+  #         :as => :geomap,
+  #         :in_element => 'my_geomap_container',
+  #         :series => {
+  #           :series_label => 'name',
+  #           :data_label => '# widgets',
+  #           :data_method => 'quantity'
+  #         },
+  #         :chart_options => {
+  #           :data_mode => 'regions',
+  #           :region => 'US',
+  #         }  
+  #       )
+  #   -%>
+  #
+  # ==@widgets==
+  #
+  # A collection of objects (ActiveRecord or otherwise) that must respond to the
+  # following methods:
+  #
+  #   latitude  # => returns the latitude in decimal format
+  #   longitude # => returns the longitude in decimal format
+  #   geocoded? # => result of latitude && longitude
+  #
+  # For details on the chart options, see the Google API docs at 
+  # http://code.google.com/apis/visualization/documentation/gallery/geomap.html
+  #
+  class Geomap
+  
+    include Seer::Chart
+
+    COUNTRY_CODES = ['world', 'AX', 'AF', 'AL', 'DZ', 'AS', 'AD', 'AO', 'AI', 'AQ', 'AG', 'AR', 'AM', 'AW', 'AU', 'AT', 'AZ', 'BS', 'BH', 'BD', 'BB', 'BY', 'BE', 'BZ', 'BJ', 'BM', 'BT', 'BO', 'BA', 'BW', 'BV', 'BR', 'IO', 'BN', 'BG', 'BF', 'BI', 'KH', 'CM', 'CA', 'CV', 'KY', 'CF', 'TD', 'CL', 'CN', 'CX', 'CC', 'CO', 'KM', 'CD', 'CG', 'CK', 'CR', 'CI', 'HR', 'CU', 'CY', 'CZ', 'DK', 'DJ', 'DM', 'DO', 'EC', 'EG', 'SV', 'GQ', 'ER', 'EE', 'ET', 'FK', 'FO', 'FJ', 'FI', 'FR', 'GF', 'PF', 'TF', 'GA', 'GM', 'GE', 'DE', 'GH', 'GI', 'GR', 'GL', 'GD', 'GP', 'GU', 'GT', 'GN', 'GW', 'GY', 'HT', 'HM', 'HN', 'HK', 'HU', 'IS', 'IN', 'ID', 'IR', 'IQ', 'IE', 'IL', 'IT', 'JM', 'JP', 'JO', 'KZ', 'KE', 'KI', 'KP', 'KR', 'KW', 'KG', 'LA', 'LV', 'LB', 'LS', 'LR', 'LY', 'LI', 'LT', 'LU', 'MO', 'MK', 'MG', 'MW', 'MY', 'MV', 'ML', 'MT', 'MH', 'MQ', 'MR', 'MU', 'YT', 'MX', 'FM', 'MD', 'MC', 'MN', 'MS', 'MA', 'MZ', 'MM', 'NA', 'NR', 'NP', 'NL', 'AN', 'NC', 'NZ', 'NI', 'NE', 'NG', 'NU', 'NF', 'MP', 'NO', 'OM', 'PK', 'PW', 'PS', 'PA', 'PG', 'PY', 'PE', 'PH', 'PN', 'PL', 'PT', 'PR', 'QA', 'RE', 'RO', 'RU', 'RW', 'SH', 'KN', 'LC', 'PM', 'VC', 'WS', 'SM', 'ST', 'SA', 'SN', 'CS', 'SC', 'SL', 'SG', 'SK', 'SI', 'SB', 'SO', 'ZA', 'GS', 'ES', 'LK', 'SD', 'SR', 'SJ', 'SZ', 'SE', 'CH', 'SY', 'TW', 'TJ', 'TZ', 'TH', 'TL', 'TG', 'TK', 'TO', 'TT', 'TN', 'TR', 'TM', 'TC', 'TV', 'UG', 'UA', 'AE', 'GB', 'US', 'UM', 'UY', 'UZ', 'VU', 'VA', 'VE', 'VN', 'VG', 'VI', 'WF', 'EH', 'YE', 'ZM', 'ZW', '005', '013', '021', '002', '017', '015', '018', '030', '034', '035', '143', '145', '151', '154', '155', '039']
+  
+    # Chart options accessors
+    attr_accessor :data_mode, :enable_tooltip, :height, :legend_background_color, :legend_font_size, :legend_text_color, :legend, :region, :show_legend, :show_zoom_out, :title_color, :title_font_size, :title_x, :title_y, :title, :tooltip_font_size, :tooltip_height, :tooltip_width, :width, :zoom_out_label
+    
+    # Graph data
+    attr_accessor :data, :data_label, :data_method, :data_table, :label_method
+    
+    def initialize(args={}) #:nodoc:
+    
+      # Standard options
+      args.each{ |method,arg| self.send("#{method}=",arg) if self.respond_to?(method) }
+
+      # Chart options
+      args[:chart_options].each{ |method, arg| self.send("#{method}=",arg) if self.respond_to?(method) }
+
+      # Handle defaults
+      @colors ||= args[:chart_options][:colors] || DEFAULT_COLORS
+      @legend ||= args[:chart_options][:legend] || DEFAULT_LEGEND_LOCATION
+      @height ||= args[:chart_options][:height] || DEFAULT_HEIGHT
+      @width  ||= args[:chart_options][:width]  || DEFAULT_WIDTH
+
+    end
+  
+    def data_columns #:nodoc:
+      _data_columns = "data.addRows(#{data_table.size});"
+      if self.data_mode == 'markers'
+        _data_columns << %{
+          data.addColumn('number', 'LATITUDE');
+          data.addColumn('number', 'LONGITUDE');
+          data.addColumn('number', '#{data_method}');
+          data.addColumn('string', '#{label_method}');
+        }
+      else
+        _data_columns << "          data.addColumn('string', '#{label_method}');"
+        _data_columns << "          data.addColumn('number', '#{data_method}');"
+        _data_columns
+      end
+      _data_columns
+    end
+    
+    def data_mode=(mode) #:nodoc:
+      raise ArgumentError, "Invalid data mode option: #{mode}. Must be one of 'regions' or 'markers'." unless ['regions', 'markers'].include?(mode)
+      @data_mode = mode
+    end
+
+    def data_table #:nodoc:
+      @data_table = []
+      data.each_with_index do |datum, column|
+        next unless datum.geocoded?
+        if data_mode == "markers"
+          @data_table << [
+            "            data.setValue(#{column}, 0, #{datum.latitude});\r",
+            "            data.setValue(#{column}, 1, #{datum.longitude});\r",
+            "            data.setValue(#{column}, 2, #{datum.send(data_method)});\r",
+            "            data.setValue(#{column}, 3, '#{datum.send(label_method)}');\r"
+          ]
+        else # Regions
+          @data_table << [
+            "            data.setValue(#{column}, 0, '#{datum.name}');\r",
+            "            data.setValue(#{column}, 1, #{datum.send(data_method)});\r"
+          ]
+        end
+      end
+      @data_table
+    end
+  
+    # Because Google is not consistent in their @#!$ API...
+    def formatted_colors
+      "[#{@colors.map{|color| "'#{color.gsub(/\#/,'0x')}'"} * ','}]"
+    end
+    
+    def nonstring_options  #:nodoc:
+      [:colors, :enable_tooltip, :height, :legend_font_size, :title_font_size, :tooltip_font_size, :tooltip_width, :width]
+    end
+    
+    def string_options #:nodoc:
+      [:data_mode, :legend, :legend_background_color, :legend_text_color, :title, :title_x, :title_y, :title_color, :region]
+    end
+    
+    def to_js
+      %{
+        <script type="text/javascript">
+          google.load('visualization', '1', {'packages':['geomap']});
+          google.setOnLoadCallback(drawChart);
+          function drawChart() {
+            var data = new google.visualization.DataTable();
+#{data_columns}
+#{data_table.to_s}
+            var options = {};
+#{options}
+            var container = document.getElementById('#{self.chart_element}');
+            var geomap = new google.visualization.GeoMap(container);
+            geomap.draw(data, options);
+          }
+        </script>
+      }
+    end
+    
+    def region=(desired_region)
+      raise ArgumentError, "Invalid region: #{desired_region}" unless COUNTRY_CODES.include?(desired_region)
+      @region = desired_region
+    end
+  
+    # ====================================== Class Methods =========================================
+    
+    def self.render(data, args)
+      map = Seer::Geomap.new(
+        :region         => args[:chart_options][:region],
+        :data_mode      => args[:chart_options][:data_mode],
+        :data           => data,
+        :label_method   => args[:series][:series_label],
+        :data_method    => args[:series][:data_method],
+        :chart_options  => args[:chart_options],
+        :chart_element  => args[:in_element] || 'chart'
+      )
+      map.to_js
+    end
+    
+  end  
+
+end

data/spec/geomap_spec.rb

@@ -0,0 +1,67 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Seer::Geomap" do
+
+  before :each do
+
+    class GeoThing
+      def initialize; end
+      def name; 'foo'; end
+      def latitude; -90; end
+      def longitude; -90; end
+      def count; 8; end
+      def geocoded?; true; end
+    end
+  
+    @chart = Seer::Geomap.new(
+        :data => [GeoThing.new, GeoThing.new, GeoThing.new],
+        :label_method   => 'name',
+        :data_method => 'count',
+        :chart_options  => {},
+        :chart_element  => 'geochart'
+     )
+  end
+  
+  describe 'defaults' do
+  
+    it 'height' do
+      @chart.height.should == Seer::Chart::DEFAULT_HEIGHT
+    end
+    
+    it 'width' do
+      @chart.width.should == Seer::Chart::DEFAULT_WIDTH
+    end
+    
+  end
+
+  describe 'graph options' do
+  
+    [:show_zoom_out, :zoom_out_label].each do |accessor|
+      it "sets its #{accessor} value" do
+        @chart.send("#{accessor}=", 'foo')
+        @chart.send(accessor).should == 'foo'
+      end
+    end
+    
+      it_should_behave_like 'it has colors attribute'
+  end
+  
+  it 'renders as JavaScript' do
+    (@chart.to_js =~ /javascript/).should be_true
+    (@chart.to_js =~ /geomap/).should be_true
+  end
+  
+  it 'sets its data columns' do
+    @chart.data_columns.should =~ /addRows\(3\)/
+  end
+  
+  it 'sets its data table' do
+    @chart.data_table.to_s.should set_value(0, 0,'foo')
+    @chart.data_table.to_s.should set_value(0, 1, 8)
+    @chart.data_table.to_s.should set_value(1, 0,'foo')
+    @chart.data_table.to_s.should set_value(1, 1, 8)
+    @chart.data_table.to_s.should set_value(2, 0,'foo')
+    @chart.data_table.to_s.should set_value(2, 1, 8)
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,8 +1,8 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'rubygems'
-require 'active_support'
 require 'action_pack'
+require 'active_support'
 require 'spec'
 require 'spec/autorun'
 require 'seer'

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: seer
 version: !ruby/object:Gem::Version 
+  hash: 59
   prerelease: false
   segments: 
   - 0
-  - 7
+  - 9
   - 0
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors: 
 - Corey Ehmke / SEO Logic
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-11 00:00:00 -05:00
+date: 2010-09-08 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 1
         - 2
@@ -52,11 +55,22 @@ files:
 - lib/seer/chart.rb
 - lib/seer/column_chart.rb
 - lib/seer/gauge.rb
+- lib/seer/geomap.rb
 - lib/seer/line_chart.rb
 - lib/seer/pie_chart.rb
 - spec/seer_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/area_chart_spec.rb
+- spec/bar_chart_spec.rb
+- spec/chart_spec.rb
+- spec/column_chart_spec.rb
+- spec/custom_matchers.rb
+- spec/gauge_spec.rb
+- spec/geomap_spec.rb
+- spec/helpers.rb
+- spec/line_chart_spec.rb
+- spec/pie_chart_spec.rb
 has_rdoc: true
 homepage: http://github.com/Bantik/seer
 licenses: []
@@ -67,23 +81,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Seer is a lightweight, semantically rich wrapper for the Google Visualization API.
@@ -94,6 +112,7 @@ test_files:
 - spec/column_chart_spec.rb
 - spec/custom_matchers.rb
 - spec/gauge_spec.rb
+- spec/geomap_spec.rb
 - spec/helpers.rb
 - spec/line_chart_spec.rb
 - spec/pie_chart_spec.rb