google_charts 1.0.0

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+# RubyMine
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in google_charts/.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Rudolf Schmidt
+
+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,59 @@
+= GoogleCharts
+
+GoogleCharts is a ruby wrapper to the Google Chart API (http://code.google.com/apis/charttools/)
+
+== Summary
+For now, the plugin supports the following charts:
+- pie chart
+- line chart
+- bar chart
+- column chart
+- area chart
+
+Basically, you can give the chart all the options you would give a GoogleChart when using the Google library: height, width, title, and so on...
+
+For a detailed description of which options to use visit the Google Visualization API and check out the charts there: http://code.google.com/apis/visualization/documentation/gallery.html
+
+
+== Installation
+script/plugin install git://github.com/rudionrails/google_charts.git
+
+
+== Usage
+GoogleCharts is based on a collection of elements (usually records from the database). They do not need to be ActiveRecord collections, simple arrays will do as well.
+
+For a simple pie chart, simply type this in your view:
+  <% pie_chart( [ [:eggs, 3], [:bacon, 1] ], { :height => 300, :is3D => true }, { :id => "breakfastChart" } ) do |c| -%>
+    <% c.title "breakfast" %>
+  
+    <% c.label "ingredient", :first %>
+    <% c.value "amount", :last %>
+  <% end -%>
+
+As you may imagine, the pie_chart cycles through the collection [ [:eggs, 3], [:bacon, 1] ]. In this example, every item is itself an array again which have a :first and :last method in ruby. Those methods are called. 
+
+
+Now you may ask yourself: thats nice, but how can I get labels or values in my pie chart that are not direct methods on the collection elements? Have no fear, lamda is our friend in this case. The same pie chart can be visualized by calling those methods differently:
+  <% pie_chart( [ [:eggs, 3], [:bacon, 1] ], { :height => 300, :is3D => true }, { :id => "breakfastChart" } ) do |c| -%>
+    <% c.title "breakfast" %>
+  
+    <% c.label "ingredient", lambda { |e| e[0] } %>
+    <% c.value "amount", lambda { |e| e[1] } %>
+  <% end -%>
+
+Now we get exactly the same chart, but it's been called in a different way via lamda. Like this, you can use view helpers such as number_to_currency, or any fancy helper method that will give you what you need. 
+
+
+Here's another example. Once again we have 3 eggs and 1 bacon, but now there's a price to the amounts which we can use in the displayed label:
+  <% pie_chart( [ [:eggs, 1.99, 3], [:bacon, 3.99, 1] ], { :height => 300, :is3D => true }, { :id => "breakfastChart" } ) do |c| -%>
+    <% c.title "breakfast" %>
+  
+    <% c.label "ingredient", lambda { |e| "#{e.last} #{e.first} for #{number_to_currency(e[1])}" } %>
+    <% c.value "amount", :last %>
+  <% end -%>
+
+
+One important thing to mention is, that you should always give the chart an :id. It will get a defaut "googleChart" id, but it may not work well for multiple charts on one page. Also, for charts that support 3D, you can always add the :is3D option (see examples above). All charts are interactive, there are no image charts as of now.
+
+
+Copyright (c) 2010 - 2011 Rudolf Schmidt, released under the MIT license.

data/Rakefile

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift( 'lib' )
+
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/google_charts.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "google_charts/version"
+
+Gem::Specification.new do |s|
+  s.name        = "google_charts"
+  s.version     = GoogleCharts::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Rudolf Schmidt"]
+  
+  s.homepage    = ""
+  s.summary     = %q{Google Charts with Ruby}
+  s.description = %q{GoogleCharts is a Ruby wrapper to the Google Chart API}
+
+  s.rubyforge_project = "google_charts"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "actionpack", "~> 2.x"
+end

data/init.rb

@@ -0,0 +1,9 @@
+require 'google_charts'
+
+begin
+  require 'actionpack'
+  ActionView::Base.send :include, GoogleCharts::Helpers::ActionView
+rescue LoadError
+  $stderr.puts "Skipping GoogleCharts plugin. `gem install actionpack` and try again."
+end
+

data/lib/google_charts.rb

@@ -0,0 +1,8 @@
+module GoogleCharts
+
+  autoload :Charts, File.dirname(__FILE__) + "/google_charts/charts"
+  autoload :Helpers, File.dirname(__FILE__) + "/google_charts/helpers"
+
+end
+
+

data/lib/google_charts/charts.rb

@@ -0,0 +1,12 @@
+module GoogleCharts
+  module Charts
+
+    autoload :Base,   File.dirname(__FILE__) + "/charts/base"
+    autoload :Pie,    File.dirname(__FILE__) + "/charts/pie"
+    autoload :Line,   File.dirname(__FILE__) + "/charts/line"
+    autoload :Area,   File.dirname(__FILE__) + "/charts/area"
+    autoload :Bar,    File.dirname(__FILE__) + "/charts/bar"
+    autoload :Column, File.dirname(__FILE__) + "/charts/column"
+
+  end
+end

data/lib/google_charts/charts/area.rb

@@ -0,0 +1,7 @@
+module GoogleCharts::Charts
+
+  class Area < GoogleCharts::Charts::Line
+  end
+
+end
+

data/lib/google_charts/charts/bar.rb

@@ -0,0 +1,7 @@
+module GoogleCharts::Charts
+
+  class Bar < GoogleCharts::Charts::Line
+  end
+
+end
+

data/lib/google_charts/charts/base.rb

@@ -0,0 +1,97 @@
+module GoogleCharts::Charts
+
+  class Base
+
+    def initialize( template, collection, options = {}, html_options = {} )
+      @template = template
+      @collection = collection
+
+      @options = options
+      @html_options = { :id => "googleChart" }.merge( html_options )
+
+      @columns, @rows = [], []
+    end
+    
+    def title( val ); @options[:title] = val; end
+
+    def to_html
+      setup_data
+
+      [
+        google_jsapi,
+        container_div,
+        google_chart
+      ].join("\n")
+    end
+
+
+    private
+
+    def packages; ['corechart'].to_json end
+
+    def value_for( method_or_proc, obj )
+      method_or_proc.is_a?( Proc ) ? method_or_proc.call( obj ) : obj.send( method_or_proc )
+    end
+
+    # stub
+    def setup_data; end
+
+    # === columns and rows
+    def columns
+      @columns.join( "\n" )
+    end
+
+    def add_column( type, value )
+      @columns << "data.addColumn( '#{type}', '#{value}' );"
+    end
+
+    def rows
+      [
+        "data.addRows([ ",
+        @rows.join( ", \n" ),
+        "]);"
+      ].join( "\n" )
+    end
+
+    def add_row( value )
+      @rows << value.to_json
+    end
+
+    def google_jsapi
+      @template.javascript_tag(
+        <<-EOS
+        // if( typeof google == 'undefined' ) {
+          document.write(unescape("%3Cscript src='http://www.google.com/jsapi' type='text/javascript'%3E%3C/script%3E"));
+        // };
+        EOS
+      )
+    end
+
+    def google_chart
+      @template.javascript_tag(
+        <<-EOS
+        google.load( "visualization", "1", { packages: #{packages} } );
+        google.setOnLoadCallback( function() {
+          var data = new google.visualization.DataTable();
+
+          #{columns}
+          #{rows}
+
+          var chart = new google.visualization.#{google_visualization_class}( document.getElementById('#{@html_options[:id]}') );
+          chart.draw( data, #{@options.to_json} );
+        });
+        EOS
+      )
+    end
+
+    def google_visualization_class
+      self.class.name.split( "::" ).last + 'Chart'
+    end
+
+    def container_div
+      @template.content_tag( :div, "", :id => @html_options[:id] )
+    end
+
+  end
+
+end

data/lib/google_charts/charts/column.rb

@@ -0,0 +1,7 @@
+module GoogleCharts::Charts
+
+  class Column < GoogleCharts::Charts::Line
+  end
+
+end
+

data/lib/google_charts/charts/line.rb

@@ -0,0 +1,32 @@
+module GoogleCharts::Charts
+
+  class Line < GoogleCharts::Charts::Base
+    def initialize( template, collection, options = {}, html_options = {} )
+      super
+
+      @label, @values = [], []
+    end
+
+    def label( name, method ); @label = [name, method]; end
+    def value( name, method ); @values << [name, method]; end
+
+
+    private
+
+    def setup_data
+      # setup the columns
+      add_column( 'string', @label.first )
+      @values.each { |val| add_column( 'number', val.first ) }
+
+      # setup the rows
+      @collection.each do |col|
+        label = value_for( @label.last, col )
+        values = @values.map { |value| value_for( value.last, col ) }
+
+        add_row( [label, *values] )
+      end
+    end
+  end
+
+end
+

data/lib/google_charts/charts/pie.rb

@@ -0,0 +1,28 @@
+module GoogleCharts::Charts
+
+  class Pie < GoogleCharts::Charts::Base
+    def initialize( template, collection, options = {}, html_options = {} )
+      super
+
+      @label, @value = [], []
+    end
+
+    def label( name, method ); @label = [name, method]; end
+    def value( name, method ); @value = [name, method]; end
+
+
+    private
+
+    def setup_data
+      # setup the columns
+      add_column( 'string', @label.first )
+      add_column( 'number', @value.first )
+
+      # setup the rows
+      @collection.each do |col|
+        add_row( [value_for( @label.last, col ), value_for( @value.last, col )] )
+      end
+    end
+  end
+
+end

data/lib/google_charts/helpers.rb

@@ -0,0 +1,7 @@
+module GoogleCharts
+  module Helpers
+
+    autoload :ActionView, File.dirname(__FILE__) + "/helpers/action_view"
+
+  end
+end

data/lib/google_charts/helpers/action_view.rb

@@ -0,0 +1,26 @@
+module GoogleCharts::Helpers
+
+  module ActionView
+
+    def self.define_helper( name, options = {} )
+      helper_name = [options[:prefix], name, options[:suffix]||'chart'].compact.join( '_' )
+
+      module_eval <<-DEF
+        def #{helper_name}( *options )
+          chart = GoogleCharts::Charts::#{name.to_s.capitalize}.new( self, *options )
+          yield chart if block_given?
+
+          concat chart.to_html
+        end
+      DEF
+    end
+
+    define_helper :line
+    define_helper :pie
+    define_helper :area
+    define_helper :bar
+    define_helper :column
+    
+  end
+
+end

data/lib/google_charts/version.rb

@@ -0,0 +1,3 @@
+module GoogleCharts
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: google_charts
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Rudolf Schmidt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-22 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 121
+        segments: 
+        - 2
+        - x
+        version: 2.x
+  type: :runtime
+  version_requirements: *id001
+description: GoogleCharts is a Ruby wrapper to the Google Chart API
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- google_charts.gemspec
+- init.rb
+- lib/google_charts.rb
+- lib/google_charts/charts.rb
+- lib/google_charts/charts/area.rb
+- lib/google_charts/charts/bar.rb
+- lib/google_charts/charts/base.rb
+- lib/google_charts/charts/column.rb
+- lib/google_charts/charts/line.rb
+- lib/google_charts/charts/pie.rb
+- lib/google_charts/helpers.rb
+- lib/google_charts/helpers/action_view.rb
+- lib/google_charts/version.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+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: google_charts
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Google Charts with Ruby
+test_files: []
+