ar-audit-tracer 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm_gemset_create_on_use_flag=1
+rvm gemset use 1.9.2@ar-audit-tracer

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Martin Schweizer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,34 @@
+= ar-audit-tracer
+
+
+== Summary
+
+<i>ar-audit-tracer</i> patches ActiveRecord so modifiers of a record can be traked on saving (insert/update).
+It works exactly like 'timestamps' (see usage below).
+
+
+== Usage
+
+=== Migration
+
+In a models migration add:
+  t.authors
+  
+This will add columns +created_by+ and +updated_by+ of type +:string+ to your model.
+
+In case you want to use another type, simply pass the type as argument, e.g.
+  t.authors(:integer)
+
+=== Usage
+
+All you need to do is to set the current author such as e.g:
+  Concern::Audit::Author.current="bad_man"
+
+Each ActiveRecord +save+ or +update+ then will set the respetive attributes +created_by+ and +modified_by+ automatically, whereas the modifier is set to the same value as the creator on model creation.
+
+In a Rails Application you would set the author as described above in a +before_filter+.
++Concern::Audit::Author+ stores the author in a Thread-Local variable.
+
+== Additional Notes
+In case you need associations to a respective Author Model you have to set them up yourselfs.
+

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ar-audit-tracer"
+    gem.summary = %Q{Track creator/modifiers of you AR Models similar to timestamps.}
+    gem.description = %Q{Handles ActiveRecord authors in the same way as timstamps.}
+    gem.email = "contact@verticonaut.me"
+    gem.homepage = "http://github.com/verticonaut/ar-audit-tracer"
+    gem.authors = ["Martin Schweizer"]
+    # 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 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ar-audit-tracer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/ar-audit-tracer.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ar-audit-tracer}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Martin Schweizer"]
+  s.date = %q{2010-11-27}
+  s.description = %q{Handles ActiveRecord authors in the same way as timstamps.}
+  s.email = %q{contact@verticonaut.me}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rvmrc",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "ar-audit-tracer.gemspec",
+    "lib/ar-audit-tracer.rb",
+    "lib/concern/audit/author.rb",
+    "test/concern/audit/author_test.rb",
+    "test/helper.rb",
+    "test/resources/models.rb",
+    "test/resources/schema.rb",
+    "test/test_ar-audit-tracer.rb"
+  ]
+  s.homepage = %q{http://github.com/verticonaut/ar-audit-tracer}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Track creator/modifiers of you AR Models similar to timestamps.}
+  s.test_files = [
+    "test/concern/audit/author_test.rb",
+    "test/helper.rb",
+    "test/resources/models.rb",
+    "test/resources/schema.rb",
+    "test/test_ar-audit-tracer.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/ar-audit-tracer.rb

@@ -0,0 +1,133 @@
+require 'concern/audit/author'
+
+# ActiveRecordAuthors
+module ActiveRecord
+  module ConnectionAdapters
+
+    class TableDefinition
+
+      # Creates author columns ...
+      #
+      # @param Symbol type  The desired type for the columns, defaults to :string
+      # @param Hash   *args Column options from rails
+      def authors(type=:string, *args)
+        options = args.extract_options!
+        column(:created_by, type, options)
+        column(:updated_by, type, options)
+      end
+
+
+    end
+
+    class Table
+      # Adds author (created_by and updated_by) columns to the table
+      # ===== Example
+      #  t.authors
+      #
+      # @param Symbol type  The desired type for the columns, defaults to :string
+      # @see SchemaStatements#add_authors
+      def authors(type=:string)
+        @base.add_authors(@table_name, type)
+      end
+
+      # Removes the author columns (created_by and updated_by) from the table.
+      # ===== Example
+      #  t.remove_authors
+      def remove_authors
+        @base.remove_authors(@table_name)
+      end
+
+    end
+
+    module SchemaStatements
+      # Adds author columns (created_by and updated_by) to the named table.
+      # ===== Examples
+      #  add_authors(:suppliers)
+      def add_authors(table_name, type=:string)
+        add_column table_name, :created_by, type
+        add_column table_name, :updated_by, type
+      end
+
+      # Removes the author columns (created_by and updated_by) from the table definition.
+      # ===== Examples
+      #  remove_authors(:suppliers)
+      def remove_authors(table_name)
+        remove_column table_name, :updated_by
+        remove_column table_name, :created_by
+      end
+    end
+
+  end
+
+  # = Active Record Author
+  #
+  # Active Record automatically authors create and update operations if the
+  # table has fields named <tt>created_by</tt> or
+  # <tt>updated_by</tt>.
+  #
+  # Authoring can be turned off by setting:
+  #
+  #   <tt>ActiveRecord::Base.record_authors = false</tt>
+  module Author
+    extend ActiveSupport::Concern
+
+    included do
+      class_inheritable_accessor :record_authors, :instance_writer => false
+      self.record_authors = true
+    end
+
+  private
+
+    def create #:nodoc:
+      if record_authors
+        current_author = Concern::Audit::Author.current
+
+        all_author_attributes.each do |column|
+          write_attribute(column.to_s, current_author) if respond_to?(column) && self.send(column).nil?
+        end
+      end
+
+      super
+    end
+
+    def update(*args) #:nodoc:
+      if should_record_authors?
+        current_author = Concern::Audit::Author.current
+
+        author_attributes_for_update_in_model.each do |column|
+          column = column.to_s
+          next if attribute_changed?(column)
+          write_attribute(column, current_author)
+        end
+      end
+      super
+    end
+
+    def should_record_authors?
+      record_authors && (!partial_updates? || changed?)
+    end
+
+    def author_attributes_for_update_in_model
+      author_attributes_for_update.select { |c| respond_to?(c) }
+    end
+
+    def author_attributes_for_update #:nodoc:
+      [:updated_by]
+    end
+
+    def author_attributes_for_create #:nodoc:
+      [:created_by]
+    end
+
+    def all_author_attributes #:nodoc:
+      author_attributes_for_create + author_attributes_for_update
+    end
+
+  end
+
+  Base.class_eval do
+    include Author
+  end
+
+end
+

data/lib/concern/audit/author.rb

@@ -0,0 +1,15 @@
+module Concern
+  module Audit
+    module Author
+
+      def self.current=(author)
+        Thread.current[:current_author] = author
+      end
+
+      def self.current
+        Thread.current[:current_author]
+      end
+
+    end
+  end
+end

data/test/concern/audit/author_test.rb

@@ -0,0 +1,38 @@
+require 'test/unit'
+require File.expand_path('../../../test_helper.rb', __FILE__)
+
+# Test Thread.current stuff.
+class Concern::Audit::AuthorTest < Test::Unit::TestCase
+
+  def setup
+    Concern::Audit::Author.current = nil
+  end
+  
+  def test_author_setting_in_single_thread
+    Concern::Audit::Author.current
+
+    assert_nil Concern::Audit::Author.current
+    Concern::Audit::Author.current="the_author"
+
+    assert_equal("the_author", Concern::Audit::Author.current)
+  end
+  
+  def test_author_setting_in_different_threads
+    Concern::Audit::Author.current="outer_thread"
+
+    assert_equal("outer_thread", Concern::Audit::Author.current)
+
+    t = Thread.fork do
+      assert_nil Concern::Audit::Author.current
+
+      Concern::Audit::Author.current="in_thread"
+
+      assert_equal("in_thread", Concern::Audit::Author.current)
+    end
+
+    # check if outer thread has still original value
+    t.join
+    assert_equal("outer_thread", Concern::Audit::Author.current)
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'test/unit'
+require 'fileutils'
+require "active_record"
+require 'logger'
+
+# ------------------------------------------------------
+# Setup AR environment
+# ------------------------------------------------------
+
+# Define connection info
+ActiveRecord::Base.configurations = {
+  "test" => {
+    :adapter  => 'sqlite3',
+    :database => ':memory:'
+  }
+}
+ActiveRecord::Base.establish_connection("test")
+
+# Setup logger
+tmp = File.expand_path('../../tmp', __FILE__)
+FileUtils.mkdir_p(tmp)
+ActiveRecord::Base.logger = Logger.new("#{tmp}/debug.log")
+
+
+# ------------------------------------------------------
+# Inject audit-trascer
+#   and setup test schema
+#   and define models used in tests
+# ------------------------------------------------------
+require "ar-audit-tracer"
+
+require "resources/schema.rb"
+require "resources/models.rb"

data/test/resources/models.rb

@@ -0,0 +1,9 @@
+# ------------------------------------------------------
+# Defined the respective AR Models
+# ------------------------------------------------------
+class WithStringAuthor <  ActiveRecord::Base
+end
+
+class WithIntegerAuthor <  ActiveRecord::Base
+end
+

data/test/resources/schema.rb

@@ -0,0 +1,16 @@
+# ------------------------------------------------------
+# Defined the migrations
+# ------------------------------------------------------
+ActiveRecord::Schema.define(:version => 0) do
+
+  create_table :with_string_authors, :force => true do |t|
+    t.string :name
+    t.authors
+  end
+
+  create_table :with_integer_authors, :force => true do |t|
+    t.string :name
+    t.authors(:integer)
+  end
+  
+end

data/test/test_ar-audit-tracer.rb

@@ -0,0 +1,93 @@
+require 'helper'
+
+class TestArAuditTracer < Test::Unit::TestCase
+
+  def setup
+    Concern::Audit::Author.current=nil  
+  end
+
+  def test_author_attributes_available
+    # test :string coded authors
+    assert WithStringAuthor.columns_hash.key? 'created_by'
+    assert WithStringAuthor.columns_hash.key? 'updated_by'
+
+    # test :string coded authors
+    assert WithIntegerAuthor.columns_hash.key? 'created_by'
+    assert WithIntegerAuthor.columns_hash.key? 'updated_by'
+  end
+
+  def test_author_attributes_have_correct_type
+    # test :string coded authors
+    assert_equal(WithStringAuthor.columns_hash['created_by'].type, :string)
+    assert_equal(WithStringAuthor.columns_hash['updated_by'].type, :string)
+
+    # test :string coded authors
+    assert_equal(WithIntegerAuthor.columns_hash['created_by'].type, :integer)
+    assert_equal(WithIntegerAuthor.columns_hash['updated_by'].type, :integer)
+  end
+
+  def test_author_setting_on_create
+    # test :string coded authors
+    Concern::Audit::Author.current="creator"
+    audited_record = WithStringAuthor.create!
+    
+    assert_equal audited_record.created_by, "creator"
+    assert_equal audited_record.updated_by, "creator"
+
+    # test :integer coded authors
+    Concern::Audit::Author.current= 1
+    audited_record = WithIntegerAuthor.create!
+
+    assert_equal audited_record.created_by, 1
+    assert_equal audited_record.updated_by, 1
+  end
+
+  def test_string_author_setting_on_update
+    Concern::Audit::Author.current="creator"
+    audited_record = WithStringAuthor.create!
+
+    assert_equal audited_record.created_by, "creator"
+    assert_equal audited_record.updated_by, "creator"
+
+    Concern::Audit::Author.current="updater"
+    audited_record.update_attribute(:name, "some_name")
+
+    assert_equal audited_record.created_by, "creator"
+    assert_equal audited_record.updated_by, "updater"
+  end
+
+  def test_integer_author_setting_on_update
+    Concern::Audit::Author.current= 1
+    audited_record = WithStringAuthor.create!
+
+    assert_equal audited_record.created_by, 1
+    assert_equal audited_record.updated_by, 1
+
+    Concern::Audit::Author.current= 2
+    audited_record.update_attribute(:name, "some_name")
+
+    assert_equal audited_record.created_by, 1
+    assert_equal audited_record.updated_by, 2
+  end
+
+  def test_string_author_with_ignored_save
+    Concern::Audit::Author.current= "creator"
+    audited_record = WithStringAuthor.create!
+    assert_equal audited_record.updated_by, "creator"
+
+    Concern::Audit::Author.current= "updater"
+    audited_record.save # save is not executed - there is nothing changed
+    assert_equal audited_record.updated_by, "creator"
+  end
+
+  def test_integer_author_with_ignored_save
+    Concern::Audit::Author.current= 1
+    audited_record = WithStringAuthor.create!
+    assert_equal audited_record.updated_by, 1
+
+    Concern::Audit::Author.current= 2
+    audited_record.save # save is not executed - there is nothing changed
+    assert_equal audited_record.updated_by, 1
+  end
+
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: ar-audit-tracer
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Martin Schweizer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-27 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Handles ActiveRecord authors in the same way as timstamps.
+email: contact@verticonaut.me
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .rvmrc
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- ar-audit-tracer.gemspec
+- lib/ar-audit-tracer.rb
+- lib/concern/audit/author.rb
+- test/concern/audit/author_test.rb
+- test/helper.rb
+- test/resources/models.rb
+- test/resources/schema.rb
+- test/test_ar-audit-tracer.rb
+has_rdoc: true
+homepage: http://github.com/verticonaut/ar-audit-tracer
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Track creator/modifiers of you AR Models similar to timestamps.
+test_files: 
+- test/concern/audit/author_test.rb
+- test/helper.rb
+- test/resources/models.rb
+- test/resources/schema.rb
+- test/test_ar-audit-tracer.rb