@@ -1,9 +1,9 @@ HasTimestamps ================= -Lets you timestamp models, like if you want to fake a CRM. +Lets you timestamp models without adding a lot of timestamp fields to your tables. -Note: it doesn't save objects automatically, so you have to run a "user.save" (etc.) when you're done timestamping. +Note: it **doesn't** save objects automatically, so you have to run a "user.save" (etc.) when you're done timestamping. Installation ============ @@ -16,28 +16,14 @@ config.gem 'seamusabshere-has_timestamps', :lib => 'has_timestamps', :source => Then be sure to: -rake gems:install +sudo rake gems:install -Example -======= +Finally in a migration: -class CreateTimestamps < ActiveRecord::Migration - def self.up - create_table(:timestamps) do |t| - t.integer :timestampable_id - t.string :timestampable_type - t.string :key - t.datetime :stamped_at - t.timestamps - end - end - - def self.down - drop_table(:timestamps) - end -end +Timestamp.create_table (and Timestamp.drop_table for the down migration) -then... +Example +======= class User < ActiveRecord::Base has_timestamps @@ -45,28 +31,22 @@ end >> user.timestamps => [] ->> user.timestamp!(:hailed) +>> user.timestamp(:greeted) => Wed Dec 10 15:11:52 -0500 2008 >> user.timestamps -=> [#<Timestamp id: nil, timestampable_id: 14, timestampable_type: "User", key: "hailed", stamped_at: "2008-12-10 15:11:52", created_at: nil, updated_at: nil>] ->> user.timestamped?(:hailed) -=> true +=> [#<Timestamp id: nil, timestampable_id: 14, timestampable_type: "User", key: "greeted", stamped_at: "2008-12-10 15:11:52", created_at: nil, updated_at: nil>] >> user.save => true ->> user.timestamped?(:saluted) -=> false ->> user.timestamp!(:saluted) -=> Wed Dec 10 15:12:28 -0500 2008 ->> user.timestamped?(:saluted) +>> user.timestamped?(:greeted) => true ->> user.timestamps[:saluted] -=> Wed Dec 10 15:12:28 -0500 2008 ->> user.timestamps[:hailed] +>> user.timestamps[:greeted] => Wed Dec 10 15:11:52 -0500 2008 +>> user.timestamped?(:saluted) +=> false Credits ======= Thanks to Fingertips for inspiration. -Copyright (c) 2008 Seamus Abshere, released under the MIT license. +Copyright (c) 2009 Seamus Abshere, released under the MIT license. README @@ -17,7 +17,7 @@ module HasTimestamps end after_save :save_or_destroy_timestamps - def timestamp!(key) + def timestamp(key) timestamps[key.to_s] = Time.now end lib/has_timestamps.rb @@ -29,7 +29,7 @@ module SharedTests end it "should set timestamp" do - @person.timestamp!(:hailed) + @person.timestamp(:hailed) @person.save @person.reload assert_simultaneous Time.now, @person.timestamps[:hailed] @@ -37,7 +37,7 @@ module SharedTests it "should reset timestamp" do old_time = @person.timestamps[:saluted] - @person.timestamp!(:saluted) + @person.timestamp(:saluted) @person.save @person.reload assert_not_simultaneous(old_time, @person.timestamps[:saluted]) @@ -90,7 +90,7 @@ module SharedTests it "should save timestamps" do assert_difference('Timestamp.count', 1) do - @person.timestamp!(:hailed) + @person.timestamp(:hailed) @person.save end end test/has_timestamps_test.rb 4a5e5457521adfadc514e16cd1b4618eeef1254c Seamus Abshere seamus@abshere.net http://github.com/seamusabshere/has_timestamps/commit/c861b359a3f868287e825eaec45c20a97f8aeec0 c861b359a3f868287e825eaec45c20a97f8aeec0 2009-02-10T16:38:29-08:00 2009-02-10T16:38:29-08:00 Stop using an exclamation point because it doesn't actually save the record or anything. Update README. 7208f03faae12c936608352759ee65f42fd27cc2 Seamus Abshere seamus@abshere.net