auditing 1.3.1 → 1.4.0

data/.bundle/config

@@ -1,2 +1,2 @@
---- 
-BUNDLE_DISABLE_SHARED_GEMS: "1"
+--- {}
+

data/.rvmrc.rbx

@@ -0,0 +1 @@
+rvm use rbx@auditing

data/Gemfile.lock

@@ -1,24 +1,24 @@
 PATH
   remote: .
   specs:
-    auditing (1.3.0)
+    auditing (1.4.0)
       activerecord (~> 3.0.0)
       activesupport (~> 3.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.0.6)
-      activesupport (= 3.0.6)
+    activemodel (3.0.7)
+      activesupport (= 3.0.7)
       builder (~> 2.1.2)
       i18n (~> 0.5.0)
-    activerecord (3.0.6)
-      activemodel (= 3.0.6)
-      activesupport (= 3.0.6)
+    activerecord (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
       arel (~> 2.0.2)
       tzinfo (~> 0.3.23)
-    activesupport (3.0.6)
-    arel (2.0.9)
+    activesupport (3.0.7)
+    arel (2.0.10)
     builder (2.1.2)
     diff-lcs (1.1.2)
     i18n (0.5.0)
@@ -35,7 +35,7 @@ GEM
     sqlite3-ruby (1.3.3)
       sqlite3 (>= 1.3.3)
     timecop (0.3.5)
-    tzinfo (0.3.26)
+    tzinfo (0.3.27)
 
 PLATFORMS
   ruby

data/README.markdown

@@ -24,7 +24,7 @@ and, of course, to use it
 If you want to track the user, uncomment the t.integer :user_id above.  See the Tracking Users section below.
 
 
-## Upgrading to 1.3.0
+## Upgrading to 1.4.0
 
 New installs will not need to do this.  Anyone that is using 1.2.X and below should upgrade
 
@@ -34,6 +34,7 @@ New installs will not need to do this.  Anyone that is using 1.2.X and below sho
     rake db:migrate
     
 This will create a new migration to update the :old_value and :new_value attribute from STRING to TEXT
+It will also create an initializer (see Tracking Users section below)
 
 
 ## Basic Usage
@@ -80,32 +81,58 @@ that you only want to log.
 
 ## 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
 
-You will need to add the relationship to the Audit class as well
+To let the auditing gem know which model to attribute the changes to, you will 
+need to do some minor setup.  Edit the config/initializers/auditing.rb file 
+created during the installation.  If you do not have that file, it should 
+look like this...
+
+    Auditing.configure do |config|
+      config.report_on      = nil # User
+      config.report_method  = nil # 'current_user'
+    end
+        
+
+You will need to set the config.report_on to the model you are using.  Most 
+applications use a model called User and a method called 'current_user'. If 
+this is your case, then your config file should be updated to look like this...
+
+    Auditing.configure do |config|
+      config.report_on      = User
+      config.report_method  = 'current_user'
+    end
+
+If your application uses something else, say a model called Member, and you 
+have a method to get the logged in member called 'my_awesome_member' then your
+config file should be updated to look like this...
+
+    Auditing.configure do |config|
+      config.report_on      = Member
+      config.report_method  = 'my_awesome_member'
+    end
+
+You will need to add the relationship to the Audit class and to your User / Member /
+(Insert your custom model here)
 
     class Audit < ActiveRecord::Base
       belongs_to :user
     end
 
-If you want to see all the audits for a particular user, you can
-add the has_many relationship to the User model as well
-
     class User < ActiveRecord::Base
       has_many :audits
     end
 
-Your user class should respond to a class method called current_user 
+You can alter the suggested implementation below to suite your needs.  I am showing
+a model named User and a method called current_user.  
+
+
+
+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
@@ -122,11 +149,10 @@ Here is a suggested method
   
     end
 
-Your ApplicationController should also set the current user so the auditing gem can 
-get the current user properly
+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  :unset_current_user
   
@@ -139,7 +165,6 @@ get the current user properly
       def unset_current_user
         User.current_user = nil
       end
-  
     end
   
 ## Testing

data/lib/auditing.rb

@@ -1,4 +1,14 @@
 module Auditing
+  
+  class << self
+    attr_accessor :report_on, :report_method
+
+    def configure
+      yield self
+      true
+    end
+  end
+  
 end
 
 require 'auditing/base'

data/lib/auditing/base.rb

@@ -28,8 +28,8 @@ module Auditing
     end
 
     module InstanceMethods
+      
       # http://stackoverflow.com/questions/1906421/problem-saving-rails-marshal-in-sqlite3-db
-       
       def dump_data(value)
         ActiveSupport::Base64.encode64(Marshal.dump(value))
       end
@@ -46,8 +46,7 @@ module Auditing
             add_audit(:action     => 'updated',
                       :field_name => field,
                       :old_value  => dump_data(change[0]),
-                      :new_value  => dump_data(change[1]) 
-                      )
+                      :new_value  => dump_data(change[1]) )
           end
         end
       end
@@ -85,8 +84,10 @@ module Auditing
 
       private
         def add_audit(hash={})
-          if class_exists?('User') && User.respond_to?(:current_user) && !User.current_user.blank?
-            hash[:user_id] = User.current_user.id
+          unless Auditing.report_on.nil?
+            if class_exists?(Auditing.report_on.to_s) && Auditing.report_on.respond_to?(Auditing.report_method.to_sym) && !Auditing.report_on.send(Auditing.report_method.to_sym).blank?
+              hash[:user_id] = Auditing.report_on.send(Auditing.report_method.to_sym).id
+            end
           end
           Audit.create!({:auditable => self}.merge(hash))
         end

data/lib/auditing/version.rb

@@ -1,3 +1,3 @@
 module Auditing
-  VERSION = "1.3.1"
+  VERSION = "1.4.0"
 end

data/lib/generators/auditing/USAGE

@@ -10,6 +10,7 @@ Example:
         app/models/audit.rb
         app/views/audits/index.html.erb 
         db/migrate/#{time_stamp}_create_audits.rb
+        config/initializers/auditing.rb
         
     This will modify config/routes.rb with
         match ':resource/:id/audits' => 'audits#index', :as => 'audits'

data/lib/generators/auditing/install_generator.rb

@@ -32,6 +32,10 @@ module Auditing
       def create_migration
         migration_template 'migration.rb', "db/migrate/create_audits.rb"
       end
+      
+      def create_initializer
+        template 'auditing.rb', 'config/initializers/auditing.rb'
+      end
 
       private
 

data/lib/generators/auditing/templates/auditing.rb

@@ -0,0 +1,4 @@
+Auditing.configure do |config|
+  config.report_on      = nil # User
+  config.report_method  = nil # 'current_user'
+end

data/lib/generators/auditing/upgrade_generator.rb

@@ -12,6 +12,10 @@ module Auditing
         migration_template 'update_migration.rb', "db/migrate/update_audits.rb"
       end
 
+      def create_initializer
+        template 'auditing.rb', 'config/initializers/auditing.rb'
+      end
+
       private
 
       def self.next_migration_number(dirname) #:nodoc:

data/spec/auditing/config_report_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe "auditing configuration" do
+
+  describe ":report_on => User; :report_method => 'current_user'" 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
+    
+      Auditing.configure do |config|
+        config.report_on     = User
+        config.report_method = 'current_user'
+      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
+  
+  describe ":report_on => Member; :report_method => 'current_member'" do
+    before do
+      class School < ActiveRecord::Base
+        audit_enabled
+      end
+    
+      class Member < ActiveRecord::Base
+        def self.current_member=(member)
+          @current_member = member
+        end
+        def self.current_member
+          @current_member
+        end
+      end
+    
+      Auditing.configure do |config|
+        config.report_on     = Member
+        config.report_method = 'current_member'
+      end
+    
+      @member1 = Member.create(:member_name=>'foo_dude')
+      @member2 = Member.create(:member_name=>'bar_dude')
+    end
+  
+    it "adds the member to the audit" do
+      Member.current_member = @member1
+      school = School.create(:name => 'PS118')
+      a = school.audits.first
+      a.user_id.should == @member1.id
+      Member.current_member = nil
+    end
+  
+    it "does not add the member to the audit if Member.current_member is not set" do
+      school = School.create(:name => 'PS118')
+      a = school.audits.first
+      a.user_id.should == nil
+    end
+  end
+end

data/spec/schema.rb

@@ -61,6 +61,10 @@ ActiveRecord::Schema.define(:version => 0) do
     t.string :email
   end
   
+  create_table :members do |t|
+    t.string :member_name
+  end
+  
   create_table :specials do |t|
     t.text :text_field
     t.date :date_field

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'active_record'
 require 'auditing'
 require 'rspec'
+require 'timecop'
 
 # our test database
 TEST_DB = File.join(File.dirname(__FILE__), '..', 'test.sqlite3')
@@ -16,11 +17,13 @@ ActiveRecord::Base.establish_connection(
 # our schema
 load(File.dirname(__FILE__) + '/schema.rb')
 
+Auditing.configure do |config|
+  config.report_on      = nil
+  config.report_method  = nil
+end
+
 class Audit < ActiveRecord::Base
   include Auditing::Auditor
   belongs_to :auditable,   :polymorphic => true
   belongs_to :association, :polymorphic => true
 end
-
-# class User < ActiveRecord::Base
-# end

data/todo.txt

@@ -0,0 +1,27 @@
+# TODO
+config (aka => tigre-clint)
+  serialization (default ?)
+    allow dev to create their own, location should be lib/auditing/serialization
+      publish API (load / dump)
+  
+serialization schemes
+  YAML
+  BASE64
+  Marshal
+  other?
+  
+  
+documentation
+  investigate YARD
+  update auditing_project
+    create branch that shows
+      defaults
+      custom user => MEMBER
+      custom serialization => maybe put BASE64 here instead ?
+      
+
+test all column types with all supported serialization schemes
+  use BASE64 to document how to add / test your own
+  
+possible screencast about installation / usage ?
+possible opensourceitwith.me/gems/auditing

metadata

@@ -2,7 +2,7 @@
 name: auditing
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors: 
 - Brad Cantin
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-15 00:00:00 -04:00
+date: 2011-05-22 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -94,6 +94,7 @@ files:
 - .gitignore
 - .rspec
 - .rvmrc
+- .rvmrc.rbx
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -108,6 +109,7 @@ files:
 - lib/generators/auditing/USAGE
 - lib/generators/auditing/install_generator.rb
 - lib/generators/auditing/templates/audit.rb
+- lib/generators/auditing/templates/auditing.rb
 - lib/generators/auditing/templates/audits_controller.rb
 - lib/generators/auditing/templates/audits_helper.rb
 - lib/generators/auditing/templates/index.html.erb
@@ -118,10 +120,11 @@ files:
 - spec/auditing/audit_relationship_spec.rb
 - spec/auditing/auditor_spec.rb
 - spec/auditing/base_spec.rb
+- spec/auditing/config_report_spec.rb
 - spec/auditing/formats_spec.rb
-- spec/auditing/with_users_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb
+- todo.txt
 has_rdoc: true
 homepage: https://github.com/bcantin/auditing
 licenses: []
@@ -154,7 +157,7 @@ test_files:
 - spec/auditing/audit_relationship_spec.rb
 - spec/auditing/auditor_spec.rb
 - spec/auditing/base_spec.rb
+- spec/auditing/config_report_spec.rb
 - spec/auditing/formats_spec.rb
-- spec/auditing/with_users_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb

data/spec/auditing/with_users_spec.rb

@@ -1,37 +0,0 @@
-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