change_log 0.0.1 → 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 PETER ZHANG
+
+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

@@ -0,0 +1,69 @@
+h1. Change Log
+
+A gem to keep all maintenances in database
+
+
+h2. Install Change Log Gem
+    1. command:
+    <pre><code># gem install change_log</code</pre>
+
+    2. bundler
+    <pre><code>
+        # Gemfile in your application
+        gem 'change_log','0.0.1'
+    </code</pre>
+    then:
+    <pre><code>
+        bundle install
+    </code</pre>
+
+h2. Create a table to keep all maintenance logs
+
+    1. generate a migration file
+
+    <pre><code>
+        class AddChangeLog < ActiveRecord::Migration
+          def self.up
+            create_table :change_log do |t|
+             t.integer :version, :null=>false # store version of each change
+             t.string :record_id,:limit=>30   # store the actual record id 
+             t.string :table_name, :limti=>60  # store the table name 
+             t.string :attribute_name,:limit=>60 # store the column name
+             t.string :user, :limit=>20  # store the user who made the change
+             t.string :action, :limit=>6 # store the change action: create, read, update, delete
+             t.text :old_value # the value before change
+             t.text :new_value # value after change
+             t.string :field_type, :limit=>30 # the column type eg. date, text, varchar, int etc
+             t.timestamps
+            end
+          end
+
+          def self.down
+            drop_table :change_log
+          end
+        end
+    </code></pre>
+
+    Then:
+    <pre><code>rake db:migrate</code></pre>
+
+h2. Use Change Log
+    1. Add current_user method in application_controller.rb 
+    <pre><code>
+      # used by change log 
+      def current_user # :nodoc:
+        return session[:user] # replace this with your own code to tell change_log who is the current user
+      end
+    </code></pre>
+
+h2. Testing
+    TODO::
+
+
+Author
+------
+
+Peter Zhang at NCS New Zealand.
+Email: peterz@ncs.co.nz
+
+Copyright (c) 2011 Peter Zhang, released under the MIT license

data/lib/change_log/config.rb

@@ -0,0 +1,11 @@
+module ChangeLog
+  class Config
+    include Singleton
+    attr_accessor :enabled
+ 
+    def initialize
+      # Indicates whether ChangeLog is on or off.
+      @enabled = true
+    end
+  end
+end

data/lib/change_log/controller.rb

@@ -0,0 +1,29 @@
+module ChangeLog
+  module Controller
+
+    def self.included(base)
+      base.before_filter :set_change_log_whodidit
+    end
+
+    protected
+
+    # Returns the user who is responsible for any changes that occur.
+    # By default this calls `current_user` and returns the result.
+    # 
+    # Override this method in your controller to call a different
+    # method, e.g. `current_login_user`, or anything.
+    def user_for_change_log
+      current_user rescue nil
+    end
+
+    private
+
+    # Tells ChangeLog who is responsible for any changes.
+    def set_change_log_whodidit
+      ::ChangeLog.whodidit = user_for_change_log
+    end
+
+  end
+end
+
+ActionController::Base.send :include, ChangeLog::Controller

data/lib/change_log/has_change_log.rb

@@ -0,0 +1,99 @@
+module ChangeLog
+  module Model
+
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+
+    module ClassMethods
+      # Declare this in your model to keep a change log for every create, update, and destroy.
+      #
+      # Options:
+      # :ignore    an array of attributes will be ingored when saving changes into change log.
+      def enable_change_log(options = {})
+        send :include, InstanceMethods
+
+        cattr_accessor :ignore, :whodidit
+        self.ignore = (options[:ignore] || []).map &:to_s
+
+        # Indicates whether or not ChangeLog is active for this class.
+        # This is independent of whether ChangeLog is globally enabled or disabled.
+        cattr_accessor :change_log_active
+        self.change_log_active = true
+
+        after_create  :record_create
+        before_update :record_update
+        after_destroy :record_destroy
+      end
+
+      # Switches ChangeLog off for this class.
+      def change_log_off
+        self.change_log_active = false
+      end
+
+      # Switches ChangeLog on for this class.
+      def change_log_on
+        self.change_log_active = true
+      end
+    end
+
+    # Wrap the following methods in a module so we can include them only in the
+    # ActiveRecord models that declare `enable_change_log`.
+    module InstanceMethods
+      def record_create
+        # do nothing if the change log is not turned on
+        return '' unless switched_on?
+        # saving changes to maintenance 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)
+          end
+        end  
+  	  end
+
+      def record_update
+        # do nothing if the change log is not turned on and no changes has been made
+        return '' unless switched_on? && self.valid? && self.changed?
+
+        self.changes.each do |attribute_name,value|
+          # 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)
+          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)})
+      end
+
+      # Return a list of maintenance 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")
+      end
+
+      # Return `true` if current record has a list of maintenance 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
+      end
+
+      private
+
+      # Returns `true` if ChangeLog is globally enabled and active for this class,
+      # `false` otherwise.
+      def switched_on?
+        ChangeLog.enabled? && self.class.change_log_active
+      end    
+    end
+
+  end
+end
+
+ActiveRecord::Base.send :include, ChangeLog::Model

data/lib/change_log/maintenance.rb

@@ -0,0 +1,30 @@
+class Maintenance < 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)
+    record.field_type = get_field_type(option[:table_name],option[:attribute_name]) unless option[:action].eql?('DELETE')
+    record.created_at = Time.now
+    record.save
+  end
+
+  # return the lastest 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])
+    return latest_version.nil? ? 1 : latest_version.next
+  end
+
+  def self.get_field_type(table_name,field_name)
+    return 'Error' if table_name.blank?||field_name.blank?
+    ActiveRecord::Base.connection.columns(table_name).each do |field|
+      return field.sql_type if field.name.eql?(field_name)
+    end
+  rescue
+    return 'Error'
+  end
+
+end

data/lib/change_log/version.rb

@@ -1,3 +1,3 @@
 module ChangeLog
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: change_log
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Peter Zhang
@@ -42,11 +42,18 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .change_log.gemspec.un~
 - .gitignore
 - Gemfile
+- MIT-LICENSE
+- README
 - Rakefile
 - change_log.gemspec
 - lib/change_log.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