audit_trail 0.0.1

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

@@ -0,0 +1,16 @@
+class CreateAuditTrails < ActiveRecord::Migration
+  def self.up
+    create_table(:change_events) do |t|
+      t.integer :changed_object_id, :changed_by_id, :integer_value, :previous_integer_value
+      t.string  :changed_object_type, :changed_attribute, :string_value, :previous_string_value, :additional_info, :changer_ip_address
+      t.date    :date_value, :previous_date_value
+      t.datetime :created_at, :datetime_value, :previous_datetime_value
+      t.decimal  :decimal_value, :previous_decimal_value, :precision => 14, :scale => 2
+      t.boolean  :boolean_value, :previous_boolean_value
+    end
+  end
+  
+  def self.down
+    drop_table :change_events
+  end
+end

data/test/audit_trail_test.rb

@@ -0,0 +1,5 @@
+require 'test_helper'
+
+class AuditTrailTest < ActiveSupport::TestCase
+  
+end

data/test/change_tracking_test.rb

@@ -0,0 +1,242 @@
+require 'test_helper'
+
+class ChangeTrackingTest < ActiveSupport::TestCase
+  
+  setup :declare_tracked_model
+  teardown :cleanup_tracked_model
+  
+  def test_methods_defined
+    assert TrackedModel.respond_to?(:audit_trail_for)
+  end
+  
+  def test_audit_trail_for
+    TrackedModel.class_eval do
+      audit_trail_for :count, :price
+    end
+    
+    obj = TrackedModel.new
+
+    assert obj.respond_to?(:record_change_event_for_count)
+    assert obj.respond_to?(:record_change_event_for_price)
+    
+    assert_equal :integer, TrackedModel.audit_trail_types['count']
+    assert_equal :decimal, TrackedModel.audit_trail_types['price']
+
+  end
+
+  def test_record_change_events__changes_on_non_tracked_attributes
+    TrackedModel.class_eval do
+      audit_trail_for :note
+    end
+    
+    obj = TrackedModel.new
+    obj.untracked_column = "foobar"
+
+    assert_no_difference 'ChangeEvent.count' do
+      obj.save!
+    end
+  end
+  
+  def test_record_change_events__changes_on_tracked_attributes
+    TrackedModel.class_eval do
+      audit_trail_for :note, :price
+    end
+    
+    obj = TrackedModel.new(:note => "value_new")
+    
+    assert_difference 'ChangeEvent.count', 1 do
+      obj.save!
+    end
+
+    assert_change_event ChangeEvent.last, 'note', nil, "value_new", :string, :changed_object => obj
+    
+    assert_no_difference 'ChangeEvent.count' do
+      obj.save!
+    end
+    
+    assert_difference 'ChangeEvent.count', 2 do
+      obj.update_attributes!(:note => "new_new_value", :price => 100.00)
+    end
+    
+    note_change_event = ChangeEvent.where(:changed_attribute => "note").last
+    assert_change_event note_change_event, 'note', "value_new", "new_new_value", :string, :changed_object => obj
+
+    price_change_event = ChangeEvent.where(:changed_attribute => "price").last
+    assert_change_event price_change_event, 'price', nil, 100.00, :decimal, :changed_object => obj
+  end
+
+  def test_record_change_events__changes_on_tracked_attributes__with_additional_info
+    TrackedModel.class_eval do
+      audit_trail_for :note, :additional_info => :note_additional_info
+      audit_trail_for :price, :additional_info => Proc.new { |rec| "Price: #{rec.price}"}
+      
+      def note_additional_info
+        "note"
+      end
+    end
+    
+    obj = TrackedModel.create(:note => 'old_value', :price => 1)
+    obj.note = "new_note"
+    obj.price = 10
+
+    assert_difference 'ChangeEvent.count', 2 do
+      obj.save!
+    end
+
+    note_change_event = obj.note_change_events.first
+    price_change_event = obj.price_change_events.first
+    
+    assert_change_event note_change_event, 'note', 'old_value', "new_note", :string, :changed_object => obj, :additional_info => 'note'
+    assert_change_event price_change_event, 'price', 1, 10, :decimal, :changed_object => obj, :additional_info => "Price: 10.0"
+  end
+
+  def test_record_change_events__changes_on_tracked_attributes__if_block
+    TrackedModel.class_eval do
+      audit_trail_for :note, :if => :some_check
+    end
+    
+    obj = TrackedModel.new(:note => "old_value")
+    obj.stubs(:some_check).returns(true)
+    obj.save!
+
+    obj.note = "new_note"
+
+    assert_difference 'ChangeEvent.count', 1 do
+      obj.save!
+    end
+
+    note_change_event = ChangeEvent.last
+    assert_change_event note_change_event, 'note', 'old_value', "new_note", :string, :changed_object => obj
+    
+    obj.stubs(:some_check).returns(false)
+
+    assert_no_difference 'ChangeEvent.count' do
+      obj.update_attributes!(:note => 'new_new_note')
+    end
+  end
+
+  def test_record_change_events__changes_on_tracked_attributes__if_block_separate_statements_for_each_attr
+    TrackedModel.class_eval do
+      audit_trail_for :note, :if => :some_check_1
+      audit_trail_for :price, :if => Proc.new { |rec| rec.some_check_2 }
+    end
+    
+    obj = TrackedModel.new
+    obj.stubs(:some_check_1).returns(true)
+    obj.stubs(:some_check_2).returns(false)
+    
+    obj.note = "new_note"
+    obj.price = 1
+
+    assert_difference 'obj.note_change_events.count', 1 do
+      assert_no_difference 'obj.price_change_events.count' do
+        obj.save!
+      end
+    end
+
+    obj.stubs(:some_check_1).returns(false)
+    obj.stubs(:some_check_2).returns(true)
+
+    obj.note = "new_new_note"
+    obj.price = 100
+    
+    assert_no_difference 'obj.note_change_events.count' do
+      assert_difference 'obj.price_change_events.count', 1 do
+        obj.save!
+      end
+    end
+  end
+  
+  def test_change_events__different_types
+    TrackedModel.class_eval do
+      audit_trail_for :note, :price, :yes_no, :occurred_on, :occurred_at, :count
+    end
+    
+    obj = TrackedModel.new
+    obj.attributes = { :note => "new_note", :price => 10, :yes_no => true, :occurred_at => Time.now, :occurred_on => Date.today, :untracked_column => "hello", :count => 1 }
+    
+    assert_difference 'ChangeEvent.count', 6 do
+      obj.save!
+    end
+    
+    assert_change_event obj.note_change_events.first, 'note', nil, "new_note", :string
+    assert_change_event obj.price_change_events.first, 'price', nil, 10, :decimal
+    assert_change_event obj.count_change_events.first, 'count', nil, 1, :integer
+    assert_change_event obj.yes_no_change_events.first, 'yes_no', nil, true, :boolean
+    assert_change_event obj.occurred_on_change_events.first, 'occurred_on', nil, Date.today, :date
+  end
+  
+  def test_change_events__records_user
+    TrackedModel.class_eval do
+      audit_trail_for :note
+    end
+    ChangeEvent.stubs(:changer).returns(stub(:id => 5))
+
+    obj = TrackedModel.new(:note => 'note')
+    obj.save!
+    
+    changed_event = ChangeEvent.last
+    assert_equal 5, changed_event.changed_by_id
+  end
+  
+  def test_change_events__records_ip_address
+    TrackedModel.class_eval do
+      audit_trail_for :note
+    end
+
+    ChangeEvent.stubs(:changer_ip_address).returns("3.4.5.6")
+
+    obj = TrackedModel.new(:note => 'note')
+    obj.save!
+    
+    changed_event = ChangeEvent.last
+    assert_equal "3.4.5.6", changed_event.changer_ip_address
+  end
+  
+  def test_change_events__supports_different_callbacks
+    TrackedModel.class_eval do
+      audit_trail_for :note
+      audit_trail_for :price, :on => :update
+    end
+    
+    obj = TrackedModel.new
+
+    assert_difference 'obj.note_change_events.count', 1 do
+      assert_no_difference 'obj.price_change_events.count' do
+        obj.update_attributes!(:note => 'note', :price => 1)
+      end
+    end
+    
+    assert_difference 'obj.note_change_events.count', 1 do
+      assert_difference 'obj.price_change_events.count', 1 do
+        obj.update_attributes!(:note => 'note2', :price => 100)
+      end
+    end
+    
+    assert_no_difference 'obj.note_change_events.count' do
+      assert_no_difference 'obj.price_change_events.count' do
+        obj.update_attributes!(:note => 'note2', :price => 100)
+      end
+    end
+  end
+
+  private
+  
+  def assert_change_event(change_event, changed_attribute, previous_value, new_value, type, options = {})
+    assert_equal changed_attribute, change_event.changed_attribute
+    assert_equal previous_value, change_event.previous_value
+    assert_equal new_value, change_event.value
+    assert_equal previous_value, change_event.send("previous_#{type}_value")
+    assert_equal new_value, change_event.send("#{type}_value")
+    if options[:additional_info]
+      assert_equal options[:additional_info], change_event.additional_info
+    else
+      assert change_event.additional_info.blank?
+    end
+    
+    if options[:changed_object]
+      assert_equal options[:changed_object], change_event.changed_object
+    end
+  end
+  
+end

data/test/test_app_3_1/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+gem 'audit_trail', :path => '../..'
+
+group :development do
+  gem 'rails', '3.1.0'
+  gem 'mysql2', '0.3.7'
+  gem 'mocha', '0.9.8', :require => false
+end

data/test/test_app_3_1/Gemfile.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: ../..
+  specs:
+    audit_trail (0.0.1)
+      rails (~> 3.1)
+
+GEM
+  remote: http://rubygems.org/
+  remote: https://gems:frifeprexo@gemini.atl.appfolio.net/
+  specs:
+    actionmailer (3.1.0)
+      actionpack (= 3.1.0)
+      mail (~> 2.3.0)
+    actionpack (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.2)
+      rack-cache (~> 1.0.3)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.0)
+    activemodel (3.1.0)
+      activesupport (= 3.1.0)
+      bcrypt-ruby (~> 3.0.0)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+    activesupport (3.1.0)
+      multi_json (~> 1.0)
+    arel (2.2.1)
+    bcrypt-ruby (3.0.1)
+    builder (3.0.0)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    json (1.4.3)
+    mail (2.3.0)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.17.2)
+    mocha (0.9.8)
+      rake
+    multi_json (1.0.4)
+    mysql2 (0.3.7)
+    polyglot (0.3.3)
+    rack (1.3.6)
+    rack-cache (1.0.3)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.1.0)
+      actionmailer (= 3.1.0)
+      actionpack (= 3.1.0)
+      activerecord (= 3.1.0)
+      activeresource (= 3.1.0)
+      activesupport (= 3.1.0)
+      bundler (~> 1.0)
+      railties (= 3.1.0)
+    railties (3.1.0)
+      actionpack (= 3.1.0)
+      activesupport (= 3.1.0)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    sprockets (2.0.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  audit_trail!
+  mocha (= 0.9.8)
+  mysql2 (= 0.3.7)
+  rails (= 3.1.0)

data/test/test_app_3_1/README

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.