transcoder 0.3.0 → 0.4.0

data/CHANGES

@@ -1,4 +1,10 @@
-= 0.2.0
+= 0.4.0 (10/02/2010)
+  * Added ability to transcode from a ruby hash or array to: json, yaml or xml
+
+= 0.3.0 (08/02/2010)
+  * Re-factored autoloading (http://www.germanforblack.com/articles/ruby-autoload)
+  
+= 0.2.0 (08/02/2010)
   * Added Transcoder.for method for a shorter version of Transcoder::Parser.for
   * Added Yaml parser
   * Switched all parsers to use autoload for their associated library dependencies (http://gist.github.com/324367)

data/README.md

@@ -1,19 +1,16 @@
 # transcoder
 
-Transcode from common web based formats into plain old Ruby.
+Transcode between common web formats and Ruby. 
 
-## Scenario
+## Scenario (Web->Ruby)
 Say you'd pulled an API based resource using `rest-client`
   
   * All that you wanted was a ruby object.
-  * You don't want to know anything about the format that the API uses. 
+  * You don't want to know anything about the format that the API serves. 
   * You're pretty sure its something pretty common.
   
-## Install
-
-    gem install transcoder
 
-## Example
+## Example (Web->Ruby)
     $ irb -rubygems
     
     >> require 'restclient'
@@ -25,21 +22,50 @@ Say you'd pulled an API based resource using `rest-client`
     
 What you'll get back is a Ruby object. Lovley.
 
+## Scenario (Ruby→Web)
+
+You have a Ruby array or a hash and you want to pack it up and post it off somewhere else
+
+  * You have a target (content|mime)-type in mind 
+    
+    or
+    
+  * You have a named format eg: "json"
+
+## Example (Ruby→Web)
+    $ irb -rubygems
+    
+    >> require 'transcoder'
+    
+    >> Transcoder.for(:xml).generate({:title => "Hamlyn's Guide to Sauces and Saucemaking"})
+    => "<?xml version=\"1.0\"?>\n<items>\n  <item>\n    <title>Hamlyn's Guide to Sauces and Saucemaking</title>\n  </item>\n</items>\n"
+    
+    >> Transcoder.for(:yaml).generate({:title => "Hamlyn's Guide to Sauces and Saucemaking"})
+    => "--- \n:title: Hamlyn's Guide to Sauces and Saucemaking\n"
+    
+
 ## Supported formats
 
 * Json
 * XML
 * RSS / Atom
+* Yaml
+
+## Install
 
-### Note about RSS / Atom
+    gem install transcoder
 
-Transcoder will return a SimpleRSS object rather than a straight up Ruby hash, this shouldn't be (much) of a reason for concern.
-This simply means that you'll want to call the properties of the returned object with method calls rather than hash access.
+### Notes about RSS / Atom parsing and generation
 
-## Future thoughts
+* Transcoder will return a SimpleRSS object rather than a straight up Ruby hash, this shouldn't be (much) of a reason for concern.
+  
+  This simply means that you'll want to call the properties of the returned object with method calls rather than hash access.
+* There is no 'generate' method for feeds. This is simply because they require much more information than a raw feed.
 
-* Add something to cast attributes to a native ruby object, eg - if its key is created_at, try to date parse it.
+## Future thoughts
 
+* Add something to cast attributes to a native ruby object, eg - if its key is `created_at`, try to date parse it.
+* Generator methods to unpack and generate object trees (XML generator)
 
 ## Note on Patches/Pull Requests
  

data/Rakefile

@@ -16,6 +16,7 @@ begin
     gem.add_dependency "json"
     gem.add_dependency "crack"
     gem.add_dependency "simple-rss"
+    gem.add_dependency "nokogiri"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/lib/transcoder.rb

@@ -4,6 +4,8 @@ module Transcoder
   VERSION = File.read(File.join(File.dirname(__FILE__), "..", "VERSION"))
   
   class Parser
+    class TypeError < StandardError; end
+    
     extend Registry
   end
   

data/lib/transcoder/parser/feed/identifier.rb

@@ -1,10 +1,16 @@
 module Transcoder
   class Feed < Parser
-    identifier "application/atom+xml",
+    identifier "atom",
+               "rss",
+               "application/atom+xml",
                "application/rss+xml"
     
     autoload :Handler, "feed/handler"
-  
+    
+    def self.generate(objects)
+      raise "NotImplemented"
+    end
+    
     def self.parse(raw)
       Feed::Handler.parse(raw)
     end

data/lib/transcoder/parser/json/identifier.rb

@@ -1,6 +1,7 @@
 module Transcoder
   class Json < Parser
-    identifier "application/json",
+    identifier "json",
+               "application/json",
                "application/x-javascript",
                "text/javascript",
                "text/x-javascript",
@@ -8,6 +9,11 @@ module Transcoder
                
     autoload :Handler, "json/handler"
     
+    def self.generate(objects)
+      raise TypeError unless objects.is_a? Hash or objects.is_a? Array
+      Json::Handler.generate(objects)
+    end
+    
     def self.parse(raw)
       Json::Handler.parse(raw)
     end

data/lib/transcoder/parser/xml/generator_handler.rb

@@ -0,0 +1,5 @@
+require 'nokogiri'
+
+class Transcoder::XML
+  GeneratorHandler = Nokogiri::XML::Builder
+end

data/lib/transcoder/parser/xml/identifier.rb

@@ -1,12 +1,39 @@
 module Transcoder
   class XML < Parser
-    identifier "text/xml",
+    identifier "xml",
+               "text/xml",
                "application/xml"
 
-    autoload :Handler, "xml/handler"
+    autoload :GeneratorHandler, "xml/generator_handler"
+    autoload :ParserHandler,    "xml/parser_handler"
+    
+    def self.generate(object)
+      raise TypeError unless object.is_a? Hash or object.is_a? Array
+      builder = XML::GeneratorHandler.new do |xml|
+        xml.items {
+          if object.is_a? Array
+            object.each{|item| xml.item(:value => item) }
+          elsif object.is_a? Hash
+            # stringify all the keys
+            object.each {|key, value| object[key.to_s] = object.delete(key) }
+            
+            xml.item {
+              object.each do |key, value|
+                # id, type, class and fork must be appended with _
+                key = "#{key}_" if key =~ /(id|type|class|fork)/
+                
+                xml.send(key, value)
+              end
+            }
+          end
+        }
+      end
+    
+      builder.to_xml
+    end
              
     def self.parse(raw)
-      XML::Handler.parse(raw)
+      XML::ParserHandler.parse(raw)
     end
   end
-end
+end

data/lib/transcoder/parser/xml/{handler.rb → parser_handler.rb}

@@ -1,5 +1,5 @@
 require 'crack'
 
 class Transcoder::XML
-  Handler = Crack::XML
+  ParserHandler = Crack::XML
 end

data/lib/transcoder/parser/yaml/identifier.rb

@@ -3,11 +3,17 @@ autoload :YAML, "yaml"
 
 module Transcoder
   class Yaml < Parser
-    identifier "text/yaml",
+    identifier "yaml",
+               "text/yaml",
                "text/x-yaml",
                "application/yaml",
                "application/x-yaml"
     
+    def self.generate(objects)
+      raise TypeError unless objects.is_a? Hash or objects.is_a? Array
+      YAML.dump(objects)
+    end
+    
     def self.parse(raw)
       YAML.load(raw)
     end

data/spec/parser/feed_spec.rb

@@ -33,4 +33,8 @@ describe Transcoder::Feed do
     
     Transcoder.for("application/atom+xml").parse(atom).should be_an_instance_of(SimpleRSS)
   end
+  
+  it "should raise NotImplemented from a ruby object" do
+    lambda { Transcoder.for("application/atom+xml").generate({:key => "value"}) }.should raise_error("NotImplemented")
+  end
 end

data/spec/parser/json_spec.rb

@@ -4,4 +4,27 @@ describe Transcoder::Json do
   it "should parse the json and return a ruby object" do
     Transcoder.for("application/json").parse('{"key": "value"}').should == {"key" => "value"}
   end
+  
+  
+  describe "generate" do
+    it "json from a ruby object" do
+      Transcoder.for("json").generate({:key => "value"}).should == "{\"key\":\"value\"}"
+    end
+    
+    it "should accept an array" do
+      lambda { Transcoder.for("json").generate([1, 2, 3]) }.should_not raise_error
+    end
+    
+    it "should accept a hash" do
+      lambda { Transcoder.for("json").generate({:key => "value"}) }.should_not raise_error
+    end
+    
+    it "should not accept a string" do
+      lambda { Transcoder.for("json").generate("value") }.should raise_error
+    end
+    
+    it "should not accept an object" do
+      lambda { Transcoder.for("json").generate(Object.new) }.should raise_error
+    end
+  end
 end

data/spec/parser/xml_spec.rb

@@ -4,4 +4,44 @@ describe Transcoder::XML do
   it "should parse the xml and return a ruby object" do
     Transcoder.for("application/xml").parse("<key>value</key>").should == {"key" => "value"}
   end
+  
+  describe "generate" do
+    it "xml from a ruby object" do
+      Transcoder.for("xml").generate({"key" => "value"}).should == "<?xml version=\"1.0\"?>\n<items>\n  <item>\n    <key>value</key>\n  </item>\n</items>\n"
+    end
+    
+    describe "nokogiri inefficiencies" do
+      it "should handle keys of id" do
+        Transcoder.for("xml").generate({"id" => "value"}).should == "<?xml version=\"1.0\"?>\n<items>\n  <item>\n    <id>value</id>\n  </item>\n</items>\n"
+      end
+      
+      it "should handle keys of type" do
+        Transcoder.for("xml").generate({"type" => "value"}).should == "<?xml version=\"1.0\"?>\n<items>\n  <item>\n    <type>value</type>\n  </item>\n</items>\n"
+      end
+      
+      it "should handle keys of class" do
+        Transcoder.for("xml").generate({"class" => "value"}).should == "<?xml version=\"1.0\"?>\n<items>\n  <item>\n    <class>value</class>\n  </item>\n</items>\n"
+      end
+      
+      it "should handle keys of fork" do
+        Transcoder.for("xml").generate({"fork" => "value"}).should == "<?xml version=\"1.0\"?>\n<items>\n  <item>\n    <fork>value</fork>\n  </item>\n</items>\n"
+      end
+    end
+    
+    it "should accept an array" do
+      lambda { Transcoder.for("xml").generate([1, 2, 3]) }.should_not raise_error
+    end
+    
+    it "should accept a hash" do
+      lambda { Transcoder.for("xml").generate({:key => "value"}) }.should_not raise_error
+    end
+    
+    it "should not accept a string" do
+      lambda { Transcoder.for("xml").generate("value") }.should raise_error
+    end
+    
+    it "should not accept an object" do
+      lambda { Transcoder.for("xml").generate(Object.new) }.should raise_error
+    end
+  end
 end

data/spec/parser/yaml_spec.rb

@@ -4,4 +4,26 @@ describe Transcoder::Yaml do
   it "should parse the yaml and return a ruby object" do
     Transcoder.for("application/x-yaml").parse("key: value").should == {"key" => "value"}
   end
+  
+  describe "generate" do
+    it "yaml from a ruby object" do
+      Transcoder.for("yaml").generate({:key => "value"}).should == "--- \n:key: value\n"
+    end
+    
+    it "should accept an array" do
+      lambda { Transcoder.for("yaml").generate([1, 2, 3]) }.should_not raise_error
+    end
+    
+    it "should accept a hash" do
+      lambda { Transcoder.for("yaml").generate({:key => "value"}) }.should_not raise_error
+    end
+    
+    it "should not accept a string" do
+      lambda { Transcoder.for("yaml").generate("value") }.should raise_error
+    end
+    
+    it "should not accept an object" do
+      lambda { Transcoder.for("yaml").generate(Object.new) }.should raise_error
+    end
+  end
 end

data/transcoder.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{transcoder}
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Schwarz"]
-  s.date = %q{2010-03-08}
+  s.date = %q{2010-03-21}
   s.description = %q{Transcode from json, xml or atom/rss feeds to Ruby.}
   s.email = %q{ben.schwarz@gmail.com}
   s.extra_rdoc_files = [
@@ -29,8 +29,9 @@ Gem::Specification.new do |s|
      "lib/transcoder/parser/feed/identifier.rb",
      "lib/transcoder/parser/json/handler.rb",
      "lib/transcoder/parser/json/identifier.rb",
-     "lib/transcoder/parser/xml/handler.rb",
+     "lib/transcoder/parser/xml/generator_handler.rb",
      "lib/transcoder/parser/xml/identifier.rb",
+     "lib/transcoder/parser/xml/parser_handler.rb",
      "lib/transcoder/parser/yaml/identifier.rb",
      "spec/parser/feed_spec.rb",
      "spec/parser/json_spec.rb",
@@ -66,6 +67,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<json>, [">= 0"])
       s.add_runtime_dependency(%q<crack>, [">= 0"])
       s.add_runtime_dependency(%q<simple-rss>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
     else
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_dependency(%q<rest-client>, [">= 0"])
@@ -73,6 +75,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<json>, [">= 0"])
       s.add_dependency(%q<crack>, [">= 0"])
       s.add_dependency(%q<simple-rss>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
     end
   else
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
@@ -81,6 +84,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<json>, [">= 0"])
     s.add_dependency(%q<crack>, [">= 0"])
     s.add_dependency(%q<simple-rss>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
   end
 end
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Ben Schwarz
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-08 00:00:00 +11:00
+date: 2010-03-21 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -93,6 +93,18 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id007
 description: Transcode from json, xml or atom/rss feeds to Ruby.
 email: ben.schwarz@gmail.com
 executables: []
@@ -115,8 +127,9 @@ files:
 - lib/transcoder/parser/feed/identifier.rb
 - lib/transcoder/parser/json/handler.rb
 - lib/transcoder/parser/json/identifier.rb
-- lib/transcoder/parser/xml/handler.rb
+- lib/transcoder/parser/xml/generator_handler.rb
 - lib/transcoder/parser/xml/identifier.rb
+- lib/transcoder/parser/xml/parser_handler.rb
 - lib/transcoder/parser/yaml/identifier.rb
 - spec/parser/feed_spec.rb
 - spec/parser/json_spec.rb