hotwire 0.0.0 → 0.1.0

data/test/test_response.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+class TestResponse < Test::Unit::TestCase
+  context "Hotwire::Response" do
+    
+    context "from_request" do
+      context "for json" do
+        setup { @response = Hotwire::Response.from_request(valid_request(:out => 'json')) }
+        
+        should "be an instance of Hotwire::Response::Json" do
+          assert @response.is_a?(Hotwire::Response::Json)
+        end
+      end
+      
+      context "for html" do
+        setup { @response = Hotwire::Response.from_request(valid_request(:out => 'html')) }
+        
+        should "be an instance of Hotwire::Response::Html" do
+          assert @response.is_a?(Hotwire::Response::Html)
+        end
+      end
+      
+      context "for csv" do
+        setup { @response = Hotwire::Response.from_request(valid_request(:out => 'csv')) }
+        
+        should "be an instance of Hotwire::Response::Csv" do
+          assert @response.is_a?(Hotwire::Response::Csv)
+        end
+      end
+      
+      context "for an invalid type" do
+        setup { @response = Hotwire::Response.from_request(valid_request(:out => 'invalid')) }
+        
+        should "be an instance of Hotwire::Response::Invalid" do
+          assert @response.is_a?(Hotwire::Response::Invalid)
+        end
+      end
+    end
+    
+  end
+  
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 0
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Les Freeman
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-20 00:00:00 -07:00
+date: 2010-10-25 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: thoughtbot-shoulda
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
@@ -27,10 +27,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
+  type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: thoughtbot-shoulda
+  name: redgreen
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
@@ -42,7 +42,7 @@ dependencies:
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: redgreen
+  name: mocha
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
@@ -61,29 +61,34 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.makrdown
+- README.markdown
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.makrdown
+- README.markdown
 - Rakefile
 - VERSION
 - hotwire.gemspec
 - lib/hotwire.rb
-- lib/hotwire/active_record_mixins.rb
-- lib/hotwire/column_headers.rb
-- lib/hotwire/core_extensions.rb
-- lib/hotwire/row.rb
-- lib/hotwire/table.rb
-- test/active_record_test_helper.rb
+- lib/hotwire/base.rb
+- lib/hotwire/request.rb
+- lib/hotwire/response.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/hotwire_test.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_column_headers.rb
-- test/test_core_extensions.rb
 - test/test_helper.rb
-- test/test_row.rb
-- test/test_table.rb
+- test/test_request.rb
+- test/test_response.rb
 has_rdoc: true
 homepage: http://github.com/lesfreeman/hotwire
 licenses: []
@@ -115,11 +120,13 @@ 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_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_column_headers.rb
-- test/test_core_extensions.rb
 - test/test_helper.rb
-- test/test_row.rb
-- test/test_table.rb
+- test/test_request.rb
+- test/test_response.rb

data/README.makrdown

@@ -1,46 +0,0 @@
-# Hotwire
-
-Hotwire is designed to ease the pain of creating Google Wire Protocol compatible data source in Ruby. Specifically, Hotwire can make it dead simple to provide data for the Google Visualization API.
-
-## Basic Usage
-
-Create a data hash...
-
-    data = {:columns => ['name', 'years', 'location'], :rows => [["Bob", 21, "Baltimore"],
-                                                                 ["Fred", 11, "Pittsburgh"]]}
-
-...convert it...
-    
-    data.to_wire
-
-...and savor the results:
-    
-    {"table"=>{"rows"=>[{"c"=>[{"v"=>"Bob"}, {"v"=>21}, {"v"=>"Baltimore"}]}, {"c"=>[{"v"=>"Fred"}, {"v"=>11}, {"v"=>"Pittsburgh"}]}], "cols"=>[{"type"=>"string", "id"=>"name", "label"=>"Name"}, {"type"=>"number", "id"=>"years", "label"=>"Years"}, {"type"=>"string", "id"=>"location", "label"=>"Location"}]}}
-
-## Basic ActiveRecord Usage
-If your project includes ActiveRecord, Hotwire will automatically included an extension to itself for processing ActiveRecord collections. This allows you to do something like:
-
-    people = Person.all
-    people.to_wire
-    
-Resulting in:
-
-    {"table"=>{"rows"=>[{"c"=>[{"v"=>"Bob"}, {"v"=>21}, {"v"=>"Baltimore"}]}, {"c"=>[{"v"=>"Fred"}, {"v"=>11}, {"v"=>"Pittsburgh"}]}], "cols"=>[{"type"=>"string", "id"=>"name", "label"=>"Name"}, {"type"=>"number", "id"=>"years", "label"=>"Years"}, {"type"=>"string", "id"=>"location", "label"=>"Location"}]}}
-
-## Advanced Usage ##
-
-Under the hood, Hotwire is designed to be extended in the future to allow for other construction methods and direct data manipulation. I haven't had a need for these features yet, but if you do and are interested in implementing them, please let me know.
-
-## Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-## Copyright
-
-Copyright (c) 2010 Les Freeman. See LICENSE for details.

data/lib/hotwire/active_record_mixins.rb

@@ -1,95 +0,0 @@
-module Hotwire #:nodoc:
-  
-  ##
-  # Hotwire extensions to build from ActiveRecord collections
-  #
-  module ActiveRecordMixins
-    
-    ##
-    # Extensions to Hotwire::Table
-    #
-    module Table
-    private
-      def self.included base
-        base.class_eval do
-          alias_method_chain :initialize, :active_record_extension
-        end
-      end
-      
-      ##
-      # Parse source data if needed and then pass it along to main initializer
-      #
-      def initialize_with_active_record_extension source
-        source = source_from_active_record_collection(source) if source.is_a?(Array) and source.first.is_a?(ActiveRecord::Base)
-        initialize_without_active_record_extension source
-      end
-    
-      ##
-      # Parse an ActiveRecord collection into a hash for the initializer
-      #
-      def source_from_active_record_collection source
-        { :columns => columns_from_active_record_collection(source), :rows => rows_from_active_record_collection(source) }
-      end
-    
-      ##
-      # Parse an ActiveRecord collection into a column headers array
-      #
-      def columns_from_active_record_collection source
-        source.first.attributes.keys.sort
-      end
-      
-      ##
-      # Parse an ActiveRecord collection into a rows array
-      #
-      def rows_from_active_record_collection source
-        source.map do |obj| 
-          obj.attributes.sort_by{ |key, val| key }.map do |key, val|
-            val
-          end
-        end
-      end
-    end
-    
-    ##
-    # Extensions to Hotwire::Row
-    #
-    module Row
-    private
-      ##
-      # Times pulled from an activerecord attribute hash are not converted to the zone automatically
-      #
-      def format_date_with_time_zone_conversion date
-        date = date.in_time_zone if Time.respond_to?(:zone) and Time.zone and date.respond_to?(:in_time_zone)
-        format_date_without_time_zone_conversion date
-      end
-      
-      def self.included base
-        base.class_eval do
-          alias_method_chain :format_date, :time_zone_conversion
-        end
-      end
-    end
-    
-    ##
-    # Extensions to Hotwire::CoreExtensions
-    #
-    module CoreExtensions
-      
-      module Array
-        ##
-        # Converts an ActiveRecord collection array to a Wire compatible hash
-        #
-        def to_wire
-          raise "to_wire only works on an array of ActiveRecord objects" if self.map {|elem| elem.is_a?(ActiveRecord::Base)}.include?(false)
-          Hotwire::Table.new(self).to_wire
-        end
-      end
-    end
-     
-  end
-  
-end
-
-Hotwire::Table.send(:include, Hotwire::ActiveRecordMixins::Table) 
-Hotwire::Row.send(:include, Hotwire::ActiveRecordMixins::Row) 
-Array.send(:include, Hotwire::ActiveRecordMixins::CoreExtensions::Array)

data/lib/hotwire/column_headers.rb

@@ -1,54 +0,0 @@
-require 'active_support'
-
-module Hotwire #:nodoc:
-  
-  ##
-  # Represents header information for a Hotwire::Table
-  #
-  class ColumnHeaders
-    
-    ##
-    # Initialize from a hash of data. See Hotwire::Table.initialize for param information.
-    #
-    def initialize data
-      @data = data
-    end
-  
-    ##
-    # Convert to a Wire compatible Hash
-    #
-    def to_wire
-      returning [] do |columns|
-        @data[:columns].each_with_index do |column, index| 
-          columns << {'id' => column, 'label' => column.humanize, 'type' => column_type_for_index(index)}
-        end
-      end
-    end
-
-  private
-  
-    ##
-    # Determine the column data type by index 
-    #
-    def column_type_for_index index
-      column_type(@data[:rows].first[index])
-    end
-    
-    ##
-    # Determine the column data type for a given value
-    #
-    def column_type sample_value
-      case sample_value.class.name
-      when 'BigDecimal', 'Fixnum'
-        'number'
-      when /Time/
-        'datetime'
-      when 'String'
-        'string'
-      else
-        'string'
-      end
-    end
-
-  end
-end

data/lib/hotwire/core_extensions.rb

@@ -1,11 +0,0 @@
-class Hash #:nodoc:
-  
-  ##
-  # Returns a new Wire formatted hash based on an approriately formatted hash.
-  # For information on required keys, see Hotwire::Table.initialize
-  #
-  def to_wire
-    Hotwire::Table.new(self).to_wire
-  end
-  
-end

data/lib/hotwire/row.rb

@@ -1,46 +0,0 @@
-module Hotwire #:nodoc:
-  
-  ##
-  # Represents a one-dimensional row of data.
-  #
-  class Row
-    
-    ##
-    # Construct a new Row object from a array of data.
-    #
-    def initialize data
-      raise ArgumentError, "data must be an Array of values" unless data.is_a?(Array)
-      @data = data
-    end
-  
-    ##
-    # Convert the row to a Wire compatible Hash
-    #
-    def to_wire
-      { 'c' => @data.map { |value| {'v' => format_value(value) } } }
-    end
-
-  private
-  
-    ##
-    # Perform any formatting needed to make value Wire compatible.
-    #
-    def format_value value
-      case value.class.name
-      when /Time/
-        format_date value
-      when /NilClass/
-        0
-      else
-        value
-      end
-    end
-    
-    ##
-    # Wire dates seem to expect to have 0 based month.
-    #
-    def format_date value
-      "Date(#{value.year}, #{value.month - 1}, #{value.day}, #{value.hour}, #{value.min}, #{value.sec})"
-    end
-  end
-end

data/lib/hotwire/table.rb

@@ -1,27 +0,0 @@
-module Hotwire #:nodoc:
-  
-  ##
-  # Represents a two dimensional table of data that is ready to format for the Wire protocol
-  #
-  class Table
-    ##
-    # Create a table from a source hash. The hash must contain these keys:
-    # :columns => A one dimensional array of column labels.
-    # :rows => => A two dimensional array of data. Each row is a one dimensional array.
-    #
-    def initialize source
-      raise ArgumentError, "source data must have a :column key and a :rows key" unless source.has_key?(:columns) && source.has_key?(:rows)
-      @column_headers = Hotwire::ColumnHeaders.new(source)
-      @rows = source[:rows].map { |row| Hotwire::Row.new(row) }
-    end
-    
-    ##
-    # Convert the table to a Wire compatible hash
-    #
-    def to_wire
-      {'table' => {'cols' => @column_headers.to_wire, 'rows' => @rows.map {|r| r.to_wire} } }
-    end
-    
-  end
-  
-end

data/test/active_record_test_helper.rb

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