audited-activerecord 3.0.0.rc1

data/lib/audited-activerecord.rb

@@ -0,0 +1,2 @@
+require 'audited'
+require 'audited/adapters/active_record'

data/lib/audited/adapters/active_record.rb

@@ -0,0 +1,15 @@
+require 'active_record'
+require 'audited/auditor'
+require 'audited/adapters/active_record/audit'
+
+module Audited::Auditor::ClassMethods
+  def default_ignored_attributes
+    [self.primary_key, inheritance_column]
+  end
+end
+
+::ActiveRecord::Base.send :include, Audited::Auditor
+
+Audited.audit_class = Audited::Adapters::ActiveRecord::Audit
+
+require 'audited/sweeper'

data/lib/audited/adapters/active_record/audit.rb

@@ -0,0 +1,69 @@
+require 'set'
+require 'audited/audit'
+
+module Audited
+  module Adapters
+    module ActiveRecord
+      # Audit saves the changes to ActiveRecord models.  It has the following attributes:
+      #
+      # * <tt>auditable</tt>: the ActiveRecord model that was changed
+      # * <tt>user</tt>: the user that performed the change; a string or an ActiveRecord model
+      # * <tt>action</tt>: one of create, update, or delete
+      # * <tt>audited_changes</tt>: a serialized hash of all the changes
+      # * <tt>comment</tt>: a comment set with the audit
+      # * <tt>created_at</tt>: Time that the change was performed
+      #
+      class Audit < ::ActiveRecord::Base
+        include Audited::Audit
+
+
+        serialize :audited_changes
+
+        default_scope         order(:version)
+        scope :descending,    reorder("version DESC")
+        scope :creates,       :conditions => {:action => 'create'}
+        scope :updates,       :conditions => {:action => 'update'}
+        scope :destroys,      :conditions => {:action => 'destroy'}
+
+        scope :up_until,      lambda {|date_or_time| where("created_at <= ?", date_or_time) }
+        scope :from_version,  lambda {|version| where(['version >= ?', version]) }
+        scope :to_version,    lambda {|version| where(['version <= ?', version]) }
+
+        # Return all audits older than the current one.
+        def ancestors
+          self.class.where(['auditable_id = ? and auditable_type = ? and version <= ?',
+            auditable_id, auditable_type, version])
+        end
+
+        # Allows user to be set to either a string or an ActiveRecord object
+        # @private
+        def user_as_string=(user)
+          # reset both either way
+          self.user_as_model = self.username = nil
+          user.is_a?(::ActiveRecord::Base) ?
+            self.user_as_model = user :
+            self.username = user
+        end
+        alias_method :user_as_model=, :user=
+        alias_method :user=, :user_as_string=
+
+        # @private
+        def user_as_string
+          self.user_as_model || self.username
+        end
+        alias_method :user_as_model, :user
+        alias_method :user, :user_as_string
+
+      private
+        def set_version_number
+          max = self.class.maximum(:version,
+            :conditions => {
+              :auditable_id => auditable_id,
+              :auditable_type => auditable_type
+            }) || 0
+          self.version = max + 1
+        end
+      end
+    end
+  end
+end

data/lib/generators/audited/install_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'active_record'
+require 'rails/generators/active_record'
+
+module Audited
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      # Implement the required interface for Rails::Generators::Migration.
+      def self.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
+
+      def copy_migration
+        migration_template 'install.rb', 'db/migrate/install_audited.rb'
+      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/install.rb

@@ -0,0 +1,28 @@
+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 :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
+
+  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,63 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'active_record'
+require 'rails/generators/active_record'
+
+module Audited
+  module Generators
+    class UpgradeGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      # Implement the required interface for Rails::Generators::Migration.
+      def self.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
+
+      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::Adapters::ActiveRecord::Audit.reset_column_information
+        columns = Audited::Adapters::ActiveRecord::Audit.columns.map(&:name)
+
+        unless columns.include?( 'comment' )
+          yield :add_comment_to_audits
+        end
+
+        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?( '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

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: audited-activerecord
+version: !ruby/object:Gem::Version
+  version: 3.0.0.rc1
+  prerelease: 6
+platform: ruby
+authors:
+- Brandon Keepers
+- Kenneth Kalmer
+- Daniel Morrison
+- Brian Ryckbost
+- Steve Richert
+- Ryan Glover
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: audited
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc1
+        prerelease: 6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc1
+        prerelease: 6
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Log all changes to your ActiveRecord models
+email: info@collectiveidea.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/audited-activerecord.rb
+- lib/audited/adapters/active_record.rb
+- lib/audited/adapters/active_record/audit.rb
+- lib/generators/audited/install_generator.rb
+- lib/generators/audited/templates/add_association_to_audits.rb
+- lib/generators/audited/templates/add_comment_to_audits.rb
+- lib/generators/audited/templates/add_remote_address_to_audits.rb
+- lib/generators/audited/templates/install.rb
+- lib/generators/audited/templates/rename_association_to_associated.rb
+- lib/generators/audited/templates/rename_changes_to_audited_changes.rb
+- lib/generators/audited/templates/rename_parent_to_association.rb
+- lib/generators/audited/upgrade_generator.rb
+homepage: https://github.com/collectiveidea/audited
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Log all changes to your ActiveRecord models
+test_files: []