ar_after_timestamps 0.2.0

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+*.gem

data/README.md

@@ -0,0 +1,58 @@
+# after_timestamps
+
+## Summary
+
+Plugin for Ruby on Rails that gives you a way to add a callback to the ActiveRecord callback chain that will be executed right after the record's timestamp columns are set, but before the record is actually saved to the database. This is useful if you want to do something with the timestamps, such as defaulting another time column to created_at, or rolling back a timestamp by a certain amount.
+
+## Example
+
+Let's say you have a migration like this:
+
+    class AddFoo < ActiveRecord::Migration
+      def self.up
+        create_table :foo {|t| t.timestamps }
+      end
+      def self.down
+        drop_table :foo
+      end
+    end
+
+And a model like this:
+  
+    class Foo < ActiveRecord::Base
+      after_timestamps_on_create :roll_back_created_at_by_two_hours
+      after_timestamps_on_update :roll_back_updated_at_by_two_hours
+    
+    private
+      def roll_back_created_at_by_two_hours
+        self.created_at -= 2.hours
+      end
+    
+      def roll_back_updated_at_by_two_hours
+        self.updated_at -= 2.hours
+      end
+    end
+  
+Now if you say
+
+    Foo.create!
+  
+`created_at` and `updated_at` will be set, but 2 hours will be subtracted from them before they're put into the database.
+
+## Installation
+
+1. Run `gem install after_timestamps` (probably as root)
+2. Add `config.gem 'after_timestamps'` to environment.rb
+3. Optionally run `rake gems:build`
+
+## Support
+
+If you find any bugs with this plugin, feel free to:
+
+* file a bug report in the [Issues area on Github](http://github.com/mcmire/after_timestamps/issues)
+* fork the [project on Github](http://github.com/mcmire/after_timestamps) and send me a pull request
+* email me (*firstname* dot *lastname* at gmail dot com)
+
+## Author/License
+
+(c) 2008-2010 Elliot Winkler. Released under the MIT license.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+require File.dirname(__FILE__) + "/lib/mcmire/ar_after_timestamps"
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.version = Mcmire::ARAfterTimestamps::VERSION
+    gem.name = "ar_after_timestamps"
+    gem.summary = %Q{Rails gem that provides an AR callback right after timestamps are set and before the record is saved}
+    gem.description = %Q{Gem that plugs into Ruby on Rails that gives you a way to add a callback to the ActiveRecord callback chain that will be executed right after the record's timestamp columns are set, but before the record is actually saved to the database. This is useful if you want to do something with the timestamps, such as defaulting another time column to created_at, or rolling back a timestamp by a certain amount.}
+    gem.authors = ["Elliot Winkler"]
+    gem.email = "elliot.winkler@gmail.com"
+    gem.homepage = "http://github.com/mcmire/ar_after_timestamps"
+    gem.add_dependency "activerecord", "< 3.0"
+    gem.add_development_dependency "mcmire-protest", "~> 0.2.4"
+    gem.add_development_dependency "mcmire-matchy", "~> 0.4.1"
+    gem.add_development_dependency "mcmire-mocha", "~> 0.9.8"
+    gem.add_development_dependency "mocha-protest-integration"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << File.dirname(__FILE__) << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/ar_after_timestamps.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ar_after_timestamps}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Elliot Winkler"]
+  s.date = %q{2010-01-09}
+  s.description = %q{Gem that plugs into Ruby on Rails that gives you a way to add a callback to the ActiveRecord callback chain that will be executed right after the record's timestamp columns are set, but before the record is actually saved to the database. This is useful if you want to do something with the timestamps, such as defaulting another time column to created_at, or rolling back a timestamp by a certain amount.}
+  s.email = %q{elliot.winkler@gmail.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.md",
+     "Rakefile",
+     "ar_after_timestamps.gemspec",
+     "lib/mcmire/ar_after_timestamps.rb",
+     "rails/init.rb",
+     "test/ar_after_timestamps_test.rb",
+     "test/helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mcmire/ar_after_timestamps}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Rails gem that provides an AR callback right after timestamps are set and before the record is saved}
+  s.test_files = [
+    "test/ar_after_timestamps_test.rb",
+     "test/helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, ["< 3.0"])
+      s.add_development_dependency(%q<mcmire-protest>, ["~> 0.2.4"])
+      s.add_development_dependency(%q<mcmire-matchy>, ["~> 0.4.1"])
+      s.add_development_dependency(%q<mcmire-mocha>, ["~> 0.9.8"])
+      s.add_development_dependency(%q<mocha-protest-integration>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, ["< 3.0"])
+      s.add_dependency(%q<mcmire-protest>, ["~> 0.2.4"])
+      s.add_dependency(%q<mcmire-matchy>, ["~> 0.4.1"])
+      s.add_dependency(%q<mcmire-mocha>, ["~> 0.9.8"])
+      s.add_dependency(%q<mocha-protest-integration>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, ["< 3.0"])
+    s.add_dependency(%q<mcmire-protest>, ["~> 0.2.4"])
+    s.add_dependency(%q<mcmire-matchy>, ["~> 0.4.1"])
+    s.add_dependency(%q<mcmire-mocha>, ["~> 0.9.8"])
+    s.add_dependency(%q<mocha-protest-integration>, [">= 0"])
+  end
+end
+

data/lib/mcmire/ar_after_timestamps.rb

@@ -0,0 +1,101 @@
+module Mcmire
+  # You probably know that every time a record is created, its created_at field
+  # is automatically filled in. And every time a record is updated, its updated_at
+  # field is filled in. This "magic" happens because of ActiveRecord's
+  # Timestamp module, which is mixed in when ActiveRecord::Base is require()'d.
+  #
+  # Unfortunately, if you want to adjust these times for any reason before the
+  # record is actually saved to the database, there isn't a built-in way to do
+  # this. So, what we have to end up doing is inserting another method into the
+  # ActiveRecord callback chain. However, doing so can be kind of tricky if you
+  # don't know what's going on behind the scenes. This is because ActiveRecord
+  # starts out with a set of standard methods in AR::Base and then several modules
+  # are mixed in that override some of those methods.
+  #
+  # The methods that we are concerned about are the ones that are called when
+  # you say `some_record.save`:
+  #
+  #                                    save
+  #                                     |
+  #                              create_or_update
+  #                               /           \
+  #                           create         update
+  #
+  # The modules which are mixed into AR::Base that we are concerned about are
+  # AR::Timestamp and AR::Callbacks. Both use alias_method_chain to override
+  # the methods, so you will see that below. Anyway, when AR::Timestamp is mixed
+  # in this is what the call tree like:
+  #
+  #                                    save
+  #                                     |
+  #                              create_or_update
+  #                      ......./                \.......
+  #                     /                                \
+  #         create(_with_timestamps)         update(_with_timestamps)
+  #                    |                                 | 
+  #        create_without_timestamps         update_without_timestamps
+  #
+  # (The parentheses are there to indicate the effects of alias_method_chain.)
+  #
+  # And when AR::Callbacks is mixed in, the tree changes again:
+  #
+  #                                    save
+  #                                     |
+  #                      create_or_update(_with_callbacks)
+  #                                     |
+  #                               before_save
+  #                                     |
+  #                     create_or_update_without_callbacks
+  #                 ............/   ^   |   ^    \..........
+  #                v                |   |   |               v
+  #     create(_with_callbacks)     |   |   |     update(_with_callbacks)
+  #               |                 |   |   |                |
+  #         before_create           |   |   |          before_update
+  #               |                 |   |   |                |
+  #    create_without_callbacks     |   |   |    update_without_callbacks
+  #               |                 |   |   |                |
+  #    create_without_timestamps   /    |    \   update_without_timestamps
+  #               |               /     |     \              |
+  #          after_create .......´      |      '....... after_update
+  #                                     |
+  #                                     v
+  #                                 after_save 
+  #
+  # As you can see, when the before_save callback is fired, the timestamps
+  # haven't been set yet. Even at before_create/before_update, the timestamps
+  # still haven't been set yet. Of course, by the time after_create/after_update,
+  # it's too late to adjust the timestamps, since the record has already been
+  # saved.
+  #
+  # That's why we need to insert a custom callback in the chain. We do this by
+  # simply alias_method_chain()'ing create_without_timestamps and
+  # update_without_timestamps to do what we want.
+  #
+  module ARAfterTimestamps
+    VERSION = "0.2.0"
+    
+    def self.included(klass)
+      klass.class_eval do
+        alias_method_chain :create_without_timestamps, :after_timestamps
+        alias_method_chain :update_without_timestamps, :after_timestamps
+        define_callbacks :after_timestamps_on_create, :after_timestamps_on_update
+      end
+    end
+    
+    def after_timestamps_on_create() end
+    def after_timestamps_on_update() end
+    
+  private
+    # Override create_with_timestamps to call the after_timestamps_on_create callback
+    def create_without_timestamps_with_after_timestamps
+      return false if callback(:after_timestamps_on_create) == false
+      create_without_timestamps_without_after_timestamps
+    end
+  
+    # Same thing, only for update_with_timestamps
+    def update_without_timestamps_with_after_timestamps
+      return false if callback(:after_timestamps_on_update) == false
+      update_without_timestamps_without_after_timestamps
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,7 @@
+require 'active_record'
+
+require 'mcmire/ar_after_timestamps'
+
+ActiveRecord::Base.class_eval do
+  include Mcmire::ARAfterTimestamps
+end

data/test/ar_after_timestamps_test.rb

@@ -0,0 +1,61 @@
+require 'helper'
+
+ActiveRecord::Base.establish_connection(
+  "adapter" => "sqlite3",
+  "database" => ":memory:"
+)
+
+ActiveRecord::Migration.suppress_messages do
+  ActiveRecord::Schema.define do
+    create_table :posts do |t|
+      t.timestamps
+      t.datetime :posted_at, :null => false
+      t.string :formatted_created_at
+      t.integer :timestamp
+    end
+  end
+end
+
+class Post < ActiveRecord::Base
+  after_timestamps_on_create :set_posted_at_to_created_at
+  after_timestamps_on_create {|post| post.formatted_created_at = post.created_at.strftime("%b/%Y-%d %D %H%M..%S") }
+  after_timestamps_on_update :rollback_created_at
+  after_timestamps_on_update {|post| post.timestamp = post.created_at.to_i }
+  
+  def set_posted_at_to_created_at
+    self.posted_at = self.created_at
+  end
+  def rollback_created_at
+    self.posted_at -= 2.days
+  end
+end
+
+Protest.context("ar_after_timestamps") do
+  test "after_timestamps_on_create symbol is called on create" do
+    Time.stubs(:now).returns(Time.local(2009))
+    post = Post.new
+    post.save!
+    post.posted_at.should == Time.local(2009)
+  end
+  
+  test "after_timestamps_on_create proc is called on create" do
+    Time.stubs(:now).returns(Time.local(2009))
+    post = Post.new
+    post.save!
+    post.formatted_created_at.should == "Jan/2009-01 01/01/09 0000..00"
+  end
+  
+  test "after_timestamps_on_update symbol is called on update" do
+    Time.stubs(:now).returns(Time.local(2009))
+    post = Post.create!
+    post.save!
+    post.posted_at.should == Time.local(2008, 12, 30)
+  end
+  
+  test "after_timestamp_on_update proc is called on update" do
+    Time.stubs(:now).returns(Time.local(2009))
+    post = Post.create!
+    post.save!
+    post.timestamp.should == 1230789600
+  end
+end

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+
+gem 'mcmire-protest'
+require 'protest'
+gem 'mcmire-matchy'
+require 'matchy'
+gem 'mcmire-mocha'
+require 'mocha'
+require 'mocha-protest-integration'
+
+require 'rails/init'

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: ar_after_timestamps
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Elliot Winkler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-09 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - <
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mcmire-protest
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.2.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mcmire-matchy
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.4.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mcmire-mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.8
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha-protest-integration
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Gem that plugs into Ruby on Rails that gives you a way to add a callback to the ActiveRecord callback chain that will be executed right after the record's timestamp columns are set, but before the record is actually saved to the database. This is useful if you want to do something with the timestamps, such as defaulting another time column to created_at, or rolling back a timestamp by a certain amount.
+email: elliot.winkler@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- README.md
+- Rakefile
+- ar_after_timestamps.gemspec
+- lib/mcmire/ar_after_timestamps.rb
+- rails/init.rb
+- test/ar_after_timestamps_test.rb
+- test/helper.rb
+has_rdoc: true
+homepage: http://github.com/mcmire/ar_after_timestamps
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Rails gem that provides an AR callback right after timestamps are set and before the record is saved
+test_files: 
+- test/ar_after_timestamps_test.rb
+- test/helper.rb