auditing 1.1.3 → 1.2.0

data/.rvmrc

@@ -0,0 +1,5 @@
+if [[ -n "$rvm_environments_path" && -s "$rvm_environments_path/ruby-1.8.7-p302@auditing" ]] ; then
+  \. "$rvm_environments_path/ruby-1.8.7-p302@auditing"
+else
+  rvm --create use  "ruby-1.8.7-p302@auditing"
+fi

data/Gemfile

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

data/Gemfile.lock

@@ -1,36 +1,37 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.0.0.rc2)
-      activesupport (= 3.0.0.rc2)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
       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)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
       tzinfo (~> 0.3.23)
-    activesupport (3.0.0.rc2)
-    arel (1.0.0.rc1)
-      activesupport (>= 3.0.0.beta)
+    activesupport (3.0.3)
+    arel (2.0.7)
     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)
-    sqlite3-ruby (1.3.1)
-    tzinfo (0.3.23)
+    i18n (0.5.0)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    sqlite3 (1.3.3)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
+    tzinfo (0.3.24)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (~> 3.0.0.rc2)
-  rspec (~> 2.0)
-  sqlite3-ruby (~> 1.3)
+  activerecord
+  rspec
+  sqlite3-ruby

data/README.rdoc

@@ -9,7 +9,11 @@ http://github.com/bcantin/auditing_project
 
   gem install auditing
   
-You will have to supply a model named Audit in your rails application with the following migration
+You will have to supply a model named Audit in your rails application 
+
+  rails g model audit
+
+Here is a migration for your audit model following migration
 
   create_table :audits, :force => true do |t|
     t.string  :action
@@ -25,9 +29,9 @@ You will have to supply a model named Audit in your rails application with the f
     t.timestamps
   end
   
-If you want to track the user, uncomment the t.integer :user_id above.
+If you want to track the user, uncomment the t.integer :user_id above.  See the Tracking Users section below.
 
-TODO: more to follow about tracking the user
+Update your Audit class 
 
   class Audit < ActiveRecord::Base
     include Auditing::Auditor
@@ -77,7 +81,67 @@ If your relationship is polymorphic, you can supply an array of classes
 that you only want to log.
 
   audit_relationship_enabled :only => [Company, Person]
+
+== Tracking Users
+
+NOTE: there is probably a more elegant solution to this,  if you know of
+one, please drop me a line.
+
+NOTE: currently this only works with a model called User. I welcome patches
+to change this.
+
+To track which logged in users have made the changes, you will need to have a 
+user_id column in your audits table.  If you did not add it when you created
+the audits table, you can add it in another migration
+
+  add_column :audits, :user_id, :integer
+
+Your user class should respond to a class method called current_user 
+and current_user= (some authentication systems do this, others do not).
+
+Here is a suggested method
+
+  class User < ActiveRecord::Base
+    
+    def self.current_user=(current_user)
+      @current_user = current_user
+    end
+    
+    def self.current_user
+      @current_user
+    end
+    
+  end
+
+Your ApplicationController should also set the current user so the auditing gem can 
+get the current user properly
+
+  class ApplicationController < ActionController::Base
+  
+    before_filter :set_current_user
+    after_filter  :unser_current_user
+    
+    private
+    
+    def set_current_user
+      User.current_user = current_user
+    end
+    
+    def unset_current_user
+      User.current_user = nil
+    end
+    
+  end
   
+== Testing
+
+To run the tests, first clone this repo, then
+
+  cd auditing
+  bundle
+  rspec spec
+  
+
 == Note on Patches/Pull Requests
  
 * Fork the project.
@@ -85,7 +149,8 @@ that you only want to log.
 * 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)
+  (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

data/Rakefile

@@ -18,19 +18,19 @@ 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
+# 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
 

data/VERSION

@@ -1 +1 @@
-1.1.3
+1.2.0

data/auditing.gemspec

@@ -1,54 +1,55 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{auditing}
-  s.version = "1.1.3"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brad Cantin"]
-  s.date = %q{2010-10-16}
+  s.date = %q{2011-02-01}
   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"
+    "README.rdoc"
   ]
   s.files = [
     ".bundle/config",
-     ".document",
-     ".gitignore",
-     ".rspec",
-     "Gemfile",
-     "Gemfile.lock",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "auditing.gemspec",
-     "lib/auditing.rb",
-     "lib/auditing/audit_relationship.rb",
-     "lib/auditing/auditor.rb",
-     "lib/auditing/base.rb",
-     "spec/auditing/audit_relationship_spec.rb",
-     "spec/auditing/auditor_spec.rb",
-     "spec/auditing/base_spec.rb",
-     "spec/schema.rb",
-     "spec/spec_helper.rb"
+    ".document",
+    ".rspec",
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "auditing.gemspec",
+    "lib/auditing.rb",
+    "lib/auditing/audit_relationship.rb",
+    "lib/auditing/auditor.rb",
+    "lib/auditing/base.rb",
+    "spec/auditing/audit_relationship_spec.rb",
+    "spec/auditing/auditor_spec.rb",
+    "spec/auditing/base_spec.rb",
+    "spec/auditing/with_users_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/audit_relationship_spec.rb",
-     "spec/auditing/auditor_spec.rb",
-     "spec/auditing/base_spec.rb",
-     "spec/schema.rb",
-     "spec/spec_helper.rb"
+    "spec/auditing/auditor_spec.rb",
+    "spec/auditing/base_spec.rb",
+    "spec/auditing/with_users_spec.rb",
+    "spec/schema.rb",
+    "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -56,11 +57,20 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<activerecord>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 2.0"])
     else
+      s.add_dependency(%q<activerecord>, [">= 0"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 2.0"])
     end
   else
+    s.add_dependency(%q<activerecord>, [">= 0"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 2.0"])
   end
 end

data/lib/auditing/auditor.rb

@@ -27,4 +27,5 @@ module Auditing
     end
     
   end # end Auditing::Auditor
-end
+end
+

data/lib/auditing/base.rb

@@ -70,6 +70,9 @@ module Auditing
 
       private
         def add_audit(hash={})
+          if User.respond_to?(:current_user) && !User.current_user.blank?
+            hash[:user_id] = User.current_user.id
+          end
           Audit.create!({:auditable => self}.merge(hash))
         end
     end # Auditing::InstanceMethods

data/spec/auditing/with_users_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe "auditing with users" do
+
+  before do
+    class School < ActiveRecord::Base
+      audit_enabled
+    end
+    
+    class User < ActiveRecord::Base
+      def self.current_user=(user)
+        @current_user = user
+      end
+      def self.current_user
+        @current_user
+      end
+    end
+    
+    @user1 = User.create(:email=>'foo@example.com')
+    @user2 = User.create(:email=>'bar@example.com')
+  end
+  
+  it "adds the user to the audit" do
+    User.current_user = @user1
+    school = School.create(:name => 'PS118')
+    a = school.audits.first
+    a.user_id.should == @user1.id
+    User.current_user = nil
+  end
+  
+  it "does not add the user to the audit if User.current_user is not set" do
+    school = School.create(:name => 'PS118')
+    a = school.audits.first
+    a.user_id.should == nil
+  end
+  
+end

data/spec/schema.rb

@@ -9,7 +9,7 @@ ActiveRecord::Schema.define(:version => 0) do
     t.string  :field_name
     t.string  :old_value
     t.string  :new_value
-    # t.integer :user_id
+    t.integer :user_id
     t.boolean :undoable, :default => true
     t.timestamps
   end  
@@ -56,5 +56,9 @@ ActiveRecord::Schema.define(:version => 0) do
     t.string   :start_date
     t.timestamps
   end
-
+  
+  create_table :users do |t|
+    t.string :email
+  end
+  
 end

data/spec/spec_helper.rb

@@ -20,4 +20,7 @@ class Audit < ActiveRecord::Base
   include Auditing::Auditor
   belongs_to :auditable,   :polymorphic => true
   belongs_to :association, :polymorphic => true
+end
+
+class User < ActiveRecord::Base
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: auditing
 version: !ruby/object:Gem::Version 
+  hash: 31
   prerelease: false
   segments: 
   - 1
-  - 1
-  - 3
-  version: 1.1.3
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Brad Cantin
@@ -14,23 +15,66 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-16 00:00:00 -04:00
+date: 2011-02-01 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: activerecord
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: sqlite3-ruby
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
   name: rspec
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  name: rspec
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 2
         - 0
         version: "2.0"
-  type: :development
-  version_requirements: *id001
+  requirement: *id004
 description: acts_as_versioned is good. This allows an attribute level rollback instead
 email: brad.cantin@gmail.com
 executables: []
@@ -43,8 +87,8 @@ extra_rdoc_files:
 files: 
 - .bundle/config
 - .document
-- .gitignore
 - .rspec
+- .rvmrc
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -59,6 +103,7 @@ files:
 - spec/auditing/audit_relationship_spec.rb
 - spec/auditing/auditor_spec.rb
 - spec/auditing/base_spec.rb
+- spec/auditing/with_users_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -66,8 +111,8 @@ homepage: http://github.com/bcantin/auditing
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -75,6 +120,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -83,6 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -97,5 +144,6 @@ test_files:
 - spec/auditing/audit_relationship_spec.rb
 - spec/auditing/auditor_spec.rb
 - spec/auditing/base_spec.rb
+- spec/auditing/with_users_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb

data/.gitignore

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