activeaudit 0.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Massimo Maino
+
+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,73 @@
+# ActiveAudit
+
+Audit support for Active Record
+
+[![Build Status](https://travis-ci.org/maintux/activeaudit.png)](https://travis-ci.org/maintux/activeaudit)
+
+## Install
+
+Include `ActiveAudit` in your Gemfile
+```ruby
+gem 'activeaudit', :git=>'https://github.com/maintux/activeaudit.git'
+```
+and update your bundle
+```
+bundle install
+```
+
+Then run the task to generate migration
+```
+rake active_audit_rails_engine:install:migrations
+```
+and execute migration
+```
+rake db:migrate
+```
+
+## Usage
+
+In your model you have to include the mixin
+```ruby
+include ActiveAudit::Logger
+```
+This mixin allow you to use an helper called `loggable_event` that define what you want to log.
+
+The basic syntax is:
+```ruby
+loggable_event create: true
+loggable_event destroy: true
+loggable_event update: true
+```
+With this, ActiveAudit will log events using the standard callbacks `after_create`, `after_update` and `before_destroy`
+
+If you want customize the fields that determine the logging action, you can use the Array syntax like the following example:
+```ruby
+loggable_event update: [:name,:surname]
+```
+So with this syntax, ActiveAudit will log the update event only if `name` __OR__ `surname` fields are changed.
+
+You can also specify the value that a field must have to trigger the logging:
+```ruby
+loggable_event update: [{state: "confirmed"}]
+```
+In this case ActiveAudit will log the update event only if `state` field is changed and the new value is "confirmed"
+
+It's possible to use custom event name that is managed like an update event. For exaple you can create an event called `confirmation` like this:
+```ruby
+loggable_event confirmation: [{state: "confirmed"}]
+```
+
+## Contributing to ActiveAudit
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2013 Massimo Maino. See LICENSE.txt for further details.
+

data/app/models/active_audit/audit.rb

@@ -0,0 +1,13 @@
+class ActiveAudit::Audit < ActiveRecord::Base
+
+  attr_accessible :obj_id, :obj_type, :activity, :user_id
+  validates_presence_of :obj_id, :obj_type, :activity
+
+  if defined?(::Rails)
+    ::ActiveAudit::AuditConcern
+    if defined?(::ActiveAudit::AuditConcern)
+      include ::ActiveAudit::AuditConcern
+    end
+  end
+
+end

data/db/migrate/1_create_active_audits.rb

@@ -0,0 +1,14 @@
+class CreateActiveAudits < ActiveRecord::Migration
+  def change
+    create_table :audits do |t|
+      t.integer :obj_id
+      t.string :obj_type
+      t.integer :user_id
+      t.text :activity
+
+      t.timestamps
+    end
+    add_index :audits, :obj_id
+    add_index :audits, :user_id
+  end
+end

data/lib/active_audit/engine.rb

@@ -0,0 +1,14 @@
+require 'active_audit/logger'
+
+module ActiveAudit
+  module Rails
+    class Engine < ::Rails::Engine
+      initializer 'activeservice.autoload', :before => :set_autoload_paths do |app|
+        app.config.autoload_paths += %W(#{app.config.root}/app/concerns/active_audit)
+      end
+      #ActiveRecord::Base.class_eval do
+        #include ActiveAudit::Logger
+      #end
+    end
+  end
+end

data/lib/active_audit/logger.rb

@@ -0,0 +1,95 @@
+require 'active_support/concern'
+
+module ActiveAudit
+  module Logger
+
+    extend ActiveSupport::Concern
+
+    included do
+
+      after_create :log_activity_on_create
+      after_update :log_activity_on_update
+      before_destroy :log_activity_on_destroy
+
+      attr_accessible :audit_user_id
+      attr_accessor :audit_user_id
+
+      @@_loggable_events = {}
+
+      def self.loggable_event(event)
+        @@_loggable_events.merge! event
+      end
+
+      def self.loggable_events
+        @@_loggable_events
+      end
+
+      def log_activity_on_create
+        @@_loggable_events.each do |k,v|
+          next unless k.eql?(:create)
+          if v.eql?(true)
+            ActiveAudit::Audit.create obj_id: id, obj_type: self.class.to_s, user_id: audit_user_id, activity: k.to_s
+          elsif v.is_a?(Array)
+            log_event = false
+            v.each do |field|
+              if field.is_a?(Hash)
+                key, value = field.first
+                if self.send(key.to_s).eql?(value)
+                  log_event = true
+                  break
+                end
+              elsif field.is_a?(Symbol)
+                if self.send(field.to_s)
+                  log_event = true
+                  break
+                end
+              end
+            end
+            if log_event
+              ActiveAudit::Audit.create obj_id: id, obj_type: self.class.to_s, user_id: audit_user_id, activity: k.to_s
+            end
+          end
+        end
+      end
+
+      def log_activity_on_update
+        @@_loggable_events.each do |k,v|
+          next if [:create,:destroy].include?(k)
+          if k.eql?(:update) and v.eql?(true)
+            ActiveAudit::Audit.create obj_id: id, obj_type: self.class.to_s, user_id: audit_user_id, activity: k.to_s
+          else
+            if v.is_a?(Array)
+              log_event = false
+              v.each do |field|
+                if field.is_a?(Hash)
+                  key, value = field.first
+                  if self.send("#{key}_changed?") and self.send(key.to_s).eql?(value)
+                    log_event = true
+                    break
+                  end
+                elsif field.is_a?(Symbol)
+                  if self.send("#{field}_changed?")
+                    log_event = true
+                    break
+                  end
+                end
+              end
+              if log_event
+                ActiveAudit::Audit.create obj_id: id, obj_type: self.class.to_s, user_id: audit_user_id, activity: k.to_s
+              end
+            end
+          end
+        end
+      end
+
+      def log_activity_on_destroy
+        @@_loggable_events.each do |k,v|
+          next unless k.eql?(:destroy)
+          ActiveAudit::Audit.create obj_id: id, obj_type: self.class.to_s, user_id: audit_user_id, activity: k.to_s
+        end
+      end
+
+    end
+
+  end
+end

data/lib/activeaudit.rb

@@ -0,0 +1,9 @@
+module ActiveAudit
+  def self.load!
+    if defined?(::Rails)
+      require 'active_audit/engine'
+    end
+  end
+end
+
+ActiveAudit.load!

data/spec/callbacks_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+require 'models/person'
+require './app/models/active_audit/audit'
+
+describe "Callbacks" do
+
+  before :each do
+    ActiveAudit::Audit.destroy_all
+    @person = Person.create name: Faker::Name.first_name, surname: Faker::Name.last_name, age: 10, audit_user_id: 1
+    @person.should_not be_nil
+  end
+
+  it "should create a 'create log'" do
+    ActiveAudit::Audit.count.should eq(1)
+    latest_log = ActiveAudit::Audit.last
+    latest_log.obj_id.should eq(@person.id)
+    latest_log.obj_type.should eq("Person")
+    latest_log.activity.should eq("create")
+    latest_log.user_id.should eq(1)
+  end
+
+  it "should create a 'destroy log'" do
+    @person.destroy
+    ActiveAudit::Audit.count.should eq(2)
+    latest_log = ActiveAudit::Audit.last
+    latest_log.obj_id.should eq(@person.id)
+    latest_log.obj_type.should eq("Person")
+    latest_log.activity.should eq("destroy")
+    latest_log.user_id.should eq(1)
+  end
+
+  it "should create a 'update log' - One field" do
+    @person.name = "new_#{Faker::Name.first_name}"
+    @person.save
+    ActiveAudit::Audit.count.should eq(2)
+    latest_log = ActiveAudit::Audit.last
+    latest_log.obj_id.should eq(@person.id)
+    latest_log.obj_type.should eq("Person")
+    latest_log.activity.should eq("update")
+    latest_log.user_id.should eq(1)
+  end
+
+  it "should create a 'update log' - More fields" do
+    @person.name = "new_#{Faker::Name.first_name}"
+    @person.surname = "new_#{Faker::Name.last_name}"
+    @person.email = Faker::Internet.email
+    @person.save
+    ActiveAudit::Audit.count.should eq(2)
+    latest_log = ActiveAudit::Audit.last
+    latest_log.obj_id.should eq(@person.id)
+    latest_log.obj_type.should eq("Person")
+    latest_log.activity.should eq("update")
+    latest_log.user_id.should eq(1)
+  end
+
+  it "should not create a 'update log' - External field" do
+    @person.email = Faker::Internet.email
+    @person.save
+    ActiveAudit::Audit.count.should eq(1)
+  end
+
+  it "should not create a 'update log' - Field linked to other event" do
+    @person.age = 1
+    @person.save
+    ActiveAudit::Audit.count.should eq(1)
+  end
+
+  it "should create a 'child log'" do
+    @person.age = 14
+    @person.save
+    ActiveAudit::Audit.count.should eq(2)
+    latest_log = ActiveAudit::Audit.last
+    latest_log.obj_id.should eq(@person.id)
+    latest_log.obj_type.should eq("Person")
+    latest_log.activity.should eq("child")
+    latest_log.user_id.should eq(1)
+  end
+
+  it "should create a 'adult log'" do
+    @person.age = 18
+    @person.save
+    ActiveAudit::Audit.count.should eq(2)
+    latest_log = ActiveAudit::Audit.last
+    latest_log.obj_id.should eq(@person.id)
+    latest_log.obj_type.should eq("Person")
+    latest_log.activity.should eq("adult")
+    latest_log.user_id.should eq(1)
+  end
+
+  it "should create a 'adult log' and 'update log'" do
+    @person.age = 18
+    @person.name = "new_#{Faker::Name.first_name}"
+    @person.save
+    ActiveAudit::Audit.count.should eq(3)
+    latest_logs = ActiveAudit::Audit.last(2)
+    first_log = latest_logs.first
+    first_log.obj_id.should eq(@person.id)
+    first_log.obj_type.should eq("Person")
+    first_log.activity.should eq("update")
+    first_log.user_id.should eq(1)
+    second_log = latest_logs.second
+    second_log.obj_id.should eq(@person.id)
+    second_log.obj_type.should eq("Person")
+    second_log.activity.should eq("adult")
+    second_log.user_id.should eq(1)
+  end
+
+end

data/spec/core_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'models/person'
+
+describe "Core" do
+
+  it "should have loggable_event method" do
+    ret = Person.respond_to?(:loggable_event)
+    ret.should be_true
+  end
+
+  it "should have audit_user_id attribute" do
+    person = Person.new
+    ret = person.respond_to?(:audit_user_id)
+    ret.should be_true
+  end
+
+  it "should have right loggable_events" do
+    events = Person.loggable_events
+    events.should eq({create: true, destroy: true, update: [:name,:surname], adult: [{age: 18}], child: [{age: 14}]})
+  end
+
+end

data/spec/models/person.rb

@@ -0,0 +1,12 @@
+class Person < ActiveRecord::Base
+  include ActiveAudit::Logger
+
+  attr_accessible :name, :surname, :age
+
+  loggable_event create: true
+  loggable_event destroy: true
+  loggable_event update: [:name,:surname]
+  loggable_event adult: [{age: 18}]
+  loggable_event child: [{age: 14}]
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'active_audit/logger'
+require 'active_record'
+require 'faker'
+require './db/migrate/1_create_active_audits'
+
+puts "Removing test database..."
+if File.exist? "spec/db/active_audit_test.sqlite3"
+  File.unlink "spec/db/active_audit_test.sqlite3"
+end
+ActiveRecord::Base.establish_connection(
+  :adapter  => "sqlite3",
+  :database => "spec/db/active_audit_test.sqlite3",
+)
+puts "Creating test tables..."
+ActiveRecord::Base.connection.execute("CREATE TABLE `people`(`id` INTEGER PRIMARY KEY AUTOINCREMENT, `name` TEXT, `surname` TEXT, `email` TEXT, `age` INT, `created_at` DATETIME, `updated_at` DATETIME);")
+CreateActiveAudits.migrate :up
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: activeaudit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Massimo Maino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Audit support for Active Record
+email: maintux@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- app/models/active_audit/audit.rb
+- db/migrate/1_create_active_audits.rb
+- lib/active_audit/engine.rb
+- lib/active_audit/logger.rb
+- lib/activeaudit.rb
+- spec/callbacks_spec.rb
+- spec/core_spec.rb
+- spec/models/person.rb
+- spec/spec_helper.rb
+- LICENSE.txt
+- README.md
+homepage: http://github.com/maintux/activeaudit
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4479424809207949742
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Audit support for Active Record
+test_files: []