thirtythirty 0.0.2 → 0.0.3

data/README.rdoc

@@ -8,18 +8,18 @@ Selectively marshal objects without the fancy ruby 1.9 marshalling:
     extend Thirtythirty
     
     marshalled_accessor :attr1, :attr2
-    attr_accessor :volatile_attr
+    attr_accessor :transient_attr
   end
 
   original = Marshalled.new
   original.attr1 = "value1"
-  original.volatile_attr = "non-marshalled"
+  original.transient_attr = "non-marshalled"
   
   marshalled = Marshal.dump(original)
   
   reloaded = Marshal.load(marshalled)
   
   reloaded.attr1          # => "value1"
-  reloaded.volatile_attr  # => nil
+  reloaded.transient_attr # => nil
 
 Note: Custom marshalling will only be activated by calling one of the marshalling methods (marshal, marshalled_reader, marshalled_writer, marshalled_accessor), not by extending Thirtythirty alone.

data/lib/thirtythirty.rb

@@ -4,37 +4,31 @@ module Thirtythirty
 
   # Activates marshalling for the given attributes - you have to implement getters/setters yourself!
   def marshal(*attributes)
-    configure_marshalling(attributes)
+    unless defined?(@marshalled_attributes)
+      extend ClassMethods
+      send :include, InstanceMethods
+      @marshalled_attributes = []
+    end
+    @marshalled_attributes = (@marshalled_attributes.map | attributes.flatten.map(&:to_sym).uniq).freeze
   end
 
   # Activates marshalling for the given attributes and generates getters - you have to implement setters yourself!
   def marshalled_reader(*attributes)
-    attr_reader *configure_marshalling(attributes)
+    attr_reader *marshal(attributes)
   end
 
   # Activates marshalling for the given attributes and generates setters - you have to implement getters yourself!
   def marshalled_writer(*attributes)
-    attr_writer *configure_marshalling(attributes)
+    attr_writer *marshal(attributes)
   end
 
   # Activates marshalling for the given attributes and generates getters/setters.
   def marshalled_accessor(*attributes)
-    attr_accessor *configure_marshalling(attributes)
+    attr_accessor *marshal(attributes)
   end
 
 private
 
-  def configure_marshalling(attributes)
-    unless defined?(@marshalled_attributes)
-      extend ClassMethods
-      send :include, InstanceMethods
-      @marshalled_attributes = []
-    end
-    attributes = attributes.flatten.map(&:to_s).uniq
-    @marshalled_attributes = (@marshalled_attributes | attributes).sort.freeze
-    attributes.map(&:to_sym)
-  end
-
   module ClassMethods
 
     attr_reader :marshalled_attributes
@@ -45,7 +39,7 @@ private
       data = JSON.parse(dumped)
       obj = new
       marshalled_attributes.each do |attr|
-        obj.send(:"#{attr}=", Marshal.load(data[attr]))
+        obj.send(:"#{attr}=", Marshal.load(data[attr.to_s]))
       end
       obj
     end
@@ -55,10 +49,31 @@ private
   module InstanceMethods
 
     def _dump(*args)
+      build_marshalled_attributes_hash {|v| Marshal.dump(v)}.to_json
+    end
+
+    def marshalled_attributes
+      build_marshalled_attributes_hash {|v| retrieve_marshalled_attributes_of(v)}
+    end
+
+  private
+
+    def build_marshalled_attributes_hash(&block)
       self.class.marshalled_attributes.inject({}) do |hash, attr|
-        hash[attr] = Marshal.dump(self.send(attr.to_sym))
+        value = self.send(attr)
+        hash[attr] = block.call(value)
         hash
-      end.to_json
+      end
+    end
+
+    def retrieve_marshalled_attributes_of(obj)
+      if obj.is_a?(Array)
+        obj.map {|v| retrieve_marshalled_attributes_of(v)}
+      elsif obj.respond_to?(:marshalled_attributes)
+        obj.marshalled_attributes
+      else
+        obj
+      end
     end
 
   end

data/spec/spec_helper.rb

@@ -3,29 +3,3 @@ require 'bundler'
 Bundler.require(:default, :development)
 
 Dir[File.expand_path '../support/*.rb', __FILE__].each {|f| require f}
-
-
-class ThirtythirtyBase
-  extend Thirtythirty
-end
-
-class BlogPost < ThirtythirtyBase
-  marshal :title, :description, :comments
-  attr_accessor :title, :description, :comments, :secret_password
-  def initialize(attributes={})
-    self.title = attributes[:title] || 'My first blog post'
-    self.description = attributes[:description] || "This is a very short description of the things i've done yesterday"
-    self.comments = attributes[:comments] || [Comment.new, Comment.new(:author => 'bennyb', :comment => 'Ponies and Unicorns!')]
-    self.secret_password = attributes[:secret_password] || "SECRET!"
-  end
-end
-
-class Comment < ThirtythirtyBase
-  marshal :author, :body, :date
-  attr_accessor :author, :body, :date
-  def initialize(attributes={})
-    self.author = attributes[:author] || 'tomj'
-    self.body = attributes[:body] || "Very nice article!"
-    self.date = attributes[:date] || Time.now
-  end
-end

data/spec/support/thirtythirty_base.rb

@@ -0,0 +1,3 @@
+class ThirtythirtyBase
+  extend Thirtythirty
+end

data/spec/support/tree.rb

@@ -0,0 +1,4 @@
+class ThirtythirtyTree < ThirtythirtyBase
+  marshalled_accessor :persistent, :parent, :children
+  attr_accessor :transient
+end

data/spec/thirtythirty_spec.rb

@@ -6,13 +6,13 @@ describe Thirtythirty do
 
     subject do
       cls = Class.new(ThirtythirtyBase) do
-        marshal :attr1, :attr3
+        marshal :attr1, "attr3"
         marshal [:attr1, :attr2]
       end
     end
 
-    it "should add given attributes to marshalled attributes (stringified, unique, sorted, frozen)" do
-      subject.marshalled_attributes.should == %w(attr1 attr2 attr3)
+    it "should add given attributes to marshalled attributes (symbolized, unique, frozen)" do
+      subject.marshalled_attributes.should =~ [:attr1, :attr2, :attr3]
       subject.marshalled_attributes.should be_frozen
     end
 
@@ -22,13 +22,13 @@ describe Thirtythirty do
 
     subject do
       Class.new(ThirtythirtyBase) do
-        marshalled_reader :attr1, :attr3
+        marshalled_reader :attr1, "attr3"
         marshalled_reader [:attr1, :attr2]
       end
     end
 
-    it "should add given attributes to marshalled attributes (stringified, unique, sorted, frozen)" do
-      subject.marshalled_attributes.should == %w(attr1 attr2 attr3)
+    it "should add given attributes to marshalled attributes (symbolized, unique, frozen)" do
+      subject.marshalled_attributes.should =~ [:attr1, :attr2, :attr3]
       subject.marshalled_attributes.should be_frozen
     end
 
@@ -48,13 +48,13 @@ describe Thirtythirty do
 
     subject do
       Class.new(ThirtythirtyBase) do
-        marshalled_writer :attr1, :attr3
+        marshalled_writer :attr1, "attr3"
         marshalled_writer [:attr1, :attr2]
       end
     end
 
-    it "should add given attributes to marshalled attributes (stringified, unique, sorted, frozen)" do
-      subject.marshalled_attributes.should == %w(attr1 attr2 attr3)
+    it "should add given attributes to marshalled attributes (symbolized, unique, frozen)" do
+      subject.marshalled_attributes.should =~ [:attr1, :attr2, :attr3]
       subject.marshalled_attributes.should be_frozen
     end
 
@@ -74,13 +74,13 @@ describe Thirtythirty do
 
     subject do
       Class.new(ThirtythirtyBase) do
-        marshalled_accessor :attr1, :attr3
+        marshalled_accessor :attr1, "attr3"
         marshalled_accessor :attr1, :attr2
       end
     end
 
-    it "should add given attributes to marshalled attributes (stringified, unique, sorted, frozen)" do
-      subject.marshalled_attributes.should == %w(attr1 attr2 attr3)
+    it "should add given attributes to marshalled attributes (symbolized, unique, frozen)" do
+      subject.marshalled_attributes.should =~ [:attr1, :attr2, :attr3]
       subject.marshalled_attributes.should be_frozen
     end
 
@@ -96,45 +96,114 @@ describe Thirtythirty do
 
   end
 
-  describe "marshalling" do
+  describe "#marshalled_attributes" do
 
-    describe "#_dump" do
+    it "should give all marshalled attributes" do
+      obj = ThirtythirtyTree.new
+      obj.persistent = "p"
+      obj.transient = "t"
+      obj.marshalled_attributes.should == {:persistent => "p", :parent => nil, :children => nil}
+    end
+
+    it "should recursively give marshalled attributes of a single relation" do
+      obj = ThirtythirtyTree.new
+      obj.persistent = "middle"
+      obj.parent = ThirtythirtyTree.new
+      obj.parent.persistent = "parent"
+      obj.marshalled_attributes.should == {
+        :persistent => "middle",
+        :parent => {:persistent => "parent", :parent => nil, :children => nil},
+        :children => nil
+      }
+    end
+
+    it "should recursively give marshalled attributes of a collection relation" do
+      obj = ThirtythirtyTree.new
+      obj.persistent = "middle"
+      obj.children = [ThirtythirtyTree.new]
+      obj.children.first.persistent = "child1"
+      obj.marshalled_attributes.should == {
+        :persistent => "middle",
+        :parent => nil,
+        :children => [{:persistent => "child1", :parent => nil, :children => nil}]
+      }
+    end
+
+  end
+
+  describe "marshalling (#_dump/._load)" do
+
+    before do
+      @obj = ThirtythirtyTree.new
+    end
+
+    it "should dump a string" do
+      Marshal.dump(@obj).should be_a(String)
+    end
+
+    it "should restore a ThirtythirtyTree" do
+      Marshal.load(Marshal.dump(@obj)).should be_a(ThirtythirtyTree)
+    end
 
-      it "should only dump attributes that should be exposed" do
-        password = "VERY SECRET!"
-        blog_post = BlogPost.new(:secret_password => password)
-        marshalled_blog_post = Marshal.dump(blog_post)
-        marshalled_blog_post.should_not match(Regexp.new(password))
+    it "should dump/restore marshalled attributes" do
+      @obj.persistent = "data"
+      restored = Marshal.load(Marshal.dump(@obj))
+      restored.persistent.should == "data"
+    end
+
+    it "should not dump/restore unmarshalled attributes" do
+      @obj.transient = "data"
+      restored = Marshal.load(Marshal.dump(@obj))
+      restored.transient.should be_nil
+    end
+
+    context "with a single relation" do
+
+      before do
+        @obj.parent = ThirtythirtyTree.new
+      end
+
+      it "should restore a ThirtythirtyTree" do
+        Marshal.load(Marshal.dump(@obj)).parent.should be_a(ThirtythirtyTree)
       end
 
-      it "should also serialize nested objects so that these objects can also be retrieved by loading the main object" do
-        blog_post = BlogPost.new(:comments => [Comment.new(:author => 'tomj'), Comment.new(:author => 'bennyb')])
-        marshalled_blog_post = Marshal.dump(blog_post)
-        marshalled_blog_post.should match(/bennyb/)
-        marshalled_blog_post.should match(/tomj/)
+      it "should dump/restore marshalled attributes" do
+        @obj.parent.persistent = "data"
+        restored = Marshal.load(Marshal.dump(@obj))
+        restored.parent.persistent.should == "data"
+      end
+
+      it "should not dump/restore unmarshalled attributes" do
+        @obj.parent.transient = "data"
+        restored = Marshal.load(Marshal.dump(@obj))
+        restored.parent.transient.should be_nil
       end
 
     end
 
-    describe "._load" do
+    context "with a collection relation" do
+
+      before do
+        @obj.children = [ThirtythirtyTree.new]
+      end
+
+      it "should restore an array of ThirtythirtyTrees" do
+        children = Marshal.load(Marshal.dump(@obj)).children
+        children.should be_a(Array)
+        children.size.should == 1
+        children.first.should be_a(ThirtythirtyTree)
+      end
 
-      it "should return a fully deserialized object" do
-        blog_post = BlogPost.new(:comments => [], :title => 'blau is happy')
-        marshalled_blog_post = Marshal.dump(blog_post)
-        deserialized_blog_post = Marshal.load(marshalled_blog_post)
-        deserialized_blog_post.should be_kind_of(BlogPost)
-        deserialized_blog_post.title.should == 'blau is happy'
+      it "should dump/restore marshalled attributes" do
+        @obj.children.first.persistent = "data"
+        restored = Marshal.load(Marshal.dump(@obj))
+        restored.children.first.persistent.should == "data"
       end
 
-      it "should return a fully deserialized object and nested objects" do
-        nice_comment = Comment.new(:author => 'tomj', :body => 'nice article, dude!')
-        blog_post = BlogPost.new(:comments => [nice_comment])
-        marshalled_blog_post = Marshal.dump(blog_post)
-        deserialized_blog_post = Marshal.load(marshalled_blog_post)
-        retrieved_comment = deserialized_blog_post.comments.first
-        retrieved_comment.should be_kind_of(Comment)
-        retrieved_comment.author.should == 'tomj'
-        retrieved_comment.body.should == 'nice article, dude!'
+      it "should not dump/restore unmarshalled attributes" do
+        @obj.children.first.transient = "data"
+        restored = Marshal.load(Marshal.dump(@obj))
+        restored.children.first.transient.should be_nil
       end
 
     end

data/thirtythirty.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name        = "thirtythirty"
-  s.version     = "0.0.2"
+  s.version     = "0.0.3"
   s.date        = Time.now
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Benjamin Behr", "Thomas Jachmann"]

metadata

@@ -1,76 +1,56 @@
 --- !ruby/object:Gem::Specification 
 name: thirtythirty
 version: !ruby/object:Gem::Version 
-  hash: 27
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
-- Benjamin Behr
-- Thomas Jachmann
+  - Benjamin Behr
+  - Thomas Jachmann
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-02-04 00:00:00 +01:00
+date: 2011-02-08 00:00:00 +01:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: ci_reporter
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 1
-        - 6
-        - 3
-        version: 1.6.3
-  type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 2
-        - 4
-        - 0
-        version: 2.4.0
-  type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: json
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 5
-        - 1
-        version: 1.5.1
-  type: :runtime
-  version_requirements: *id003
+  - !ruby/object:Gem::Dependency 
+    name: ci_reporter
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: 1.6.3
+    type: :development
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: 2.4.0
+    type: :development
+    version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: json
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: 1.5.1
+    type: :runtime
+    version_requirements: *id003
 description: This gem allows for customization of which data to marshal, especially useful for selective session data serialization.
 email: 
-- benny@digitalbehr.de
-- self@thomasjachmann.com
+  - benny@digitalbehr.de
+  - self@thomasjachmann.com
 executables: []
 
 extensions: []
@@ -78,15 +58,17 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- .gitignore
-- .rspec
-- Gemfile
-- README.rdoc
-- Rakefile
-- lib/thirtythirty.rb
-- spec/spec_helper.rb
-- spec/thirtythirty_spec.rb
-- thirtythirty.gemspec
+  - .gitignore
+  - .rspec
+  - Gemfile
+  - README.rdoc
+  - Rakefile
+  - lib/thirtythirty.rb
+  - spec/spec_helper.rb
+  - spec/support/thirtythirty_base.rb
+  - spec/support/tree.rb
+  - spec/thirtythirty_spec.rb
+  - thirtythirty.gemspec
 has_rdoc: true
 homepage: http://github.com/blaulabs/thirtythirty
 licenses: []
@@ -95,25 +77,19 @@ post_install_message:
 rdoc_options: []
 
 require_paths: 
-- lib
+  - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
 requirements: []
 
 rubyforge_project: thirtythirty
@@ -122,5 +98,7 @@ signing_key:
 specification_version: 3
 summary: Marshalling customization
 test_files: 
-- spec/spec_helper.rb
-- spec/thirtythirty_spec.rb
+  - spec/spec_helper.rb
+  - spec/support/thirtythirty_base.rb
+  - spec/support/tree.rb
+  - spec/thirtythirty_spec.rb