representable 1.8.5 → 2.0.0.rc1

data/test/schema_test.rb

@@ -0,0 +1,123 @@
+require 'test_helper'
+
+# Include Inherit Module And Decorator Test
+class SchemaTest < MiniTest::Spec
+  module Genre
+    include Representable
+    property :genre
+  end
+
+  module LinkFeature
+    def self.included(base)
+      base.extend(Link)
+    end
+
+    module Link
+      def link
+      end
+    end
+  end
+
+
+  module Module
+    include Representable::Hash
+    feature LinkFeature
+
+    property :title
+    property :label do # extend: LabelModule
+      property :name
+      link # feature
+
+      property :location do
+        property :city
+        link # feature.
+      end
+    end
+
+    property :album, :extend => lambda { raise "don't manifest me!" } # this is not an inline decorator, don't manifest it.
+
+
+    include Genre # Schema::Included::included is called!
+  end
+
+
+  class WithLocationStreetRepresenter < Representable::Decorator
+    include Representable::Hash
+    feature LinkFeature
+
+    property :title
+    property :label do # extend: LabelModule
+      property :name
+      link # feature
+
+      property :location do
+        property :city
+        link # feature.
+      end
+    end
+  end
+
+  describe "3-level deep with features" do
+    let (:label) { OpenStruct.new(:name => "Epitaph", :location => OpenStruct.new(:city => "Sanfran", :name => "DON'T SHOW ME!")) }
+
+    # Module does correctly include features in inlines.
+    it { band.extend(Module).to_hash.must_equal({"label"=>{"name"=>"Epitaph", "location"=>{"city"=>"Sanfran"}}, "genre"=>"Punkrock"}) }
+
+    # Decorator does correctly include features in inlines.
+    it { Decorator.new(band).to_hash.must_equal({"label"=>{"name"=>"Epitaph", "location"=>{"city"=>"Sanfran"}}, "genre"=>"Punkrock"}) }
+  end
+
+
+
+  class Decorator < Representable::Decorator
+    feature Representable::Hash
+
+    include Module
+  end
+
+  # puts Decorator.representable_attrs[:definitions].inspect
+
+  let (:label) { OpenStruct.new(:name => "Fat Wreck", :city => "San Francisco", :employees => [OpenStruct.new(:name => "Mike")], :location => OpenStruct.new(:city => "Sanfran")) }
+  let (:band) { OpenStruct.new(:genre => "Punkrock", :label => label) }
+
+
+  # it { FlatlinersDecorator.new( OpenStruct.new(label: OpenStruct.new) ).
+  #   to_hash.must_equal({}) }
+  it do
+    Decorator.new(band).to_hash.must_equal({"genre"=>"Punkrock", "label"=>{"name"=>"Fat Wreck", "location"=>{"city"=>"Sanfran"}}})
+  end
+
+
+  class InheritDecorator < Representable::Decorator
+    include Representable::Hash
+
+    include Module
+
+    property :label, inherit: true do # decorator.rb:27:in `initialize': superclass must be a Class (Module given)
+      property :city
+
+      property :location, :inherit => true do
+        property :city
+      end
+    end
+  end
+
+  it do
+    InheritDecorator.new(band).to_hash.must_equal({"genre"=>"Punkrock", "label"=>{"name"=>"Fat Wreck", "city"=>"San Francisco", "location"=>{"city"=>"Sanfran"}}})
+  end
+
+
+
+  class InheritFromDecorator < InheritDecorator
+
+    property :label, inherit: true do
+      collection :employees do
+        property :name
+      end
+    end
+  end
+
+  it do
+    InheritFromDecorator.new(band).to_hash.must_equal({"genre"=>"Punkrock", "label"=>{"name"=>"Fat Wreck", "city"=>"San Francisco", "employees"=>[{"name"=>"Mike"}], "location"=>{"city"=>"Sanfran"}}})
+  end
+end

data/test/test_helper.rb

@@ -19,7 +19,7 @@ class Album
 end
 
 class Song
-  attr_accessor :name, :track
+  attr_accessor :name, :track # never change this, track rendered with Rails#to_json.
   def initialize(name=nil, track=nil)
     @name   = name
     @track  = track

data/test/xml_test.rb

@@ -34,40 +34,6 @@ class XmlTest < MiniTest::Spec
     end
 
 
-    describe ".from_xml" do
-      it "is delegated to #from_xml" do
-        block = lambda {|*args|}
-        @Band.any_instance.expects(:from_xml).with("<document>", "options") # FIXME: how to NOT expect block?
-        @Band.from_xml("<document>", "options", &block)
-      end
-
-      it "yields new object and options to block" do
-        @Band.class_eval { attr_accessor :new_name }
-        @band = @Band.from_xml("<band/>", :new_name => "Diesel Boy") do |band, options|
-          band.new_name= options[:new_name]
-        end
-        assert_equal "Diesel Boy", @band.new_name
-      end
-    end
-
-
-    describe ".from_node" do
-      it "is delegated to #from_node" do
-        block = lambda {|*args|}
-        @Band.any_instance.expects(:from_node).with("<document>", "options") # FIXME: how to expect block?
-        @Band.from_node("<document>", "options", &block)
-      end
-
-      it "yields new object and options to block" do
-        @Band.class_eval { attr_accessor :new_name }
-        @band = @Band.from_node(Nokogiri::XML("<band/>"), :new_name => "Diesel Boy") do |band, options|
-          band.new_name= options[:new_name]
-        end
-        assert_equal "Diesel Boy", @band.new_name
-      end
-    end
-
-
     describe "#from_xml" do
       before do
         @band = @Band.new
@@ -222,7 +188,7 @@ class AttributesTest < MiniTest::Spec
     end
 
     it "#from_xml creates correct accessors" do
-      link = Link.from_xml(%{
+      link = Link.new.from_xml(%{
         <a href="http://apotomo.de" title="Home, sweet home" />
       })
       assert_equal "http://apotomo.de", link.href
@@ -238,13 +204,29 @@ class AttributesTest < MiniTest::Spec
   end
 end
 
+
+class CDataBand
+  class CData < Representable::XML::PropertyBinding
+    def serialize_node(parent, value)
+      parent << Nokogiri::XML::CDATA.new(parent, represented.name)
+    end
+  end
+
+  include Representable::XML
+  property :name, :binding => lambda { |*args| CData.new(*args) }#getter: lambda { |opt| Nokogiri::XML::CDATA.new(opt[:doc], name) }
+  attr_accessor :name
+
+  def initialize(name=nil)
+    name and self.name = name
+  end
+end
+
 class TypedPropertyTest < MiniTest::Spec
   module AlbumRepresenter
     include Representable::XML
     property :band, :class => Band
   end
 
-
   class Album
     attr_accessor :band
     def initialize(band=nil)
@@ -288,6 +270,19 @@ class TypedPropertyTest < MiniTest::Spec
         assert_xml_equal %{<album><band>Baaaad Religion</band></album>}, Album.new(band).extend(AlbumRepresenter).to_xml
       end
     end
+
+    describe "#to_xml with CDATA" do
+      it "wraps Band name in CDATA#to_xml" do
+        band = CDataBand.new("Bad Religion")
+        album = Album.new(band).extend(AlbumRepresenter)
+
+        assert_xml_equal %{<album>
+         <c_data_band>
+           <name><![CDATA[Bad Religion]]></name>
+         </c_data_band>
+       </album>}, album.to_xml
+      end
+    end
   end
 end
 
@@ -302,7 +297,7 @@ class CollectionTest < MiniTest::Spec
 
     describe "#from_xml" do
       it "pushes collection items to array" do
-        cd = Compilation.from_xml(%{
+        cd = Compilation.new.from_xml(%{
           <compilation>
             <band><name>Diesel Boy</name></band>
             <band><name>Cobra Skulls</name></band>
@@ -390,9 +385,10 @@ class CollectionTest < MiniTest::Spec
     module SongRepresenter
       include Representable::XML
       property :name
+      self.representation_wrap = :song
     end
 
-    let (:decorator) { rpr = representer; Class.new(Representable::Decorator) { include rpr; self.representation_wrap= :songs } } # FIXME: why isn't representation wrap inherited properly?
+    let (:decorator) { rpr = representer; Class.new(Representable::Decorator) { include rpr } }
 
     describe "XML::Collection" do
       describe "with contained objects" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: representable
 version: !ruby/object:Gem::Version
-  version: 1.8.5
+  version: 2.0.0.rc1
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-11 00:00:00.000000000 Z
+date: 2014-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -42,16 +42,16 @@ dependencies:
   name: uber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.7
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -126,16 +126,16 @@ dependencies:
   name: virtus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -168,26 +168,30 @@ files:
 - TODO
 - lib/representable.rb
 - lib/representable/TODO.getting_serious
+- lib/representable/autoload.rb
 - lib/representable/binding.rb
 - lib/representable/bindings/hash_bindings.rb
 - lib/representable/bindings/xml_bindings.rb
 - lib/representable/bindings/yaml_bindings.rb
 - lib/representable/coercion.rb
 - lib/representable/config.rb
+- lib/representable/declarative.rb
 - lib/representable/decorator.rb
-- lib/representable/decorator/coercion.rb
 - lib/representable/definition.rb
 - lib/representable/deserializer.rb
+- lib/representable/for_collection.rb
 - lib/representable/hash.rb
 - lib/representable/hash/allow_symbols.rb
 - lib/representable/hash/collection.rb
 - lib/representable/hash_methods.rb
+- lib/representable/inheritable.rb
 - lib/representable/json.rb
 - lib/representable/json/collection.rb
 - lib/representable/json/hash.rb
 - lib/representable/mapper.rb
 - lib/representable/parse_strategies.rb
-- lib/representable/readable_writeable.rb
+- lib/representable/pipeline.rb
+- lib/representable/represent.rb
 - lib/representable/serializer.rb
 - lib/representable/version.rb
 - lib/representable/xml.rb
@@ -198,19 +202,23 @@ files:
 - test/as_test.rb
 - test/class_test.rb
 - test/coercion_test.rb
+- test/config/inherit_test.rb
 - test/config_test.rb
 - test/decorator_scope_test.rb
 - test/decorator_test.rb
 - test/definition_test.rb
 - test/example.rb
 - test/exec_context_test.rb
+- test/features_test.rb
+- test/filter_test.rb
+- test/for_collection_test.rb
 - test/generic_test.rb
 - test/getter_setter_test.rb
 - test/hash_bindings_test.rb
 - test/hash_test.rb
 - test/if_test.rb
 - test/inherit_test.rb
-- test/inheritance_test.rb
+- test/inheritable_test.rb
 - test/inline_test.rb
 - test/instance_test.rb
 - test/is_representable_test.rb
@@ -222,7 +230,9 @@ files:
 - test/pass_options_test.rb
 - test/prepare_test.rb
 - test/reader_writer_test.rb
+- test/represent_test.rb
 - test/representable_test.rb
+- test/schema_test.rb
 - test/serialize_deserialize_test.rb
 - test/stringify_hash_test.rb
 - test/test_helper.rb
@@ -245,9 +255,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2

data/lib/representable/decorator/coercion.rb

@@ -1,4 +0,0 @@
-require 'representable/coercion'
-
-# TODO: deprecate for 1.7.
-Representable::Decorator::Coercion = Representable::Coercion

data/lib/representable/readable_writeable.rb

@@ -1,29 +0,0 @@
-module Representable
-  module ReadableWriteable
-    def deserialize_property(binding, doc, options)
-      return unless binding.writeable?
-      super
-    end
-
-    def serialize_property(binding, doc, options)
-      return unless binding.readable?
-      super
-    end
-  end
-
-
-  # TODO: i hate monkey-patching Definition here since it globally adds this options. However, for now this should be ok :-)
-  Definition.class_eval do
-    # Checks and returns if the property is writeable
-    def writeable?
-      return self[:writeable] if self.has_key?(:writeable)
-      true
-    end
-
-    # Checks and returns if the property is readable
-    def readable?
-      return self[:readable] if self.has_key?(:readable)
-      true
-    end
-  end
-end

data/test/inheritance_test.rb

@@ -1,22 +0,0 @@
-require 'test_helper'
-
-class InheritanceTest < MiniTest::Spec
-  let (:decorator) do
-    Class.new(Representable::Decorator) do
-      property :title
-    end
-  end
-
-  # Decorator.new.representable_attrs != Decorator.representable_attrs
-  it "doesn't clone for instantiated decorator" do
-    instance = decorator.new(Object.new)
-    instance.send(:representable_attrs).first.merge!(:instance => true)
-
-    # we didn't clone and thereby change the original config:
-    instance.send(:representable_attrs).to_s.must_equal decorator.representable_attrs.to_s
-  end
-
-  # TODO:  ? (performance?)
-  #  more tests on cloning
-  #
-end