rgviz-rails 0.43 → 0.44

data/README.rdoc

@@ -0,0 +1,101 @@
+== 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. 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
+
+In your environment.rb
+
+  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]. {Read more about this}
+
+=== Current Limitations
+* The *format* clause is ignored (If someone knows of a working icu library for ruby, please tell me)
+* 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

data/lib/rgviz_rails.rb

@@ -1,3 +1,4 @@
+require 'rgviz_rails/init.rb'
 require 'rgviz_rails/executor.rb'
 require 'rgviz_rails/js_renderer.rb'
 require 'rgviz_rails/tqx.rb'

data/lib/rgviz_rails/executor.rb

@@ -517,32 +517,16 @@ module Rgviz
       col = klass.send(:columns).select{|x| x.name == name}.first
       return [klass, col, joins] if col
       
-      offset = 0
-      while true
-        idx = name.index '_', offset
-        if not idx
-          # Try to see if the name is an association, and refer to the id
-          assoc = klass.send :reflect_on_association, name.to_sym
-          if assoc
-            col = klass.send(:columns).select{|x| x.name == assoc.association_foreign_key}.first
-            return [klass, col, joins] if col  
-          end
-          return nil
-        end
-        
-        before = name[0 ... idx]
-        new_name = name[idx + 1 .. -1]
-        
-        assoc = klass.send :reflect_on_association, before.to_sym
-        if assoc
-          name = new_name
-          klass = assoc.klass
-          joins << assoc
-          break
-        end
-        
-        offset = idx + 1
-      end
+      idx = name.index '_'
+      return nil if not idx
+      
+      before = name[0 ... idx]
+      name = name[idx + 1 .. -1]
+      
+      assoc = klass.send :reflect_on_association, before.to_sym
+      raise "Unknown association #{before}" unless assoc
+      klass = assoc.klass
+      joins << assoc
     end
   end
   

data/{rails → lib/rgviz_rails}/init.rb

@@ -2,63 +2,75 @@ require "rgviz_rails/view_helper"
 # includes the view helper to ActionView::Base
 ActionView::Base.send(:include, Rgviz::ViewHelper)
 
-config.after_initialize do
-  class ::ActionController::Base
-    alias_method :original_render, :render
-    def render(*args, &block)
+def _define_rgviz_class
+  ::ActionController::Base.module_eval do
+    def render_with_rgviz(*args, &block)
       if args.length == 1 && args[0].kind_of?(Hash)
-        hash = args.first 
+        hash = args.first
         case hash[:rgviz]
-        when nil then original_render *args, &block
+        when nil then render_without_rgviz *args, &block
         else
           model = hash[:rgviz]
           conditions = hash[:conditions]
           extensions = hash[:extensions]
           query = params[:tq]
           tqx = params[:tqx] || ''
-          
+
           tqx = Rgviz::Tqx.parse(tqx)
-          
+
           begin
             executor = Rgviz::Executor.new model, query
             options = {}
             options[:conditions] = conditions if conditions
             options[:extensions] = extensions if extensions
             table = executor.execute options
-            
+
             yield table if block_given?
-            
+
             case tqx['out']
             when 'json'
-              original_render :text => Rgviz::JsRenderer.render(table, tqx)
+              render_without_rgviz :text => Rgviz::JsRenderer.render(table, tqx)
             when 'html'
-              original_render :text => Rgviz::HtmlRenderer.render(table)
+              render_without_rgviz :text => Rgviz::HtmlRenderer.render(table)
             when 'csv'
               csv_output = Rgviz::CsvRenderer.render(table)
               if tqx['outFileName']
                 send_data csv_output, :filename => tqx['outFileName'], :type => 'text/csv'
               else
-                original_render :text => csv_output
+                render_without_rgviz :text => csv_output
               end
             else
-              original_render :text => Rgviz::JsRenderer.render_error('not_supported', "Unsupported output type: #{out}", tqx)
+              render_without_rgviz :text => Rgviz::JsRenderer.render_error('not_supported', "Unsupported output type: #{out}", tqx)
             end
           rescue ParseException => e
             case tqx['out']
             when 'json'
-              original_render :text => Rgviz::JsRenderer.render_error('invalid_query', e.message, tqx)
+              render_without_rgviz :text => Rgviz::JsRenderer.render_error('invalid_query', e.message, tqx)
             when 'html'
-              original_render :text => "<b>Error:</b> #{e.message}"
+              render_without_rgviz :text => "<b>Error:</b> #{e.message}"
             when 'csv'
-              original_render :text => "Error: #{e.message}"
+              render_without_rgviz :text => "Error: #{e.message}"
             else
-              original_render :text => "<b>Unsupported output type:</b> #{out}"
+              render_without_rgviz :text => "<b>Unsupported output type:</b> #{out}"
             end
           end
         end
       else
-        original_render *args, &block
+        render_without_rgviz *args, &block
       end
     end
+    alias_method_chain :render, :rgviz
+  end
+end
+
+if Rails::VERSION::MAJOR == 2
+  config.after_initialize do
+    _define_rgviz_class
+  end
+else
+  class Railtie < Rails::Railtie
+    initializer "define rgviz class" do
+      _define_rgviz_class
+    end
   end
 end

data/lib/rgviz_rails/view_helper.rb

@@ -6,7 +6,7 @@ module Rgviz
         i = 0
         opts.each do |key, value|
           key = key.to_s.gsub('"', '\"')
-           
+
           @s << ',' if i > 0
           @s << "\"#{key}\":"
           if special_keys.include?(key) || !value.kind_of?(String)
@@ -19,9 +19,9 @@ module Rgviz
         end
         @s << '}'
       end
-    
+
       options = options.with_indifferent_access
-    
+
       id = options[:id]
       kind = options[:kind]
       url = options[:url]
@@ -30,74 +30,74 @@ module Rgviz
       html = options[:html] || {}
       hidden = options[:hidden]
       extensions = options[:extensions]
-      
+
       rgviz_events, google_events = events.partition{|x| x.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
-      
+
       html_prefix = (options[:html_prefix] || 'html').to_s
       js_prefix = (options[:js_prefix] || 'js').to_s
       param_prefix = (options[:param_prefix] || 'param').to_s
-      
+
       html_prefix += '_'
       js_prefix += '_'
       param_prefix += '_'
-      
+
       debug = options[:debug]
       opts = options[:options] || {}
       opts[:width] = 640 unless opts[:width]
       opts[:height] = 480 unless opts[:height]
-      
+
       params = []
       uses_rgviz_get_value = false
       uses_rgviz_append = false
-      
+
       visitor = MagicNamesVisitor.new(html_prefix, js_prefix, param_prefix)
-      
+
       special_keys = []
-      
+
       opts.each do |key, value|
         next unless value.kind_of?(String)
-      
+
         source = visitor.get_source(value, false)
         next unless source[:source]
-        
+
         special_keys << key
-        
+
         case source[:source]
         when :html
-          opts[key] = "rgviz_get_value('#{source[:id]}')"      
-          uses_rgviz_get_value = true     
+          opts[key] = "rgviz_get_value('#{source[:id]}')"
+          uses_rgviz_get_value = true
         when :js
           opts[key] = "#{source[:id]}()"
         when :param
           opts[key] = "param_#{source[:id]}"
           params << source[:id].to_i unless params.include?(source[:id])
-        end 
+        end
       end
-      
+
       opts = opts_to_json(opts, special_keys)
-      
+
       raise "Must specify an :id" unless id
       raise "Must specify a :kind" unless kind
       raise "Must specify a :url" unless url
-      
+
       url = url_for url
-      
+
       # Parse the query
       query = Parser.parse query, :extensions => extensions
-      
+
       # And replace the html_ and javascript_ magic names
       query.accept visitor
       query_builder = visitor.query_builder
       query_builder_var = visitor.query_builder_var
-      
+
       uses_rgviz_get_value |= visitor.uses_rgviz_get_value?
       uses_rgviz_append |= visitor.uses_rgviz_append?
-      
+
       visitor.params.each{|p| params << p unless params.include?(p)}
       params = params.sort!.map{|i| "param_#{i}"}
-      
+
       out = ''
 
       # Output the google jsapi tag the first time
@@ -107,15 +107,15 @@ module Rgviz
       end
       # Now the real script
       out << "<script type=\"text/javascript\">\n"
-      
+
       # Define a function to get the value of an html element
-      if uses_rgviz_get_value && !@defined_rgviz_get_value        
+      if uses_rgviz_get_value && !@defined_rgviz_get_value
         out << "function rgviz_get_value(id) {\n"
           out << "var e = document.getElementById(id);\n"
           out << "var n = e.tagName.toLowerCase();\n"
           out << "var s = null;\n"
           out << "if (n == 'select' && e.multiple) {\n"
-            out << "var s = [];\n" 
+            out << "var s = [];\n"
             out << "var o = e.options;\n"
             out << "for(var i = 0; i < o.length; i++)\n"
               out << "if (o[i].selected) s.push(o[i].value);\n"
@@ -128,7 +128,7 @@ module Rgviz
         out << "}\n"
         @defined_rgviz_get_value = true
       end
-        
+
       # Define a function to append the value of a magic something
       if uses_rgviz_append && !@defined_rgviz_append
         out << "function rgviz_append(s, b, a) {\n"
@@ -147,27 +147,27 @@ module Rgviz
         out << "}\n"
         @defined_rgviz_append = true
       end
-      
+
       # Load visualizations and the package, if not already loaded
-      pack = kind.downcase      
+      pack = kind.downcase
       @packages ||= []
       unless @packages.include?(pack)
         out << "google.load(\"visualization\", \"1\", {'packages':['#{pack}']});\n"
         @packages << pack
       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 !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"
-      
+
       # And define the callback
       out << "function #{callback}(#{params.join(', ')}) {\n"
         out << "#{rgviz_events[:rgviz_start]}('#{id}');\n" if rgviz_events[:rgviz_start]
@@ -185,24 +185,28 @@ module Rgviz
           out << "#{rgviz_events[:rgviz_end]}('#{id}');\n" if rgviz_events[:rgviz_end]
         out << "});\n"
       out << "}\n"
-      
+
       out << "</script>\n"
-      
+
       # Write the div
       out << "<div id=\"#{id}\""
       html.each do |key, value|
         out << " #{key}=\"#{h value}\""
       end
       out << "></div>\n"
-      
+
       @first_time = 0
-      
-      out
+
+      if defined? :raw
+        raw out
+      else
+        out
+      end
     end
-    
+
     module_function :rgviz
   end
-  
+
   class MagicNamesVisitor < Visitor
     def initialize(html_prefix, js_prefix, param_prefix)
       @html_prefix = html_prefix
@@ -211,27 +215,27 @@ module Rgviz
       @s = ''
       @params = []
     end
-    
+
     def query_builder
       @s.strip
     end
-    
+
     def query_builder_var
       'q'
     end
-    
+
     def params
       @params
     end
-    
+
     def uses_rgviz_get_value?
       @uses_rgviz_get_value
     end
-    
+
     def uses_rgviz_append?
       @uses_rgviz_append
     end
-    
+
     def visit_query(node)
       @s << "var q = '"
       node.select.accept self if node.select
@@ -241,20 +245,20 @@ module Rgviz
       node.order_by.accept self if node.order_by
       @s << "limit #{node.limit} " if node.limit
       @s << "offset #{node.offset} " if node.offset
-      if node.labels  
+      if node.labels
         @s << "label "
         node.labels.each_with_index do |l, i|
-          @s << ', ' if i > 0 
+          @s << ', ' if i > 0
           l.accept self
         end
-      end 
+      end
       if node.formats
         @s << "format "
         node.formats.each_with_index do |f, i|
-          @s << ', ' if i > 0 
+          @s << ', ' if i > 0
           f.accept self
         end
-      end 
+      end
       if node.options
         @s << "options "
         @s << "no_values " if node.options.no_values
@@ -263,35 +267,35 @@ module Rgviz
       @s << "';\n"
       false
     end
-    
+
     def visit_select(node)
       @s << "select ";
       print_columns node
       @s << " "
       false
     end
-    
+
     def visit_where(node)
       @s << "where "
       node.expression.accept self
       @s << " "
       false
     end
-    
+
     def visit_group_by(node)
       @s << "group by "
       print_columns node
       @s << " "
       false
     end
-    
+
     def visit_pivot(node)
       @s << "pivot "
       print_columns node
       @s << " "
       false
     end
-    
+
     def visit_order_by(node)
       @s << "order by "
       node.sorts.each_with_index do |s, i|
@@ -303,7 +307,7 @@ module Rgviz
       @s << " "
       false
     end
-    
+
     def visit_label(node)
       node.column.accept self
       @s << ' '
@@ -315,7 +319,7 @@ module Rgviz
       end
       false
     end
-    
+
     def visit_format(node)
       node.column.accept self
       @s << ' '
@@ -326,7 +330,7 @@ module Rgviz
       end
       false
     end
-    
+
     def visit_logical_expression(node)
       @s += "("
       node.operands.each_with_index do |operand, i|
@@ -336,9 +340,9 @@ module Rgviz
       @s += ")"
       false
     end
-    
+
     def visit_binary_expression(node)
-      if node.operator == BinaryExpression::Eq 
+      if node.operator == BinaryExpression::Eq
         source = has_magic_name?(node.right)
         if source
           @s << "';\n"
@@ -346,7 +350,7 @@ module Rgviz
           when :html
             @s << "var s = rgviz_get_value('#{source[:id]}');\n"
             append_selections node, source
-            
+
             @uses_rgviz_get_value = true
           when :js
             @s << "var s = #{source[:id]}();\n"
@@ -367,7 +371,7 @@ module Rgviz
       node.right.accept self
       false
     end
-    
+
     def visit_unary_expression(node)
       if node.operator == UnaryExpression::Not
         @s << "not "
@@ -388,7 +392,7 @@ module Rgviz
         append_before_source_type source[:type]
         @s << " + rgviz_get_value('#{source[:id]}') + "
         append_after_source_type source[:type]
-        
+
         @uses_rgviz_get_value = true
       when :js
         append_before_source_type source[:type]
@@ -401,35 +405,35 @@ module Rgviz
         @params << source[:id].to_i unless @params.include?(source[:id])
       end
     end
-    
+
     def visit_number_column(node)
       @s << node.value.to_s
     end
-    
+
     def visit_string_column(node)
       value = node.value.gsub('"', '\"')
       @s << "\"#{value}\""
     end
-    
+
     def visit_boolean_column(node)
       @s << node.value.to_s
     end
-    
+
     def visit_date_column(node)
       @s << "date \"#{node.value.to_s}\""
     end
-    
+
     def visit_date_time_column(node)
       @s << "date \"#{node.value.strftime('%Y-%m-%d %H:%M:%S')}\""
     end
-    
+
     def visit_time_of_day_column(node)
       @s << "date \"#{node.value.strftime('%H:%M:%S')}\""
     end
-    
+
     def visit_scalar_function_column(node)
       case node.function
-      when ScalarFunctionColumn::Sum, ScalarFunctionColumn::Difference, 
+      when ScalarFunctionColumn::Sum, ScalarFunctionColumn::Difference,
            ScalarFunctionColumn::Product, ScalarFunctionColumn::Quotient
         node.arguments[0].accept node
         @s << " #{node.function} "
@@ -444,21 +448,21 @@ module Rgviz
       end
       false
     end
-    
+
     def visit_aggregate_column(node)
       @s << "#{node.function}("
       node.argument.accept self
       @s << ")"
       false
     end
-    
+
     def print_columns(node)
       node.columns.each_with_index do |c, i|
         @s << ', ' if i > 0
         c.accept self
       end
     end
-    
+
     def get_source(name, include_type = true)
       if name.start_with?(@html_prefix)
         if include_type
@@ -482,7 +486,7 @@ module Rgviz
         {}
       end
     end
-    
+
     def get_source_type(source, name)
       if name.start_with?('number_')
         {:source => source, :id => name[7 .. -1], :type => :number}
@@ -498,7 +502,7 @@ module Rgviz
         {:source => source, :id => name, :type => :string}
       end
     end
-    
+
     def append_before_source_type(type)
       case type
       when :number
@@ -513,7 +517,7 @@ module Rgviz
         @s << "timeofday \"'"
       end
     end
-    
+
     def append_after_source_type(type)
       case type
       when :number
@@ -522,7 +526,7 @@ module Rgviz
         @s << "'\""
       end
     end
-    
+
     def append_selections(node, source)
       @s << "q += rgviz_append(s, '";
       node.left.accept self
@@ -533,7 +537,7 @@ module Rgviz
       @s << "');\n"
       @uses_rgviz_append = true
     end
-    
+
     def has_magic_name?(node)
       return false unless node.kind_of?(IdColumn)
       source = get_source node.name

data/spec/blueprints.rb

@@ -23,10 +23,3 @@ Person.blueprint do
   birthday { Sham::date }
   city
 end
-
-Pet.blueprint do
-  name
-  age { Sham::number }
-  birthday { Sham::date }
-  the_city { City.make }
-end

data/spec/rgviz/executor_spec.rb

@@ -5,12 +5,11 @@ include Rgviz
 
 describe Executor do
   before :each do
-    [Person, Pet, City, Country].each &:delete_all
+    [Person, City, Country].each &:delete_all
   end
   
   def exec(query, options = {})
-    clazz = options[:class] || Person
-    exec = Executor.new clazz, query
+    exec = Executor.new Person, query
     exec.execute options
   end
   
@@ -287,14 +286,6 @@ describe Executor do
   
   it_processes_single_select_column "1 options no_values", 'c0', :number, nil, "1"
   
-  it_processes_single_select_column "1 where city is null", 'c0', :number, 1, "1" do
-    Person.make :city => nil
-  end
-  
-  it_processes_single_select_column "the_city_name where the_city_name = 'foo'", 'the_city_name', :string, 'foo', "the_city_name", :class => Pet do
-    Pet.make :the_city => (City.make :name => 'foo')
-  end
-  
   it "processes pivot" do
     Person.make :name => 'Eng', :birthday => '2000-01-12', :age => 1000
     Person.make :name => 'Eng', :birthday => '2000-01-12', :age => 500 

data/spec/spec_helper.rb

@@ -32,19 +32,9 @@ ActiveRecord::Schema.define do
     t.datetime "updated_at"
     t.integer  "city_id"
   end
-  
-  create_table "pets", :force => true do |t|
-    t.string   "name"
-    t.integer  "age"
-    t.date     "birthday"
-    t.datetime "created_at"
-    t.datetime "updated_at"
-    t.integer  "city_id"
-  end
 end
 
 require File.dirname(__FILE__) + '/models/person'
-require File.dirname(__FILE__) + '/models/pet'
 require File.dirname(__FILE__) + '/models/city'
 require File.dirname(__FILE__) + '/models/country'
 

metadata

@@ -1,12 +1,11 @@
 --- !ruby/object:Gem::Specification 
 name: rgviz-rails
 version: !ruby/object:Gem::Version 
-  hash: 93
   prerelease: false
   segments: 
   - 0
-  - 43
-  version: "0.43"
+  - 44
+  version: "0.44"
 platform: ruby
 authors: 
 - Ary Borenszweig
@@ -14,10 +13,22 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-14 00:00:00 -03:00
+date: 2010-12-11 00:00:00 -03:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rgviz
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
 description: 
 email: aborenszweig@manas.com.ar
 executables: []
@@ -25,7 +36,7 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.rdoc
 files: 
 - lib/rgviz_rails.rb
 - lib/rgviz_rails/executor.rb
@@ -35,16 +46,15 @@ files:
 - lib/rgviz_rails/adapters/mysql_adapter.rb
 - lib/rgviz_rails/adapters/postgresql_adapter.rb
 - lib/rgviz_rails/adapters/sqlite_adapter.rb
-- rails/init.rb
+- lib/rgviz_rails/init.rb
 - spec/blueprints.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/models/city.rb
 - spec/models/country.rb
 - spec/models/person.rb
-- spec/models/pet.rb
 - spec/rgviz/executor_spec.rb
-- README
+- README.rdoc
 has_rdoc: true
 homepage: http://code.google.com/p/rgviz-rails
 licenses: []
@@ -59,7 +69,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -68,7 +77,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"

data/README

@@ -1,243 +0,0 @@
-== Welcome to Rails
-
-Rails is a web-application framework that includes everything needed to create 
-database-backed web applications according to the Model-View-Control pattern. 
-
-This pattern splits the view (also called the presentation) into "dumb" templates
-that are primarily responsible for inserting pre-built data in between HTML tags.
-The model contains the "smart" domain objects (such as Account, Product, Person,
-Post) that holds all the business logic and knows how to persist themselves to
-a database. The controller handles the incoming requests (such as Save New Account,
-Update Product, Show Post) by manipulating the model and directing data to the view.
-
-In Rails, the model is handled by what's called an object-relational mapping
-layer entitled Active Record. This layer allows you to present the data from
-database rows as objects and embellish these data objects with business logic
-methods. You can read more about Active Record in
-link:files/vendor/rails/activerecord/README.html.
-
-The controller and view are handled by the Action Pack, which handles both
-layers by its two parts: Action View and Action Controller. These two layers
-are bundled in a single package due to their heavy interdependence. This is
-unlike the relationship between the Active Record and Action Pack that is much
-more separate. Each of these packages can be used independently outside of
-Rails.  You can read more about Action Pack in
-link:files/vendor/rails/actionpack/README.html.
-
-
-== Getting Started
-
-1. At the command prompt, start a new Rails application using the <tt>rails</tt> command
-   and your application name. Ex: rails myapp
-2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
-3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!"
-4. Follow the guidelines to start developing your application
-
-
-== Web Servers
-
-By default, Rails will try to use Mongrel if it's are installed when started with script/server, otherwise Rails will use WEBrick, the webserver that ships with Ruby. But you can also use Rails
-with a variety of other web servers.
-
-Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
-suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
-getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
-More info at: http://mongrel.rubyforge.org
-
-Say other Ruby web servers like Thin and Ebb or regular web servers like Apache or LiteSpeed or
-Lighttpd or IIS. The Ruby web servers are run through Rack and the latter can either be setup to use
-FCGI or proxy to a pack of Mongrels/Thin/Ebb servers.
-
-== Apache .htaccess example for FCGI/CGI
-
-# General Apache options
-AddHandler fastcgi-script .fcgi
-AddHandler cgi-script .cgi
-Options +FollowSymLinks +ExecCGI
-
-# If you don't want Rails to look in certain directories,
-# use the following rewrite rules so that Apache won't rewrite certain requests
-# 
-# Example:
-#   RewriteCond %{REQUEST_URI} ^/notrails.*
-#   RewriteRule .* - [L]
-
-# Redirect all requests not available on the filesystem to Rails
-# By default the cgi dispatcher is used which is very slow
-# 
-# For better performance replace the dispatcher with the fastcgi one
-#
-# Example:
-#   RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
-RewriteEngine On
-
-# If your Rails application is accessed via an Alias directive,
-# then you MUST also set the RewriteBase in this htaccess file.
-#
-# Example:
-#   Alias /myrailsapp /path/to/myrailsapp/public
-#   RewriteBase /myrailsapp
-
-RewriteRule ^$ index.html [QSA]
-RewriteRule ^([^.]+)$ $1.html [QSA]
-RewriteCond %{REQUEST_FILENAME} !-f
-RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
-
-# In case Rails experiences terminal errors
-# Instead of displaying this message you can supply a file here which will be rendered instead
-# 
-# Example:
-#   ErrorDocument 500 /500.html
-
-ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly"
-
-
-== Debugging Rails
-
-Sometimes your application goes wrong.  Fortunately there are a lot of tools that
-will help you debug it and get it back on the rails.
-
-First area to check is the application log files.  Have "tail -f" commands running
-on the server.log and development.log. Rails will automatically display debugging
-and runtime information to these files. Debugging info will also be shown in the
-browser on requests from 127.0.0.1.
-
-You can also log your own messages directly into the log file from your code using
-the Ruby logger class from inside your controllers. Example:
-
-  class WeblogController < ActionController::Base
-    def destroy
-      @weblog = Weblog.find(params[:id])
-      @weblog.destroy
-      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
-    end
-  end
-
-The result will be a message in your log file along the lines of:
-
-  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1
-
-More information on how to use the logger is at http://www.ruby-doc.org/core/
-
-Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
-
-* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
-* Learn to Program: http://pine.fm/LearnToProgram/  (a beginners guide)
-
-These two online (and free) books will bring you up to speed on the Ruby language
-and also on programming in general.
-
-
-== Debugger
-
-Debugger support is available through the debugger command when you start your Mongrel or
-Webrick server with --debugger. This means that you can break out of execution at any point
-in the code, investigate and change the model, AND then resume execution! 
-You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug'
-Example:
-
-  class WeblogController < ActionController::Base
-    def index
-      @posts = Post.find(:all)
-      debugger
-    end
-  end
-
-So the controller will accept the action, run the first line, then present you
-with a IRB prompt in the server window. Here you can do things like:
-
-  >> @posts.inspect
-  => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
-       #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
-  >> @posts.first.title = "hello from a debugger"
-  => "hello from a debugger"
-
-...and even better is that you can examine how your runtime objects actually work:
-
-  >> f = @posts.first
-  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
-  >> f.
-  Display all 152 possibilities? (y or n)
-
-Finally, when you're ready to resume execution, you enter "cont"
-
-
-== Console
-
-You can interact with the domain model by starting the console through <tt>script/console</tt>.
-Here you'll have all parts of the application configured, just like it is when the
-application is running. You can inspect domain models, change values, and save to the
-database. Starting the script without arguments will launch it in the development environment.
-Passing an argument will specify a different environment, like <tt>script/console production</tt>.
-
-To reload your controllers and models after launching the console run <tt>reload!</tt>
-
-== dbconsole
-
-You can go to the command line of your database directly through <tt>script/dbconsole</tt>.
-You would be connected to the database with the credentials defined in database.yml.
-Starting the script without arguments will connect you to the development database. Passing an
-argument will connect you to a different database, like <tt>script/dbconsole production</tt>.
-Currently works for mysql, postgresql and sqlite.
-
-== Description of Contents
-
-app
-  Holds all the code that's specific to this particular application.
-
-app/controllers
-  Holds controllers that should be named like weblogs_controller.rb for
-  automated URL mapping. All controllers should descend from ApplicationController
-  which itself descends from ActionController::Base.
-
-app/models
-  Holds models that should be named like post.rb.
-  Most models will descend from ActiveRecord::Base.
-
-app/views
-  Holds the template files for the view that should be named like
-  weblogs/index.html.erb for the WeblogsController#index action. All views use eRuby
-  syntax.
-
-app/views/layouts
-  Holds the template files for layouts to be used with views. This models the common
-  header/footer method of wrapping views. In your views, define a layout using the
-  <tt>layout :default</tt> and create a file named default.html.erb. Inside default.html.erb,
-  call <% yield %> to render the view using this layout.
-
-app/helpers
-  Holds view helpers that should be named like weblogs_helper.rb. These are generated
-  for you automatically when using script/generate for controllers. Helpers can be used to
-  wrap functionality for your views into methods.
-
-config
-  Configuration files for the Rails environment, the routing map, the database, and other dependencies.
-
-db
-  Contains the database schema in schema.rb.  db/migrate contains all
-  the sequence of Migrations for your schema.
-
-doc
-  This directory is where your application documentation will be stored when generated
-  using <tt>rake doc:app</tt>
-
-lib
-  Application specific libraries. Basically, any kind of custom code that doesn't
-  belong under controllers, models, or helpers. This directory is in the load path.
-
-public
-  The directory available for the web server. Contains subdirectories for images, stylesheets,
-  and javascripts. Also contains the dispatchers and the default HTML files. This should be
-  set as the DOCUMENT_ROOT of your web server.
-
-script
-  Helper scripts for automation and generation.
-
-test
-  Unit and functional tests along with fixtures. When using the script/generate scripts, template
-  test files will be generated for you and placed in this directory.
-
-vendor
-  External libraries that the application depends on. Also includes the plugins subdirectory.
-  If the app has frozen rails, those gems also go here, under vendor/rails/.
-  This directory is in the load path.

data/spec/models/pet.rb

@@ -1,3 +0,0 @@
-class Pet < ActiveRecord::Base
-  belongs_to :the_city, :class_name => 'City', :foreign_key => 'city_id'
-end