notifiably_audited 0.0.6 → 0.0.7

data/lib/notifiably_audited.rb

@@ -0,0 +1,15 @@
+module Audited
+  VERSION = '3.0.0'
+
+  class << self
+    attr_accessor :ignored_attributes, :current_user_method, :audit_class
+
+    def store
+      Thread.current[:audited_store] ||= {}
+    end
+  end
+
+  @ignored_attributes = %w(lock_version created_at updated_at created_on updated_on)
+
+  @current_user_method = :current_user
+end

data/notifiably_audited.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'notifiably_audited/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "notifiably_audited"
+  spec.version       = NotifiablyAudited::VERSION
+  spec.authors       = ["TODO: Write your name"]
+  spec.email         = ["TODO: Write your email address"]
+  spec.summary       = %q{TODO: Write a short summary. Required.}
+  spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/spec/audited_spec_helpers.rb

@@ -0,0 +1,31 @@
+module AuditedSpecHelpers
+
+  def create_user(use_mongo = false, attrs = {})
+    klass = use_mongo ? Models::MongoMapper::User : Models::ActiveRecord::User
+    klass.create({:name => 'Brandon', :username => 'brandon', :password => 'password'}.merge(attrs))
+  end
+
+  def create_versions(n = 2, use_mongo = false)
+    klass = use_mongo ? Models::MongoMapper::User : Models::ActiveRecord::User
+
+    klass.create(:name => 'Foobar 1').tap do |u|
+      (n - 1).times do |i|
+        u.update_attribute :name, "Foobar #{i + 2}"
+      end
+      u.reload
+    end
+  end
+
+  def create_active_record_user(attrs = {})
+    create_user(false, attrs)
+  end
+
+  def create_mongo_user(attrs = {})
+    create_user(true, attrs)
+  end
+
+  def create_mongo_versions(n = 2)
+    create_versions(n, true)
+  end
+
+end

data/spec/rails_app/config/application.rb

@@ -0,0 +1,5 @@
+module RailsApp
+  class Application < Rails::Application
+    config.root = File.expand_path('../../', __FILE__)
+  end
+end

data/spec/rails_app/config/database.yml

@@ -0,0 +1,24 @@
+sqlite3mem: &SQLITE3MEM
+  adapter: sqlite3
+  database: ":memory:"
+
+sqlite3: &SQLITE
+  adapter: sqlite3
+  database: audited_test.sqlite3.db
+
+postgresql: &POSTGRES
+  adapter: postgresql
+  username: postgres
+  password: postgres
+  database: audited_test
+  min_messages: ERROR
+
+mysql: &MYSQL
+  adapter: mysql
+  host: localhost
+  username: root
+  password:
+  database: audited_test
+
+test:
+  <<: *<%= ENV['DB'] || 'SQLITE3MEM' %>

data/spec/rails_app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+RailsApp::Application.initialize!

data/spec/rails_app/config/environments/development.rb

@@ -0,0 +1,19 @@
+RailsApp::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_view.debug_rjs             = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+end

data/spec/rails_app/config/environments/production.rb

@@ -0,0 +1,33 @@
+RailsApp::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  config.serve_static_assets = false
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+end

data/spec/rails_app/config/environments/test.rb

@@ -0,0 +1,33 @@
+RailsApp::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  config.action_dispatch.show_exceptions = false
+
+  config.active_support.deprecation = :stderr
+end

data/spec/rails_app/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+Rails.backtrace_cleaner.remove_silencers!

data/spec/rails_app/config/initializers/inflections.rb

@@ -0,0 +1,2 @@
+ActiveSupport::Inflector.inflections do |inflect|
+end

data/spec/rails_app/config/initializers/secret_token.rb

@@ -0,0 +1,2 @@
+Rails.application.config.secret_token = 'ea942c41850d502f2c8283e26bdc57829f471bb18224ddff0a192c4f32cdf6cb5aa0d82b3a7a7adbeb640c4b06f3aa1cd5f098162d8240f669b39d6b49680571'
+Rails.application.config.session_store :cookie_store, :key => "_my_app"

data/spec/rails_app/config/routes.rb

@@ -0,0 +1,6 @@
+Rails.application.routes.draw do
+
+  # This is a legacy wild controller route that's not recommended for RESTful applications.
+  # Note: This route will make all actions in every controller accessible via GET requests.
+  match ':controller(/:action(/:id(.:format)))'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+ENV['RAILS_ENV'] = 'test'
+
+require 'rails/all'
+require 'rails_app/config/environment'
+require 'rspec/rails'
+require 'audited'
+require 'audited_spec_helpers'
+
+SPEC_ROOT = Pathname.new(File.expand_path('../', __FILE__))
+
+Dir[SPEC_ROOT.join('support/*.rb')].each{|f| require f }
+
+RSpec.configure do |config|
+  config.include AuditedSpecHelpers
+
+  config.before(:each, :adapter => :active_record) do
+    Audited.audit_class = Audited::Adapters::ActiveRecord::Audit
+  end
+
+  config.before(:each, :adapter => :mongo_mapper) do
+    Audited.audit_class = Audited::Adapters::MongoMapper::Audit
+  end
+end

data/spec/support/active_record/models.rb

@@ -0,0 +1,84 @@
+require 'cgi'
+require File.expand_path('../schema', __FILE__)
+
+module Models
+  module ActiveRecord
+    class User < ::ActiveRecord::Base
+      audited :allow_mass_assignment => true, :except => :password
+
+      attr_protected :logins
+
+      def name=(val)
+        write_attribute(:name, CGI.escapeHTML(val))
+      end
+    end
+
+    class CommentRequiredUser < ::ActiveRecord::Base
+      self.table_name = :users
+      audited :comment_required => true
+    end
+
+    class AccessibleAfterDeclarationUser < ::ActiveRecord::Base
+      self.table_name = :users
+      audited
+      attr_accessible :name, :username, :password
+    end
+
+    class AccessibleBeforeDeclarationUser < ::ActiveRecord::Base
+      self.table_name = :users
+      attr_accessible :name, :username, :password # declare attr_accessible before calling aaa
+      audited
+    end
+
+    class NoAttributeProtectionUser < ::ActiveRecord::Base
+      self.table_name = :users
+      audited :allow_mass_assignment => true
+    end
+
+    class UserWithAfterAudit < ::ActiveRecord::Base
+      self.table_name = :users
+      audited
+      attr_accessor :bogus_attr
+
+      def after_audit
+        self.bogus_attr = "do something"
+      end
+    end
+
+    class Company < ::ActiveRecord::Base
+      audited
+    end
+
+    class Owner < ::ActiveRecord::Base
+      self.table_name = 'users'
+      has_associated_audits
+    end
+
+    class OwnedCompany < ::ActiveRecord::Base
+      self.table_name = 'companies'
+      belongs_to :owner, :class_name => "Owner"
+      attr_accessible :name, :owner # declare attr_accessible before calling aaa
+      audited :associated_with => :owner
+    end
+
+    class OnUpdateDestroy < ::ActiveRecord::Base
+      self.table_name = 'companies'
+      audited :on => [:update, :destroy]
+    end
+
+    class OnCreateDestroy < ::ActiveRecord::Base
+      self.table_name = 'companies'
+      audited :on => [:create, :destroy]
+    end
+
+    class OnCreateDestroyExceptName < ::ActiveRecord::Base
+      self.table_name = 'companies'
+      audited :except => :name, :on => [:create, :destroy]
+    end
+
+    class OnCreateUpdate < ::ActiveRecord::Base
+      self.table_name = 'companies'
+      audited :on => [:create, :update]
+    end
+  end
+end

data/spec/support/active_record/schema.rb

@@ -0,0 +1,54 @@
+require 'active_record'
+require 'logger'
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+ActiveRecord::Base.logger = Logger.new(SPEC_ROOT.join('debug.log'))
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Schema.define do
+  create_table :users, :force => true do |t|
+    t.column :name, :string
+    t.column :username, :string
+    t.column :password, :string
+    t.column :activated, :boolean
+    t.column :suspended_at, :datetime
+    t.column :logins, :integer, :default => 0
+    t.column :created_at, :datetime
+    t.column :updated_at, :datetime
+  end
+
+  create_table :companies, :force => true do |t|
+    t.column :name, :string
+    t.column :owner_id, :integer
+  end
+
+  create_table :authors, :force => true do |t|
+    t.column :name, :string
+  end
+
+  create_table :books, :force => true do |t|
+    t.column :authord_id, :integer
+    t.column :title, :string
+  end
+
+  create_table :audits, :force => true do |t|
+    t.column :auditable_id, :integer
+    t.column :auditable_type, :string
+    t.column :associated_id, :integer
+    t.column :associated_type, :string
+    t.column :user_id, :integer
+    t.column :user_type, :string
+    t.column :username, :string
+    t.column :action, :string
+    t.column :audited_changes, :text
+    t.column :version, :integer, :default => 0
+    t.column :comment, :string
+    t.column :remote_address, :string
+    t.column :created_at, :datetime
+  end
+
+  add_index :audits, [:auditable_id, :auditable_type], :name => 'auditable_index'
+  add_index :audits, [:associated_id, :associated_type], :name => 'associated_index'
+  add_index :audits, [:user_id, :user_type], :name => 'user_index'
+  add_index :audits, :created_at
+end

data/spec/support/mongo_mapper/connection.rb

@@ -0,0 +1,4 @@
+require 'mongo_mapper'
+
+MongoMapper.connection = Mongo::Connection.new
+MongoMapper.database = 'audited_test'

data/spec/support/mongo_mapper/models.rb

@@ -0,0 +1,210 @@
+require 'cgi'
+require 'mongo_mapper'
+require File.expand_path('../connection', __FILE__)
+
+module Models
+  module MongoMapper
+    class User
+      include ::MongoMapper::Document
+
+      key :name, String
+      key :username, String
+      key :password, String
+      key :activated, Boolean
+      key :suspended_at, Time
+      key :logins, Integer, :default => 0
+      timestamps!
+
+      audited :allow_mass_assignment => true, :except => :password
+
+      attr_protected :logins
+
+      def name=(val)
+        write_attribute(:name, CGI.escapeHTML(val))
+      end
+    end
+
+    class CommentRequiredUser
+      include ::MongoMapper::Document
+
+      key :name, String
+      key :username, String
+      key :password, String
+      key :activated, Boolean
+      key :suspended_at, Time
+      key :logins, Integer, :default => 0
+      timestamps!
+
+      audited :comment_required => true
+    end
+
+    class AccessibleAfterDeclarationUser
+      include ::MongoMapper::Document
+
+      key :name, String
+      key :username, String
+      key :password, String
+      key :activated, Boolean
+      key :suspended_at, Time
+      key :logins, Integer, :default => 0
+      timestamps!
+
+      audited
+      attr_accessible :name, :username, :password
+    end
+
+    class AccessibleBeforeDeclarationUser
+      include ::MongoMapper::Document
+
+      key :name, String
+      key :username, String
+      key :password, String
+      key :activated, Boolean
+      key :suspended_at, Time
+      key :logins, Integer, :default => 0
+      timestamps!
+
+      attr_accessible :name, :username, :password # declare attr_accessible before calling aaa
+      audited
+    end
+
+    class NoAttributeProtectionUser
+      include ::MongoMapper::Document
+
+      key :name, String
+      key :username, String
+      key :password, String
+      key :activated, Boolean
+      key :suspended_at, Time
+      key :logins, Integer, :default => 0
+      timestamps!
+
+      audited :allow_mass_assignment => true
+    end
+
+    class UserWithAfterAudit
+      include ::MongoMapper::Document
+
+      key :name, String
+      key :username, String
+      key :password, String
+      key :activated, Boolean
+      key :suspended_at, Time
+      key :logins, Integer, :default => 0
+      timestamps!
+
+      audited
+      attr_accessor :bogus_attr
+
+      def after_audit
+        self.bogus_attr = "do something"
+      end
+    end
+
+    class Company
+      include ::MongoMapper::Document
+
+      key :name, String
+      key :owner_id, ObjectId
+
+      audited
+    end
+
+    class Owner
+      include ::MongoMapper::Document
+
+      key :name, String
+      key :username, String
+      key :password, String
+      key :activated, Boolean
+      key :suspended_at, Time
+      key :logins, Integer, :default => 0
+      timestamps!
+
+      has_associated_audits
+    end
+
+    class OwnedCompany
+      include ::MongoMapper::Document
+
+      key :name, String
+      key :owner_id, ObjectId
+
+      belongs_to :owner, :class_name => "Owner"
+      attr_accessible :name, :owner # declare attr_accessible before calling aaa
+      audited :associated_with => :owner
+    end
+
+    class OnUpdateDestroy
+      include ::MongoMapper::Document
+
+      key :name, String
+      key :owner_id, ObjectId
+
+      audited :on => [:update, :destroy]
+    end
+
+    class OnCreateDestroy
+      include ::MongoMapper::Document
+
+      key :name, String
+      key :owner_id, ObjectId
+
+      audited :on => [:create, :destroy]
+    end
+
+    class OnCreateDestroyExceptName
+      include ::MongoMapper::Document
+
+      key :name, String
+      key :owner_id, ObjectId
+
+      audited :except => :name, :on => [:create, :destroy]
+    end
+
+    class OnCreateUpdate
+      include ::MongoMapper::Document
+
+      key :name, String
+      key :owner_id, ObjectId
+
+      audited :on => [:create, :update]
+    end
+
+    class RichObjectUser
+      include ::MongoMapper::Document
+
+      class Name
+        attr_accessor :first_name, :last_name
+
+        def self.from_mongo(value)
+          case value
+          when String then new(*value.split)
+          when self then value
+          end
+        end
+
+        def self.to_mongo(value)
+          case value
+          when String then value
+          when self then value.to_s
+          end
+        end
+
+        def initialize(first_name, last_name)
+          self.first_name, self.last_name = first_name, last_name
+        end
+
+        def to_s
+          [first_name, last_name].compact.join(' ')
+        end
+      end
+
+      key :name, Name
+
+      attr_accessible :name
+
+      audited
+    end
+  end
+end

data/test/db/version_1.rb

@@ -0,0 +1,17 @@
+ActiveRecord::Schema.define do
+  create_table :audits, :force => true do |t|
+    t.column :auditable_id, :integer
+    t.column :auditable_type, :string
+    t.column :user_id, :integer
+    t.column :user_type, :string
+    t.column :username, :string
+    t.column :action, :string
+    t.column :changes, :text
+    t.column :version, :integer, :default => 0
+    t.column :created_at, :datetime
+  end
+
+  add_index :audits, [:auditable_id, :auditable_type], :name => 'auditable_index'
+  add_index :audits, [:user_id, :user_type], :name => 'user_index'
+  add_index :audits, :created_at
+end

data/test/db/version_2.rb

@@ -0,0 +1,18 @@
+ActiveRecord::Schema.define do
+  create_table :audits, :force => true do |t|
+    t.column :auditable_id, :integer
+    t.column :auditable_type, :string
+    t.column :user_id, :integer
+    t.column :user_type, :string
+    t.column :username, :string
+    t.column :action, :string
+    t.column :changes, :text
+    t.column :version, :integer, :default => 0
+    t.column :comment, :string
+    t.column :created_at, :datetime
+  end
+
+  add_index :audits, [:auditable_id, :auditable_type], :name => 'auditable_index'
+  add_index :audits, [:user_id, :user_type], :name => 'user_index'
+  add_index :audits, :created_at
+end

data/test/db/version_3.rb

@@ -0,0 +1,19 @@
+ActiveRecord::Schema.define do
+  create_table :audits, :force => true do |t|
+    t.column :auditable_id, :integer
+    t.column :auditable_type, :string
+    t.column :user_id, :integer
+    t.column :user_type, :string
+    t.column :username, :string
+    t.column :action, :string
+    t.column :audited_changes, :text
+    t.column :version, :integer, :default => 0
+    t.column :comment, :string
+    t.column :created_at, :datetime
+  end
+
+  add_index :audits, [:auditable_id, :auditable_type], :name => 'auditable_index'
+  add_index :audits, [:user_id, :user_type], :name => 'user_index'
+  add_index :audits, :created_at
+end
+

data/test/db/version_4.rb

@@ -0,0 +1,20 @@
+ActiveRecord::Schema.define do
+  create_table :audits, :force => true do |t|
+    t.column :auditable_id, :integer
+    t.column :auditable_type, :string
+    t.column :user_id, :integer
+    t.column :user_type, :string
+    t.column :username, :string
+    t.column :action, :string
+    t.column :audited_changes, :text
+    t.column :version, :integer, :default => 0
+    t.column :comment, :string
+    t.column :created_at, :datetime
+    t.column :remote_address, :string
+  end
+
+  add_index :audits, [:auditable_id, :auditable_type], :name => 'auditable_index'
+  add_index :audits, [:user_id, :user_type], :name => 'user_index'
+  add_index :audits, :created_at
+end
+