audit_model 0.2.0 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ecfdf66cff271315a58dde4a53b3699c26cd513
-  data.tar.gz: e8f1672bce78f28ccabe6bd41a0f0451cdd285b1
+  metadata.gz: ebd0dcefac241688d051a1f655677777a08ddb6d
+  data.tar.gz: bf92e33f15d3dcc5188db421fe1add51e605502d
 SHA512:
-  metadata.gz: 9dd4a6f127ad3dd0b21ad950b0f2b075ecac5b349ff1d763a30aca684ac0230043530ee37ba60e67997980db403575bd6a2ae96dd4e64858fd374d91aff2254a
-  data.tar.gz: 151fe8095d9822825490bc931654c0d317f7f362c4b8ef6dffe7d2c2495ec798b00779dce21bd6e1708b19bc9e3f5c5d196fb92e083dc46d20897e6b6865df44
+  metadata.gz: 851c47ab75009da4e4135ebdc799c59ab9815619d9d0d4e96f58043e0cd22d02c4052bde5a2e02f00c0687b11af07f98609b00468a065cc3dc81fdf74abd31fb
+  data.tar.gz: ff994a7e238bb17dfff34d8f58b09f56b24f0226df8f0158535040992380be0c578aa8845bfc9fb9fc902e16d8104e9b737be5f8af73daceafaed9b9012a2676

data/README.md

@@ -32,23 +32,74 @@ class User < ActiveRecord::Base
 end
 ```
 
+## Configuration
+When you run the following command you create a configuration file **config/initializers/audit_model.rb**
+```
+rails g audit_model:install
+```
+You can configure which method the application uses to retrieve the current user by default the method is [#current_user](#).
+```
+#!ruby
+AuditModel.setup do |config|
+  config.user_method = "current_user"  
+end
+```
+
 ## Usage
 In the model you have [#audits](#) method that returns the audits.
 ```
 #!ruby
-User.audits
+user = User.create(email: "user@example.com", name: "user example")
+user.audits
 ```
 Audits are ActiveRecord models, knowing that you can make any query based on ActiveRecord.
 You can do something like this:
 ```
 #!ruby
-User.audits.last
+user.audits.last
 ```
 This will return the last change in the model.
+You can also use [#revisions](#)
+```
+#!ruby
+user = User.find 3
+revision = user.revisions.last
+```
+So it's possible to obtain information
+```
+#!ruby
+revision.user # User who made the changes
+revision.revision_date 
+revision.model # Model that was audited.
+revision.audit # Model with the audit information
+```
+## Disabling auditing
+
+If you want to disable auditing, you can use [#without_audit](#) in your model class.
+
+```
+#!ruby
+User.without_audit do 
+  User.create(name: "User example", email: "user.example@domain.com")
+end
+
+User.without_audit do 
+  user = User.find 3
+  user.update(email: "user-example@domain.com")
+end
+```
+
 ## License
 
 AuditModel is released under the [MIT License](http://www.opensource.org/licenses/MIT).
 
+
+## Inspirations
+
+* [Audited](https://github.com/collectiveidea/audited)
+* [PaperTrail](https://github.com/airblade/paper_trail)
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on BitBucket at https://bitbucket.org/alissonbruno/audit_model

data/lib/audit_model/controllers/helpers.rb

@@ -10,11 +10,11 @@ module AuditModel
 
       module InstanceMethods
         def set_current_user
-          Thread.current[:user_id] = get_user.try(:id)
+          Thread.current[:user] = get_user
         end
 
         def clear_current_user
-          Thread.current[:user_id] = nil
+          Thread.current[:user] = nil
         end
 
         private

data/lib/audit_model/models/base.rb

@@ -2,7 +2,8 @@ module AuditModel
   module Models
     class Base < ActiveRecord::Base
       self.abstract_class = true
-      
+      has_one :revision, foreign_key: "audit_id"
+
       BLACK_LIST = [
         "id", 
         "created_at", 
@@ -14,26 +15,29 @@ module AuditModel
       end
 
       class << self
-        def audit(model, type)
-          revision = Revision.new({
-            model: model,
-            user_id: Thread.current[:user_id],
-            revison_date: Time.now
-          })
-          revision.audit = new sanitizer_args(model, type)
-          revision.save!
+        def build(model, type)
+          return if type == :update && !any_change?(model)
+          attrs = sanitize(model, type)
+          attrs[:rev_type] = type
+          new(attrs)
         end
 
         private
 
-        def sanitizer_args(model, type) 
-          args = model.attributes.merge(model.changed_attributes)
-          args.except!(*BLACK_LIST).select! {|k,v| copy?(k) }
-          args[:rev_type] = type
-          args
+        def sanitize(model, type)
+          if type == :update
+            attrs = model.attributes.merge(model.changed_attributes)
+          elsif 
+            attrs = model.attributes
+          end
+          attrs.except(*BLACK_LIST).select { |key,value| has_audit?(key) }
+        end
+
+        def any_change?(model)
+          model.changed? && model.changed_attributes.any? { |key,value| has_audit?(key) }
         end
 
-        def copy?(attribute)
+        def has_audit?(attribute)
           attribute_names.include?(attribute)
         end
       end

data/lib/audit_model/models/helpers.rb

@@ -3,17 +3,32 @@ module AuditModel
     module Helpers
       extend ActiveSupport::Concern
 
-      included do
-        send :include, InstanceMethods
-      end
-
       module ClassMethods
         def auditable(options = {}) 
-          options[:on] ||= [:update, :destroy]
+          send :include, InstanceMethods
+          class_attribute :audit_enabled, instance_writer: false
+          options[:on] ||= [:create, :update, :destroy]
           setup_callbacks options[:on]
           setup_model
-          has_many :revisions, as: :model, class_name: "AuditModel::Models::Revision"
-          has_many :audits, through: :revisions, source: :audit, source_type: audit_class
+          setup_associations
+
+          send :enable_audit
+        end
+
+        def without_audit 
+          cache = audit_enabled
+          disable_audit
+          yield
+        ensure
+          enable_audit if cache
+        end
+
+        def disable_audit
+          self.audit_enabled = false
+        end
+
+        def enable_audit
+          self.audit_enabled = true
         end
 
         private
@@ -27,6 +42,11 @@ module AuditModel
           Object.const_set audit_class, Class.new(Models::Base)
         end
 
+        def setup_associations
+          has_many :revisions, as: :model, class_name: "AuditModel::Models::Revision"
+          has_many :audits, through: :revisions, source: :audit, source_type: audit_class
+        end
+
         def callback_on_create
           after_create :audit_on_create
         end
@@ -36,7 +56,7 @@ module AuditModel
         end
 
         def callback_on_destroy
-          before_destroy :audit_on_destroy
+          after_destroy :audit_on_destroy
         end
 
         def audit_class 
@@ -45,18 +65,20 @@ module AuditModel
       end
 
       module InstanceMethods
+        private
+
         def audit_on_create
-          "#{self.class}Audit".constantize.audit(self, :create)
+          Revision.audit(self, :create) if self.class.audit_enabled 
         end
 
         def audit_on_update
-          "#{self.class}Audit".constantize.audit(self, :update)
+          Revision.audit(self, :update) if self.changed? && self.class.audit_enabled
         end
 
         def audit_on_destroy
-          "#{self.class}Audit".constantize.audit(self, :destroy)
+          Revision.audit(self, :destroy) unless self.new_record? || !self.class.audit_enabled
         end
-
+        
       end
     end
   end

data/lib/audit_model/models/revision.rb

@@ -3,6 +3,25 @@ module AuditModel
     class Revision < ActiveRecord::Base
       belongs_to :model, polymorphic: true
       belongs_to :audit, polymorphic: true
+      belongs_to :user, polymorphic: true
+
+      class << self
+        def audit(model, type) 
+          data = {
+            model: model,
+            user: Thread.current[:user],
+            revision_date: Time.now,
+            audit: audit_class_for(model).build(model, type)
+          }
+          create(data)
+        end
+
+        private
+
+        def audit_class_for(model) 
+          "#{model.class}Audit".constantize
+        end
+      end
     end
   end
 end

data/lib/audit_model/version.rb

@@ -1,3 +1,3 @@
 module AuditModel
-  VERSION = "0.2.0"
+  VERSION = "0.3"
 end

data/lib/generators/audit_model/install/templates/revision.rb

@@ -1,13 +1,16 @@
 class CreateRevisions < ActiveRecord::Migration
   create_table :revisions do |t|
-    t.integer   :user_id, index: true
+    t.integer   :user_id
+    t.string    :user_type
     t.integer   :model_id
     t.string    :model_type
     t.integer   :audit_id
     t.string    :audit_type
 
-    t.timestamp :revison_date
+    t.timestamp :revision_date
   end
-  add_index :revisions, [:model_id, :model_type], :name => 'model_index'
-  add_index :revisions, [:audit_id, :audit_type], :name => 'audit_index'
+
+  add_index :revisions, [:user_id, :user_type], name: 'revision_user_index'
+  add_index :revisions, [:model_id, :model_type], name: 'revision_model_index'
+  add_index :revisions, [:audit_id, :audit_type], name: 'revision_audit_index'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: audit_model
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: '0.3'
 platform: ruby
 authors:
 - Alisson Bruno
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-01 00:00:00.000000000 Z
+date: 2016-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler