auditor 1.0.0 → 2.0.0

data/spec/spec_helper.rb

@@ -1,37 +1,13 @@
 require 'rspec'
+require 'auditor'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
-  # If you're not using ActiveRecord you should remove these
-  # lines, delete config/database.yml and disable :active_record
-  # in your config/boot.rb
-  # config.use_transactional_fixtures = true
-  # config.use_instantiated_fixtures  = false
+  config.include TransactionalSpecs
 
-  # == Fixtures
-  #
-  # You can declare fixtures for each example_group like this:
-  #   describe "...." do
-  #     fixtures :table_a, :table_b
-  #
-  # Alternatively, if you prefer to declare them only once, you can
-  # do so right here. Just uncomment the next line and replace the fixture
-  # names with your fixtures.
-  #
-  # config.global_fixtures = :all
-  #
-  # If you declare global fixtures, be aware that they will be declared
-  # for all of your examples, even those that don't use them.
-  #
-  # You can also declare which fixtures to use (for example fixtures for test/fixtures):
-  #
-  # config.fixture_path = RAILS_ROOT + '/spec/fixtures/'
-  #
-  # == Mock Framework
-  #
   # RSpec uses it's own mocking framework by default. If you prefer to
   # use mocha, flexmock or RR, uncomment the appropriate line:
   #

data/spec/status_spec.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'auditor/status'
+
+describe Auditor::Status do
+  it "should be enabled if set to enabled" do
+    obj = Class.new { include Auditor::Status }.new
+    obj.enable_auditing
+    obj.should be_auditing_enabled
+    obj.should_not be_auditing_disabled
+  end
+
+  it "should be disabled if set to disabled" do
+    obj = Class.new { include Auditor::Status }.new
+    obj.disable_auditing
+    obj.should_not be_auditing_enabled
+    obj.should be_auditing_disabled
+  end
+end

data/spec/support/db_setup.rb

@@ -0,0 +1,50 @@
+require 'active_support/core_ext'
+require 'active_record'
+require 'generators/auditor/migration/templates/migration'
+
+tmpdir = File.join(File.dirname(__FILE__), '..', '..', 'tmp')
+FileUtils.mkdir(tmpdir) unless File.exist?(tmpdir)
+test_db = File.join(tmpdir, 'test.db')
+
+connection_spec = {
+  :adapter => 'sqlite3',
+  :database => test_db
+}
+
+# Delete any existing instance of the test database
+FileUtils.rm test_db, :force => true
+
+# Create a new test database
+ActiveRecord::Base.establish_connection(connection_spec)
+
+# ActiveRecord::Base.connection.initialize_schema_migrations_table
+
+class CreateUser < ActiveRecord::Migration
+  def self.up
+    create_table :users, :force => true do |t|
+      t.column :username, :string
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end
+
+class CreateModel < ActiveRecord::Migration
+  def self.up
+    create_table :models, :force => true do |t|
+      t.column :name, :string
+      t.column :value, :string
+    end
+  end
+
+  def self.down
+    drop_table :models
+  end
+end
+
+CreateUser.up
+CreateModel.up
+CreateAuditsTable.up
+

data/spec/support/transactional_specs.rb

@@ -0,0 +1,17 @@
+module TransactionalSpecs
+
+  def self.included(base)
+    base.class_eval do
+      around(:each) do |spec|
+        ActiveRecord::Base.transaction do
+          begin
+            spec.call
+          ensure
+            raise ActiveRecord::Rollback
+          end
+        end
+      end
+    end
+  end
+
+end

data/spec/user_spec.rb

@@ -7,19 +7,19 @@ describe Auditor::User do
     Auditor::User.current_user = user
     Auditor::User.current_user.should == user
   end
-  
+
   it "should not return the same user from a different thread" do
     user = "user"
     user2 = "user2"
-    
+
     Auditor::User.current_user = user
-    
+
     Thread.new do
       Auditor::User.current_user.should be_nil
       Auditor::User.current_user = user2
       Auditor::User.current_user.should == user2
     end
-    
+
     Auditor::User.current_user.should == user
   end
-end
+end

metadata

@@ -1,22 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: auditor
 version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: false
+  hash: 15
+  prerelease: 
   segments: 
-  - 1
+  - 2
   - 0
   - 0
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Jeff Kunkle
-- Matt Wizeman
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-01-06 00:00:00 -05:00
+date: 2011-03-16 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,14 +24,48 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 27
         segments: 
+        - 2
+        - 5
         - 0
-        version: "0"
+        version: 2.5.0
   type: :development
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 3
+        - 3
+        version: 1.3.3
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :development
+  version_requirements: *id003
 description: Auditor allows you to declaratively specify what CRUD operations should be audited and save the audit data to the database.
 email: 
 executables: []
@@ -42,29 +75,33 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- auditor.gemspec
+- init.rb
+- lib/auditor.rb
 - lib/auditor/audit.rb
-- lib/auditor/config_parser.rb
-- lib/auditor/integration.rb
-- lib/auditor/model_audit.rb
+- lib/auditor/auditable.rb
+- lib/auditor/config.rb
 - lib/auditor/recorder.rb
 - lib/auditor/spec_helpers.rb
-- lib/auditor/thread_local.rb
-- lib/auditor/thread_status.rb
+- lib/auditor/status.rb
 - lib/auditor/user.rb
 - lib/auditor/version.rb
-- lib/auditor.rb
+- lib/generators/auditor.rb
 - lib/generators/auditor/migration/migration_generator.rb
 - lib/generators/auditor/migration/templates/migration.rb
-- lib/generators/auditor.rb
-- LICENSE
-- README.rdoc
-- spec/config_parser_spec.rb
-- spec/model_audit_spec.rb
+- spec/audit_spec.rb
+- spec/auditable_spec.rb
+- spec/config_spec.rb
 - spec/recorder_spec.rb
 - spec/spec_helper.rb
-- spec/support/auditor_helpers.rb
-- spec/thread_local_spec.rb
-- spec/thread_status_spec.rb
+- spec/status_spec.rb
+- spec/support/db_setup.rb
+- spec/support/transactional_specs.rb
 - spec/user_spec.rb
 has_rdoc: true
 homepage: http://github.com/nearinfinity/auditor
@@ -89,25 +126,24 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 23
+      hash: 3
       segments: 
-      - 1
-      - 3
-      - 6
-      version: 1.3.6
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: Rails 3 plugin for auditing access to your ActiveRecord model objects
 test_files: 
-- spec/config_parser_spec.rb
-- spec/model_audit_spec.rb
+- spec/audit_spec.rb
+- spec/auditable_spec.rb
+- spec/config_spec.rb
 - spec/recorder_spec.rb
 - spec/spec_helper.rb
-- spec/support/auditor_helpers.rb
-- spec/thread_local_spec.rb
-- spec/thread_status_spec.rb
+- spec/status_spec.rb
+- spec/support/db_setup.rb
+- spec/support/transactional_specs.rb
 - spec/user_spec.rb

data/lib/auditor/config_parser.rb

@@ -1,36 +0,0 @@
-module Auditor
-  class ConfigParser
-    
-    def self.extract_config(args)
-      options = (args.delete_at(args.size - 1) if args.last.kind_of?(Hash)) || {}
-      normalize_config args, options
-      validate_config args, options
-      options = normalize_options(options)
-      
-      [args, options]
-    end
-    
-    private
-    
-      def self.normalize_config(actions, options)
-        actions.each_with_index { |item, index| actions[index] = item.to_sym }
-        options.each_pair { |k, v| options[k.to_sym] = options.delete(k) unless k.kind_of? Symbol }
-      end
-      
-      def self.normalize_options(options)
-        return { :except => [], :only => [] } if options.nil? || options.empty?
-        options[:except] = options[:except] || []
-        options[:only] = options[:only] || []
-        options[:except] = Array(options[:except]).map(&:to_s)
-        options[:only] = Array(options[:only]).map(&:to_s)
-        options
-      end
-    
-      def self.validate_config(actions, options)
-        raise Auditor::Error.new "at least one :create, :find, :update, or :destroy action must be specified" if actions.empty?
-        raise Auditor::Error.new ":create, :find, :update, and :destroy are the only valid actions" unless actions.all? { |a| [:create, :find, :update, :destroy].include? a }
-        raise Auditor::Error.new "only one of :except and :only can be specified" if options.size > 1
-      end
-     
-  end
-end

data/lib/auditor/integration.rb

@@ -1,49 +0,0 @@
-require 'auditor/thread_status'
-
-module Auditor
-  module Integration
-    
-    def without_auditor
-      previously_disabled = auditor_disabled?
-      disable_auditor
-      
-      begin
-        result = yield if block_given?
-      ensure
-        enable_auditor unless previously_disabled
-      end
-      
-      result
-    end
-    
-    def with_auditor
-      previously_disabled = auditor_disabled?
-      enable_auditor
-      
-      begin
-        result = yield if block_given?
-      ensure
-        disable_auditor if previously_disabled
-      end
-      
-      result
-    end
-    
-    def disable_auditor
-      Auditor::ThreadStatus.disable
-    end
-    
-    def enable_auditor
-      Auditor::ThreadStatus.enable
-    end
-    
-    def auditor_disabled?
-      Auditor::ThreadStatus.disabled?
-    end
-    
-    def auditor_enabled?
-      Auditor::ThreadStatus.enabled?
-    end
-    
-  end
-end

data/lib/auditor/model_audit.rb

@@ -1,47 +0,0 @@
-require 'auditor/thread_status'
-require 'auditor/config_parser'
-require 'auditor/recorder'
-
-module Auditor
-  module ModelAudit
-    
-    def self.included(base)
-      base.extend ClassMethods
-    end
-  
-    # ActiveRecord won't call the after_find handler unless it see's a specific after_find method defined
-    def after_find; end
-  
-    def auditor_disabled?
-      Auditor::ThreadStatus.disabled? || @auditor_disabled
-    end
-    
-    module ClassMethods
-      def audit(*args, &blk)
-        actions, options = Auditor::ConfigParser.extract_config(args)
-      
-        actions.each do |action|
-          unless action.to_sym == :find
-            callback = "auditor_before_#{action}"
-            define_method(callback) do
-              @auditor_auditor = Auditor::Recorder.new(action, self, options, &blk)
-              @auditor_auditor.audit_before unless auditor_disabled?
-              true
-            end 
-            send "before_#{action}".to_sym, callback
-          end
-          
-          callback = "auditor_after_#{action}"
-          define_method(callback) do
-            @auditor_auditor = Auditor::Recorder.new(action, self, options, &blk) if action.to_sym == :find
-            @auditor_auditor.audit_after unless auditor_disabled?
-            true
-          end
-          send "after_#{action}".to_sym, callback
-          
-        end
-      end
-    end
-    
-  end
-end