representable 0.0.2 → 0.9.0

data/CHANGES.textile

@@ -0,0 +1,5 @@
+h2. 0.9.0
+
+h3. Changes
+  * Removed the :tag option in favor of :from. The Definition#from method is now authorative for all name mappings. 
+  * Removed the active_support and i18n dependency.

data/README.rdoc

@@ -29,7 +29,7 @@ Now, parsing manually starts simple but gets complex soon. In the end, you have
     include Representable::XML
     
     representable_property :id
-    representable_collection :items, :tag => :item, :as => Item
+    representable_collection :items, :from => :item, :as => Item
   end
   
   class Item
@@ -73,6 +73,12 @@ You can also render a representation from a newly created object.
 
 Representable makes working with representations extremely easy and testable.
 
+
+== Serialization Backends
+
+This gem ships with JSON and XML support, meaning you can parse and render both media formats. 
+
+
 == More
 
 Representable was written with REST representations in mind. However, it is a generic module for working with documents. If you do consider using it for a REST project, check out the {Roar framework}[http://github.com/apotonick/roar], which comes with representers, built-in hypermedia support and more. It internally uses Representable and streamlines the process for building hypermedia-driven REST applications.

data/Rakefile

@@ -3,6 +3,9 @@ Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
 
+desc 'Test the representable gem.'
+task :default => :test
+
 Rake::TestTask.new(:test) do |test|
   test.libs << 'test'
   test.test_files = FileList['test/*_test.rb']

data/lib/representable.rb

@@ -1,15 +1,8 @@
-require 'active_support'
-require 'active_support/core_ext/module/delegation'
-require 'active_support/core_ext/string/inflections.rb'
-require 'active_support/core_ext/hash/reverse_merge.rb'
-
 require 'hooks/inheritable_attribute'
 
-
 require 'representable/definition'
 require 'representable/nokogiri_extensions'
 
-#require 'representable/xml' # TODO: do that dynamically.
 
 module Representable
   def self.included(base)
@@ -226,7 +219,10 @@ module Representable
       end
       
       def representation_name
-        explicit_representation_name or name.split('::').last.underscore
+        explicit_representation_name or name.split('::').last.
+         gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+         gsub(/([a-z\d])([A-Z])/,'\1_\2').
+         downcase
       end
     end
   end

data/lib/representable/bindings/json_bindings.rb

@@ -2,7 +2,7 @@ module Representable
   module JSON
     class Binding
       attr_reader :definition
-      delegate :required?, :array?, :accessor, :wrapper, :name, :to => :definition
+      #delegate :required?, :array?, :accessor, :from, :to => :definition
 
       def initialize(definition)
         @definition = definition
@@ -18,19 +18,19 @@ module Representable
       end
       
       def collect_for(hash)
-        nodes = hash[name.to_s] or return
+        nodes = hash[definition.from] or return
         nodes = [nodes] unless nodes.is_a?(Array)
         
         vals  = nodes.collect { |node| yield node }
         
-        array? ? vals : vals.first
+        definition.array? ? vals : vals.first
       end
     end
     
     # Represents plain key-value.
     class TextBinding < Binding
       def update_json(hash, value)
-        hash[name] = value
+        hash[definition.from] = value
       end
 
     private
@@ -43,11 +43,11 @@ module Representable
   
     # Represents a tag with object binding.
     class ObjectBinding < Binding
-      delegate :sought_type, :to => :definition
+      #delegate :sought_type, :to => :definition
       
       def update_json(hash, value)
-        if array?
-          hash.merge! ({accessor => value.collect {|v| v.to_hash(:wrap => false)}}) # hier name=> wech.
+        if definition.array?
+          hash.merge! ({definition.from => value.collect {|v| v.to_hash(:wrap => false)}}) # hier name=> wech.
         else
           hash.merge! value.to_hash
         end
@@ -60,7 +60,7 @@ module Representable
       
       def value_from_hash(xml)
         collect_for(xml) do |node|
-          sought_type.from_json(node, :wrap => false) # hier name=> wech.
+          definition.sought_type.from_json(node, :wrap => false) # hier name=> wech.
         end
       end
       

data/lib/representable/bindings/xml_bindings.rb

@@ -2,7 +2,6 @@ module Representable
   module XML
     class Binding
       attr_reader :definition
-      delegate :required?, :array?, :accessor, :wrapper, :name, :to => :definition
 
       def initialize(definition)
         @definition = definition
@@ -20,11 +19,11 @@ module Representable
       end
       
       def xpath
-        name
+        definition.from
       end
 
       def wrap(xml, opts = {:always_create => false})
-        wrap_with = @auto_vals ? auto_wrapper : wrapper
+        wrap_with = @auto_vals ? auto_wrapper : definition.wrapper
 
         return xml if !wrap_with || xml.name == wrap_with
         if !opts[:always_create] && (child = xml.children.find {|c| c.name == wrap_with })
@@ -37,7 +36,7 @@ module Representable
         nodes = xml.search("./#{xpath}")
         vals  = nodes.collect { |node| yield node }
         
-        array? ? vals : vals.first
+        definition.array? ? vals : vals.first
       end
     end
     
@@ -46,35 +45,33 @@ module Representable
     class AttributeBinding < Binding
       def update_xml(xml, values)
         wrap(xml).tap do |xml|
-          xml[name] = values.to_s
+          xml[definition.from] = values.to_s
         end
       end
 
     private
       def value_from_node(xml)
-        xml[name]
+        xml[definition.from]
       end
     end
     
     
     # Represents text content in a tag. # FIXME: is this tested???
     class TextBinding < Binding
-      delegate :cdata?, :content?, :name?, :to => :definition
-
       # Updates the text in the given _xml_ block to
       # the _value_ provided.
       def update_xml(xml, value)
         wrap(xml).tap do |xml|
-          if content?
+          if definition.content?
             add(xml, value)
-          elsif name?
+          elsif definition.name?
             xml.name = value
-          elsif array?
+          elsif definition.array?
             value.each do |v|
-              add(xml.add_node(name), v)
+              add(xml.add_node(definition.from), v)
             end
           else
-            add(xml.add_node(name), value)
+            add(xml.add_node(definition.from), value)
           end
         end
       end
@@ -87,30 +84,17 @@ module Representable
       end
 
       def add(dest, value)
-        if cdata?
-          dest.add_child(Nokogiri::XML::CDATA.new(dest.document, content))
-        else
-          dest.content = value.to_s
-        end
-      end
-    end
-  
-
-    class NamespaceBinding < Binding
-    private
-      def value_from_node(xml)
-        xml.namespace.prefix
+        dest.content = value.to_s
       end
     end
+    
 
     # Represents a tag with object binding.
     class ObjectBinding < Binding
-      delegate :sought_type, :to => :definition
-
       # Adds the ref's markup to +xml+. 
       def update_xml(xml, value)
         wrap(xml).tap do |xml|
-          if array?
+          if definition.array?
             update_xml_for_collection(xml, value)
           else
             update_xml_for_entity(xml, value)
@@ -134,7 +118,7 @@ module Representable
       # Deserializes the ref's element from +xml+.
       def value_from_node(xml)
         collect_for(xml) do |node|
-          deserialize(sought_type, node)
+          deserialize(definition.sought_type, node)
         end
       end
       

data/lib/representable/definition.rb

@@ -1,38 +1,16 @@
-class Module
-  def bool_attr_reader(*attrs)
-    attrs.each do |attr|
-      define_method :"#{attr}?" do
-        instance_variable_get(:"@#{attr}") || false
-      end
-    end
-  end
-end
-
 module Representable
-  class ContradictoryNamespaces < StandardError
-  end
   class Definition # :nodoc:
-    attr_reader :name, :sought_type, :wrapper, :accessor, :namespace
-    bool_attr_reader :name_explicit, :array, :cdata
+    attr_reader :name, :sought_type, :wrapper, :accessor, :from
+    
     
     def initialize(sym, opts={})
-      @accessor   = sym.to_s
-      @namespace  = opts.delete(:namespace)
+      @accessor = @name = sym.to_s
       
+      @array        = true if opts[:as].is_a?(Array) # DISCUSS: move to ArrayDefinition.
+      @from         = (opts[:from] || name).to_s
+      @sought_type  = extract_type(opts[:as])
       
-      if opts[:as].is_a?(Array) # DISCUSS: move to ArrayDefinition.
-        @array      = true
-        @name       = (opts[:tag] || @accessor).to_s
-      else
-        @name = accessor
-        @name = (opts[:from] || @name).to_s
-      end
-
-      @sought_type = extract_type(opts[:as])
-      if @sought_type.respond_to?(:roxml_tag_name)
-        opts[:from] ||= @sought_type.roxml_tag_name
-      end
-
+      # FIXME: move me to xml.
       if opts[:from] == :content
         opts[:from] = '.'
       elsif opts[:from] == :name
@@ -40,17 +18,10 @@ module Representable
       elsif opts[:from] == :attr
         @sought_type = :attr
         opts[:from] = nil
-      elsif opts[:from] == :namespace
-        opts[:from] = '*'
-        @sought_type = :namespace
-      elsif opts[:from].to_s =~ /^@/  # FIXME: move me to xml.
+      elsif opts[:from].to_s =~ /^@/
         @sought_type = :attr
         opts[:from].sub!('@', '')
       end
-
-      
-      #raise ContradictoryNamespaces if @name.include?(':') && (@namespace.present? || @namespace == false)
-
     end
 
     def instance_variable_name
@@ -73,6 +44,15 @@ module Representable
       @name == '.'
     end
     
+    def array?
+      @array
+    end
+    
+    def cdata?  # FIXME: move to XML!
+      @cdata
+    end
+    
+    
     # Applies the block to +value+ which might also be a collection.
     def apply(value)
       return value unless value # DISCUSS: is that ok here?

data/lib/representable/json.rb

@@ -26,9 +26,10 @@ module Representable
       def from_json(data, options={})
         # DISCUSS: extract #from_json call in Bindings to this place.
         data = ::JSON[data] if data.is_a?(String) # DISCUSS: #from_json sometimes receives a string (in nestings).
-        data ||= {}
-        
+        data ||= {} # DISCUSS: is this needed?
         data = data[representation_name.to_s] unless options[:wrap] == false
+        data ||= {} # FIXME: should we fail here? generate a warning?
+        
         
         create_from_json.tap do |inst|
           refs = representable_attrs.map {|attr| JSON.binding_for_definition(attr) }
@@ -53,7 +54,7 @@ module Representable
           refs = self.class.representable_attrs.map {|attr| JSON.binding_for_definition(attr) }
           
           refs.each do |ref|
-            value = public_send(ref.accessor) # DISCUSS: eventually move back to Ref.
+            value = public_send(ref.definition.accessor) # DISCUSS: eventually move back to Ref.
             ref.update_json(attrs, value) if value
           end
         end
@@ -67,5 +68,5 @@ module Representable
         to_hash(options).to_json
       end
     end
-  end # Xml
+  end
 end

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "0.0.2"
+  VERSION = "0.9.0"
 end

data/lib/representable/xml.rb

@@ -6,7 +6,6 @@ module Representable
     BINDING_FOR_TYPE = {
       :attr     => AttributeBinding,
       :text     => TextBinding,
-      :namespace=> NamespaceBinding,
     }
     
     def self.binding_for_definition(definition)
@@ -57,13 +56,13 @@ module Representable
     module InstanceMethods # :nodoc:
       # Returns a Nokogiri::XML object representing this object.
       def to_xml(params={})
-        params.reverse_merge!(:name => self.class.representation_name)
+        params[:name] ||= self.class.representation_name
         
         Nokogiri::XML::Node.new(params[:name].to_s, Nokogiri::XML::Document.new).tap do |root|
           refs = self.class.representable_attrs.map {|attr| XML.binding_for_definition(attr) }
           
           refs.each do |ref|
-            value = public_send(ref.accessor) # DISCUSS: eventually move back to Ref.
+            value = public_send(ref.definition.accessor) # DISCUSS: eventually move back to Ref.
             ref.update_xml(root, value) if value
           end
         end

data/representable.gemspec

@@ -19,12 +19,11 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   
-  s.add_dependency "activesupport"
   s.add_dependency "hooks"
   s.add_dependency "nokogiri"
-  s.add_dependency "i18n"
   s.add_dependency "json"
   
+  s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
   s.add_development_dependency "test_xml"
 end

data/test/bindings_test.rb

@@ -36,6 +36,26 @@ class DefinitionTest < MiniTest::Spec
       assert Representable::Definition.new(:songs, :as => Hash).typed?
       assert Representable::Definition.new(:songs, :as => [Hash]).typed?
     end
+    
+    it "responds to #accessor" do
+      assert_equal "songs", @def.accessor
+    end
+    
+    it "responds to #name" do
+      assert_equal "songs", @def.name 
+    end
+    
+    it "responds to #instance_variable_name" do
+      assert_equal :"@songs", @def.instance_variable_name
+    end
+    
+    it "responds to #setter" do
+      assert_equal :"songs=", @def.setter
+    end
+    
+    it "responds to #sought_type" do
+      assert_equal :text, @def.sought_type
+    end
   end
   
   
@@ -61,26 +81,10 @@ class DefinitionTest < MiniTest::Spec
       @def = Representable::Definition.new(:songs, :as => [], :tag => :song)
     end
     
-    it "responds to #accessor" do
-      assert_equal "songs", @def.accessor
-    end
-    
     it "responds to #array?" do
       assert @def.array?
     end
     
-    it "responds to #name" do
-      assert_equal "songs", @def.accessor 
-    end
-    
-    it "responds to #instance_variable_name" do
-      assert_equal :"@songs", @def.instance_variable_name
-    end
-    
-    it "responds to #setter" do
-      assert_equal :"songs=", @def.setter
-    end
-    
     it "responds to #sought_type" do
       assert_equal :text, @def.sought_type
     end

data/test/json_test.rb

@@ -6,7 +6,7 @@ module JsonTest
     Json = Representable::JSON
     Def = Representable::Definition
     
-    describe "Xml module" do
+    describe "JSON module" do
       describe "#binding_for_definition" do
         it "returns ObjectBinding" do
           assert_kind_of Json::ObjectBinding, Json.binding_for_definition(Def.new(:band, :as => Hash))
@@ -16,11 +16,32 @@ module JsonTest
           assert_kind_of Json::TextBinding, Json.binding_for_definition(Def.new(:band))
         end
       end
+      
+      describe "#from_json" do
+        class Band
+          include Json
+        end
+        
+        it "raises error with emtpy string" do
+          assert_raises JSON::ParserError do
+            Band.from_json("")
+          end
+        end
+        
+        it "returns empty hash with inappropriate hash" do
+          assert Band.from_json({:song => "Message In A Bottle"}.to_json)
+        end
+        
+        it "generates warning with inappropriate hash in debugging mode" do
+          
+        end
+      end
+      
     end
   end
 
   class PropertyTest < MiniTest::Spec
-    describe "property :name" do
+    describe "representable_property :name" do
       class Band
         include Representable::JSON
         representable_property :name
@@ -36,7 +57,6 @@ module JsonTest
         assert_equal "Bombshell Rocks", band.name
       end
       
-    
       it "#to_json serializes correctly" do
         band = Band.new
         band.name = "Cigar"
@@ -45,27 +65,6 @@ module JsonTest
       end
     end
     
-    describe "property :name, :as => []" do
-      class CD
-        include Representable::JSON
-        representable_property :songs, :as => []
-      end
-      
-      it "#from_json creates correct accessors" do
-        cd = CD.from_json({:cd => {:songs => ["Out in the cold", "Microphone"]}}.to_json)
-        assert_equal ["Out in the cold", "Microphone"], cd.songs
-      end
-    
-      it "#to_json serializes correctly" do
-        cd = CD.new
-        cd.songs = ["Out in the cold", "Microphone"]
-        
-        assert_equal '{"cd":{"songs":["Out in the cold","Microphone"]}}', cd.to_json
-      end
-    end
-  end
-
-  class TypedPropertyTest < MiniTest::Spec
     describe ":as => Item" do
       class Label
         include Representable::JSON
@@ -82,20 +81,54 @@ module JsonTest
         assert_equal "Bad Religion", album.label.name
       end
       
-      describe "#to_json" do
-        it "serializes" do
-          label = Label.new; label.name = "Fat Wreck"
-          album = Album.new; album.label = label
-          
-          assert_equal '{"album":{"label":{"name":"Fat Wreck"}}}', album.to_json
-        end
+      it "#to_json serializes" do
+        label = Label.new; label.name = "Fat Wreck"
+        album = Album.new; album.label = label
+        
+        assert_equal '{"album":{"label":{"name":"Fat Wreck"}}}', album.to_json
+      end
+    end
+    
+    describe ":from => :songName" do
+      class Song
+        include Representable::JSON
+        representable_property :name, :from => :songName
+      end
+      
+      it "respects :from in #from_json" do
+        song = Song.from_json({:song => {:songName => "Run To The Hills"}}.to_json)
+        assert_equal "Run To The Hills", song.name
+      end
+      
+      it "respects :from in #to_json" do
+        song = Song.new; song.name = "Run To The Hills"
+        assert_equal '{"song":{"songName":"Run To The Hills"}}', song.to_json
       end
     end
   end
 
 
   class CollectionTest < MiniTest::Spec
-    describe ":as => [Band]" do
+    describe "representable_collection :name" do
+      class CD
+        include Representable::JSON
+        representable_collection :songs
+      end
+      
+      it "#from_json creates correct accessors" do
+        cd = CD.from_json({:cd => {:songs => ["Out in the cold", "Microphone"]}}.to_json)
+        assert_equal ["Out in the cold", "Microphone"], cd.songs
+      end
+    
+      it "#to_json serializes correctly" do
+        cd = CD.new
+        cd.songs = ["Out in the cold", "Microphone"]
+        
+        assert_equal '{"cd":{"songs":["Out in the cold","Microphone"]}}', cd.to_json
+      end
+    end
+    
+    describe "representable_collection :name, :as => Band" do
       class Band
         include Representable::JSON
         representable_property :name
@@ -107,7 +140,7 @@ module JsonTest
       
       class Compilation
         include Representable::JSON
-        representable_property :bands, :as => [Band]
+        representable_collection :bands, :as => Band
       end
       
       describe "#from_json" do
@@ -131,5 +164,25 @@ module JsonTest
         assert_equal '{"compilation":{"bands":[{"name":"Diesel Boy"},{"name":"Bad Religion"}]}}', cd.to_json
       end
     end
+    
+    
+    describe ":from => :songList" do
+      class Songs
+        include Representable::JSON
+        representable_collection :tracks, :from => :songList
+      end
+      
+      it "respects :from in #from_json" do
+        songs = Songs.from_json({:songs => {:songList => ["Out in the cold", "Microphone"]}}.to_json)
+        assert_equal ["Out in the cold", "Microphone"], songs.tracks
+      end
+    
+      it "respects option in #to_json" do
+        songs = Songs.new
+        songs.tracks = ["Out in the cold", "Microphone"]
+        
+        assert_equal '{"songs":{"songList":["Out in the cold","Microphone"]}}', songs.to_json
+      end
+    end
   end
 end

data/test/representable_test.rb

@@ -24,12 +24,27 @@ class RepresentableTest < MiniTest::Spec
     end
   end
   
+  
+  
   describe "#representable_property" do
     it "creates accessors for the attribute" do
       @band = PunkBand.new
       assert @band.name = "Bad Religion"
       assert_equal "Bad Religion", @band.name
     end
+    
+    describe ":from" do
+      # TODO: do this with all options.
+      it "can be set explicitly" do
+        band = Class.new(Band) { representable_property :friends, :from => :friend }
+        assert_equal "friend", band.representable_attrs.last.from
+      end
+      
+      it "is infered from the name implicitly" do
+        band = Class.new(Band) { representable_property :friends }
+        assert_equal "friends", band.representable_attrs.last.from
+      end
+    end
   end
   
   describe "#representable_collection" do

data/test/xml_test.rb

@@ -125,18 +125,13 @@ class CollectionTest < MiniTest::Spec
   describe ":as => [Band], :tag => :band" do
     class Compilation
       include Representable::XML
-      representable_collection :bands, :as => Band, :tag => :band
+      representable_collection :bands, :as => Band, :from => :band
     end
     
     describe "#representable_collection" do
       it "declares a collection" do
         assert Compilation.representable_attrs.first.array?
       end
-      
-      it "accepts :tag" do
-        assert_equal "band", Compilation.representable_attrs.first.name
-      end
-      
     end
     
     
@@ -175,7 +170,7 @@ class CollectionTest < MiniTest::Spec
   describe ":as => []" do
     class Album
       include Representable::XML
-      representable_collection :songs, :tag => :song
+      representable_collection :songs, :from => :song
     end
 
     it "collects untyped items" do

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 9
   - 0
-  - 2
-  version: 0.0.2
+  version: 0.9.0
 platform: ruby
 authors: 
 - Nick Sutterer
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-03 00:00:00 +02:00
+date: 2011-10-05 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: hooks
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -31,7 +31,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: hooks
+  name: nokogiri
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -44,7 +44,7 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: nokogiri
+  name: json
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -57,7 +57,7 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: i18n
+  name: rake
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -67,10 +67,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
+  type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: rspec
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -80,10 +80,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
+  type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: test_xml
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
@@ -95,19 +95,6 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: test_xml
-  prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id007
 description: Maps representation documents from and to Ruby objects. Includes XML and JSON support, plain properties and compositions.
 email: 
 - apotonick@gmail.com
@@ -121,6 +108,7 @@ files:
 - .gitignore
 - .gitmodules
 - .rspec
+- CHANGES.textile
 - Gemfile
 - LICENSE
 - README.rdoc