google_charts 1.2.0 → 2.0.0.alpha.1

data/README.md

@@ -0,0 +1,84 @@
+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
+
+System wide:
+
+```console
+gem install google_charts
+```
+
+Or in your Gemfile:
+
+```ruby
+gem 'google_charts'
+```
+
+
+## Usage
+
+GoogleCharts is based on a collection of elements. Usually they are records from the database, but can also just be an array.
+
+The following **Stock** class is a Mongoid document and used to keep track of how much we have of any product in our online store. All we need is the product's name and the amount. For simplicity, we'll skip any default values or validations.
+
+```ruby
+class Stock
+  include Mongoid::Document
+
+  field :name,    type: String
+  field :amount,  type: Integer
+end
+```
+
+Now, let's supply some data for our store.
+
+```ruby
+Stock.create name: "Apple",  amount: 10
+Stock.create name: "Pear",   amount: 5
+Stock.create name: "Banana", amount: 1
+```
+
+### Example: Pie chart
+
+In order to figure out how much we have of any product, all we need to do is:
+
+```erb
+<%= pie_chart Stock.all do |c| %>
+  <% c.title "Total Stock" %>
+
+  <% c.label "Name",    :name %>
+  <% c.value "Amount",  :amount %>
+<% end %>
+```
+
+### Example: Pie chart with block parameters for label and value
+
+In order to dynamically display labels or values within a chart, you may also pass a block:
+
+```erb
+<%= pie_chart Stock.all do |c| %>
+  <% c.title "Total Stock" %>
+
+  <% c.label("Name")        { |s| "#{s.name} (percent)" } %>
+  <% c.value("Percentage")  { |s| s.amount / Stock.sum(:amount) * 100 } %>
+<% end %>
+
+```
+NOTE: I know that Stock.sum(:amount) is not good practice, but it serves the example.
+
+
+Copyright &copy; 2010 - 2012 Rudolf Schmidt, released under the MIT license.

data/init.rb

@@ -1,9 +1,2 @@
 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

@@ -1,8 +1,29 @@
 module GoogleCharts
 
   autoload :Charts, File.dirname(__FILE__) + "/google_charts/charts"
-  autoload :Helpers, File.dirname(__FILE__) + "/google_charts/helpers"
+
+  module Helpers
+    def self.define( 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?
+
+          chart.to_html
+        end
+      DEF
+    end
+
+    define :line
+    define :pie
+    define :area
+    define :bar
+    define :column
+  end
 
 end
 
+ActionView::Base.send :include, GoogleCharts::Helpers
 

data/lib/google_charts/charts/base.rb

@@ -2,12 +2,12 @@ module GoogleCharts::Charts
 
   class Base
 
-    def initialize( template, collection, options = {}, html_options = {} )
+    def initialize( template, collection, options = {} )
       @template = template
       @collection = collection
 
       @options = options
-      @html_options = { :id => "googleChart" }.merge( html_options )
+      @html_options = { :id => "googleChart" }.merge( options.delete(:html) || {} )
 
       @columns, @rows = [], []
     end
@@ -21,7 +21,7 @@ module GoogleCharts::Charts
         google_jsapi,
         container_div,
         google_chart
-      ].join("\n")
+      ].join("\n").html_safe
     end
 
 

data/lib/google_charts/charts/line.rb

@@ -1,14 +1,14 @@
 module GoogleCharts::Charts
 
   class Line < GoogleCharts::Charts::Base
-    def initialize( template, collection, options = {}, html_options = {} )
+    def initialize( template, collection, options = {} )
       super
 
       @label, @values = [], []
     end
 
-    def label( name, method ); @label = [name, method]; end
-    def value( name, method ); @values << [name, method]; end
+    def label(name, method = nil, &block); @label = [name, block ? block : method]; end
+    def value(name, method = nil, &block); @values << [name, block ? block : method]; end
 
 
     private

data/lib/google_charts/charts/pie.rb

@@ -1,14 +1,14 @@
 module GoogleCharts::Charts
 
   class Pie < GoogleCharts::Charts::Base
-    def initialize( template, collection, options = {}, html_options = {} )
+    def initialize( template, collection, options = {} )
       super
 
       @label, @value = [], []
     end
 
-    def label( name, method ); @label = [name, method]; end
-    def value( name, method ); @value = [name, method]; end
+    def label(name, method = nil, &block); @label = [name, block ? block : method]; end
+    def value(name, method = nil, &block); @value = [name, block ? block : method]; end
 
 
     private
@@ -20,7 +20,7 @@ module GoogleCharts::Charts
 
       # setup the rows
       @collection.each do |col|
-        add_row( [value_for( @label.last, col ), value_for( @value.last, col )] )
+        add_row( [value_for(@label.last, col), value_for(@value.last, col)] )
       end
     end
   end

data/lib/google_charts/version.rb

@@ -1,3 +1,4 @@
 module GoogleCharts
-  VERSION = '1.2.0'
+  VERSION = '2.0.0.alpha.1'
+
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: google_charts
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 1.2.0
+  prerelease: 6
+  version: 2.0.0.alpha.1
 platform: ruby
 authors: 
   - Rudolf Schmidt
@@ -10,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-12 00:00:00 +02:00
-default_executable: 
+date: 2012-02-09 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: actionpack
@@ -36,7 +35,7 @@ files:
   - .gitignore
   - Gemfile
   - LICENSE.txt
-  - README.rdoc
+  - README.md
   - Rakefile
   - google_charts.gemspec
   - init.rb
@@ -48,10 +47,7 @@ files:
   - 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: http://github.com/rudionrails/google_charts
 licenses: []
 
@@ -69,15 +65,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 1.3.1
 requirements: []
 
 rubyforge_project: google_charts
-rubygems_version: 1.5.1
+rubygems_version: 1.8.9
 signing_key: 
 specification_version: 3
 summary: Google Charts with Ruby
 test_files: []
 
+has_rdoc: 

data/README.rdoc

@@ -1,59 +0,0 @@
-= 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
-  gem install google_charts
-  
-
-== 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/lib/google_charts/helpers.rb

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

data/lib/google_charts/helpers/action_view.rb

@@ -1,26 +0,0 @@
-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