mordor 0.2.1 → 0.2.2

data/README.md

@@ -8,6 +8,7 @@ class ExampleResource
   attribute :first, :index => true
   attribute :second
   attribute :third, :finder_method => :find_by_third_attribute
+  attribute :at,    :timestamp => true
 end
 ```
 
@@ -17,3 +18,8 @@ as can be seen with the third attribute.
 
 When the `:index => true` option is set, indices are ensured before each query on 
 the collection. Indices are descending by default, but this can be changed by also supplying a `:index_type => Mongo::ASCENDING` option.
+
+At most one attribute per Resource can have the option `:timestamp => true` set. This means that the attribute will be saved as one of the two first 
+attributes (the other one being the `_id` attribute. When no value is given for the timestamped attribute, a timestamp with value 0 will be inserted,
+which results in a timestamp being assigned to it by the MongoDB.
+An exception is raised when more than one attribute is given the timestamp option

data/lib/mordor/resource.rb

@@ -52,10 +52,29 @@ module Mordor
       return !new?
     end
 
+    def reload
+      return unless _id
+      res = self.class.get(_id).to_hash.each do |k, v|
+        self.send("#{k}=".to_sym, v)
+      end
+      self
+    end
+
     def save
       unless self._id
-        insert_id = self.class.collection.insert(self.to_hash)
+        self_hash = self.to_hash
+        if timestamp_attribute = self.class.timestamped_attribute
+          timestamp_value = self_hash.delete(timestamp_attribute)
+          ordered_self_hash = BSON::OrderedHash.new
+          ordered_self_hash[timestamp_attribute] = (timestamp_value.nil? || timestamp_value.empty?) ? BSON::Timestamp.new(0, 0) : timestamp_value
+          self_hash.each do |key, value|
+            ordered_self_hash[key] = value
+          end
+          self_hash = ordered_self_hash
+        end
+        insert_id = self.class.collection.insert(self_hash)
         self._id = insert_id
+        self.reload
       else
         insert_id = self.update
       end
@@ -148,6 +167,9 @@ module Mordor
         Collection.new(self, cursor)
       end
 
+      def timestamped_attribute
+        @timestamped_attribute
+      end
 
       def attribute(name, options = {})
         @attributes  ||= []
@@ -160,6 +182,11 @@ module Mordor
           @index_types[name] = options[:index_type] ? options[:index_type] : Mongo::DESCENDING
         end
 
+        if options[:timestamp]
+          raise ArgumentError.new("Only one timestamped attribute is allowed, '#{@timestamped_attribute}' is already timestamped") unless @timestamped_attribute.nil?
+          @timestamped_attribute = name
+        end
+
         method_name = options.key?(:finder_method) ? options[:finder_method] : "find_by_#{name}"
 
         class_eval <<-EOS, __FILE__, __LINE__

data/mordor.gemspec

@@ -2,8 +2,8 @@ Gem::Specification.new do |s|
   s.name    = "mordor"
   
   # Do not set the version and date field manually, this is done by the release script
-  s.version = "0.2.1"
-  s.date    = "2011-12-27"
+  s.version = "0.2.2"
+  s.date    = "2011-12-28"
 
   s.summary     = "mordor"
   s.description = <<-eos

data/spec/mordor/resource_spec.rb

@@ -2,19 +2,20 @@ require File.join(File.dirname(__FILE__), '..', '/spec_helper.rb')
 
 describe "with respect to resources" do
   before :each do
+    Object.send(:remove_const, :TestResource) if Object.const_defined?(:TestResource)
     class TestResource
       include Mordor::Resource
 
       attribute :first,  :index => true
       attribute :second, :index => true, :index_type => Mongo::ASCENDING
       attribute :third,  :finder_method => :find_by_third_attribute
+      attribute :at,     :timestamp => true
 
       # Put this in here again to ensure the original method is still here
       class_eval do
         def self.ensure_indices
           collection.ensure_index( indices.map{|index| [index.to_s, Mongo::DESCENDING]} ) if indices.any?
         end
-
       end
     end
   end
@@ -49,6 +50,10 @@ describe "with respect to resources" do
 
   it "should call ensure_index on the collection for each index when a query is performed" do
     TestResource.class_eval do
+      def self.reset_ensure_count
+        @count = 0
+      end
+
       def self.ensure_count
         @count ||= 0
       end
@@ -70,10 +75,31 @@ describe "with respect to resources" do
       end
     end
     TestResource.create({:first => 'first', :second => 'second', :third => 'third'})
+    TestResource.reset_ensure_count
     TestResource.all()
     TestResource.ensure_count.should == 1
   end
 
+  it "should be possible to designate an attribute as a timestamp" do
+    TestResource.timestamped_attribute.should_not be_nil
+    TestResource.timestamped_attribute.should == :at
+  end
+
+  it "should only be possible to have one attribute as a timestamp" do
+    lambda {
+      TestResource2.class_eval do
+        attribute :some_timestamp, :timestamp => true
+        attribute :another_timestamp, :timestamp => true
+      end
+    }.should raise_error
+  end
+
+  it "should provide timestamped attribute as first attribute when creating a Resource" do
+    tr = TestResource.create({:first => 'first'})
+    tr.at.should_not be_nil
+    TestResource.get(tr._id).at.should_not == BSON::Timestamp.new(0,0)
+  end
+
   context "with respect to replacing params" do
     before :each do
       clean_sheet
@@ -111,7 +137,7 @@ describe "with respect to resources" do
     it "should correctly respond to to_hash" do
       resource = TestResource.new({:first => "first", :second => "second", :third => "third"})
       hash = resource.to_hash
-      hash.size.should     == 3
+      hash.size.should     == 4
       hash[:first].should  == "first"
       hash[:second].should == "second"
       hash[:third].should  == "third"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mordor
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Jan-Willem Koelewijn
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-27 00:00:00 +01:00
+date: 2011-12-28 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency