perpetuity 0.1 → 0.2

data/README.md

@@ -15,11 +15,9 @@ In the Data Mapper pattern, the objects you work with don't understand how to pe
 Add the following to your Gemfile and run `bundle` to install it.
 
 ```ruby
-gem 'perpetuity', github: 'jgaskins/perpetuity'
+gem 'perpetuity'
 ```
 
-Once it's got enough functionality to release, you'll be able to remove the `github` parameter.
-
 ## Configuration
 
 The only currently supported persistence method is MongoDB. Other schemaless solutions can probably be implemented easily.

data/lib/perpetuity/data_injectable.rb

@@ -1,13 +1,17 @@
 module Perpetuity
   module DataInjectable
+    def inject_attribute object, attribute, value
+      if object.respond_to?("#{attribute}=")
+        object.send("#{attribute}=", value)
+      else
+        attribute = "@#{attribute}" unless attribute[0] == '@'
+        object.instance_variable_set(attribute, value)
+      end
+    end
+
     def inject_data object, data
       data.each_pair do |attribute,value|
-        if object.respond_to?("#{attribute}=")
-          object.send("#{attribute}=", value)
-        else
-          attribute = "@#{attribute}" unless attribute[0] == '@'
-          object.instance_variable_set(attribute, value)
-        end
+        inject_attribute object, attribute, value
       end
       give_id_to object if object.instance_variables.include?(:@id)
     end

data/lib/perpetuity/mapper.rb

@@ -39,68 +39,64 @@ module Perpetuity
       data_source.delete_all mapped_class
     end
 
-    def serializable_types
-      @serializable_types ||= [NilClass, TrueClass, FalseClass, Fixnum, Bignum, Float, String, Array, Hash, Time, Date]
-    end
-
     def insert object
       raise "#{object} is invalid and cannot be persisted." unless validations.valid?(object)
-      serializable_attributes = {}
+      serializable_attributes = serialize(object)
       if o_id = object.instance_exec(&id)
         serializable_attributes[:id] = o_id
       end
 
-      attributes_for(object).each_pair do |attribute, value|
-        if serializable_types.include? value.class
-          serializable_attributes[attribute] = value
-        elsif value.respond_to?(:id)
-          serializable_attributes[attribute] = value.id
-        else
-          raise "Must persist #{attribute} (#{value.inspect}) before persisting this #{object.inspect}."
-        end
-      end
-
       new_id = data_source.insert mapped_class, serializable_attributes
       give_id_to object, new_id
       new_id
     end
 
-    def attributes_for object
+    def serialize object
       attrs = {}
       attribute_set.each do |attrib|
         value = object.send(attrib.name)
-
-        if attrib.type == Array
-          new_array = []
-          value.each do |i|
-            if serializable_types.include? i.class
-              new_array << i
-            else
-              if attrib.embedded?
-                new_array << Marshal.dump(i)
-              else
-                new_array << i.id
-              end
-            end
+        attrib_name = attrib.name.to_s
+
+        if value.respond_to? :each
+          attrs[attrib_name] = serialize_enumerable(value)
+        elsif data_source.can_serialize? value
+          attrs[attrib_name] = value
+        elsif Mapper[value.class]
+          if attrib.embedded?
+            attrs[attrib_name] = Mapper[value.class].serialize(value).merge '__metadata__' =>  { 'class' => value.class }
+          else
+            attrs[attrib_name] = {
+              '__metadata__' =>  {
+                'class' => value.class.to_s,
+                'id' => value.id
+              }
+            }
           end
-
-          attrs[attrib.name] = new_array
         else
-          attrs[attrib.name] = value
+          if attrib.embedded?
+            attrs[attrib_name] = Marshal.dump(value)
+          end
         end
       end
+
       attrs
     end
 
-    def unserialize(data)
-      if data.is_a?(String) && data.start_with?("\u0004")
-        Marshal.load(data)
-      elsif data.is_a? Array
-        data.map { |i| unserialize i }
-      elsif data.is_a? Hash
-        Hash[data.map{|k,v| [k, unserialize(v)]}]
-      else
-        data
+    def serialize_enumerable enum
+      enum.map do |value|
+        if value.respond_to? :each
+          serialize_enumerable(value)
+        elsif data_source.can_serialize? value
+          value
+        elsif Mapper[value.class]
+          {
+            '__metadata__' => {
+              'class' => value.class.to_s
+            }
+          }.merge Mapper[value.class].serialize(value)
+        else
+          Marshal.dump(value)
+        end
       end
     end
 
@@ -159,12 +155,11 @@ module Perpetuity
     end
 
     def load_association! object, attribute
-      class_name = attribute_set[attribute].type
-      id = object.send(attribute)
+      reference = object.send(attribute)
+      klass = reference.klass
+      id = reference.id
 
-      mapper = Mapper[class_name]
-      associated_object = mapper.find(id)
-      object.send("#{attribute}=", associated_object)
+      inject_attribute object, attribute, Mapper[klass].find(id)
     end
 
     def id &block

data/lib/perpetuity/mongodb.rb

@@ -98,5 +98,14 @@ module Perpetuity
     def update klass, id, new_data
       collection(klass).update({ _id: id }, new_data)
     end
+
+    def can_serialize? value
+      serializable_types.include? value.class
+    end
+
+    private
+    def serializable_types
+      @serializable_types ||= [NilClass, TrueClass, FalseClass, Fixnum, Float, String, Array, Hash, Time]
+    end
   end
 end

data/lib/perpetuity/reference.rb

@@ -0,0 +1,17 @@
+module Perpetuity
+  class Reference
+    attr_reader :klass, :id
+    def initialize klass, id
+      @klass = klass
+      @id    = id
+    end
+
+    def == other
+      klass == other.klass && id == other.id
+    end
+
+    def eql? other
+      self == other
+    end
+  end
+end

data/lib/perpetuity/retrieval.rb

@@ -1,5 +1,5 @@
 require 'perpetuity/data_injectable'
-require 'perpetuity/mapper'
+require 'perpetuity/reference'
 
 module Perpetuity
   class Retrieval
@@ -53,15 +53,39 @@ module Perpetuity
         page: result_page
       }
       results = @data_source.retrieve(@class, @criteria, options)
-      objects = []
-      results.each do |result|
-        object = @class.new
-        inject_data object, Mapper.new.unserialize(result)
+      unserialize results
+    end
 
-        objects << object
-      end
+    def unserialize(data)
+      if data.is_a?(String) && data.start_with?("\u0004") # if it's marshaled
+        Marshal.load(data)
+      elsif data.is_a? Array
+        data.map { |i| unserialize i }
+      elsif data.is_a? Hash
+        metadata = data.delete('__metadata__')
+        if metadata
+          klass = Object.const_get metadata['class']
+          id = metadata['id']
+          if id
+            object = Reference.new(klass, id)
+          else
+            object = klass.new
+            data.each do |attr, value|
+              inject_attribute object, attr, unserialize(value)
+            end
+          end
+        else
+          object = @class.new
+          data.each do |attr, value|
+            inject_attribute object, attr, unserialize(value)
+          end
+        end
 
-      objects
+        give_id_to object
+        object
+      else
+        data
+      end
     end
 
     def [] index

data/lib/perpetuity/version.rb

@@ -1,3 +1,3 @@
 module Perpetuity
-  VERSION = "0.1"
+  VERSION = "0.2"
 end

data/perpetuity.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Jamie Gaskins"]
   s.email       = ["jgaskins@gmail.com"]
   s.homepage    = "https://github.com/jgaskins/perpetuity.git"
-  s.summary     = %q{Persistence library allowing persistence of Ruby objects}
-  s.description = %q{Persistence library allowing persistence of Ruby objects without adding persistence concerns to domain objects.}
+  s.summary     = %q{Persistence library allowing serialization of Ruby objects}
+  s.description = %q{Persistence layer Ruby objects}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/perpetuity/data_injectable_spec.rb

@@ -7,6 +7,11 @@ module Perpetuity
 
     before { klass.extend DataInjectable }
 
+    it 'injects an attribute into an object' do
+      klass.inject_attribute object, :a, 1
+      object.instance_variable_get(:@a).should eq 1
+    end
+
     it 'injects data into an object' do
       klass.inject_data object, { a: 1, b: 2 }
       object.instance_variable_get(:@a).should eq 1

data/spec/perpetuity/mapper_spec.rb

@@ -26,7 +26,7 @@ module Perpetuity
 
     its(:mapped_class) { should eq Object }
 
-    context 'with unserializable attributes' do
+    context 'with unserializable embedded attributes' do
       let(:unserializable_object) { 1.to_c }
       let(:serialized_attrs) do
         [ Marshal.dump(unserializable_object) ]
@@ -36,15 +36,11 @@ module Perpetuity
         object = Object.new
         object.stub(sub_objects: [unserializable_object])
         mapper.attribute :sub_objects, Array, embedded: true
-        mapper.attributes_for(object)[:sub_objects].should eq serialized_attrs
-      end
-
-      describe 'unserializes attributes' do
-        let(:comments) { mapper.unserialize(serialized_attrs)  }
-        subject { comments.first }
+        data_source = double(:data_source)
+        mapper.stub(data_source: data_source)
+        data_source.should_receive(:can_serialize?).with(unserializable_object).and_return false
 
-        it { should be_a Complex }
-        it { should eq unserializable_object }
+        mapper.serialize(object)['sub_objects'].should eq serialized_attrs
       end
     end
   end

data/spec/perpetuity/mongodb_spec.rb

@@ -1,4 +1,5 @@
 require 'perpetuity/mongodb'
+require 'date'
 
 module Perpetuity
   describe MongoDB do
@@ -83,9 +84,20 @@ module Perpetuity
 
     it 'retrieves by id if the id is a string' do
       time = Time.now.utc
-      id = mongo.insert Article, {inserted: time}
-      objects = mongo.retrieve(Article, id: id.to_s).to_a
+      id = mongo.insert Object, {inserted: time}
+      objects = mongo.retrieve(Object, id: id.to_s).to_a
       objects.map{|i| i["inserted"].to_f}.first.should be_within(0.001).of time.to_f
     end
+
+    describe 'serializable objects' do
+      let(:serializable_values) { [nil, true, false, 1, 1.2, '', [], {}, Time.now] }
+
+      it 'can insert serializable values' do
+        serializable_values.each do |value|
+          mongo.insert(Object, {value: value}).should be_a BSON::ObjectId
+          mongo.can_serialize?(value).should be_true
+        end
+      end
+    end
   end
 end

data/spec/perpetuity/reference_spec.rb

@@ -0,0 +1,26 @@
+require 'perpetuity/reference'
+
+module Perpetuity
+  describe Reference do
+    let(:reference) { Reference.new Object, 1 }
+    subject { reference }
+
+    its(:klass) { should be Object }
+    its(:id)    { should be == 1 }
+
+    describe 'comparability' do
+      describe 'equality' do
+        let(:duplicate) { reference.dup }
+        it { should be == duplicate }
+        it { should eql duplicate }
+      end
+
+      describe 'inequality' do
+        it { should_not be == Reference.new(String, reference.id) }
+        it { should_not eql Reference.new(String, reference.id) }
+        it { should_not be == Reference.new(reference.klass, 2) }
+        it { should_not eql Reference.new(reference.klass, 2) }
+      end
+    end
+  end
+end

data/spec/perpetuity/retrieval_spec.rb

@@ -54,5 +54,15 @@ module Perpetuity
 
       results.map(&:id).should == [0]
     end
+
+    describe 'unserializes attributes' do
+      let(:unserializable_object) { 1.to_c }
+      let(:serialized_attrs) { [ Marshal.dump(unserializable_object) ] }
+      let(:comments) { retrieval.unserialize(serialized_attrs)  }
+      subject { comments.first }
+
+      it { should be_a Complex }
+      it { should eq unserializable_object}
+    end
   end
 end

data/spec/perpetuity_spec.rb

@@ -243,12 +243,17 @@ describe Perpetuity do
       topic_mapper.insert topic
     end
 
-    it 'can reference other objects' do
-      topic_mapper.find(topic.id).creator.should eq user.id
+    describe 'referenced relationships' do
+      let(:creator) { topic_mapper.find(topic.id).creator }
+      subject { creator }
+
+      it { should be_a Perpetuity::Reference }
+      its(:klass) { should be User }
+      its(:id) { should be == user.id }
     end
 
     it 'can retrieve associated objects' do
-      retrieved_topic = topic_mapper.first
+      retrieved_topic = topic_mapper.find(topic.id)
 
       topic_mapper.load_association! retrieved_topic, :creator
       retrieved_topic.creator.name.should eq 'Flump'
@@ -290,4 +295,62 @@ describe Perpetuity do
     saved_message.instance_variable_get(:@text).should eq 'My Message!'.reverse
     saved_message.text.should eq 'My Message!'
   end
+
+  describe 'serialization' do
+    let(:author) { User.new 'username' }
+    let(:comment) { Comment.new }
+    let(:article) { Article.new }
+    let(:mapper) { Perpetuity[Article] }
+    let(:serialized_value) do
+      {
+        'title' => article.title,
+        'body' => article.body,
+        'author' => {
+          '__metadata__' => {
+            'class' => author.class.to_s,
+            'id' => author.id
+          }
+        },
+        'comments' => [
+          {
+            '__metadata__' => {
+              'class' => comment.class.to_s
+            },
+            'body' => comment.body,
+            'author' => {
+              '__metadata__' => {
+                'class' => author.class.to_s,
+                'id' => author.id
+              }
+            }
+          },
+        ],
+        'published_at' => article.published_at,
+        'views' => article.views
+      } 
+    end
+
+    before do
+      article.author = author
+      article.comments = [comment]
+      comment.author = author
+
+      Perpetuity[User].insert author
+      Perpetuity[Article].insert article
+    end
+
+    it 'serializes objects into hashes' do
+      mapper.serialize(article).should be == serialized_value
+    end
+
+    it 'deserializes hashes into proper objects' do
+      unserialized = mapper.find article.id
+      unserialized.should be_a Article
+      unserialized.title.should be == article.title
+      unserialized.body.should be == article.body
+      unserialized.comments.first.tap do |unserialized_comment|
+        unserialized_comment.body.should be == comment.body
+      end
+    end
+  end
 end

data/spec/test_classes.rb

@@ -1,8 +1,20 @@
+class User
+  attr_accessor :name
+  def initialize name="Foo"
+    @name = name
+  end
+end
+
+Perpetuity.generate_mapper_for User do
+  attribute :name, String
+end
+
 class Article
-  attr_accessor :title, :body, :comments, :published_at, :views
+  attr_accessor :title, :body, :author, :comments, :published_at, :views
   def initialize title="Title", body="Body", author=nil, published_at=Time.now, views=0
     @title = title
     @body = body
+    @author = author
     @comments = []
     @published_at = published_at
     @views = views
@@ -12,31 +24,23 @@ end
 Perpetuity.generate_mapper_for(Article) do
   attribute :title, String
   attribute :body, String
+  attribute :author, User
   attribute :comments, Array, embedded: true
   attribute :published_at, Time
   attribute :views, Integer
 end
 
 class Comment
-  attr_reader :body
-  def initialize body='Body'
+  attr_accessor :body, :author
+  def initialize body='Body', author=nil
     @body = body
+    @author = author
   end
 end
 
 Perpetuity.generate_mapper_for(Comment) do
   attribute :body, String
-end
-
-class User
-  attr_accessor :name
-  def initialize name="Foo"
-    @name = name
-  end
-end
-
-Perpetuity.generate_mapper_for User do
-  attribute :name, String
+  attribute :author, User
 end
 
 class Book

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perpetuity
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-22 00:00:00.000000000 Z
+date: 2012-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -91,8 +91,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Persistence library allowing persistence of Ruby objects without adding
-  persistence concerns to domain objects.
+description: Persistence layer Ruby objects
 email:
 - jgaskins@gmail.com
 executables: []
@@ -117,6 +116,7 @@ files:
 - lib/perpetuity/mongodb/query.rb
 - lib/perpetuity/mongodb/query_attribute.rb
 - lib/perpetuity/mongodb/query_expression.rb
+- lib/perpetuity/reference.rb
 - lib/perpetuity/retrieval.rb
 - lib/perpetuity/validations.rb
 - lib/perpetuity/validations/length.rb
@@ -133,6 +133,7 @@ files:
 - spec/perpetuity/mongodb/query_expression_spec.rb
 - spec/perpetuity/mongodb/query_spec.rb
 - spec/perpetuity/mongodb_spec.rb
+- spec/perpetuity/reference_spec.rb
 - spec/perpetuity/retrieval_spec.rb
 - spec/perpetuity/validations/length_spec.rb
 - spec/perpetuity/validations/presence_spec.rb
@@ -162,7 +163,7 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Persistence library allowing persistence of Ruby objects
+summary: Persistence library allowing serialization of Ruby objects
 test_files:
 - spec/perpetuity/attribute_set_spec.rb
 - spec/perpetuity/attribute_spec.rb
@@ -173,6 +174,7 @@ test_files:
 - spec/perpetuity/mongodb/query_expression_spec.rb
 - spec/perpetuity/mongodb/query_spec.rb
 - spec/perpetuity/mongodb_spec.rb
+- spec/perpetuity/reference_spec.rb
 - spec/perpetuity/retrieval_spec.rb
 - spec/perpetuity/validations/length_spec.rb
 - spec/perpetuity/validations/presence_spec.rb