RubyGems - gvis - Versions diffs - 1.0.2 - Mend

gvis 1.0.2

Files changed (7) hide show

data/MIT-LICENSE +20 -0
data/README +62 -0
data/Rakefile +23 -0
data/lib/data_table.rb +76 -0
data/lib/google_visualization.rb +122 -0
data/lib/gvis.rb +2 -0
metadata +72 -0

data/MIT-LICENSE ADDED

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+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 ADDED

@@ -0,0 +1,62 @@
+Gvis
+====
+Rails plugin that provides a Ruby wrapper for easily loading the Google Visualization API, and simple generation of the javascript required to plot the graphs
+version 2.X - Rails 3.X
+version 1.X - Rails 2.X
+Installation
+============
+Rails 3:
+# Gemfile
+gem 'gvis', '>= 2.0.1'
+Rails 2.X:
+# config/environment.rb
+config.gem 'gvis', :version => '< 2.0.0'
+# Include the GoogleVisualization module in app/helpers/application_helper.rb
+module ApplicationHelper
+  include GoogleVisualization
+end
+# Load the API, and render any graphs by placing these methods inside your layout
+# app/views/layouts/application.html.erb
+<head>
+	<%= include_visualization_api %>
+	<%= render_visualizations %>
+...
+</head>
+Example
+=======
+# Render desired graphs in the view
+# index.html.erb
+<% visualization "my_chart", "MotionChart", :width => 600, :height => 400, :html => {:class => "graph_chart"} do |chart| %>
+	<%# Add the columns that the graph will have %>
+	<% chart.string "Fruit" %>
+	<% chart.date "Date" %>
+	<% chart.number "Sales" %>
+	<% chart.number "Expenses" %>
+	<% chart.string "Location" %>
+	<%# Add the data %>
+	<% chart.add_rows([
+			["Apples", Date.new(1998,1,1), 1000,300,'East'],
+			["Oranges", Date.new(1998,1,1), 950,200,'West'],
+			["Bananas", Date.new(1998,1,1), 300,250,'West'],
+			["Apples", Date.new(1998,2,1), 1200,400,'East'],
+			["Oranges", Date.new(1998,2,1), 950,150,'West'],
+			["Bananas", Date.new(1998,2,1), 788,617,'West']
+		]) %>
+<% end %>
+Copyright (c) 2009 [Jeremy Olliver], released under the MIT license

data/Rakefile ADDED

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+desc 'Default: run unit tests.'
+task :default => :test
+desc 'Test the gvis plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+desc 'Generate documentation for the gvis plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Gvis'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/data_table.rb ADDED

@@ -0,0 +1,76 @@
+# Converts Ruby data structures into javascript strings for constructing the data for Google Visualization API clients.
+#
+# This library can be used to create a google.visualization.DataTable usable by
+# visualizations built on the Google Visualization API. Output formats are raw
+# JSON, JSON response, and JavaScript.
+#
+# written by Jeremy Olliver
+class DataTable
+  attr_accessor :data, :columns, :column_types
+  def initialize(data = nil, columns = [], options = {})
+    @columns, @column_types = [], {}
+    unless columns.nil? || columns.empty?
+      columns.each do |type, name|
+        register_column(type, name, options)
+      end
+    end
+    @data = data || []
+  end
+  # Registers each column explicitly, with data type, and a name associated
+  def register_column(type, name, options = {})
+    @columns << name.to_s
+    @column_types.merge!(name.to_s => type.to_s)
+  end
+  # Adds a single row to the table
+  def add_row(row)
+    @data << row
+  end
+  # Adds multiple rows (2D array) to the table
+  def add_rows(rows)
+    @data += rows
+  end
+  # Handle the Column definition methods (#string, #number, #date, #datetime)
+  def method_missing(method, *arguments)
+    if ["string", "number", "date", "datetime"].include?(method.to_s)
+      options = arguments.extract_options!
+      register_column(method, arguments, options)
+    else
+      raise NoMethodError.new(method)
+    end
+  end
+  ###################################################################################
+  # Format the ruby arrays into JS                                                  #
+  # Builds up a string representing a JS Array with JS escaped and formatted values #
+  ###################################################################################
+  def js_format_data
+    formatted_rows = []
+    @data.each do |row|
+      values = []
+      row.each_with_index do |entry,index|
+        # Format/escape individual values for javascript, checking column types, and the ruby value as a failsafe
+        safe_val = if @column_types[index] == "date" || entry.is_a?(Date)
+          # Format a date object as a javascript date
+          entry.is_a?(String) ? entry : "new Date (#{entry.year},#{entry.month - 1},#{entry.day})"
+        elsif @column_types[index] == "datetime" || entry.is_a?(Time)
+          # Format a Time (datetime) as a javascript date object down to seconds
+          entry.is_a?(String) ? entry : "new Date (#{entry.year},#{entry.month - 1},#{entry.day},#{entry.hour},#{entry.min},#{entry.sec})"
+        else
+          # Non date/time values can be JS escaped/formatted safely with # to_json
+          entry.to_json
+        end
+        values << safe_val
+      end
+      rowstring = "[#{values.join(",")}]"
+      formatted_rows << rowstring
+    end
+    "[#{formatted_rows.join(',')}]"
+  end
+end

data/lib/google_visualization.rb ADDED

@@ -0,0 +1,122 @@
+# Provides calls for simplifying the loading and use of the Google Visualization API
+#
+# For use with rails, include this Module in ApplicationHelper
+# See the Readme for usage details
+#
+# written by Jeremy Olliver
+module GoogleVisualization
+  attr_accessor :google_visualizations, :visualization_packages
+  #######################################################################
+  # Place these method calls inside the <head> tag in your layout file. #
+  #######################################################################
+  # Include the Visualization API code from google.
+  # (Omit this call if you prefer to include the API in your own js package)
+  def include_visualization_api
+    %Q(<!--Load the AJAX API--><script type="text/javascript" src="http://www.google.com/jsapi"></script>)
+  end
+  # This code actually inserts the visualization data
+  def render_visualizations
+    if @google_visualizations
+      package_list = []
+      @visualization_packages.uniq.each do |p|
+        package_list << "\'#{p.to_s.camelize.downcase}\'"
+      end
+      output = %Q(
+        <script type="text/javascript">
+          google.load('visualization', '1', {'packages':[#{package_list.uniq.join(',')}]});
+          google.setOnLoadCallback(drawCharts);
+          var chartData = {};
+          var visualizationCharts = {};
+          function drawCharts() { )
+            @google_visualizations.each do |id, vis|
+              output += generate_visualization(id, vis[0], vis[1], vis[2])
+            end
+      output += "} </script>"
+      output + "<!-- Rendered Google Visualizations /-->"
+    else
+      "<!-- No graphs on this page /-->"
+    end
+  end
+  ########################################################################
+  # Call this method from the view to insert the visualization data here #
+  # Will output a div with given id, and add the chart data to be        #
+  # rendered from the head of the page                                   #
+  ########################################################################
+  def visualization(id, chart_type, options = {}, &block)
+    init
+    chart_type = chart_type.camelize      # Camelize the chart type, as the Google API follows Camel Case conventions (e.g. ColumnChart, MotionChart)
+    options.stringify_keys!               # Ensure consistent hash access
+    @visualization_packages << chart_type # Add the chart type to the packages needed to be loaded
+    # Initialize the data table (with hashed options), and pass it the block for cleaner adding of attributes within the block
+    table = DataTable.new(options.delete("data"), options.delete("columns"), options)
+    if block_given?
+      yield table
+    end
+    # Extract the html options
+    html_options = options.delete("html") || {}
+    # Add our chart to the list to be rendered in the head tag
+    @google_visualizations.merge!(id => [chart_type, table, options])
+    # Output a div with given id, that our graph will be embedded into
+    html = ""
+    html_options.each do |key, value|
+      html += %Q(#{key}="#{value}" )
+    end
+    concat %Q(<div id="#{id}" #{html}><!-- /--></div>), block.binding
+    nil
+  end
+  protected
+  # Initialize instance variables
+  def init
+    @google_visualizations ||= {}
+    @visualization_packages ||=[]
+  end
+  ###################################################
+  # Internal methods for building the script data   #
+  ###################################################
+  def generate_visualization(id, chart, table, options={})
+    # Generate the js chart data
+    output = "chartData['#{id}'] = new google.visualization.DataTable();"
+    table.columns.each do |col|
+      output += "chartData['#{id}'].addColumn('#{table.column_types[col]}', '#{col}');"
+    end
+    option_str = make_opts_string(options)
+    output += %Q(
+      chartData['#{id}'].addRows(#{table.js_format_data});
+      visualizationCharts['#{id}'] = new google.visualization.#{chart.to_s.camelize}(document.getElementById('#{id}'));
+      visualizationCharts['#{id}'].draw(chartData['#{id}'], {#{option_str}});
+    )
+  end
+  # parse options into an array of key-value pairs
+  #
+  def make_opts_string(opts)
+    option_str = []
+    opts.each do |key, val|
+      str = "#{key}: "
+      if val.kind_of? Hash
+        str += "{" + make_opts_string(val) + "}"
+      elsif val.kind_of? Array
+        str += "[ " + val.collect { |v| "'#{v}'" }.join(", ") + " ]"
+      else
+        str += (val.kind_of?(String) ? "'#{val}'" : val.to_s)
+      end
+      option_str << str
+    end
+    return option_str.join(',')
+  end
+end

data/lib/gvis.rb ADDED

	@@ -0,0 +1,2 @@
1	+ require 'data_table'
2	+ require 'google_visualization'

metadata ADDED

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: gvis
+version: !ruby/object:Gem::Version
+  hash: 19
+  prerelease:
+  segments:
+  - 1
+  - 0
+  - 2
+  version: 1.0.2
+platform: ruby
+authors:
+- Jeremy Olliver
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-03-12 00:00:00 +13:00
+default_executable:
+dependencies: []
+description: Easily embed charts with Google Visualization API, using ruby formatted options in your view files
+email: jeremy.olliver@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README
+- Rakefile
+- MIT-LICENSE
+- lib/gvis.rb
+- lib/data_table.rb
+- lib/google_visualization.rb
+has_rdoc: true
+homepage: http://github.com/jeremyolliver/gvis
+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:
+rubygems_version: 1.6.1
+signing_key:
+specification_version: 3
+summary: Easily embed charts with Google Visualization API
+test_files: []