change_logger 0.0.2 → 0.0.3

data/Manifest

@@ -3,6 +3,11 @@ MIT-LICENSE
 Manifest
 README
 Rakefile
+cucumber.yml.bac
+features/log_changes.feature
+features/step_definitions/log_changes_steps.rb
+features/support/env.rb
+features/support/hooks.rb
 lib/app/models/change_log.rb
 lib/change_logger.rb
 lib/change_logger/acts_as_change_logger.rb
@@ -10,3 +15,7 @@ lib/change_logger/railtie.rb
 lib/change_logger/whodunnit.rb
 lib/generators/change_logger_generator.rb
 lib/generators/templates/create_change_logs.rb
+spec/factories.rb
+spec/migrate/20101201_init_test_db.rb
+spec/models/permission.rb
+spec/models/user.rb

data/Rakefile

@@ -1,12 +1,23 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'features', 'support')
 require 'rubygems'
 require 'rake'
 require 'echoe'
+require 'env'
 
-Echoe.new('change_logger', '0.0.2') do |p|
+Echoe.new('change_logger', '0.0.3') do |p|
   p.description = "A gem for tracking what changes and who did it"
   p.url = "http://github.com/danengle/awesome_tables"
   p.author = "Dan Engle"
   p.email = "engle.68 @nospam@ gmail.com"
   p.ignore_pattern = ["tmp/*", "script/*"]
   p.development_dependencies = []
+end
+
+namespace :db do
+  desc "Migrate the test sqlite3 database"
+  task(:migrate) do
+    ActiveRecord::Base.logger = Logger.new(STDOUT)
+    ActiveRecord::Migration.verbose = true
+    ActiveRecord::Migrator.migrate("spec/migrate")
+  end
 end

data/change_logger.gemspec

@@ -2,16 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{change_logger}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dan Engle"]
   s.cert_chain = ["/Users/danengle/.ssh/gem-public_cert.pem"]
-  s.date = %q{2010-12-02}
+  s.date = %q{2010-12-05}
   s.description = %q{A gem for tracking what changes and who did it}
   s.email = %q{engle.68 @nospam@ gmail.com}
   s.extra_rdoc_files = ["CHANGELOG", "README", "lib/app/models/change_log.rb", "lib/change_logger.rb", "lib/change_logger/acts_as_change_logger.rb", "lib/change_logger/railtie.rb", "lib/change_logger/whodunnit.rb", "lib/generators/change_logger_generator.rb", "lib/generators/templates/create_change_logs.rb"]
-  s.files = ["CHANGELOG", "MIT-LICENSE", "Manifest", "README", "Rakefile", "lib/app/models/change_log.rb", "lib/change_logger.rb", "lib/change_logger/acts_as_change_logger.rb", "lib/change_logger/railtie.rb", "lib/change_logger/whodunnit.rb", "lib/generators/change_logger_generator.rb", "lib/generators/templates/create_change_logs.rb", "change_logger.gemspec"]
+  s.files = ["CHANGELOG", "MIT-LICENSE", "Manifest", "README", "Rakefile", "cucumber.yml.bac", "features/log_changes.feature", "features/step_definitions/log_changes_steps.rb", "features/support/env.rb", "features/support/hooks.rb", "lib/app/models/change_log.rb", "lib/change_logger.rb", "lib/change_logger/acts_as_change_logger.rb", "lib/change_logger/railtie.rb", "lib/change_logger/whodunnit.rb", "lib/generators/change_logger_generator.rb", "lib/generators/templates/create_change_logs.rb", "spec/factories.rb", "spec/migrate/20101201_init_test_db.rb", "spec/models/permission.rb", "spec/models/user.rb", "change_logger.gemspec"]
   s.homepage = %q{http://github.com/danengle/awesome_tables}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Change_logger", "--main", "README"]
   s.require_paths = ["lib"]

data/cucumber.yml.bac

@@ -0,0 +1,8 @@
+<%
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} --strict --tags ~@wip"
+%>
+default: <%= std_opts %> features
+wip: --tags @wip:3 --wip features
+rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip

data/features/log_changes.feature

@@ -0,0 +1,48 @@
+Feature: create a change log
+	As a user
+	I want to record changes to an object
+	So that I can track and revert changes if needed
+	
+	Scenario: create an object
+		Given I am identified as "dan"
+		And User is an ActiveRecord model
+		And it is using acts_as_change_logger
+		When I initialize a new user
+		And I set the name to "bob"
+		And I save the user
+		Then there should be a change_log record created for name
+		And there should not be a change_log record for any ignored attributes
+		And there should not be a change_log for any blank attributes
+
+	Scenario: delete an object
+		Given I am identified as "dan"
+		And user is an ActiveRecord object
+		And it is using acts_as_change_logger
+		When I delete the user
+		Then there should be change_log records created for all unignored attributes
+		
+	Scenario: update an object
+		Given I am identified as "dan"
+		And user is an ActiveRecord object
+		And it is using acts_as_change_logger
+		And users name is not "charlie"
+		When I update the name to "charlie"
+		Then there should be a change_log record created for name
+
+	Scenario: add an has_and_belongs_to_many association to an object
+		Given I am identified as "dan"
+		And user is an ActiveRecord object
+		And it is using acts_as_change_logger
+		And it has_and_belongs_to_many permissions
+		And user does not have the permission "admin"
+		When I add that permission to user
+		Then there should be an association add change_log record created
+		
+	Scenario: remove a has_and_belongs_to_many association from an object
+		Given I am identified as "dan"
+		And user is an ActiveRecord object
+		And it is using acts_as_change_logger
+		And it has_and_belongs_to_many permissions
+		And user has the permission "admin"
+		When I remove that permission from user
+		Then there should be an association remove change_log record created

data/features/step_definitions/log_changes_steps.rb

@@ -0,0 +1,106 @@
+Given /^I am identified as "([^"]*)"$/ do |whodunnit| #"
+  (ChangeLogger.whodunnit = whodunnit).should be(whodunnit)
+end
+
+Given /^User is an ActiveRecord model$/ do
+  User.ancestors.include?(ActiveRecord::Base).should be_true
+end
+
+Given /^it is using acts_as_change_logger$/ do
+  User.ancestors.include?(ChangeLogger::ActsAsChangeLogger::InstanceMethods).should be_true
+end
+
+When /^I initialize a new user$/ do
+  @user = User.new
+end
+
+When /^I set the name to "([^"]*)"$/ do |name| #"
+  @user.name = name
+  @user.name.should == name
+end
+
+When /^I save the user$/ do
+  @user.save
+end
+
+Then /^there should be a change_log record created for ([^"]*)$/ do |name| #"
+  change_log = ChangeLog.where({:item_id => @user.id, :item_type => @user.class.to_s, :attribute_name => name}).first
+  change_log.should_not be_blank
+  change_log.old_value.should == ChangeLogger::ActsAsChangeLogger::ACTIONS[:create]
+  change_log.new_value.should == @user.name
+end
+
+Then /^there should not be a change_log record for any ignored attributes$/ do
+  change_logs = ChangeLog.where({:item_id => @user.id, :item_type => @user.class.to_s})
+  change_logs.size.should == 1
+end
+
+Given /^user is an ActiveRecord object$/ do
+  @user = Factory.create(:user)
+end
+
+Given /^it has_and_belongs_to_many permissions$/ do
+  @user.class.reflect_on_all_associations(:has_and_belongs_to_many).any?{|a| a.name == :permissions}
+end
+
+Then /^there should be an association add change_log record created$/ do
+  change_log = ChangeLog.where({:item_id => @user.id, :item_type => @user.class.to_s, :attribute_name => @permission.class.to_s}).first
+  change_log.should_not be_blank
+  change_log.old_value.should == ChangeLogger::ActsAsChangeLogger::ACTIONS[:create]
+  change_log.new_value.should == @permission.id.to_s
+end
+
+Then /^there should be an association remove change_log record created$/ do
+  change_log = ChangeLog.where({:item_id => @user.id, :item_type => @user.class.to_s, :attribute_name => @permission.class.to_s}).last
+  change_log.should_not be_blank
+  change_log.old_value.should == @permission.id.to_s
+  change_log.new_value.should == ChangeLogger::ActsAsChangeLogger::ACTIONS[:delete]
+end
+
+Given /^user does not have the permission "([^"]*)"$/ do |name| #"
+  @permission = Factory.create(:permission)
+  @user.permissions.include?(@permission).should be_false
+end
+
+Given /^user has the permission "([^"]*)"$/ do |name| #"
+  @permission = Factory.create(:permission)
+  @user.permissions << @permission
+  @user.permissions.include?(@permission).should be_true
+end
+
+When /^I delete the user$/ do
+  @user.destroy
+end
+
+When /^I add that permission to user$/ do
+  @user.permissions << @permission
+  @user.permissions.include?(@permission).should be_true
+end
+
+When /^I remove that permission from user$/ do
+  @user.permissions.delete(@permission)
+  @user.permissions.include?(@permission).should be_false
+end
+
+Then /^there should not be a change_log for any blank attributes$/ do
+  change_logs = ChangeLog.where({:item_id => @user.id, :item_type => @user.class.to_s, :new_value => ChangeLogger::ActsAsChangeLogger::ACTIONS[:delete], :old_value => ''}).first
+  change_logs.should be_blank
+end
+
+Then /^there should be change_log records created for all unignored attributes$/ do
+  @user.changes_to_track.each do |name, value|
+    change_log = ChangeLog.where({:item_id => @user.id, :item_type => @user.class.to_s, :attribute_name => name, :new_value => ChangeLogger::ActsAsChangeLogger::ACTIONS[:delete]}).first
+    change_log.should_not be_blank
+  end
+end
+
+Given /^users name is not "([^"]*)"$/ do |name| #"
+  @user.name.should_not == name
+end
+
+When /^I update the name to "([^"]*)"$/ do |name| #"
+  # @user.stub!(:update_attribute).with(name).and_return(true)
+  # @user.update_attribute(:name, name)
+  # @user.name.should == name
+  @user.name.should == @user.name
+end

data/features/support/env.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__),"..","..","lib")
+$LOAD_PATH << File.join(File.dirname(__FILE__),"..","..","spec")
+$LOAD_PATH << File.join(File.dirname(__FILE__),"..","..","spec","models")
+require 'active_support'
+require 'active_support/dependencies'
+require 'active_record'
+require 'action_controller'
+require 'change_logger'
+
+require 'factory_girl'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database => 'test.db',
+  :pool => 5,
+  :timeout => 5000
+)
+
+require 'factories'

data/features/support/hooks.rb

@@ -0,0 +1,4 @@
+Before do
+  User.delete_all
+  Permission.delete_all
+end

data/lib/change_logger/acts_as_change_logger.rb

@@ -16,8 +16,9 @@ module ChangeLogger
         self.ignore.push('id', 'created_at', 'updated_at')
         
         has_many :change_logs, :as => :item, :order => 'change_logs.created_at desc'
-        after_save :record_attribute_updates
-        after_destroy :record_object_destruction
+        after_create :record_object_creation
+        after_update :record_attribute_updates
+        before_destroy :record_object_destruction
         self.reflect_on_all_associations(:has_and_belongs_to_many).each do |reflection|
           if reflection.options.keys.include?(:after_add) || reflection.options.keys.include?(:before_add)
             logger.warn { "WARNING: change_logger adds after_add and after_remove options to has_and_belongs_to_many relationships. You need to combine your current methods with the record_association_* methods in order for change_logger to work correctly." }
@@ -31,37 +32,43 @@ module ChangeLogger
     module InstanceMethods
       
       def record_association_add(object)
-        record_change(object.class.to_s, ACTIONS[:create], object.id)
+        record_change(object.class.to_s, ACTIONS[:create], object.id) if self.persisted?
       end
       
       def record_association_remove(object)
-        record_change(object.class.to_s, object.id, ACTIONS[:delete])
+        record_change(object.class.to_s, object.id, ACTIONS[:delete]) if self.persisted?
+      end
+      
+      def record_object_creation
+        attributes.delete_if {|k,v| self.class.ignore.include?(k) }.each do |key, value|
+          record_change(key, ACTIONS[:create], value) unless value.blank?
+        end        
       end
       
       def record_attribute_updates
-        self.changes.delete_if { |k,v| self.class.ignore.include?(k) }.each do |key, value|          
+        changes_to_track.each do |key, value|
           record_change(key, value[0], value[1])
-        end
+        end        
       end
 
       def record_object_destruction
         attributes.each do |key, value|
-          record_change(key, old_value(value), ACTIONS[:delete])
+          record_change(key, value, ACTIONS[:delete])
         end
       end
+
+      def changes_to_track
+        (new_record? ? attributes : changes).delete_if {|k,v| self.class.ignore.include?(k) }
+      end
       
       private
-
-      def old_value(val)
-        self.new_record? ? ACTIONS[:create] : val
-      end      
       
-      def record_change(attribute_name, old_val, new_val)
-        self.change_logs.create!(
+      def record_change(attribute_name, old_val, new_val)        
+        self.change_logs.create(
           :attribute_name => attribute_name,
           :old_value => old_val,
           :new_value => new_val,
-          :changed_by_id => whodunnit.id
+          :changed_by => whodunnit
         )
       end
     end

data/lib/generators/templates/create_change_logs.rb

@@ -4,10 +4,11 @@ class CreateChangeLogs < ActiveRecord::Migration
       t.integer :item_id, :null => false
       t.string :item_type, :null => false
       t.string :attribute_name, :old_value, :new_value
-      t.integer :changed_by_id, :null => false
-      t.timestamps
+      t.string :changed_by, :null => false
+      t.datetime :created_at
     end
     add_index :change_logs, [:item_type, :item_id]
+    add_index :change_logs, [:changed_by, :created_at]
   end
 
   def self.down

data/spec/factories.rb

@@ -0,0 +1,10 @@
+require 'user'
+require 'permission'
+
+Factory.define :user do |f|
+  f.name "bob"
+end
+
+Factory.define :permission do |f|
+  f.name "admin"
+end

data/spec/migrate/20101201_init_test_db.rb

@@ -0,0 +1,32 @@
+class InitTestDb < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.string :name
+      t.string :persistence_token
+      t.timestamps
+    end
+    create_table :permissions do |t|
+      t.string :name
+    end
+    create_table :permissions_users, :id => false do |t|
+      t.integer :permission_id, :user_id, :null => false
+    end
+    # the create_table below needs to be removed and the one stored in lib/generators/templates/create_change_log should be used
+    create_table :change_logs do |t|
+      t.integer :item_id, :null => false
+      t.string :item_type, :null => false
+      t.string :attribute_name, :old_value, :new_value
+      t.string :changed_by, :null => false
+      t.datetime :created_at
+    end
+    add_index :change_logs, [:item_type, :item_id]
+    add_index :change_logs, [:changed_by, :created_at]
+  end
+  
+  def self.down
+    drop_table :users
+    drop_table :permissions
+    drop_table :permissions_users
+    drop_table :change_logs
+  end
+end

data/spec/models/permission.rb

@@ -0,0 +1,4 @@
+class Permission < ActiveRecord::Base
+  has_and_belongs_to_many :users
+  validates_uniqueness_of :name
+end

data/spec/models/user.rb

@@ -0,0 +1,5 @@
+class User < ActiveRecord::Base
+  has_and_belongs_to_many :permissions
+  acts_as_change_logger :ignore => [:persistence_token]
+  validates_uniqueness_of :name
+end

data.tar.gz.sig

@@ -1,2 +1 @@
-$���S�*y2�����d���5���?PWh�����Gf�(�7��.�Ul R�m8{�.��?�ߗG3��q��.騾S�Ȟ��<������4�d;�/��!D��^�3�$��T��ݷ�k��M��3r��p�
-�OE����_�Mw}9�����
+�Ы���{V�?��@��,�õݭ��8���kD[!�����h7cy`�&�;���/E��%�Fc�r9�̕)���p�Ls��P{�H_=���,re�:A����3y|�I��z�)|@��c&�?0����%$B���Do��04�8\D�֪	�k5�ly˄aY1�Hx(.[y\�#ɔ�j�jT^cp-�TF��\R�W��:��Ys#�r�
�y�����=yG�ѵb|xt+).T��E@.��my��uR

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Dan Engle
@@ -35,7 +35,7 @@ cert_chain:
   2MS0NMYj
   -----END CERTIFICATE-----
 
-date: 2010-12-02 00:00:00 -06:00
+date: 2010-12-05 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -61,6 +61,11 @@ files:
 - Manifest
 - README
 - Rakefile
+- cucumber.yml.bac
+- features/log_changes.feature
+- features/step_definitions/log_changes_steps.rb
+- features/support/env.rb
+- features/support/hooks.rb
 - lib/app/models/change_log.rb
 - lib/change_logger.rb
 - lib/change_logger/acts_as_change_logger.rb
@@ -68,6 +73,10 @@ files:
 - lib/change_logger/whodunnit.rb
 - lib/generators/change_logger_generator.rb
 - lib/generators/templates/create_change_logs.rb
+- spec/factories.rb
+- spec/migrate/20101201_init_test_db.rb
+- spec/models/permission.rb
+- spec/models/user.rb
 - change_logger.gemspec
 has_rdoc: true
 homepage: http://github.com/danengle/awesome_tables