hotwire 0.1.1 → 0.1.2

data/README.markdown

@@ -59,6 +59,10 @@ The following is a basic example of use.
         end
     end
 
+## Alternate Data Structures ##
+
+The set\_data method on a Hotwire::Response object can be called with several different data structures in order to make getting data into the response as smoothly as possible. See the documentation for Hotwire::Response.set\_data for more details.
+
 ## ActiveRecord ##
 
 If your project includes ActiveRecord, Hotwire will automatically included an ActiveRecord mixin that allows columns to be added from a model class.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/hotwire.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hotwire}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Les Freeman"]
-  s.date = %q{2010-10-25}
+  s.date = %q{2010-11-02}
   s.description = %q{Hotwire is designed to ease the pain of creating Google Wire protocol compatible data source in Ruby.}
   s.email = %q{les@codebenders.com}
   s.extra_rdoc_files = [

data/lib/hotwire/response/base.rb

@@ -34,26 +34,113 @@ module Hotwire
       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'}])
+      # Adds a colleciton of columns to the visualization
+      # +columns+ can either be an array of column definitions:
+      #   add_columns(['string', {:id => 'Column A'}], ['number', {:id => 'Column B'}])
+      #
+      # or a sample row of data, represented as a hash keyed as column_name => value:
+      #   add_columns({:column_a => 'a1', :column_b => 'b1})
+      # column_name keys are expected to be symbols(string keys do not maintain order).
       def add_columns(columns)
-        columns.each { |col| add_column(*col)}
+        if columns.first.is_a?(Hash)
+          add_columns_from_data_hash(columns)
+        else
+          add_columns_from_array(columns)
+        end
       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 
-      # ordering must be the same used in +add_col+ invokations.
-      #
-      # Anything that behaves like a 2-dimensional array and supports +each+ is
+      # Sets the data to be exported. 
+      # +data+ can be a 2-dimensional array of plain data, an array of hashes that are keyed 
+      # column_name => value, or a hash with a :columns key and a :rows key 
+      # 
+      # If passing a 2-dimensional array, the first index should iterate over rows, 
+      # the second over columns. Column ordering must be the same used in +add_col+ 
+      # invokations. Anything that behaves like a 2-dimensional array and supports +each+ is
       # a perfectly fine alternative.
+      #
+      # If passing an array of column_name => value hashes and no columns have been added,
+      # a column will automatically be added for each entry in the first row of data.
+      # If columns have already been added then the data will be filtered to those
+      # columns. column_name keys are expected to be symbols(string keys do not maintain order).
+      #
+      # If passing a hash with :columns key and a :rows key, 
+      # :columns should be an array of column ids: ['col_a', 'col_b'...'col_N']
+      # :rows should be a 2-dimensional array of data: [['a1', 'b1']...['aN', 'bN']]
+      # Note that each row of data must be in the same order as the column id array.
       def set_data(data)
-        @data = data
+        if data.is_a?(Hash)
+          set_data_from_hash(data)
+        elsif data.first.is_a?(Hash)
+          set_data_from_array_of_hashes(data)
+        else
+          set_data_from_array(data)
+        end
         return self
       end
       
       # Placeholder method for the subclasses to overwrite
       def body
       end
+      
+    protected
+    
+      # Adds columns to the response based on a sample row of data in the form of a hash
+      # keyed as column_name => value
+      def add_columns_from_data_hash(data)
+        data.first.each do |key, value|
+          add_column(column_type_for_value(value), :id => key.to_s, :label => key.to_s)
+        end
+      end
+      
+      # Determines the appropriate Wire Protocol column type for +value+
+      def column_type_for_value(value)
+        case value.class.name
+        when 'BigDecimal', 'Fixnum', 'Float'
+          'number'
+        when /Time/
+          'datetime'
+        when 'Date'
+          'date'
+        when 'String'
+          'string'
+        else
+          'string'
+        end
+      end
+      
+      # Adds multiple columns to the response from an array of column definitions:
+      #   add_columns(['string', {:id => 'Column A'}], ['number', {:id => 'Column B'}])
+      def add_columns_from_array(columns)
+        columns.each { |col| add_column(*col)}
+      end
+      
+      # Sets up the response based on a hash that has a :columns key and a :rows key.
+      # :columns should be an array of column ids: ['col_a', 'col_b'...'col_N']
+      # :rows should be a 2-dimensional array of data: [['a1', 'b1']...['aN', 'bN']]
+      # This method adds columns based on the first row of data and the provided
+      # array of column ids. Note that each row of data must be in the same
+      # order as the column id array.
+      def set_data_from_hash(data)
+        data[:columns].each_with_index do |column_name, index|
+          sample_value = data[:rows].first[index]
+          add_column(column_type_for_value(sample_value), :id => column_name, :label => column_name)
+        end
+        set_data_from_array(data[:rows])
+      end
+      
+      # Sets the response data from an array of row hashes that are keyed column_name => value.
+      # If there are no columns setup, they are added automatically.
+      # Data is filtered on the columns that exist.
+      def set_data_from_array_of_hashes(data)
+        add_columns(data) if columns.empty?
+        set_data(data.map { |row| self.columns.map { |c| row[c[:id].to_sym] } })
+      end
+      
+      # Sets the response data from a two dimensional array of innumerables.
+      def set_data_from_array(data)
+        @data = data
+      end
+      
     end
     
   end

data/test/response/test_base.rb

@@ -39,14 +39,76 @@ class TestResponseBase < Test::Unit::TestCase
       end
       
       context "set_data" do
-        setup do
-          @data = [['a', 'b']]
-          @response.set_data(@data)
+        context "from an array of hashes" do
+          context "when columns are not set" do
+            setup do
+              @datetime = Time.utc(2010, 11, 2, 9, 35, 00)
+              @data = [{:string_col => 'a1', :int_col => 2, :decimal_col => 3.3, :datetime_col => @datetime}]
+              @response.set_data(@data)
+            end
+            should "add columns to the response" do
+              expected = [{:id => 'string_col', :label => "string_col", :type => 'string'},
+                          {:id => 'int_col', :label => "int_col", :type => 'number'},
+                          {:id => 'decimal_col', :label => "decimal_col", :type => 'number'},
+                          {:id => 'datetime_col', :label => "datetime_col", :type => 'datetime'}]
+              assert_equal expected, @response.columns
+            end
+            should "set the data for the response" do
+              assert_equal [['a1', 2, 3.3, @datetime]], @response.data
+            end
+          end
+          
+          context "when columns are already set" do
+            setup do
+              @data = [{:col_a => 'a1', :col_b => 'b1', :col_c => 'c1'}]
+              @response.add_columns([['string', {:id => 'col_c', :label => 'col_c'}],
+                                     ['string', {:id => 'col_a', :label => 'col_a'}]])
+              @response.set_data(@data)
+            end
+            should "add columns to the response" do
+              expected = [{:id => 'col_c', :label => "col_c", :type => 'string'},
+                          {:id => 'col_a', :label => "col_a", :type => 'string'}]
+              assert_equal expected, @response.columns
+            end
+            should "set the data for the response" do
+              assert_equal [['c1', 'a1']], @response.data
+            end
+          end
         end
         
-        should "set the data for the response" do
-          assert_equal @data, @response.data
+        context "from a :rows, :columns hash" do
+          setup do
+            @datetime = Time.utc(2010, 11, 2, 9, 35, 00)
+            @data = {:columns => ["string_col", "int_col", "decimal_col", "datetime_col"],
+                     :rows => [['a1', 2, 3.3, @datetime]]}
+            @response.set_data(@data)
+          end
+          
+          should "add columns to the response" do
+            expected = [{:id => 'string_col', :label => "string_col", :type => 'string'},
+                        {:id => 'int_col', :label => "int_col", :type => 'number'},
+                        {:id => 'decimal_col', :label => "decimal_col", :type => 'number'},
+                        {:id => 'datetime_col', :label => "datetime_col", :type => 'datetime'}]
+            assert_equal expected, @response.columns
+          end
+          
+          should "set the data from the response" do
+            assert_equal [['a1', 2, 3.3, @datetime]], @response.data
+          end
+        end
+        
+        context "from an array of arrays" do
+          setup do
+            @data = [['a', 'b']]
+            @response.set_data(@data)
+          end
+        
+          should "set the data for the response" do
+            assert_equal @data, @response.data
+          end
         end
+        
+        
       end
       
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hotwire
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Les Freeman
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-25 00:00:00 -07:00
+date: 2010-11-02 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency