glennr-seer 0.9.3

data/lib/seer/chart.rb

@@ -0,0 +1,68 @@
+module Seer
+
+  module Chart #:nodoc:
+
+    attr_accessor :chart_element, :colors
+
+    DEFAULT_COLORS = ['#324F69','#919E4B', '#A34D4D', '#BEC8BE']
+    DEFAULT_LEGEND_LOCATION = 'bottom'
+    DEFAULT_HEIGHT = 350
+    DEFAULT_WIDTH = 550
+
+    def hash_options
+      []
+    end
+
+    def in_element=(elem)
+      @chart_element = elem
+    end
+
+    def colors=(colors_list)
+      unless colors_list.include?('darker')
+        raise ArgumentError, "Invalid color option: #{colors_list}" unless colors_list.is_a?(Array)
+        colors_list.each do |color|
+          raise ArgumentError, "Invalid color option: #{colors_list}" unless Seer.valid_hex_number?(color)
+        end
+      end
+      @colors = colors_list
+    end
+
+    def formatted_colors
+      if @colors.include?('darker')
+        @colors
+      else
+        "[#{@colors.map{|color| "'#{color.gsub(/\#/,'')}'"} * ','}]"
+      end
+    end
+
+    def data_columns
+      _data_columns =  "            data.addRows(#{data_table.size});\r"
+      _data_columns << "            data.addColumn('string', '#{label_method}');\r"
+      _data_columns << "            data.addColumn('number', '#{data_method}');\r"
+      _data_columns
+    end
+
+    def options
+      _options = ""
+      nonstring_options.each do |opt|
+        next unless self.send(opt)
+        if opt == :colors
+          _options << "            options['#{opt.to_s.camelize(:lower)}'] = #{self.send(:formatted_colors)};\r"
+        else
+          _options << "            options['#{opt.to_s.camelize(:lower)}'] = #{self.send(opt)};\r"
+        end
+      end
+      string_options.each do |opt|
+        next unless self.send(opt)
+        _options << "            options['#{opt.to_s.camelize(:lower)}'] = '#{self.send(opt)}';\r"
+      end
+      hash_options.each do |opt|
+        next unless self.send(opt)
+        _options << "            options['#{opt.to_s.camelize(:lower)}'] = #{Seer.options_for_javascript(self.send(opt))};\r"
+      end
+      _options
+    end
+  end
+
+
+end

data/lib/seer/column_chart.rb

@@ -0,0 +1,124 @@
+module Seer
+
+  # =USAGE
+  #
+  # In your controller:
+  #
+  #   @data = Widgets.all # Must be an array, and must respond
+  #                       # to the data method specified below (in this example, 'quantity')
+  #
+  # In your view:
+  #
+  #   <div id="chart"></div>
+  #
+  #   <%= Seer::visualize(
+  #         @widgets,
+  #         :as => :column_chart,
+  #         :in_element => 'chart',
+  #         :series => {:series_label => 'name', :data_method => 'quantity'},
+  #         :chart_options => {
+  #           :height   => 300,
+  #           :width    => 300,
+  #           :is_3_d   => true,
+  #           :legend   => 'none',
+  #           :colors   => "[{color:'#990000', darker:'#660000'}]",
+  #           :title    => "Widget Quantities",
+  #           :title_x  => 'Widgets',
+  #           :title_y  => 'Quantities'
+  #         }
+  #       )
+  #    -%>
+  #
+  # Colors are treated differently for 2d and 3d graphs. If you set is_3_d to false, set the
+  # graph color like this:
+  #
+  #           :colors   => "#990000"
+  #
+  # For details on the chart options, see the Google API docs at
+  # http://code.google.com/apis/visualization/documentation/gallery/columnchart.html
+  #
+  class ColumnChart
+
+    include Seer::Chart
+
+    # Chart options accessors
+    attr_accessor :axis_color, :axis_background_color, :axis_font_size, :background_color, :border_color, :enable_tooltip, :focus_border_color, :height, :is_3_d, :is_stacked, :legend, :legend_background_color, :legend_font_size, :legend_text_color, :log_scale, :max, :min, :reverse_axis, :show_categories, :title, :title_x, :title_y, :title_color, :title_font_size, :tooltip_font_size, :tooltip_height, :tooltip_width, :width
+
+    # Graph data
+    attr_accessor :data, :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
+      @is_3_d ||= args[:chart_options][:is_3_d]
+
+      @data_table = []
+
+    end
+
+    def data_table #:nodoc:
+      data.each_with_index do |datum, column|
+        @data_table << [
+          "            data.setValue(#{column}, 0,'#{datum.send(label_method)}');\r",
+          "            data.setValue(#{column}, 1, #{datum.send(data_method)});\r"
+        ]
+      end
+      @data_table
+    end
+
+    def is_3_d #:nodoc:
+      @is_3_d.blank? ? false : @is_3_d
+    end
+
+    def nonstring_options #:nodoc:
+      [:axis_font_size, :colors, :enable_tooltip, :height, :is_3_d, :is_stacked, :legend_font_size, :log_scale, :max, :min, :reverse_axis, :show_categories, :title_font_size, :tooltip_font_size, :tooltip_width, :width]
+    end
+
+    def string_options #:nodoc:
+      [:axis_color, :axis_background_color, :background_color, :border_color, :focus_border_color, :legend, :legend_background_color, :legend_text_color, :title, :title_x, :title_y, :title_color]
+    end
+
+    def to_js #:nodoc:
+
+      %{
+        <script type="text/javascript">
+          google.load('visualization', '1', {'packages':['corechart']});
+          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 chart = new google.visualization.ColumnChart(container);
+            chart.draw(data, options);
+          }
+        </script>
+      }
+    end
+
+    def self.render(data, args) #:nodoc:
+      graph = Seer::ColumnChart.new(
+        :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'
+      )
+      graph.to_js
+    end
+
+  end
+
+end

data/lib/seer/gauge.rb

@@ -0,0 +1,119 @@
+module Seer
+
+  # =USAGE
+  # 
+  # In your controller:
+  #
+  #   @data = Widgets.all # Must be an array, and must respond
+  #                       # to the data method specified below (in this example, 'quantity')
+  #
+  # In your view:
+  #
+  #   <div id="chart"></div>
+  #   
+  #   <%= Seer::visualize(
+  #         @data, 
+  #         :as => :gauge,
+  #         :in_element => 'chart',
+  #         :series => {:series_label => 'name', :data_method => 'quantity'},
+  #         :chart_options => {
+  #           :green_from => 0,
+  #           :green_to => 50,
+  #           :height => 300,
+  #           :max => 100,
+  #           :min => 0,
+  #           :minor_ticks => 5,
+  #           :red_from => 76,
+  #           :red_to => 100,
+  #           :width => 600,
+  #           :yellow_from => 51,
+  #           :yellow_to => 75
+  #         }
+  #       )
+  #    -%>
+  #
+  # For details on the chart options, see the Google API docs at 
+  # http://code.google.com/apis/visualization/documentation/gallery/gauge.html
+  #
+  class Gauge
+  
+    include Seer::Chart
+    
+    # Chart options accessors
+    attr_accessor :green_from, :green_to, :height, :major_ticks, :max, :min, :minor_ticks, :red_from, :red_to, :width, :yellow_from, :yellow_to
+    
+    # Graph data
+    attr_accessor :data, :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      
+      @height ||= args[:chart_options][:height] || DEFAULT_HEIGHT
+      @width  ||= args[:chart_options][:width] || DEFAULT_WIDTH
+
+      @data_table = []
+      
+    end
+  
+    def data_table  #:nodoc:
+      data.each_with_index do |datum, column|
+        @data_table << [
+          "            data.setValue(#{column}, 0,'#{datum.send(label_method)}');\r",
+          "            data.setValue(#{column}, 1, #{datum.send(data_method)});\r"
+        ]
+      end
+      @data_table
+    end
+
+    def is_3_d  #:nodoc:
+      @is_3_d.blank? ? false : @is_3_d
+    end
+    
+    def nonstring_options  #:nodoc:
+      [:green_from, :green_to, :height, :major_ticks, :max, :min, :minor_ticks, :red_from, :red_to, :width, :yellow_from, :yellow_to]
+    end
+    
+    def string_options  #:nodoc:
+      []
+    end
+    
+    def to_js  #:nodoc:
+
+      %{
+        <script type="text/javascript">
+          google.load('visualization', '1', {'packages':['gauge']});
+          google.setOnLoadCallback(drawChart);
+          function drawChart() {
+            var data = new google.visualization.DataTable();
+#{data_columns}
+#{data_table.join}
+            var options = {};
+#{options}
+            var container = document.getElementById('#{self.chart_element}');
+            var chart = new google.visualization.Gauge(container);
+            chart.draw(data, options);
+          }
+        </script>
+      }
+    end
+      
+    def self.render(data, args)  #:nodoc:
+      graph = Seer::Gauge.new(
+        :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'
+      )
+      graph.to_js
+    end
+    
+  end  
+
+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', 'us_metro', '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