change_log 0.0.5 → 0.0.6

data/README.textile

@@ -1,6 +1,9 @@
 h1. Change Log
 
-A gem to keep all maintenances in database
+A gem to keep all changes about the record in database.
+It automatically saves who made the changes at what time and what has been changed into a single database table.
+You can choose the columns which you want to keep the changes.
+Ignores columns like 'updated_at', 'created_at' and 'password' etc.
 
 
 h2. Install Change Log Gem
@@ -11,7 +14,7 @@ h2. Install Change Log Gem
 <pre><code>config.gem 'change_log'</code></pre>
 
 
-2. by bundler:
+2. or by bundler:
 <pre><code># Gemfile in your application
 gem 'change_log'
 </code></pre>
@@ -19,11 +22,13 @@ gem 'change_log'
 Then:
 <pre><code>bundle install</code></pre>
 
-* Note: Currently if you use bundler to load gems and phusion-passenger as your web server,
-        you may get "enable_change_log" method missing error. 
-        I am still looking for reason for that, helps will be pleased!
+* Note: 
+        If you use bundler with Rails 2.3.x, you may get "enable_change_log" method missing error. 
+        This is because Rails 2.3.x comes with its own gem handling. 
+        You need to override that and replace it with support for Bundler. 
+        Visit "Bundler Website":http://gembundler.com/rails23.html to find out how.
 
-h2. Create a table to keep all maintenance logs
+h2. Create a table to keep all changes
 
     Generate a migration file
 
@@ -51,32 +56,22 @@ h2. Create a table to keep all maintenance logs
 </code></pre>
 
 Then:
-<pre><code>rake db:migrate</code></pre>
-
-* Note: It is ok if you want to use other table name instead of 'change_logs',
-        choose your preferred table name and run the migration.
-        Just remember in your environment.rb file, you need to tell change_log gem 
-        what is your table name:
-<pre><code># config/environment.rb
-Maintenance.set_table_name('hr_maintenances')
-</code></pre>
-
-* Note: Maintenance model is core ActiveRecord model used by change_log.
+<pre><code>rake db:migrate</code></pre> 
 
 h2. Use Change Log
 
-    1. Include change_log in environment.rb
-<pre><code>config.gem 'change_log'</code></pre>
+    1. *Add current_user Method in application_controller.rb*
 
-    2. Add current_user method in application_controller.rb 
+This method will tell change_log who is the current user
 <pre><code>
-# used by change log 
 def current_user 
-  return session[:user] # replace this with your own code to tell change_log who is the current user
+  return session[:user] # replace this with your own code
 end
 </code></pre>
 
-    3. Models
+    2. *ActiveRecord Models*
+If you want to enable change_log for any ActiveRecord Model, 
+just put following line in very beginning of model file.
 <pre><code>
 enable_change_log :ignore=>[:updated_at]    
 </code></pre>
@@ -85,6 +80,31 @@ Put any columns you do not want to keep in the change log table in :ignore optio
 eg. the password hash
 
 
+    3.  *About the ChangeLogs Model*
+ChangeLogs model is core ActiveRecord model used by change_log gem.
+
+You can use it directly in your model, controller even in helper.
+
+For example:
+<pre><code># List all changes
+ChangeLogs.find(:all)</code></pre>
+
+<pre><code># List all changes made by user 'peterz'
+ChangeLogs.find(:all,:conditions=>['user = ?', 'peterz'])</code></pre>
+
+<pre><code># List all changes for table 'accounts'
+ChangeLogs.find(:all,:conditions=>['table_name = ?', 'accounts'])</code></pre>   
+
+* Note: 
+        It is ok if you want to use other table name instead of 'change_logs',
+        choose your preferred table name and run the migration.
+        Just remember in your environment.rb file, you need to tell change_log gem 
+        what is your table name:
+
+<pre><code># config/environment.rb
+ChangeLogs.set_table_name('hr_maintenances')
+</code></pre>
+
 h2. Testing
 
     TODO

data/lib/change_log.rb

@@ -3,7 +3,7 @@ require 'yaml'
 require 'change_log/config'
 require 'change_log/controller'
 require 'change_log/has_change_log'
-require 'change_log/maintenance'
+require 'change_log/change_logs'
 
 # ChangeLog's module methods can be called in both models and controllers.
 module ChangeLog
@@ -19,7 +19,7 @@ module ChangeLog
     !!ChangeLog.config.enabled
   end
 
-  # Returns who is reponsible for any changes that occur.
+  # Returns who is responsible for any changes that occur.
   def self.whodidit
     change_log_store[:whodidit]
   end

data/lib/change_log/{maintenance.rb → change_logs.rb}

@@ -1,12 +1,12 @@
-class Maintenance < ActiveRecord::Base
+class ChangeLogs < ActiveRecord::Base
   # Set table name to "change_logs" 
   set_table_name 'change_logs' 
 
   private
 
-  # Save maintenance details when options
-  def self.update_maintenance_record_with(option={})
-    record = Maintenance.new(option)
+  # Save Change Log details when options
+  def self.update_change_log_record_with(option={})
+    record = ChangeLogs.new(option)
     record.field_type = get_field_type(option[:table_name],option[:attribute_name]) unless option[:action].eql?('DELETE')
     record.created_at = Time.now
     record.save
@@ -14,7 +14,7 @@ class Maintenance < ActiveRecord::Base
 
   # return the latest version number for this change
   def self.get_version_number(id,table_name)
-    latest_version = Maintenance.maximum(:version,:conditions=>['record_id = ? and table_name = ?',id,table_name])
+    latest_version = ChangeLogs.maximum(:version,:conditions=>['record_id = ? and table_name = ?',id,table_name])
     return latest_version.nil? ? 1 : latest_version.next
   end
 

data/lib/change_log/has_change_log.rb

@@ -44,11 +44,11 @@ module ChangeLog
       def record_create
         # do nothing if the change log is not turned on
         return '' unless switched_on?
-        # saving changes to maintenance log
+        # saving changes to change log
         self.attributes.map do |key,value|
           unless self.ignore.include?(key.to_sym)
             option = {:action=>'INSERT', :record_id=>self.id,:table_name=>self.class.table_name, :user=>ChangeLog.whodidit,:attribute_name=>key,:new_value=>value,:version=>1}
-            Maintenance.update_maintenance_record_with(option)
+            ChangeLogs.update_change_log_record_with(option)
           end
         end  
   	  end
@@ -61,27 +61,27 @@ module ChangeLog
           # do not record changes between nil <=> ''
           # and ignore the changes for ignored columns
           unless value[1].eql?(value[0]) || (value[1].blank?&&value[0].blank?) || self.ignore.include?(attribute_name.to_s)
-            option = {:action=>'UPDATE',:record_id=>self.id,:table_name=>self.class.table_name,:user=>ChangeLog.whodidit,:attribute_name=>attribute_name,:old_value=>value[0],:new_value=>value[1],:version => Maintenance.get_version_number(self.id,self.class.table_name)}
-            Maintenance.update_maintenance_record_with(option)
+            option = {:action=>'UPDATE',:record_id=>self.id,:table_name=>self.class.table_name,:user=>ChangeLog.whodidit,:attribute_name=>attribute_name,:old_value=>value[0],:new_value=>value[1],:version => ChangeLogs.get_version_number(self.id,self.class.table_name)}
+            ChangeLogs.update_change_log_record_with(option)
           end
         end
       end
 
       def record_destroy
         return '' unless switched_on?
-        Maintenance.update_maintenance_record_with({:action=>'DELETE',:table_name=>self.class.table_name,:record_id=>self.id,:user=>ChangeLog.whodidit,:version => Maintenance.get_version_number(self.id,self.class.table_name)})
+        ChangeLogs.update_change_log_record_with({:action=>'DELETE',:table_name=>self.class.table_name,:record_id=>self.id,:user=>ChangeLog.whodidit,:version => ChangeLogs.get_version_number(self.id,self.class.table_name)})
       end
 
-      # Return a list of maintenance records
+      # Return a list of change_log records
       # Return empty array if not record found
       def change_logs
-        return Maintenance.find(:all,:conditions=>['table_name= ? and record_id = ?',self.class.table_name,self.id],:order=>"created_at DESC")
+        return ChangeLogs.find(:all,:conditions=>['table_name= ? and record_id = ?',self.class.table_name,self.id],:order=>"created_at DESC")
       end
 
-      # Return `true` if current record has a list of maintenance records
+      # Return `true` if current record has a list of change_log records
       # otherwise `false`.
       def has_change_log?
-        return (Maintenance.count(:conditions=>['table_name= ? and record_id = ?',self.class.table_name,self.id]) > 0) ? true : false
+        return (ChangeLogs.count(:conditions=>['table_name= ? and record_id = ?',self.class.table_name,self.id]) > 0) ? true : false
       end
 
       private

data/lib/change_log/version.rb

@@ -1,3 +1,3 @@
 module ChangeLog
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: change_log
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Peter Zhang
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-19 00:00:00 +13:00
+date: 2011-01-20 00:00:00 +13:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,10 +48,10 @@ files:
 - Rakefile
 - change_log.gemspec
 - lib/change_log.rb
+- lib/change_log/change_logs.rb
 - lib/change_log/config.rb
 - lib/change_log/controller.rb
 - lib/change_log/has_change_log.rb
-- lib/change_log/maintenance.rb
 - lib/change_log/version.rb
 has_rdoc: true
 homepage: http://www.ncs.co.nz