auditing 1.2.0 → 1.2.2

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/.rvmrc

@@ -1,5 +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"
+if [[ -n "$rvm_environments_path" && -s "$rvm_environments_path/ruby-1.9.2-p136@auditing" ]] ; then
+  \. "$rvm_environments_path/ruby-1.9.2-p136@auditing"
 else
-  rvm --create use  "ruby-1.8.7-p302@auditing"
+  rvm --create use  "ruby-1.9.2-p136@auditing"
 fi

data/Gemfile

@@ -1,7 +1,4 @@
 source "http://rubygems.org"
 
-group :development, :test do
-  gem 'activerecord'
-  gem 'sqlite3-ruby'
-  gem 'rspec'
-end
+# Specify your gem's dependencies in auditing.gemspec
+gemspec

data/Gemfile.lock

@@ -1,20 +1,12 @@
+PATH
+  remote: .
+  specs:
+    auditing (1.2.2)
+
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.0.3)
-      activesupport (= 3.0.3)
-      builder (~> 2.1.2)
-      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.3)
-    arel (2.0.7)
-    builder (2.1.2)
     diff-lcs (1.1.2)
-    i18n (0.5.0)
     rspec (2.4.0)
       rspec-core (~> 2.4.0)
       rspec-expectations (~> 2.4.0)
@@ -23,15 +15,10 @@ 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.24)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord
+  auditing!
   rspec
-  sqlite3-ruby

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Brad Cantin
+Copyright (c) 2011 Brad Cantin
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -96,6 +96,19 @@ 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
+
+  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 
 and current_user= (some authentication systems do this, others do not).
 
@@ -119,7 +132,7 @@ get the current user properly
   class ApplicationController < ActionController::Base
   
     before_filter :set_current_user
-    after_filter  :unser_current_user
+    after_filter  :unset_current_user
     
     private
     

data/Rakefile

@@ -1,45 +1,2 @@
-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 Cantin"]
-    gem.add_development_dependency "rspec", ">= 2.0"
-    # 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
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/auditing.gemspec

@@ -1,77 +1,23 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "auditing/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{auditing}
-  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{2011-02-01}
+  s.name        = %q{auditing}
+  s.version     = Auditing::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Brad Cantin"]
+  s.email       = ['brad.cantin@gmail.com']
+  s.homepage    = 'https://github.com/bcantin/auditing'
   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",
-    ".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.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/auditing/with_users_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
+  s.summary     = %q{A gem to keep track of audit hisory of a record}
+  
+  s.add_development_dependency "rspec"
+  
+  s.rubyforge_project = "auditing"
 
-    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
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
 end
-

data/lib/auditing/version.rb

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

data/lib/auditing.rb

@@ -1,3 +1,6 @@
+module Auditing
+end
+
 require 'auditing/base'
 require 'auditing/auditor'
 require 'auditing/audit_relationship'

data/lib/generators/auditing/USAGE

@@ -0,0 +1,16 @@
+Description:
+    Create an audit model, migration, controller, helper, and an index view
+
+Example:
+    rails generate auditing:install
+
+    This will create:
+        app/controllers/audits_controller.rb
+        app/helpers/audits_helper.rb
+        app/models/audit.rb
+        app/views/audits/index.html.erb 
+        db/migrate/#{time_stamp}_create_audits.rb
+        
+    This will modify config/routes.rb with
+        match ':resource/:id/audits' => 'audits#index', :as => 'audits'
+        match 'audit/rollback/:id'   => 'audits#rollback', :as => 'audit_rollback'

data/lib/generators/auditing/install_generator.rb

@@ -0,0 +1,48 @@
+require 'rails/generators/migration'
+
+module Auditing
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+    
+      include Rails::Generators::Migration
+    
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_controller_files
+        template 'audits_controller.rb', 'app/controllers/audits_controller.rb'
+      end
+
+      def create_helper_files
+        template 'audits_helper.rb', 'app/helpers/audits_helper.rb'
+      end
+
+      def create_model_files
+        template 'audit.rb', 'app/models/audit.rb'
+      end
+
+      def create_view_files
+        template 'index.html.erb', 'app/views/audits/index.html.erb'
+      end
+
+      def create_routes
+        route "match ':resource/:id/audits' => 'audits#index', :as => 'audits'"
+        route "match 'audit/rollback/:id'   => 'audits#rollback', :as => 'audit_rollback'"
+      end
+
+      def create_migration
+        migration_template 'migration.rb', "db/migrate/create_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/lib/generators/auditing/templates/audit.rb

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

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

@@ -0,0 +1,17 @@
+class AuditsController < ApplicationController
+
+  def index
+    resource  = params[:resource].classify.constantize
+    @resource = resource.find(params[:id])
+    @audits   = @resource.audits
+  end
+  
+  def rollback
+    audit = Audit.find(params[:id])
+    audit.rollback
+    
+    resource = audit.auditable
+    redirect_to audits_path(resource.class.table_name, resource)
+  end
+
+end

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

@@ -0,0 +1,75 @@
+module AuditsHelper
+
+  def description(audit)
+    str = case audit.action
+    when 'created'
+      "Created Record #{audit.auditable_type}"
+    when 'updated'
+      if audit.association.blank?
+        if audit.field_name.match(/_id$/)
+          "Old: #{get_belongs_to(audit, audit.old_value)} <br/>" +
+          "New: #{get_belongs_to(audit, audit.new_value)}"
+        else
+          "Old: #{audit.old_value} <br/>" +
+          "New: #{audit.new_value}"
+        end
+      else
+        if audit.old_value
+          "Old: #{get_has_many(audit, audit.old_value)}<br/>"+
+          "New: #{get_has_many(audit, audit.new_value)}"
+        else
+          "New: #{get_has_many(audit, audit.new_value)}"
+        end
+      end
+    when 'added'
+      if audit.old_value
+        "Old: #{get_has_many(audit, audit.old_value)}<br/>"+
+        "New: #{get_has_many(audit, audit.new_value)}"
+      else
+        "New: #{get_has_many(audit, audit.new_value)}"
+      end
+    when 'removed'
+      "Removed #{audit.association_type}"
+    end
+    
+    str.html_safe
+  end
+
+  def get_has_many(audit, value)
+    return nil unless value
+    if audit.field_name.match(/_id$/)
+      get_belongs_to(audit, value)
+    else
+      value
+    end
+  end
+
+  ##
+  # For a belongs_to association, we only store the ID of what is being
+  # refered to (:industry_id => 5).  We cannot guess what would be relevant
+  # to actually show for the value.  We recommend implementing a #to_label
+  # method and/or overriding this method to display what is relevant to
+  # your application.
+  #
+  # EG:
+  #   class Industry < ActiveRecord::Base
+  #     has_many :companies
+  #
+  #     def to_label
+  #       name
+  #     end
+  #   end
+
+  def get_belongs_to(audit, value)
+    return nil unless value
+    if audit.association
+      klass = audit.association.class.reflect_on_association(audit.field_name.gsub(/_id$/,'').to_sym).class_name.constantize
+    else
+      klass = audit.auditable.class.reflect_on_association(audit.field_name.gsub(/_id$/,'').to_sym).class_name.constantize
+    end
+    value = klass.where(:id => value).first
+    return 'Unknown' unless value
+    return value.to_label
+  end
+
+end

data/lib/generators/auditing/templates/index.html.erb

@@ -0,0 +1,32 @@
+<h2>Audit Log</h2>
+
+<%%= link_to "back to #{@resource.class}", @resource %>
+
+<table>
+  <thead>
+    <tr>
+      <th>Field Name</th>
+      <th>Values</th>
+      <th>Created</th>
+      <th>Rollback</th>
+    </tr>
+  </thead>
+  <tbody>
+    <%% @audits.each do |audit| %>
+      <tr>
+        <td>
+          <%%= audit.field_name.humanize if audit.field_name %>
+        </td>
+        <td>
+          <%%= description(audit) %>
+        </td>
+        <td> 
+          <%%= time_ago_in_words(audit.created_at) %> ago
+        </td>
+        <td> 
+          <%%= link_to 'rollback', audit_rollback_path(audit) if audit.reversable? %>
+        </td>
+      </tr>
+    <%% end %>
+  </tbody>
+</table>

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

@@ -0,0 +1,4 @@
+Rails.application.configure do
+  # Uncomment this to turn on verbose mode
+  config.my_gem.verbose = true
+end

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

@@ -0,0 +1,24 @@
+class CreateAudits < ActiveRecord::Migration
+  def self.up
+    create_table :audits 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
+    
+    add_index :audits, [:auditable_type, :auditable_id]
+    add_index :audits, [:association_type, :association_id]
+  end
+
+  def self.down
+    drop_table :audits
+  end
+end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: auditing
 version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: false
-  segments: 
-  - 1
-  - 2
-  - 0
-  version: 1.2.0
+  prerelease: 
+  version: 1.2.2
 platform: ruby
 authors: 
 - Brad Cantin
@@ -15,78 +10,33 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-01 00:00:00 -05:00
+date: 2011-02-05 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 
+  prerelease: false
+  requirement: &id001 !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
-  name: rspec
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 0
-        version: "2.0"
-  requirement: *id004
+  version_requirements: *id001
 description: acts_as_versioned is good. This allows an attribute level rollback instead
-email: brad.cantin@gmail.com
+email: 
+- brad.cantin@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
 - .bundle/config
 - .document
+- .gitignore
 - .rspec
 - .rvmrc
 - Gemfile
@@ -94,12 +44,20 @@ files:
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION
 - auditing.gemspec
 - lib/auditing.rb
 - lib/auditing/audit_relationship.rb
 - lib/auditing/auditor.rb
 - lib/auditing/base.rb
+- lib/auditing/version.rb
+- lib/generators/auditing/USAGE
+- lib/generators/auditing/install_generator.rb
+- lib/generators/auditing/templates/audit.rb
+- lib/generators/auditing/templates/audits_controller.rb
+- lib/generators/auditing/templates/audits_helper.rb
+- lib/generators/auditing/templates/index.html.erb
+- lib/generators/auditing/templates/initializer.rb
+- lib/generators/auditing/templates/migration.rb
 - spec/auditing/audit_relationship_spec.rb
 - spec/auditing/auditor_spec.rb
 - spec/auditing/base_spec.rb
@@ -107,7 +65,7 @@ files:
 - spec/schema.rb
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://github.com/bcantin/auditing
+homepage: https://github.com/bcantin/auditing
 licenses: []
 
 post_install_message: 
@@ -120,23 +78,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.3.7
+rubyforge_project: auditing
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: A gem to keep track of audit hisory of a record

data/VERSION

@@ -1 +0,0 @@
-1.2.0