mcfly 0.0.4 → 0.0.5

data/README.md

@@ -89,9 +89,14 @@ TODO: discuss using `current_user` method in `ApplicationController`. Also, sett
 
 TODO
 
-## Limitations
+## Limitations/Requirements
 
-Currently, Mcfly only works with PostgreSQL databases.
+Currently, Mcfly only works with PostgreSQL databases. The following
+line must be added to the `postgresql.conf` file.  Mcfly uses the
+PostgreSQL session variable `mcfly.whodunnit` to store the current
+user id.
+
+    custom_variable_classes = 'mcfly'
 
 ## History
 

data/lib/mcfly.rb

@@ -12,6 +12,9 @@ module Mcfly
   # with models directly.
   def self.whodunnit=(value)
     mcfly_store[:whodunnit] = value
+
+    sval = value.try(:id) || -1
+    ActiveRecord::Base.connection.execute("SET mcfly.whodunnit = #{sval};")
   end
 
   def self.whodunnit

data/lib/mcfly/delete_trig.sql

@@ -2,12 +2,18 @@ CREATE OR REPLACE FUNCTION "%{table}_delete" ()
   RETURNS TRIGGER
 AS $$
 
+DECLARE
+  whodunnit int;
+
 BEGIN
   IF OLD.obsoleted_dt <> 'infinity' THEN
      RAISE EXCEPTION 'can not delete old row version';
   END IF;
 
-  UPDATE "%{table}" SET "obsoleted_dt" = 'now()' WHERE id = OLD.id;
+  SHOW mcfly.whodunnit INTO whodunnit;
+
+  UPDATE "%{table}"
+  SET "obsoleted_dt" = 'now()', "o_user_id" = whodunnit WHERE id = OLD.id;
 
   RETURN NULL; -- the row is not actually deleted
 END;

data/lib/mcfly/has_mcfly.rb

@@ -32,11 +32,14 @@ module McFly
         # obsoleted_dt.
 
         send :include, InstanceMethods
-        after_initialize :record_init
+        before_validation :record_validation
+
         # FIXME: :created_dt should also be readonly.  However, we set
         # it for debugging purposes.  Should consider making this
-        # readonly once we're in production.
-        attr_readonly :group_id, :obsoleted_dt, :user_id
+        # readonly once we're in production.  Also, :user_id should be
+        # read-only.  We should only set whodunnit and let PostgreSQL
+        # set it.
+        attr_readonly :group_id, :obsoleted_dt, :o_user_id #, :user_id
       end
 
       def mcfly_lookup(name, options = {}, &block)
@@ -78,11 +81,12 @@ module McFly
     end
 
     module InstanceMethods
-      def record_init
-        # Set obsoleted_dt to non NIL to ensure constraints are properly
-        # constructed
-        self.obsoleted_dt = 'infinity' unless self.obsoleted_dt
-        self.user_id ||= Mcfly.whodunnit.try(:id)
+      def record_validation
+        if self.changed?
+          self.user_id = Mcfly.whodunnit.try(:id)
+          self.obsoleted_dt ||= 'infinity'
+        end
+
       end
     end
     

data/lib/mcfly/insert_trig.sql

@@ -25,3 +25,8 @@ $$ LANGUAGE plpgsql;
 DROP TRIGGER IF EXISTS %{table}_insert ON %{table};
 CREATE TRIGGER "%{table}_insert" BEFORE INSERT ON "%{table}" FOR EACH ROW
 EXECUTE PROCEDURE "%{table}_insert"();
+
+-- Add constraint to make sure o_user_id is set iff obsoleted_dt is
+-- not infinity (i.e. object is obsoleted).
+ALTER TABLE "%{table}" ADD CONSTRAINT check_o_user
+CHECK ((obsoleted_dt = 'Infinity') = (o_user_id IS NULL));

data/lib/mcfly/migration.rb

@@ -14,6 +14,7 @@ class McFlyMigration < ActiveRecord::Migration
       t.timestamp :created_dt, null: false
       t.timestamp :obsoleted_dt, null: false
       t.references :user, null: false
+      t.references :o_user
       block.call(t)
     }
 

data/lib/mcfly/update_append_only_trig.sql

@@ -13,6 +13,7 @@ BEGIN
   -- ignored.  This is used by DELETE.
   IF NEW.obsoleted_dt <> 'infinity' THEN
      OLD.obsoleted_dt = NEW.obsoleted_dt;
+     OLD.o_user_id = NEW.o_user_id;
      return OLD;
   END IF;
 

data/lib/mcfly/update_trig.sql

@@ -5,6 +5,7 @@ DECLARE
   rec "%{table}";
   new_id INT4;
   now timestamp;
+  whodunnit int;
 
 BEGIN
   IF OLD.obsoleted_dt <> 'infinity' THEN
@@ -15,6 +16,7 @@ BEGIN
   -- obsoleted.  We return the OLD row so that other field updates are
   -- ignored.  This is used by DELETE.
   IF NEW.obsoleted_dt <> 'infinity' THEN
+     OLD.o_user_id = NEW.o_user_id;
      OLD.obsoleted_dt = NEW.obsoleted_dt;
      return OLD;
   END IF;
@@ -31,7 +33,8 @@ BEGIN
 
   rec.id = new_id;
   rec.group_id = NEW.id;
-  
+  rec.o_user_id = NEW.user_id;
+
   -- FIXME: The following IF/ELSE handles cases where created_dt is
   -- sent in on update. This is only useful for debugging.  Consider
   -- removing the surronding IF (and ELSE part) for production

data/lib/mcfly/version.rb

@@ -1,3 +1,3 @@
 module Mcfly
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/dummy/db/schema.rb

@@ -18,6 +18,7 @@ ActiveRecord::Schema.define(:version => 2) do
     t.datetime "created_dt",             :null => false
     t.datetime "obsoleted_dt",           :null => false
     t.integer  "user_id",                :null => false
+    t.integer  "o_user_id"
     t.integer  "security_instrument_id", :null => false
     t.decimal  "coupon",                 :null => false
     t.integer  "settlement_mm",          :null => false
@@ -30,6 +31,7 @@ ActiveRecord::Schema.define(:version => 2) do
     t.datetime "created_dt",                    :null => false
     t.datetime "obsoleted_dt",                  :null => false
     t.integer  "user_id",                       :null => false
+    t.integer  "o_user_id"
     t.string   "name",                          :null => false
     t.string   "settlement_class", :limit => 1, :null => false
   end

data/spec/model_spec.rb

@@ -182,7 +182,7 @@ describe "Mcfly" do
 
   it "should be able to delete objects" do
     si = SecurityInstrument.find_by_name("FN Fix-30 Cash")
-    dt = DateTime.now
+    dt = '2010-01-01 08:00 PST8PDT'
 
     mp = MarketPrice.lookup_si(dt, si)
     mp.obsoleted_dt.should == Float::INFINITY
@@ -203,4 +203,37 @@ describe "Mcfly" do
     }.should raise_error(ActiveRecord::StatementInvalid)
   end
 
+  it "whodunnit should set user/o_user on CRUD" do
+    Mcfly.whodunnit = TestUser.new(20)
+
+    si = SecurityInstrument.find_by_name("FN Fix-30 Cash")
+    dt = '2010-01-01 08:00 PST8PDT'
+
+    sleep 1.seconds
+
+    mp = MarketPrice.lookup_si(dt, si)
+    mp.user_id.should == 10
+
+    mp.price = 123
+    mp.save!
+
+    # old version should still have original creator user
+    mp = MarketPrice.lookup_si(dt, si)
+    mp.user_id.should == 10
+    mp.o_user_id.should == 20
+
+    # new version should have new creator
+    mp = MarketPrice.lookup_si('infinity', si)
+    mp.user_id.should == 20
+    mp.o_user_id.should == nil
+
+    rid = mp.id
+
+    Mcfly.whodunnit = TestUser.new(30)
+
+    mp.delete
+    mp = MarketPrice.find(rid)
+    mp.o_user_id.should == 30
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mcfly
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-05 00:00:00.000000000 Z
+date: 2013-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -148,7 +148,6 @@ files:
 - spec/dummy/db/schema.rb
 - spec/dummy/lib/assets/.gitkeep
 - spec/dummy/log/.gitkeep
-- spec/dummy/log/development.log
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html