acts_as_audited_collection 0.4.1 → 1.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.log
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/db/*.db
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acts_as_audited_collection.gemspec
+gemspec

data/LICENSE

@@ -1,19 +1,22 @@
-Copyright (c) 2010 Shaun Mangelsdorf
+Copyright (c) 2010-2012 Shaun Mangelsdorf
 
-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:
+MIT License
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+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 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.
+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

@@ -1,7 +1,7 @@
-acts_as_audited_collection
+acts\_as\_audited\_collection
 ==========================
 
-acts_as_audited_collection is a Rails plugin, which extends ActiveRecord to allow auditing of associations.
+acts\_as\_audited\_collection is a Rails plugin, which extends ActiveRecord to allow auditing of associations.
 
 The basic feature set is:
 
@@ -19,7 +19,17 @@ This plugin is released under the MIT license, and was contributed to the Rails
 Installation
 ============
 
-TBD
+Add this line to your application's Gemfile:
+
+    gem 'acts_as_audited_collection'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_audited_collection
 
 Generating the migration
 ------------------------
@@ -94,7 +104,7 @@ Consider the following alternative "Person" model.
           :track_modifications => true
     end
 
-With this, we can now see modifications from the parent (though we make no attempt to ascertain what the modifications were - if you need this, see [acts_as_audited](http://github.com/collectiveidea/acts_as_audited))
+With this, we can now see modifications from the parent (though we make no attempt to ascertain what the modifications were - if you need this, see [acts_as_audited](http://github.com/collectiveidea/audited))
 
     p = Person.first                                  # Person name: 'Fred'
     p.update_attributes :name => 'Freda'              # Audit record is created
@@ -142,3 +152,12 @@ Temporarily disabling auditing
     end
 
 Keep in mind that this disables collection auditing completely in the current thread, not just for the `Person` model.
+
+Contributing
+============
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -1,6 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
 require 'rake'
 require 'rake/testtask'
-require 'rdoc/task'
 require 'rspec/core/rake_task'
 
 desc 'Default: run unit tests.'
@@ -14,36 +16,7 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = true
 end
 
-desc 'Generate documentation for the acts_as_audited_collection plugin.'
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'ActsAsAuditedCollection'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
 RSpec::Core::RakeTask.new do |t|
   t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
   t.pattern = 'spec/*_spec.rb'
 end
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = 'acts_as_audited_collection'
-    gem.summary = 'Extends ActiveRecord to allow auditing of associations'
-    gem.description = 'Adds auditing capabilities to ActiveRecord associations, in a similar fashion to acts_as_audited.'
-    gem.files = Dir[
-      '[a-zA-Z]*',
-      'generators/**/*',
-      'lib/**/*',
-      'rails/**/*',
-      'spec/**/*'
-    ]
-    gem.authors = ['Shaun Mangelsdorf']
-    gem.version = '0.4.1'
-  end
-rescue LoadError
-  puts "Jeweler could not be sourced"
-end

data/acts_as_audited_collection.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/acts_as_audited_collection/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Shaun Mangelsdorf"]
+  gem.email         = ["s.mangelsdorf@gmail.com"]
+  gem.description   = %q{Adds auditing capabilities to ActiveRecord associations, in a similar fashion to acts_as_audited.}
+  gem.summary       = %q{Extends ActiveRecord to allow auditing of associations}
+  gem.homepage      = "https://github.com/smangelsdorf/acts_as_audited_collection"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "acts_as_audited_collection"
+  gem.require_paths = ["lib"]
+  gem.version       = ActsAsAuditedCollection::VERSION
+
+  gem.add_development_dependency 'ruby-debug'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rails', '~>3.0'
+  gem.add_development_dependency 'sqlite3'
+end

data/lib/active_record/acts/audited_collection.rb

@@ -72,7 +72,8 @@ module ActiveRecord
         end
 
         def define_acts_as_audited_collection(options)
-          yield(read_inheritable_attribute(:audited_collections)[options[:name]] ||= {})
+          key = "#{options[:parent_type]}##{options[:name]}"
+          yield(read_inheritable_attribute(:audited_collections)[key] ||= {})
         end
 
         def without_collection_audit
@@ -93,7 +94,7 @@ module ActiveRecord
         end
 
         def collection_audit_update
-          audited_collections.each do |name, opts|
+          audited_collections.each do |key, opts|
             attributes = {opts[:foreign_key] => self.send(opts[:foreign_key])}
             if collection_audit_is_soft_deleted?(opts)
               collection_audit_write(

data/lib/acts_as_audited_collection.rb

@@ -1,4 +1,5 @@
 require 'acts_as_audited_collection/collection_audit'
 require 'active_record/acts/audited_collection'
+require 'acts_as_audited_collection/version'
 
 require 'acts_as_audited_collection/railtie' if defined? Rails

data/lib/acts_as_audited_collection/collection_audit.rb

@@ -1,4 +1,5 @@
 # Released under the MIT license. See the LICENSE file for details
+require 'active_record'
 
 class CollectionAudit < ActiveRecord::Base
   belongs_to :parent_record, :polymorphic => true
@@ -7,4 +8,21 @@ class CollectionAudit < ActiveRecord::Base
 
   belongs_to :child_audit, :class_name => 'CollectionAudit'
   has_many :parent_audits, :class_name => 'CollectionAudit', :foreign_key => :child_audit_id
+
+  before_create :set_as_current
+
+  scope :for_child, lambda{|c| where(:child_record_type => c.class.name, :child_record_id => c.id)}
+
+  private
+  def set_as_current
+    self.class.where(
+      :parent_record_type => parent_record_type,
+      :parent_record_id => parent_record_id,
+      :child_record_type => child_record_type,
+      :child_record_id => child_record_id,
+      :association => association,
+      :current => true
+    ).update_all :current => false
+    self.current = true
+  end
 end

data/lib/acts_as_audited_collection/version.rb

@@ -0,0 +1,3 @@
+module ActsAsAuditedCollection
+  VERSION = '1.0.1'
+end

data/lib/generators/audited_collection_migration/audited_collection_migration_generator.rb

@@ -0,0 +1,9 @@
+# Released under the MIT license. See the LICENSE file for details
+
+class AuditedCollectionMigrationGenerator < Rails::Generators::NamedBase
+  source_root File.join(File.dirname(__FILE__), 'templates')
+
+  def manifest
+    migration_template 'migration.rb', "db/migrate/#{file_name}"
+  end
+end

data/lib/generators/audited_collection_upgrade/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Generates the migration to create a collection_audits table.
+
+Example:
+    ./script/generate audited_collection_migration add_collection_audits_table
+
+    This will create:
+        db/migrate/*_add_collection_audits_table.rb
+
+	Run "rake db:migrate" to update your database.

data/lib/generators/audited_collection_upgrade/audited_collection_upgrade_generator.rb

@@ -0,0 +1,20 @@
+# Released under the MIT license. See the LICENSE file for details
+
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record/migration'
+
+class AuditedCollectionUpgradeGenerator < Rails::Generators::NamedBase
+  include Rails::Generators::Migration
+  extend ActiveRecord::Generators::Migration
+  attr_accessor :from_version
+
+  source_root File.join(File.dirname(__FILE__), 'templates')
+
+  argument :from, :type => :string, :default => '', :banner => 'VERSION'
+
+  def main_screen_turn_on
+    self.from_version = from.split('.').collect(&:to_i)
+    migration_template 'migration.rb', "db/migrate/#{file_name}"
+  end
+end

data/lib/generators/audited_collection_upgrade/templates/migration.rb

@@ -0,0 +1,27 @@
+class <%= class_name %> < ActiveRecord::Migration
+  def self.up
+<% if (from_version <=> [1,0,0]) < 0 %>
+    add_column :collection_audits, :current, :boolean, :default => true, :nullable => false
+    add_index :collection_audits, :current
+
+    execute %q{
+      update collection_audits ca_old
+        join collection_audits ca_new
+        on ca_old.id < ca_new.id
+        and ca_old.parent_record_type = ca_new.parent_record_type
+        and ca_old.parent_record_id = ca_new.parent_record_id
+        and ca_old.child_record_type = ca_new.child_record_type
+        and ca_old.child_record_id = ca_new.child_record_id
+        and ca_old.association = ca_new.association
+      set ca_old.current = false
+    }
+<% end %>
+  end
+
+  def self.down
+<% if (from_version <=> [1,0,0]) < 0 %>
+    remove_index :collection_audits, :current
+    remove_column :collection_audits, :current
+<% end %>
+  end
+end

data/spec/acts_as_audited_collection_spec.rb

@@ -1,6 +1,7 @@
 # Released under the MIT license. See the LICENSE file for details
 
 require File.dirname(__FILE__) + '/spec_helper'
+require 'acts_as_audited_collection'
 
 describe 'Acts as audited collection plugin' do
   it 'can be included in an ActiveRecord model' do
@@ -24,7 +25,7 @@ describe 'Acts as audited collection plugin' do
       acts_as_audited_collection :parent => :test_parent
 
       audited_collections
-    end.should have_key :people
+    end.should have_key "TestParent#people"
   end
 
   it 'allows the audited collection through a belongs_to relationship' do
@@ -78,9 +79,9 @@ describe 'Acts as audited collection plugin' do
       acts_as_audited_collection :parent => :test_parent, :cascade => true
     end
 
-    Person.audited_collections.should have_key :people
-    Person.audited_collections[:people].should have_key :cascade
-    Person.audited_collections[:people][:cascade].should be_true
+    Person.audited_collections.should have_key 'TestParent#people'
+    Person.audited_collections['TestParent#people'].should have_key :cascade
+    Person.audited_collections['TestParent#people'][:cascade].should be_true
   end
 
   it 'configures an audited collection to track modificiations when required' do
@@ -90,9 +91,9 @@ describe 'Acts as audited collection plugin' do
       acts_as_audited_collection :parent => :test_parent, :track_modifications => true
     end
 
-    Person.audited_collections.should have_key :people
-    Person.audited_collections[:people].should have_key :track_modifications
-    Person.audited_collections[:people][:track_modifications].should be_true
+    Person.audited_collections.should have_key 'TestParent#people'
+    Person.audited_collections['TestParent#people'].should have_key :track_modifications
+    Person.audited_collections['TestParent#people'][:track_modifications].should be_true
   end
 
   it 'audits an object creation when relationships are defined' do
@@ -166,6 +167,23 @@ describe 'Acts as audited collection plugin' do
     CollectionAudit.last.action.should == 'remove'
   end
 
+  it 'audits an object creation when two parent relationships exist with the same collection name' do
+    p = TestParent.create :name => 'test parent'
+    f = TestFakeParent.create :name => 'test fake parent'
+
+    c = nil
+    lambda {
+      c = TestChild.create :name => 'test child', :test_fake_parent => f, :test_parent => p
+    }.should change(CollectionAudit, :count).by(2)
+
+    p.test_children_audits.last.child_record_id.should == c.id
+    p.test_children_audits.last.parent_record.should == p
+    p.test_children_audits.last.child_record_id.should == c.id
+    f.test_children_audits.last.child_record_id.should == c.id
+    f.test_children_audits.last.parent_record.should == f
+    f.test_children_audits.last.child_record_id.should == c.id
+  end
+
   it 'skips auditing an object deletion when no relationships exist' do
     c = TestChild.create :name => 'test child'
 
@@ -480,4 +498,59 @@ describe 'Acts as audited collection plugin' do
     ca.child_record.should == g
     ca.parent_record.should == c
   end
+
+  it 'assigns a new audit record as the current record' do
+    p = TestParent.create :name => 'test parent'
+    c = p.test_children.create :name => 'test child'
+    p.test_children_audits.last.should be_current
+  end
+
+  it 'unassigns the previous current record when a new current record is created' do
+    p = TestParent.create :name => 'test parent'
+    c = p.other_test_children.create :name => 'test child'
+    previous = p.other_test_children_audits.last
+    lambda {
+      c.update_attributes! :name => 'updated child'
+    }.should change(CollectionAudit, :count).by(1)
+    previous.reload.should_not be_current
+    p.other_test_children_audits.last.should be_current
+  end
+
+  it 'tracks the current audit record uniquely per association' do
+    p = TestParent.create :name => 'test parent'
+    c = p.test_children.create :name => 'test child'
+    c.test_parent_with_only = p
+    c.save
+
+    p.test_children_audits.last.should be_current
+    p.test_children_with_only_audits.last.should be_current
+  end
+
+  it 'tracks the current audit record correctly per hierarchy' do
+    p = TestParent.create :name => 'test parent'
+    c = p.test_children.create :name => 'test child'
+    p2 = TestParent.create :name => 'test parent 2'
+    c2 = p2.test_children.create :name => 'test child 2'
+
+    p.test_children_audits.last.should be_current
+    p2.test_children_audits.last.should be_current
+  end
+
+  it 'tracks the current audit record correctly per child object' do
+    p = TestParent.create :name => 'test parent'
+    c = p.test_children.create :name => 'test child'
+    c2 = p.test_children.create :name => 'test child 2'
+
+    p.test_children_audits.for_child(c).last.should be_current
+    p.test_children_audits.for_child(c2).last.should be_current
+  end
+
+  it 'tracks the current audit record correctly through different parent objects' do
+    p = TestParent.create :name => 'test parent'
+    f = TestFakeParent.create :name => 'test fake parent'
+    c = TestChild.create :name => 'test child', :test_fake_parent => f, :test_parent => p
+
+    p.test_children_audits.last.should be_current
+    f.test_children_audits.last.should be_current
+  end
 end