mongoid-audit 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+services: mongodb
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid-audit.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Gleb Tv
+
+MIT License
+
+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,191 @@
+Mongoid::Audit
+==============
+
+[![Build Status](https://secure.travis-ci.org/rs-pro/mongoid-audit.png?branch=master)](http://travis-ci.org/rs-pro/mongoid-audit)
+[![Dependency Status](https://gemnasium.com/rs-pro/mongoid-audit.png)](https://gemnasium.com/rs-pro/mongoid-audit)
+
+Mongoid-audit tracks historical changes for any document, including embedded ones. It achieves this by storing all history tracks in a single collection that you define. 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 gem also 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 is probably not suitable for use cases such as a wiki.
+
+Installation
+____________
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid-audit'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid-audit
+
+Usage
+-----
+
+**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::Audit::Tracker`
+
+```ruby
+# app/models/history_tracker.rb
+class HistoryTracker
+  include Mongoid::Audit::Tracker
+end
+```
+
+**Set tracker class name**
+
+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.
+
+The following example sets the tracker class name using a Rails initializer.
+
+```ruby
+# config/initializers/mongoid-audit.rb
+# initializer for mongoid-audit
+# assuming HistoryTracker is your tracker class
+Mongoid::Audit.tracker_class_name = :history_tracker
+```
+
+**Set `#current_user` method name**
+
+You can set the name of the method that returns currently logged in user if you don't want to set `modifier` explicitly on every update.
+
+The following example sets the `current_user_method` using a Rails initializer
+
+```ruby
+# config/initializers/mongoid-audit.rb
+# initializer for mongoid-audit
+# assuming you're using devise/authlogic
+Mongoid::Audit.current_user_method = :current_user
+```
+
+**IMPORTANT**
+for this to work in development environment, add
+```ruby
+require_dependency 'history_tracker.rb' if Rails.env == "development"
+```
+to the initializer so controller filter would be installed
+
+
+When `current_user_method` is set, mongoid-audit will invoke this method on each update and set its result as the instance modifier.
+
+```ruby
+# assume that current_user return #<User _id: 1>
+post = Post.first
+post.update_attributes(:title => 'New title')
+
+post.history_tracks.last.modifier #=> #<User _id: 1>
+```
+
+**Create trackable classes and objects**
+
+```ruby
+class Post
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  # history tracking all Post documents
+  # note: tracking will not work until #track_history is invoked
+  include Mongoid::Audit::Trackable
+
+  field           :title
+  field           :body
+  field           :rating
+  embeds_many     :comments
+
+  # telling Mongoid::Audit how you want to track changes
+  track_history   :on => [:title, :body],       # track title and body fields only, default is :all
+                  :modifier_field => :modifier, # adds "referenced_in :modifier" to track who made the change, default is :modifier
+                  :version_field => :version,   # adds "field :version, :type => Integer" to track current version, default is :version
+                  :track_create   =>  false,    # track document creation, default is false
+                  :track_update   =>  true,     # track document updates, default is true
+                  :track_destroy  =>  false,    # track document destruction, default is false
+end
+
+class Comment
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  # declare that we want to track comments
+  include Mongoid::Audit::Trackable
+
+  field             :title
+  field             :body
+  embedded_in       :post, :inverse_of => :comments
+
+  # track title and body for all comments, scope it to post (the parent)
+  # also track creation and destruction
+  track_history     :on => [:title, :body], :scope => :post, :track_create => true, :track_destroy => true
+end
+
+# the modifier class
+class User
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field             :name
+end
+
+user = User.create(:name => "Aaron")
+post = Post.create(:title => "Test", :body => "Post", :modifier => user)
+comment = post.comments.create(:title => "test", :body => "comment", :modifier => user)
+comment.history_tracks.count # should be 1
+
+comment.update_attributes(:title => "Test 2")
+comment.history_tracks.count # should be 2
+
+track = comment.history_tracks.last
+
+track.undo! user # comment title should be "Test"
+
+track.redo! user # comment title should be "Test 2"
+
+# undo last change
+comment.undo! user
+
+# undo versions 1 - 4
+comment.undo! user, :from => 4, :to => 1
+
+# undo last 3 versions
+comment.undo! user, :last => 3
+
+# redo versions 1 - 4
+comment.redo! user, :from => 1, :to => 4
+
+# redo last 3 versions
+comment.redo! user, :last => 3
+
+# delete post
+post.destroy
+
+# undelete post
+post.undo! user
+
+# disable tracking for comments within a block
+Comment.disable_tracking do
+  comment.update_attributes(:title => "Test 3")
+end
+```
+For more examples, check out [spec/integration/integration_spec.rb](https://github.com/aq1018/mongoid-history/blob/master/spec/integration/integration_spec.rb).
+
+## Credits
+
+This gem is loosely based on https://github.com/aq1018/mongoid-history
+
+The original gem didn't work correctly for us, when not setting modifier manually, so we rewrote it a bit.
+Seems to work fully now, including manually setting modifier
+
+Mongoid-history Copyright (c) 2011-2012 Aaron Qian. MIT License. See [LICENSE.txt](https://github.com/aq1018/mongoid-history/blob/master/LICENSE.txt) for further details.
+Mongoid-audit Copyright (c) 2013 http://rocketscience.pro MIT License.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/config/mongoid.yml

@@ -0,0 +1,8 @@
+test:
+  sessions:
+    default:
+      database: mongoid-history
+      hosts:
+        - localhost:27017
+      options:
+        consistency: :strong

data/lib/mongoid-audit.rb

@@ -0,0 +1,24 @@
+require 'mongoid-audit/version'
+require 'easy_diff'
+
+module Mongoid
+  module Audit
+    mattr_accessor :tracker_class_name
+    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
+    end
+  end
+end
+
+require 'mongoid-audit/tracker'
+require 'mongoid-audit/trackable'
+require 'mongoid-audit/sweeper'
+
+Mongoid::Audit.modifier_class_name = "User"
+Mongoid::Audit.trackable_class_options = {}
+Mongoid::Audit.current_user_method ||= :current_user
+

data/lib/mongoid-audit/sweeper.rb

@@ -0,0 +1,40 @@
+module Mongoid::Audit
+  class Sweeper < Mongoid::Observer
+    def controller
+      Thread.current[:mongoid_history_sweeper_controller]
+    end
+
+    def controller=(value)
+      Thread.current[:mongoid_history_sweeper_controller] = value
+    end
+
+    # Hook to ActionController::Base#around_filter.
+    # Runs before a controller action is run.
+    # It should always return true so controller actions
+    # can continue.
+    def before(controller)
+      self.controller = controller
+      true
+    end
+
+    # Hook to ActionController::Base#around_filter.
+    # Runs after a controller action is run.
+    # Clean up so that the controller can
+    # be collected after this request
+    def after(controller)
+      self.controller = nil
+    end
+
+    def before_create(track)
+      track.modifier = current_user if track.modifier.nil?
+    end
+
+    def current_user
+      if controller.respond_to?(Mongoid::Audit.current_user_method, true)
+        controller.send Mongoid::Audit.current_user_method
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/mongoid-audit/trackable.rb

@@ -0,0 +1,262 @@
+module Mongoid::Audit
+  module Trackable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def track_history(options={})
+        scope_name = self.collection_name.to_s.singularize.to_sym
+        default_options = {
+          :on             =>  :all,
+          :except         =>  [:created_at, :updated_at],
+          :modifier_field =>  :modifier,
+          :version_field  =>  :version,
+          :scope          =>  scope_name,
+          :track_create   =>  false,
+          :track_update   =>  true,
+          :track_destroy  =>  false,
+        }
+
+        options = default_options.merge(options)
+
+        # normalize except fields
+        # manually ensure _id, id, version will not be tracked in history
+        options[:except] = [options[:except]] unless options[:except].is_a? Array
+        options[:except] << options[:version_field]
+        options[:except] << "#{options[:modifier_field]}_id".to_sym
+        options[:except] += [:_id, :id]
+        options[:except] = options[:except].map(&:to_s).flatten.compact.uniq
+        options[:except].map(&:to_s)
+
+        # normalize fields to track to either :all or an array of strings
+        if options[:on] != :all
+          options[:on] = [options[:on]] unless options[:on].is_a? Array
+          options[:on] = options[:on].map(&:to_s).flatten.uniq
+        end
+
+        field options[:version_field].to_sym, :type => Integer
+        belongs_to options[:modifier_field].to_sym, :class_name => Mongoid::Audit.modifier_class_name
+
+        include MyInstanceMethods
+        extend SingletonMethods
+
+        delegate :history_trackable_options, :to => 'self.class'
+        delegate :track_history?, :to => 'self.class'
+
+        before_update :track_update if options[:track_update]
+        before_create :track_create if options[:track_create]
+        before_destroy :track_destroy if options[:track_destroy]
+
+        Mongoid::Audit.trackable_class_options ||= {}
+        Mongoid::Audit.trackable_class_options[scope_name] = options
+      end
+
+      def track_history?
+        enabled = Thread.current[track_history_flag]
+        enabled.nil? ? true : enabled
+      end
+
+      def disable_tracking(&block)
+        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
+
+    module MyInstanceMethods
+      def history_tracks
+        @history_tracks ||= Mongoid::Audit.tracker_class.where(:scope => history_trackable_options[:scope], :association_chain => association_hash)
+      end
+
+      #  undo :from => 1, :to => 5
+      #  undo 4
+      #  undo :last => 10
+      def undo!(modifier, options_or_version=nil)
+        versions = get_versions_criteria(options_or_version).to_a
+        versions.sort!{|v1, v2| v2.version <=> v1.version}
+
+        versions.each do |v|
+          undo_attr = v.undo_attr(modifier)
+          self.attributes = v.undo_attr(modifier)
+        end
+        save!
+      end
+
+      def redo!(modifier, options_or_version=nil)
+        versions = get_versions_criteria(options_or_version).to_a
+        versions.sort!{|v1, v2| v1.version <=> v2.version}
+
+        versions.each do |v|
+          redo_attr = v.redo_attr(modifier)
+          self.attributes = redo_attr
+        end
+        save!
+      end
+
+    private
+      def get_versions_criteria(options_or_version)
+        if options_or_version.is_a? Hash
+          options = options_or_version
+          if options[:from] && options[:to]
+            lower = options[:from] >= options[:to] ? options[:to] : options[:from]
+            upper = options[:from] <  options[:to] ? options[:to] : options[:from]
+            versions = history_tracks.where( :version.in => (lower .. upper).to_a )
+          elsif options[:last]
+            versions = history_tracks.limit( options[:last] )
+          else
+            raise "Invalid options, please specify (:from / :to) keys or :last key."
+          end
+        else
+          options_or_version = options_or_version.to_a if options_or_version.is_a?(Range)
+          version_field_name = history_trackable_options[:version_field]
+          version = options_or_version || self.attributes[version_field_name] || self.attributes[version_field_name.to_s]
+          version = [ version ].flatten
+          versions = history_tracks.where(:version.in => version)
+        end
+        versions.desc(:version)
+      end
+
+      def should_track_update?
+        track_history? && !modified_attributes_for_update.blank?
+      end
+
+      def traverse_association_chain(node=self)
+        list = node._parent ? traverse_association_chain(node._parent) : []
+        list << association_hash(node)
+        list
+      end
+
+      def association_hash(node=self)
+
+        # We prefer to look up associations through the parent record because
+        # we're assured, through the object creation, it'll exist. Whereas we're not guarenteed
+        # the child to parent (embedded_in, belongs_to) relation will be defined
+        if node._parent
+          meta = _parent.relations.values.select do |relation|
+            relation.class_name == node.class.to_s
+          end.first
+        end
+
+        # if root node has no meta, and should use class name instead
+        name = meta ? meta.key.to_s : node.class.name
+
+        { 'name' => name, 'id' => node.id}
+      end
+
+      def modified_attributes_for_update
+        @modified_attributes_for_update ||= if history_trackable_options[:on] == :all
+          changes.reject do |k, v|
+            history_trackable_options[:except].include?(k)
+          end
+        else
+          changes.reject do |k, v|
+            !history_trackable_options[:on].include?(k)
+          end
+
+        end
+      end
+
+      def modified_attributes_for_create
+        @modified_attributes_for_create ||= attributes.inject({}) do |h, pair|
+          k,v =  pair
+          h[k] = [nil, v]
+          h
+        end.reject do |k, v|
+          history_trackable_options[:except].include?(k)
+        end
+      end
+
+      def modified_attributes_for_destroy
+        @modified_attributes_for_destroy ||= attributes.inject({}) do |h, pair|
+          k,v =  pair
+          h[k] = [nil, v]
+          h
+        end
+      end
+
+      def history_tracker_attributes(method)
+        return @history_tracker_attributes if @history_tracker_attributes
+
+        @history_tracker_attributes = {
+          :association_chain  => traverse_association_chain,
+          :scope              => history_trackable_options[:scope],
+          :modifier           => send("#{history_trackable_options[:modifier_field].to_s}_id_changed?".to_sym) ? send(history_trackable_options[:modifier_field]) : nil,
+        }
+
+        original, modified = transform_changes(case method
+          when :destroy then modified_attributes_for_destroy
+          when :create then modified_attributes_for_create
+          else modified_attributes_for_update
+        end)
+
+        @history_tracker_attributes[:original] = original
+        @history_tracker_attributes[:modified] = modified
+        @history_tracker_attributes
+      end
+
+      def track_update
+        return unless should_track_update?
+        current_version = (self.send(history_trackable_options[:version_field]) || 0 ) + 1
+        self.send("#{history_trackable_options[:version_field]}=", current_version)
+
+        track = Mongoid::Audit.tracker_class.create!(history_tracker_attributes(:update).merge(:version => current_version, :action => "update", :trackable => self))
+        self.send("#{history_trackable_options[:modifier_field]}=", track.modifier)
+
+        clear_memoization
+      end
+
+      def track_create
+        return unless track_history?
+        current_version = (self.send(history_trackable_options[:version_field]) || 0 ) + 1
+        self.send("#{history_trackable_options[:version_field]}=", current_version)
+
+        track = Mongoid::Audit.tracker_class.create!(history_tracker_attributes(:create).merge(:version => current_version, :action => "create", :trackable => self))
+        self.send("#{history_trackable_options[:modifier_field]}=", track.modifier)
+
+        clear_memoization
+      end
+
+      def track_destroy
+        return unless track_history?
+        current_version = (self.send(history_trackable_options[:version_field]) || 0 ) + 1
+
+        track = Mongoid::Audit.tracker_class.create!(history_tracker_attributes(:destroy).merge(:version => current_version, :action => "destroy", :trackable => self))
+        self.send("#{history_trackable_options[:modifier_field]}=", track.modifier)
+
+        clear_memoization
+      end
+
+      def clear_memoization
+        @history_tracker_attributes =  nil
+        @modified_attributes_for_create = nil
+        @modified_attributes_for_update = nil
+        @history_tracks = nil
+      end
+
+      def transform_changes(changes)
+        original = {}
+        modified = {}
+        changes.each_pair do |k, v|
+          o, m = v
+          original[k] = o unless o.nil?
+          modified[k] = m unless m.nil?
+        end
+
+        original.easy_diff modified
+      end
+
+    end
+
+    module SingletonMethods
+      def history_trackable_options
+        @history_trackable_options ||= Mongoid::Audit.trackable_class_options[self.collection_name.to_s.singularize.to_sym]
+      end
+    end
+  end
+end