ardm-timestamps 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 583bcb564f8777f6b7a43110756cd6e899bacb72
+  data.tar.gz: e967770881024b8a92a47afb695fea29b8007b0e
+SHA512:
+  metadata.gz: 5c2806491966e63d2ea5e539643622e387053e3cbb329750e3b57357148c910c8758401305dbe94338897c6c9d07b00bc6537adea2f6070d81e69ee5aa9ebd8e
+  data.tar.gz: 8b6d40458249e8b705176770e1413e690ffb78a6c518d508c1e242b0bae5c1ca6c840814a19523811752946626be318d62634fed0e7a5cb046f7ebc650dc212f

data/.gitignore

@@ -0,0 +1,35 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## Rubinius
+*.rbc
+
+## PROJECT::GENERAL
+*.gem
+coverage
+rdoc
+pkg
+tmp
+doc
+log
+.yardoc
+measurements
+
+## BUNDLER
+.bundle
+Gemfile.*
+
+## PROJECT::SPECIFIC
+spec/db/

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+sudo: false
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.5
+  - 2.2.0
+matrix:
+  allow_failures:
+    - rvm: 2.1.5
+    - rvm: 2.2.0

data/Gemfile

@@ -0,0 +1,55 @@
+require 'pathname'
+
+source 'https://rubygems.org'
+
+gemspec
+
+SOURCE         = ENV.fetch('SOURCE', :git).to_sym
+REPO_POSTFIX   = SOURCE == :path ? ''                                : '.git'
+DATAMAPPER     = SOURCE == :path ? Pathname(__FILE__).dirname.parent : 'http://github.com/ar-dm'
+DM_VERSION     = '~> 1.2.0'
+DO_VERSION     = '~> 0.10.6'
+DM_DO_ADAPTERS = %w[ sqlite postgres mysql oracle sqlserver ]
+CURRENT_BRANCH = ENV.fetch('GIT_BRANCH', 'master')
+
+gem 'ardm-core', DM_VERSION,
+  SOURCE  => "#{DATAMAPPER}/ardm-core#{REPO_POSTFIX}",
+  :branch => CURRENT_BRANCH
+
+group :datamapper do
+
+  adapters = ENV['ADAPTER'] || ENV['ADAPTERS']
+  adapters = adapters.to_s.tr(',', ' ').split.uniq - %w[ in_memory ]
+
+  if (do_adapters = DM_DO_ADAPTERS & adapters).any?
+    do_options = {}
+    do_options[:git] = "#{DATAMAPPER}/do#{REPO_POSTFIX}" if ENV['DO_GIT'] == 'true'
+
+    gem 'data_objects', DO_VERSION, do_options.dup
+
+    do_adapters.each do |adapter|
+      adapter = 'sqlite3' if adapter == 'sqlite'
+      gem "do_#{adapter}", DO_VERSION, do_options.dup
+    end
+
+    gem 'ardm-do-adapter', DM_VERSION,
+      SOURCE  => "#{DATAMAPPER}/ardm-do-adapter#{REPO_POSTFIX}",
+      :branch => CURRENT_BRANCH
+  end
+
+  adapters.each do |adapter|
+    gem "ardm-#{adapter}-adapter", DM_VERSION,
+      SOURCE  => "#{DATAMAPPER}/ardm-#{adapter}-adapter#{REPO_POSTFIX}",
+      :branch => CURRENT_BRANCH
+  end
+
+  plugins = ENV['PLUGINS'] || ENV['PLUGIN']
+  plugins = plugins.to_s.tr(',', ' ').split.push('ardm-migrations').uniq
+
+  plugins.each do |plugin|
+    gem plugin, DM_VERSION,
+      SOURCE  => "#{DATAMAPPER}/#{plugin}#{REPO_POSTFIX}",
+      :branch => CURRENT_BRANCH
+  end
+
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Foy Savas
+
+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,17 @@
+= dm-timestamps
+
+DataMapper plugin which adds "magic" to created_at, created_on, et cetera.
+
+= Using
+
+This plugin works by looking for the "created_at," "updated_at," "created_on"
+and "updated_on" properties. If they exist, it does the right thing by setting
+them or updating them. The *at properties should be of type DateTime, while the
+*on properties should be of type Date.
+
+Alternatively, you can have all of this setup for you if you use the "timestamps"
+helper:
+
+  timestamps :at    # Add created_at and updated_at
+  timestamps :on    # Add created_on and updated_on
+  timestamps :created_at, :updated_on    # Add these only

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'rake'
+
+FileList['tasks/**/*.rake'].each { |task| import task }

data/ardm-timestamps.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/data_mapper/timestamps/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "ardm-timestamps"
+  gem.version       = DataMapper::Timestamps::VERSION
+
+  gem.authors     = [ 'Martin Emde', 'Foy Savas', 'Dan Kubb' ]
+  gem.email       = [ 'me@martinemde.com', "dan.kubb@gmail.com" ]
+  gem.summary     = "Ardm fork of dm-timestamps"
+  gem.description = "DataMapper plugin for magical timestamps"
+  gem.homepage    = "https://github.com/ar-dm/dm-timestamps"
+  gem.license     = 'MIT'
+
+  gem.files            = `git ls-files`.split("\n")
+  gem.test_files       = `git ls-files -- {spec}/*`.split("\n")
+  gem.extra_rdoc_files = %w[LICENSE README.rdoc]
+  gem.require_paths = [ "lib" ]
+
+  gem.add_runtime_dependency 'ardm-core', '~> 1.2'
+
+  gem.add_development_dependency 'rake',  '~> 0.9'
+  gem.add_development_dependency 'rspec', '~> 1.3'
+end
+

data/lib/ardm-timestamps.rb

@@ -0,0 +1 @@
+require 'dm-timestamps'

data/lib/data_mapper/timestamps/version.rb

@@ -0,0 +1,5 @@
+module DataMapper
+  module Timestamps
+    VERSION = '1.2.0'
+  end
+end

data/lib/dm-timestamps.rb

@@ -0,0 +1,70 @@
+require 'dm-core'
+
+module DataMapper
+  module Timestamps
+    TIMESTAMP_PROPERTIES = {
+      :updated_at => [ DateTime, lambda { |r| DateTime.now                             } ],
+      :updated_on => [ Date,     lambda { |r| Date.today                               } ],
+      :created_at => [ DateTime, lambda { |r| r.created_at || (DateTime.now if r.new?) } ],
+      :created_on => [ Date,     lambda { |r| r.created_on || (Date.today   if r.new?) } ],
+    }.freeze
+
+    def self.included(model)
+      model.before :save, :set_timestamps_on_save
+      model.extend ClassMethods
+    end
+
+    # Saves the record with the updated_at/on attributes set to the current time.
+    def touch
+      set_timestamps
+      save
+    end
+
+    private
+
+    def set_timestamps_on_save
+      return unless dirty?
+      set_timestamps
+    end
+
+    def set_timestamps
+      TIMESTAMP_PROPERTIES.each do |name,(_type,proc)|
+        if properties.named?(name)
+          attribute_set(name, proc.call(self))
+        end
+      end
+    end
+
+    module ClassMethods
+      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
+              options = { :required => true }
+
+              if Property.accepted_options.include?(:auto_validation)
+                options.update(:auto_validation => false)
+              end
+
+              property name, TIMESTAMP_PROPERTIES[name].first, options
+            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 # module ClassMethods
+
+    class InvalidTimestampName < RuntimeError; end
+
+    Model.append_inclusions self
+  end # module Timestamp
+
+  # include Timestamp or Timestamps, it still works
+  Timestamp = Timestamps
+end # module DataMapper

data/spec/integration/timestamps_spec.rb

@@ -0,0 +1,199 @@
+require 'spec_helper'
+
+describe 'DataMapper::Timestamp' do
+
+  supported_by :all do
+
+    describe "Timestamp (shared behavior)", :shared => true do
+      it "should not set the created_at/on fields if they're already set" 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
+
+      it "should set the created_at/on fields on creation" 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
+
+      it "should not alter the create_at/on fields on model updates" 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
+
+      it "should set the updated_at/on fields on creation and on update" 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
+
+      it "should only set the updated_at/on fields on dirty objects" 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
+
+      describe '#touch' do
+        it 'should update the updated_at/on fields' do
+          green_smoothie = GreenSmoothie.create(:name => 'Mango')
+
+          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.touch
+
+          green_smoothie.updated_at.should eql(time_tomorrow)
+          green_smoothie.updated_on.should eql(date_tomorrow)
+        end
+
+        it 'should not update the created_at/on fields' do
+          green_smoothie = GreenSmoothie.create(:name => 'Mango')
+
+          original_created_at = green_smoothie.created_at
+          original_created_on = green_smoothie.created_on
+
+          green_smoothie.touch
+
+          green_smoothie.created_at.should equal(original_created_at)
+          green_smoothie.created_on.should equal(original_created_on)
+        end
+      end
+    end
+
+    describe "explicit property declaration" do
+      before do
+        Object.send(:remove_const, :GreenSmoothie) if defined?(GreenSmoothie)
+        class GreenSmoothie
+          include DataMapper::Resource
+
+          property :id,         Serial
+          property :name,       String
+          property :created_at, DateTime, :required => true
+          property :created_on, Date,     :required => true
+          property :updated_at, DateTime, :required => true
+          property :updated_on, Date,     :required => true
+
+          auto_migrate!
+        end
+      end
+
+      it_should_behave_like "Timestamp (shared behavior)"
+    end
+
+    describe "implicit property declaration" do
+      before do
+        Object.send(:remove_const, :GreenSmoothie) if defined?(GreenSmoothie)
+        class GreenSmoothie
+          include DataMapper::Resource
+
+          property :id,   Serial
+          property :name, String
+
+          timestamps :at, :on
+
+          auto_migrate!
+        end
+      end
+
+      it_should_behave_like "Timestamp (shared behavior)"
+    end
+
+    describe "timestamps helper" do
+      describe "inclusion" do
+        before :each do
+          @klass = Class.new do
+            include DataMapper::Resource
+          end
+        end
+
+        it "should provide #timestamps" do
+          @klass.should respond_to(:timestamps)
+        end
+
+        it "should set the *at properties" do
+          @klass.timestamps :at
+
+          @klass.properties.should be_named(:created_at)
+          @klass.properties[:created_at].should be_kind_of(DataMapper::Property::DateTime)
+          @klass.properties.should be_named(:updated_at)
+          @klass.properties[:updated_at].should be_kind_of(DataMapper::Property::DateTime)
+        end
+
+        it "should set the *on properties" do
+          @klass.timestamps :on
+
+          @klass.properties.should be_named(:created_on)
+          @klass.properties[:created_on].should be_kind_of(DataMapper::Property::Date)
+          @klass.properties.should be_named(:updated_on)
+          @klass.properties[:updated_on].should be_kind_of(DataMapper::Property::Date)
+        end
+
+        it "should set multiple properties" do
+          @klass.timestamps :created_at, :updated_on
+
+          @klass.properties.should be_named(:created_at)
+          @klass.properties.should be_named(:updated_on)
+        end
+
+        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
+    end
+
+  end
+
+end

data/spec/rcov.opts

@@ -0,0 +1,6 @@
+--exclude "spec,^/"
+--sort coverage
+--callsites
+--xrefs
+--profile
+--text-summary

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--loadby random
+--format profile
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'dm-core/spec/setup'
+require 'dm-core/spec/lib/adapter_helpers'
+
+require 'dm-timestamps'
+require 'dm-migrations'
+
+DataMapper::Spec.setup
+
+Spec::Runner.configure do |config|
+  config.extend(DataMapper::Spec::Adapters::Helpers)
+end

data/tasks/spec.rake

@@ -0,0 +1,38 @@
+spec_defaults = lambda do |spec|
+  spec.pattern    = 'spec/**/*_spec.rb'
+  spec.libs      << 'lib' << 'spec'
+  spec.spec_opts << '--options' << 'spec/spec.opts'
+end
+
+begin
+  require 'spec/rake/spectask'
+
+  Spec::Rake::SpecTask.new(:spec, &spec_defaults)
+rescue LoadError
+  task :spec do
+    abort 'rspec is not available. In order to run spec, you must: gem install rspec'
+  end
+end
+
+begin
+  require 'rcov'
+  require 'spec/rake/verify_rcov'
+
+  Spec::Rake::SpecTask.new(:rcov) do |rcov|
+    spec_defaults.call(rcov)
+    rcov.rcov      = true
+    rcov.rcov_opts = File.read('spec/rcov.opts').split(/\s+/)
+  end
+
+  RCov::VerifyTask.new(:verify_rcov => :rcov) do |rcov|
+    rcov.threshold = 100
+  end
+rescue LoadError
+  %w[ rcov verify_rcov ].each do |name|
+    task name do
+      abort "rcov is not available. In order to run #{name}, you must: gem install rcov"
+    end
+  end
+end
+
+task :default => :spec

data/tasks/yard.rake

@@ -0,0 +1,9 @@
+begin
+  require 'yard'
+
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yard do
+    abort 'YARD is not available. In order to run yard, you must: gem install yard'
+  end
+end

data/tasks/yardstick.rake

@@ -0,0 +1,19 @@
+begin
+  require 'pathname'
+  require 'yardstick/rake/measurement'
+  require 'yardstick/rake/verify'
+
+  # yardstick_measure task
+  Yardstick::Rake::Measurement.new
+
+  # verify_measurements task
+  Yardstick::Rake::Verify.new do |verify|
+    verify.threshold = 100
+  end
+rescue LoadError
+  %w[ yardstick_measure verify_measurements ].each do |name|
+    task name.to_s do
+      abort "Yardstick is not available. In order to run #{name}, you must: gem install yardstick"
+    end
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: ardm-timestamps
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Martin Emde
+- Foy Savas
+- Dan Kubb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ardm-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: DataMapper plugin for magical timestamps
+email:
+- me@martinemde.com
+- dan.kubb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- ardm-timestamps.gemspec
+- lib/ardm-timestamps.rb
+- lib/data_mapper/timestamps/version.rb
+- lib/dm-timestamps.rb
+- spec/integration/timestamps_spec.rb
+- spec/rcov.opts
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/spec.rake
+- tasks/yard.rake
+- tasks/yardstick.rake
+homepage: https://github.com/ar-dm/dm-timestamps
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ardm fork of dm-timestamps
+test_files: []
+has_rdoc: