mongoid-history 0.1.0 → 0.1.1

data/README.rdoc

@@ -103,6 +103,11 @@ Here is a quick example on how to use this plugin. For more details, please look
   
   # undelete post
   post.undo! @user
+  
+  # disable tracking for comments within a block
+  Comment.disable_tracking do
+    comment.update_attributes(:title => "Test 3")
+  end
 
 == Contributing to mongoid-history
  

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/mongoid-history.rb

@@ -4,6 +4,6 @@ require File.expand_path(File.dirname(__FILE__) + '/mongoid/history')
 require File.expand_path(File.dirname(__FILE__) + '/mongoid/history/tracker')
 require File.expand_path(File.dirname(__FILE__) + '/mongoid/history/trackable')
 
-Mongoid::History.modifer_class_name = "User"
+Mongoid::History.modifier_class_name = "User"
 Mongoid::History.trackable_classes = []
-Mongoid::History.trackable_class_options = {}
+Mongoid::History.trackable_class_options = {}

data/lib/mongoid/history.rb

@@ -3,11 +3,11 @@ module Mongoid
     mattr_accessor :tracker_class_name
     mattr_accessor :trackable_classes
     mattr_accessor :trackable_class_options
-    mattr_accessor :modifer_class_name
+    mattr_accessor :modifier_class_name
     
     def self.tracker_class
       @tracker_class ||= tracker_class_name.to_s.classify.constantize
     end
 
   end
-end
+end

data/lib/mongoid/history/trackable.rb

@@ -33,7 +33,7 @@ module Mongoid::History
         end
 
         field options[:version_field].to_sym, :type => Integer
-        referenced_in options[:modifier_field].to_sym, :class_name => Mongoid::History.modifer_class_name
+        referenced_in options[:modifier_field].to_sym, :class_name => Mongoid::History.modifier_class_name
 
         include InstanceMethods
         extend SingletonMethods
@@ -49,17 +49,24 @@ module Mongoid::History
         Mongoid::History.trackable_classes << self
         Mongoid::History.trackable_class_options ||= {}
         Mongoid::History.trackable_class_options[model_name] = options
-        Thread.current[:mongoid_history_trackable_enabled] = true
       end
-
+      
       def track_history?
-        !!Thread.current[:mongoid_history_trackable_enabled]
+        enabled = Thread.current[track_history_flag]
+        enabled.nil? ? true : enabled
       end
 
       def disable_tracking(&block)
-        Thread.current[:mongoid_history_trackable_enabled] = false
-        yield
-        Thread.current[:mongoid_history_trackable_enabled] = true
+        begin
+          Thread.current[track_history_flag] = false
+          yield
+        ensure
+          Thread.current[track_history_flag] = true
+        end
+      end
+      
+      def track_history_flag
+        "mongoid_history_#{self.name.underscore}_trackable_enabled".to_sym
       end
     end
 

data/lib/mongoid/history/tracker.rb

@@ -12,7 +12,7 @@ module Mongoid::History
       field       :version,                 :type => Integer
       field       :action,                  :type => String
       field       :scope,                   :type => String
-      referenced_in :modifier,              :class_name => Mongoid::History.modifer_class_name
+      referenced_in :modifier,              :class_name => Mongoid::History.modifier_class_name
 
       Mongoid::History.tracker_class_name = self.name.tableize.singularize.to_sym
     end

data/mongoid-history.gemspec

@@ -5,15 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid-history}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Aaron Qian", "Justin Grimes"]
-  s.date = %q{2011-05-13}
+  s.authors = [%q{Aaron Qian}, %q{Justin Grimes}]
+  s.date = %q{2011-05-25}
   s.description = %q{In frustration of Mongoid::Versioning, I created this plugin for tracking historical changes for any document, including embedded ones. It achieves this by storing all history tracks in a single collection that you define. (See Usage for more details) Embedded documents are referenced by storing an association path, which is an array of document_name and document_id fields starting from the top most parent document and down to the embedded document that should track history.
 
   This plugin implements multi-user undo, which allows users to undo any history change in any order. Undoing a document also creates a new history track. This is great for auditing and preventing vandalism, but it is probably not suitable for use cases such as a wiki.}
-  s.email = ["aq1018@gmail.com", "justin.mgrimes@gmail.com"]
+  s.email = [%q{aq1018@gmail.com}, %q{justin.mgrimes@gmail.com}]
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
@@ -38,9 +38,9 @@ Gem::Specification.new do |s|
     "spec/tracker_spec.rb"
   ]
   s.homepage = %q{http://github.com/aq1018/mongoid-history}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.3}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.3}
   s.summary = %q{history tracking, auditing, undo, redo for mongoid}
   s.test_files = [
     "spec/integration/integration_spec.rb",

data/spec/trackable_spec.rb

@@ -72,5 +72,42 @@ describe Mongoid::History::Trackable do
     it "should define #history_trackable_options" do
       MyModel.history_trackable_options.should == @expected_option
     end
+
+    context "track_history" do
+    
+      it "should be enabled on the current thread" do
+        MyModel.new.track_history?.should == true
+      end
+      
+      it "should be disabled within disable_tracking" do
+        MyModel.disable_tracking do
+          MyModel.new.track_history?.should == false
+        end
+      end
+      
+      it "should be rescued if an exception occurs" do
+        begin
+          MyModel.disable_tracking do
+            raise "exception"
+          end
+        rescue
+        end
+        MyModel.new.track_history?.should == true
+      end
+      
+      it "should be disabled only for the class that calls disable_tracking" do
+        class MyModel2
+          include Mongoid::Document
+          include Mongoid::History::Trackable
+          track_history
+        end
+        
+        MyModel.disable_tracking do
+          MyModel2.new.track_history?.should == true
+        end      
+      end
+    
+    end
+    
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: mongoid-history
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Aaron Qian
@@ -11,8 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-13 00:00:00 -07:00
-default_executable: 
+date: 2011-05-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: easy_diff
@@ -156,7 +155,6 @@ files:
 - spec/spec_helper.rb
 - spec/trackable_spec.rb
 - spec/tracker_spec.rb
-has_rdoc: true
 homepage: http://github.com/aq1018/mongoid-history
 licenses: 
 - MIT
@@ -170,7 +168,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1260875336228097140
+      hash: 2593170872748444504
       segments: 
       - 0
       version: "0"
@@ -183,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 1.8.3
 signing_key: 
 specification_version: 3
 summary: history tracking, auditing, undo, redo for mongoid