representable 1.1.6 → 1.1.7

data/CHANGES.textile

@@ -1,3 +1,7 @@
+h2. 1.1.7
+
+* Added support for coercion using virtus. Note that this presently works on class level with inline representers, only.
+ 
 h2. 1.1.6
 
 * Added @:if@ option to @property@.

data/README.rdoc

@@ -13,8 +13,9 @@ This keeps your representation knowledge in one place when implementing REST ser
 == Features
 
 * Bidirectional - rendering and parsing
-* OOP documents
-* Support for JSON, XML and MessagePack
+* OOP access to documents
+* Support for JSON and XML
+* Coercion support with virtus[https://github.com/solnic/virtus.]
 
 
 == Example
@@ -52,7 +53,7 @@ Many people dislike including representers on class layer. You might also extend
 
   Hero.new.extend(HeroRepresenter)
 
-Alternatively, if you don't like modules (which you shouldn't),  declarations can be put into classes directly.
+Alternatively, if you don't like modules (which you shouldn't),  declarations can be put into classes directly. We call that inline representers.
 
   class Hero
     attr_accessor :forename, :surename
@@ -307,6 +308,25 @@ You can also map properties to tag attributes in representable.
 Naturally, this works for both ways.
 
 
+== Coercion
+
+If you fancy coercion when parsing a document you can use the Coercion module which uses virtus[https://github.com/solnic/virtus] for type conversion. Due to some virtus' nature this can be used on class layer with inline representers, only for now.
+
+Include virtus in your Gemfile, first.
+
+  gem 'virtus'
+  
+Use the +:type+ option to specify the conversion target. Note that +:default+ still works.
+
+  class Hero
+    include Representable::JSON
+    include Virtus
+    extend Representable::Coercion::ClassMethods
+      
+    property :born_at, :type => DateTime, :default => "May 12th, 2012"
+  end
+
+
 == More
 
 Instead of spreading knowledge about your representations about the entire framework, Representable keeps rendering and parsing representations in one single, testable asset. It is a new abstraction layer missing in many "RESTful" frameworks.

data/lib/representable.rb

@@ -199,17 +199,4 @@ private
        downcase
     end
   end
-  
-  
-  # Allows mapping formats to representer classes.
-  # DISCUSS: this module might be removed soon.
-  module Represents
-    def represents(format, options)
-      representer[format] = options[:with]
-    end
-    
-    def representer
-      @represents_map ||= {}
-    end
-  end
 end

data/lib/representable/coercion.rb

@@ -0,0 +1,18 @@
+require "virtus"
+
+module Representable::Coercion
+  def self.included(base)
+    base.class_eval do
+      include Virtus
+      extend ClassMethods
+    end
+  end
+  
+  module ClassMethods
+    def property(name, args={})
+       attribute(name, args[:type]) if args[:type] # FIXME (in virtus): undefined method `superclass' for VirtusCoercionTest::SongRepresenter:Module
+      super(name, args)
+    end
+  end
+  
+end

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "1.1.6"
+  VERSION = "1.1.7"
 end

data/representable.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "minitest", ">= 2.8.1"
   s.add_development_dependency "mocha"
   s.add_development_dependency "mongoid"
+  s.add_development_dependency "virtus"
 end

data/test/coercion_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+require 'representable/coercion'
+
+class VirtusCoercionTest < MiniTest::Spec
+  class Song  # note that we don't define accessors for the properties here.
+  end
+    
+  describe "Coercion with Virtus" do
+    #before do
+    #  module SongRepresenter
+    #    include Representable::JSON
+    #    include Representable::Coercion
+    #    property :composed_at, :type => DateTime 
+    #  end
+    #end
+   # 
+   # it "coerces properties in #from_json" do
+   #   song = Song.new.extend(SongRepresenter).from_json("{\"composed_at\":\"November 18th, 1983\"}")
+   #   assert_kind_of DateTime, song.composed_at
+   #   assert_equal "expected", song.composed_at
+   # end
+    class ImmigrantSong
+      include Representable::JSON
+      include Virtus
+      extend Representable::Coercion::ClassMethods
+      
+      property :composed_at, :type => DateTime, :default => "May 12th, 2012"
+    end
+    
+    it "coerces into the provided type" do
+      song = ImmigrantSong.new.from_json("{\"composed_at\":\"November 18th, 1983\"}")
+      assert_equal DateTime.parse("Fri, 18 Nov 1983 00:00:00 +0000"), song.composed_at
+    end
+    
+    it "respects the :default options" do
+      song = ImmigrantSong.new.from_json("{}")
+      assert_kind_of DateTime, song.composed_at
+      assert_equal DateTime.parse("Mon, 12 May 2012 00:00:00 +0000"), song.composed_at
+    end
+    
+  end
+end

data/test/representable_test.rb

@@ -340,19 +340,4 @@ class RepresentableTest < MiniTest::Spec
       end
     end
   end
-  
-  describe "Represents" do
-    before do
-      @class = Class.new do
-        extend Representable::Represents
-        represents :json, :with => :whatever
-        represents "application/order-json", :with => :special
-      end
-    end
-    
-    it "allows mapping formats to representers" do
-      assert_equal :whatever, @class.representer[:json]
-      assert_equal :special, @class.representer["application/order-json"]
-    end    
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: representable
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.1.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-20 00:00:00.000000000 Z
+date: 2012-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &80957240 !ruby/object:Gem::Requirement
+  requirement: &80366830 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *80957240
+  version_requirements: *80366830
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &80956630 !ruby/object:Gem::Requirement
+  requirement: &80366420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *80956630
+  version_requirements: *80366420
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &80956310 !ruby/object:Gem::Requirement
+  requirement: &80365840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *80956310
+  version_requirements: *80365840
 - !ruby/object:Gem::Dependency
   name: test_xml
-  requirement: &80956090 !ruby/object:Gem::Requirement
+  requirement: &80365210 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *80956090
+  version_requirements: *80365210
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &80955690 !ruby/object:Gem::Requirement
+  requirement: &80364570 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 2.8.1
   type: :development
   prerelease: false
-  version_requirements: *80955690
+  version_requirements: *80364570
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &80955390 !ruby/object:Gem::Requirement
+  requirement: &80364280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *80955390
+  version_requirements: *80364280
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &80955040 !ruby/object:Gem::Requirement
+  requirement: &80363910 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *80955040
+  version_requirements: *80363910
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: &80363490 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *80363490
 description: Maps representation documents from and to Ruby objects. Includes XML
   and JSON support, plain properties, collections and compositions.
 email:
@@ -108,6 +119,7 @@ files:
 - lib/representable/binding.rb
 - lib/representable/bindings/json_bindings.rb
 - lib/representable/bindings/xml_bindings.rb
+- lib/representable/coercion.rb
 - lib/representable/definition.rb
 - lib/representable/json.rb
 - lib/representable/json/collection.rb
@@ -117,6 +129,7 @@ files:
 - lib/representable/xml/collection.rb
 - lib/representable/xml/hash.rb
 - representable.gemspec
+- test/coercion_test.rb
 - test/definition_test.rb
 - test/json_bindings_test.rb
 - test/json_test.rb