mongoid-audit 0.3.2 → 1.0.0.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f22e64db40fe3fc2abd49b9256511a5787994ac
-  data.tar.gz: cc6fc81cb903b782850aff4f3813dbbe720e82a6
+  metadata.gz: 0057de0bc4b8086ede177d4e62f00f2afe911a9c
+  data.tar.gz: a3bc47897234907ac0febea43b6d7062f04be122
 SHA512:
-  metadata.gz: 3a88f20f072b6f285ec0120246f43f07741c3a38aa330f5ad23ec80273ddd1a401be6f28c2d8e59d928d09e374ad15a4c838cffa4e4a7b24d86c9ed6fd427de3
-  data.tar.gz: da8e1441856ff92dcbd0c091d736b1e59077e6761f14818f724cae4302675f0aed15bd45d0a7627ac2c84359ab403dc4b7d1fc18b6285f9f86b19f578af46a6b
+  metadata.gz: 4ced31227b1dbdb9bd575ee5d48e03642e2574aa3b1df4836a54f08709cf42e4b24bb6c6c148ad822a442e22372f59bb5bb0180b013a95f82422aff0411f138d
+  data.tar.gz: b6decdc95280890a88824fc4ec47e3fc8c7c6b08cc488ada2e9208b0eb81240f9cd1796e758118f5b2cd8d74ab235c97b8f97592ec89cf6f908198eae493356c

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/.ruby-version

@@ -1 +1 @@
-ruby-2.0.0-p247
+2.1.2

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    mongoid-audit (1.0.0.alpha.1)
+      activesupport
+      glebtv_mongoid_userstamp
+      kaminari
+      mongoid (~> 4.0.0)
+      mongoid-history (~> 0.4.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.1.4)
+      actionview (= 4.1.4)
+      activesupport (= 4.1.4)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.4)
+      activesupport (= 4.1.4)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.4)
+      activesupport (= 4.1.4)
+      builder (~> 3.1)
+    activesupport (4.1.4)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    bson (2.3.0)
+    builder (3.2.2)
+    connection_pool (2.0.0)
+    easy_diff (0.0.3)
+    erubis (2.7.0)
+    glebtv_mongoid_userstamp (0.4.1)
+      mongoid (~> 4.0.0.beta1)
+    i18n (0.6.11)
+    json (1.8.1)
+    kaminari (0.16.1)
+      actionpack (>= 3.0.0)
+      activesupport (>= 3.0.0)
+    minitest (5.4.0)
+    mongoid (4.0.0)
+      activemodel (~> 4.0)
+      moped (~> 2.0.0)
+      origin (~> 2.1)
+      tzinfo (>= 0.3.37)
+    mongoid-history (0.4.4)
+      activesupport
+      easy_diff
+      mongoid (>= 3.0)
+    moped (2.0.0)
+      bson (~> 2.2)
+      connection_pool (~> 2.0)
+      optionable (~> 0.2.0)
+    optionable (0.2.0)
+    origin (2.1.1)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.3.2)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  mongoid-audit!
+  rake

data/README.md

@@ -1,31 +1,32 @@
-Mongoid::Audit
-==============
+## Mongoid::Audit
 
-Mongoid Audit is a fork of mongoid-history https://github.com/aq1018/mongoid-history
+[![Gem Version](https://badge.fury.io/rb/mongoid-audit.png)](http://badge.fury.io/rb/mongoid-audit)
+[![Dependency Status](https://www.versioneye.com/user/projects/53ea131f8b6db55f150000b7/badge.svg)](https://www.versioneye.com/user/projects/53ea131f8b6db55f150000b7)
+[![Issues](http://img.shields.io/github/issues/rs-pro/mongoid-audit.svg)](https://github.com/rs-pro/mongoid-audit/issues)
+[![License](http://img.shields.io/:license-mit-blue.svg)](https://github.com/rs-pro/mongoid-audit/blob/master/MIT-LICENSE.txt)
 
-Fork differences:
- * Rails 4 support
- * Built in rails_admin auditing support
- * Properly setting user (modifier) all the time
+**MongoidAudit 1.0 is a complete rewrite and might break backwards compatibility**
 
-In case of problems, you can try mongoid-history, which didn't work properly for us.
+Since 1.0.0, mongoid_audit is no longer a fork, but a wrapper of [mongoid-history](https://github.com/aq1018/mongoid-history), providing
+out-of-the-box Userstamp, RailsAdmin integration and easier setup and configuration.
 
-[![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)
-[![Coverage Status](https://coveralls.io/repos/rs-pro/mongoid-audit/badge.png?branch=master)](https://coveralls.io/r/rs-pro/mongoid-audit?branch=master)
-[![Gem Version](https://badge.fury.io/rb/mongoid-audit.png)](http://badge.fury.io/rb/mongoid-audit)
+Database storage format for user / modifier in 1.0.0 was changed, since now glebtv_mongoid_userstamp gem is used to store
+modifier.
+
+To migrate your data do:
+  
+    HistoryTracker.all.each{|ht| ht.rename(:modifier_id, :updater_id)
 
-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 includes storing modifier, but it is done via ```glebtv_mongoid_userstamp``` and not directly.
 
-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.
+RailsAdmin history is fully supported.
 
-Installation
-____________
+## Installation
 
 Add this line to your application's Gemfile:
 
     # must be after rails_admin, if you use it
-    gem 'mongoid-audit'
+    gem 'mongoid-audit', '~> 1.0.0.alpha.1'
 
 And then execute:
 
@@ -33,173 +34,39 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install mongoid-audit
-
-Usage
------
-
-**Rails Admin Integration**
-
-    # note that instead of a user class, you pass in history tracker table name as second argument
-    config.audit_with :mongoid_audit, 'HistoryTracker'
-
-
-**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
-
+    $ gem install mongoid-audit --pre
 
-When `current_user_method` is set, mongoid-audit will invoke this method on each update and set its result as the instance modifier.
+## Usage
 
-```ruby
-# assume that current_user return #<User _id: 1>
-post = Post.first
-post.update_attributes(:title => 'New title')
+Include ```Trackable``` in your models. That's it, you are done!
 
-post.history_tracks.last.modifier #=> #<User _id: 1>
-```
+    include Trackable
 
-**Create trackable classes and objects**
+## Advanced usage
 
-```ruby
-class Post
-  include Mongoid::Document
-  include Mongoid::Timestamps
+Identical to Mongoid::History.
+See https://github.com/aq1018/mongoid-history
 
-  # history tracking all Post documents
-  # note: tracking will not work until #track_history is invoked
-  include Mongoid::Audit::Trackable
+    include Mongoid::History::Trackable
+    track_history({
+      track_create: true,
+      track_destroy: true,
+      track_update: true,
+      modifier_field: :updater,
+      except: ["created_at", "updated_at", "c_at", "u_at"],
+    })
 
-  field           :title
-  field           :body
-  field           :rating
-  embeds_many     :comments
+### Rails Admin Integration
 
-  # 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
+Add 
 
-class Comment
-  include Mongoid::Document
-  include Mongoid::Timestamps
+    config.audit_with :mongoid_audit
 
-  # 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).
+in ```config/initializers/rails_admin.rb```
 
 ## Credits
 
-This gem is 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.
+(c) 2013-2014 http://rocketscience.pro MIT License.
 
 ## Contributing
 

data/Rakefile

@@ -1,14 +1,2 @@
 require "bundler/gem_tasks"
 
-# Get your spec rake tasks working in RSpec 2.0
-
-require 'rspec/core/rake_task'
-
-desc 'Default: run specs.'
-task :default => :spec
-
-desc "Run specs"
-RSpec::Core::RakeTask.new do |t|
-  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
-                                    # Put spec opts in a file named .rspec in root
-end

data/lib/mongoid-audit.rb

@@ -1,34 +1,21 @@
-require 'mongoid-audit/version'
-require 'easy_diff'
 require 'mongoid'
-require 'rails-observers'
-require 'rails/observers/active_model/active_model'
-
-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-history'
+require 'mongoid_userstamp'
+require 'kaminari'
+require 'kaminari/hooks'
+require 'kaminari/models/mongoid_extension'
 
-if defined? Rails::Railtie
-  require 'mongoid-audit/railtie'
-end
+require 'mongoid-audit/version'
+require 'mongoid-audit/trackable'
+require 'mongoid-audit/history_tracker'
+require 'mongoid-audit/railtie'
 
-if Object.const_defined?("RailsAdmin")
+begin; require 'rails_admin'; rescue LoadError; end
+if defined? ::RailsAdmin
   require "mongoid-audit/rails_admin"
 end
 
-require 'mongoid-audit/tracker'
-require 'mongoid-audit/trackable'
-require 'mongoid-audit/sweeper'
+Mongoid::History.tracker_class_name = :history_tracker
+Mongoid::History.current_user_method = :current_user
+Mongoid::History.modifier_class_name = "User"
 
-Mongoid::Audit.modifier_class_name = "User"
-Mongoid::Audit.trackable_class_options = {}
-Mongoid::Audit.current_user_method ||= :current_user

data/lib/mongoid-audit/history_tracker.rb

@@ -0,0 +1,6 @@
+class HistoryTracker
+  include Mongoid::History::Tracker
+  include Mongoid::Userstamp
+  include Kaminari::MongoidExtension::Document
+end
+

data/lib/mongoid-audit/rails_admin.rb

@@ -1,108 +1,119 @@
-module RailsAdmin
-  module Extensions
-    module MongoidAudit
-      class VersionProxy
-        def initialize(version)
-          @version = version
-        end
-
-        def message
-          @message = @version.action
-          mods = @version.modified.to_a.map do |c|
-            if c[1].class.name == "Moped::BSON::Binary" || c[1].class.name == "BSON::Binary"
-              c[0] + " = {binary data}"
-            elsif c[1].to_s.length > 220
-              c[0] + " = " + c[1].to_s[0..200]
-            else
-              c[0] + " = " + c[1].to_s
-            end
-
-          end
-          @version.respond_to?(:modified) ? @message + ' ' + table +  " [" + mods.join(", ") + "]" : @message
-        end
-
-        def created_at
-          @version.created_at
-        end
-
-        def table
-          @version.association_chain.last['name']
-        end
-
-        def username
-          @version.modifier.try(:email) || @version.modifier
-        end
-
-        def item
-          @version.association_chain.last['id']
-        end
-      end
-
-      class AuditingAdapter
-        COLUMN_MAPPING = {
-            :table => 'association_chain.name',
-            :username => 'modifier_id',
-            :item => 'association_chain.id',
-            :created_at => :created_at,
-            :message => :action
-        }
-
-        def initialize(controller, version_class = HistoryTracker)
-          @controller = controller
-          @version_class = version_class.to_s.constantize
-        end
-
-        def latest
-          @version_class.order_by([:_id, :desc]).limit(20).map { |version| VersionProxy.new(version) }
-        end
-
-        def delete_object(object, model, user)
-          # do nothing
-        end
-
-        def update_object(object, model, user, changes)
-          # do nothing
-        end
-
-        def create_object(object, abstract_model, user)
-          # do nothing
-        end
-
-        def listing_for_model(model, query, sort, sort_reverse, all, page, per_page = (RailsAdmin::Config.default_items_per_page || 20))
-          history = @version_class.where('association_chain.name' => model.model_name)
-          history = history.any_of({action: /.*#{query}.*/}, {modifier_id: /.*#{query}.*/}) if query.present?
-          if sort
-            order = sort_reverse == "true" ? :desc : :asc
-            history = history.order_by(sort.to_sym => order)
-          else
-            history = history.order_by(created_at: :desc)
-          end
-
-          history = all ? history.entries : history.send(Kaminari.config.page_method_name, page.presence || "1").per(per_page)
-
-          history.map{|version| VersionProxy.new(version)}
-        end
-
-        def listing_for_object(model, object, query, sort, sort_reverse, all, page, per_page = (RailsAdmin::Config.default_items_per_page || 20))
-          history = @version_class.where('association_chain.name' => model.model_name, 'association_chain.id' => object.id)
-          history = history.any_of({action: /.*#{query}.*/}, {username: /.*#{query}.*/}) if query.present?
-          if sort
-            order = sort_reverse == "true" ? :desc : :asc
-            history = history.order_by(sort.to_sym => order)
-          else
-            history = history.order_by(created_at: :desc)
-          end
-          history = all ? history.entries : history.send(Kaminari.config.page_method_name, page.presence || "1").per(per_page)
-
-          history.map{|version| VersionProxy.new(version)}
-        end
-      end
-    end
-  end
-end
-
-
-
-RailsAdmin.add_extension(:mongoid_audit, RailsAdmin::Extensions::MongoidAudit, {
-  :auditing => true
-})
+module RailsAdmin
+  module Extensions
+    module MongoidAudit
+      class VersionProxy
+        def initialize(version)
+          @version = version
+        end
+
+        def message
+          @message = @version.action
+          if @message == 'create'
+            return 'new'
+          end
+          if @message == 'destroy'
+            return 'delete'
+          end
+          mods = @version.modified.to_a.map do |c|
+            if c[1].class.name == "Moped::BSON::Binary" || c[1].class.name == "BSON::Binary"
+              c[0] + " = {binary data}"
+            elsif c[1].to_s.length > 220
+              c[0] + " = " + c[1].to_s[0..200]
+            else
+              c[0] + " = " + c[1].to_s
+            end
+
+          end
+          @version.respond_to?(:modified) ? @message + ' ' + table +  " [" + mods.join(", ") + "]" : @message
+        end
+
+        def created_at
+          @version.created_at
+        end
+
+        def table
+          @version.association_chain.last['name']
+        end
+
+        def username
+          @version.updater.try(:email) || @version.updater
+        end
+
+        def item
+          @version.association_chain.last['id']
+        end
+      end
+
+      class AuditingAdapter
+        COLUMN_MAPPING = {
+            :table => 'association_chain.name',
+            :username => 'modifier_id',
+            :item => 'association_chain.id',
+            :created_at => :created_at,
+            :message => :action
+        }
+
+        def initialize(controller, version_class = HistoryTracker)
+          @controller = controller
+          @version_class = version_class.to_s.constantize
+        end
+
+        def latest(include_empty_modifier = false)
+          versions = @version_class
+          unless include_empty_modifier
+            versions.where(:updater_id.exists => true)
+          end
+          versions = versions.desc(:_id).limit(20)
+          versions.map { |version| VersionProxy.new(version) }
+        end
+
+        def delete_object(object, model, user)
+          # do nothing
+        end
+
+        def update_object(object, model, user, changes)
+          # do nothing
+        end
+
+        def create_object(object, abstract_model, user)
+          # do nothing
+        end
+
+        def listing_for_model(model, query, sort, sort_reverse, all, page, per_page = (RailsAdmin::Config.default_items_per_page || 20))
+          listing_for_model_or_object(model, nil, query, sort, sort_reverse, all, page, per_page)
+        end
+
+        def listing_for_object(model, object, query, sort, sort_reverse, all, page, per_page = (RailsAdmin::Config.default_items_per_page || 20))
+          listing_for_model_or_object(model, object, query, sort, sort_reverse, all, page, per_page)
+        end
+
+        protected
+          def listing_for_model_or_object(model, object, query, sort, sort_reverse, all, page, per_page)
+            if sort.present?
+              sort = COLUMN_MAPPING[sort.to_sym]
+            else
+              sort = :created_at
+              sort_reverse = 'true'
+            end
+            model_name = model.model.name
+            if object
+              versions = @version_class.where('association_chain.name' => model.model_name, 'association_chain.id' => object.id)
+            else
+              versions = @version_class.where('association_chain.name' => model_name)
+            end
+            versions = versions.order_by([sort, sort_reverse == 'true' ? :desc : :asc])
+            unless all
+              page = 1 if page.nil?
+              versions = versions.send(Kaminari.config.page_method_name, page).per(per_page)
+            end
+            versions.map { |version| VersionProxy.new(version) }
+          end
+      end
+    end
+  end
+end
+
+RailsAdmin.add_extension(:mongoid_audit, RailsAdmin::Extensions::MongoidAudit, {
+  :auditing => true
+})
+