change_log 1.0.0 → 1.0.1

data/README.textile

@@ -1,9 +1,9 @@
 h1. Change Log
 
-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.
+A gem to keep all changes about the data in database.
+It automatically saves who made the changes at what time and what has been changed.
+You can choose to skip the column which you do not want to keep change logs.
+For example: 'updated_at', 'created_at' and 'password' etc.
 
 
 h2. Install Change Log Gem
@@ -28,14 +28,14 @@ Then:
         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 changes
+3. Create a table to keep all changes
 
-    Generate a migration file
+    Generate a migration file similar to this:
 
 <pre><code>
     class AddChangeLog < ActiveRecord::Migration
       def self.up
-        create_table :change_logs do |t|
+        create_table :change_logs do |t|       # feel free to choose another table name
          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 
@@ -58,7 +58,7 @@ h2. Create a table to keep all changes
 Then:
 <pre><code>rake db:migrate</code></pre> 
 
-h2. Use Change Log
+h2. Use Change Log Gem
 
     1. *Add current_user Method in application_controller.rb*
 
@@ -70,7 +70,7 @@ end
 </code></pre>
 
     2. *ActiveRecord Models*
-If you want to enable change_log for any ActiveRecord Model, 
+Enable change_log for Active Record Model, 
 just put following line in very beginning of model file.
 <pre><code>
 enable_change_log :ignore=>[:updated_at]    
@@ -79,6 +79,27 @@ enable_change_log :ignore=>[:updated_at]
 Put any columns you do not want to keep in the change log table in :ignore option.
 eg. the password hash
 
+Then the system should record every changes the user made to change_log table.
+If you are making changes within Model file:
+    For Example: 
+<pre><code># this is a model file
+def making_some_changes
+  user = User.find(:first)
+  user.email = 'peterz@ncs.co.nz'
+  user.save
+end
+</code></pre>
+
+An attribute called 'whodidit' is automatically available.
+So if you want to keep the changes in this scenario, do following:
+<pre><code># this is a model file
+def making_some_changes
+  user = User.find(:first)
+  user.email = 'peterz@ncs.co.nz'
+  user.whodidit = 'Peter'
+  user.save
+end
+</code></pre>
 
     3.  *About the ChangeLogs Model*
 ChangeLogs model is core ActiveRecord model used by change_log gem.
@@ -105,9 +126,8 @@ ChangeLogs.find(:all,:conditions=>['table_name = ?', 'accounts'])</code></pre>
 ChangeLogs.set_table_name('hr_maintenances')
 </code></pre>
 
-h2. Testing
-
-    TODO
+h2. Wish List
+    Please email me if you have any enquiry.
 
 
 h3. Author
@@ -116,4 +136,4 @@ h3. Author
 Peter Zhang at NCS New Zealand.
 Email: peterz@ncs.co.nz
 
-Copyright (c) 2011 Peter Zhang, released under the MIT license
+Copyright (c) 2011 Peter Zhang and NCS LTD, released under the MIT license

data/change_log.gemspec

@@ -9,10 +9,9 @@ Gem::Specification.new do |s|
   s.authors     = ["Peter Zhang"]
   s.email       = ["peterz@ncs.co.nz"]
   s.homepage    = "http://www.ncs.co.nz"
-  s.summary     = %q{Change log gem record every changes for the model}
-  s.description = %q{A gem for tracking who did what changes and when it happened -- keeps all the maintenance logs}
+  s.summary     = %q{Change log gem records every changes for the active record model}
+  s.description = %q{A gem for tracking who did what and when it happened -- keeps all the changes done by user into a maintenance log}
 
-  s.add_development_dependency "rspec"
   s.rubyforge_project = "change_log"
 
   s.files         = `git ls-files`.split("\n")

data/lib/change_log/version.rb

@@ -1,3 +1,3 @@
 module ChangeLog
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/test/boot.rb

@@ -0,0 +1,21 @@
+plugin_root = File.join(File.dirname(__FILE__), '..')
+version = ENV['RAILS_VERSION']
+version = nil if version and version == ""
+
+# first look for a symlink to a copy of the framework
+if !version and framework_root = ["#{plugin_root}/rails", "#{plugin_root}/../../rails"].find { |p| File.directory? p }
+  puts "found framework root: #{framework_root}"
+  # this allows for a plugin to be tested outside of an app and without Rails gems
+  $:.unshift "#{framework_root}/activesupport/lib", "#{framework_root}/activerecord/lib", "#{framework_root}/actionpack/lib"
+else
+  # simply use installed gems if available
+  puts "using Rails#{version ? ' ' + version : nil} gems"
+  require 'rubygems'
+  
+  if version
+    gem 'rails', version
+  else
+    gem 'actionpack', '< 3.0.0.a'
+    gem 'activerecord', '< 3.0.0.a'
+  end
+end

data/test/change_log_test.rb

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'test/unit'
+require 'lib/activerecord_test_case'
+require 'action_controller'
+require 'change_log'
+
+class ChangeLogTest < ActiveRecordTestCase
+  fixtures :change_logs
+
+  # insert an new record
+  # then check the total number
+  def test_update_change_log_record_with
+    option = {:action=>'INSERT', :record_id=>3,:table_name=>'test', :user=>'test',:attribute_name=>'test',:new_value=>'50',:version=>1}
+    assert_equal true, ChangeLogs.update_change_log_record_with(option) 
+    assert_equal 3, ChangeLogs.count()
+  end
+
+  # it should pick up the largest version number from fixture file
+  def test_get_version_number
+    assert_equal 3, ChangeLogs.get_version_number(1,'test')
+  end
+
+  # it will get the type of field from the table
+  def test_get_field_type
+    assert_equal 'integer', ChangeLogs.get_field_type('test','total')
+  end
+
+  # some logic test
+  def test_change_log_logic
+      # find a test, update the total
+      version_number = ChangeLogs.get_version_number(1,'test')
+      option = {:action=>'UPDATE', :record_id=>1,:table_name=>'test', :user=>'peterz',:attribute_name=>'test',:new_value=>'999',:old_value=>'100',:version=>version_number}
+      assert_equal true, ChangeLogs.update_change_log_record_with(option)
+      change_log = ChangeLogs.find(version_number)
+      assert_equal 'peterz',change_log.user
+      assert_equal '999', change_log.new_value
+      assert_equal '100', change_log.old_value
+  end
+end

data/test/database.yml

@@ -0,0 +1,22 @@
+sqlite3:
+  database: ":memory:"
+  adapter: sqlite3
+  timeout: 500
+
+sqlite2:
+  database: ":memory:"
+  adapter: sqlite2
+
+mysql:
+  adapter: mysql
+  username: root
+  password: 
+  encoding: utf8
+  database: will_paginate_unittest
+
+postgres:
+  adapter: postgresql
+  username: mislav
+  password: 
+  database: will_paginate_unittest
+  min_messages: warning

data/test/fixtures/change_logs.yml

@@ -0,0 +1,24 @@
+log_1:
+  id: 1
+  version: 1
+  record_id: 1
+  table_name: test
+  field_type: int
+  action: 'INSERT'
+  attribute_name: total
+  user: tester
+  old_value: 10
+  new_value: 100
+log_2:
+  id: 2
+  version: 2
+  record_id: 1
+  table_name: test
+  field_type: int
+  action: 'INSERT'
+  attribute_name: total
+  user: tester
+  old_value: 100
+  new_value: 1
+
+

data/test/fixtures/schema.rb

@@ -0,0 +1,24 @@
+ActiveRecord::Schema.define do
+
+  create_table "test" do |t|
+    t.column "total",     :integer
+    t.column "created_at", :datetime
+    t.column "updated_at", :datetime
+  end
+
+
+  create_table "change_logs"  do |t|
+    t.column "id", :integer, :null => false
+    t.column "version",   :integer, :null => false
+    t.column "record_id",   :integer
+    t.column "table_name", :string
+    t.column "field_type", :string
+    t.column "attribute_name", :string
+    t.column "action", :string
+    t.column "user", :string
+    t.column "old_value", :string
+    t.column "new_value", :string
+    t.timestamps
+  end
+
+end

data/test/fixtures/test.rb

@@ -0,0 +1,3 @@
+class Test < ActiveRecord::Base
+  enable_change_log
+end

data/test/lib/activerecord_test_case.rb

@@ -0,0 +1,43 @@
+require 'lib/activerecord_test_connector'
+
+class ActiveRecordTestCase < Test::Unit::TestCase
+  if defined?(ActiveSupport::Testing::SetupAndTeardown)
+    include ActiveSupport::Testing::SetupAndTeardown
+  end
+
+  if defined?(ActiveRecord::TestFixtures)
+    include ActiveRecord::TestFixtures
+  end
+  # Set our fixture path
+  if ActiveRecordTestConnector.able_to_connect
+    self.fixture_path = File.join(File.dirname(__FILE__), '..', 'fixtures')
+    self.use_transactional_fixtures = true
+  end
+
+  def self.fixtures(*args)
+    super if ActiveRecordTestConnector.connected
+  end
+
+  def run(*args)
+    super if ActiveRecordTestConnector.connected
+  end
+
+  # Default so Test::Unit::TestCase doesn't complain
+  def test_truth
+  end
+
+  protected
+
+    def assert_queries(num = 1)
+      $query_count = 0
+      yield
+    ensure
+      assert_equal num, $query_count, "#{$query_count} instead of #{num} queries were executed."
+    end
+
+    def assert_no_queries(&block)
+      assert_queries(0, &block)
+    end
+end
+
+ActiveRecordTestConnector.setup

data/test/lib/activerecord_test_connector.rb

@@ -0,0 +1,76 @@
+require 'active_record'
+require 'active_record/version'
+require 'active_record/fixtures'
+
+class ActiveRecordTestConnector
+  cattr_accessor :able_to_connect
+  cattr_accessor :connected
+
+  FIXTURES_PATH = File.join(File.dirname(__FILE__), '..', 'fixtures')
+
+  # Set our defaults
+  self.connected = false
+  self.able_to_connect = true
+
+  def self.setup
+    unless self.connected || !self.able_to_connect
+      setup_connection
+      load_schema
+      add_load_path FIXTURES_PATH
+      self.connected = true
+    end
+  rescue Exception => e  # errors from ActiveRecord setup
+    $stderr.puts "\nSkipping ActiveRecord tests: #{e}\n\n"
+    self.able_to_connect = false
+  end
+
+  private
+  
+  def self.add_load_path(path)
+    dep = defined?(ActiveSupport::Dependencies) ? ActiveSupport::Dependencies : ::Dependencies
+    autoload_paths = dep.respond_to?(:autoload_paths) ? dep.autoload_paths : dep.load_paths
+    autoload_paths.unshift path
+  end
+
+  def self.setup_connection
+    db = ENV['DB'].blank?? 'sqlite3' : ENV['DB']
+    
+    configurations = YAML.load_file(File.join(File.dirname(__FILE__), '..', 'database.yml'))
+    raise "no configuration for '#{db}'" unless configurations.key? db
+    configuration = configurations[db]
+    
+    ActiveRecord::Base.logger = Logger.new(STDOUT) if $0 == 'irb'
+    puts "using #{configuration['adapter']} adapter" unless ENV['DB'].blank?
+    
+    gem 'sqlite3-ruby' if 'sqlite3' == db
+    
+    ActiveRecord::Base.establish_connection(configuration)
+    ActiveRecord::Base.configurations = { db => configuration }
+    prepare ActiveRecord::Base.connection
+
+    unless Object.const_defined?(:QUOTED_TYPE)
+      Object.send :const_set, :QUOTED_TYPE, ActiveRecord::Base.connection.quote_column_name('type')
+    end
+  end
+
+  def self.load_schema
+    ActiveRecord::Base.silence do
+      ActiveRecord::Migration.verbose = false
+      load File.join(FIXTURES_PATH, 'schema.rb')
+    end
+  end
+
+  def self.prepare(conn)
+    class << conn
+      IGNORED_SQL = [/^PRAGMA/, /^SELECT currval/, /^SELECT CAST/, /^SELECT @@IDENTITY/, /^SELECT @@ROWCOUNT/, /^SHOW FIELDS /]
+
+      def execute_with_counting(sql, name = nil, &block)
+        $query_count ||= 0
+        $query_count  += 1 unless IGNORED_SQL.any? { |r| sql =~ r }
+        execute_without_counting(sql, name, &block)
+      end
+
+      alias_method_chain :execute, :counting
+    end
+  end
+end

data/test/lib/load_fixtures.rb

@@ -0,0 +1,8 @@
+require 'boot'
+require 'lib/activerecord_test_connector'
+
+# setup the connection
+ActiveRecordTestConnector.setup
+
+# load all fixtures
+Fixtures.create_fixtures(ActiveRecordTestConnector::FIXTURES_PATH, ActiveRecord::Base.connection.tables)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: change_log
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Peter Zhang
@@ -15,24 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-20 00:00:00 +13:00
+date: 2011-01-25 00:00:00 +13:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id001
-description: A gem for tracking who did what changes and when it happened -- keeps all the maintenance logs
+dependencies: []
+
+description: A gem for tracking who did what and when it happened -- keeps all the changes done by user into a maintenance log
 email: 
 - peterz@ncs.co.nz
 executables: []
@@ -53,6 +40,15 @@ files:
 - lib/change_log/controller.rb
 - lib/change_log/has_change_log.rb
 - lib/change_log/version.rb
+- test/boot.rb
+- test/change_log_test.rb
+- test/database.yml
+- test/fixtures/change_logs.yml
+- test/fixtures/schema.rb
+- test/fixtures/test.rb
+- test/lib/activerecord_test_case.rb
+- test/lib/activerecord_test_connector.rb
+- test/lib/load_fixtures.rb
 has_rdoc: true
 homepage: http://www.ncs.co.nz
 licenses: []
@@ -86,6 +82,14 @@ rubyforge_project: change_log
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Change log gem record every changes for the model
-test_files: []
-
+summary: Change log gem records every changes for the active record model
+test_files: 
+- test/boot.rb
+- test/change_log_test.rb
+- test/database.yml
+- test/fixtures/change_logs.yml
+- test/fixtures/schema.rb
+- test/fixtures/test.rb
+- test/lib/activerecord_test_case.rb
+- test/lib/activerecord_test_connector.rb
+- test/lib/load_fixtures.rb