rgviz-rails 0.72 → 0.73

data/README.markdown

@@ -1,6 +1,8 @@
 rgviz-rails
 ===========
 
+[![Build Status](https://secure.travis-ci.org/asterite/rgviz-rails.png?branch=master)](http://travis-ci.org/asterite/rgviz-rails)
+
 This library makes it easy to implement a visualization data source so that you can easily chart or visualize your data from [ActiveRecord](http://ar.rubyonrails.org/) models or from in-memory arrays. the library implements the [Google Visualization API wire protocol](http://code.google.com/apis/visualization/documentation/dev/implementing_data_source.html).
 
 It also allows you to [render the visualizations in a view template](https://github.com/asterite/rgviz-rails/wiki/showing-a-visualization-in-a-view) in a very simple but powerful way.
@@ -18,7 +20,7 @@ Rails 3
 In your gemfile
 
     gem 'rgviz'
-    gem 'rgviz-rails'
+    gem 'rgviz-rails', :require => 'rgviz_rails'
 
 Rails 2.x
 ---------
@@ -26,7 +28,7 @@ Rails 2.x
 In your environment.rb
 
     config.gem "rgviz"
-    config.gem "rgviz-rails"
+    config.gem "rgviz-rails", :require => 'rgviz_rails'
 
 Usage
 -----
@@ -119,10 +121,36 @@ You can also apply a query over an array of arrays that contains your "records"
 
 This is very useful if you need to present visualizations against data coming from a csv file.
 
+Virtual columns
+---------------
+
+GQL is nice but it's not very powerful (except for the cute pivot clause).
+
+If you need to select columns using complex SQL, you might be able to do it with virtual columns.
+
+For example, in your controller you put:
+
+    render :rgviz => Person, :virtual_columns => {
+        'age_range' => {
+            :sql => "case when age < 20 then 'young' else 'old' end", 
+            :type => :string
+        }
+    }
+
+Then in a query you can do:
+
+select age_range ...
+
+Note that the keys of the virtual_columns hash must be strings. The value can be a hash with :sql and :type key-value pairs (since GQL needs the type of every column), or can be just a string if you want the column to be replaced by another GQL expression. For example:
+
+    render :rgviz => Person, :virtual_columns => {
+        'age_plus_two' => 'age + 2'
+    }
+
 Current limitations
 -------------------
 
-* the *format* clause works, but formatting is as in ruby (like "%.2f" for numbers, "foo %s bar" for strings, and "%y-%m-%d" for dates, as specified by time#strftime)
+* the *format* clause works, but formatting is as in ruby (like "%.2f" for numbers, "foo %s bar" for strings, and "%y-%m-%d" for dates, as specified by [Time#strftime](http://www.ruby-doc.org/core-1.9.3/Time.html#method-i-strftime))
 * only supports mysql, postgresql and sqlite adapters
 * these scalar functions are not supported for sqlite: *millisecond*, *quarter*
 * these scalar functions are not supported for mysql: *millisecond*

data/lib/rgviz_rails/view_helper.rb

@@ -23,6 +23,7 @@ module Rgviz
       conditions = options[:conditions]
       virtual_columns = options[:virtual_columns]
       package = options[:package]
+      load = options[:load]
 
       rgviz_events, google_events = events.partition{|x| x[0].to_s.start_with? 'rgviz'}
       rgviz_events = rgviz_events.inject(Hash.new){|h, y| h[y[0]] = y[1]; h}
@@ -104,13 +105,24 @@ module Rgviz
       visitor.params.each{|p| params << p unless params.include?(p)}
       params = params.sort!.map{|i| "param_#{i}"}
 
+      callback = "rgviz_draw_#{id}"
+
       out = ''
 
+      # Write the div
+      out << "<div id=\"#{id}\""
+      html.each do |key, value|
+        out << " #{key}=\"#{h value}\""
+      end
+      out << "></div>\n"
+
       # Output the google jsapi tag the first time
       @first_time ||= 1
-      if load_google && @first_time == 1
+
+      if load != :auto && load_google && @first_time == 1
         out << "<script type=\"text/javascript\" src=\"http://www.google.com/jsapi\"></script>\n"
       end
+
       # Now the real script
       out << "<script type=\"text/javascript\">\n"
 
@@ -156,25 +168,6 @@ module Rgviz
         @defined_rgviz_append = true
       end
 
-      if load_package
-        # Load visualizations and the package, if not already loaded
-        package ||= get_package(kind)
-
-        @packages ||= []
-        unless @packages.include?(package)
-          out << "google.load(\"visualization\", \"1\", {'packages':['#{package}']});\n"
-          @packages << package
-        end
-      end
-
-      callback = "rgviz_draw_#{id}"
-
-      # Set the callback if the function doesn't have params and if the
-      # user didn't request to hide the visualization
-      if !ajax && !hidden && params.empty?
-        out << "google.setOnLoadCallback(#{callback});\n"
-      end
-
       # Define the visualization var and data
       out << "var rgviz_#{id} = null;\n"
       out << "var rgviz_#{id}_data = null;\n"
@@ -222,19 +215,44 @@ module Rgviz
         out << "});\n"
       end
       out << "}\n"
+
+      if load != :auto && load_package
+        # Load visualizations and the package, if not already loaded
+        package ||= get_package(kind)
+
+        @packages ||= []
+        unless @packages.include?(package)
+          out << "google.load(\"visualization\", \"1\", {'packages':['#{package}']"
+
+          if load == :dynamic && !ajax && !hidden && params.empty?
+            out << ", 'callback': #{callback}"
+          end
+
+          out << "});\n"
+          @packages << package
+        end
+      end
+
+      # Set the callback if the function doesn't have params and if the
+      # user didn't request to hide the visualization
+      if !load && !ajax && !hidden && params.empty?
+        out << "google.setOnLoadCallback(#{callback});\n"
+      end
+
       out << "#{callback}()" if ajax
+
       out << "</script>\n"
 
-      # Write the div
-      out << "<div id=\"#{id}\""
-      html.each do |key, value|
-        out << " #{key}=\"#{h value}\""
+      if load == :auto && !ajax && !hidden && params.empty?
+        require 'cgi'
+
+        package ||= get_package(kind)
+        autoload = {'modules' => [{'name' => 'visualization', 'version' => '1', 'packages' => ["#{package}"], 'callback' => callback}]}
+        out << "<script type=\"text/javascript\" src=\"http://www.google.com/jsapi?autoload=#{CGI.escape autoload.to_json}\"></script>\n"
       end
-      out << "></div>\n"
 
       @first_time = 0
 
-
       if Rails::VERSION::MAJOR == 2
         out
       else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rgviz-rails
 version: !ruby/object:Gem::Version
-  version: '0.72'
+  version: '0.73'
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-30 00:00:00.000000000Z
+date: 2012-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rgviz
-  requirement: &70273597103400 !ruby/object:Gem::Requirement
+  requirement: &70257227777720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0.46'
   type: :runtime
   prerelease: false
-  version_requirements: *70273597103400
+  version_requirements: *70257227777720
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70273597102640 !ruby/object:Gem::Requirement
+  requirement: &70257227776920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70273597102640
+  version_requirements: *70257227776920
 description: 
 email: aborenszweig@manas.com.ar
 executables: []