hotwire 0.1.0 → 0.1.1

data/README.markdown

@@ -44,20 +44,56 @@ The following is a basic example of use.
             ]
             respond_to do |wants|
                 wants.json do
-                if wire_request = Hotwire::Request.from_param(params)
-                    wire_response = wire_request.build_response
-                    wire_response.add_col('date', :id => 'A' , :label => 'Date').
-                                  add_col('string', :id => 'B' , :label => 'Name').
-                                  add_col('number', :id => 'C', :label => 'Count').
-                                  set_data(data) if wire_req.valid?
-                    wire_request.body
-                else
-                    data.to_json
+                    if wire_request = Hotwire::Request.from_param(params)
+                        wire_response = wire_request.build_response
+                        wire_response.add_col('date', :id => 'A' , :label => 'Date').
+                                      add_col('string', :id => 'B' , :label => 'Name').
+                                      add_col('number', :id => 'C', :label => 'Count').
+                                      set_data(data) if wire_request.valid?
+                        wire_response.body
+                    else
+                        data.to_json
+                    end
                 end
             end
         end
     end
 
+## ActiveRecord ##
+
+If your project includes ActiveRecord, Hotwire will automatically included an ActiveRecord mixin that allows columns to be added from a model class.
+
+Let's say you have a Person Model:
+    
+    Class Person < ActiveRecord::Base
+    end
+    
+Then, when you have created your response object, you can add all the columns from the Person Model: 
+
+    ...
+    wire_response.add_columns(Person)
+    ...
+    
+Finally, you can pass a collection of People to set_data:
+
+    ...
+    @people = Personal.find(:all)
+    wire_response.set_data(@people)
+    ...
+    
+You can also set the columns manually and then still use set_data with a collection. This will only set data with columns you have already added, matching the id key of the column definition to the attribute on your objects:
+
+    ...
+    wire_response.add_col('string', :id => 'name' , :label => 'Name').
+                  add_col('number', :id => 'age' , :label => 'Age')
+    wire_response.set_data(Person.all)
+    ...
+    
+In that case, your wire_response.data will look like:
+
+    wire_response.data => [['Bob', 33], ['Fred', 22]]
+                  
+    
 ## ToDo
 TODO: should be updated to handle version 0.6 of the API
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/hotwire.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hotwire}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Les Freeman"]
@@ -28,18 +28,20 @@ Gem::Specification.new do |s|
      "lib/hotwire/base.rb",
      "lib/hotwire/request.rb",
      "lib/hotwire/response.rb",
+     "lib/hotwire/response/active_record_mixin.rb",
      "lib/hotwire/response/base.rb",
      "lib/hotwire/response/csv.rb",
      "lib/hotwire/response/html.rb",
      "lib/hotwire/response/invalid.rb",
      "lib/hotwire/response/json.rb",
+     "test/active_record_test_helper.rb",
      "test/hotwire_test.rb",
+     "test/response/test_active_record_mixin.rb",
      "test/response/test_base.rb",
      "test/response/test_csv.rb",
      "test/response/test_html.rb",
      "test/response/test_invalid.rb",
      "test/response/test_json.rb",
-     "test/test_active_record_mixins.rb",
      "test/test_helper.rb",
      "test/test_request.rb",
      "test/test_response.rb"
@@ -47,16 +49,17 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/lesfreeman/hotwire}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Under the hood data transformations for the Google Wire protocol.}
   s.test_files = [
-    "test/hotwire_test.rb",
+    "test/active_record_test_helper.rb",
+     "test/hotwire_test.rb",
+     "test/response/test_active_record_mixin.rb",
      "test/response/test_base.rb",
      "test/response/test_csv.rb",
      "test/response/test_html.rb",
      "test/response/test_invalid.rb",
      "test/response/test_json.rb",
-     "test/test_active_record_mixins.rb",
      "test/test_helper.rb",
      "test/test_request.rb",
      "test/test_response.rb"
@@ -66,7 +69,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
       s.add_development_dependency(%q<redgreen>, [">= 0"])
       s.add_development_dependency(%q<mocha>, [">= 0"])

data/lib/hotwire.rb

@@ -11,4 +11,10 @@ require 'hotwire/response/base'
 require 'hotwire/response/csv'
 require 'hotwire/response/json'
 require 'hotwire/response/html'
-require 'hotwire/response/invalid'
+require 'hotwire/response/invalid'
+
+
+
+if defined? ActiveRecord::Base
+  require 'hotwire/response/active_record_mixin.rb'
+end

data/lib/hotwire/response/active_record_mixin.rb

@@ -0,0 +1,51 @@
+module Hotwire
+  module Response
+    
+    # This mixin adds the ability to pass an ActiveRecord model to add_columns
+    module ActiveRecordMixin
+      def add_columns_with_active_record_model(args)
+        if args.respond_to?(:ancestors) and args.ancestors.include? ActiveRecord::Base
+          args = args.columns.sort_by{|c| c.name }.map do |col| 
+            [normalize_active_record_type(col.type), {:id => col.name, :label => col.name }]
+          end
+        end
+        add_columns_without_active_record_model(args) 
+        
+      end
+      
+      def set_data_with_active_record_collection(data)
+        data = rows_from_active_record_collection(data) if data.first.is_a?(ActiveRecord::Base)
+        set_data_without_active_record_collection(data)
+      end
+      
+      def self.included(base)
+        base.send :alias_method_chain, :add_columns, :active_record_model
+        base.send :alias_method_chain, :set_data, :active_record_collection
+      end
+      
+    private
+      
+      # Converts an Array of ActiveRecord objects to an Array of data points based on columns setup for the response.
+      def rows_from_active_record_collection(collection)
+        collection.map { |obj| self.columns.map { |c| obj[c[:id]] } }
+      end
+      
+      # Convert an ActiveRecord type string to Wire Protocol types
+      def normalize_active_record_type(type)
+        case type
+        when :timestamp
+          'datetime'
+        when :string, :text
+          'string'
+        when :decimal, :integer
+          'number'
+        else
+          type.to_s
+        end
+      end
+      
+    end
+  end
+end
+
+Hotwire::Response::Base.send :include, Hotwire::Response::ActiveRecordMixin

data/lib/hotwire/response/base.rb

@@ -24,7 +24,7 @@ module Hotwire
       # be raised. +params+ is an optional map to define extra column attributes. 
       # These include: +:id+, +:label+ and +:pattern+.
       def add_column(type, params=nil)
-        raise ArgumentError.new("Invalid column type: #{type}") if !@coltypes.include?(type)
+        raise ArgumentError.new("Invalid column type: #{type}(#{type.class.name})") if !@coltypes.include?(type)
         params ||= {}
         params[:type] = type
     
@@ -33,6 +33,12 @@ module Hotwire
         return self
       end
       alias_method :add_col, :add_column
+      
+      # Adds an array of columns to the visualization:
+      # add_columns(['string', {:id => 'Column A'}], ['number', {:id => 'Column B'}])
+      def add_columns(columns)
+        columns.each { |col| add_column(*col)}
+      end
   
       # Sets the data to be exported. +data+ should be a 2-dimensional array. The 
       # first index should iterate over rows, the second over columns. Column 

data/lib/hotwire/response/json.rb

@@ -59,7 +59,7 @@ module Hotwire
         when "date"
           Hotwire::Response::Json::Date.new(value)
         when "datetime"
-          Hotwire::Response::Json::Datetime.new(value)
+          Hotwire::Response::Json::DateTime.new(value)
         when "timeofday"
           [ value.hour, value.min, value.sec, value.usec / 1000 ]
         end
@@ -86,7 +86,7 @@ module Hotwire
         end
 
         def to_json(options=nil)
-          "new Date(#{@date.year}, #{@date.month-1}, #{@date.day}, #{@date.hour}, #{@date.min}, #{@date.sec})"
+          "new Date(#{@datetime.year}, #{@datetime.month-1}, #{@datetime.day}, #{@datetime.hour}, #{@datetime.min}, #{@datetime.sec})"
         end
       end
 

data/test/active_record_test_helper.rb

@@ -0,0 +1,17 @@
+require 'active_record'
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :people do |t|
+    t.integer :id
+    t.string :name
+    t.text :bio
+    t.integer :age
+    t.decimal :weight
+    t.datetime :birth_date
+    t.boolean :tall
+  end
+end
+
+class Person < ActiveRecord::Base
+end

data/test/response/test_active_record_mixin.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+require 'active_record_test_helper'
+
+
+class TestActiveRecordMixin < Test::Unit::TestCase
+  context "the Hotwire::Response::Base instance" do
+    
+    context "created from a valid request" do
+      setup { @response = Hotwire::Response::Base.new(valid_request) }
+      
+      context "add_columns with a Model" do
+        setup { @response.add_columns(Person) }
+        
+        should "add columns to match the ActiveRecord object" do
+          expected = [{:type=>"number", :label=>"age", :id=>"age"},
+                      {:type=>"string", :label=>"bio", :id=>"bio"},
+                      {:type=>"datetime", :label=>"birth_date", :id=>"birth_date"},
+                      {:type=>"number", :label=>"id", :id=>"id"},
+                      {:type=>"string", :label=>"name", :id=>"name"},
+                      {:type=>"boolean", :label=>"tall", :id=>"tall"},
+                      {:type=>"number", :label=>"weight", :id=>"weight"}]
+                      
+          assert_equal expected, @response.columns
+        end
+      end
+      
+      context "set_data with a collection" do
+        setup do
+          Person.destroy_all
+          @time = Time.utc(1980, 9, 15, 12, 22, 23)
+          @bob = Person.create(:name => "Bob", :age => 30, :bio => "A Nice Guy", :birth_date => 30.years.ago, :tall => true, :weight => 155.5)
+          @fred = Person.create(:name => "Fred", :age => 22, :bio => "A Nice Guy Too", :birth_date => 22.years.ago, :tall => false, :weight => 110.5)
+          @response.add_columns(Person)
+          @response.set_data(Person.all)
+        end
+        
+        should "add rows from the collection" do
+          expected = [[30, "A Nice Guy", @bob.birth_date, 1, "Bob", true, @bob.weight],
+                      [22, "A Nice Guy Too", @fred.birth_date, 2, "Fred", false, @fred.weight]]
+                      
+          assert_equal expected.to_s, @response.data.to_s
+        end
+        
+      end
+
+    end
+
+  end
+end

data/test/response/test_base.rb

@@ -29,6 +29,15 @@ class TestResponseBase < Test::Unit::TestCase
         
       end
       
+      context "add_columns" do
+        setup { @response.add_columns([['string', {:id => 'Column A'}], ['number', {:id => 'Column B'}]]) }
+        
+        should "add each column passed in" do
+          expected = [{:type=>"string", :id=>"Column A"}, {:type=>"number", :id=>"Column B"}]
+          assert_equal expected, @response.columns
+        end
+      end
+      
       context "set_data" do
         setup do
           @data = [['a', 'b']]

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hotwire
 version: !ruby/object:Gem::Version 
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Les Freeman
@@ -21,9 +22,11 @@ dependencies:
   name: thoughtbot-shoulda
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -33,9 +36,11 @@ dependencies:
   name: redgreen
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -45,9 +50,11 @@ dependencies:
   name: mocha
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -74,18 +81,20 @@ files:
 - lib/hotwire/base.rb
 - lib/hotwire/request.rb
 - lib/hotwire/response.rb
+- lib/hotwire/response/active_record_mixin.rb
 - lib/hotwire/response/base.rb
 - lib/hotwire/response/csv.rb
 - lib/hotwire/response/html.rb
 - lib/hotwire/response/invalid.rb
 - lib/hotwire/response/json.rb
+- test/active_record_test_helper.rb
 - test/hotwire_test.rb
+- test/response/test_active_record_mixin.rb
 - test/response/test_base.rb
 - test/response/test_csv.rb
 - test/response/test_html.rb
 - test/response/test_invalid.rb
 - test/response/test_json.rb
-- test/test_active_record_mixins.rb
 - test/test_helper.rb
 - test/test_request.rb
 - test/test_response.rb
@@ -99,34 +108,39 @@ 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.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Under the hood data transformations for the Google Wire protocol.
 test_files: 
+- test/active_record_test_helper.rb
 - test/hotwire_test.rb
+- test/response/test_active_record_mixin.rb
 - test/response/test_base.rb
 - test/response/test_csv.rb
 - test/response/test_html.rb
 - test/response/test_invalid.rb
 - test/response/test_json.rb
-- test/test_active_record_mixins.rb
 - test/test_helper.rb
 - test/test_request.rb
 - test/test_response.rb

data/test/test_active_record_mixins.rb

@@ -1,61 +0,0 @@
-# require 'test_helper'
-# require 'active_record_test_helper'
-# 
-# 
-# class TestActiveRecordMixin < Test::Unit::TestCase
-#   
-#   context "a Hotwire::Table instance from an ActiveRecord collection" do
-#     setup do
-#       Person.delete_all
-#       Person.create(:name => "Bob", :age => 33, :bio => "A nice Guy", :birth_date => Time.utc(2010, 10, 19, 9, 38, 10))
-#       @data = Hotwire::Table.new(Person.all)
-#     end
-#     
-#     context "to_wire" do
-#       should "return a properly formatted hash" do
-#         expected = { "table"=> {"rows"=> [{"c"=> [{"v"=>33},
-#                                                   {"v"=>"A nice Guy"},
-#                                                   {"v"=>"Date(2010, 9, 19, 9, 38, 10)"},
-#                                                   {"v"=>"Bob"}]}],
-#                                 "cols"=> [{"type"=>"number", "id"=>"age", "label"=>"Age"},
-#                                           {"type"=>"string", "id"=>"bio", "label"=>"Bio"},
-#                                           {"type"=>"datetime", "id"=>"birth_date", "label"=>"Birth date"},
-#                                           {"type"=>"string", "id"=>"name", "label"=>"Name"}]}}    
-#           
-#         assert_equal expected, @data.to_wire
-#       end
-#     end
-#   end
-#   
-#   context "an Array of ActiveRecord objects" do
-#     setup do
-#       Person.delete_all
-#       Person.create(:name => "Bob", :age => 33, :bio => "A nice Guy", :birth_date => Time.utc(2010, 10, 19, 9, 38, 10))
-#       @people = Person.all
-#     end
-#     
-#     context "to_wire" do
-#       should "return a properly formatted hash" do
-#         expected = { "table"=> {"rows"=> [{"c"=> [{"v"=>33},
-#                                                   {"v"=>"A nice Guy"},
-#                                                   {"v"=>"Date(2010, 9, 19, 9, 38, 10)"},
-#                                                   {"v"=>"Bob"}]}],
-#                                 "cols"=> [{"type"=>"number", "id"=>"age", "label"=>"Age"},
-#                                           {"type"=>"string", "id"=>"bio", "label"=>"Bio"},
-#                                           {"type"=>"datetime", "id"=>"birth_date", "label"=>"Birth date"},
-#                                           {"type"=>"string", "id"=>"name", "label"=>"Name"}]}}    
-#           
-#         assert_equal expected, @people.to_wire
-#       end
-#     end
-#   end
-#   
-#   context "an Array of non-ActiveRecord objects" do
-#     should "raise an error" do
-#       assert_raises RuntimeError do
-#         ["string"].to_wire
-#       end
-#     end
-#   end
-#   
-# end