representable 0.10.1 → 0.10.2

data/CHANGES.textile

@@ -1,3 +1,9 @@
+h2. 0.10.2
+
+* Added `representable_property :accessors => false` option to suppress adding accessors.
+* @Representable.representation_wrap@ is no longer inherited.
+* Representers can now be defined in modules. They inherit to including modules.
+
 h2. 0.10.1
 
 * The block in @to_*@ and @from_*@ now yields the symbolized property name. If you need the binding/definition you gotta get it yourself.

data/README.rdoc

@@ -37,6 +37,22 @@ Since you keep forgetting the heroes of your childhood you decide to implement a
 
 This declares two simple properties. Representable will automatically add accessors to the class.
 
+If you don't want declarations in your models, use a module.
+
+  module HeroRepresentation
+    include Representable
+    
+    representable_property :forename
+    representable_property :surename
+  end
+
+This module needs a host class to be used with.
+
+  class Hero
+    include Representable::JSON
+    include HeroRepresentation
+  end
+
 == Rendering
 
 Now let's create and render our first hero.

data/lib/representable.rb

@@ -1,4 +1,3 @@
-require 'hooks/inheritable_attribute'
 require 'representable/definition'
 
 module Representable
@@ -7,11 +6,9 @@ module Representable
       extend ClassMethods::Declarations
       extend ClassMethods::Accessors
       
-      extend Hooks::InheritableAttribute
-      inheritable_attr :representable_attrs
-      self.representable_attrs = []
-      
-      inheritable_attr :representable_wrap
+      def self.included(base)
+        base.representable_attrs.push(*representable_attrs) # "inherit".
+      end
     end
   end
   
@@ -64,10 +61,12 @@ private
       #   representable_property :name
       #   representable_property :name, :from => :title
       #   representable_property :name, :as => Name
-      def representable_property(*args)
-        attr = add_representable_property(*args)
-        attr_reader(attr.getter)
-        attr_writer(attr.getter)
+      #   representable_property :name, :accessors => false
+      def representable_property(name, options={})
+        attr = add_representable_property(name, options)
+        
+        attr_reader(attr.getter) unless options[:accessors] == false
+        attr_writer(attr.getter) unless options[:accessors] == false
       end
       
       # Declares a represented document node collection.
@@ -91,6 +90,18 @@ private
     end
 
     module Accessors
+      def representable_attrs
+        @representable_attrs ||= []
+      end
+      
+      def representable_wrap
+        @representable_wrap ||= false
+      end
+      
+      def representable_wrap=(name)
+        @representable_wrap = name
+      end
+      
       def representation_wrap=(name)
         self.representable_wrap = name
       end

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "0.10.1"
+  VERSION = "0.10.2"
 end

data/representable.gemspec

@@ -11,15 +11,14 @@ Gem::Specification.new do |s|
   s.authors     = ["Nick Sutterer"]
   s.email       = ["apotonick@gmail.com"]
   s.homepage    = "http://representable.apotomo.de"
-  s.summary     = %q{Maps representation documents from and to Ruby objects. Includes XML and JSON support, plain properties and compositions.}
-  s.description = %q{Maps representation documents from and to Ruby objects. Includes XML and JSON support, plain properties and compositions.}
+  s.summary     = %q{Maps representation documents from and to Ruby objects. Includes XML and JSON support, plain properties, collections and compositions.}
+  s.description = %q{Maps representation documents from and to Ruby objects. Includes XML and JSON support, plain properties, collections and compositions.}
   
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   
-  s.add_dependency "hooks"
   s.add_dependency "nokogiri"
   s.add_dependency "json"
   

data/test/representable_test.rb

@@ -10,6 +10,19 @@ class RepresentableTest < MiniTest::Spec
     representable_property :street_cred
   end
   
+  module BandRepresentation
+    include Representable
+    
+    representable_property :name
+  end
+  
+  module PunkBandRepresentation
+    include Representable
+    include BandRepresentation
+    
+    representable_property :street_cred
+  end
+  
   
   describe "#representable_attrs" do
     it "responds to #representable_attrs" do
@@ -17,10 +30,40 @@ class RepresentableTest < MiniTest::Spec
       assert_equal "name", Band.representable_attrs.first.name
     end
     
-    it "inherits correctly" do
-      assert_equal 2, PunkBand.representable_attrs.size
-      assert_equal "name", PunkBand.representable_attrs.first.name
-      assert_equal "street_cred", PunkBand.representable_attrs.last.name
+    describe "in module" do
+      it "returns definitions" do
+        assert_equal 1, BandRepresentation.representable_attrs.size
+        assert_equal "name", BandRepresentation.representable_attrs.first.name
+      end
+      
+      it "inherits to including modules" do
+        assert_equal 2,  PunkBandRepresentation.representable_attrs.size
+        assert_equal "name", PunkBandRepresentation.representable_attrs.first.name
+        assert_equal "street_cred", PunkBandRepresentation.representable_attrs.last.name
+      end
+      
+      it "inherits to including class" do
+        band = Class.new do
+          include Representable
+          include PunkBandRepresentation
+        end
+        
+        assert_equal 2,  band.representable_attrs.size
+        assert_equal "name", band.representable_attrs.first.name
+        assert_equal "street_cred", band.representable_attrs.last.name
+      end
+      
+      it "allows including the concrete representer module later" do
+        require 'representable/json'
+        vd = class VD
+          include Representable::JSON
+          include PunkBandRepresentation
+        end.new
+        vd.name        = "Vention Dention"
+        vd.street_cred = 1
+        assert_equal "{\"name\":\"Vention Dention\",\"street_cred\":1}", vd.to_json
+      end
+      
     end
   end
   
@@ -44,6 +87,15 @@ class RepresentableTest < MiniTest::Spec
         assert_equal "friends", band.representable_attrs.last.from
       end
     end
+    
+    describe ":accessor" do
+      it "doesn't add methods when false" do
+        klass = Class.new(Band) { representable_property :friends, :accessors => false }
+        band = klass.new
+        assert ! band.respond_to?(:friends)
+        assert ! band.respond_to?("friends=")
+      end
+    end
   end
   
   describe "#representable_collection" do
@@ -74,7 +126,6 @@ class RepresentableTest < MiniTest::Spec
       assert_equal nil, SoundSystem.representation_wrap
     end
     
-    
     it "infers a printable class name if set to true" do
       HardcoreBand.representation_wrap = true
       assert_equal "hardcore_band", HardcoreBand.send(:representation_wrap)
@@ -85,9 +136,9 @@ class RepresentableTest < MiniTest::Spec
       assert_equal "breach", HardcoreBand.representation_wrap
     end
     
-    it "inherits correctly" do
+    it "doesn't inherit correctly" do
       HardcoreBand.representation_wrap = "breach"
-      assert_equal "breach", SoftcoreBand.representation_wrap
+      assert_equal nil, SoftcoreBand.representation_wrap
     end
   end
   

data/test/xml_test.rb

@@ -125,7 +125,11 @@ class XmlTest < MiniTest::Spec
       end
       
       it "respects #representation_wrap=" do
-        klass = Class.new(Band)
+        klass = Class.new(Band) do
+          include Representable
+          representable_property :name
+        end
+        
         klass.representation_wrap = :group
         assert_xml_equal "<group><name>Rise Against</name></group>", klass.new("Rise Against").to_node.to_s
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: representable
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-01 00:00:00.000000000Z
+date: 2011-12-03 00:00:00.000000000Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: hooks
-  requirement: &72137670 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: *72137670
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &72137450 !ruby/object:Gem::Requirement
+  requirement: &75503660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *72137450
+  version_requirements: *75503660
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &72137230 !ruby/object:Gem::Requirement
+  requirement: &75503430 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *72137230
+  version_requirements: *75503430
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &72137010 !ruby/object:Gem::Requirement
+  requirement: &75503180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *72137010
+  version_requirements: *75503180
 - !ruby/object:Gem::Dependency
   name: test_xml
-  requirement: &72136800 !ruby/object:Gem::Requirement
+  requirement: &75502870 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *72136800
+  version_requirements: *75502870
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &72136530 !ruby/object:Gem::Requirement
+  requirement: &75502410 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +65,10 @@ dependencies:
         version: '2.8'
   type: :development
   prerelease: false
-  version_requirements: *72136530
+  version_requirements: *75502410
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &72136320 !ruby/object:Gem::Requirement
+  requirement: &75501950 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,9 +76,9 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *72136320
+  version_requirements: *75501950
 description: Maps representation documents from and to Ruby objects. Includes XML
-  and JSON support, plain properties and compositions.
+  and JSON support, plain properties, collections and compositions.
 email:
 - apotonick@gmail.com
 executables: []
@@ -143,5 +132,5 @@ rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Maps representation documents from and to Ruby objects. Includes XML and
-  JSON support, plain properties and compositions.
+  JSON support, plain properties, collections and compositions.
 test_files: []