seer 0.4.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Corey Ehmke / SEO Logic
+
+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/README.rdoc

@@ -0,0 +1,49 @@
+=Seer
+
+Seer is a lightweight, semantically rich wrapper for the Google Visualization API. It allows you to easily create a visualization of data in a variety of formats, including area charts, bar charts, column charts, gauges, line charts, and pie charts.
+
+==Usage
+
+Add the following to the head of the page that will display a chart, or add it to your layout file:
+
+  <%= Seer::init_visualization -%>
+
+Gather the data you want to visualize in an instance variable in your controller, then use the visualize method to insert the appropriate chart in your view.
+
+== Example
+
+In your controller:
+
+  # @data must be an array, and each object in the array must respond to the data method specified
+  # in the visualize call (in this example, 'quantity')
+  @data = Widget.all
+  
+In your view:
+
+  <div id="chart" class="chart"></div>
+
+  <%= Seer::visualize(
+        @widgets, 
+        :as => :bar_chart,
+        :in_element => 'chart',
+        :series => {:series_label => 'name', :data_method => 'quantity'},
+        :chart_options => {
+          :height => 300,
+          :width => 200 * @widgets.size,
+          :is_3_d => false,
+          :legend => 'none',
+          :colors => ["#990000"],
+          :title => "Widget Quantities",
+          :title_x => 'Quantity',
+          :title_y => 'Widgets'
+        }
+      )
+   -%>
+
+== More information
+
+For examples of additional chart types, refer to the documentation for each of the individual chart objects, or see the blog post announcing Seer: {Simple, Semantic Graphing for Ruby on Rails with Seer}[http://www.idolhands.com/ruby-on-rails/gems-plugins-and-engines/graphing-for-ruby-on-rails-with-seer]
+
+Seer is developed and maintained by {Corey Ehmke}[http://www.idolhands.com/] at {SEO Logic}[http://www.seologic.com/].
+
+Copyright (c) 2010 Corey Ehmke / SEO Logic, released under the MIT license

data/Rakefile

@@ -0,0 +1,63 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "seer"
+    gem.summary = %Q{Seer is a lightweight, semantically rich wrapper for the Google Visualization API.}
+    gem.description = %Q{ Seer is a lightweight, semantically rich wrapper for the Google Visualization API. It allows you to easily create a visualization of data in a variety of formats, including area charts, bar charts, column charts, gauges, line charts, and pie charts.}
+    gem.email = "corey@seologic.com"
+    gem.homepage = "http://github.com/Bantik/seer"
+    gem.authors = ["Corey Ehmke / SEO Logic"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.files = [
+       "init.rb",
+       "lib/seer.rb",
+       "lib/seer/area_chart.rb",
+       "lib/seer/bar_chart.rb",
+       "lib/seer/chart.rb",
+       "lib/seer/column_chart.rb",
+       "lib/seer/gauge.rb",
+       "lib/seer/line_chart.rb",
+       "lib/seer/pie_chart.rb",
+       "lib/seer/visualization_helper.rb",
+       "LICENSE",
+       "Rakefile",
+       "README.rdoc",
+       "rails/init.rb",
+       "spec/spec.opts",
+       "spec/spec_helper.rb",
+       "spec/seer_spec.rb"
+    ]
+end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "seer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1 @@
+require 'seer'

data/lib/seer.rb

@@ -0,0 +1,58 @@
+module Seer
+
+  require 'seer/chart'
+  require 'seer/area_chart'
+  require 'seer/bar_chart'
+  require 'seer/column_chart'
+  require 'seer/gauge'
+  require 'seer/line_chart'
+  require 'seer/pie_chart'
+  
+  VISUALIZERS = [:area_chart, :bar_chart, :column_chart, :gauge, :line_chart, :pie_chart]
+  
+  def self.valid_hex_number?(val) #:nodoc:
+    return false unless val.is_a?(String) && ! val.empty?
+    ! (val =~ /^\#([0-9]|[a-f]|[A-F])+$/).nil? && val.length == 7
+  end
+
+  def self.log(message) #:nodoc:
+    RAILS_DEFAULT_LOGGER.info(message)
+  end
+
+  def self.init_visualization
+    %{<script type="text/javascript" src="http://www.google.com/jsapi"></script>      }
+  end
+  
+  def self.visualize(data, args={})
+    raise ArgumentError, "Seer: Invalid visualizer: #{args[:as]}" unless args[:as] && VISUALIZERS.include?(args[:as])
+    raise ArgumentError, "Seer: No data provided!" unless data && ! data.empty?
+    self.send(args[:as], data, args)
+  end
+
+  private
+  
+  def self.area_chart(data, args)
+    AreaChart.render(data, args)
+  end
+  
+  def self.bar_chart(data, args)
+    BarChart.render(data, args)
+  end
+  
+  def self.column_chart(data, args)
+    ColumnChart.render(data, args)
+  end
+  
+  def self.gauge(data, args)
+    Gauge.render(data, args)
+  end
+
+  def self.line_chart(data, args)
+    LineChart.render(data, args)
+  end
+
+  def self.pie_chart(data, args)
+    PieChart.render(data, args)
+  end
+  
+end

data/lib/seer/area_chart.rb

@@ -0,0 +1,133 @@
+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')
+  #
+  #   @series = @data.map{|w| w.widget_stats} # An array of arrays
+  #
+  # In your view:
+  #
+  #   <div id="chart" class="chart"></div>
+  #
+  #   <%= Seer::visualize(
+  #         @data, 
+  #         :as => :area_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/areachart.html
+  #
+  class AreaChart
+  
+    include Seer::Chart
+    
+    # Graph options
+    attr_accessor :axis_color, :axis_background_color, :axis_font_size, :background_color, :border_color, :data_table, :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
+    
+    # Graph data
+    attr_accessor :series_label, :data_label, :data, :data_method, :data_series
+    
+    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_series.first.map{|d| d.send(data_label)}.uniq.size});\r"
+      _data_columns << "            data.addColumn('string', 'Date');\r"
+      data.each do |datum|
+        _data_columns << "            data.addColumn('number', '#{datum.send(series_label)}');\r"
+      end
+      _data_columns
+    end
+    
+    def data_table #:nodoc:
+      _rows = data_series.first.map{|d| d.send(data_label)}.uniq
+      _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 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, :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':['areachart']});
+          google.setOnLoadCallback(drawChart);
+          function drawChart() {
+            var data = new google.visualization.DataTable();
+#{data_columns}
+#{data_table.to_s}
+            var options = {};
+#{options}
+            var container = document.getElementById('chart');
+            var chart = new google.visualization.AreaChart(container);
+            chart.draw(data, options);
+          }
+        </script>
+      }
+    end
+      
+    def self.render(data, args) #:nodoc:
+      graph = Seer::AreaChart.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/bar_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" class="chart"></div>
+  #
+  #   <%= Seer::visualize(
+  #         @widgets, 
+  #         :as => :bar_chart,
+  #         :in_element => 'chart',
+  #         :series => {:series_label => 'name', :data_method => 'quantity'},
+  #         :chart_options => {
+  #           :height => 300,
+  #           :width => 200 * @widgets.size,
+  #           :is_3_d => false,
+  #           :legend => 'none',
+  #           :colors => ["#990000"],
+  #           :title => "Widget Quantities",
+  #           :title_x => 'Quantity',
+  #           :title_y => 'Widgets'
+  #         }
+  #       )
+  #    -%>
+  #   
+  # Colors are treated differently for 2d and 3d graphs. If you set is_3_d to true, set the
+  # graph colors like this:
+  #
+  #           :colors   => "[{color:'#990000', darker:'#660000'}]",
+  #
+  # For details on the chart options, see the Google API docs at 
+  # http://code.google.com/apis/visualization/documentation/gallery/barchart.html
+  #
+  class BarChart
+  
+    include Seer::Chart
+    
+    # Chart options accessors
+    attr_accessor :axis_color, :axis_background_color, :axis_font_size, :background_color, :border_color, :data_table, :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, :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, :is_3_d, :is_stacked, :legend_font_size, :log_scale, :max, :min, :reverse_axis, :show_categories, :title_font_size, :tooltip_font_size, :tooltip_width]
+    end
+    
+    def string_options #:nodoc:
+      [:axis_color, :axis_background_color, :background_color, :border_color, :focus_border_color,  :height, :legend, :legend_background_color, :legend_text_color, :title, :title_x, :title_y, :title_color, :width]
+    end
+    
+    def to_js #:nodoc:
+
+      %{
+        <script type="text/javascript">
+          google.load('visualization', '1', {'packages':['barchart']});
+          google.setOnLoadCallback(drawChart);
+          function drawChart() {
+            var data = new google.visualization.DataTable();
+#{data_columns}
+#{data_table.to_s}
+            var options = {};
+#{options}
+            var container = document.getElementById('chart');
+            var chart = new google.visualization.BarChart(container);
+            chart.draw(data, options);
+          }
+        </script>
+      }
+    end
+      
+    def self.render(data, args) #:nodoc:
+      graph = Seer::BarChart.new(
+        :label_method   => args[:series][:series_label],
+        :data_method    => args[:series][:data_method],
+        :chart_options  => args[:chart_options],
+        :chart_element  => args[:in_element] || 'chart',
+        :data           => data
+      )
+      graph.to_js
+    end
+    
+  end  
+
+end