column_timestamps 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Myron Marston
+
+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.rdoc

@@ -0,0 +1,43 @@
+= column_timestamps
+
+ActiveRecord manages your updated_at columns for you, updating the timestamp when your records change.
+This gem provides similar, but more granular functionality: in addition to a table-wide updated_at column,
+you can have additional timestamp columns that track when specific columns change.
+
+Usage is pretty simple:
+- Create a new datetime column using the naming convention <column>_updated_at.
+- Include ColumnTimestamps in your model.
+
+Example:
+
+    # schema definition...
+    ActiveRecord::Schema.define do
+      create_table :users, :force => true do |t|
+        t.string    :email_address
+        t.string    :name
+        t.string    :state
+        t.datetime  :state_updated_at
+        t.timestamps
+      end
+    end
+
+    # Model...
+    class User < ActiveRecord::Base
+      include ColumnTimestamps
+    end
+
+Anytime the state attribute of a user record is changed, the state_updated_at timestamp will be updated to reflect that.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Myron Marston. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,74 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "column_timestamps"
+    gem.summary = %Q{Keeps track of when a specific column in an ActiveRecord model changed.}
+    gem.description = %Q{Works "automagically" like updated_at...just add a column named <column>_updated_at, and when your column changes, the timestamp will be updated. }
+    gem.email = "myron.marston@gmail.com"
+    gem.homepage = "http://github.com/myronmarston/column_timestamps"
+    gem.authors = ["Myron Marston"]
+    gem.add_dependency 'activerecord'
+    gem.add_development_dependency 'sqlite3-ruby'
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "rr", ">= 0.10.4"
+
+    # 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: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'reek/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "column_timestamps #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/column_timestamps.rb

@@ -0,0 +1,24 @@
+require 'activerecord'
+
+module ColumnTimestamps
+  def self.included(klass)
+    klass.send :extend, ClassMethods
+    klass.send :before_save, :update_column_timestamps
+  end
+
+  module ClassMethods
+    def timestamped_column_names
+      @timestamped_column_names ||= self.column_names.select { |c| self.column_names.include?("#{c}_updated_at") }
+    end
+  end
+
+  private
+
+  def update_column_timestamps
+    current_time = self.class.default_timezone == :utc ? Time.now.utc : Time.now
+    self.class.timestamped_column_names.each do |column_name|
+      self.send("#{column_name}_updated_at=", current_time) if self.send("#{column_name}_changed?")
+    end
+    true
+  end
+end

data/spec/fixtures/models.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  include ColumnTimestamps
+end

data/spec/fixtures/schema.rb

@@ -0,0 +1,10 @@
+ActiveRecord::Schema.define do
+  create_table :users, :force => true do |t|
+    t.string    :email_address
+    t.string    :name
+    t.string    :state
+    t.datetime  :name_updated_at
+    t.datetime  :state_updated_at
+    t.timestamps
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'column_timestamps'
+require 'spec'
+require 'spec/autorun'
+
+ActiveRecord::Base.establish_connection({ :database => ":memory:", :adapter => 'sqlite3', :timeout => 500 })
+require 'fixtures/schema.rb'
+require 'fixtures/models.rb'
+
+Spec::Runner.configure do |config|
+  config.mock_with :rr
+end

data/spec/user_spec.rb

@@ -0,0 +1,87 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe User do
+  it "should return the timestamped_column_names from #timestamped_column_names" do
+    User.timestamped_column_names.sort.should == %w( name state )
+  end
+
+  it "should initially have nil values for the column timestamps" do
+    @user = User.new
+    @user.name_updated_at.should be_nil
+    @user.state_updated_at.should be_nil
+  end
+
+  it "should not set the the column timestamps when saved with name or state values" do
+    @user = User.create!
+    @user.name_updated_at.should be_nil
+    @user.state_updated_at.should be_nil
+  end
+
+  describe "saving the record with a name value" do
+    before(:each) do
+      @now = @now1 = Time.now
+      stub(Time).now { @now }
+      @user = User.create!(:name => 'David')
+      @user.reload
+    end
+
+    it "should set the name_updated_at timestamp" do
+      @user.name_updated_at.to_s.should == @now1.to_s
+    end
+
+    it "should not set the state_updated_at timestamp" do
+      @user.state_updated_at.should be_nil
+    end
+
+    describe "and later updating the state value" do
+      before(:each) do
+        @now = @now2 = (@now1 + 1.day)
+        @user.state = 'approved'
+        @user.save!
+        @user.reload
+      end
+
+      it "should set the state_updated_at timestamp" do
+        @user.state_updated_at.to_s.should == @now2.to_s
+      end
+
+      it "should not update the name_updated_at timestamp" do
+        @user.name_updated_at.to_s.should == @now1.to_s
+      end
+
+      describe "and later updating another attribute" do
+        before(:each) do
+          @now = @now3 = (@now2 + 1.day)
+          @user.email_address = 'dave@example.com'
+          @user.save!
+          @user.reload
+        end
+
+        it "should not update the state_updated_at timestamp" do
+          @user.state_updated_at.to_s.should == @now2.to_s
+        end
+
+        it "should not update the name_updated_at timestamp" do
+          @user.name_updated_at.to_s.should == @now1.to_s
+        end
+      end
+
+      describe "and later updating the name attribute" do
+        before(:each) do
+          @now = @now3 = (@now2 + 1.day)
+          @user.name = 'Dave'
+          @user.save!
+          @user.reload
+        end
+
+        it "should not update the state_updated_at timestamp" do
+          @user.state_updated_at.to_s.should == @now2.to_s
+        end
+
+        it "should update the name_updated_at timestamp" do
+          @user.name_updated_at.to_s.should == @now3.to_s
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: column_timestamps
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Myron Marston
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-19 00:00:00 -07: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: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rr
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.4
+    version: 
+description: "Works \"automagically\" like updated_at...just add a column named <column>_updated_at, and when your column changes, the timestamp will be updated. "
+email: myron.marston@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/column_timestamps.rb
+- spec/fixtures/models.rb
+- spec/fixtures/schema.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/user_spec.rb
+has_rdoc: true
+homepage: http://github.com/myronmarston/column_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: Keeps track of when a specific column in an ActiveRecord model changed.
+test_files: 
+- spec/fixtures/models.rb
+- spec/fixtures/schema.rb
+- spec/spec_helper.rb
+- spec/user_spec.rb