sylvaing-seer 0.7.1

data/lib/seer/chart.rb

@@ -0,0 +1,60 @@
+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 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
+      _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':['columnchart']});
+          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/line_chart.rb

@@ -0,0 +1,143 @@
+module Seer
+
+  # =USAGE
+  # 
+  # In your controller:
+  #
+  #   @data = Widgets.all # Must be an array of objects that respond to the specidied data method 
+  #                       # (In this example, 'quantity'
+  #
+  #   @series = @data.map{|w| w.widget_stats} # An array of arrays
+  #
+  # In your view:
+  #
+  #   <div id="chart"></div>
+  #
+  #   <%= Seer::visualize(
+  #         @data, 
+  #         :as => :line_chart,
+  #         :in_element => 'chart',
+  #         :series => {
+  #           :series_label => 'name',
+  #           :data_label => 'date',
+  #           :data_method => 'quantity',
+  #           :data_series => @series
+  #         },
+  #         :chart_options => { 
+  #           :height => 300,
+  #           :width => 300,
+  #           :axis_font_size => 11,
+  #           :colors => ['#7e7587','#990000','#009900'],
+  #           :title => "Widget Quantities",
+  #           :point_size => 5
+  #         }
+  #        )
+  #    -%>
+  #
+  # For details on the chart options, see the Google API docs at 
+  # http://code.google.com/apis/visualization/documentation/gallery/linechart.html
+  #
+  class LineChart
+  
+    include Seer::Chart
+    
+    # Graph options
+    attr_accessor :axis_color, :axis_background_color, :axis_font_size, :background_color, :border_color, :enable_tooltip, :focus_border_color, :height, :legend, :legend_background_color, :legend_font_size, :legend_text_color, :line_size, :log_scale, :max, :min, :point_size, :reverse_axis, :show_categories, :smooth_line, :title, :title_x, :title_y, :title_color, :title_font_size, :tooltip_font_size, :tooltip_height, :number, :tooltip_width, :width
+    
+    # Graph data
+    attr_accessor :data, :data_label, :data_method, :data_series, :data_table, :series_label
+    
+    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
+
+      @data_table = []
+      
+    end
+  
+    def data_columns  #:nodoc:
+      _data_columns =  "            data.addRows(#{data_rows.size});\r"
+      _data_columns << "            data.addColumn('string', 'Date');\r"
+      if data.first.respond_to?(series_label)
+        data.each{ |datum| _data_columns << "            data.addColumn('number', '#{datum.send(series_label)}');\r" }
+      else
+        data.each{ |datum| _data_columns << "            data.addColumn('number', '#{series_label}');\r" }
+      end
+      _data_columns
+    end
+    
+    def data_table  #:nodoc:
+      _rows = data_rows
+      _rows.each_with_index do |r,i|
+        @data_table << "            data.setCell(#{i}, 0,'#{r}');\r"
+      end
+      data_series.each_with_index do |column,i|
+        column.each_with_index do |c,j|
+          @data_table << "data.setCell(#{j},#{i+1},#{c.send(data_method)});\r"
+        end
+      end
+      @data_table
+    end
+    
+    def data_rows
+      data_series.inject([]) do |rows, element|
+        rows |= element.map { |e| e.send(data_label) }
+      end
+    end
+
+    def nonstring_options  #:nodoc:
+      [ :axis_font_size, :colors, :enable_tooltip, :height, :legend_font_size, :line_size, :log_scale, :max, :min, :point_size, :reverse_axis, :show_categories, :smooth_line, :title_font_size, :tooltip_font_size, :tooltip_height, :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':['linechart']});
+          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.LineChart(container);
+            chart.draw(data, options);
+          }
+        </script>
+      }
+    end
+      
+    # ====================================== Class Methods =========================================
+    
+    def self.render(data, args)  #:nodoc:
+      graph = Seer::LineChart.new(
+        :data => data,
+        :series_label   => args[:series][:series_label],
+        :data_series    => args[:series][:data_series],
+        :data_label     => args[:series][:data_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/pie_chart.rb

@@ -0,0 +1,116 @@
+module Seer
+
+  # =USAGE
+  # 
+  # In your controller:
+  #
+  #   @data = Widgets.all # Must be an array of objects that respond to the specidied data method 
+  #                       # (In this example, 'quantity'
+  #
+  # In your view:
+  #
+  #   <div id="chart"></div>
+  #
+  #   <%= Seer::visualize(
+  #         @data, 
+  #         :as => :pie_chart,
+  #         :series => {:series_label => 'name', :data_method => 'quantity'},
+  #         :chart_options => { 
+  #           :height => 300,
+  #           :width => 300,
+  #           :axis_font_size => 11,
+  #           :title => "Widget Quantities",
+  #           :point_size => 5,
+  #           :is_3_d => true
+  #         }
+  #        )
+  #    -%>
+  #   
+  # For details on the chart options, see the Google API docs at 
+  # http://code.google.com/apis/visualization/documentation/gallery/piechart.html
+  #
+  class PieChart
+  
+    include Seer::Chart
+    
+    # Chart options accessors
+    attr_accessor :background_color, :border_color, :enable_tooltip, :focus_border_color, :height, :is_3_d, :legend, :legend_background_color, :legend_font_size, :legend_text_color, :pie_join_angle, :pie_minimal_angle, :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:
+      [:colors, :enable_tooltip, :height, :is_3_d, :legend_font_size, :pie_join_angle, :pie_minimal_angle, :title_font_size, :tooltip_font_size, :tooltip_width, :width]
+    end
+    
+    def string_options #:nodoc:
+      [:background_color, :border_color, :focus_border_color, :legend, :legend_background_color, :legend_text_color, :title, :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.PieChart(container);
+            chart.draw(data, options);
+          }
+        </script>
+      }
+    end
+      
+    def self.render(data, args) #:nodoc:
+      graph = Seer::PieChart.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