dm-timestamps 0.9.7 → 0.9.8

data/History.txt

@@ -1 +1,6 @@
+=== 0.9.8 / 2008-12-07
 
+* 2 minor enhancements:
+
+  * Added timestamps helper method
+  * Internal refactorings

data/Manifest.txt

@@ -9,3 +9,5 @@ lib/dm-timestamps/version.rb
 spec/integration/timestamps_spec.rb
 spec/spec.opts
 spec/spec_helper.rb
+tasks/install.rb
+tasks/spec.rb

data/Rakefile

@@ -1,58 +1,25 @@
-require 'rubygems'
-require 'spec'
-require 'spec/rake/spectask'
 require 'pathname'
+require 'rubygems'
+
+ROOT    = Pathname(__FILE__).dirname.expand_path
+JRUBY   = RUBY_PLATFORM =~ /java/
+WINDOWS = Gem.win_platform?
+SUDO    = (WINDOWS || JRUBY) ? '' : ('sudo' unless ENV['SUDOLESS'])
 
-ROOT = Pathname(__FILE__).dirname.expand_path
 require ROOT + 'lib/dm-timestamps/version'
 
-AUTHOR = "Foy Savas"
-EMAIL  = "foysavas@gmail.com"
-GEM_NAME = "dm-timestamps"
+AUTHOR = 'Foy Savas'
+EMAIL  = 'foysavas [a] gmail [d] com'
+GEM_NAME = 'dm-timestamps'
 GEM_VERSION = DataMapper::Timestamps::VERSION
-GEM_DEPENDENCIES = [["dm-core", GEM_VERSION]]
-GEM_CLEAN = ["log", "pkg", "coverage"]
-GEM_EXTRAS = { :has_rdoc => true, :extra_rdoc_files => %w[ README.txt LICENSE TODO ] }
-
-PROJECT_NAME = "datamapper"
-PROJECT_URL  = "http://github.com/sam/dm-more/tree/master/dm-timestamps"
-PROJECT_DESCRIPTION = PROJECT_SUMMARY = "DataMapper plugin for magical timestamps"
-
-require ROOT.parent + 'tasks/hoe'
-
-task :default => [ :spec ]
-
-WIN32 = (RUBY_PLATFORM =~ /win32|mingw|cygwin/) rescue nil
-SUDO  = WIN32 ? '' : ('sudo' unless ENV['SUDOLESS'])
-
-desc "Install #{GEM_NAME} #{GEM_VERSION} (default ruby)"
-task :install => [ :package ] do
-  sh "#{SUDO} gem install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources", :verbose => false
-end
-
-desc "Uninstall #{GEM_NAME} #{GEM_VERSION} (default ruby)"
-task :uninstall => [ :clobber ] do
-  sh "#{SUDO} gem uninstall #{GEM_NAME} -v#{GEM_VERSION} -I -x", :verbose => false
-end
-
-namespace :jruby do
-  desc "Install #{GEM_NAME} #{GEM_VERSION} with JRuby"
-  task :install => [ :package ] do
-    sh %{#{SUDO} jruby -S gem install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources}, :verbose => false
-  end
-end
+GEM_DEPENDENCIES = [['dm-core', "~>#{GEM_VERSION}"]]
+GEM_CLEAN = %w[ log pkg coverage ]
+GEM_EXTRAS = { :has_rdoc => true, :extra_rdoc_files => %w[ README.txt LICENSE TODO History.txt ] }
 
-desc 'Run specifications'
-Spec::Rake::SpecTask.new(:spec) do |t|
-  t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
-  t.spec_files = Pathname.glob((ROOT + 'spec/**/*_spec.rb').to_s)
+PROJECT_NAME = 'datamapper'
+PROJECT_URL  = "http://github.com/sam/dm-more/tree/master/#{GEM_NAME}"
+PROJECT_DESCRIPTION = PROJECT_SUMMARY = 'DataMapper plugin for magical timestamps'
 
-  begin
-    t.rcov = ENV.has_key?('NO_RCOV') ? ENV['NO_RCOV'] != 'true' : true
-    t.rcov_opts << '--exclude' << 'spec'
-    t.rcov_opts << '--text-summary'
-    t.rcov_opts << '--sort' << 'coverage' << '--sort-reverse'
-  rescue Exception
-    # rcov not installed
-  end
+[ ROOT, ROOT.parent ].each do |dir|
+  Pathname.glob(dir.join('tasks/**/*.rb').to_s).each { |f| require f }
 end

data/TODO

@@ -1,8 +0,0 @@
-TODO
-====
-
-
-
----
-TODO tickets may also be found in the DataMapper Issue Tracker:
-http://wm.lighthouseapp.com/projects/4819-datamapper/overview

data/lib/dm-timestamps.rb

@@ -1,57 +1,56 @@
 require 'rubygems'
 
-gem 'dm-core', '~>0.9.7'
+gem 'dm-core', '~>0.9.8'
 require 'dm-core'
 
 module DataMapper
   module Timestamp
+    Resource.append_inclusions self
+
     TIMESTAMP_PROPERTIES = {
-      :updated_at => lambda { |r| r.updated_at = DateTime.now },
-      :updated_on => lambda { |r| r.updated_on = Date.today   },
-      :created_at => lambda { |r| r.created_at = DateTime.now if r.new_record? && r.created_at.nil? },
-      :created_on => lambda { |r| r.created_on = Date.today   if r.new_record? && r.created_on.nil?},
-    }
+      :updated_at => [ DateTime, lambda { |r, p| DateTime.now                                    } ],
+      :updated_on => [ Date,     lambda { |r, p| Date.today                                      } ],
+      :created_at => [ DateTime, lambda { |r, p| r.created_at || (DateTime.now if r.new_record?) } ],
+      :created_on => [ Date,     lambda { |r, p| r.created_on || (Date.today   if r.new_record?) } ],
+    }.freeze
 
     def self.included(model)
-      model.before :save, :set_timestamp_properties
-      model.send :extend, ClassMethods
+      model.before :create, :set_timestamps
+      model.before :update, :set_timestamps
+      model.extend ClassMethods
     end
 
     private
 
-    def set_timestamp_properties
-      if dirty?
-        self.class.properties.slice(*TIMESTAMP_PROPERTIES.keys).compact.each do |property|
-          TIMESTAMP_PROPERTIES[property.name][self] unless attribute_dirty?(property.name)
+    def set_timestamps
+      return unless dirty?
+      TIMESTAMP_PROPERTIES.each do |name,(_type,proc)|
+        if model.properties.has_property?(name)
+          model.properties[name].set(self, proc.call(self, model.properties[name])) unless attribute_dirty?(name)
         end
       end
     end
 
     module ClassMethods
-      def timestamps(*args)
-        if args.empty? then raise ArgumentError, "You need to pass at least one argument." end
-
-        args.each do |ts|
-          case ts
-          when :at
-            property :created_at, DateTime
-            property :updated_at, DateTime
-          when :on
-            property :created_on, Date
-            property :updated_on, Date
-          else
-            unless TIMESTAMP_PROPERTIES.keys.include?(ts)
-              raise InvalidTimestampName, "Invalid timestamp property '#{ts}'."
-            end
-
-            property ts, DateTime
+      def timestamps(*names)
+        raise ArgumentError, 'You need to pass at least one argument' if names.empty?
+
+        names.each do |name|
+          case name
+            when *TIMESTAMP_PROPERTIES.keys
+              type = TIMESTAMP_PROPERTIES[name].first
+              property name, type, :nullable => false
+            when :at
+              timestamps(:created_at, :updated_at)
+            when :on
+              timestamps(:created_on, :updated_on)
+            else
+              raise InvalidTimestampName, "Invalid timestamp property name '#{name}'"
           end
         end
       end
-    end
+    end # module ClassMethods
 
     class InvalidTimestampName < RuntimeError; end
   end # module Timestamp
-
-  Resource::append_inclusions Timestamp
-end
+end # module DataMapper

data/lib/dm-timestamps/version.rb

@@ -1,5 +1,5 @@
 module DataMapper
   module Timestamps
-    VERSION = "0.9.7"
+    VERSION = '0.9.8'
   end
 end

data/spec/integration/timestamps_spec.rb

@@ -3,152 +3,175 @@ require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
 
 if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
   describe 'DataMapper::Timestamp' do
-    before :all do
-      class GreenSmoothie
-        include DataMapper::Resource
-
-        property :id, Integer, :serial => true
-        property :name, String
-        property :created_at, DateTime
-        property :created_on, Date
-        property :updated_at, DateTime
-        property :updated_on, Date
-
-        auto_migrate!(:default)
+    describe "Timestamp (shared behavior)", :shared => true do
+      it "should not set the created_at/on fields if they're already set" do
+        repository(:default) do
+          green_smoothie = GreenSmoothie.new(:name => 'Banana')
+          time = (DateTime.now - 100)
+          green_smoothie.created_at = time
+          green_smoothie.created_on = time
+          green_smoothie.save
+          green_smoothie.created_at.should == time
+          green_smoothie.created_on.should == time
+          green_smoothie.created_at.should be_a_kind_of(DateTime)
+          green_smoothie.created_on.should be_a_kind_of(Date)
+        end
       end
-    end
 
-    after do
-     repository(:default).adapter.execute('DELETE from green_smoothies');
-    end
-
-    it "should not set the created_at/on fields if they're already set" do
-      repository(:default) do
-        green_smoothie = GreenSmoothie.new(:name => 'Banana')
-        time = (DateTime.now - 100)
-        green_smoothie.created_at = time
-        green_smoothie.created_on = time
-        green_smoothie.save
-        green_smoothie.created_at.should == time
-        green_smoothie.created_on.should == time
-        green_smoothie.created_at.should be_a_kind_of(DateTime)
-        green_smoothie.created_on.should be_a_kind_of(Date)
+      it "should set the created_at/on fields on creation" do
+        repository(:default) do
+          green_smoothie = GreenSmoothie.new(:name => 'Banana')
+          green_smoothie.created_at.should be_nil
+          green_smoothie.created_on.should be_nil
+          green_smoothie.save
+          green_smoothie.created_at.should be_a_kind_of(DateTime)
+          green_smoothie.created_on.should be_a_kind_of(Date)
+        end
       end
-    end
 
-    it "should set the created_at/on fields on creation" do
-      repository(:default) do
-        green_smoothie = GreenSmoothie.new(:name => 'Banana')
-        green_smoothie.created_at.should be_nil
-        green_smoothie.created_on.should be_nil
-        green_smoothie.save
-        green_smoothie.created_at.should be_a_kind_of(DateTime)
-        green_smoothie.created_on.should be_a_kind_of(Date)
+      it "should not alter the create_at/on fields on model updates" do
+        repository(:default) do
+          green_smoothie = GreenSmoothie.new(:id => 2, :name => 'Berry')
+          green_smoothie.created_at.should be_nil
+          green_smoothie.created_on.should be_nil
+          green_smoothie.save
+          original_created_at = green_smoothie.created_at
+          original_created_on = green_smoothie.created_on
+          green_smoothie.name = 'Strawberry'
+          green_smoothie.save
+          green_smoothie.created_at.should eql(original_created_at)
+          green_smoothie.created_on.should eql(original_created_on)
+        end
       end
-    end
 
-    it "should not alter the create_at/on fields on model updates" do
-      repository(:default) do
-        green_smoothie = GreenSmoothie.new(:id => 2, :name => 'Berry')
-        green_smoothie.created_at.should be_nil
-        green_smoothie.created_on.should be_nil
-        green_smoothie.save
-        original_created_at = green_smoothie.created_at
-        original_created_on = green_smoothie.created_on
-        green_smoothie.name = 'Strawberry'
-        green_smoothie.save
-        green_smoothie.created_at.should eql(original_created_at)
-        green_smoothie.created_on.should eql(original_created_on)
+      it "should set the updated_at/on fields on creation and on update" do
+        repository(:default) do
+          green_smoothie = GreenSmoothie.new(:name => 'Mango')
+          green_smoothie.updated_at.should be_nil
+          green_smoothie.updated_on.should be_nil
+          green_smoothie.save
+          green_smoothie.updated_at.should be_a_kind_of(DateTime)
+          green_smoothie.updated_on.should be_a_kind_of(Date)
+          original_updated_at = green_smoothie.updated_at
+          original_updated_on = green_smoothie.updated_on
+          time_tomorrow = DateTime.now + 1
+          date_tomorrow = Date.today + 1
+          DateTime.stub!(:now).and_return { time_tomorrow }
+          Date.stub!(:today).and_return { date_tomorrow }
+          green_smoothie.name = 'Cranberry Mango'
+          green_smoothie.save
+          green_smoothie.updated_at.should_not eql(original_updated_at)
+          green_smoothie.updated_on.should_not eql(original_updated_on)
+          green_smoothie.updated_at.should eql(time_tomorrow)
+          green_smoothie.updated_on.should eql(date_tomorrow)
+        end
       end
-    end
 
-    it "should set the updated_at/on fields on creation and on update" do
-      repository(:default) do
-        green_smoothie = GreenSmoothie.new(:name => 'Mango')
-        green_smoothie.updated_at.should be_nil
-        green_smoothie.updated_on.should be_nil
-        green_smoothie.save
-        green_smoothie.updated_at.should be_a_kind_of(DateTime)
-        green_smoothie.updated_on.should be_a_kind_of(Date)
-        original_updated_at = green_smoothie.updated_at
-        original_updated_on = green_smoothie.updated_on
-        time_tomorrow = DateTime.now + 1
-        date_tomorrow = Date.today + 1
-        DateTime.stub!(:now).and_return { time_tomorrow }
-        Date.stub!(:today).and_return { date_tomorrow }
-        green_smoothie.name = 'Cranberry Mango'
-        green_smoothie.save
-        green_smoothie.updated_at.should_not eql(original_updated_at)
-        green_smoothie.updated_on.should_not eql(original_updated_on)
-        green_smoothie.updated_at.should eql(time_tomorrow)
-        green_smoothie.updated_on.should eql(date_tomorrow)
+      it "should only set the updated_at/on fields on dirty objects" do
+        repository(:default) do
+          green_smoothie = GreenSmoothie.new(:name => 'Mango')
+          green_smoothie.updated_at.should be_nil
+          green_smoothie.updated_on.should be_nil
+          green_smoothie.save
+          green_smoothie.updated_at.should be_a_kind_of(DateTime)
+          green_smoothie.updated_on.should be_a_kind_of(Date)
+          original_updated_at = green_smoothie.updated_at
+          original_updated_on = green_smoothie.updated_on
+          time_tomorrow = DateTime.now + 1
+          date_tomorrow = Date.today + 1
+          DateTime.stub!(:now).and_return { time_tomorrow }
+          Date.stub!(:today).and_return { date_tomorrow }
+          green_smoothie.save
+          green_smoothie.updated_at.should_not eql(time_tomorrow)
+          green_smoothie.updated_on.should_not eql(date_tomorrow)
+          green_smoothie.updated_at.should eql(original_updated_at)
+          green_smoothie.updated_on.should eql(original_updated_on)
+        end
       end
     end
 
-    it "should only set the updated_at/on fields on dirty objects" do
-      repository(:default) do
-        green_smoothie = GreenSmoothie.new(:name => 'Mango')
-        green_smoothie.updated_at.should be_nil
-        green_smoothie.updated_on.should be_nil
-        green_smoothie.save
-        green_smoothie.updated_at.should be_a_kind_of(DateTime)
-        green_smoothie.updated_on.should be_a_kind_of(Date)
-        original_updated_at = green_smoothie.updated_at
-        original_updated_on = green_smoothie.updated_on
-        time_tomorrow = DateTime.now + 1
-        date_tomorrow = Date.today + 1
-        DateTime.stub!(:now).and_return { time_tomorrow }
-        Date.stub!(:today).and_return { date_tomorrow }
-        green_smoothie.save
-        green_smoothie.updated_at.should_not eql(time_tomorrow)
-        green_smoothie.updated_on.should_not eql(date_tomorrow)
-        green_smoothie.updated_at.should eql(original_updated_at)
-        green_smoothie.updated_on.should eql(original_updated_on)
+    describe "explicit property declaration" do
+      before do
+        Object.send(:remove_const, :GreenSmoothie) if defined?(GreenSmoothie)
+        class GreenSmoothie
+          include DataMapper::Resource
+
+          property :id, Integer, :serial => true
+          property :name, String
+          property :created_at, DateTime
+          property :created_on, Date
+          property :updated_at, DateTime
+          property :updated_on, Date
+
+          auto_migrate!(:default)
+        end
       end
+
+      it_should_behave_like "Timestamp (shared behavior)"
     end
 
-    describe "inclusion" do
-      before :each do
-        @klass = Class.new do
-          include DataMapper::Resource
+    describe "timestamps helper" do
+      describe "inclusion" do
+        before :each do
+          @klass = Class.new do
+            include DataMapper::Resource
+          end
         end
-      end
 
-      it "should provide #timestamps" do
-        @klass.should respond_to(:timestamps)
-      end
+        it "should provide #timestamps" do
+          @klass.should respond_to(:timestamps)
+        end
 
-      it "should set the *at properties" do
-        @klass.timestamps :at
+        it "should set the *at properties" do
+          @klass.timestamps :at
 
-        @klass.properties.should have_property(:created_at)
-        @klass.properties[:created_at].type.should == DateTime
-        @klass.properties.should have_property(:updated_at)
-        @klass.properties[:updated_at].type.should == DateTime
-      end
+          @klass.properties.should have_property(:created_at)
+          @klass.properties[:created_at].type.should == DateTime
+          @klass.properties.should have_property(:updated_at)
+          @klass.properties[:updated_at].type.should == DateTime
+        end
 
-      it "should set the *on properties" do
-        @klass.timestamps :on
+        it "should set the *on properties" do
+          @klass.timestamps :on
 
-        @klass.properties.should have_property(:created_on)
-        @klass.properties[:created_on].type.should == Date
-        @klass.properties.should have_property(:updated_on)
-        @klass.properties[:updated_on].type.should == Date
-      end
+          @klass.properties.should have_property(:created_on)
+          @klass.properties[:created_on].type.should == Date
+          @klass.properties.should have_property(:updated_on)
+          @klass.properties[:updated_on].type.should == Date
+        end
 
-      it "should set multiple properties" do
-        @klass.timestamps :created_at, :updated_on
+        it "should set multiple properties" do
+          @klass.timestamps :created_at, :updated_on
 
-        @klass.properties.should have_property(:created_at)
-        @klass.properties.should have_property(:updated_on)
-      end
+          @klass.properties.should have_property(:created_at)
+          @klass.properties.should have_property(:updated_on)
+        end
 
-      it "should fail on unknown property name" do
-        lambda { @klass.timestamps :wowee }.should raise_error(DataMapper::Timestamp::InvalidTimestampName)
+        it "should fail on unknown property name" do
+          lambda { @klass.timestamps :wowee }.should raise_error(DataMapper::Timestamp::InvalidTimestampName)
+        end
+
+        it "should fail on empty arguments" do
+          lambda { @klass.timestamps }.should raise_error(ArgumentError)
+        end
       end
 
-      it "should fail on empty arguments" do
-        lambda { @klass.timestamps }.should raise_error(ArgumentError)
+      describe "behavior" do
+        before do
+          Object.send(:remove_const, :GreenSmoothie) if defined?(GreenSmoothie)
+          class GreenSmoothie
+            include DataMapper::Resource
+
+            property :id, Integer, :serial => true
+            property :name, String
+
+            timestamps :at, :on
+
+            auto_migrate!(:default)
+          end
+        end
+
+        it_should_behave_like "Timestamp (shared behavior)"
       end
     end
   end

data/spec/spec.opts

@@ -1,2 +1 @@
---format specdoc
 --colour

data/spec/spec_helper.rb

@@ -1,22 +1,20 @@
+require 'pathname'
 require 'rubygems'
-gem 'rspec', '>=1.1.3'
+
+gem 'rspec', '~>1.1.11'
 require 'spec'
-require 'pathname'
+
 require Pathname(__FILE__).dirname.parent.expand_path + 'lib/dm-timestamps'
 
 def load_driver(name, default_uri)
   return false if ENV['ADAPTER'] != name.to_s
 
-  lib = "do_#{name}"
-
   begin
-    gem lib, '~>0.9.7'
-    require lib
     DataMapper.setup(name, ENV["#{name.to_s.upcase}_SPEC_URI"] || default_uri)
     DataMapper::Repository.adapters[:default] =  DataMapper::Repository.adapters[name]
     true
-  rescue Gem::LoadError => e
-    warn "Could not load #{lib}: #{e}"
+  rescue LoadError => e
+    warn "Could not load do_#{name}: #{e}"
     false
   end
 end

data/tasks/install.rb

@@ -0,0 +1,13 @@
+def sudo_gem(cmd)
+  sh "#{SUDO} #{RUBY} -S gem #{cmd}", :verbose => false
+end
+
+desc "Install #{GEM_NAME} #{GEM_VERSION}"
+task :install => [ :package ] do
+  sudo_gem "install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources"
+end
+
+desc "Uninstall #{GEM_NAME} #{GEM_VERSION}"
+task :uninstall => [ :clobber ] do
+  sudo_gem "uninstall #{GEM_NAME} -v#{GEM_VERSION} -Ix"
+end

data/tasks/spec.rb

@@ -0,0 +1,25 @@
+begin
+  gem 'rspec', '~>1.1.11'
+  require 'spec'
+  require 'spec/rake/spectask'
+
+  task :default => [ :spec ]
+
+  desc 'Run specifications'
+  Spec::Rake::SpecTask.new(:spec) do |t|
+    t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
+    t.spec_files = Pathname.glob((ROOT + 'spec/**/*_spec.rb').to_s)
+
+    begin
+      gem 'rcov', '~>0.8'
+      t.rcov = JRUBY ? false : (ENV.has_key?('NO_RCOV') ? ENV['NO_RCOV'] != 'true' : true)
+      t.rcov_opts << '--exclude' << 'spec'
+      t.rcov_opts << '--text-summary'
+      t.rcov_opts << '--sort' << 'coverage' << '--sort-reverse'
+    rescue LoadError
+      # rcov not installed
+    end
+  end
+rescue LoadError
+  # rspec not installed
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dm-timestamps
 version: !ruby/object:Gem::Version 
-  version: 0.9.7
+  version: 0.9.8
 platform: ruby
 authors: 
 - Foy Savas
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-18 00:00:00 -08:00
+date: 2008-12-07 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -18,23 +18,13 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.9.7
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.8.2
+        version: 0.9.8
     version: 
 description: DataMapper plugin for magical timestamps
 email: 
-- foysavas@gmail.com
+- foysavas [a] gmail [d] com
 executables: []
 
 extensions: []
@@ -43,6 +33,7 @@ extra_rdoc_files:
 - README.txt
 - LICENSE
 - TODO
+- History.txt
 files: 
 - History.txt
 - LICENSE
@@ -55,6 +46,8 @@ files:
 - spec/integration/timestamps_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- tasks/install.rb
+- tasks/spec.rb
 has_rdoc: true
 homepage: http://github.com/sam/dm-more/tree/master/dm-timestamps
 post_install_message: