representable 0.12.0 → 0.13.0

data/CHANGES.textile

@@ -1,8 +1,11 @@
+h2. 0.13.0
+
+* We no longer create accessors in @Representable.property@ - you have to do this yourself using @attr_accessors@.
+
 h2. 0.12.0
 
 * @:as@ is now @:class@.
 
-
 h2. 0.11.0
 
 * Representer modules can now be injected into objects using @#extend@.

data/README.rdoc

@@ -37,11 +37,13 @@ Representations are usually defined using a module. This makes them super flexib
     property :surename
   end
 
-By using #property we declare two simple attributes. Representable will automatically add accessors to the module.
+By using #property we declare two simple attributes that should be considered when representing.
 
-To use your representer include it in the matching class. Note that you could reuse a representer in multiple classes. 
+To use your representer include it in the matching class. Note that you could reuse a representer in multiple classes. The represented class must have getter and setter methods for each property.
 
   class Hero
+    attr_accessor :forename, :surename
+  	
   	include Representable
     include HeroRepresenter
   end
@@ -53,6 +55,8 @@ Many people dislike including representers on class layer. You might also extend
 Alternatively, if you don't like modules (which you shouldn't),  declarations can be put into classes directly.
 
   class Hero
+    attr_accessor :forename, :surename
+  	
     include Representable::JSON
     
     property :forename
@@ -87,6 +91,8 @@ See how easy this is? You can use an object-oriented method to read from the doc
 You need a second domain object. Every hero has a place it comes from.
 
   class Location
+    attr_accessor :title
+  	
     include Representable::JSON
     
     property :title
@@ -254,7 +260,7 @@ Representable was written with REST representations in mind. However, it is a ge
 
 == Copyright
 
-Representable is a heavily simplified fork of the ROXML gem. Big thanks to Ben Woosley for his work.
+Representable is a heavily simplified fork of the ROXML gem. Big thanks to Ben Woosley for his inspiring work.
 
 * Copyright (c) 2011 Nick Sutterer <apotonick@gmail.com>
-* Copyright (c) 2004-2009 Ben Woosley, Zak Mandhro and Anders Engstrom.
+* ROXML is Copyright (c) 2004-2009 Ben Woosley, Zak Mandhro and Anders Engstrom.

data/lib/representable.rb

@@ -85,13 +85,9 @@ private
       #   property :name
       #   property :name, :from => :title
       #   property :name, :class => Name
-      #   property :name, :accessors => false
       #   property :name, :default => "Mike"
       def property(name, options={})
-        attr = add_property(name, options)
-        
-        attr_reader(attr.getter) unless options[:accessors] == false
-        attr_writer(attr.getter) unless options[:accessors] == false
+        representable_attrs << definition_class.new(name, options)
       end
       
       # Declares a represented document node collection.
@@ -105,13 +101,6 @@ private
         options[:collection] = true
         property(name, options)
       end
-      
-    private
-      def add_property(*args)
-        definition_class.new(*args).tap do |attr|
-          representable_attrs << attr
-        end
-      end
     end
     
     

data/lib/representable/definition.rb

@@ -8,7 +8,7 @@ module Representable
       @name               = sym.to_s
       @array              = options[:collection]
       @from               = (options[:from] || name).to_s
-      @sought_type        = options[:class] || options[:class] || :text  # TODO: deprecate :class in 1.0.
+      @sought_type        = options[:class] || options[:as] || :text  # TODO: deprecate :as in 1.0.
       @default            = options[:default]
       @default            ||= [] if array?
       @representer_module = options[:extend]  # DISCUSS: move to Representable::DCI?

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "0.12.0"
+  VERSION = "0.13.0"
 end

data/test/json_test.rb

@@ -12,6 +12,7 @@ module JsonTest
           include Representable::JSON
           property :name
           property :label
+          attr_accessor :name, :label
           
           def initialize(name=nil)
             self.name = name if name
@@ -167,6 +168,9 @@ module JsonTest
         civ = Object.new
         civ.instance_eval do
           def name; "CIV"; end
+          def name=(v)
+            @name = v
+          end
         end
         
         civ.extend(BandRepresenter)
@@ -196,6 +200,7 @@ module JsonTest
       class Band
         include Representable::JSON
         property :name
+        attr_accessor :name
       end
       
       it "#from_json creates correct accessors" do
@@ -215,11 +220,13 @@ module JsonTest
       class Label
         include Representable::JSON
         property :name
+        attr_accessor :name
       end
       
       class Album
         include Representable::JSON
         property :label, :class => Label
+        attr_accessor :label
       end
       
       it "#from_json creates one Item instance" do
@@ -239,6 +246,7 @@ module JsonTest
           @Album = Class.new do
             include Representable::JSON
             property :seller, :class => Label
+            attr_accessor :seller
           end
         end
         
@@ -255,6 +263,7 @@ module JsonTest
       class Song
         include Representable::JSON
         property :name, :from => :songName
+        attr_accessor :name
       end
       
       it "respects :from in #from_json" do
@@ -273,6 +282,7 @@ module JsonTest
         @Album = Class.new do
         include Representable::JSON
         property :name, :default => "30 Years Live"
+        attr_accessor :name
       end
     end
       
@@ -319,6 +329,7 @@ end
       class CD
         include Representable::JSON
         collection :songs
+        attr_accessor :songs
       end
       
       it "#from_json creates correct accessors" do
@@ -338,6 +349,7 @@ end
       class Band
         include Representable::JSON
         property :name
+        attr_accessor :name
         
         def initialize(name="")
           self.name = name
@@ -347,6 +359,7 @@ end
       class Compilation
         include Representable::JSON
         collection :bands, :class => Band
+        attr_accessor :bands
       end
       
       describe "#from_json" do
@@ -376,6 +389,7 @@ end
       class Songs
         include Representable::JSON
         collection :tracks, :from => :songList
+        attr_accessor :tracks
       end
       
       it "respects :from in #from_json" do

data/test/representable_test.rb

@@ -4,10 +4,12 @@ class RepresentableTest < MiniTest::Spec
   class Band
     include Representable
     property :name
+    attr_accessor :name
   end
   
   class PunkBand < Band
     property :street_cred
+    attr_accessor :street_cred
   end
   
   module BandRepresentation
@@ -56,6 +58,7 @@ class RepresentableTest < MiniTest::Spec
       it "allows including the concrete representer module later" do
         require 'representable/json'
         vd = class VD
+          attr_accessor :name, :street_cred
           include Representable::JSON
           include PunkBandRepresentation
         end.new
@@ -80,6 +83,45 @@ class RepresentableTest < MiniTest::Spec
   end
   
   
+  describe "Representable" do
+    it "allows mixing in multiple representers" do
+      require 'representable/json'
+      require 'representable/xml'
+      class Bodyjar
+        include Representable::XML
+        include Representable::JSON
+        include PunkBandRepresentation
+        
+        self.representation_wrap = "band"
+        attr_accessor :name, :street_cred
+      end
+      
+      band = Bodyjar.new
+      band.name = "Bodyjar"
+      
+      assert_equal "{\"band\":{\"name\":\"Bodyjar\"}}", band.to_json
+      #assert_equal "{\"name\":\"Bodyjar\"}", band.to_xml # FIXME: now, #binding_for_definition returns wrong binding.
+    end
+    
+    it "allows extending with different representers subsequentially" do
+      module SongXmlRepresenter
+        include Representable::XML
+        property :name, :from => "@name"
+      end
+      
+      module SongJsonRepresenter
+        include Representable::JSON
+        property :name
+      end
+      
+      @song = Song.new("Days Go By")
+      assert_xml_equal "<song name=\"Days Go By\"/>", @song.extend(SongXmlRepresenter).to_xml
+      assert_equal "{\"name\":\"Days Go By\"}", @song.extend(SongJsonRepresenter).to_json
+    end
+  end
+  
+  
+  
   describe "#property" do
     it "creates accessors for the attribute" do
       @band = PunkBand.new
@@ -163,6 +205,7 @@ class RepresentableTest < MiniTest::Spec
     include Representable::JSON
     property :name
     property :groupies
+    attr_accessor :name, :groupies
   end
 
   describe "#update_properties_from" do

data/test/test_helper.rb

@@ -10,6 +10,7 @@ require 'test_xml/mini_test'
 require 'mocha'
 
 class Album
+  attr_accessor :songs, :best_song
   def initialize(*songs)
     @songs      = songs
     @best_song  = songs.last
@@ -17,6 +18,7 @@ class Album
 end
 
 class Song
+  attr_accessor :name
   def initialize(name=nil)
     @name = name
   end

data/test/xml_test.rb

@@ -4,6 +4,7 @@ require 'representable/xml'
 class Band
   include Representable::XML
   property :name
+  attr_accessor :name
   
   def initialize(name=nil)
     name and self.name = name
@@ -24,6 +25,7 @@ class XmlTest < MiniTest::Spec
         self.representation_wrap = :band
         property :name
         property :label
+        attr_accessor :name, :label
       end
       
       @band = @Band.new
@@ -159,6 +161,9 @@ class XmlTest < MiniTest::Spec
         civ = Object.new
         civ.instance_eval do
           def name; "CIV"; end
+          def name=(v)
+            @name = v
+          end
         end
         
         civ.extend(BandRepresenter)
@@ -194,6 +199,7 @@ class AttributesTest < MiniTest::Spec
       include Representable::XML
       property :href,   :from => "@href"
       property :title,  :from => "@title"
+      attr_accessor :href, :title
     end
     
     it "#from_xml creates correct accessors" do
@@ -221,6 +227,7 @@ class TypedPropertyTest < MiniTest::Spec
   
   
   class Album
+    attr_accessor :band
     def initialize(band=nil)
       @band = band
     end
@@ -271,6 +278,7 @@ class CollectionTest < MiniTest::Spec
     class Compilation
       include Representable::XML
       collection :bands, :class => Band, :from => :band
+      attr_accessor :bands
     end
     
     describe "#from_xml" do
@@ -309,6 +317,7 @@ class CollectionTest < MiniTest::Spec
     class Album
       include Representable::XML
       collection :songs, :from => :song
+      attr_accessor :songs
     end
 
     it "collects untyped items" do

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 12
+  - 13
   - 0
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors: 
 - Nick Sutterer
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-19 00:00:00 +01:00
+date: 2011-12-24 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency