mark_mapper 0.0.1

data/spec/unit/serializers/json_serializer_spec.rb

@@ -0,0 +1,218 @@
+require 'spec_helper'
+
+module JsonSerialization
+  describe "JsonSerialization" do
+
+    # Helper function in case things change in the future
+    # - replacing all those to_json calls was a nightmare
+    def convert_to_json(object, options={})
+      ActiveSupport::JSON.encode(object, options)
+    end
+
+    class Tag
+      include MarkMapper::EmbeddedDocument
+      key :name, String
+    end
+
+    class Contact
+      include MarkMapper::Document
+      key :name, String
+      key :age, Integer
+      key :created_at, Time
+      key :awesome, Boolean
+      key :preferences, Hash
+
+      many :tags, :class_name => 'JsonSerialization::Tag'
+    end
+
+    before do
+      Kernel.const_set('TopLevelContact', Doc('TopLevelContact'))
+      TopLevelContact.key :name, String
+
+      Contact.include_root_in_json = false
+      @contact = Contact.new(
+        :name        => 'Konata Izumi',
+        :age         => 16,
+        :created_at  => Time.utc(2006, 8, 1),
+        :awesome     => true,
+        :preferences => { :shows => 'anime' }
+      )
+      @top_level_contact = TopLevelContact.new(
+        :name        => 'Konata Izumi'
+      )
+    end
+
+    after do
+      Kernel.send(:remove_const, 'TopLevelContact') if Object.const_defined?('TopLevelContact')
+    end
+
+    it "should include root for class with no module" do
+      TopLevelContact.include_root_in_json = true
+      convert_to_json(@top_level_contact).should match %r{^\{"top_level_contact":\s?\{}
+    end
+
+    it "should include demodulized root" do
+      Contact.include_root_in_json = true
+      convert_to_json(@contact).should match %r{^\{"contact":\s?\{}
+    end
+
+    it "should encode all encodable attributes" do
+      json = convert_to_json(@contact)
+
+      json.should_not match %r{"_id"}
+      json.should match %r{"name":"Konata Izumi"}
+      json.should match %r{"age":16}
+      json.should include(%("created_at":#{ActiveSupport::JSON.encode(Time.utc(2006, 8, 1))}))
+      json.should match %r{"awesome":true}
+      json.should match %r{"preferences":\{"shows":"anime"\}}
+    end
+
+    it "should allow attribute filtering with only" do
+      json = convert_to_json(@contact, :only => [:name, :age])
+
+      json.should_not match %r{"_id"}
+      json.should match %r{"name":"Konata Izumi"}
+      json.should match %r{"age":16}
+      json.should_not match %r{"awesome"}
+      json.should_not match %r{"created_at"}
+      json.should_not match %r{"preferences"}
+    end
+
+    it "should allow attribute filtering with except" do
+      json = convert_to_json(@contact, :except => [:name, :age])
+
+      json.should_not match %r{"_id"}
+      json.should_not match %r{"name"}
+      json.should_not match %r{"age"}
+      json.should match %r{"awesome"}
+      json.should match %r{"created_at"}
+      json.should match %r{"preferences"}
+    end
+
+    context "_id key" do
+      it "should not be included by default" do
+        json = convert_to_json(@contact)
+        json.should_not match %r{"_id":}
+      end
+
+      it "should not be included even if :except is used" do
+        json = convert_to_json(@contact, :except => :name)
+        json.should_not match %r{"_id":}
+      end
+    end
+
+    context "id method" do
+      before do
+        def @contact.label; "Has cheezburger"; end
+        def @contact.favorite_quote; "Constraints are liberating"; end
+      end
+
+      it "should be included by default" do
+        json = convert_to_json(@contact)
+        json.should match %r{"id"}
+      end
+
+      it "should be included when single method included" do
+        json = convert_to_json(@contact, :methods => :label)
+        json.should match %r{"id"}
+        json.should match %r{"label":"Has cheezburger"}
+        json.should match %r{"name":"Konata Izumi"}
+        json.should_not match %r{"favorite_quote":"Constraints are liberating"}
+      end
+
+      it "should be included when multiple methods included" do
+        json = convert_to_json(@contact, :methods => [:label, :favorite_quote])
+        json.should match %r{"id"}
+        json.should match %r{"label":"Has cheezburger"}
+        json.should match %r{"favorite_quote":"Constraints are liberating"}
+        json.should match %r{"name":"Konata Izumi"}
+      end
+
+      it "should not be included if :only is present" do
+        json = convert_to_json(@contact, :only => :name)
+        json.should_not match %r{"id":}
+      end
+
+      it "should be represented by a string" do
+        json = convert_to_json(@contact)
+        json.should match %r{"id":"}
+      end
+    end
+
+    context "including methods" do
+      before do
+        def @contact.label; "Has cheezburger"; end
+        def @contact.favorite_quote; "Constraints are liberating"; end
+      end
+
+      it "should include single method" do
+        json = convert_to_json(@contact, :methods => :label)
+        json.should match %r{"label":"Has cheezburger"}
+      end
+
+      it "should include multiple methods" do
+        json = convert_to_json(@contact, :only => :name, :methods => [:label, :favorite_quote])
+        json.should match %r{"label":"Has cheezburger"}
+        json.should match %r{"favorite_quote":"Constraints are liberating"}
+        json.should match %r{"name":"Konata Izumi"}
+        json.should_not match %r{"age":16}
+        json.should_not match %r{"awesome"}
+        json.should_not match %r{"created_at"}
+        json.should_not match %r{"preferences"}
+      end
+    end
+
+    context "array of records" do
+      before do
+        @contacts = [
+          Contact.new(:name => 'David', :age => 39),
+          Contact.new(:name => 'Mary', :age => 14)
+        ]
+      end
+
+      it "should allow attribute filtering with only" do
+        json =convert_to_json(@contacts, :only => :name)
+        json.should match %r{\{"name":"David"\}}
+        json.should match %r{\{"name":"Mary"\}}
+      end
+
+      it "should allow attribute filtering with except" do
+        json = convert_to_json(@contacts, :except => [:name, :preferences, :awesome, :created_at, :updated_at])
+        json.should match %r{"age":39}
+        json.should match %r{"age":14}
+        json.should_not match %r{"name":}
+        json.should_not match %r{"preferences":}
+        json.should_not match %r{"awesome":}
+        json.should_not match %r{"created_at":}
+        json.should_not match %r{"updated_at":}
+      end
+    end
+
+    it "should allow options for hash of records" do
+      contacts = {
+        1 => Contact.new(:name => 'David', :age => 39),
+        2 => Contact.new(:name => 'Mary', :age => 14)
+      }
+      json = convert_to_json(contacts, :only => [1, :name])
+      json.should match %r{"1":}
+      json.should match %r{\{"name":"David"\}}
+      json.should_not match %r{"2":}
+    end
+
+    it "should include embedded attributes" do
+      contact = Contact.new(:name => 'John', :age => 27)
+      contact.tags = [Tag.new(:name => 'awesome'), Tag.new(:name => 'ruby')]
+      json = convert_to_json(contact)
+      json.should match %r{"tags":}
+      json.should match %r{"name":"awesome"}
+      json.should match %r{"name":"ruby"}
+    end
+
+    it "should include dynamic attributes" do
+      contact = Contact.new(:name => 'John', :age => 27, :foo => 'bar')
+      contact['smell'] = 'stinky'
+      json = convert_to_json(contact)
+      json.should match %r{"smell":"stinky"}
+    end
+  end
+end

data/spec/unit/serializers/xml_serializer_spec.rb

@@ -0,0 +1,198 @@
+require 'spec_helper'
+
+module XmlSerialization
+  describe "XmlSerialization" do
+    class Tag
+      include MarkMapper::EmbeddedDocument
+      key :name, String
+    end
+
+    class Contact
+      include MarkMapper::Document
+      key :name, String
+      key :age, Integer
+      key :created_at, Time
+      key :awesome, Boolean
+      key :preferences, Hash
+
+      many :tags, :class_name => 'XmlSerialization::Tag'
+    end
+
+    before do
+      Kernel.const_set('TopLevelContact', Doc('TopLevelContact'))
+      TopLevelContact.key :name, String
+
+      Contact.include_root_in_json = false
+      @contact = Contact.new(
+        :name        => 'Konata Izumi',
+        :age         => 16,
+        :created_at  => Time.utc(2006, 8, 1),
+        :awesome     => true,
+        :preferences => { :shows => 'anime' }
+      )
+      @top_level_contact = TopLevelContact.new(
+        :name        => 'Konata Izumi'
+      )
+    end
+
+    after do
+      Kernel.send(:remove_const, 'TopLevelContact') if Object.const_defined?('TopLevelContact')
+    end
+
+    it "should include root for class with no module" do
+      @top_level_contact.to_xml.should match %r{<top-level-contact>}
+    end
+
+    it "should include demodulized root" do
+      @contact.to_xml.should match %r{<contact>}
+    end
+
+    it "should encode all encodable attributes" do
+      xml = @contact.to_xml
+
+      xml.should_not match %r{_id}
+      xml.should match %r{<id>#{@contact.id}</id>}
+      xml.should match %r{<name>Konata Izumi</name>}
+      xml.should match %r{<age.*>16</age>}
+      xml.should match %r(<created-at type="date[tT]ime">)
+      xml.should match %r{<awesome type="boolean">true</awesome>}
+      xml.should match %r{<preferences>}
+      xml.should match %r{<shows>anime</shows>}
+    end
+
+    it "should allow attribute filtering with only" do
+      xml = @contact.to_xml(:only => [:name, :age])
+
+      xml.should match %r{<name>Konata Izumi</name>}
+      xml.should match %r{<age type="integer">16</age>}
+      xml.should_not match %r{<id>}
+      xml.should_not match %r{awesome}
+      xml.should_not match %r{created-at}
+      xml.should_not match %r{preferences}
+    end
+
+    it "should allow attribute filtering with except" do
+      xml = @contact.to_xml(:except => [:name, :age])
+
+      xml.should_not match %r{<name>Konata Izumi</name>}
+      xml.should_not match %r{<age type="integer">16</age>}
+      xml.should match %r{<id>}
+      xml.should match %r{awesome}
+      xml.should match %r{created-at}
+      xml.should match %r{preferences}
+    end
+
+    context "_id key" do
+      it "should not be included by default" do
+        @contact.to_xml.should_not match %r{_id}
+      end
+
+      it "should not be included even if :except is used" do
+        @contact.to_xml(:except => :name).should_not match %r{_id}
+      end
+    end
+
+    context "id method" do
+      before do
+        def @contact.label; "Has cheezburger"; end
+        def @contact.favorite_quote; "Constraints are liberating"; end
+      end
+
+      it "should be included by default" do
+        @contact.to_xml.should match %r{<id>#{@contact.id}</id>}
+      end
+
+      it "should be included when single method included" do
+        xml = @contact.to_xml(:methods => :label)
+        xml.should match %r{<id>}
+        xml.should match %r{<label>Has cheezburger</label>}
+        xml.should match %r{<name>Konata Izumi</name>}
+        xml.should_not match %r{favorite_quote}
+      end
+
+      it "should be included when multiple methods included" do
+        xml = @contact.to_xml(:methods => [:label, :favorite_quote])
+        xml.should match %r{<id>}
+        xml.should match %r{<label>Has cheezburger</label>}
+        xml.should match %r{<name>Konata Izumi</name>}
+        xml.should match %r{<favorite-quote>Constraints are liberating</favorite-quote>}
+      end
+
+      it "should not be included if :only is present" do
+        @contact.to_xml(:only => :name).should_not match %r{<id}
+      end
+
+      it "should be represented by a string" do
+        @contact.to_xml.should match %r{<id>}
+      end
+    end
+
+    context "including methods" do
+      before do
+        def @contact.label; "Has cheezburger"; end
+        def @contact.favorite_quote; "Constraints are liberating"; end
+      end
+
+      it "should include single method" do
+        @contact.to_xml(:methods => :label).should match %r{<label>Has cheezburger</label>}
+      end
+
+      it "should include multiple methods" do
+        xml = @contact.to_xml(:only => :name, :methods => [:label, :favorite_quote])
+        xml.should match %r{<label>Has cheezburger</label>}
+        xml.should match %r{<favorite-quote>Constraints are liberating</favorite-quote>}
+        xml.should match %r{<name>Konata Izumi</name>}
+        xml.should_not match %r{age}
+        xml.should_not match %r{awesome}
+        xml.should_not match %r{created-at}
+        xml.should_not match %r{preferences}
+
+        # Assert only one tag is created
+        xml.scan(/favorite-quote/).size.should == 2
+      end
+    end
+
+    context "array of records" do
+      before do
+        @contacts = [
+          Contact.new(:name => 'David', :age => 39),
+          Contact.new(:name => 'Mary', :age => 14)
+        ]
+      end
+
+      it "should allow attribute filtering with only" do
+        xml = @contacts.to_xml(:only => :name)
+        xml.should match %r{<name>David</name>}
+        xml.should match %r{<name>Mary</name>}
+      end
+
+      it "should allow attribute filtering with except" do
+        xml = @contacts.to_xml(:except => [:name, :preferences, :awesome, :created_at, :updated_at])
+        xml.should match %r{<age type="integer">14</age>}
+        xml.should match %r{<age type="integer">39</age>}
+        xml.should_not match %r{name}
+        xml.should_not match %r{preferences}
+        xml.should_not match %r{awesome}
+        xml.should_not match %r{created-at}
+        xml.should_not match %r{updated-at}
+      end
+    end
+
+    it "should include embedded attributes" do
+      contact = Contact.new(:name => 'John', :age => 27)
+      contact.tags = [Tag.new(:name => 'awesome'), Tag.new(:name => 'ruby')]
+      xml = contact.to_xml
+      xml.should match %r{<tags type="array">}
+      xml.should match %r{<id>#{contact.tags[0].id}</id>}
+      xml.should match %r{<id>#{contact.tags[1].id}</id>}
+      xml.should match %r{<name>awesome</name>}
+      xml.should match %r{<name>ruby</name>}
+    end
+
+    it "should include dynamic attributes" do
+      contact = Contact.new(:name => 'John', :age => 27, :foo => 'bar')
+      contact['smell'] = 'stinky'
+      contact.to_xml.should match %r{<smell>stinky</smell>}
+    end
+  end
+end

data/spec/unit/time_zones_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe "TimeZones" do
+  context "An instance of an embedded document" do
+    before do
+      @document = EDoc do
+        key :name, String
+        key :created_at, Time
+      end
+    end
+
+    # it "should preserve milliseconds" do
+    #   doc = @document.new(:created_at => '2011-02-12 16:01:02.543Z')
+    #   doc.created_at.should be_within(0.0000001).of(Time.parse('2011-02-12 16:01:02.543Z'))
+    # end
+
+    it "should work without Time.zone" do
+      Time.zone = nil
+
+      doc = @document.new(:created_at => "2009-08-15 14:00:00")
+      doc.created_at.should == Time.local(2009, 8, 15, 14, 0, 0).utc
+    end
+
+    it "should work with Time.zone set to the (default) UTC" do
+      Time.zone = 'UTC'
+
+      doc = @document.new(:created_at => "2009-08-15 14:00:00")
+      doc.created_at.is_a?(ActiveSupport::TimeWithZone).should be_truthy
+      doc.created_at.should == Time.utc(2009, 8, 15, 14)
+
+      Time.zone = nil
+    end
+
+    it "should work with timezones that are not UTC" do
+      Time.zone = 'Hawaii'
+
+      doc = @document.new(:created_at => "2009-08-15 14:00:00")
+      doc.created_at.is_a?(ActiveSupport::TimeWithZone).should be_truthy
+      doc.created_at.should == Time.utc(2009, 8, 16)
+
+      Time.zone = nil
+    end
+  end
+end