representable 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 783116ac1174ef6a0aa6eaf44c768bfe3786dec0
-  data.tar.gz: bc85eaa1d218cd5c54161a607d80d6d3539937cf
+  metadata.gz: d4c1cc5843478c8c3c889dabd023eca71e622da8
+  data.tar.gz: c8b2850a2418de5d94dbc1024f5d84c93a979976
 SHA512:
-  metadata.gz: 347783301a5545df8e009130eb741970d5635796368c3aae726f52e21f0357daefbfa367e7296b053aa14c8357ac1dcdff95b2cca828bfe2bf3f79fc34defe86
-  data.tar.gz: ff5d1a1825af70bee387b09ee7f997718744e7a69b66f80fb379dbbd726e1640aec81888dd651cbfa6c78c218342bfc2a5305f1bf741972a677037e3d6176894
+  metadata.gz: 8447a73176a4dfd5cc11d7767721e083757e2c9eeeb9e0bde32d73b17fea141fd6954ca05ce45f9e88c8393d9341981cce7b4e5fc4836f7eaed39d05a0890bc8
+  data.tar.gz: a4175164b4f3eb64db40630b7d9fcc4e1574cc075268f87e6cdafbe2a8648861a07f0302fbbc54431ac6bb5934b4c3f12e704a3459a4b3c134acf029ff794496

data/CHANGES.md

@@ -1,3 +1,28 @@
+# 2.1.1
+
+* Added `Definition#delete!` to remove options.
+* Added `Representable::apply` do iterate and change schemas.
+* Added `Config.remove` to remove properties.
+* Added `Representable::Debug` which just has to be included into your represented object.
+
+    ```ruby
+    song.extend(SongRepresenter).extend(Representable::Debug).from_json("..")
+    song.extend(SongRepresenter).extend(Representable::Debug).to_json("..")
+    ```
+
+    It can also be included statically into your representer or decorator.
+
+    ```ruby
+    class SongRepresenter < Representable::Decorator
+      include Representable::JSON
+      include Representable::Debug
+
+      property :title
+    end
+    ```
+
+    It is great.
+
 # 2.1.0
 
 ## Breaking Changes

data/lib/representable.rb

@@ -7,6 +7,7 @@ require 'representable/mapper'
 require 'representable/for_collection'
 require 'representable/represent'
 require 'representable/declarative'
+require 'representable/apply'
 
 
 require 'uber/callable'
@@ -23,6 +24,7 @@ module Representable
       extend Feature
       extend ForCollection
       extend Represent
+      extend Apply
       # register_feature Representable # Representable gets included automatically when creating inline representer.
     end
   end

data/lib/representable/apply.rb

@@ -0,0 +1,13 @@
+module Representable
+  module Apply
+    # Iterates over all property/collection definitions and yields the Definition instance.
+    def apply(&block)
+      representable_attrs.each do |dfn|
+        block.call(dfn)
+        dfn.representer_module.extend(Apply).apply(&block) if dfn.representer_module # nested.
+      end
+
+      self
+    end
+  end
+end

data/lib/representable/binding.rb

@@ -28,7 +28,7 @@ module Representable
     attr_reader :user_options, :represented # TODO: make private/remove.
 
     def as # DISCUSS: private?
-      evaluate_option(:as)
+      @as ||= evaluate_option(:as)
     end
 
     # Retrieve value and write fragment to the doc.

data/lib/representable/config.rb

@@ -39,6 +39,10 @@ module Representable
         self[name.to_s]
       end
 
+      def remove(name)
+        delete(name.to_s)
+      end
+
       extend Forwardable
       def_delegators :values, :each # so we look like an array. this is only used in Mapper. we could change that so we don't need to hide the hash.
 
@@ -63,7 +67,7 @@ module Representable
 
     # delegate #collect etc to Definitions instance.
     extend Forwardable
-    def_delegators :@definitions, :get, :add, :each, :size
+    def_delegators :@definitions, :get, :add, :each, :size, :remove
     # #collect comes from Hash and then gets delegated to @definitions. don't like that.
 
     def wrap=(value)

data/lib/representable/debug.rb

@@ -0,0 +1,95 @@
+module Representable
+  module Debug
+    def self.extended(represented)
+      represented.extend Representable
+    end
+
+    module Representable
+      def update_properties_from(doc, options, format)
+        puts
+        puts "[Deserialize]........."
+        puts "[Deserialize] document #{doc.inspect}"
+        super
+      end
+
+      def create_representation_with(doc, options, format)
+        puts
+        puts "[Serialize]........."
+        puts "[Serialize]"
+        super
+      end
+
+      def representable_mapper(*args)
+        super.extend(Mapper)
+      end
+    end
+
+    module Binding
+      def read(doc)
+        value = super
+        puts "                #read --> #{value.inspect}"
+        value
+      end
+
+      def evaluate_option(name, *args, &block)
+        puts "=====#{self[name]}" if name ==:prepare
+        puts (evaled = self[name]) ?
+          "                #evaluate_option [#{name}]: eval!!!" :
+          "                #evaluate_option [#{name}]: skipping"
+        value = super
+        puts "                #evaluate_option [#{name}]: --> #{value}" if evaled
+        puts "                #evaluate_option [#{name}]: -->= #{args.first}" if name == :setter
+        value
+      end
+
+      def populator
+        super.extend(Populator)
+      end
+
+      def serializer
+        super.extend(Serializer)
+      end
+    end
+
+    module Populator
+      def deserialize(fragment)
+        puts "                  Populator#deserialize: #{fragment.inspect}"
+        puts "                                       : typed? is false, skipping Deserializer." if ! @binding.typed?
+        super
+      end
+
+      def deserializer
+        super.extend(Deserializer)
+      end
+    end
+
+    module Deserializer
+      def create_object(fragment, *args)
+        value = super
+          puts "                    Deserializer#create_object: --> #{value.inspect}"
+        value
+      end
+    end
+
+    module Serializer
+      def marshal(object, user_options)
+        puts "                    Serializer#marshal: --> #{object.inspect}"
+        super
+      end
+    end
+
+    module Mapper
+      def uncompile_fragment(bin, doc)
+        bin.extend(Binding)
+        puts "              uncompile_fragment: #{bin.name}"
+        super
+      end
+
+      def compile_fragment(bin, doc)
+        bin.extend(Binding)
+        puts "              compile_fragment: #{bin.name}"
+        super
+      end
+    end
+  end
+end

data/lib/representable/definition.rb

@@ -33,6 +33,12 @@ module Representable
       self
     end
 
+    def delete!(name)
+      @runtime_options.delete(name)
+      @options.delete(name)
+      self
+    end
+
     def [](name)
       @runtime_options[name]
     end

data/lib/representable/deserializer.rb

@@ -28,10 +28,14 @@ module Representable
       return object unless @binding.representable?
 
       @binding.evaluate_option(:deserialize, object, fragment) do
-        object.send(@binding.deserialize_method, fragment, options)
+        demarshal(object, fragment, options)
       end
     end
 
+    def demarshal(object, fragment, options)
+      object.send(@binding.deserialize_method, fragment, options)
+    end
+
     def prepare(object)
       @binding.evaluate_option(:prepare, object) do
         prepare!(object)

data/lib/representable/populator.rb

@@ -31,13 +31,17 @@ module Representable
       return yield if @binding.evaluate_option(:skip_parse, fragment) # TODO: move this into Deserializer.
 
       # use a Deserializer to transform fragment to/into object.
-      deserializer_class.new(@binding).call(fragment) # CollectionDeserializer/HashDeserializer/etc.
+      deserializer.call(fragment) # CollectionDeserializer/HashDeserializer/etc.
     end
 
     def deserializer_class
       Deserializer
     end
 
+    def deserializer
+      deserializer_class.new(@binding)
+    end
+
 
     # A separated collection deserializer/populator allows us better dealing with populating/modifying
     # collections of models. (e.g. replace, update, push, etc.).
@@ -45,7 +49,11 @@ module Representable
     class Collection < self
     private
       def deserialize(fragment)
-        return Deserializer::Collection.new(@binding).call(fragment)
+        return deserializer.call(fragment)
+      end
+
+      def deserializer
+        Deserializer::Collection.new(@binding)
       end
     end
 

data/lib/representable/serializer.rb

@@ -16,10 +16,14 @@ module Representable
       return object unless @binding.representable?
 
       @binding.evaluate_option(:serialize, object) do
-        object.send(@binding.serialize_method, user_options.merge!({:wrap => false}))
+        marshal(object, user_options)
       end
     end
 
+    def marshal(object, user_options)
+      object.send(@binding.serialize_method, user_options.merge!({:wrap => false}))
+    end
+
 
     class Collection < self
       def serialize(array, *args)

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "2.1.0"
+  VERSION = "2.1.1"
 end

data/test/config_test.rb

@@ -39,6 +39,16 @@ class ConfigTest < MiniTest::Spec
   # forwarded to Config#definitions
   # that goes to ConfigDefinitionsTest
   describe "#add" do
+    describe "returns" do
+      it do
+        # #add returns Definition.`
+        subject = Representable::Config.new.add(:title, {:me => true})
+
+        subject.must_be_kind_of Representable::Definition
+        subject[:me].must_equal true
+      end
+    end
+
     before { subject.add(:title, {:me => true}) }
 
     # must be kind of Definition
@@ -65,6 +75,20 @@ class ConfigTest < MiniTest::Spec
   end
 
 
+  describe "#remove" do
+    subject { Representable::Config.new }
+
+    it do
+      subject.add(:title, {:me => true})
+      subject.add(:genre, {})
+      subject.get(:genre).must_be_kind_of Representable::Definition
+
+      subject.remove(:genre)
+      subject.get(:genre).must_equal nil
+    end
+  end
+
+
   describe "#each" do
     before { subject.add(:title, {:me => true}) }
 
@@ -84,14 +108,6 @@ class ConfigTest < MiniTest::Spec
     end
   end
 
-
-  describe "#add" do
-    subject { Representable::Config.new.add(:title, {:me => true}) }
-
-    it { subject.must_be_kind_of Representable::Definition }
-    it { subject[:me].must_equal true }
-  end
-
   describe "#get" do
     subject       { Representable::Config.new }
 
@@ -105,7 +121,7 @@ class ConfigTest < MiniTest::Spec
   end
 
 
-  describe "xxx- #inherit!" do
+  describe "#inherit!" do
     let (:title)  { Definition.new(:title) }
     let (:length) { Definition.new(:length) }
     let (:stars)  { Definition.new(:stars) }

data/test/definition_test.rb

@@ -88,6 +88,16 @@ class DefinitionTest < MiniTest::Spec
     end
   end
 
+
+  # delete!
+  describe "#delete!" do
+    let (:definition) { Definition.new(:song, serialize: "remove me!") }
+
+    before { definition[:serialize].evaluate(nil).must_equal "remove me!" }
+
+    it { definition.delete!(:serialize)[:serialize].must_equal nil }
+  end
+
   # #inspect
   describe "#inspect" do
     it { Definition.new(:songs).inspect.must_equal "#<Representable::Definition ==>songs @options={:parse_filter=>[], :render_filter=>[], :as=>\"songs\"}>" }

data/test/schema_test.rb

@@ -120,4 +120,39 @@ class SchemaTest < MiniTest::Spec
   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
+
+
+class ApplyTest < MiniTest::Spec
+  class AlbumDecorator < Representable::Decorator
+    property :title
+
+    property :hit do
+      property :title
+    end
+
+    collection :songs do
+      property :title
+    end
+
+    property :band do # yepp, people do crazy stuff like that.
+      property :label do
+        property :name
+      end
+    end
+  end
+
+  # #apply
+  it do
+    properties = []
+
+    AlbumDecorator.apply do |dfn|
+      properties << dfn.name
+      dfn.merge! :cool => true
+    end.must_equal AlbumDecorator
+
+    properties.must_equal ["title", "hit", "title", "songs", "title", "band", "label", "name"]
+    # writeable
+    AlbumDecorator.representable_attrs.get(:band).representer_module.representable_attrs.get(:label).representer_module.representable_attrs.get(:name)[:cool].must_equal true
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: representable
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-19 00:00:00.000000000 Z
+date: 2014-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -168,10 +168,12 @@ files:
 - TODO
 - lib/representable.rb
 - lib/representable/TODO.getting_serious
+- lib/representable/apply.rb
 - lib/representable/autoload.rb
 - lib/representable/binding.rb
 - lib/representable/coercion.rb
 - lib/representable/config.rb
+- lib/representable/debug.rb
 - lib/representable/declarative.rb
 - lib/representable/decorator.rb
 - lib/representable/definition.rb