rgviz-rails 0.67 → 0.68

data/README.markdown

@@ -0,0 +1,135 @@
+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.
+
+this library is built on top of [rgviz](https://github.com/asterite/rgviz).
+
+installation
+------------
+
+    gem install rgviz-rails
+
+rails 3
+-------
+
+in your gemfile
+
+    gem 'rgviz'
+    gem 'rgviz-rails', :require => 'rgviz_rails'
+
+rails 2.x
+---------
+
+in your environment.rb
+
+    config.gem "rgviz"
+    config.gem "rgviz-rails", :lib => 'rgviz_rails'
+
+usage
+-----
+
+to make a method in your controller be a visualization api endpoint:
+
+    class vizcontroller < applicationcontroller
+      def person
+        # person is an activerecord::base class
+        render :rgviz => person
+      end
+    end
+
+so for example if <tt>person</tt> has <tt>name</tt> and <tt>age</tt>, pointing your browser to:
+
+    http://localhost:3000/viz/person?select name where age > 20 limit 5
+
+would render the necessary javascript code that implements the google visualization api wire protocol.
+
+associations
+------------
+
+if you want to filter, order by or group by columns that are in a model's association you can use underscores. this is better understood with an example:
+
+    class person < activerecord::base
+      belongs_to :city
+    end
+
+    class city < activerecord::base
+      belongs_to :country
+    end
+
+    class country < activerecord::base
+    end
+
+to select the name of the city each person belongs to:
+
+    select city_name
+
+to select the name of the country of the city each person belongs to:
+
+    select city_country_name
+
+a slightly more complex example:
+
+    select avg(age) where city_country_name = 'argentina' group by city_name
+
+the library will make it in just one query, writing all the sql joins for you.
+
+extra conditions
+----------------
+
+sometimes you want to limit your results the query will work with. you can do it like this:
+
+    render :rgviz => person, :conditions => ['age > ?', 20]
+
+or also:
+
+    render :rgviz => person, :conditions => 'age > 20'
+
+preprocessing
+-------------
+
+if you need to tweak a result before returning it, just include a block:
+
+    render :rgviz => person do |table|
+      # modify the rgviz::table object
+    end
+
+showing a visualization in a view
+---------------------------------
+
+you can invoke the rgviz method in your views. [read more about this](https://github.com/asterite/rgviz-rails/wiki/showing-a-visualization-in-a-view).
+
+you can always do it the [old way](http://code.google.com/apis/visualization/documentation/using_overview.html).
+
+executing queries over in-memory arrays
+---------------------------------------
+
+you can also apply a query over an array of arrays that contains your "records" to be queried.
+
+    types = [[:id, :number], [:name, :string], [:age, :number]]
+    records = [
+      [1, 'john', 23],
+      [2, 'pete', 36]
+    ]
+    executor = rgviz::memoryexecutor.new records, types
+
+    render :rgviz => executor
+
+this is very useful if you need to present visualizations against data coming from a csv file.
+
+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)
+* 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*
+* the function *toDate* doesn't accept a number as its argument
+* the *tsv* output format is not supported
+
+contributors
+------------
+
+* [brad seefeld](https://github.com/bradseefeld)

data/lib/rgviz_rails/executor.rb

@@ -2,6 +2,7 @@ module Rgviz
   class Executor
     attr_reader :model_class
     attr_reader :adapter
+    attr_reader :virtual_columns
 
     def initialize(model_class)
       @model_class = model_class
@@ -27,11 +28,13 @@ module Rgviz
 
     def execute(query, options = {})
       @query = query
-      @query = RgvizRails::Parser.parse(@query, options) unless @query.kind_of?(Query)
+      @query = RgvizRails::Parser.parse(@query) unless @query.kind_of?(Query)
 
       @table = Table.new
       @extra_conditions = options[:conditions]
+      @virtual_columns = options[:virtual_columns]
 
+      process_virtual_columns
       process_pivot
       process_labels
       process_formats
@@ -46,6 +49,17 @@ module Rgviz
       @table
     end
 
+    def process_virtual_columns
+      return unless @virtual_columns
+
+      @virtual_columns.each do |key, value|
+        if value.is_a?(String) || value[:gql]
+          parser = RgvizRails::Parser.new(value.is_a?(String) ? value : value[:gql])
+          @virtual_columns[key] = {:gql => parser.parse_column}
+        end
+      end
+    end
+
     def process_labels
       return unless @query.labels.present?
 
@@ -319,6 +333,10 @@ module Rgviz
     def column_type(col)
       case col
       when IdColumn
+        if @virtual_columns && (vc = @virtual_columns[col.name])
+          return vc[:gql] ? column_type(vc[:gql]) : vc[:type]
+        end
+
         klass, rails_col, joins = Rgviz::find_rails_col @model_class, col.name
         raise "Unknown column #{col}" unless rails_col
         rails_column_type rails_col
@@ -440,6 +458,15 @@ module Rgviz
     end
 
     def visit_id_column(node)
+      if @executor.virtual_columns && (vc = @executor.virtual_columns[node.name])
+        if vc[:gql]
+          vc[:gql].accept self
+        else
+          @string += vc[:sql]
+        end
+        return
+      end
+
       klass, rails_col, joins = Rgviz::find_rails_col @executor.model_class, node.name
       raise "Unknown column '#{node.name}'" unless rails_col
       @string += ActiveRecord::Base.connection.quote_column_name(klass.table_name)

data/lib/rgviz_rails/init.rb

@@ -13,7 +13,7 @@ module Rgviz
           else
             model = hash[:rgviz]
             conditions = hash[:conditions]
-            extensions = hash[:extensions]
+            virtual_columns = hash[:virtual_columns]
             query = params[:tq] || 'select *'
             tqx = params[:tqx] || ''
 
@@ -22,7 +22,7 @@ module Rgviz
             begin
               options = {}
               options[:conditions] = conditions if conditions
-              options[:extensions] = extensions if extensions
+              options[:virtual_columns] = virtual_columns if virtual_columns
 
               table = if model.is_a?(Class) && model < ActiveRecord::Base
                         Rgviz::Executor.new(model).execute query, options

data/lib/rgviz_rails/parser.rb

@@ -1,7 +1,7 @@
 module RgvizRails
   class Parser < Rgviz::Parser
-    def self.parse(string, options = {})
-      new(string, options).parse
+    def self.parse(string)
+      new(string).parse
     end
     
   protected

data/lib/rgviz_rails/view_helper.rb

@@ -20,14 +20,18 @@ module Rgviz
       events = options[:events] || {}
       html = options[:html] || {}
       hidden = options[:hidden]
-      extensions = options[:extensions]
       conditions = options[:conditions]
+      virtual_columns = options[:virtual_columns]
       package = options[:package]
 
       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}
       rgviz_events = rgviz_events.with_indifferent_access
 
+      ajax = options.has_key?(:ajax) && options[:ajax]
+      load_package = !ajax && (!options.has_key?(:load_package) || options[:load_package])
+      load_google = !ajax && (!options.has_key?(:load_google) || options[:load_google])
+
       html_prefix = (options[:html_prefix] || 'html').to_s
       js_prefix = (options[:js_prefix] || 'js').to_s
       param_prefix = (options[:param_prefix] || 'param').to_s
@@ -87,7 +91,7 @@ module Rgviz
       url = url_for url unless custom_executor
 
       # Parse the query
-      query = RgvizRails::Parser.parse query, :extensions => extensions
+      query = RgvizRails::Parser.parse query
 
       # And replace the html_ and javascript_ magic names
       query.accept visitor
@@ -104,7 +108,7 @@ module Rgviz
 
       # Output the google jsapi tag the first time
       @first_time ||= 1
-      if @first_time == 1
+      if load_google && @first_time == 1
         out << "<script type=\"text/javascript\" src=\"http://www.google.com/jsapi\"></script>\n"
       end
       # Now the real script
@@ -150,7 +154,7 @@ module Rgviz
         @defined_rgviz_append = true
       end
 
-      if !options.has_key?(:load_package) || options[:load_package]
+      if load_package
         # Load visualizations and the package, if not already loaded
         package ||= get_package(kind)
 
@@ -165,7 +169,7 @@ module Rgviz
 
       # Set the callback if the function doesn't have params and if the
       # user didn't request to hide the visualization
-      if !hidden && params.empty?
+      if !ajax && !hidden && params.empty?
         out << "google.setOnLoadCallback(#{callback});\n"
       end
 
@@ -194,7 +198,7 @@ module Rgviz
         else
           executor_options = {}
           executor_options[:conditions] = conditions if conditions
-          executor_options[:extensions] = extensions if extensions
+          executor_options[:virtual_columns] = virtual_columns if virtual_columns
 
           table = if url.is_a?(Class) and url < ActiveRecord::Base
                     Rgviz::Executor.new(url).execute(query, executor_options)
@@ -216,7 +220,7 @@ module Rgviz
         out << "});\n"
       end
       out << "}\n"
-
+      out << "#{callback}()" if ajax
       out << "</script>\n"
 
       # Write the div

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rgviz-rails
 version: !ruby/object:Gem::Version
-  version: '0.67'
+  version: '0.68'
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-05 00:00:00.000000000Z
+date: 2012-07-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rgviz
-  requirement: &70182476133340 !ruby/object:Gem::Requirement
+  requirement: &70314626649780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.43'
+        version: '0.46'
   type: :runtime
   prerelease: false
-  version_requirements: *70182476133340
+  version_requirements: *70314626649780
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70182476132920 !ruby/object:Gem::Requirement
+  requirement: &70314626649300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,13 +32,13 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70182476132920
+  version_requirements: *70314626649300
 description: 
 email: aborenszweig@manas.com.ar
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.rdoc
+- README.markdown
 files:
 - lib/rgviz_rails.rb
 - lib/rgviz_rails/executor.rb
@@ -51,7 +51,7 @@ files:
 - lib/rgviz_rails/adapters/sqlite_adapter.rb
 - lib/rgviz_rails/init.rb
 - rails/init.rb
-- README.rdoc
+- README.markdown
 homepage: http://github.com/asterite/rgviz-rails
 licenses: []
 post_install_message: 

data/README.rdoc

@@ -1,131 +0,0 @@
-== 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.
-
-This library is built on top of rgviz[https://github.com/asterite/rgviz].
-
-=== Installation
-
-  gem install rgviz-rails
-
-=== Rails 3
-
-In your Gemfile
-
-  gem 'rgviz'
-  gem 'rgviz-rails', :require => 'rgviz_rails'
-
-=== Rails 2.x
-
-In your environment.rb
-
-  config.gem "rgviz"
-  config.gem "rgviz-rails", :lib => 'rgviz_rails'
-
-=== Usage
-
-To make a method in your controller be a visualization API endpoint:
-
-  class VizController < ApplicationController
-
-    def person
-      # Person is an ActiveRecord::Base class
-      render :rgviz => Person
-    end
-
-  end
-
-So for example if +Person+ has +name+ and +age+, pointing your browser to:
-
-  http://localhost:3000/viz/person?select name where age > 20 limit 5
-
-would render the necessary javascript code that implements the Google Visualization API wire protocol.
-
-=== Extensions
-
-To enable the extensions defined by rgviz you need to specify it in the render method:
-
-  render :rgviz => Person, :extensions => true
-
-=== Associations
-
-If you want to filter, order by or group by columns that are in a model's association you can use underscores. This is better understood with an example:
-
-  class Person < ActiveRecord::Base
-    belongs_to :city
-  end
-
-  class City < ActiveRecord::Base
-    belongs_to :country
-  end
-
-  class Country < ActiveRecord::Base
-  end
-
-To select the name of the city each person belongs to:
-
-  select city_name
-
-To select the name of the country of the city each person belongs to:
-
-  select city_country_name
-
-A slightly more complex example:
-
-  select avg(age) where city_country_name = 'Argentina' group by city_name
-
-The library will make it in just one query, writing all the SQL joins for you.
-
-=== Extra conditions
-
-Sometimes you want to limit your results the query will work with. You can do it like this:
-
-  render :rgviz => Person, :conditions => ['age > ?', 20]
-
-Or also:
-
-  render :rgviz => Person, :conditions => 'age > 20'
-
-=== Preprocessing
-
-If you need to tweak a result before returning it, just include a block:
-
-  render :rgviz => Person do |table|
-    # Modify the Rgviz::Table object
-  end
-
-=== Showing a visualization in a view
-
-You can invoke the rgviz method in your views. {Read more about this}[https://github.com/asterite/rgviz-rails/wiki/Showing-a-visualization-in-a-view].
-
-You can always do it the {old way}[http://code.google.com/apis/visualization/documentation/using_overview.html].
-
-=== Executing queries over in-memory arrays
-
-You can also apply a query over an array of arrays that contains your "records" to be queried.
-
-  types = [[:id, :number], [:name, :string], [:age, :number]]
-  records = [
-    [1, 'John', 23],
-    [2, 'Pete', 36]
-  ]
-  executor = Rgviz::MemoryExecutor.new records, types
-
-  render :rgviz => executor
-
-This is very useful if you need to present visualizations against data coming from a CSV file.
-
-=== 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)
-* 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*
-* The function *toDate* doesn't accept a number as its argument
-* The *tsv* output format is not supported
-
-=== Contributors
-
-* {Brad Seefeld}[https://github.com/bradseefeld]