glennr-seer 0.9.3

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':['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.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,128 @@
+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, :chart_area,
+                  :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, :pie_slice_text
+
+    # 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,
+        :pie_slice_text]
+    end
+
+    def hash_options #:nodoc:
+      [:chart_area]
+    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

data/spec/area_chart_spec.rb

@@ -0,0 +1,108 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Seer::AreaChart" do
+
+  before :each do
+    @chart = Seer::AreaChart.new(
+        :data => [0,1,2,3],
+        :series_label   => 'to_s',
+        :data_series => [[1,2,3],[3,4,5]],
+        :data_label => 'to_s',
+        :data_method => 'size',
+        :chart_options  => {},
+        :chart_element  => 'chart'
+     )
+  end
+  
+  describe 'defaults' do  
+    it_should_behave_like 'it sets default values'
+  end
+
+  describe 'graph options' do
+  
+    [:axis_color, :axis_background_color, :axis_font_size, :background_color, :border_color, :enable_tooltip, :focus_border_color, :height, :is_stacked, :legend, :legend_background_color, :legend_font_size, :legend_text_color, :line_size, :log_scale, :max, :min, :point_size, :reverse_axis, :show_categories, :title, :title_x, :title_y, :title_color, :title_font_size, :tooltip_font_size, :tooltip_height, :number, :tooltip_width, :width].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 =~ /areachart/).should be_true
+  end
+  
+  it 'sets its data columns' do
+    @chart.data_columns.should =~ /addRows\(5\)/
+    @chart.data_columns.should add_column('string', 'Date')
+    @chart.data_columns.should add_column('number', '0')
+    @chart.data_columns.should add_column('number', '1')
+    @chart.data_columns.should add_column('number', '2')
+    @chart.data_columns.should add_column('number', '3')
+  end
+  
+  it 'sets its data table' do
+    @chart.data_table.to_s.should set_cell(0, 0,'1')
+    @chart.data_table.to_s.should set_cell(1, 0,'2')
+    @chart.data_table.to_s.should set_cell(2, 0,'3')
+    @chart.data_table.to_s.should set_cell(3, 0,'4')
+    @chart.data_table.to_s.should set_cell(4, 0,'5')
+    @chart.data_table.to_s.should set_cell(0,1,8)
+    @chart.data_table.to_s.should set_cell(2,1,8)
+    @chart.data_table.to_s.should set_cell(0,2,8)
+    @chart.data_table.to_s.should set_cell(1,2,8)
+    @chart.data_table.to_s.should set_cell(2,2,8)
+  end
+  
+  describe 'when data_series is an array of arrays of arrays/hashes' do
+    before(:each) do 
+      data_series = Array.new(3) {|i| [[i, i+1], [i+1, i+2]]}
+      @chart = Seer::AreaChart.new(
+          :data => [0,1,2,3],
+          :series_label   => 'to_s',
+          :data_series => data_series,
+          :data_label => 'first',
+          :data_method => 'size',
+          :chart_options  => {},
+          :chart_element  => 'chart'
+       )
+     end
+
+    it 'calculates number of rows' do
+      @chart.data_columns.should =~ /addRows\(4\)/     
+    end
+    
+    it 'sets its data table' do 
+      @chart.data_table.to_s.should set_cell(0, 0,'0')
+      @chart.data_table.to_s.should set_cell(1, 0,'1')
+      @chart.data_table.to_s.should set_cell(2, 0,'2')
+      @chart.data_table.to_s.should set_cell(3, 0,'3')
+    end
+  end
+  
+  describe 'should receive options' do 
+    before(:each) do 
+      data_series = Array.new(3) {|i| [[i, i+1], [i+1, i+2]]}
+      @options = {
+          :data => [0,1,2,3],
+          :series_label   => 'to_s',
+          :data_series => data_series,
+          :data_label => 'first',
+          :data_method => 'size',
+          :chart_options  => {},
+          :chart_element  => 'chart'
+      }
+    end
+    
+    it 'should receive :is_stacked option' do 
+      create_chart_with_option(:is_stacked => true).to_js.should =~ /options\['isStacked'\] = true/
+      end
+  end
+end
+
+def create_chart_with_option(option)
+      Seer::AreaChart.new(@options.merge(option))
+end

data/spec/bar_chart_spec.rb

@@ -0,0 +1,51 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Seer::BarChart" do
+
+  before :each do
+    @chart = Seer::BarChart.new(
+      :data => [0,1,2,3],
+      :label_method   => 'to_s',
+      :data_method => 'size',
+      :chart_options  => {},
+      :chart_element  => 'chart'
+     )
+  end
+  
+  describe 'defaults' do
+    it_should_behave_like 'it sets default values'
+  end
+
+  describe 'graph options' do
+  
+    [: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].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 =~ /barchart/).should be_true
+  end
+  
+  it 'sets its data columns' do
+    @chart.data_columns.should =~ /addRows\(4\)/
+  end
+  
+  it 'sets its data table' do
+    @chart.data_table.to_s.should set_value(0, 0,'0')
+    @chart.data_table.to_s.should set_value(0, 1, 8)
+    @chart.data_table.to_s.should set_value(1, 0,'1')
+    @chart.data_table.to_s.should set_value(1, 1, 8)
+    @chart.data_table.to_s.should set_value(2, 0,'2')
+    @chart.data_table.to_s.should set_value(2, 1, 8)
+    @chart.data_table.to_s.should set_value(3, 0,'3')
+    @chart.data_table.to_s.should set_value(3, 1, 8)
+  end
+  
+end

data/spec/chart_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Seer::Chart" do
+
+  before :all do
+    @chart = Seer::AreaChart.new(
+        :data => [0,1,2,3],
+        :series_label   => 'to_s',
+        :data_series => [[1,2,3],[3,4,5]],
+        :data_label => 'to_s',
+        :data_method => 'size',
+        :chart_options  => { 
+          :legend => 'right',
+          :title_x => 'Something'
+        },
+        :chart_element  => 'chart'
+     )
+  end
+  
+  it 'sets the chart element' do
+    @chart.in_element = 'foo'
+    @chart.chart_element.should == 'foo'
+  end
+  
+  describe 'sets colors' do
+  
+    it 'accepting valid values' do
+      @chart.colors = ["#ff0000", "#00ff00"]
+      @chart.colors.should == ["#ff0000", "#00ff00"]
+    end
+    
+    it 'raising an error on invalid values' do
+      lambda do
+        @chart.colors = 'fred'
+      end.should raise_error(ArgumentError)
+      lambda do
+        @chart.colors = [0,1,2]
+      end.should raise_error(ArgumentError)
+    end
+    
+  end
+ 
+  it 'formats colors' do
+    @chart.colors = ["#ff0000"]
+    @chart.formatted_colors.should == "['ff0000']"
+  end
+  
+  it 'sets its data columns' do
+    @chart.data_columns.should =~ /addRows\(5\)/
+    @chart.data_columns.should =~ /addColumn\('string', 'Date'\)/
+    @chart.data_columns.should =~ /addColumn\('number', '0'\)/
+    @chart.data_columns.should =~ /addColumn\('number', '1'\)/
+    @chart.data_columns.should =~ /addColumn\('number', '2'\)/
+    @chart.data_columns.should =~ /addColumn\('number', '3'\)/
+  end
+  
+  it 'sets its options' do
+    @chart.options.should =~ /options\['titleX'\] = 'Something'/
+  end
+  
+  
+end