mongoid_simple_audit 0.1.4

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDNhMjFmOTBkZTJmMWZiZDI1ZDNhZmJiZWJlMzk0MzdmODNjN2MxOQ==
+  data.tar.gz: !binary |-
+    YzY1MWFkZjhlZGUzYmIyNDEzOTIyYzMxNGZlZTU5NTViY2EzYmJlYw==
+SHA512:
+  metadata.gz: !binary |-
+    ZTU4MTNmOGVhMTIzNTAxZGEwM2E2ZjQ2ZDYwYjVlMjE2NGIxYWZhOThiMTdk
+    ZGUwNTEzNDQ0YzM0ZTMwZGQ1NjA0NWY0Yjg1Mzg2YWI4Yjg3ZDY5M2U4OTU2
+    NDEwMmNlNTlmZTEzNjNlZjIxZmRiZTk0MGYxN2QwMjE1NjcxNWI=
+  data.tar.gz: !binary |-
+    YjkxNGQyOGYzYTZkN2Q3NzMwODVlODM4YzA3NmU1YzY3NmQxNTI1YTkxYTVi
+    YTVkOGQ3M2I4ZTYwMzM0ZGQyZTU1MmU2M2IzMGM5NTQyYjk0NDc1NDRjZWY4
+    MTNiZmM3OWNjNTcwMGU0NzI2M2I1NWM5ZTU4MGFjZDg5M2U4MmU=

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+
+gemfile:
+  - gemfiles/rails_3.gemfile
+  - gemfiles/rails_4.gemfile
+
+script: 'bundle exec rake'
+
+services:
+  - mongodb
+before_script:
+  - sleep 15  
+
+notifications:
+  email:
+    recipients:
+      - felix.abele@gmail.com
+    on_failure: change
+    on_success: never

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "rails-3" do
+  gem "mongoid", '>= 3.0', '< 4.0.0'
+end
+
+appraise "rails-4" do
+  gem "mongoid", '>= 4.0.0'
+end

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Felix Abele
+
+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,151 @@
+[![Build Status](https://travis-ci.org/felixabele/mongoid_simple_audit.svg?branch=master)](https://travis-ci.org/felixabele/mongoid_simple_audit) [![Coverage Status](https://img.shields.io/coveralls/felixabele/mongoid_simple_audit.svg)](https://coveralls.io/r/felixabele/mongoid_simple_audit?branch=master)
+
+# MongoidSimpleAudit
+
+This is modified version of the Gem simple_audit from Gabriel Tarnovan (https://github.com/gtarnovan/simple_audit) wich uses MongoDB with Mongoid to store audit logs instead of ActiveRecord.
+
+# What is this Gem about?
+
+It's a simple auditing solution for ActiveRecord and MongoID models. Provides an easy way of creating audit logs for complex model associations.
+Instead of storing audits for all data aggregated by the audited model, you can specify a serializable representation of the model.
+mongoid_simple_audit is intended as a straightforward, performant and simple auditing solution.
+    
+  * a helper method is provided to easily display the audit log
+  * the Audit object provides a #delta method which computes the differences between two audits
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid_simple_audit'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid_simple_audit
+
+Don't forget to create the MongoDB indeces
+
+    rake db:mongoid:create_indexes
+
+## Usage
+
+  class Booking < ActiveRecord::Base
+    simple_audit do |record|
+      # data to be audited
+      {
+          :price => record.price,
+          :period => record.period, 
+          ...
+      }
+    end
+  end
+  
+  # in your view
+  <%= render_audits(@booking) %>
+
+Audit ActiveRecord models. Somewhere in your (backend) views show the audit logs.
+    
+    # in your model
+    # app/models/booking.rb
+    
+    class Booking < ActiveRecord::Base
+        simple_audit
+        ...
+    end
+    
+    # in your view
+    # app/views/bookings/booking.html.erb
+    
+    ...
+    <%= render_audits(@booking) %>
+    ...     
+
+## Sample styling
+      .audits {
+        clear: both;
+      }
+      .audit {
+        -moz-border-radius:8px;
+        -webkit-border-radius: 8px;
+        background-color: #dfdfdf;
+        padding: 6px;
+        margin-bottom: 8px;
+        font-size: 12px;
+      }
+      .audit .action, .audit .user, .audit .timestamp{
+        float: left;
+        margin-right: 6px;
+      }
+      .audit .changes {
+        clear: both;
+        white-space: pre;
+      }
+
+      .audit .current {
+        margin-left: 6px;
+      }
+      .audit .previous {
+        margin-left: 6px;
+        text-decoration: line-through;
+      }  
+
+# Assumptions and limitations
+
+  * Your user model is called User (or Cms::User) and the current user User.current
+    See [sentient_user](http://github.com/bokmann/sentient_user) for more information.
+
+    
+## Customize auditing
+
+By default after each save, all model's attributes and `belongs_to` associations (their `id` and `to_s` on these) are saved in the audits table.
+You can customize the data which is saved by supplying a block which will return all relevant data for the audited model.
+
+    # app/models/booking.rb
+    
+    class Booking < ActiveRecord::Base
+        simple_audit do |record|
+          {
+            :state  => record.state, 
+            :price  => record.price.format,
+            :period => record.period.to_s,
+            :housing_units => record.housing_units.collect(&:name).join('; '),
+            ...
+            }
+        end
+        ...
+    end
+    
+You can also customize the attribute of the User model which will be stored in the audit.
+
+    # default is :name
+    simple_audit :username_method => :email
+
+As a default it will audit all save and update calls even though no changes where made, unless you specify :audit_changes_only => true
+
+  simple_audit :audit_changes_only => true
+    
+## Rendering audit trail
+
+A helper method for displaying a list of audits is provided. It will render a decorated list of the provided audits;
+only the differences between revisions will be shown, thus making the audit information easily readable.
+
+## Why I consider the MongoDB Version more suitable to the original with ActiveRecord
+
+1. Changed attributes are natively searchable by the database
+2. Better perfomance
+3. High scalability
+4. It supports the Mongoid wrapper  
+
+Negative aspect though, its not working nicely hand in hand with not MongoDB backends
+
+## Contributing
+
+1. Fork it ( https://github.com/felixabele/mongoid_simple_audit/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'progress']
+end
+
+task :default => :spec
+
+

data/gemfiles/rails_3.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", ">= 3.0", "< 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails_3.gemfile.lock

@@ -0,0 +1,137 @@
+PATH
+  remote: ../
+  specs:
+    mongoid_simple_audit (0.1.4)
+      mongoid
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (3.2.18)
+      activemodel (= 3.2.18)
+      activesupport (= 3.2.18)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.18)
+      activesupport (= 3.2.18)
+      builder (~> 3.0.0)
+    activerecord (3.2.18)
+      activemodel (= 3.2.18)
+      activesupport (= 3.2.18)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.18)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    appraisal (1.0.2)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (3.0.3)
+    builder (3.0.4)
+    coveralls (0.7.1)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    erubis (2.7.0)
+    factory_girl (4.4.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.4.1)
+      factory_girl (~> 4.4.0)
+      railties (>= 3.0.0)
+    hike (1.2.3)
+    i18n (0.6.11)
+    journey (1.0.4)
+    json (1.8.1)
+    mime-types (1.25.1)
+    mongoid (3.1.6)
+      activemodel (~> 3.2)
+      moped (~> 1.4)
+      origin (~> 1.0)
+      tzinfo (~> 0.3.29)
+    moped (1.5.2)
+    multi_json (1.10.1)
+    netrc (0.7.7)
+    origin (1.1.0)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.4)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (3.2.18)
+      actionpack (= 3.2.18)
+      activesupport (= 3.2.18)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.3.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.2)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.0)
+      rspec-support (~> 3.1.0)
+    rspec-rails (3.1.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.0)
+    simplecov (0.9.0)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.9)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tilt (1.4.1)
+    tins (1.3.2)
+    tzinfo (0.3.41)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  appraisal
+  bundler (~> 1.6)
+  coveralls (~> 0.7.1)
+  factory_girl_rails
+  mongoid (>= 3.0, < 4.0.0)
+  mongoid_simple_audit!
+  rake
+  rspec
+  rspec-rails
+  sqlite3

data/gemfiles/rails_4.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", ">= 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.gemfile.lock

@@ -0,0 +1,128 @@
+PATH
+  remote: ../
+  specs:
+    mongoid_simple_audit (0.1.4)
+      mongoid
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activerecord (4.0.0)
+      activemodel (= 4.0.0)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    appraisal (1.0.2)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (4.0.2)
+    bson (2.3.0)
+    builder (3.1.4)
+    connection_pool (2.0.0)
+    coveralls (0.7.1)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    erubis (2.7.0)
+    factory_girl (4.4.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.4.1)
+      factory_girl (~> 4.4.0)
+      railties (>= 3.0.0)
+    i18n (0.6.11)
+    mime-types (1.25.1)
+    minitest (4.7.5)
+    mongoid (4.0.0)
+      activemodel (~> 4.0)
+      moped (~> 2.0.0)
+      origin (~> 2.1)
+      tzinfo (>= 0.3.37)
+    moped (2.0.0)
+      bson (~> 2.2)
+      connection_pool (~> 2.0)
+      optionable (~> 0.2.0)
+    multi_json (1.10.1)
+    netrc (0.7.7)
+    optionable (0.2.0)
+    origin (2.1.1)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (4.0.0)
+      actionpack (= 4.0.0)
+      activesupport (= 4.0.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.2)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.0)
+      rspec-support (~> 3.1.0)
+    rspec-rails (3.1.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.0)
+    simplecov (0.9.0)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    sqlite3 (1.3.9)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tins (1.3.2)
+    tzinfo (0.3.41)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  appraisal
+  bundler (~> 1.6)
+  coveralls (~> 0.7.1)
+  factory_girl_rails
+  mongoid (>= 4.0.0)
+  mongoid_simple_audit!
+  rake
+  rspec
+  rspec-rails
+  sqlite3

data/lib/mongoid/simple_audit/audit.rb

@@ -0,0 +1,27 @@
+module Mongoid
+  module SimpleAudit
+    class Audit
+      include Mongoid::Document
+
+      field :auditable_type,  type: String
+      field :auditable_id,    type: String
+
+      index({ auditable_id: 1, auditable_type: 1 })
+
+      embeds_many :modifications
+
+      scope :by_auditable, (lambda do |auditable|
+        where( auditable_type: auditable.class.name, auditable_id: auditable.id )
+      end)      
+
+      def self.find_or_create_by_auditable auditable
+        self.find_or_create_by( auditable_type: auditable.class.name, auditable_id: auditable.id )
+      end
+
+      def self.find_by_auditable auditable
+        self.by_auditable( auditable ).first
+      end
+
+    end
+  end
+end

data/lib/mongoid/simple_audit/helper.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+module Mongoid
+  module SimpleAudit
+    module Helper
+      
+      # Render the change log for the given audited model
+      def render_audits(audited_model)
+        return '' if !audited_model.respond_to?(:audit) || audited_model.audit.nil?
+        audits = (audited_model.audit.modifications).dup.sort{|a,b| b.created_at <=> a.created_at}
+        res = ''
+        audits.each_with_index do |audit, index|
+          older_audit = audits[index + 1]
+          res += content_tag(:div, :class => 'audit') do
+            content_tag(:div, audit.action, :class => "action #{audit.action}") +
+            content_tag(:div, audit.username, :class => "user") + 
+            content_tag(:div, l(audit.created_at), :class => "timestamp") + 
+            content_tag(:div, :class => 'changes') do
+              changes = if older_audit.present?
+                audit.delta(older_audit).sort{|x,y| audited_model.class.human_attribute_name(x.first) <=> audited_model.class.human_attribute_name(y.first)}.collect do |k, v|                
+                  next if k.to_s == 'created_at' || k.to_s == 'updated_at'
+                  "\n" + 
+                  audited_model.class.human_attribute_name(k) +
+                  ":" +
+                  content_tag(:span, (v.last ? v.last.to_s.force_encoding("UTF-8") : '' ), :class => 'current') +
+                  content_tag(:span, (v.first ? v.first.to_s.force_encoding("UTF-8") : '' ), :class => 'previous')
+                end
+              else
+                audit.change_log.sort{|x,y| audited_model.class.human_attribute_name(x.first) <=> audited_model.class.human_attribute_name(y.first)}.reject{|k, v| v.blank?}.collect {|k, v| "\n#{audited_model.class.human_attribute_name(k)}: #{v}"}
+              end
+              raw changes.join
+            end        
+          end
+        end
+        raw res
+      end 
+    end      
+  end
+end

data/lib/mongoid/simple_audit/modification.rb

@@ -0,0 +1,57 @@
+module Mongoid
+  module SimpleAudit
+    class Modification
+      include Mongoid::Document
+      include Mongoid::Timestamps::Created
+      include Mongoid::Attributes::Dynamic if Mongoid::VERSION.to_i > 3
+
+      field :action,      type: String
+      field :username,    type: String
+      field :change_log,  type: Hash
+
+      embedded_in :audit
+
+      # Computes the differences of the change logs between two audits.
+      #
+      # Returns a hash containing arrays of the form 
+      #   {
+      #     :key_1 => [<value_in_other_change_log>, <value_in_this_audit>],
+      #     :key_2 => [<value_in_other_change_log>, <value_in_this_audit>],
+      #   } 
+      def delta(other_change_log)
+        return self.change_log if other_change_log.nil?
+      
+        {}.tap do |d|
+          
+          # first for keys present only in this audit
+          (self.change_log.keys - other_change_log.change_log.keys).each do |k|
+            d[k] = [nil, self.change_log[k]]
+          end
+      
+          # .. then for keys present only in other audit
+          (other_change_log.change_log.keys - self.change_log.keys).each do |k|
+            d[k] = [other_change_log.change_log[k], nil]
+          end
+      
+          # .. finally for keys present in both, but with different values
+          self.change_log.keys.each do |k|
+            if self.change_log[k] != other_change_log.change_log[k]
+              d[k] = [other_change_log.change_log[k], self.change_log[k]]
+            end
+          end
+      
+        end
+
+      end
+
+      # as mongoid stores hashes keys as strings, here us a way to get the change log symbolized
+      # TODO: refactor
+      def symbolized_change_log
+        sym_log = self.change_log.dup
+        sym_log = sym_log.symbolize_keys
+        sym_log.each{ |k,v| sym_log[k] = v.symbolize_keys if v.is_a? Hash }
+        sym_log
+      end
+    end
+  end
+end

data/lib/mongoid/simple_audit/railtie.rb

@@ -0,0 +1,11 @@
+module Mongoid
+  module SimpleAudit
+    class Railtie < Rails::Railtie
+      railtie_name :mongoid_simple_audit
+
+      rake_tasks do
+        require 'mongoid/simple_audit/tasks'
+      end
+    end
+  end
+end