seamusabshere-has_timestamps 1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,59 @@
+HasTimestamps
+=================
+
+Lets you timestamp models, like if you want to fake a CRM.
+
+Note: it doesn't save objects automatically, so you have to run a "user.save" (etc.) when you're done timestamping.
+
+Example
+=======
+
+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
+
+then...
+
+class User < ActiveRecord::Base
+  has_timestamps
+end
+
+>> user.timestamps
+=> []
+>> user.timestamp!(:hailed)
+=> 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
+>> user.save
+=> true
+>> user.timestamped?(:saluted)
+=> false
+>> user.timestamp!(:saluted)
+=> Wed Dec 10 15:12:28 -0500 2008
+>> user.timestamped?(:saluted)
+=> true
+>> user.timestamps[:saluted]
+=> Wed Dec 10 15:12:28 -0500 2008
+>> user.timestamps[:hailed]
+=> Wed Dec 10 15:11:52 -0500 2008
+
+Credits
+=======
+
+Thanks to Fingertips for inspiration.
+
+Copyright (c) 2008 Seamus Abshere, released under the MIT license.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the has_timestamps plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the has_timestamps plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HasTimestamps'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/has_timestamps.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name     = "has_timestamps"
+  s.version  = "1.0"
+  s.date     = "2008-12-29"
+  s.summary  = "Rails plugin to add named timestamps to ActiveRecord models."
+  s.email    = "seamus@abshere.net"
+  s.homepage = "http://github.com/seamusabshere/has_timestamps"
+  s.description = "has_timestamps is a Rails plugin that allows you to add named timestamps to ActiveRecord models without adding database columns."
+  s.has_rdoc = false
+  s.authors  = "Seamus Abshere"
+  s.files    = [
+    "has_timestamps.gemspec",
+    "init.rb",
+    "install.rb",
+    "lib/has_timestamps.rb",
+    "lib/timestamp.rb",
+    "MIT-LICENSE",
+    "Rakefile",
+    "README",
+    "tasks/has_timestamps_tasks.rake",
+    "uninstall.rb"
+    ]
+  s.test_files = [  
+    "test/has_timestamps_test.rb",
+    "test/test_helper.rb"
+    ]
+end

data/init.rb

@@ -0,0 +1,4 @@
+require 'has_timestamps'
+ActiveRecord::Base.send(:include, ActiveRecord::Acts::HasTimestamps)
+
+require File.dirname(__FILE__) + '/lib/timestamp'

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/has_timestamps.rb

@@ -0,0 +1,58 @@
+module ActiveRecord #:nodoc:
+  module Acts #:nodoc:
+    module HasTimestamps
+      def self.included(base) #:nodoc:
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def has_timestamps(opts = {})
+          class_eval do
+            def save_or_destroy_timestamps
+              timestamps.each do |timestamp|
+                if timestamp.stamped_at.acts_like?(:time) or timestamp.stamped_at.is_a?(Date) or timestamp.stamped_at.is_a?(DateTime)
+                  timestamp.save
+                elsif !timestamp.new_record?
+                  timestamp.destroy
+                end
+              end
+            end
+            after_save :save_or_destroy_timestamps
+            
+            def timestamp!(key)
+              timestamps[key.to_s] = Time.now
+            end
+            
+            def timestamped?(key)
+              !timestamps[key.to_s].blank?
+            end
+          end
+
+          has_many :timestamps, opts.merge(:as => :timestampable) do
+            def [](key)
+              fetch_timestamp(key).stamped_at
+            end
+
+            def []=(key, stamped_at)
+              fetch_timestamp(key).stamped_at = stamped_at
+            end
+
+            def find_by_key(key)
+              proxy_owner.timestamps.to_a.find { |timestamp| timestamp.key == key.to_s }
+            end
+
+            private
+
+            def fetch_timestamp(key)
+              find_by_key(key) || build_timestamp(key)
+            end
+
+            def build_timestamp(key)
+              build(:key => key.to_s)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/timestamp.rb

@@ -0,0 +1,26 @@
+class Timestamp < ActiveRecord::Base
+  class << self
+    def create_table
+      self.connection.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 drop_table
+      self.connection.drop_table(:timestamps)
+    end
+  end
+
+  belongs_to :timestampable, :polymorphic => true
+
+  validates_presence_of :key, :timestampable_id, :timestampable_type
+  validates_uniqueness_of :key, :scope => [ :timestampable_id, :timestampable_type ]
+  
+  def to_param
+    self.key
+  end
+end

data/tasks/has_timestamps_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :has_timestamps do
+#   # Task goes here
+# end

data/test/has_timestamps_test.rb

@@ -0,0 +1,150 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module SharedTests
+  def self.included(klass)
+    klass.class_eval do
+      it "should test if two times are virtually simultaneous" do
+        t1 = Time.at(946702800)
+        t2 = Time.at(946702800 + DELTA_IN_SECONDS)
+        t3 = Time.at(946702800 + DELTA_IN_SECONDS + 1)
+        assert_simultaneous(t1, t2)
+        assert_not_simultaneous(t1, t3)
+      end
+      
+      it "should get timestamp with brackets" do
+        assert_equal @timestamp.stamped_at, @person.timestamps[@timestamp.key.to_sym]
+      end
+
+      it "should get nil timestamp with brackets" do
+        assert_nil @person.timestamps[:gibberish]
+      end
+
+      it "should get timestamp as a Time" do
+        assert @person.timestamps[@timestamp.key.to_sym].acts_like?(:time)
+      end
+
+      it "should query timestamp with brackets" do
+        assert_equal @person.timestamped?(@timestamp.key.to_sym), true
+        assert_equal @person.timestamped?(:gibberish), false
+      end
+      
+      it "should set timestamp" do
+        @person.timestamp!(:hailed)
+        @person.save
+        @person.reload
+        assert_simultaneous Time.now, @person.timestamps[:hailed]
+      end
+
+      it "should reset timestamp" do
+        old_time = @person.timestamps[:saluted]
+        @person.timestamp!(:saluted)
+        @person.save
+        @person.reload
+        assert_not_simultaneous(old_time, @person.timestamps[:saluted])
+        assert_simultaneous Time.now, @person.timestamps[:saluted]
+      end
+      
+      it "should set timestamp manually" do
+        @person.timestamps[:hailed] = @another_time
+        @person.save
+        @person.reload
+        assert_simultaneous @another_time, @person.timestamps[:hailed]
+      end
+      
+      it "should set timestamp manually to Date" do
+        @person.timestamps[:hailed] = @another_time.to_date
+        @person.save
+        @person.reload
+        assert_simultaneous @another_time, @person.timestamps[:hailed]
+      end
+      
+      it "should set timestamp manually to DateTime" do
+        @person.timestamps[:hailed] = @another_time.to_datetime
+        @person.save
+        @person.reload
+        assert_simultaneous @another_time, @person.timestamps[:hailed]
+      end
+      
+      it "should set timestamp to nil" do
+        @person.timestamps[:hailed] = nil
+        @person.save
+        @person.reload
+        assert_nil @person.timestamps[:hailed]
+      end
+      
+      it "should reset timestamp manually" do
+        old_time = @person.timestamps[:saluted]
+        @person.timestamps[:saluted] = @another_time
+        @person.save
+        @person.reload
+        assert_not_simultaneous old_time, @person.timestamps[:saluted]
+        assert_simultaneous @another_time, @person.timestamps[:saluted]
+      end
+      
+      it "should reset timestamp to nil" do
+        @person.timestamps[:saluted] = nil
+        @person.save
+        @person.reload
+        assert_nil @person.timestamps[:saluted]
+      end
+      
+      it "should save timestamps" do
+        assert_difference('Timestamp.count', 1) do
+          @person.timestamp!(:hailed)
+          @person.save
+        end
+      end
+      
+      it "should destroy nil timestamps" do
+        assert_difference('Timestamp.count', -1) do
+          @person.timestamps[:saluted] = nil
+          @person.save
+        end
+      end
+      
+      it "should not save nil timestamps" do
+        assert_no_difference('Timestamp.count') do
+          @person.timestamps[:hailed] = nil
+          @person.save
+        end
+      end
+    end
+  end
+end
+
+describe "HasTimestamps, when a timezone is not set" do
+  before do
+    HasTimestampsTest::Initializer.setup_database
+    @person = Person.first
+    @timestamp = Timestamp.first
+    @another_time = 3.days.ago.at_beginning_of_day
+  end
+  after do
+    HasTimestampsTest::Initializer.teardown_database
+  end
+  
+  it "should not have a timezone" do
+    assert_nil Time.zone
+  end
+  
+  include SharedTests
+end
+
+describe "HasTimestamps, when a timezone is set" do
+  before do
+    HasTimestampsTest::Initializer.setup_database
+    Time.zone = 'Pacific Time (US & Canada)'
+    @person = Person.first
+    @timestamp = Timestamp.first
+    @another_time = 3.days.ago.at_beginning_of_day
+  end
+  after do
+    HasTimestampsTest::Initializer.teardown_database
+  end
+  
+  it "should have a timezone" do
+    assert_equal Time.zone.name, 'Pacific Time (US & Canada)'
+  end
+  
+  include SharedTests
+end

data/test/test_helper.rb

@@ -0,0 +1,85 @@
+module HasTimestampsTest
+  module Initializer
+    VENDOR_RAILS = File.expand_path('../../../../rails', __FILE__)
+    OTHER_RAILS = File.expand_path('../../../rails', __FILE__)
+    PLUGIN_ROOT = File.expand_path('../../', __FILE__)
+    
+    def self.rails_directory
+      if File.exist?(VENDOR_RAILS)
+        VENDOR_RAILS
+      elsif File.exist?(OTHER_RAILS)
+        OTHER_RAILS
+      end
+    end
+    
+    def self.load_dependencies
+      if rails_directory
+        $:.unshift(File.join(rails_directory, 'activesupport', 'lib'))
+        $:.unshift(File.join(rails_directory, 'activerecord', 'lib'))
+      else
+        require 'rubygems' rescue LoadError
+      end
+      
+      require 'activesupport'
+      require 'activerecord'
+      require 'active_support/testing/core_ext/test/unit/assertions'
+      
+      require 'rubygems' rescue LoadError
+      
+      require 'test/spec'
+      require File.join(PLUGIN_ROOT, 'init')
+    end
+    
+    def self.configure_database
+      ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+      ActiveRecord::Migration.verbose = false
+    end
+    
+    def self.setup_database
+      ActiveRecord::Schema.define do
+        create_table :people do |t|
+          t.string :name
+        end
+        create_table :timestamps do |t|
+          t.integer :timestampable_id
+          t.string :timestampable_type
+          t.string :key
+          t.datetime :stamped_at
+          t.timestamps
+        end
+      end
+      person_fixture = Person.create :name => 'Seamus'
+      person_fixture.timestamps[:saluted] = Time.now.years_ago(1).at_beginning_of_day
+      person_fixture.save
+    end
+    
+    def self.teardown_database
+      ActiveRecord::Base.connection.tables.each do |table|
+        ActiveRecord::Base.connection.drop_table(table)
+      end
+    end
+    
+    def self.start
+      load_dependencies
+      configure_database
+    end
+  end
+end
+ 
+HasTimestampsTest::Initializer.start
+ 
+class Person < ActiveRecord::Base
+  has_timestamps
+end
+
+DELTA_IN_SECONDS = 5
+
+def assert_simultaneous(t1, t2)
+  assert_in_delta t1, t2, DELTA_IN_SECONDS
+end
+
+def assert_not_simultaneous(t1, t2)
+  assert_raise(Test::Unit::AssertionFailedError) do
+    assert_simultaneous t1, t2
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: seamusabshere-has_timestamps
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- Seamus Abshere
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-29 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: has_timestamps is a Rails plugin that allows you to add named timestamps to ActiveRecord models without adding database columns.
+email: seamus@abshere.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- has_timestamps.gemspec
+- init.rb
+- install.rb
+- lib/has_timestamps.rb
+- lib/timestamp.rb
+- MIT-LICENSE
+- Rakefile
+- README
+- tasks/has_timestamps_tasks.rake
+- uninstall.rb
+has_rdoc: false
+homepage: http://github.com/seamusabshere/has_timestamps
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Rails plugin to add named timestamps to ActiveRecord models.
+test_files: 
+- test/has_timestamps_test.rb
+- test/test_helper.rb