change_log 0.0.3 → 0.0.4

data/README.textile

@@ -0,0 +1,82 @@
+h1. Change Log
+
+A gem to keep all maintenances in database
+
+
+h2. Install Change Log Gem
+
+1. by command:
+<pre><code># gem install change_log</code></pre>
+
+2. or by bundler
+<pre><code># Gemfile in your application
+gem 'change_log'
+</code></pre>
+
+Then:
+<pre><code>bundle install</code></pre>
+
+h2. Create a table to keep all maintenance logs
+
+    Generate a migration file
+
+<pre><code>
+    class AddChangeLog < ActiveRecord::Migration
+      def self.up
+        create_table :change_logs 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, :limit=>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_logs
+      end
+    end
+</code></pre>
+
+Then:
+<pre><code>rake db:migrate</code></pre>
+
+h2. Use Change Log
+
+    1. Include change_log in environment.rb
+<pre><code>require 'change_log'</code></pre>
+
+    2. Add current_user method in application_controller.rb 
+<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
+end
+</code></pre>
+
+    3. Models
+<pre><code>
+enable_change_log :ignore=>[:updated_at]    
+</code></pre>
+
+Put any columns you do not want to keep in the change log table in :ignore option.
+eg. the password hash
+
+
+h2. Testing
+
+    TODO
+
+
+h3. 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/version.rb

@@ -1,3 +1,3 @@
 module ChangeLog
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: change_log
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Peter Zhang
@@ -42,9 +42,9 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- .gitignore
 - Gemfile
 - MIT-LICENSE
+- README.textile
 - Rakefile
 - change_log.gemspec
 - lib/change_log.rb

data/.gitignore

@@ -1,4 +0,0 @@
-pkg/*
-*.gem
-.bundle
-Gemfile.lock