pg_audit_log 0.0.1 → 0.0.2

data/lib/generators/pg_audit_log/install_generator.rb

@@ -1,11 +1,18 @@
+require "rails/generators/active_record"
+
 module PgAuditLog
   module Generators
     class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      extend ActiveRecord::Generators::Migration
+
       source_root File.expand_path('../templates', __FILE__)
 
       def install
         directory "lib/tasks"
+        migration_template "migration.rb", "db/migrate/install_pg_audit_log"
       end
+
     end
   end
 end

data/lib/generators/pg_audit_log/rspec_generator.rb

@@ -5,7 +5,6 @@ module PgAuditLog
 
       def install
         directory "spec/models"
-        copy_file "spec/models/pg_audit_log_spec.rb", "spec/models/pg_audit_log_spec.rb"
       end
     end
   end

data/lib/generators/pg_audit_log/templates/lib/tasks/pg_audit_log.rake

@@ -1,76 +1,36 @@
 namespace :pg_audit_log do
-  IGNORED_TABLES = ["plugin_schema_migrations", "sessions", "schema_migrations"]
-
   desc "Install audit_log triggers on all tables"
   task :install => :environment do
-    unless all_tables.include?(PgAuditLog::Entry.table_name)
+    unless PgAuditLog::Entry.installed?
       puts "Creating #{PgAuditLog::Entry.table_name} table..."
-      sql = File.read(File.join(sql_path, "create_audit_log_table.sql"))
-      connection.execute_without_auditing(sql)
+      PgAuditLog::Entry.install
     end
+
     puts "Installing audit_changes() function..."
-    sql = File.read(File.join(sql_path, "create_audit_changes.sql"))
-    connection.execute_without_auditing(sql)
+    PgAuditLog::Function.install
 
     puts "Installing all audit log triggers... "
-    run_on(audit_log_tables) do |table|
-      <<-SQL
-        CREATE TRIGGER audit_#{table}
-        AFTER INSERT OR UPDATE OR DELETE
-        ON #{table}
-        FOR EACH ROW
-          EXECUTE PROCEDURE audit_changes()
-      SQL
-    end
-    puts "Exporting development_structure.sql..."
-    Rake::Task["db:structure:dump"].reenable
-    Rake::Task["db:structure:dump"].invoke
+    PgAuditLog::Triggers.install
+
+    export_development_structure
   end
 
   desc "Uninstall audit log triggers on all tables"
   task :uninstall => :environment do
     puts "Dropping all audit_log triggers... "
-    run_on(audit_log_tables) do |table|
-      "DROP TRIGGER audit_#{table} ON #{table};"
-    end
+    PgAuditLog::Triggers.uninstall
+
     puts "Uninstalling audit_changes() function..."
-    sql = File.read(File.join(sql_path, "uninstall_audit_changes.sql"))
-    connection.execute_without_auditing(sql)
+    PgAuditLog::Function.uninstall
 
-    puts "Exporting development_structure.sql..."
-    Rake::Task["db:structure:dump"].reenable
-    Rake::Task["db:structure:dump"].invoke
+    export_development_structure
   end
 
   private
 
-  def connection
-    ActiveRecord::Base.connection
-  end
-
-  def all_tables
-    connection.tables
-  end
-
-  def audit_log_tables
-    all_tables - (IGNORED_TABLES + [PgAuditLog::Entry.table_name])
-  end
-
-  def sql_path
-    Rails.root.join("lib/tasks/pg_audit_log")
-  end
-
-  def run_on(tables, &block)
-    tables.sort.each do |table|
-      puts "* #{table}"
-      sql = yield(table)
-      begin
-        connection.execute_without_auditing(sql)
-      rescue => e
-        puts e.to_s
-        connection.reconnect!
-      end
-    end
+  def export_development_structure
+    puts "Exporting development_structure.sql..."
+    Rake::Task["db:structure:dump"].reenable
+    Rake::Task["db:structure:dump"].invoke
   end
-
 end

data/lib/generators/pg_audit_log/templates/migration.rb

@@ -0,0 +1,15 @@
+class InstallPgAuditLog < ActiveRecord::Migration
+
+  def self.up
+    PgAuditLog::Entry.install
+    PgAuditLog::Function.install
+    PgAuditLog::Triggers.install
+  end
+
+  def self.down
+    PgAuditLog::Triggers.uninstall
+    PgAuditLog::Function.uninstall
+    PgAuditLog::Entry.uninstall
+  end
+end
+

data/lib/pg_audit_log.rb

@@ -1,8 +1,12 @@
 module PgAuditLog
+  IGNORED_TABLES = ["plugin_schema_migrations", "sessions", "schema_migrations"]
 end
 
 require "active_record"
 require "pg_audit_log/version"
 require "pg_audit_log/extensions/postgresql_adapter.rb"
+require "pg_audit_log/active_record"
 require "pg_audit_log/entry"
+require "pg_audit_log/function"
+require "pg_audit_log/triggers"
 

data/lib/pg_audit_log/active_record.rb

@@ -0,0 +1,15 @@
+module PgAuditLog
+  class ActiveRecord
+    class << self
+      private
+
+      def connection
+        ::ActiveRecord::Base.connection
+      end
+
+      def execute(sql)
+        connection.execute_without_auditing(sql)
+      end
+    end
+  end
+end

data/lib/pg_audit_log/entry.rb

@@ -1,16 +1,50 @@
 class PgAuditLog::Entry < ActiveRecord::Base
+  TABLE_NAME = "audit_log"
+  set_table_name TABLE_NAME
+
   class CannotDeleteError < StandardError
     def message
       "Audit Logs cannot be deleted!"
     end
   end
-  set_table_name :audit_log
 
   before_destroy do
     raise CannotDeleteError
   end
 
   class << self
+    def installed?
+      connection.tables.include?(self.table_name)
+    end
+
+    def install
+      sql = <<-SQL
+        CREATE SEQUENCE #{self.table_name}_id_seq
+            START WITH 1
+            INCREMENT BY 1;
+
+        CREATE TABLE #{self.table_name} (
+            id integer PRIMARY KEY DEFAULT nextval('#{self.table_name}_id_seq'),
+            user_id integer,
+            user_unique_name character varying(255),
+            operation character varying(255),
+            table_name character varying(255),
+            field_name character varying(255),
+            field_value_new text,
+            field_value_old text,
+            occurred_at timestamp without time zone,
+            primary_key character varying(255)
+        );
+
+        ALTER SEQUENCE #{self.table_name}_id_seq OWNED BY #{self.table_name}.id;
+      SQL
+      connection.execute_without_auditing(sql)
+    end
+
+    def uninstall
+      connection.execute("DROP TABLE IF EXISTS #{self.table_name}")
+    end
+
     def delete(id)
       raise CannotDeleteError
     end
@@ -20,4 +54,4 @@ class PgAuditLog::Entry < ActiveRecord::Base
     end
   end
 
-end
+end

data/lib/{generators/pg_audit_log/templates/lib/tasks/pg_audit_log/create_audit_changes.sql → pg_audit_log/function.rb}

@@ -1,7 +1,12 @@
-CREATE OR REPLACE PROCEDURAL LANGUAGE plpgsql;
-CREATE OR REPLACE FUNCTION audit_changes() RETURNS trigger
-    LANGUAGE plpgsql
-    AS $_$
+module PgAuditLog
+  class Function < ActiveRecord
+    class << self
+      def install
+        execute <<-SQL
+        CREATE OR REPLACE PROCEDURAL LANGUAGE plpgsql;
+        CREATE OR REPLACE FUNCTION audit_changes() RETURNS trigger
+        LANGUAGE plpgsql
+        AS $_$
             DECLARE
               col information_schema.columns %ROWTYPE;
               new_value text;
@@ -70,3 +75,12 @@ CREATE OR REPLACE FUNCTION audit_changes() RETURNS trigger
               RETURN NULL;
             END
             $_$;
+        SQL
+      end
+
+      def uninstall
+        execute "DROP FUNCTION audit_changes()"
+      end
+    end
+  end
+end

data/lib/pg_audit_log/triggers.rb

@@ -0,0 +1,36 @@
+module PgAuditLog
+  class Triggers < ActiveRecord
+    class << self
+      def tables
+        connection.tables - (PgAuditLog::IGNORED_TABLES + [PgAuditLog::Entry.table_name])
+      end
+
+      def install
+        tables.each do |table|
+          create_for_table(table)
+        end
+      end
+
+      def uninstall
+        tables.each do |table|
+          drop_for_table(table)
+        end
+      end
+
+      def create_for_table(table_name)
+        execute <<-SQL
+        CREATE TRIGGER audit_#{table_name}
+        AFTER INSERT OR UPDATE OR DELETE
+        ON #{table_name}
+        FOR EACH ROW
+        EXECUTE PROCEDURE audit_changes()
+        SQL
+      end
+
+      def drop_for_table(table_name)
+        execute "DROP TRIGGER audit_#{table_name} ON #{table_name};"
+      end
+
+    end
+  end
+end

data/lib/pg_audit_log/version.rb

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

data/spec/spec_helper.rb

@@ -18,20 +18,9 @@ rescue PGError => e
   raise e
 end
 
-connection.execute("DROP TABLE IF EXISTS audit_log")
-
-sql_path = File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "generators", "pg_audit_log", "templates", "lib", "tasks", "pg_audit_log"))
-
-["create_audit_changes.sql", "create_audit_log_table.sql"].each do |sql_file|
-  begin
-    connection.execute File.read(File.join(sql_path, sql_file))
-  rescue => e
-    puts "-" * 80
-    puts "Unable to install #{sql_file}"
-    puts "-" * 80
-    raise e
-  end
-end
+PgAuditLog::Entry.uninstall
+PgAuditLog::Entry.install
+PgAuditLog::Function.install
 
 RSpec.configure do |config|
   config.mock_with :rspec

metadata

@@ -2,7 +2,7 @@
 name: pg_audit_log
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Case Commons, LLC
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-28 00:00:00 -04:00
+date: 2011-03-29 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,14 +66,15 @@ files:
 - lib/generators/pg_audit_log/install_generator.rb
 - lib/generators/pg_audit_log/rspec_generator.rb
 - lib/generators/pg_audit_log/templates/lib/tasks/pg_audit_log.rake
-- lib/generators/pg_audit_log/templates/lib/tasks/pg_audit_log/create_audit_changes.sql
-- lib/generators/pg_audit_log/templates/lib/tasks/pg_audit_log/create_audit_log_table.sql
-- lib/generators/pg_audit_log/templates/lib/tasks/pg_audit_log/uninstall_audit_changes.sql
+- lib/generators/pg_audit_log/templates/migration.rb
 - lib/generators/pg_audit_log/templates/spec/models/pg_audit_log_spec.rb
 - lib/generators/pg_audit_log/templates/spec/models/pg_audit_log_spec_helper.rb
 - lib/pg_audit_log.rb
+- lib/pg_audit_log/active_record.rb
 - lib/pg_audit_log/entry.rb
 - lib/pg_audit_log/extensions/postgresql_adapter.rb
+- lib/pg_audit_log/function.rb
+- lib/pg_audit_log/triggers.rb
 - lib/pg_audit_log/version.rb
 - pg_audit_log.gemspec
 - spec/configuration_spec.rb

data/lib/generators/pg_audit_log/templates/lib/tasks/pg_audit_log/create_audit_log_table.sql

@@ -1,18 +0,0 @@
-CREATE SEQUENCE audit_log_id_seq
-    START WITH 1
-    INCREMENT BY 1;
-
-CREATE TABLE audit_log (
-    id integer PRIMARY KEY DEFAULT nextval('audit_log_id_seq'),
-    user_id integer,
-    user_unique_name character varying(255),
-    operation character varying(255),
-    table_name character varying(255),
-    field_name character varying(255),
-    field_value_new text,
-    field_value_old text,
-    occurred_at timestamp without time zone,
-    primary_key character varying(255)
-);
-
-ALTER SEQUENCE audit_log_id_seq OWNED BY audit_log.id;

data/lib/generators/pg_audit_log/templates/lib/tasks/pg_audit_log/uninstall_audit_changes.sql

@@ -1 +0,0 @@
-DROP FUNCTION audit_changes();