thirtythirty 0.0.1 → 0.0.2

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+spec/reports

data/README.rdoc

@@ -0,0 +1,25 @@
+= thirty-thirty
+
+the right hand of Marshall BraveStarr
+
+Selectively marshal objects without the fancy ruby 1.9 marshalling:
+
+  class Marshalled
+    extend Thirtythirty
+    
+    marshalled_accessor :attr1, :attr2
+    attr_accessor :volatile_attr
+  end
+
+  original = Marshalled.new
+  original.attr1 = "value1"
+  original.volatile_attr = "non-marshalled"
+  
+  marshalled = Marshal.dump(original)
+  
+  reloaded = Marshal.load(marshalled)
+  
+  reloaded.attr1          # => "value1"
+  reloaded.volatile_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/Rakefile

@@ -2,4 +2,7 @@ require 'bundler'
 Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
+require 'ci/reporter/rake/rspec'
+
 RSpec::Core::RakeTask.new :spec
+task :default => %w(ci:setup:rspec spec)

data/lib/thirtythirty.rb

@@ -2,10 +2,37 @@ require "json"
 
 module Thirtythirty
 
+  # Activates marshalling for the given attributes - you have to implement getters/setters yourself!
   def marshal(*attributes)
-    extend ClassMethods
-    send :include, InstanceMethods
-    @marshalled_attributes = attributes
+    configure_marshalling(attributes)
+  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)
+  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)
+  end
+
+  # Activates marshalling for the given attributes and generates getters/setters.
+  def marshalled_accessor(*attributes)
+    attr_accessor *configure_marshalling(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
@@ -18,7 +45,7 @@ module Thirtythirty
       data = JSON.parse(dumped)
       obj = new
       marshalled_attributes.each do |attr|
-        obj.send(:"#{attr}=", Marshal.load(data[attr.to_s]))
+        obj.send(:"#{attr}=", Marshal.load(data[attr]))
       end
       obj
     end

data/spec/spec_helper.rb

@@ -5,13 +5,12 @@ Bundler.require(:default, :development)
 Dir[File.expand_path '../support/*.rb', __FILE__].each {|f| require f}
 
 
-class Base
+class ThirtythirtyBase
   extend Thirtythirty
 end
 
-class BlogPost < Base
+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'
@@ -21,7 +20,7 @@ class BlogPost < Base
   end
 end
 
-class Comment < Base
+class Comment < ThirtythirtyBase
   marshal :author, :body, :date
   attr_accessor :author, :body, :date
   def initialize(attributes={})

data/spec/thirtythirty_spec.rb

@@ -0,0 +1,144 @@
+require 'spec_helper'
+
+describe Thirtythirty do
+
+  describe ".marshal" do
+
+    subject do
+      cls = Class.new(ThirtythirtyBase) do
+        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)
+      subject.marshalled_attributes.should be_frozen
+    end
+
+  end
+
+  describe ".marshalled_reader" do
+
+    subject do
+      Class.new(ThirtythirtyBase) do
+        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)
+      subject.marshalled_attributes.should be_frozen
+    end
+
+    %w(attr1 attr2 attr3).each do |attr|
+
+      it "should generate a reader for attribute #{attr} (but no writer)" do
+        obj = subject.new
+        obj.should respond_to(attr.to_sym)
+        obj.should_not respond_to(:"#{attr}=")
+      end
+
+    end
+
+  end
+
+  describe ".marshalled_writer" do
+
+    subject do
+      Class.new(ThirtythirtyBase) do
+        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)
+      subject.marshalled_attributes.should be_frozen
+    end
+
+    %w(attr1 attr2 attr3).each do |attr|
+
+      it "should generate a writer for attribute #{attr} (but no reader)" do
+        obj = subject.new
+        obj.should_not respond_to(attr.to_sym)
+        obj.should respond_to(:"#{attr}=")
+      end
+
+    end
+
+  end
+
+  describe ".marshalled_accessor" do
+
+    subject do
+      Class.new(ThirtythirtyBase) do
+        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)
+      subject.marshalled_attributes.should be_frozen
+    end
+
+    %w(attr1 attr2 attr3).each do |attr|
+
+      it "should generate a reader and a writer for attribute #{attr}" do
+        obj = subject.new
+        obj.should respond_to(attr.to_sym)
+        obj.should respond_to(:"#{attr}=")
+      end
+
+    end
+
+  end
+
+  describe "marshalling" do
+
+    describe "#_dump" do
+
+      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))
+      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/)
+      end
+
+    end
+
+    describe "._load" do
+
+      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'
+      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!'
+      end
+
+    end
+
+  end
+
+end

data/thirtythirty.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name        = "thirtythirty"
-  s.version     = "0.0.1"
+  s.version     = "0.0.2"
   s.date        = Time.now
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Benjamin Behr", "Thomas Jachmann"]
@@ -12,6 +12,7 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "thirtythirty"
 
+  s.add_development_dependency "ci_reporter", "~> 1.6.3"
   s.add_development_dependency "rspec", "~> 2.4.0"
   s.add_runtime_dependency "json", "~> 1.5.1"
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: thirtythirty
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Benjamin Behr
@@ -16,13 +16,29 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-03 00:00:00 +01:00
+date: 2011-02-04 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  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: 
     - - ~>
@@ -34,11 +50,11 @@ dependencies:
         - 0
         version: 2.4.0
   type: :development
-  version_requirements: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -50,7 +66,7 @@ dependencies:
         - 1
         version: 1.5.1
   type: :runtime
-  version_requirements: *id002
+  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
@@ -65,10 +81,11 @@ files:
 - .gitignore
 - .rspec
 - Gemfile
+- README.rdoc
 - Rakefile
 - lib/thirtythirty.rb
 - spec/spec_helper.rb
-- spec/thirtythirty/thirtythirty_spec.rb
+- spec/thirtythirty_spec.rb
 - thirtythirty.gemspec
 has_rdoc: true
 homepage: http://github.com/blaulabs/thirtythirty
@@ -100,10 +117,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: thirtythirty
-rubygems_version: 1.4.2
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: Marshalling customization
 test_files: 
 - spec/spec_helper.rb
-- spec/thirtythirty/thirtythirty_spec.rb
+- spec/thirtythirty_spec.rb

data/spec/thirtythirty/thirtythirty_spec.rb

@@ -1,46 +0,0 @@
-require 'spec_helper'
-
-describe Thirtythirty do
-  
-  describe "trying to dump an object" do
-
-    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))
-    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/)
-    end
-
-  end
-  
-  describe "trying to load an object" do
-    
-    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'
-    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!'
-    end
-
-  end
-
-end