auditing 1.2.2 → 1.3.0

data/Gemfile.lock

@@ -2,11 +2,26 @@ PATH
   remote: .
   specs:
     auditing (1.2.2)
+      activerecord (~> 3.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.5)
+    arel (2.0.9)
+    builder (2.1.2)
     diff-lcs (1.1.2)
+    i18n (0.5.0)
+    rake (0.8.7)
     rspec (2.4.0)
       rspec-core (~> 2.4.0)
       rspec-expectations (~> 2.4.0)
@@ -15,10 +30,16 @@ GEM
     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.25)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   auditing!
-  rspec
+  rake (~> 0.8.7)
+  rspec (~> 2.4.0)
+  sqlite3-ruby

data/{README.rdoc → README.markdown}

@@ -1,88 +1,84 @@
-= auditing
+# auditing
 
 Auditing is a simple way to track and rollback changes to a record.
-== Sample Project
 
-http://github.com/bcantin/auditing_project
+[![Build Status](http://travis-ci.org/bcantin/auditing.png)](http://travis-ci.org/bcantin/auditing)
+
+## Sample Project
+
+https://github.com/bcantin/auditing_project
   
-== Installation
+## Installation
 
-  gem install auditing
+    gem install auditing
+  
+There is a handy installer in the gem now. To see what it will do
   
-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
-    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
+    rails g auditing:install --help
   
+and, of course, to use it
+
+    rails g auditing:install
+    rake db:migrate
+    
 If you want to track the user, uncomment the t.integer :user_id above.  See the Tracking Users section below.
 
-Update your Audit class 
 
-  class Audit < ActiveRecord::Base
-    include Auditing::Auditor
-    belongs_to :auditable,   :polymorphic => true
-    belongs_to :association, :polymorphic => true
-  end
-  
-  
-== Basic Usage
+## Upgrading to 1.3.0
+
+New installs will not need to do this.  Anyone that is using 1.2.2 and belong should 
+
+    gem update auditing
+    # ... updates happen
+    rails g auditing:upgrade
+    rake db:migrate
+    
+This will create a new migration to update the :old_value and :new_value attribute from STRING to TEXT
+
+
+## Basic Usage
 
 To add auditing to all attributes on a model, simply add auditing to the model.
 
-  class School < ActiveRecord::Base
-    audit_enabled
-  end
+    class School < ActiveRecord::Base
+      audit_enabled
+    end
 
 If you want more control over which attributes are audited, you can define them
 by supplying a fields hash
 
-  class School < ActiveRecord::Base
-    audit_enabled :fields => [:name, :established_on]
-  end
+    class School < ActiveRecord::Base
+      audit_enabled :fields => [:name, :established_on]
+    end
   
 Auditing will not track "id", "created_at", or "updated_at" by default
 
-== belongs_to relationships
+## belongs_to relationships
 
 Auditing a belongs_to relationship works by keeping track of the foreign_id attribute. You do
 not need to add anything to the foreign model.
 
-== has_many relationships
+## has_many relationships
 
 You may have the need to keep track of a has_many relationship.  To accomplish this, we have
 to enable a similar type of auditing on the other model(s)
 
-  class Company < ActiveRecord::Base
-    has_many :phone_numbers
-    audit_enabled
-  end
-  class PhoneNumber < ActiveRecord::Base
-    belongs_to :company
-    audit_relationship_enabled
-  end
+    class Company < ActiveRecord::Base
+      has_many :phone_numbers
+      audit_enabled
+    end
+    class PhoneNumber < ActiveRecord::Base
+      belongs_to :company
+      audit_relationship_enabled
+    end
 
 As above, you can supply a :fields hash of which attributes will be logged.
 If your relationship is polymorphic, you can supply an array of classes
 that you only want to log.
 
-  audit_relationship_enabled :only => [Company, Person]
+    audit_relationship_enabled :only => [Company, Person]
 
-== Tracking Users
+## Tracking Users
 
 NOTE: there is probably a more elegant solution to this,  if you know of
 one, please drop me a line.
@@ -94,68 +90,67 @@ 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
+    add_column :audits, :user_id, :integer
 
 You will need to add the relationship to the Audit class as well
 
-  class Audit < ActiveRecord::Base
-    belongs_to :user
-  end
+    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
+
+    class User < ActiveRecord::Base
+      has_many :audits
+    end
 
 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
+    class User < ActiveRecord::Base
+  
+      def self.current_user=(current_user)
+        @current_user = current_user
+      end
+  
+      def self.current_user
+        @current_user
+      end
+  
     end
-    
-  end
 
 Your ApplicationController should also set the current user so the auditing gem can 
 get the current user properly
 
-  class ApplicationController < ActionController::Base
+    class ApplicationController < ActionController::Base
+
+      before_filter :set_current_user
+      after_filter  :unset_current_user
+  
+      private
+  
+      def set_current_user
+        User.current_user = current_user
+      end
+  
+      def unset_current_user
+        User.current_user = nil
+      end
   
-    before_filter :set_current_user
-    after_filter  :unset_current_user
-    
-    private
-    
-    def set_current_user
-      User.current_user = current_user
-    end
-    
-    def unset_current_user
-      User.current_user = nil
     end
-    
-  end
   
-== Testing
+## Testing
 
 To run the tests, first clone this repo, then
 
-  cd auditing
-  bundle
-  rspec spec
-  
+    cd auditing
+    bundle
+    rake
 
-== Note on Patches/Pull Requests
+## Note on Patches/Pull Requests
  
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -166,6 +161,6 @@ To run the tests, first clone this repo, then
   a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-== Copyright
+## Copyright
 
-Copyright (c) 2010 Brad Cantin. See LICENSE for details.
+Copyright (c) 2011 Brad Cantin. See LICENSE for details.

data/Rakefile

@@ -1,2 +1,34 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+# require 'bundler'
+# Bundler::GemHelper.install_tasks
+
+begin
+  require 'bundler/setup'
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  puts 'although not required, bundler is recommened for running the tests'
+end
+
+
+task :default => [:test]
+
+task :test do
+  sh "bundle exec rspec spec"
+end
+
+
+# require 'rake'
+
+# begin
+#   require 'bundler/setup'
+#   Bundler::GemHelper.install_tasks
+# rescue LoadError
+#   puts 'although not required, bundler is recommened for running the tests'
+# end
+# 
+# task :default => :spec
+# 
+# require 'rspec/core/rake_task'
+# RSpec::Core::RakeTask.new do |t|
+#   t.rspec_opts = ["--color", '--format doc']
+# end
+# 

data/auditing.gemspec

@@ -12,7 +12,11 @@ Gem::Specification.new do |s|
   s.description = %q{acts_as_versioned is good. This allows an attribute level rollback instead}
   s.summary     = %q{A gem to keep track of audit hisory of a record}
   
-  s.add_development_dependency "rspec"
+  s.add_development_dependency(%q<rspec>, ["~> 2.4.0"])
+  s.add_development_dependency(%q<rake>,  ["~> 0.8.7"])
+  s.add_development_dependency "sqlite3-ruby"
+  
+  s.add_dependency('activerecord', '~> 3.0.0')
   
   s.rubyforge_project = "auditing"
 

data/lib/auditing/base.rb

@@ -68,9 +68,16 @@ module Auditing
         add_audit(:action => 'removed', :association => item, :undoable => false)
       end
 
+      def class_exists?(class_name)
+        klass = Module.const_get(class_name)
+        return klass.is_a?(Class)
+      rescue NameError
+        return false
+      end
+
       private
         def add_audit(hash={})
-          if User.respond_to?(:current_user) && !User.current_user.blank?
+          if class_exists?('User') && User.respond_to?(:current_user) && !User.current_user.blank?
             hash[:user_id] = User.current_user.id
           end
           Audit.create!({:auditable => self}.merge(hash))

data/lib/auditing/version.rb

@@ -1,3 +1,3 @@
 module Auditing
-  VERSION = "1.2.2"  
+  VERSION = "1.3.0"
 end

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

@@ -7,8 +7,8 @@ class CreateAudits < ActiveRecord::Migration
       t.string  :association_type
       t.integer :association_id
       t.string  :field_name
-      t.string  :old_value
-      t.string  :new_value
+      t.text    :old_value
+      t.text    :new_value
       # t.integer :user_id
       t.boolean :undoable, :default => true
       t.timestamps

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

@@ -0,0 +1,11 @@
+class UpdateAudits < ActiveRecord::Migration
+  def self.up
+    change_column :audits, :old_value, :text
+    change_column :audits, :new_value, :text
+  end
+
+  def self.down
+    change_column :audits, :old_value, :string
+    change_column :audits, :new_value, :string
+  end
+end

data/lib/generators/auditing/upgrade_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators/migration'
+
+module Auditing
+  module Generators
+    class UpgradeGenerator < Rails::Generators::Base
+    
+      include Rails::Generators::Migration
+    
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_migration
+        migration_template 'update_migration.rb', "db/migrate/update_audits.rb"
+      end
+
+      private
+
+      def self.next_migration_number(dirname) #:nodoc:
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+    end
+  end
+end

data/spec/auditing/base_spec.rb

@@ -204,4 +204,48 @@ describe "Base" do
     end
   end # belongs_to relationships
 
+  describe "text fields" do
+    before do
+      class Special < ActiveRecord::Base
+        audit_enabled
+      end
+    end
+    
+    it "should properly work on creation" do
+      long_string = 'a'
+      2000.times do
+        long_string << 'b'
+      end
+      special = Special.create(:text_field => long_string)
+      special.audits.should_not be_nil
+    end
+    
+    describe "updating a text field" do
+      before do
+        @long_string     = 'a'
+        @new_long_string = 'c'
+        2000.times do
+          @long_string     << 'b'
+          @new_long_string << 'd'
+        end
+        @special = Special.create(:text_field => @long_string)
+      end
+      
+      it "should create an audit log when we update a text field" do
+        lambda {@special.update_attributes(:text_field => @new_long_string)
+                }.should change { Audit.count }.by(1)
+      end
+      
+      it "should allow access to the old and new values" do
+        @special.update_attributes(:text_field => @new_long_string)
+        audit = @special.audits.first
+        audit.old_value.should eql(@long_string)
+        audit.new_value.should eql(@new_long_string)
+      end
+      
+    end
+    
+    
+  end
+
 end

data/spec/schema.rb

@@ -1,5 +1,5 @@
 ActiveRecord::Schema.define(:version => 0) do
-  
+
   create_table :audits do |t|
     t.string  :action
     t.string  :auditable_type
@@ -7,35 +7,35 @@ ActiveRecord::Schema.define(:version => 0) do
     t.string  :association_type
     t.integer :association_id
     t.string  :field_name
-    t.string  :old_value
-    t.string  :new_value
+    t.text    :old_value
+    t.text    :new_value
     t.integer :user_id
     t.boolean :undoable, :default => true
     t.timestamps
-  end  
-  
+  end
+
   create_table :schools do |t|
     t.string   :name
     t.datetime :established_on
     t.timestamps
   end
-  
+
   create_table :cars do |t|
     t.string  :name
     t.integer :auto_maker_id
     t.timestamps
   end
-  
+
   create_table :auto_makers do |t|
     t.string :name
     t.timestamps
   end
-  
+
   create_table :companies do |t|
     t.string :name
     t.timestamps
   end
-  
+
   create_table :phone_numbers do |t|
     t.string  :number
     t.string  :extension
@@ -43,22 +43,26 @@ ActiveRecord::Schema.define(:version => 0) do
     t.integer :phoneable_id
     t.timestamps
   end
-  
+
   create_table :people do |t|
     t.string :first_name
     t.string :last_name
     t.timestamps
   end
-  
+
   create_table :employments do |t|
     t.integer  :person_id
     t.integer  :company_id
     t.string   :start_date
     t.timestamps
   end
-  
+
   create_table :users do |t|
     t.string :email
   end
   
-end
+  create_table :specials do |t|
+    t.text :text_field
+  end
+  
+end

metadata

@@ -2,7 +2,7 @@
 name: auditing
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors: 
 - Brad Cantin
@@ -10,20 +10,53 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-05 00:00:00 -05:00
+date: 2011-04-14 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 
+        version: 2.4.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.8.7
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
-  version_requirements: *id001
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id004
 description: acts_as_versioned is good. This allows an attribute level rollback instead
 email: 
 - brad.cantin@gmail.com
@@ -42,7 +75,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - auditing.gemspec
 - lib/auditing.rb
@@ -58,6 +91,8 @@ files:
 - lib/generators/auditing/templates/index.html.erb
 - lib/generators/auditing/templates/initializer.rb
 - lib/generators/auditing/templates/migration.rb
+- lib/generators/auditing/templates/update_migration.rb
+- lib/generators/auditing/upgrade_generator.rb
 - spec/auditing/audit_relationship_spec.rb
 - spec/auditing/auditor_spec.rb
 - spec/auditing/base_spec.rb