log_table 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a3bac03cb5e151d6994bfbcddcf876d6d1ff4bb
-  data.tar.gz: d8197dba004608c3f58e82f2ad2254dd33f9666e
+  metadata.gz: 52f146085c33b699a9ad2c599635622ba24e69b0
+  data.tar.gz: 626da3f952be97c2775b8c18c636f240ac0f81d8
 SHA512:
-  metadata.gz: 8533007d4d2f356397df004ddfadca193bf83112878d4f889f5e374ba0dcd09d6cc87aa5c2b0ad08b9822d0d2d25eddce640cef12df126ee4a63a13dad55b6a9
-  data.tar.gz: e1b55ac03f7fa8d1353e10bc4cf3957777b034d4a3e17bf26997b271d9daff8a7bd469a28430d7c6e725c40686b429df326e593006c86663c4410e8ca4d965c5
+  metadata.gz: 504e87d8d33ae8aef765ea177d17042d6adfecf27eaa70aa6f2b9225a88f042dc091a987ccab5301cca16de5a490bb1dea1792bb9316d0c1867cf86ed0c50c99
+  data.tar.gz: 2c3c1243bfade52c08909425cf20c23dd1fa1ebba2f0fed6f5891f87c69ded6c1ec6add55d6e1951180d39567f766b486f66e169323cbf94e1bcaf1ace00d964

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
 rvm:
+  - 1.9.3
+  - 2.1.5
   - 2.2.3
 before_install: gem install bundler -v 1.10.6

data/README.md

@@ -1,5 +1,7 @@
 # LogTable
 
+[<img src="https://secure.travis-ci.org/diskshima/log_table.png?branch=master" />](http://travis-ci.org/diskshima/log_table)
+
 The LogTable gem will read your Active Record model and generate a  table to store logs to.
 It will additionally create triggers which will do the actual saving into the log table.
 
@@ -21,7 +23,12 @@ Or install it yourself as:
 
 ## Usage
 
-WIP
+After installing the gem, you will need to run the below two Rake tasks
+
+    $ bundle exec rake db:generate_log_table_migration MODEL=MODEL1,MODEL2,...
+    $ bundle exec rake db:generate_log_trigger_migration MODEL=MODEL1,MODEL2,...
+
+The first will generate a migration which will generate the log tables and the second will generate a migration for the triggers.
 
 ## Contributing
 

data/TODO.md

@@ -0,0 +1,5 @@
+# TODO
+
+- [x] Add comments for generated code
+- [x] Ability to log on delete
+- [ ] Migrations when columns are added (NOTE: not when deleted. We do not want to delete a column from the log table even if the original does not have it anymore)

data/lib/log_table/version.rb

@@ -1,3 +1,3 @@
 module LogTable
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/log_table.rb

@@ -9,6 +9,31 @@ require 'log_table/version'
 require 'hairtrigger'
 
 module LogTable
+  module LogStatus
+    STATUS_COLUMN_NAME = 'log_table_status'
+    INSERTED = 'inserted'
+    UPDATED = 'updated'
+    DELETED = 'deleted'
+
+    def self.sql_func(status, model_name, column_names, table_name, options)
+      col_names = column_names
+
+      db_columns = [STATUS_COLUMN_NAME] + col_names.map { |col_name|
+          col_name == 'id' ? "#{model_name.underscore}_id" : "#{col_name}"
+        }
+
+      db_columns_str = db_columns.join(', ')
+
+      values = (["\"#{status}\""] + col_names.map { |col| "NEW.#{col}" }).join(', ')
+
+      log_table_name = options[:table_name] || "#{table_name}_log"
+
+      sql = "INSERT INTO #{log_table_name}(#{db_columns_str}) VALUES (#{values})"
+
+      sql
+    end
+  end
+
   def self.included(base)
     base.send :extend, ClassMethods
   end
@@ -23,24 +48,20 @@ module LogTable
     # - :table_name - Specify table name of the log table.
     #
     def add_log_trigger(options = {})
-      col_names = column_names
-
-      db_columns = col_names.map { |col_name|
-        col_name == 'id' ? "#{name.underscore}_id" : "#{col_name}"
-      }.join(', ')
-
-      values = col_names.map { |col| "NEW.#{col}" }.join(', ')
-
-      log_table_name = options[:table_name] || "#{table_name}_log"
-
-      insert_sql = "INSERT INTO #{log_table_name}(#{db_columns}) VALUES (#{values})"
 
       trigger.after(:insert) do
-        insert_sql
+        LogStatus.sql_func(LogStatus::INSERTED, name, column_names, table_name,
+          options)
       end
 
       trigger.after(:update) do
-        insert_sql
+        LogStatus.sql_func(LogStatus::UPDATED, name, column_names, table_name,
+          options)
+      end
+
+      trigger.after(:delete) do
+        LogStatus.sql_func(LogStatus::DELETED, name, column_names, table_name,
+          options)
       end
     end
   end

data/lib/tasks/db/templates/create_log_table.erb

@@ -1,3 +1,5 @@
+# Generated by log_table.
+
 class <%= migration_class_name %> < ActiveRecord::Migration
   def change
 <% tables.each do |table| %>

data/log_table.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'minitest', '~> 5.8'
   spec.add_development_dependency 'm', '~> 1.4'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: log_table
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Daisuke Shimamoto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-01 00:00:00.000000000 Z
+date: 2015-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hairtrigger
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: log_table creates a log table for the given Active Record model and triggers
   to write into it.
 email:
@@ -95,6 +109,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - bin/console
 - bin/setup
 - lib/log_table.rb