audited-hp 4.3.0

data/lib/audited/rspec_matchers.rb

@@ -0,0 +1,177 @@
+module Audited
+  module RspecMatchers
+    # Ensure that the model is audited.
+    #
+    # Options:
+    # * <tt>associated_with</tt> - tests that the audit makes use of the associated_with option
+    # * <tt>only</tt> - tests that the audit makes use of the only option *Overrides <tt>except</tt> option*
+    # * <tt>except</tt> - tests that the audit makes use of the except option
+    # * <tt>requires_comment</tt> - if specified, then the audit must require comments through the <tt>audit_comment</tt> attribute
+    # * <tt>on</tt> - tests that the audit makes use of the on option with specified parameters
+    #
+    # Example:
+    #   it { should be_audited }
+    #   it { should be_audited.associated_with(:user) }
+    #   it { should be_audited.only(:field_name) }
+    #   it { should be_audited.except(:password) }
+    #   it { should be_audited.requires_comment }
+    #   it { should be_audited.on(:create).associated_with(:user).except(:password) }
+    #
+    def be_audited
+      AuditMatcher.new
+    end
+
+    # Ensure that the model has associated audits
+    #
+    # Example:
+    #   it { should have_associated_audits }
+    #
+    def have_associated_audits
+      AssociatedAuditMatcher.new
+    end
+
+    class AuditMatcher # :nodoc:
+      def initialize
+        @options = {}
+      end
+
+      def associated_with(model)
+        @options[:associated_with] = model
+        self
+      end
+
+      def only(*fields)
+        @options[:only] = fields.flatten
+        self
+      end
+
+      def except(*fields)
+        @options[:except] = fields.flatten
+        self
+      end
+
+      def requires_comment
+        @options[:comment_required] = true
+        self
+      end
+
+      def on(*actions)
+        @options[:on] = actions.flatten
+        self
+      end
+
+      def matches?(subject)
+        @subject = subject
+        auditing_enabled? &&
+          associated_with_model? &&
+          records_changes_to_specified_fields? &&
+          comment_required_valid?
+      end
+
+      def failure_message
+        "Expected #{@expectation}"
+      end
+
+      def negative_failure_message
+        "Did not expect #{@expectation}"
+      end
+
+      alias_method :failure_message_when_negated, :negative_failure_message
+
+      def description
+        description = "audited"
+        description += " associated with #{@options[:associated_with]}" if @options.key?(:associated_with)
+        description += " only => #{@options[:only].join ', '}"          if @options.key?(:only)
+        description += " except => #{@options[:except].join(', ')}"     if @options.key?(:except)
+        description += " requires audit_comment"                        if @options.key?(:comment_required)
+
+        description
+      end
+
+      protected
+
+      def expects(message)
+        @expectation = message
+      end
+
+      def auditing_enabled?
+        expects "#{model_class} to be audited"
+        model_class.respond_to?(:auditing_enabled) && model_class.auditing_enabled
+      end
+
+      def model_class
+        @subject.class
+      end
+
+      def associated_with_model?
+        expects "#{model_class} to record audits to associated model #{@options[:associated_with]}"
+        model_class.audit_associated_with == @options[:associated_with]
+      end
+
+      def records_changes_to_specified_fields?
+        if @options[:only] || @options[:except]
+          if @options[:only]
+            except = model_class.column_names - @options[:only].map(&:to_s)
+          else
+            except = model_class.default_ignored_attributes + Audited.ignored_attributes
+            except |= @options[:except].collect(&:to_s) if @options[:except]
+          end
+
+          expects "non audited columns (#{model_class.non_audited_columns.inspect}) to match (#{expect})"
+          model_class.non_audited_columns =~ except
+        else
+          true
+        end
+      end
+
+      def comment_required_valid?
+        if @options[:comment_required]
+          @subject.audit_comment = nil
+
+          expects "to be invalid when audit_comment is not specified"
+          @subject.valid? == false && @subject.errors.key?(:audit_comment)
+        else
+          true
+        end
+      end
+    end
+
+    class AssociatedAuditMatcher # :nodoc:
+      def matches?(subject)
+        @subject = subject
+
+        association_exists?
+      end
+
+      def failure_message
+        "Expected #{model_class} to have associated audits"
+      end
+
+      def negative_failure_message
+        "Expected #{model_class} to not have associated audits"
+      end
+
+      alias_method :failure_message_when_negated, :negative_failure_message
+
+      def description
+        "has associated audits"
+      end
+
+      protected
+
+      def model_class
+        @subject.class
+      end
+
+      def reflection
+        model_class.reflect_on_association(:associated_audits)
+      end
+
+      def association_exists?
+        !reflection.nil? &&
+          reflection.macro == :has_many &&
+          reflection.options[:class_name] == Audit.name
+      end
+    end
+  end
+end

data/lib/audited/sweeper.rb

@@ -0,0 +1,60 @@
+require "rails/observers/activerecord/active_record"
+require "rails/observers/action_controller/caching"
+
+module Audited
+  class Sweeper < ActionController::Caching::Sweeper
+    observe Audited::Audit
+
+    def around(controller)
+      self.controller = controller
+      yield
+    ensure
+      self.controller = nil
+    end
+
+    def before_create(audit)
+      audit.user ||= current_user
+      audit.remote_address = controller.try(:request).try(:remote_ip)
+      audit.request_uuid = request_uuid if request_uuid
+    end
+
+    def current_user
+      controller.send(Audited.current_user_method) if controller.respond_to?(Audited.current_user_method, true)
+    end
+
+    def request_uuid
+      controller.try(:request).try(:uuid)
+    end
+
+    def add_observer!(klass)
+      super
+      define_callback(klass)
+    end
+
+    def define_callback(klass)
+      observer = self
+      callback_meth = :_notify_audited_sweeper
+      klass.send(:define_method, callback_meth) do
+        observer.update(:before_create, self)
+      end
+      klass.send(:before_create, callback_meth)
+    end
+
+    def controller
+      ::Audited.store[:current_controller]
+    end
+
+    def controller=(value)
+      ::Audited.store[:current_controller] = value
+    end
+  end
+end
+
+ActiveSupport.on_load(:action_controller) do
+  if defined?(ActionController::Base)
+    ActionController::Base.around_action Audited::Sweeper.instance
+  end
+  if defined?(ActionController::API)
+    ActionController::API.around_action Audited::Sweeper.instance
+  end
+end

data/lib/audited/version.rb

@@ -0,0 +1,3 @@
+module Audited
+  VERSION = "4.3.0"
+end

data/lib/generators/audited/install_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'active_record'
+require 'rails/generators/active_record'
+require 'generators/audited/migration'
+
+module Audited
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      extend Audited::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_migration
+        migration_template 'install.rb', 'db/migrate/install_audited.rb'
+      end
+    end
+  end
+end

data/lib/generators/audited/migration.rb

@@ -0,0 +1,15 @@
+module Audited
+  module Generators
+    module Migration
+      # Implement the required interface for Rails::Generators::Migration.
+      def next_migration_number(dirname) #:nodoc:
+        next_migration_number = current_migration_number(dirname) + 1
+        if ::ActiveRecord::Base.timestamped_migrations
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+    end
+  end
+end

data/lib/generators/audited/templates/add_association_to_audits.rb

@@ -0,0 +1,11 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    add_column :audits, :association_id, :integer
+    add_column :audits, :association_type, :string
+  end
+
+  def self.down
+    remove_column :audits, :association_type
+    remove_column :audits, :association_id
+  end
+end

data/lib/generators/audited/templates/add_comment_to_audits.rb

@@ -0,0 +1,9 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    add_column :audits, :comment, :string
+  end
+
+  def self.down
+    remove_column :audits, :comment
+  end
+end

data/lib/generators/audited/templates/add_remote_address_to_audits.rb

@@ -0,0 +1,10 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    add_column :audits, :remote_address, :string
+  end
+
+  def self.down
+    remove_column :audits, :remote_address
+  end
+end
+

data/lib/generators/audited/templates/add_request_uuid_to_audits.rb

@@ -0,0 +1,10 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    add_column :audits, :request_uuid, :string
+    add_index :audits, :request_uuid
+  end
+
+  def self.down
+    remove_column :audits, :request_uuid
+  end
+end

data/lib/generators/audited/templates/install.rb

@@ -0,0 +1,30 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    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 :request_uuid, :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, :request_uuid
+    add_index :audits, :created_at
+  end
+
+  def self.down
+    drop_table :audits
+  end
+end

data/lib/generators/audited/templates/rename_association_to_associated.rb

@@ -0,0 +1,23 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    if index_exists? :audits, [:association_id, :association_type], :name => 'association_index'
+      remove_index :audits, :name => 'association_index'
+    end
+
+    rename_column :audits, :association_id, :associated_id
+    rename_column :audits, :association_type, :associated_type
+
+    add_index :audits, [:associated_id, :associated_type], :name => 'associated_index'
+  end
+
+  def self.down
+    if index_exists? :audits, [:associated_id, :associated_type], :name => 'associated_index'
+      remove_index :audits, :name => 'associated_index'
+    end
+
+    rename_column :audits, :associated_type, :association_type
+    rename_column :audits, :associated_id, :association_id
+
+    add_index :audits, [:association_id, :association_type], :name => 'association_index'
+  end
+end

data/lib/generators/audited/templates/rename_changes_to_audited_changes.rb

@@ -0,0 +1,9 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    rename_column :audits, :changes, :audited_changes
+  end
+
+  def self.down
+    rename_column :audits, :audited_changes, :changes
+  end
+end

data/lib/generators/audited/templates/rename_parent_to_association.rb

@@ -0,0 +1,11 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    rename_column :audits, :auditable_parent_id, :association_id
+    rename_column :audits, :auditable_parent_type, :association_type
+  end
+
+  def self.down
+    rename_column :audits, :association_type, :auditable_parent_type
+    rename_column :audits, :association_id, :auditable_parent_id
+  end
+end

data/lib/generators/audited/upgrade_generator.rb

@@ -0,0 +1,57 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'active_record'
+require 'rails/generators/active_record'
+require 'generators/audited/migration'
+
+module Audited
+  module Generators
+    class UpgradeGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      extend Audited::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_templates
+        migrations_to_be_applied do |m|
+          migration_template "#{m}.rb", "db/migrate/#{m}.rb"
+        end
+      end
+
+      private
+
+      def migrations_to_be_applied
+        Audited::Audit.reset_column_information
+        columns = Audited::Audit.columns.map(&:name)
+
+        yield :add_comment_to_audits unless columns.include?('comment')
+
+        if columns.include?('changes')
+          yield :rename_changes_to_audited_changes
+        end
+
+        unless columns.include?('remote_address')
+          yield :add_remote_address_to_audits
+        end
+
+        unless columns.include?('request_uuid')
+          yield :add_request_uuid_to_audits
+        end
+
+        unless columns.include?('association_id')
+          if columns.include?('auditable_parent_id')
+            yield :rename_parent_to_association
+          else
+            unless columns.include?('associated_id')
+              yield :add_association_to_audits
+            end
+          end
+        end
+
+        if columns.include?('association_id')
+          yield :rename_association_to_associated
+        end
+      end
+    end
+  end
+end