representable 1.8.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b00de985635f525b8a01171885aed414e6204034
-  data.tar.gz: dc62dd3c718b5969a663da9587ef815ddb4eb6e8
+  metadata.gz: 4966e0bd638ff12a23976fed58fab076e5912e20
+  data.tar.gz: 4ca036c615f0e656d8268cdb1bf74918f1d9476a
 SHA512:
-  metadata.gz: 9a7cc3fb19f4319e69cbf66e566ae70b9a8ede10bc5b9666756128ab7795eec2c35315f31603ff3ad3fa8b78ac170270389ba33e128b6848496d45fd1cec615f
-  data.tar.gz: d2eb8e52c0485aebea0fe956fa98ef9d9c06f87a8d00a0d027dbea804b573982b364d1bcc06f3db65bbeb33e89e814a594300302675776be11024ce335569d69
+  metadata.gz: b2f875cda0fde3869bb592317de279ba4c92fb6e29b46685ed4908313bd43dab6a9614e9af6413368940ccad9e61dd7339fc0d325e1fdba9211906eb4ab40850
+  data.tar.gz: fb9e3c1d669e7219ee57451e5d5302ef41b770a6dea11f73c7699528de4a01ad3a0df6da4f8abb8cf9f691de1da94a9f92fa9014f74d4a3ec4f51366dbfead51

data/CHANGES.md

@@ -1,3 +1,7 @@
+# 1.8.1
+
+* Add `:serialize` and `:deserialize` options for overriding those steps.
+
 # 1.8.0
 
 ## Major Breakage
@@ -17,6 +21,7 @@
 
 * When unsure about the number of arguments passed into an option lambda, use `:pass_options`. This passes all general options in a dedicated `Options` object that responds to `binding`, `decorator`, `represented` and `user_options`. It's always the last argument for the block.
 * Added `parse_strategy: :find_or_instantiate`. More to come.
+* Added `parse_strategy: lambda { |fragment, i, options| }` to implement your own deserialization.
 * Use `representable: false` to prevent calling `to_*/from_*` on a represented object even if the property is `typed?` (`:extend`, `:class` or `:instance` set).
 * Introduced `:use_decorator` option to force an inline representer to be implemented with a Decorator even in a module. This fixes a bug since we used the `:decorate` option in earlier versions, which was already used for something else.
 * Autoload `Representable::Hash*` and `Representable::Decorator`.

data/README.md

@@ -125,10 +125,10 @@ end
 Surprisingly, `#collection` lets us define lists of objects to represent.
 
 ```ruby
-Song.new(title: "Fallout", composers: ["Steward Copeland", "Sting"]).
+Song.new(title: "Fallout", composers: ["Stewart Copeland", "Sting"]).
   extend(SongRepresenter).to_json
 
-#=> {"title":"Fallout","composers":["Steward Copeland","Sting"]}
+#=> {"title":"Fallout","composers":["Stewart Copeland","Sting"]}
 ```
 
 And again, this works both ways - in addition to the title it extracts the composers from the document, too.
@@ -162,7 +162,7 @@ When rendering, the `:extend` module is used to extend the attribute(s) with the
 
 ```ruby
 album.extend(AlbumRepresenter).to_json
-#=> {"name":"The Police","songs":[{"title":"Fallout","composers":["Steward Copeland","Sting"]},{"title":"Synchronicity","composers":[]}]}
+#=> {"name":"The Police","songs":[{"title":"Fallout","composers":["Stewart Copeland","Sting"]},{"title":"Synchronicity","composers":[]}]}
 ```
 
 Parsing a documents needs both `:extend` and the `:class` option as the parser requires knowledge what kind of object to create from the nested composition.
@@ -453,6 +453,8 @@ Here's a list of all dynamic options and their argument signature.
 * `writer: lambda { |document, args| }` ([see Read And Write](#overriding-read-and-write))
 * `if: lambda { |args| }` ([see Conditions](#conditions))
 * `prepare: lambda { |object, args| }` ([see docs](#rendering-and-parsing-without-extend))
+* `serialize: lambda { |object, args| }` ([see docs](#overriding-serialize-and-deserialize))
+* `deserialize: lambda { |object, fragment, args| }` ([see docs](#overriding-serialize-and-deserialize))
 * `representation_wrap` is a dynamic option, too: `self.representation_wrap = lambda do { |args| }` ([see Wrapping](#wrapping))
 
 
@@ -491,11 +493,11 @@ end
 For XML we just include the `Representable::XML` module.
 
 ```xml
-Song.new(title: "Fallout", composers: ["Steward Copeland", "Sting"]).
+Song.new(title: "Fallout", composers: ["Stewart Copeland", "Sting"]).
      extend(SongRepresenter).to_xml #=>
 <song>
     <title>Fallout</title>
-    <composers>Steward Copeland</composers>
+    <composers>Stewart Copeland</composers>
     <composers>Sting</composers>
 </song>
 ```
@@ -823,7 +825,7 @@ song.extend(SongRepresenter).to_yaml
 #=>
 ---
 title: Fallout
-composers: [Steward Copeland, Sting]
+composers: [Stewart Copeland, Sting]
 ```
 
 ## More on XML
@@ -992,6 +994,26 @@ If you want `nil` values to be included when rendering, use the `:render_nil` op
 property :track, render_nil: true
 ```
 
+
+### Overriding Serialize And Deserialize
+
+When serializing, the default mechanics after preparing the object are to call `object.to_hash`.
+
+Override this step with `:serialize`.
+
+```ruby
+property :song, extend: SongRepresenter,
+  serialize: lambda { |object, *args| Marshal.dump(object) }
+```
+
+Vice-versa, parsing allows the same.
+
+```ruby
+property :song, extend: SongRepresenter,
+  deserialize: lambda { |object, fragment, *args| Marshal.load(fragment) }
+```
+
+
 ## Coercion
 
 If you fancy coercion when parsing a document you can use the Coercion module which uses [virtus](https://github.com/solnic/virtus) for type conversion.

data/lib/representable/binding.rb

@@ -135,6 +135,7 @@ module Representable
       end
 
     private
+      # DISCUSS: deprecate :class in favour of :instance and simplicity?
       def class_for(fragment, *args)
         item_class = class_from(fragment, *args) or return handle_deprecated_class(fragment)
         item_class.new

data/lib/representable/definition.rb

@@ -90,7 +90,7 @@ module Representable
     end
 
     def dynamic_options
-      [:as, :getter, :setter, :class, :instance, :reader, :writer, :extend, :prepare, :if]
+      [:as, :getter, :setter, :class, :instance, :reader, :writer, :extend, :prepare, :if, :deserialize, :serialize]
     end
 
     def handle_extend!(options)

data/lib/representable/deserializer.rb

@@ -37,7 +37,9 @@ module Representable
     def deserialize(object, fragment, options) # TODO: merge with #serialize.
       return object unless @binding.representable?
 
-      object.send(@binding.deserialize_method, fragment, options)
+      @binding.send(:evaluate_option, :deserialize, object, fragment) do
+        object.send(@binding.deserialize_method, fragment, options)
+      end
     end
 
     def prepare(object)

data/lib/representable/serializer.rb

@@ -20,7 +20,9 @@ module Representable
     def serialize(object, user_options)
       return object unless @binding.representable?
 
-      object.send(@binding.serialize_method, user_options.merge!({:wrap => false}))
+      @binding.send(:evaluate_option, :serialize, object) do
+        object.send(@binding.serialize_method, user_options.merge!({:wrap => false}))
+      end
     end
   end
 end

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "1.8.0"
+  VERSION = "1.8.1"
 end

data/test/example.rb

@@ -56,7 +56,7 @@ module SongRepresenter
 end
 
 
-song = Song.new(:title => "Fallout", :composers => ["Steward Copeland", "Sting"])
+song = Song.new(:title => "Fallout", :composers => ["Stewart Copeland", "Sting"])
 puts song.extend(SongRepresenter).to_json
 
 
@@ -143,7 +143,7 @@ module SongRepresenter
   property :track
   collection :composers
 end
-song = Song.new(:title => "Fallout", :composers => ["Steward Copeland", "Sting"])
+song = Song.new(:title => "Fallout", :composers => ["Stewart Copeland", "Sting"])
 puts song.extend(SongRepresenter).to_xml
 
 reset_representer(SongRepresenter)

data/test/serialize_deserialize_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+
+class SerializeDeserializeTest < BaseTest
+  subject { Struct.new(:song).new.extend(representer) }
+
+  describe "deserialize" do
+    representer! do
+      property :song,
+        :instance => lambda { |fragment, *| fragment.to_s.upcase },
+        :prepare  => lambda { |fragment, *| fragment }, # TODO: allow false.
+        :deserialize => lambda { |object, fragment, args|
+          "#{object} #{fragment} #{args.inspect}"
+        }
+    end
+
+    it { subject.from_hash({"song" => Object}, {:volume => 9}).song.must_equal "OBJECT Object {:volume=>9}" }
+  end
+
+  describe "serialize" do
+    representer! do
+      property :song,
+        :representable => true,
+        :prepare  => lambda { |fragment, *| fragment }, # TODO: allow false.
+        :serialize => lambda { |object, args|
+          "#{object} #{args.inspect}"
+        }
+    end
+
+    before { subject.song = "Arrested In Shanghai" }
+
+    it { subject.to_hash({:volume => 9}).must_equal({"song"=>"Arrested In Shanghai {:volume=>9}"}) }
+  end
+end

metadata

@@ -1,167 +1,167 @@
 --- !ruby/object:Gem::Specification
 name: representable
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.1
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2014-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: uber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: test_xml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.1.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.1.6
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.7.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.7.7
 description: Renders and parses JSON/XML/YAML documents from and to Ruby objects.
@@ -172,8 +172,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .travis.yml
 - CHANGES.md
 - Gemfile
 - LICENSE
@@ -236,6 +236,7 @@ files:
 - test/prepare_test.rb
 - test/reader_writer_test.rb
 - test/representable_test.rb
+- test/serialize_deserialize_test.rb
 - test/stringify_hash_test.rb
 - test/test_helper.rb
 - test/test_helper_test.rb
@@ -252,54 +253,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
 summary: Renders and parses JSON/XML/YAML documents from and to Ruby objects. Includes
   plain properties, collections, nesting, coercion and more.
-test_files:
-- test/as_test.rb
-- test/class_test.rb
-- test/coercion_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/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/inline_test.rb
-- test/instance_test.rb
-- test/is_representable_test.rb
-- test/json_test.rb
-- test/mongoid_test.rb
-- test/nested_test.rb
-- test/parse_strategy_test.rb
-- test/pass_options_test.rb
-- test/prepare_test.rb
-- test/reader_writer_test.rb
-- test/representable_test.rb
-- test/stringify_hash_test.rb
-- test/test_helper.rb
-- test/test_helper_test.rb
-- test/wrap_test.rb
-- test/xml_bindings_test.rb
-- test/xml_test.rb
-- test/yaml_test.rb
-has_rdoc: 
+test_files: []