mongoid_simple_audit 0.1.4 → 0.1.6

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDNhMjFmOTBkZTJmMWZiZDI1ZDNhZmJiZWJlMzk0MzdmODNjN2MxOQ==
+    OWZhOTA1ZWNkM2U5YjYwMDUwOWIyMDFlNzhjNGQ3MWRiMGZhOTQ2NQ==
   data.tar.gz: !binary |-
-    YzY1MWFkZjhlZGUzYmIyNDEzOTIyYzMxNGZlZTU5NTViY2EzYmJlYw==
+    NTIyMWFiNDcyNTQ4N2Y3YWQxMjZjMzk5MDgwZmYyNjA2YzI5NTU2Zg==
 SHA512:
   metadata.gz: !binary |-
-    ZTU4MTNmOGVhMTIzNTAxZGEwM2E2ZjQ2ZDYwYjVlMjE2NGIxYWZhOThiMTdk
-    ZGUwNTEzNDQ0YzM0ZTMwZGQ1NjA0NWY0Yjg1Mzg2YWI4Yjg3ZDY5M2U4OTU2
-    NDEwMmNlNTlmZTEzNjNlZjIxZmRiZTk0MGYxN2QwMjE1NjcxNWI=
+    MzM0Nzc0OTYzYjkxMWJkZmQ3Nzg2ODk5MjIzZjQ2NGJjNDA0MDk5ZDNkN2Vm
+    NjMyZmQyMzI3Yzg1ZDdiZTE5ZDMwOTg3NWJhYjBmNjI0OTRjYzc0MDBkMjhj
+    NzIyN2QxYmYwMjRiZDY4ZTQ3ZGRmYWY0YmIyNWZmM2JmNDIzYzI=
   data.tar.gz: !binary |-
-    YjkxNGQyOGYzYTZkN2Q3NzMwODVlODM4YzA3NmU1YzY3NmQxNTI1YTkxYTVi
-    YTVkOGQ3M2I4ZTYwMzM0ZGQyZTU1MmU2M2IzMGM5NTQyYjk0NDc1NDRjZWY4
-    MTNiZmM3OWNjNTcwMGU0NzI2M2I1NWM5ZTU4MGFjZDg5M2U4MmU=
+    ZmU5Mzg1YTRkNWJlYTVkNDMyZmUwMzhkN2Q0ZDFjMjhkZWM5NzMzMzZkMjZh
+    NTE5NjFiYWJmNWRjZTBjMmZmYjM1MWI3MTkzYjZmNjIyYmU1ZmU3NzZiNjA4
+    ZDIwZTA5YmI5OWI5NmRlYTkyM2UzNTBkNjVlY2ViM2I2MTVkYTI=

data/README.md

@@ -2,17 +2,21 @@
 
 # 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.
+This is a 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. Furthermore it is capable of auditing both ActiveRecord and Mongoid models, which is especialy usefull for applications which use both backends.
 
 # 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.
+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
 
+## Requirements
+
+The gem requires Mongoid version 3.x with Ruby on Rails 3.x or Mongoid 4.x with Rails 4.x
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -47,7 +51,7 @@ Don't forget to create the MongoDB indeces
   # in your view
   <%= render_audits(@booking) %>
 
-Audit ActiveRecord models. Somewhere in your (backend) views show the audit logs.
+Audit ActiveRecord or Mongoid models. Somewhere in your (backend) views show the audit logs.
     
     # in your model
     # app/models/booking.rb
@@ -57,6 +61,14 @@ Audit ActiveRecord models. Somewhere in your (backend) views show the audit logs
         ...
     end
     
+    # or for Mongoid
+
+    class Booking
+        include Mongoid::Document
+        simple_audit
+        ...
+    end    
+
     # in your view
     # app/views/bookings/booking.html.erb
     
@@ -64,34 +76,10 @@ Audit ActiveRecord models. Somewhere in your (backend) views show the audit logs
     <%= 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;
-      }
+    # in order to have the default styles, include the stylesheet
+
+    <%= stylesheet_link_tag 'mongoid_simple_audit' %>
 
-      .audit .current {
-        margin-left: 6px;
-      }
-      .audit .previous {
-        margin-left: 6px;
-        text-decoration: line-through;
-      }  
 
 # Assumptions and limitations
 
@@ -142,6 +130,12 @@ only the differences between revisions will be shown, thus making the audit info
 
 Negative aspect though, its not working nicely hand in hand with not MongoDB backends
 
+## How to migrate simple_audit record stored with ActiveRecord
+
+If you want to migrate from the ActiveRecord version of simple_audit to a document based datamodel (maybe because your database got super fat), mongoid_simple_audit has a rake task for that.
+
+  rake mongoid_simple_audit:migrates_from_mysql_to_mongoid
+
 ## Contributing
 
 1. Fork it ( https://github.com/felixabele/mongoid_simple_audit/fork )

data/app/assets/javascripts/mongoid_simple_audit.css

@@ -0,0 +1,28 @@
+/* MongoidSimpleAudit Styles */
+.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;
+}  

data/gemfiles/rails_3.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    mongoid_simple_audit (0.1.4)
+    mongoid_simple_audit (0.1.6)
       mongoid
 
 GEM

data/gemfiles/rails_4.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    mongoid_simple_audit (0.1.4)
+    mongoid_simple_audit (0.1.6)
       mongoid
 
 GEM

data/lib/mongoid/simple_audit/engine.rb

@@ -0,0 +1,7 @@
+module Mongoid
+
+  module SimpleAudit
+    class Engine < Rails::Engine
+    end
+  end
+end

data/lib/mongoid/simple_audit/simple_audit.rb

@@ -59,8 +59,13 @@ module Mongoid
 
             attributes_and_associations = proc do |record|
               changes = record.attributes
-              record.class.reflect_on_all_associations(:belongs_to).each do |assoc|
-                changes[assoc.name] = record.send(assoc.name).to_s
+              as_types = [:belongs_to]
+              as_types << :embeds_one if record.singleton_class.included_modules.include? Mongoid::Document
+
+              as_types.each do |as_type|
+                record.class.reflect_on_all_associations( as_type ).each do |assoc|
+                  changes[assoc.name] = record.send(assoc.name).to_s
+                end
               end
               changes
             end

data/lib/mongoid/simple_audit/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module SimpleAudit
-    VERSION = "0.1.4"
+    VERSION = "0.1.6"
   end
 end

data/lib/mongoid_simple_audit.rb

@@ -2,6 +2,7 @@ require 'mongoid/simple_audit/simple_audit'
 require 'mongoid/simple_audit/audit'
 require 'mongoid/simple_audit/modification'
 require 'mongoid/simple_audit/helper'
+require 'mongoid/simple_audit/engine'
 require File.dirname(__FILE__) + '/mongoid/simple_audit/railtie' if defined?(Rails::Railtie)
 
 if defined?(ActiveRecord::Base)

data/spec/factories.rb

@@ -11,6 +11,17 @@ FactoryGirl.define do
     address
   end  
 
+  factory :mongoid_address, class: "Mongodoc::Address" do
+    line_1  "John"
+    zip     "12047"
+  end  
+
+  factory :mongoid_person, class: "Mongodoc::Person" do
+    name  "Felix"
+    email "felix.abele@gmail.com"
+    address {FactoryGirl.build( :mongoid_address )}
+  end  
+
   factory :user do
     name  "Some user"
   end  

data/spec/models/simple_mongo_audit_spec.rb

@@ -36,11 +36,6 @@ module Mongoid
       expect( person.audit.modifications.last.change_log ).to have_key( 'name' )
     end
 
-    it "should audit associated entity changes" do
-      person = create :person
-      expect( person.audit.modifications.last.change_log['address']['line_1'] ).to be_present
-    end
-
     it "should not audit if no changes where made" do
       person = create :person
       person.update_attributes name: person.name
@@ -55,10 +50,42 @@ module Mongoid
       expect( User.new.full_name ).to eql address.audit.modifications.last.username
     end
 
-    it 'should audit Mongoid models' do 
-      address = MongoidAddress.create(name: 'Hans', street: 'Sesamstr. 18')
-      expect( address.audit.modifications ).not_to be_empty
-    end    
+    # ----------------------------
+    # --- ActiveRecord specific Tests
+    # ----------------------------
+    context "ActiveRecord specific Tests" do
+
+      it "should audit associated entity changes" do
+        person = create :person, address: create(:address, line_1: 'Munich'), name: 'doe1'
+        create_audit = person.audit.modifications.last
+        person.address = create(:address, line_1: 'Berlin')
+        person.name = 'doe2'
+        person.save
+        update_audit = person.audit.modifications.last
+        expect( update_audit.delta(create_audit) ).to eql( {"name"=>["doe1", "doe2"], "address"=>[{"line_1"=>"Munich", "zip"=>"12047"}, {"line_1"=>"Berlin", "zip"=>"12047"}]} )
+      end      
+    end
+
+    # ----------------------------
+    # --- Mongoid specific Tests
+    # ----------------------------
+    context "Mongoid specific Tests" do
+
+      it 'should audit Mongoid models' do 
+        address = Mongodoc::Address.create(line_1: 'Hans', zip: '10928')
+        expect( address.audit.modifications ).not_to be_empty
+      end    
+
+      it "should audit associated entity changes" do
+        person = create :mongoid_person, address: create(:mongoid_address, line_1: 'Munich'), name: 'doe1'
+        create_audit = person.audit.modifications.last
+        person.address = create(:mongoid_address, line_1: 'Berlin')
+        person.name = 'doe2'
+        person.save
+        update_audit = person.audit.modifications.last
+        expect( update_audit.delta(create_audit) ).to eql( {"name"=>["doe1", "doe2"], "address"=>[{"line_1"=>"Munich", "zip"=>"12047"}, {"line_1"=>"Berlin", "zip"=>"12047"}]} )
+      end      
+    end
   end
 
 end  

data/spec/spec_helper.rb

@@ -77,12 +77,6 @@ class Address < ActiveRecord::Base
   simple_audit( username_method: :full_name )
 end
 
-class MongoidAddress  
-  include Mongoid::Document
-  include Mongoid::Attributes::Dynamic if Mongoid::VERSION.to_i > 3
-  simple_audit
-end
-
 class Person < ActiveRecord::Base
   has_one :address
   simple_audit( audit_changes_only: true ) do |record|
@@ -93,6 +87,31 @@ class Person < ActiveRecord::Base
   end
 end
 
+module Mongodoc
+  class Address  
+    include Mongoid::Document
+    field :line_1
+    field :zip
+    field :type
+
+    embeds_one :person, class_name: 'Mongodoc::Person'
+    simple_audit
+  end
+
+  class Person
+    include Mongoid::Document
+    field :name
+    field :email
+    embedded_in :address, class_name: 'Mongodoc::Address'
+    simple_audit( audit_changes_only: true ) do |record|
+      {
+        name: record.name,
+        address: { line_1: record.address.line_1, zip: record.address.zip }
+      }
+    end    
+  end
+end
+
 class HomeAddress < Address
   simple_audit :username_method => :short_name 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_simple_audit
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Felix Abele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-19 00:00:00.000000000 Z
+date: 2014-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -167,11 +167,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/assets/javascripts/mongoid_simple_audit.css
 - gemfiles/rails_3.gemfile
 - gemfiles/rails_3.gemfile.lock
 - gemfiles/rails_4.gemfile
 - gemfiles/rails_4.gemfile.lock
 - lib/mongoid/simple_audit/audit.rb
+- lib/mongoid/simple_audit/engine.rb
 - lib/mongoid/simple_audit/helper.rb
 - lib/mongoid/simple_audit/modification.rb
 - lib/mongoid/simple_audit/railtie.rb