mongoid-history 0.1.4 → 0.1.5

data/README.rdoc

@@ -18,12 +18,29 @@ In your Gemfile:
 
 Here is a quick example on how to use this plugin. For more details, please look at spec/integration/integration_spec.rb. It offers more detailed examples on how to use Mongoid::History.
 
-  # Create a new class for tracking all histories.
-  # Must include Mongoid::History::Tracker
+=== Create a History Tracker
+
+Create a new class to track histories. All histories are stored in this tracker. The name of the class can be anything you like. The only requirement is that it includes `Mongoid::History::Tracker`
+
+  # app/models/history_tracker.rb
   class HistoryTracker
     include Mongoid::History::Tracker
   end
 
+=== Set Tracker Class Name
+
+You should manually set the tracker class name to make sure your tracker can be found and loaded properly. You can skip this step if you manually require your tracker before using any trackables. If you don't know what I'm talking about, then you should just follow the example below.
+
+Here is an example of setting the tracker class name using a rails initializer
+
+  # config/initializers/mongoid-history.rb
+  # initializer for mongoid-history
+  # assuming HistoryTracker is your tracker class
+  Mongoid::History.tracker_class_name = :history_tracker
+
+
+=== Create Trackable classes and objects
+
   class Post
     include Mongoid::Document
     include Mongoid::Timestamps
@@ -62,7 +79,7 @@ Here is a quick example on how to use this plugin. For more details, please look
     track_history     :on => [:title, :body], :scope => :post, :track_create => true, :track_destroy => true
   end
 
-  # The modifier can be specified as well 
+  # The modifier can be specified as well
   class User
     include Mongoid::Document
     include Mongoid::Timestamps
@@ -80,30 +97,30 @@ Here is a quick example on how to use this plugin. For more details, please look
 
   track = comment.history_tracks.last
 
-  track.undo! # comment title should be "Test"
+  track.undo! user # comment title should be "Test"
 
-  track.redo! # comment title should be "Test 2"
+  track.redo! user # comment title should be "Test 2"
 
   # undo last change
-  comment.undo! @user
+  comment.undo! user
 
   # undo versions 1 - 4
-  comment.undo! @user, :from => 4, :to => 1
+  comment.undo! user, :from => 4, :to => 1
 
   # undo last 3 versions
-  comment.undo! @user, :last => 3
+  comment.undo! user, :last => 3
 
   # redo versions 1 - 4
-  comment.redo! @user, :from => 1, :to => 4
+  comment.redo! user, :from => 1, :to => 4
 
   # redo last 3 versions
-  comment.redo! @user, :last => 3
+  comment.redo! user, :last => 3
 
   # delete post
   post.destroy
 
   # undelete post
-  post.undo! @user
+  post.undo! user
 
   # disable tracking for comments within a block
   Comment.disable_tracking do

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.1.5

data/lib/mongoid-history.rb

@@ -3,7 +3,9 @@ require 'easy_diff'
 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')
+require File.expand_path(File.dirname(__FILE__) + '/mongoid/history/sweeper')
 
 Mongoid::History.modifier_class_name = "User"
 Mongoid::History.trackable_classes = []
 Mongoid::History.trackable_class_options = {}
+Mongoid::History.current_user_method ||= :current_user

data/lib/mongoid/history.rb

@@ -4,6 +4,7 @@ module Mongoid
     mattr_accessor :trackable_classes
     mattr_accessor :trackable_class_options
     mattr_accessor :modifier_class_name
+    mattr_accessor :current_user_method
 
     def self.tracker_class
       @tracker_class ||= tracker_class_name.to_s.classify.constantize

data/lib/mongoid/history/sweeper.rb

@@ -0,0 +1,28 @@
+module Mongoid::History
+  class Sweeper < Mongoid::Observer
+    attr_accessor :controller
+
+    def self.observed_classes
+      [Mongoid::History.tracker_class]
+    end
+
+    def before(controller)
+      self.controller = controller
+      true # before method from sweeper should always return true
+    end
+
+    def after(controller)
+      self.controller = controller
+      # Clean up, so that the controller can be collected after this request
+      self.controller = nil
+    end
+
+    def before_create(track)
+      track.modifier ||= current_user
+    end
+
+    def current_user
+      controller.send Mongoid::History.current_user_method if controller.respond_to?(Mongoid::History.current_user_method, true)
+    end
+  end
+end

data/lib/mongoid/history/tracker.rb

@@ -15,6 +15,12 @@ module Mongoid::History
       referenced_in :modifier,              :class_name => Mongoid::History.modifier_class_name
 
       Mongoid::History.tracker_class_name = self.name.tableize.singularize.to_sym
+
+      if defined?(ActionController) and defined?(ActionController::Base)
+        ActionController::Base.class_eval do
+          around_filter Mongoid::History::Sweeper.instance
+        end
+      end
     end
 
     def undo!(modifier)

data/mongoid-history.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid-history}
-  s.version = "0.1.4"
+  s.version = "0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Aaron Qian}, %q{Justin Grimes}]
-  s.date = %q{2011-08-30}
+  s.date = %q{2011-11-21}
   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.}
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
     "VERSION",
     "lib/mongoid-history.rb",
     "lib/mongoid/history.rb",
+    "lib/mongoid/history/sweeper.rb",
     "lib/mongoid/history/trackable.rb",
     "lib/mongoid/history/tracker.rb",
     "mongoid-history.gemspec",

data/spec/integration/integration_spec.rb

@@ -71,15 +71,15 @@ describe Mongoid::History do
       end
 
       it "should assign scope" do
-        @comment.history_tracks.first.scope == "Post"
+        @comment.history_tracks.first.scope.should == "post"
       end
 
       it "should assign method" do
-        @comment.history_tracks.first.action == "create"
+        @comment.history_tracks.first.action.should == "create"
       end
 
       it "should assign association_chain" do
-        @comment.history_tracks.first.association_chain = [{:id => @post.id, :name => "Post"}, {:id => @comment.id, :name => "Comment"}]
+        @comment.history_tracks.first.association_chain.should == [{'id' => @post.id, 'name' => "Post"}, {'id' => @comment.id, 'name' => "Comment"}]
       end
     end
 
@@ -92,12 +92,12 @@ describe Mongoid::History do
 
       it "should assign destroy on track record" do
         @post.destroy
-        @post.history_tracks.last.action == "destroy"
+        @post.history_tracks.last.action.should == "destroy"
       end
 
       it "should return affected attributes from track record" do
         @post.destroy
-        @post.history_tracks.last.affected["title"] == "Test"
+        @post.history_tracks.last.affected["title"].should == "Test"
       end
 
     end
@@ -151,12 +151,12 @@ describe Mongoid::History do
 
       it "should assign scope" do
         @post.update_attributes(:title => "Another Test")
-        @post.history_tracks.first.scope == "Post"
+        @post.history_tracks.first.scope.should == "post"
       end
 
       it "should assign association_chain" do
         @post.update_attributes(:title => "Another Test")
-        @post.history_tracks.first.association_chain = [{:id => @post.id, :name => "Post"}]
+        @post.history_tracks.first.association_chain.should == [{'id' => @post.id, 'name' => "Post"}]
       end
 
       it "should exclude defined options" do
@@ -284,7 +284,7 @@ describe Mongoid::History do
         @track = @post.history_tracks.where(:version => 1).first
         @track.undo!(@user)
         @track.redo!(@user)
-        Post.where(:_id => @post.id).first == nil
+        Post.where(:_id => @post.id).first.should == nil
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-history
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-30 00:00:00.000000000Z
+date: 2011-11-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: easy_diff
-  requirement: &33065620 !ruby/object:Gem::Requirement
+  requirement: &30606000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *33065620
+  version_requirements: *30606000
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &33065000 !ruby/object:Gem::Requirement
+  requirement: &30605480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *33065000
+  version_requirements: *30605480
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &33064420 !ruby/object:Gem::Requirement
+  requirement: &30604960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 1.3.1
   type: :development
   prerelease: false
-  version_requirements: *33064420
+  version_requirements: *30604960
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &33063880 !ruby/object:Gem::Requirement
+  requirement: &30604460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *33063880
+  version_requirements: *30604460
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &33063360 !ruby/object:Gem::Requirement
+  requirement: &30603900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +66,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *33063360
+  version_requirements: *30603900
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &33062780 !ruby/object:Gem::Requirement
+  requirement: &30603360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +77,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *33062780
+  version_requirements: *30603360
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &33062260 !ruby/object:Gem::Requirement
+  requirement: &30602760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,10 +88,10 @@ dependencies:
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *33062260
+  version_requirements: *30602760
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &33061660 !ruby/object:Gem::Requirement
+  requirement: &30602200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *33061660
+  version_requirements: *30602200
 - !ruby/object:Gem::Dependency
   name: reek
-  requirement: &33061160 !ruby/object:Gem::Requirement
+  requirement: &30601580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -110,10 +110,10 @@ dependencies:
         version: 1.2.8
   type: :development
   prerelease: false
-  version_requirements: *33061160
+  version_requirements: *30601580
 - !ruby/object:Gem::Dependency
   name: roodi
-  requirement: &33060680 !ruby/object:Gem::Requirement
+  requirement: &30600920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -121,10 +121,10 @@ dependencies:
         version: 2.1.0
   type: :development
   prerelease: false
-  version_requirements: *33060680
+  version_requirements: *30600920
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &33060200 !ruby/object:Gem::Requirement
+  requirement: &30600320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -132,7 +132,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *33060200
+  version_requirements: *30600320
 description: ! "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
@@ -162,6 +162,7 @@ files:
 - VERSION
 - lib/mongoid-history.rb
 - lib/mongoid/history.rb
+- lib/mongoid/history/sweeper.rb
 - lib/mongoid/history/trackable.rb
 - lib/mongoid/history/tracker.rb
 - mongoid-history.gemspec
@@ -184,7 +185,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4230519887588344232
+      hash: 3716774476393405527
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: