representable 3.0.3 → 3.0.4

data/test/xml_namespace_test.rb

@@ -0,0 +1,186 @@
+require "test_helper"
+
+# <lib:library
+#    xmlns:lib="http://eric.van-der-vlist.com/ns/library"
+#    xmlns:hr="http://eric.van-der-vlist.com/ns/person">
+#   <lib:book id="b0836217462" available="true">
+#    <lib:isbn>0836217462</lib:isbn>
+#    <lib:title xml:lang="en">Being a Dog Is a Full-Time Job</lib:title>
+#    <hr:author id="CMS">
+#     <hr:name>Charles M Schulz</hr:name>
+#     <hr:born>1922-11-26</hr:born>
+#     <hr:dead>2000-02-12</hr:dead>
+#    </hr:author>
+#    <lib:character id="PP">
+#     <hr:name>Peppermint Patty</hr:name>
+#     <hr:born>1966-08-22</hr:born>
+#     <lib:qualification>bold, brash and tomboyish</lib:qualification>
+#     </lib:character>
+#    <lib:character id="Snoopy">
+#     <hr:name>Snoopy</hr:name>
+#     <hr:born>1950-10-04</hr:born>
+#     <lib:qualification>extroverted beagle</lib:qualification>
+#    </lib:character>
+#    <lib:character id="Schroeder">
+#     <hr:name>Schroeder</hr:name>
+#     <hr:born>1951-05-30</hr:born>
+#     <lib:qualification>brought classical music to the Peanuts strip
+#                   </lib:qualification>
+#    </lib:character>
+#    <lib:character id="Lucy">
+#     <hr:name>Lucy</hr:name>
+#     <hr:born>1952-03-03</hr:born>
+#     <lib:qualification>bossy, crabby and selfish</lib:qualification>
+#    </lib:character>
+#   </lib:book>
+#  </lib:library>
+
+  # Theoretically, every property (scalar) needs/should have a namespace.
+  # property :name, namespace: "http://eric.van-der-vlist.com/ns/person"
+  # # This is implicit if contained:
+  # class Person < Decorator
+  #   namespace: "http://eric.van-der-vlist.com/ns/person"
+  #   property :name #, namespace: "http://eric.van-der-vlist.com/ns/person"
+  # end
+  # class Library
+  #   namespace "http://eric.van-der-vlist.com/ns/library"
+
+  #   namespace_def lib:    "http://eric.van-der-vlist.com/ns/library"
+  #   namespace_def person: "http://eric.van-der-vlist.com/ns/person"
+  #   # namespace_def person: Person
+
+  #   property :person, decorator: Person
+  # end
+class NamespaceXMLTest < Minitest::Spec
+  module Model
+    Library = Struct.new(:book)
+    Book = Struct.new(:id, :isbn)
+  end
+
+  let (:book) { Model::Book.new(1, 666) }
+
+  #:simple-class
+  class Library < Representable::Decorator
+    feature Representable::XML
+    feature Representable::XML::Namespace
+
+    namespace "http://eric.van-der-vlist.com/ns/library"
+
+    property :book do
+      namespace "http://eric.van-der-vlist.com/ns/library"
+
+      property :id,  attribute: true
+      property :isbn
+    end
+  end
+  #:simple-class end
+
+
+  # default namespace for library
+  it "what" do
+    Library.new(Model::Library.new(book)).to_xml.must_xml(
+
+    #:simple-xml
+    %{<library xmlns="http://eric.van-der-vlist.com/ns/library">
+      <book id="1">
+        <isbn>666</isbn>
+      </book>
+    </library>}
+    #:simple-xml end
+    )
+  end
+end
+
+class Namespace2XMLTest < Minitest::Spec
+  module Model
+    Library   = Struct.new(:book)
+    Book      = Struct.new(:id, :isbn, :author, :character)
+    Character = Struct.new(:name, :born, :qualification)
+  end
+
+  let (:book) { Model::Book.new(1, 666, Model::Character.new("Fowler"), [Model::Character.new("Frau Java", 1991, "typed")]) }
+
+  #:map-class
+  class Library < Representable::Decorator
+    feature Representable::XML
+    feature Representable::XML::Namespace
+
+    namespace "http://eric.van-der-vlist.com/ns/library"
+    namespace_def lib: "http://eric.van-der-vlist.com/ns/library"
+    namespace_def hr: "http://eric.van-der-vlist.com/ns/person"
+
+    property :book, class: Model::Book do
+      namespace "http://eric.van-der-vlist.com/ns/library"
+
+      property :id,  attribute: true
+      property :isbn
+
+      property :author, class: Model::Character do
+        namespace "http://eric.van-der-vlist.com/ns/person"
+
+        property :name
+        property :born
+      end
+
+      collection :character, class: Model::Character do
+        namespace "http://eric.van-der-vlist.com/ns/library"
+
+        property :qualification
+
+        property :name, namespace: "http://eric.van-der-vlist.com/ns/person"
+        property :born, namespace: "http://eric.van-der-vlist.com/ns/person"
+      end
+    end
+  end
+  #:map-class end
+
+  it "renders" do
+    Library.new(Model::Library.new(book)).to_xml.must_xml(
+#:map-xml
+%{<lib:library xmlns:lib=\"http://eric.van-der-vlist.com/ns/library\" xmlns:hr=\"http://eric.van-der-vlist.com/ns/person\">
+  <lib:book id=\"1\">
+    <lib:isbn>666</lib:isbn>
+    <hr:author>
+      <hr:name>Fowler</hr:name>
+    </hr:author>
+    <lib:character>
+      <lib:qualification>typed</lib:qualification>
+      <hr:name>Frau Java</hr:name>
+      <hr:born>1991</hr:born>
+    </lib:character>
+  </lib:book>
+</lib:library>}
+#:map-xml end
+    )
+  end
+
+  it "parses" do
+    lib  = Model::Library.new
+    #:parse-call
+    Library.new(lib).from_xml(%{<lib:library
+  xmlns:lib="http://eric.van-der-vlist.com/ns/library"
+  xmlns:hr="http://eric.van-der-vlist.com/ns/person">
+  <lib:book id="1">
+    <lib:isbn>666</lib:isbn>
+    <hr:author>
+      <hr:name>Fowler</hr:name>
+    </hr:author>
+    <lib:character>
+      <lib:qualification>typed</lib:qualification>
+      <hr:name>Frau Java</hr:name>
+      <bogus:name>Mr. Ruby</hr:name>
+      <name>Dr. Elixir</hr:name>
+      <hr:born>1991</hr:born>
+    </lib:character>
+  </lib:book>
+</lib:library>}
+    #:parse-call end
+    )
+
+    lib.book.inspect.must_equal %{#<struct Namespace2XMLTest::Model::Book id=\"1\", isbn=\"666\", author=#<struct Namespace2XMLTest::Model::Character name=\"Fowler\", born=nil, qualification=nil>, character=[#<struct Namespace2XMLTest::Model::Character name=\"Frau Java\", born=\"1991\", qualification=\"typed\">]>}
+
+    #:parse-res
+    lib.book.character[0].name #=> "Frau Java"
+    #:parse-res end
+  end
+end

data/test/xml_test.rb

@@ -10,14 +10,14 @@ class XmlPublicMethodsTest < Minitest::Spec
     property :name
   end
 
-  let (:data) { %{<data><id>1</id><name>Rancid</name></data>} }
+  let(:data) { %{<data><id>1</id><name>Rancid</name></data>} }
 
   it { BandRepresenter.new(Band.new).from_xml(data)[:id, :name].must_equal ["1", "Rancid"] }
   it { BandRepresenter.new(Band.new).parse(data)[:id, :name].must_equal ["1", "Rancid"] }
 
   #---
   # to_hash
-  let (:band) { Band.new("1", "Rancid") }
+  let(:band) { Band.new("1", "Rancid") }
 
   it { BandRepresenter.new(band).to_xml.must_equal_xml data }
   it { BandRepresenter.new(band).render.must_equal_xml data }
@@ -145,14 +145,12 @@ class XmlTest < MiniTest::Spec
       module SongRepresenter
         include Representable::XML
         property :name
-        representation_wrap = :song
       end
 
       module AlbumRepresenter
         include Representable::XML
         property :best_song, :class => Song, :extend => SongRepresenter
         collection :songs, :class => Song, :as => :song, :extend => SongRepresenter
-        representation_wrap = :album
       end
 
 
@@ -179,11 +177,11 @@ class XmlTest < MiniTest::Spec
           [Song.new("I Hate My Brain"), mr=Song.new("Mr. Charisma")], mr)
         @album.extend(AlbumRepresenter)
 
-        assert_xml_equal "<album>
+        @album.to_xml.must_equal_xml "<album>
   <song><name>Mr. Charisma</name></song>
   <song><name>I Hate My Brain</name></song>
   <song><name>Mr. Charisma</name></song>
-</album>", @album.to_xml
+</album>"
       end
 
       it "extends contained models when deserializing" do
@@ -316,32 +314,54 @@ class TypedPropertyTest < MiniTest::Spec
   end
 end
 
+# TODO: add parsing tests.
+class XMLPropertyTest < Minitest::Spec
+  Band = Struct.new(:name, :genre)
+  Manager = Struct.new(:managed)
 
-class CollectionTest < MiniTest::Spec
-  class Band
+  #---
+  #- :as with scalar
+  class BandRepresenter < Representable::Decorator
     include Representable::XML
-    property :name
-    attr_accessor :name
+    property :name, as: :theyCallUs
+    property :genre, attribute: true
+  end
 
-    def initialize(name=nil)
-      name and self.name = name
-    end
+  it { BandRepresenter.new(Band.new("Mute")).to_xml.must_equal_xml %{<band><theyCallUs>Mute</theyCallUs></band>} }
+
+  class ManagerRepresenter < Representable::Decorator
+    include Representable::XML
+    property :managed, as: :band, decorator: BandRepresenter
   end
 
+  #- :as with nested property
+  it { ManagerRepresenter.new(Manager.new(Band.new("Mute", "Punkrock"))).to_xml.must_equal_xml %{<manager><band genre="Punkrock"><theyCallUs>Mute</theyCallUs></band></manager>} }
+end
+
+
+class XMLCollectionTest < MiniTest::Spec
+  Band        = Struct.new(:name)
+  Compilation = Struct.new(:bands)
+
+  class BandRepresenter < Representable::Decorator
+    include Representable::XML
+    property :name
+  end
 
+  #---
+  #- :as, :decorator, :class
   describe ":class => Band, :as => :band, :collection => true" do
-    class Compilation
+    class CompilationRepresenter < Representable::Decorator
       include Representable::XML
-      collection :bands, :class => Band, :as => :band
-      attr_accessor :bands
+      collection :bands, class: Band, as: :group, decorator: BandRepresenter
     end
 
     describe "#from_xml" do
       it "pushes collection items to array" do
-        cd = Compilation.new.from_xml(%{
+        cd = CompilationRepresenter.new(Compilation.new).from_xml(%{
           <compilation>
-            <band><name>Diesel Boy</name></band>
-            <band><name>Cobra Skulls</name></band>
+            <group><name>Diesel Boy</name></group>
+            <group><name>Cobra Skulls</name></group>
           </compilation>
         })
         assert_equal ["Cobra Skulls", "Diesel Boy"], cd.bands.map(&:name).sort
@@ -349,13 +369,12 @@ class CollectionTest < MiniTest::Spec
     end
 
     it "responds to #to_xml" do
-      cd = Compilation.new
-      cd.bands = [Band.new("Diesel Boy"), Band.new("Bad Religion")]
+      cd = Compilation.new([Band.new("Diesel Boy"), Band.new("Bad Religion")])
 
-      assert_xml_equal %{<compilation>
-        <band><name>Diesel Boy</name></band>
-        <band><name>Bad Religion</name></band>
-      </compilation>}, cd.to_xml
+      CompilationRepresenter.new(cd).to_xml.must_equal_xml %{<compilation>
+        <group><name>Diesel Boy</name></group>
+        <group><name>Bad Religion</name></group>
+      </compilation>}
     end
   end
 
@@ -381,8 +400,8 @@ class CollectionTest < MiniTest::Spec
 
 
   describe ":wrap" do
-    let (:album) { Album.new.extend(xml_doc) }
-    let (:xml_doc) {
+    let(:album) { Album.new.extend(xml_doc) }
+    let(:xml_doc) {
       Module.new do
         include Representable::XML
         collection :songs, :as => :song, :wrap => :songs
@@ -428,7 +447,7 @@ class CollectionTest < MiniTest::Spec
       self.representation_wrap = :song
     end
 
-    let (:decorator) { rpr = representer; Class.new(Representable::Decorator) { include Representable::XML; include rpr } }
+    let(:decorator) { rpr = representer; Class.new(Representable::Decorator) { include Representable::XML; include rpr } }
 
     describe "XML::Collection" do
       describe "with contained objects" do
@@ -437,8 +456,8 @@ class CollectionTest < MiniTest::Spec
           self.representation_wrap= :songs
         end
 
-        let (:songs) { [Song.new("Days Go By"), Song.new("Can't Take Them All")] }
-        let (:xml_doc)   { "<songs><song><name>Days Go By</name></song><song><name>Can't Take Them All</name></song></songs>" }
+        let(:songs) { [Song.new("Days Go By"), Song.new("Can't Take Them All")] }
+        let(:xml_doc)   { "<songs><song><name>Days Go By</name></song><song><name>Can't Take Them All</name></song></songs>" }
 
         it "renders array" do
           songs.extend(representer).to_xml.must_equal_xml xml_doc
@@ -463,8 +482,8 @@ class CollectionTest < MiniTest::Spec
         self.representation_wrap= :songs
       end
 
-      let (:songs) { {"one" => "Graveyards", "two" => "Can't Take Them All"} }
-      let (:xml_doc)   { "<favs one=\"Graveyards\" two=\"Can't Take Them All\" />" }
+      let(:songs) { {"one" => "Graveyards", "two" => "Can't Take Them All"} }
+      let(:xml_doc)   { "<favs one=\"Graveyards\" two=\"Can't Take Them All\" />" }
 
       describe "#to_xml" do
         it "renders hash" do
@@ -512,7 +531,7 @@ class XmlHashTest < MiniTest::Spec
       hash :songs
     end
 
-    let (:doc) { "<open_struct><first>The Gargoyle</first><second>Bronx</second></open_struct>" }
+    let(:doc) { "<open_struct><first>The Gargoyle</first><second>Bronx</second></open_struct>" }
 
     # to_xml
     it { OpenStruct.new(songs: {"first" => "The Gargoyle", "second" => "Bronx"}).extend(representer).to_xml.must_equal_xml(doc) }
@@ -527,7 +546,7 @@ class XmlHashTest < MiniTest::Spec
       end
     end
 
-    let (:doc) { "<open_struct>
+    let(:doc) { "<open_struct>
   <open_struct>
     <title>The Gargoyle</title>
   </open_struct>

data/test/yaml_test.rb

@@ -9,7 +9,7 @@ class YamlPublicMethodsTest < Minitest::Spec
     property :name
   end
 
-  let (:data) { %{---
+  let(:data) { %{---
 id: 1
 name: Rancid
 } }
@@ -19,7 +19,7 @@ name: Rancid
 
   #---
   # to_yaml
-  let (:band) { Band.new("1", "Rancid") }
+  let(:band) { Band.new("1", "Rancid") }
 
   it { BandRepresenter.new(band).to_yaml.must_equal data }
   it { BandRepresenter.new(band).render.must_equal data }
@@ -29,7 +29,7 @@ class YamlTest < MiniTest::Spec
   def self.yaml_representer(&block)
     Module.new do
       include Representable::YAML
-      instance_exec &block
+      instance_exec(&block)
     end
   end
 
@@ -39,9 +39,9 @@ class YamlTest < MiniTest::Spec
 
 
   describe "property" do
-    let (:yaml) { yaml_representer do property :best_song end }
+    let(:yaml) { yaml_representer do property :best_song end }
 
-    let (:album) { Album.new.tap do |album|
+    let(:album) { Album.new.tap do |album|
       album.best_song = "Liar"
     end }
 
@@ -75,12 +75,12 @@ best_song: This Song Is Recycled
 
     describe "with :class and :extend" do
       yaml_song = yaml_representer do property :name end
-      let (:yaml_album) { Module.new do
+      let(:yaml_album) { Module.new do
         include Representable::YAML
         property :best_song, :extend => yaml_song, :class => Song
       end }
 
-      let (:album) { Album.new.tap do |album|
+      let(:album) { Album.new.tap do |album|
         album.best_song = Song.new("Liar")
       end }
 
@@ -107,9 +107,9 @@ best_song:
 
 
   describe "collection" do
-    let (:yaml) { yaml_representer do collection :songs end }
+    let(:yaml) { yaml_representer do collection :songs end }
 
-    let (:album) { Album.new.tap do |album|
+    let(:album) { Album.new.tap do |album|
       album.songs = ["Jackhammer", "Terrible Man"]
     end }
 
@@ -149,7 +149,7 @@ songs: [Off Key Melody, Sinking]").must_equal Album.new(["Off Key Melody", "Sink
 
 
     describe "with :class and :extend" do
-      let (:yaml_album) { Module.new do
+      let(:yaml_album) { Module.new do
         include Representable::YAML
         collection :songs, :class => Song do
           property :name
@@ -157,7 +157,7 @@ songs: [Off Key Melody, Sinking]").must_equal Album.new(["Off Key Melody", "Sink
         end
       end }
 
-      let (:album) { Album.new([Song.new("Liar", 1), Song.new("What I Know", 2)]) }
+      let(:album) { Album.new([Song.new("Liar", 1), Song.new("What I Know", 2)]) }
 
 
       describe "#to_yaml" do