ar-audit-tracer 1.0.2 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0cc3002d73e4ecaeae431164cbac4078b67a10f
+  data.tar.gz: 8bce9b4669e9d8c2cbe44ed3b54b4aff002ee924
+SHA512:
+  metadata.gz: 0419dacc98f06fb067be5d487f03540f14b2dfaf6620eb83d76a559d479064add1c8ca24d2bb46e45ec1ae33c6a8766f6acbee5c715a14ebbc3511e1487824d8
+  data.tar.gz: 0fb20cc963c08ed92ee12d41f24d9326bd4f6deaf3b3d855c71f6d83208264cb05901ddab6f58086c5de846aea8ac0a6ed0ea5df89bfd1339be7ef7cc250f1f2

data/.rvmrc

@@ -1 +1 @@
-rvm use 1.9.3-p125
+rvm use 2.0.0-p247

data/.travis.yml

@@ -1,9 +1,6 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
+  - 2.0.0
 gemfile:
-  - gemfiles/rails3_0.gemfile
-  - gemfiles/rails3_1.gemfile
-  - gemfiles/rails3_2.gemfile
+  - gemfiles/rails4_0.gemfile

data/Gemfile.lock

@@ -1,36 +1,44 @@
 PATH
   remote: .
   specs:
-    ar-audit-tracer (1.0.2)
-      activerecord (~> 3.0)
+    ar-audit-tracer (2.0.0)
+      activerecord (~> 4.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.2.1)
-      activesupport (= 3.2.1)
-      builder (~> 3.0.0)
-    activerecord (3.2.1)
-      activemodel (= 3.2.1)
-      activesupport (= 3.2.1)
-      arel (~> 3.0.0)
-      tzinfo (~> 0.3.29)
-    activesupport (3.2.1)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    arel (3.0.0)
-    builder (3.0.0)
-    i18n (0.6.0)
-    multi_json (1.0.4)
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activerecord (4.0.0)
+      activemodel (= 4.0.0)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.0)
+    atomic (1.1.10)
+    builder (3.1.4)
+    i18n (0.6.4)
+    minitest (4.7.5)
+    multi_json (1.7.7)
     rake (0.9.2.2)
-    sqlite3 (1.3.5)
-    tzinfo (0.3.31)
+    sqlite3 (1.3.6)
+    thread_safe (0.1.0)
+      atomic
+    tzinfo (0.3.37)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (~> 3.0)
+  activerecord (~> 4.0)
   ar-audit-tracer!
   rake
   sqlite3

data/README.rdoc

@@ -7,7 +7,12 @@
 <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.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.
+The new version 2.0.0 works now for Rails 4.0 with Ruby 1.9.3 and 2.0.0. Use the version 1.0.2 for Rails  ~3.0 with Ruby 1.8.7 or higher.
+
+**Note**<br/>
+The migration helpers changed. The column statement is now named +t.authorstamps+ instead of +t.authors+.
+Similar the changing a table is named +add_authorstamp+. The columns generated are still named the same - so they are calles
++created_by+ and +updated_by+.
 
 
 == Installation
@@ -21,26 +26,27 @@ Add below to your Gemfile and run the +bundle+ command
 === Migration
 
 In a models migration add:
-  t.authors
+  t.authorstamps
 
 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)
+  t.authorstamps(:integer)
 
-By default the columns are mandatory (:null => true). If you have existing models you want to change
+By default the columns are mandatory (<tt>:null => false</tt>). 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)
+*Note:* If you pass options you have to pass the type as well - sample migration statments:
+    add_authorstamps(:your_table_name, :string, :null => true)
 or
     change_table :your_table_name do |t|
-      t.authors(:integer, :null => true)
+      t.authorstamps(: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.
+The _authorstamps_ 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.<br/>
+**Note** You can name the attributes +created_by_id+ and +updated_by_id+. If these columns are detected they are filled as well.
 
 === Configuration
 
@@ -58,5 +64,9 @@ In case you need associations to a respective Author Model you have to set them
 
 == Changelog
 
+=== Version 2.0.0
+* Works for Rails4 with Ruby1.9.3 and Ruby 2.0.0
+* Works now not only for +created_by+ and +updated_by+, but as well for attributes +created_by_id+ and +updated_by_id+
+
 === Version 1.0.2
 * Fixed migrations so option can be passed

data/ar-audit-tracer.gemspec

@@ -13,9 +13,9 @@ Gem::Specification.new do |s|
   s.summary     = %q{Track creator/modifiers of you AR Models similar to timestamps.}
   s.description = %q{Handles ActiveRecord authors in the same way as timstamps.}
 
-  s.add_dependency              "activerecord", "~> 3.0"
+  s.add_dependency              "activerecord", "~> 4.0"
 
-  s.add_development_dependency  "activerecord", "~> 3.0"
+  s.add_development_dependency  "activerecord", "~> 4.0"
   s.add_development_dependency  "sqlite3"
 
   s.rdoc_options  << '--charset' << 'UTF-8' << '--line-numbers'

data/gemfiles/rails4_0.gemfile

@@ -0,0 +1,9 @@
+source 'http://rubygems.org'
+
+gem 'activerecord', '~> 4.0.0'
+
+group :test do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'sqlite3'
+end

data/lib/active_record/author_stamp.rb

@@ -0,0 +1,93 @@
+
+module ActiveRecord
+  # = Active Record Authorstamp
+  #
+  # Active Record automatically stamps the user that performns create and update operations if the
+  # table has fields named <tt>created_by/created_by_id</tt> or
+  # <tt>updated_by/updated_by</tt>.
+  # The user identifier is taken from ActiveRecord::Audit::Author.current. The respective value must be set
+  # by the user of this feater by calling ActiveRecord::Audit::Author.current = 'some_value'
+  #
+  # Userstamping can be turned off by setting:
+  #
+  #   config.active_record.record_userstamps = false
+  #
+  module AuthorStamp
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :record_authorstamps
+      self.record_authorstamps = true
+    end
+
+    def initialize_dup(other) # :nodoc:
+      clear_authorstamp_attributes
+      super
+    end
+
+  private
+
+    def create_record
+      if self.record_authorstamps
+        all_authorstamp_attributes.each do |column|
+          if respond_to?(column) && respond_to?("#{column}=") && self.send(column).nil?
+            write_attribute(column.to_s, current_author)
+          end
+        end
+      end
+
+      super
+    end
+
+    def update_record(*args)
+      if should_record_authorstamps?
+        authorstamp_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_authorstamps?
+      self.record_authorstamps && (!partial_writes? || changed? || (attributes.keys & self.class.serialized_attributes.keys).present?)
+    end
+
+    def authorstamp_attributes_for_create_in_model
+      authorstamp_attributes_for_create.select { |c| self.class.column_names.include?(c.to_s) }
+    end
+
+    def authorstamp_attributes_for_update_in_model
+      authorstamp_attributes_for_update.select { |c| self.class.column_names.include?(c.to_s) }
+    end
+
+    def all_authorstamp_attributes_in_model
+      authorstamp_attributes_for_create_in_model + authorstamp_attributes_for_update_in_model
+    end
+
+    def authorstamp_attributes_for_update
+      [:updated_by, :updated_by_id]
+    end
+
+    def authorstamp_attributes_for_create
+      [:created_by, :created_by_id]
+    end
+
+    def all_authorstamp_attributes
+      authorstamp_attributes_for_create + authorstamp_attributes_for_update
+    end
+
+    def current_author
+      Concern::Audit::Author.current
+    end
+
+    # Clear attributes and changed_attributes
+    def clear_authorstamp_attributes
+      all_authorstamp_attributes_in_model.each do |attribute_name|
+        self[attribute_name] = nil
+        changed_attributes.delete(attribute_name)
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/abstract_mysql_adapter.rb

@@ -0,0 +1,15 @@
+module ActiveRecord
+  module ConnectionAdapters
+    class AbstractMysqlAdapter < AbstractAdapter
+
+      def add_authorstamps_sql(table_name)
+        [add_column_sql(table_name, :created_by, :string), add_column_sql(table_name, :updated_by, :string)]
+      end
+
+      def remove_authorstamps_sql(table_name)
+        [remove_column_sql(table_name, :updated_by), remove_column_sql(table_name, :created_by)]
+      end
+
+    end
+  end
+end

data/lib/active_record/migration/command_recorder.rb

@@ -0,0 +1,40 @@
+module ActiveRecord
+  class Migration
+    # <tt>ActiveRecord::Migration::CommandRecorder</tt> records commands done during
+    # a migration and knows how to reverse those commands. The CommandRecorder
+    # knows how to invert the following commands:
+    #
+    # Adds...
+    # * add_authorstamps
+    # * remove_authorstamps
+    class CommandRecorder
+
+      [ # irreversible methods need to be here too
+        :add_authorstamps,
+        :remove_authorstamps,
+      ].each do |method|
+        class_eval <<-EOV, __FILE__, __LINE__ + 1
+          def #{method}(*args, &block)          # def create_table(*args, &block)
+            record(:"#{method}", args, &block)  #   record(:create_table, args, &block)
+          end                                   # end
+        EOV
+      end
+
+      module StraightReversions
+        private
+        { add_authorstamps:  :remove_authorstamps }.each do |cmd, inv|
+          [[inv, cmd], [cmd, inv]].uniq.each do |method, inverse|
+            class_eval <<-EOV, __FILE__, __LINE__ + 1
+              def invert_#{method}(args, &block)    # def invert_create_table(args, &block)
+                [:#{inverse}, args, block]          #   [:drop_table, args, block]
+              end                                   # end
+            EOV
+          end
+        end
+      end
+
+      include StraightReversions
+
+    end
+  end
+end

data/lib/ar-audit-tracer.rb

@@ -1,104 +1,17 @@
 # encoding: utf-8
+require 'active_record/migration/command_recorder'
+require 'active_record/author_stamp'
 require 'concern/audit/author'
 
 module ActiveRecord
 
-  # = 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_attribute :record_authors
-      self.record_authors = true
-    end
-
-    def initialize_dup(other)
-      clear_author_attributes
-    end
-
-  private
-
-    def create #:nodoc:
-      if self.record_authors
-        current_author = Concern::Audit::Author.current
-
-        all_author_attributes.each do |column|
-          if respond_to?(column) && self.send(column).nil?
-            write_attribute(column.to_s, current_author)
-          end
-        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?
-      self.record_authors && (!partial_updates? || changed? || (attributes.keys & self.class.serialized_attributes.keys).present?)
-    end
-
-    def author_attributes_for_update_in_model
-      author_attributes_for_update.select { |c| respond_to?(c) }
-    end
-
-    def author_attributes_for_create_in_model
-      author_attributes_for_create.select { |c| respond_to?(c) }
-    end
-
-    def all_author_attributes
-      author_attributes_for_create + author_attributes_for_update
-    end
-
-    def author_attributes_for_update #:nodoc:
-      [:updated_by]
-    end
-
-    def author_attributes_for_create #:nodoc:
-      [:created_by]
-    end
-
-    def all_author_attributes_in_model
-      author_attributes_for_create_in_model + author_attributes_for_update_in_model
-    end
-
-    # Clear attributes and changed_attributes
-    def clear_author_attributes
-      all_author_attributes_in_model.each do |attribute_name|
-        self[attribute_name] = nil
-        changed_attributes.delete(attribute_name)
-      end
-    end
-
-  end
-
-
 
   module ConnectionAdapters
     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, *args)
+      def add_authorstamps(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
@@ -107,7 +20,7 @@ module ActiveRecord
       # Removes the author columns (created_by and updated_by) from the table definition.
       # ===== Examples
       #  remove_authors(:suppliers)
-      def remove_authors(table_name)
+      def remove_authorstamps(table_name)
         remove_column table_name, :updated_by
         remove_column table_name, :created_by
       end
@@ -120,7 +33,7 @@ module ActiveRecord
       #
       # @param Symbol type  The desired type for the columns, defaults to :string
       # @param Hash   *args Column options from rails
-      def authors(type=:string, *args)
+      def authorstamps(type=:string, *args)
         options = args.extract_options!
         column(:created_by, type, options)
         column(:updated_by, type, options)
@@ -135,16 +48,16 @@ module ActiveRecord
       #
       # @param Symbol type  The desired type for the columns, defaults to :string
       # @see SchemaStatements#add_authors
-      def authors(type=:string, *args)
+      def authorstamps(type=:string, *args)
         options = {:null => false}.merge(args.extract_options!)
-        @base.add_authors(@table_name, type, options)
+        @base.add_authorstamps(@table_name, type, options)
       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)
+      def remove_authorstamps
+        @base.remove_authorstamps(@table_name)
       end
 
     end
@@ -153,7 +66,7 @@ module ActiveRecord
 
 
   Base.class_eval do
-    include Author
+    include ActiveRecord::AuthorStamp
   end
 
 end

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

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

data/test/resources/migrations/add_authors.rb

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

data/test/resources/migrations/change_table_authors.rb

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

data/test/resources/schema.rb

@@ -5,14 +5,14 @@ ActiveRecord::Schema.define(:version => 0) do
 
   create_table :with_string_authors, :force => true do |t|
     t.string :name
-    t.authors
+    t.authorstamps
   end
 
   create_table :with_integer_authors, :force => true do |t|
     t.string :name
-    t.authors(:integer)
+    t.authorstamps(:integer)
   end
-  
+
   create_table :blank_ones, :force => true do |t|
     t.string :name
   end

data/test/test_ar-audit-tracer.rb

@@ -6,7 +6,7 @@ require 'resources/migrations/change_table_authors'
 class TestArAuditTracer < Test::Unit::TestCase
 
   def setup
-    Concern::Audit::Author.current=nil  
+    Concern::Audit::Author.current=nil
   end
 
   def test_author_attributes_available
@@ -33,7 +33,7 @@ class TestArAuditTracer < Test::Unit::TestCase
     # 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"
 
@@ -94,10 +94,10 @@ class TestArAuditTracer < Test::Unit::TestCase
   end
 
   def test_migration_add_authors
-    assert !BlankTwo.attribute_names.include?(:created_by)
-    assert !BlankTwo.attribute_names.include?(:updated_by)
+    assert !BlankTwo.new().attribute_names.include?(:created_by)
+    assert !BlankTwo.new().attribute_names.include?(:updated_by)
 
-    AddAuthors.new().up
+    AddAuthors.up
     BlankTwo.reset_column_information
 
     assert_equal :string, BlankTwo.columns_hash['created_by'].type
@@ -105,10 +105,10 @@ class TestArAuditTracer < Test::Unit::TestCase
   end
 
   def test_migration_change_table_authors
-    assert !BlankOne.attribute_names.include?(:created_by)
-    assert !BlankOne.attribute_names.include?(:updated_by)
+    assert !BlankOne.new().attribute_names.include?(:created_by)
+    assert !BlankOne.new().attribute_names.include?(:updated_by)
 
-    ChangeTableAuthors.new().up
+    ChangeTableAuthors.up
     BlankOne.reset_column_information
 
     assert_equal :integer, BlankOne.columns_hash['created_by'].type

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: ar-audit-tracer
 version: !ruby/object:Gem::Version
-  version: 1.0.2
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - Martin Schweizer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-01 00:00:00.000000000 Z
+date: 2013-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   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.
@@ -75,9 +68,10 @@ files:
 - README.rdoc
 - Rakefile
 - ar-audit-tracer.gemspec
-- gemfiles/rails3_0.gemfile
-- gemfiles/rails3_1.gemfile
-- gemfiles/rails3_2.gemfile
+- gemfiles/rails4_0.gemfile
+- lib/active_record/author_stamp.rb
+- lib/active_record/connection_adapters/abstract_mysql_adapter.rb
+- lib/active_record/migration/command_recorder.rb
 - lib/ar-audit-tracer.rb
 - lib/ar-audit-tracer/version.rb
 - lib/concern/audit/author.rb
@@ -90,6 +84,7 @@ files:
 - test/test_ar-audit-tracer.rb
 homepage: http://github.com/verticonaut/ar-audit-tracer
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --charset
@@ -98,22 +93,20 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 2.0.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Track creator/modifiers of you AR Models similar to timestamps.
 test_files:
 - test/concern/audit/author_test.rb

data/gemfiles/rails3_0.gemfile

@@ -1,8 +0,0 @@
-source 'http://rubygems.org'
-
-gem 'activerecord', '~> 3.0.3'
-
-group :test do
-	gem 'rake'
-	gem 'sqlite3'
-end

data/gemfiles/rails3_1.gemfile

@@ -1,8 +0,0 @@
-source 'http://rubygems.org'
-
-gem 'activerecord', '~> 3.1.0'
-
-group :test do
-	gem 'rake'
-	gem 'sqlite3'
-end

data/gemfiles/rails3_2.gemfile

@@ -1,8 +0,0 @@
-source 'http://rubygems.org'
-
-gem 'activerecord', '~> 3.2.0'
-
-group :test do
-	gem 'rake'
-	gem 'sqlite3'
-end