auditing 0.0.2

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_DISABLE_SHARED_GEMS: "1"

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+test.sqlite3

data/.rspec

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

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+group :development, :test do
+  gem 'rspec-rails',  '~> 2.0.0.beta.20'
+  gem 'sqlite3-ruby', '~> 1.3'
+  gem 'activerecord', '~> 3.0.0.rc2'
+end

data/Gemfile.lock

@@ -0,0 +1,38 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.0.rc2)
+      activesupport (= 3.0.0.rc2)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0.rc2)
+      activemodel (= 3.0.0.rc2)
+      activesupport (= 3.0.0.rc2)
+      arel (~> 1.0.0.rc1)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.0.rc2)
+    arel (1.0.0.rc1)
+      activesupport (>= 3.0.0.beta)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    i18n (0.4.1)
+    rspec (2.0.0.beta.20)
+      rspec-core (= 2.0.0.beta.20)
+      rspec-expectations (= 2.0.0.beta.20)
+      rspec-mocks (= 2.0.0.beta.20)
+    rspec-core (2.0.0.beta.20)
+    rspec-expectations (2.0.0.beta.20)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.20)
+    rspec-rails (2.0.0.beta.20)
+      rspec (= 2.0.0.beta.20)
+    sqlite3-ruby (1.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.0.0.rc2)
+  rspec-rails (~> 2.0.0.beta.20)
+  sqlite3-ruby (~> 1.3)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Brad
+
+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.rdoc

@@ -0,0 +1,64 @@
+= auditing (currently in development, no gem has been created yet)
+
+Auditing is a simple way to track and rollback changes to a record.
+
+== Installation
+
+  gem install auditing # NOTE: gem has not been created yet.
+  
+You will have to supply a model named Audit in your rails application with the following migration
+
+  create_table :audits, :force => true do |t|
+    t.string  :action
+    t.string  :auditable_type
+    t.integer :auditable_id
+    t.string  :association_type
+    t.integer :association_id
+    t.string  :field_name
+    t.string  :old_value
+    t.string  :new_value
+    # t.integer :user_id
+    t.boolean :undoable, :default => true
+    t.timestamps
+  end
+  
+If you want to track the user, uncomment the t.integer :user_id above.
+TODO: more to follow about tracking the user
+
+  class Audit < ActiveRecord::Base
+    include Auditing::Auditor
+    belongs_to :auditable,   :polymorphic => true
+    belongs_to :association, :polymorphic => true
+  end
+  
+  
+== Basic Usage
+
+To add auditing to all attributes on a model, simply add auditing to the model.
+
+  class School < ActiveRecord::Base
+    auditing
+  end
+
+If you want more control over which attributes are audited, you can define them
+by supplying a fields hash
+
+  class School < ActiveRecord::Base
+    auditing :fields => [:name, :established_on]
+  end
+  
+Auditing will not track "id", "created_at", or "updated_at" by default
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Brad Cantin. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "auditing"
+    gem.summary = %Q{A gem to keep track of audit hisory of a record}
+    gem.description = %Q{acts_as_versioned is good. This allows an attribute level rollback instead}
+    gem.email = "brad.cantin@gmail.com"
+    gem.homepage = "http://github.com/bcantin/auditing"
+    gem.authors = ["Brad"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "auditing #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/auditing.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{auditing}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brad"]
+  s.date = %q{2010-08-29}
+  s.description = %q{acts_as_versioned is good. This allows an attribute level rollback instead}
+  s.email = %q{brad.cantin@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".bundle/config",
+     ".document",
+     ".gitignore",
+     ".rspec",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "auditing.gemspec",
+     "lib/auditing.rb",
+     "lib/auditing/auditing.rb",
+     "lib/auditing/auditor.rb",
+     "spec/auditing/auditing_spec.rb",
+     "spec/auditing/auditor_spec.rb",
+     "spec/schema.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/bcantin/auditing}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A gem to keep track of audit hisory of a record}
+  s.test_files = [
+    "spec/auditing/auditing_spec.rb",
+     "spec/auditing/auditor_spec.rb",
+     "spec/schema.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/auditing/auditing.rb

@@ -0,0 +1,51 @@
+module Auditing
+
+  # Auditing creates audit objects for a record.
+  #
+  # @examples
+  #   class School < ActiveRecord::Base
+  #      auditing
+  #   end
+  #   class School < ActiveRecord::Base
+  #     auditing :fields => [:name, :established_on]
+  #   end
+  def auditing(opts={})
+    include InstanceMethods
+    class_inheritable_accessor :auditing_fields
+
+    has_many :audits, :as => :auditable, :order => 'created_at DESC, id DESC'
+
+    self.auditing_fields = gather_fields_for_auditing(opts[:fields])
+    
+    after_create :log_creation
+    after_update :log_update
+    
+  end
+
+  def gather_fields_for_auditing(fields=nil)
+    return self.column_names - ["id", "created_at", "updated_at"] unless fields
+    fields.is_a?(Array) ? fields.map {|f| f.to_s} : [fields.to_s]
+  end
+
+  module InstanceMethods
+    def log_creation
+      add_audit(:action => 'created', :undoable => false)
+    end
+    
+    def log_update
+      if changed?
+        changes.each.select {|k,v| auditing_fields.include?(k)}.each do |field, change|
+          next if change[0].to_s == change[1].to_s
+          add_audit(:action => 'updated', :field_name => field,
+                    :old_value => change[0], :new_value => change[1])
+        end
+      end
+    end
+    
+    private
+      def add_audit(hash={})
+        Audit.create!({:auditable => self}.merge(hash))
+      end
+  end # Auditing::InstanceMethods
+
+end

data/lib/auditing/auditor.rb

@@ -0,0 +1,25 @@
+module Auditing
+  module Auditor
+    
+    def reversable?
+      %w[updated].include?(action)
+    end
+    
+    def show_action
+      action
+    end
+    
+    def rollback
+      return unless reversable?
+      
+      if association.blank?
+        auditable.update_attribute(field_name.to_sym, old_value)
+      else
+        # TODO
+        # association.class.find(association_id).update_attribute(field_name.to_sym, old_value)
+      end
+
+    end
+    
+  end # end Auditing::Auditor
+end

data/lib/auditing.rb

@@ -0,0 +1,5 @@
+require 'auditing/auditing'
+require 'auditing/auditor'
+
+ActiveRecord::Base.send(:extend, Auditing)
+ActiveRecord::Base.send(:extend, Auditing::Auditor)

data/spec/auditing/auditing_spec.rb

@@ -0,0 +1,131 @@
+require 'spec_helper'
+
+describe "Auditing" do
+  
+  describe "auditing default values" do
+    before do
+      class School < ActiveRecord::Base
+        auditing
+      end
+    end
+    
+    it "responds to auditing when auditing is added to an AR object" do
+      School.should respond_to(:auditing)
+    end
+    
+    it "responds to @auditing_fields" do
+      School.should respond_to(:auditing_fields)
+    end
+    
+    it "has default values when no fields are passed in" do
+      School.stub!(:column_names).and_return(["id", "name", "established_on", "created_at", "updated_at"])
+      School.gather_fields_for_auditing.should == ["name", "established_on"]
+    end
+  end # auditing default values
+
+  describe "auditing :fields => [:foo,:bar]" do
+    it "accepts a single valude as a symbol" do
+      class School < ActiveRecord::Base
+        auditing :fields => :name
+      end
+      School.auditing_fields.should == ['name']
+    end
+    
+    it "accepts a single value as a string" do
+      class School < ActiveRecord::Base
+        auditing :fields => 'name'
+      end
+      School.auditing_fields.should == ['name']
+    end
+    
+    it "accepts an array of symbols" do
+      class School < ActiveRecord::Base
+        auditing :fields => [:name, :established_on]
+      end
+      School.auditing_fields.should == ['name', 'established_on']
+    end
+    
+    it "accepts an array of strings" do
+      class School < ActiveRecord::Base
+        auditing :fields => ['name', 'established_on']
+      end
+      School.auditing_fields.should == ['name', 'established_on']
+    end
+  end # auditing :fields => [:foo,:bar]
+  
+  describe "creating a new instance" do
+    before do
+      class School < ActiveRecord::Base
+        auditing
+      end
+    end
+
+    it "creates an audit" do
+      lambda { School.create(:name => 'PS118') }.should change { Audit.count }.by(1)
+    end
+    
+    it "the first audit has an action of 'created'" do
+      school = School.create(:name => 'PS118')
+      school.audits.first.action.should == 'created'
+    end
+    
+    it "the first audit should not be reversable" do
+      school = School.create(:name => 'PS118')
+      school.audits.first.reversable?.should == false
+    end
+    
+    it "the audit.auditable should be the object that created the audit" do
+      school = School.create(:name => 'PS118')
+      school.audits.first.auditable.should == school
+    end
+  end # creating a new instance
+  
+  describe "updating an existing record" do
+    before do
+      class School < ActiveRecord::Base
+        auditing :fields => 'name'
+      end
+      @school = School.create(:name => 'PS118')
+    end
+    
+    it "creates an audit" do
+      lambda { @school.update_attributes(:name => 'PS99') }.should change { Audit.count }.by(1)
+    end
+    
+    it "the first audit has an action of 'updated" do
+      @school.update_attributes(:name => 'PS99')
+      @school.audits.first.action.should == 'updated'
+    end
+    
+    it "the first audit should be reversable" do
+      @school.update_attributes(:name => 'PS99')
+      @school.audits.first.reversable?.should == true
+    end
+    
+    it "the first audit stored the new value" do
+      @school.update_attributes(:name => 'PS99')
+      @school.audits.first.new_value.should == 'PS99'
+    end
+    
+    it "the first audit stored the old value" do
+      @school.update_attributes(:name => 'PS99')
+      @school.audits.first.old_value.should == 'PS118'
+    end
+    
+    it "the audit.auditable should be the object that created the audit" do
+      @school.update_attributes(:name => 'PS99')
+      @school.audits.first.auditable.should == @school
+    end
+    
+    describe "does not create an audit when" do
+      it "a value did not change" do
+        lambda { @school.update_attributes(:name => 'PS118') }.should_not change { Audit.count }
+      end
+      
+      it "a value is not part of auditing_fields" do
+        lambda { @school.update_attributes(:established_on => Time.now) }.should_not change { Audit.count }
+      end
+    end
+  end # updating an existing record
+  
+end

data/spec/auditing/auditor_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+# require 'timecop'
+
+describe "Auditor" do
+  it 'adds the Auditable::Auditor module to the Audit class' do
+    Audit.new.should respond_to(:show_action)
+  end
+  
+  describe "#rollback" do
+    before do
+      class School < ActiveRecord::Base
+        auditing
+      end
+      @school = School.create(:name => 'PS118')
+      @school.update_attributes(:name => 'PS99')
+      @audit = @school.audits.first
+    end
+    
+    it "the first audit should be the audit we want to rollback" do
+      @audit.action.should      == 'updated'
+      @audit.new_value.should   == 'PS99'
+      @audit.old_value.should   == 'PS118'
+      @audit.association.should == nil
+    end
+    
+    it "performs the rollback" do
+      @audit.rollback
+      @school.reload
+      @school.name.should == 'PS118'
+    end
+    
+    it "creates an audit when a rollback is performed" do
+      lambda { @audit.rollback }.should change { Audit.count }.by(1)
+    end
+    
+    it "the first audit after a rollback should contain the changed values" do
+      @audit.rollback
+      @school.reload
+      @school.audits.first.old_value.should == 'PS99'
+      @school.audits.first.new_value.should == 'PS118'
+    end
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,24 @@
+ActiveRecord::Schema.define(:version => 0) do
+  
+  create_table :audits, :force => true do |t|
+    t.string  :action
+    t.string  :auditable_type
+    t.integer :auditable_id
+    t.string  :association_type
+    t.integer :association_id
+    t.string  :field_name
+    t.string  :old_value
+    t.string  :new_value
+    # t.integer :user_id
+    t.boolean :undoable, :default => true
+    t.timestamps
+  end  
+  
+  
+  create_table :schools, :force => true do |t|
+    t.string   :name
+    t.datetime :established_on
+    t.timestamps
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'active_record'
+require 'auditing'
+require 'rspec'
+# require 'spec/autorun'
+
+# our test database
+TEST_DB = File.join(File.dirname(__FILE__), '..', 'test.sqlite3')
+File.unlink(TEST_DB) if File.exist?(TEST_DB)
+ActiveRecord::Base.establish_connection(
+  :adapter  => "sqlite3", 
+  :database => TEST_DB
+)
+
+# our schema
+load(File.dirname(__FILE__) + '/schema.rb')
+
+class Audit < ActiveRecord::Base
+  include Auditing::Auditor
+  belongs_to :auditable,   :polymorphic => true
+  belongs_to :association, :polymorphic => true
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: auditing
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Brad
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-29 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: acts_as_versioned is good. This allows an attribute level rollback instead
+email: brad.cantin@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .bundle/config
+- .document
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- auditing.gemspec
+- lib/auditing.rb
+- lib/auditing/auditing.rb
+- lib/auditing/auditor.rb
+- spec/auditing/auditing_spec.rb
+- spec/auditing/auditor_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/bcantin/auditing
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A gem to keep track of audit hisory of a record
+test_files: 
+- spec/auditing/auditing_spec.rb
+- spec/auditing/auditor_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb