mongoid-tll 0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011 Joris van Rooij
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+Mongoid Top Linked List
+=======================
+
+A relatively simple module that provides a doubly top linked list for your
+documents. Every change creates a new document, with a link to the old one.
+All the documents have a link to the newest document. This setup should
+provide better performance in applications that usually need the newest
+version.
+
+An example:
+
+    class MyDocument
+      include Mongoid::Document
+      include Mongoid::TLL
+      
+      field :data
+    end
+    
+    @doc = MyDocument.create(data: "first version")
+    @doc.data = "second version"
+    @doc.save
+    
+    @doc.data
+    >> "second version"
+    @doc.prev.data
+    >> "first version"
+
+A default scope is added to only find the newest versions by default. Use
+the `scopeless` method to circumvent this.
+
+Other helper methods have been added:
+
+* `newest` - Returns the newest version of the document.
+* `newest?` - Is this the newest version?
+* `oldest?` - Is this the oldest (original) version?
+* `prev` - Returns the previous version of the document.
+

data/lib/mongoid/tll.rb

@@ -0,0 +1,68 @@
+module Mongoid
+
+  # Include this module to have documents automatically cloned when
+  # updated. It constructs a top linked list (like a doubly linked list
+  # with a pointer to the newest version) out of the chain of documents.
+  # Only use this when in 99% of the time only the newest version of a
+  # document is read! Mongoid::Versioning will take care of all the
+  # other usecases.
+  module TLL
+    def self.included(klass)
+      klass.class_exec do
+        
+        # The linked list pointers.
+        field :tll_top
+        field :tll_prev
+
+        # By default, get the newest only.
+        default_scope where: {tll_top: nil}
+        
+        set_callback :save, :before, :tll_commit
+        attr_protected :tll_top, :tll_prev
+        
+        # Function that is called before saving a document.
+        # It's responsible for the versioning.
+        def tll_commit
+          oldself = self.class.unscoped.where(_id: id).first
+          if oldself # We've got a previous saved document.
+            self.class.unscoped.where(tll_top: oldself._id)\
+              .update_all(tll_top: id)
+            oldself = oldself.clone
+            oldself.tll_top = id
+            self.tll_prev = oldself._id
+            oldself.save
+          end
+        end
+        
+        # Is this the newest version?
+        def newest?
+          self.tll_top.nil?
+        end
+        
+        # Return the newest version.
+        def newest
+          unless self.tll_top.nil?
+            return self.class.unscoped.where(_id: self.tll_top).first
+          end
+
+          self
+        end
+        
+        # Is this the oldest version?
+        def oldest?
+          self.tll_prev.nil?
+        end
+        
+        # Return the previous version, if there is any.
+        # Will return nil when #oldest? is true.
+        def prev
+          unless self.tll_prev.nil?
+            return self.class.unscoped.where(_id: self.tll_prev).first
+          end
+
+          nil
+        end
+      end
+    end
+  end
+end

data/test/mongoid-tll.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby1.9.1
+
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'mongoid'
+require 'mongoid-tll'
+require 'test/unit'
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db "testing"
+  config.persist_in_safe_mode = false
+end
+
+class MyDocument
+  include Mongoid::Document
+  include Mongoid::TLL
+
+  field :content
+end
+
+class TestMongoidTLL < Test::Unit::TestCase
+  def setup
+    @doc = MyDocument.create(content: "first version")
+  end
+
+  def teardown
+    MyDocument.delete_all
+  end
+
+  def test_basic_attributes
+    assert_kind_of Mongoid::TLL, @doc
+    assert_respond_to @doc, :content
+    assert_equal "first version", @doc.content
+  end
+
+  def test_extended_attributes
+    assert_respond_to @doc, :newest?
+    assert_respond_to @doc, :newest
+    assert_respond_to @doc, :oldest?
+    assert_respond_to @doc, :prev
+  end
+
+  def test_add_version
+    @doc.content = "second version"
+    @doc.save
+    assert @doc.newest?
+    assert !@doc.oldest?
+    assert_kind_of Mongoid::TLL, @doc.prev
+    assert_equal "first version", @doc.prev.content
+    assert @doc.prev.oldest?
+    assert !@doc.prev.newest?
+  end
+
+  def test_add_version_twice
+    @doc.content = "second version"
+    @doc.save
+    @doc.content = "third version"
+    @doc.save
+
+    assert @doc.newest?
+    assert_equal "second version", @doc.prev.content
+    assert_equal "first version", @doc.prev.prev.content
+    assert_equal "third version", @doc.prev.newest.content
+    assert_equal "third version", @doc.prev.prev.newest.content
+    assert_equal nil, @doc.prev.prev.prev
+  end
+
+  def test_query_only_newest
+    @doc.content = "first document, second version"
+    @doc.save
+    @doc2 = MyDocument.create(content: "second document, first version")
+    @doc2.content = "second document, second version"
+    @doc2.save
+
+    assert_equal 2, MyDocument.count
+    assert_equal 4, MyDocument.unscoped.count
+
+    t = ["first document, second version", "second document, second version"]
+    MyDocument.all.each_with_index do |d, i|
+      assert_equal t[i], d.content
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid-tll
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Joris van Rooij
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-09 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id001
+description: Creates a (doubly) top linked list out of your documents. Every change makes a new revision. Basically a read optimized versioning system.
+email: jorrizza@jrrzz.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/mongoid/tll.rb
+- LICENSE
+- README.md
+- test/mongoid-tll.rb
+has_rdoc: true
+homepage: https://github.com/jorrizza/mongoid-tll
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Top linked list plugin for Mongoid
+test_files: 
+- test/mongoid-tll.rb