ar-audit-tracer 1.0.1 → 1.0.2

data/Gemfile

@@ -1,10 +1,10 @@
 source "http://rubygems.org"
 
-#gemspec
+gemspec
 
 #gem 'activerecord', '~> 3.0.3'
 #gem 'activerecord', '~> 3.1.0'
-gem 'activerecord', '~> 3.2.0'
+#gem 'activerecord', '~> 3.2.0'
 
 group :test do
 	gem 'rake'

data/Gemfile.lock

@@ -1,3 +1,9 @@
+PATH
+  remote: .
+  specs:
+    ar-audit-tracer (1.0.2)
+      activerecord (~> 3.0)
+
 GEM
   remote: http://rubygems.org/
   specs:
@@ -24,6 +30,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (~> 3.2.0)
+  activerecord (~> 3.0)
+  ar-audit-tracer!
   rake
   sqlite3

data/README.rdoc

@@ -7,7 +7,13 @@
 <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).
 
-The new version 1.0.0 works now for Rails 3.0, 3.1 and 3.2 and is tested with Ruby 1.8.7, 1.9.2 and 1.9.3.
+The new version 1.0.2 works now for Rails 3.0, 3.1 and 3.2 and is tested with Ruby 1.8.7, 1.9.2 and 1.9.3.
+
+
+== Installation
+
+Add below to your Gemfile and run the +bundle+ command
+  gem 'ar-audit-tracer'
 
 
 == Usage
@@ -16,13 +22,27 @@ The new version 1.0.0 works now for Rails 3.0, 3.1 and 3.2 and is tested with Ru
 
 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
+By default the columns are mandatory (:null => true). If you have existing models you want to change
+you have to pass the option <tt>:null => true</tt>, update the values in the new attributes columns and add another
+migration to change the column to <tt>:null => false</tt> if required.
+Note: If you pass options you have to pass the type as well - sample migration statments:
+    add_authors(:your_table_name, :string, :null => true)
+or
+    change_table :your_table_name do |t|
+      t.authors(:integer, :null => true)
+    end
+
+==== Note
+The _authors_ methods are simple conveniance methods (as regular timestamp methods are). You can simply
+add columns named +created_by+ and +updated_by+ using regular migration statements.
+
+=== Configuration
 
 All you need to do is to set the current author such as e.g:
   Concern::Audit::Author.current="bad_man"
@@ -30,8 +50,13 @@ All you need to do is to set the current author such as e.g:
 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.
+<tt>Concern::Audit::Author</tt> 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.
 
+
+== Changelog
+
+=== Version 1.0.2
+* Fixed migrations so option can be passed

data/Rakefile

@@ -26,7 +26,7 @@ rescue LoadError
 end
 
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 require "ar-audit-tracer/version"
 Rake::RDocTask.new do |rdoc|
   version = ArAuditTracer::VERSION

data/lib/ar-audit-tracer.rb

@@ -98,9 +98,10 @@ module ActiveRecord
       # 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, :null => false
-        add_column table_name, :updated_by, type, :null => false
+      def add_authors(table_name, type=:string, *args)
+        options = {:null => false}.merge(args.extract_options!)
+        add_column table_name, :created_by, type, options
+        add_column table_name, :updated_by, type, options
       end
 
       # Removes the author columns (created_by and updated_by) from the table definition.
@@ -134,8 +135,9 @@ module ActiveRecord
       #
       # @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)
+      def authors(type=:string, *args)
+        options = {:null => false}.merge(args.extract_options!)
+        @base.add_authors(@table_name, type, options)
       end
 
       # Removes the author columns (created_by and updated_by) from the table.

data/lib/ar-audit-tracer/version.rb

@@ -1,3 +1,3 @@
 module ArAuditTracer
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/test/concern/audit/author_test.rb

@@ -7,7 +7,7 @@ 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
 
@@ -16,7 +16,7 @@ class Concern::Audit::AuthorTest < Test::Unit::TestCase
 
     assert_equal("the_author", Concern::Audit::Author.current)
   end
-  
+
   def test_author_setting_in_different_threads
     Concern::Audit::Author.current="outer_thread"
 

data/test/resources/migrations/add_authors.rb

@@ -0,0 +1,7 @@
+class AddAuthors < ActiveRecord::Migration
+
+  def up
+    add_authors(:blank_twos, :string, :null => true)
+  end
+
+end

data/test/resources/migrations/change_table_authors.rb

@@ -0,0 +1,11 @@
+class ChangeTableAuthors < ActiveRecord::Migration
+
+  def up
+
+    change_table :blank_ones do |t|
+      t.authors(:integer, :null => true)
+    end
+
+  end
+
+end

data/test/resources/models.rb

@@ -7,3 +7,9 @@ end
 class WithIntegerAuthor <  ActiveRecord::Base
 end
 
+class BlankOne <  ActiveRecord::Base
+end
+
+class BlankTwo <  ActiveRecord::Base
+end
+

data/test/resources/schema.rb

@@ -13,4 +13,12 @@ ActiveRecord::Schema.define(:version => 0) do
     t.authors(:integer)
   end
   
+  create_table :blank_ones, :force => true do |t|
+    t.string :name
+  end
+
+  create_table :blank_twos, :force => true do |t|
+    t.string :name
+  end
+
 end

data/test/test_ar-audit-tracer.rb

@@ -1,5 +1,8 @@
 require 'helper'
 
+require 'resources/migrations/add_authors'
+require 'resources/migrations/change_table_authors'
+
 class TestArAuditTracer < Test::Unit::TestCase
 
   def setup
@@ -90,4 +93,27 @@ class TestArAuditTracer < Test::Unit::TestCase
     assert_equal audited_record.updated_by, 1
   end
 
+  def test_migration_add_authors
+    assert !BlankTwo.attribute_names.include?(:created_by)
+    assert !BlankTwo.attribute_names.include?(:updated_by)
+
+    AddAuthors.new().up
+    BlankTwo.reset_column_information
+
+    assert_equal :string, BlankTwo.columns_hash['created_by'].type
+    assert_equal :string, BlankTwo.columns_hash['updated_by'].type
+  end
+
+  def test_migration_change_table_authors
+    assert !BlankOne.attribute_names.include?(:created_by)
+    assert !BlankOne.attribute_names.include?(:updated_by)
+
+    ChangeTableAuthors.new().up
+    BlankOne.reset_column_information
+
+    assert_equal :integer, BlankOne.columns_hash['created_by'].type
+    assert_equal :integer, BlankOne.columns_hash['updated_by'].type
+  end
+
+
 end

metadata

@@ -1,59 +1,70 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ar-audit-tracer
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.0.2
   prerelease: 
-  version: 1.0.1
 platform: ruby
-authors: 
+authors:
 - Martin Schweizer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-02-17 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "3.0"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activerecord
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "3.0"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Handles ActiveRecord authors in the same way as timstamps.
 email: martin@verticonaut.me
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .document
 - .gitignore
 - .rvmrc
@@ -72,41 +83,43 @@ files:
 - lib/concern/audit/author.rb
 - test/concern/audit/author_test.rb
 - test/helper.rb
+- test/resources/migrations/add_authors.rb
+- test/resources/migrations/change_table_authors.rb
 - test/resources/models.rb
 - test/resources/schema.rb
 - test/test_ar-audit-tracer.rb
 homepage: http://github.com/verticonaut/ar-audit-tracer
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset
 - UTF-8
 - --line-numbers
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Track creator/modifiers of you AR Models similar to timestamps.
-test_files: 
+test_files:
 - test/concern/audit/author_test.rb
 - test/helper.rb
+- test/resources/migrations/add_authors.rb
+- test/resources/migrations/change_table_authors.rb
 - test/resources/models.rb
 - test/resources/schema.rb
 - test/test_ar-audit-tracer.rb