dm-actionstamps-jwr 0.0.3

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 kematzy
+
+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,180 @@
+= dm-actionstamps
+
+A DataMapper plugin that works similar to the dm-timestamps in that it 'automagically' adds/updates the
+created_?, updated_? fields of your models.
+
+This is a completely rewritten version of the "rlivesey's"[http://github.com/rlivsey/] <tt>"dm-userstamp"[http://github.com/rlivsey/dm-userstamp]</tt> gem. 
+
+It was rewritten and given a new new when I made more dynamic in nature than dm-userstamp.
+
+
+== Installation
+  
+  $  (sudo)? gem install dm-actionstamps
+  
+<b>NB! Depends upon the whole DataMapper suite being installed, and has ONLY been tested with DM 0.10.2.</b>
+
+
+== Getting Started
+
+
+
+Require <tt>dm-actionstamps</tt> in your app.
+
+  require 'dm-core'         # must be required first
+  require 'dm-actionstamps'
+
+
+Lets say we have a User class and we want to track the user actions in our other models. Just do as follows:
+
+  class User
+    include DataMapper::Resource
+    property :id, Serial
+    property :name, String
+    
+    provides_actionstamps
+    
+  end
+  
+
+By declaring <tt>:provides_actionstamps</tt> in your User model, you get the following functionality free.
+
+  User.current_user = new user...
+  
+  User.current_user  => retrieves the current_user
+  
+  
+You can then use it as follows:
+  
+  @user = User.create(:id => 99, :name => "Joe")
+  
+  User.current_user = @user
+  
+  
+  # retrieve the current user info.
+  User.current_user.id   =>  returns 99
+  
+
+OK, so far not so exciting, but lets say we have an Article class, and we want to track the User that 
+created the Article and the last User that updated the Article. It's easy too:
+
+    class Article
+      include DataMapper::Resource
+      property :id,     Serial
+      property :title,   String
+      ...<snip>
+      
+      actionstamps :by, User
+      
+    end
+    
+Once you have your Article model we can create our Articles just as normal:
+
+    @article = Article.create(:title => 'Example 1')
+    
+
+The instance of <tt>Article.get(1)</tt> now has the following things for free:
+
+* a <tt>:created_by</tt> attribute with the value of <tt>User.current_user.id</tt> if set. Default value is <tt>nil</tt>.
+
+* a <tt>:updated_by</tt> attribute with the value of <tt>User.current_user.id</tt> if set. Default value is <tt>nil</tt>.
+
+
+So given this usage scenario:
+
+  @user = User.create(:id => 99, :name => "Joe")
+  User.current_user = @user
+  
+  @article = Article.create(:title => 'Example 2')
+  
+  
+The Article instance should have the following:
+
+  @article.created_by   => 99
+  @article.updated_by   => 99
+  
+
+== Customisations
+
+<tt>dm-actionstamps</tt> plugin/gem was created because I needed to track the actions of Client, Staff and other 'User' models, 
+and the <tt>"dm-userstamp"[http://github.com/rlivsey/dm-userstamp]</tt> gem was hardcoded to the <tt>User</tt> model.
+
+To support more flexible declarations, I have separated out the functionality into two parts:
+
+* Provider Model
+* Receiver Model
+
+
+The Provider Model provides the actionstamps, and can be declared like this:
+
+  class Client
+    include DataMapper::Resource
+    property :id, Serial
+    property :name, String
+    
+    provides_actionstamps
+    
+  end
+  
+In difference to the examples above, the <tt>current_?</tt> methods takes the name of the Model that was given the provider status (via the <tt>:provides_actionstamps</tt> method):
+  
+  Client.current_client =  Client.create(:id => 88, :name => "Happy")
+  
+  Client.current_client   => returns the Client
+  
+
+
+The Receiver Model receives the actionstamps and can be declared like this:
+
+
+  class Bill
+    include DataMapper::Resource
+    property :id,     Serial
+    property :amount, Integer
+    ...<snip>
+  
+    actionstamps :by, Client
+  
+  end
+  
+  
+So when we create a new instance of Bill, we get the values from the Client.current_client method:
+  
+  @bill = Bill.create(:amount => "100")
+  
+  @bill.created_by   =>  88
+    
+
+== TODO
+
+* Contemplate if there is ever a scenario where you need to track two different models updating the same record?  (Seller vs Buyers ?)
+
+* Think of some clever way to automagically set "User.current_user = @user" when you load or create a new User in your enclosing application.
+
+* Any other improvements that you can think of?
+
+
+== RTFM 
+
+For a better understanding of this gem/plugin, make sure you study the '<tt>dm-actionstamps/spec/integration/actionstamps_spec.rb</tt>' file.
+
+
+== Errors / Bugs
+
+If something is not behaving intuitively, it is a bug, and should be reported.
+Report it here: http://github.com/kematzy/dm-actionstamps/issues
+
+== 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) 2010 kematzy. Released under the MIT license.
+

data/Rakefile

@@ -0,0 +1,89 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dm-actionstamps"
+    gem.summary = %Q{A DataMapper plugin that automatically adds/updates the created_?, updated_? fields of your models.}
+    gem.description = %Q{A few fixes to kematzy's dm-actionstamps DataMapper plugin that works similar to the dm-timestamps in that it 'automagically' adds/updates the created_?, updated_? fields of your models.}
+    gem.email = "joelwreed@gmail.com"
+    gem.homepage = "http://github.com/joelwreed/dm-actionstamps"
+    gem.authors = ["joelwreed", "kematzy"]
+    gem.add_dependency "dm-core", ">= 1.0"
+    gem.add_development_dependency "rspec", ">= 1.3.0"
+    # 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 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_opts = ["--color", "--format", "nested", "--require", "spec/spec_helper.rb"]
+  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
+
+namespace :spec do
+
+  desc "Run all specifications verbosely"
+  Spec::Rake::SpecTask.new(:quiet) do |t|
+    t.libs << "lib"
+    t.spec_opts = ["--color", "--require", "spec/spec_helper.rb"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+  
+  desc "Run specific spec verbosely (SPEC=/path/2/file)"
+  Spec::Rake::SpecTask.new(:select) do |t|
+    t.libs << "lib"
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"] 
+    t.spec_files = [ENV["SPEC"]]
+  end
+  
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "DM::ActionStamps #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Build the rdoc HTML Files'
+task :docs do
+  version = File.exist?('VERSION') ? IO.read('VERSION').chomp : "[Unknown]" 
+  
+  sh "sdoc -N --title 'DM::ActionStamps v#{version}' lib/ README.rdoc"
+end
+
+
+namespace :docs do
+  
+  # desc 'Remove rdoc products'
+  # task :remove => [:clobber_rdoc]
+  # 
+  # desc 'Force a rebuild of the RDOC files'
+  # task :rebuild => [:rerdoc]
+  
+  desc 'Build docs, and open in browser for viewing (specify BROWSER)'
+  task :open => [:docs] do
+    browser = ENV["BROWSER"] || "safari"
+    sh "open -a #{browser} doc/index.html"
+  end
+  
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/dm-actionstamps.gemspec

@@ -0,0 +1,59 @@
+# 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{dm-actionstamps-jwr}
+  s.version = "0.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["kematzy", "jreed"]
+  s.date = %q{2013-05-30}
+  s.description = %q{A few fixes to kematzy's DataMapper plugin that works similar to the dm-timestamps in that it 'automagically' adds/updates the created_?, updated_? fields of your models.}
+  s.email = %q{joelwreed@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "dm-actionstamps.gemspec",
+     "lib/dm-actionstamps.rb",
+     "lib/dm-actionstamps/actionstamps.rb",
+     "lib/dm-actionstamps/version.rb",
+     "spec/integration/actionstamps_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/joelwreed/dm-actionstamps}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A DataMapper plugin that automatically adds/updates the created_?, updated_? fields of your models.}
+  s.test_files = [
+    "spec/integration/actionstamps_spec.rb",
+     "spec/spec_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::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<dm-core>, [">= 1.0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+    else
+      s.add_dependency(%q<dm-core>, [">= 1.0"])
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    end
+  else
+    s.add_dependency(%q<dm-core>, [">= 1.0"])
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+  end
+end
+

data/lib/dm-actionstamps.rb

@@ -0,0 +1,16 @@
+
+# Need to import datamapper and other gems
+# require 'rubygems' # read [ http://gist.github.com/54177 ] to understand why this line is commented out
+require 'pathname'
+
+# Add all external dependencies for the plugin here
+# gem 'dm-core', '~> 0.10.2'
+require 'dm-core'
+
+# Require plugin-files
+require 'dm-actionstamps/actionstamps.rb'
+
+DataMapper::Model.append_extensions(DataMapper::Actionstamps)
+# DataMapper::Model.append_inclusions(DataMapper::Actionstamps)
+
+

data/lib/dm-actionstamps/actionstamps.rb

@@ -0,0 +1,151 @@
+
+require 'dm-core'
+
+module DataMapper 
+  module Actionstamps 
+    
+    ##
+    # Provider method, used to setup the +current_user+ information.
+    #  
+    # ==== Examples
+    # 
+    #   class User
+    #     <snip...>
+    #     
+    #     provides_actionstamps
+    #     
+    #   end
+    #     
+    #     => creates the :current_user & :current_user= methods
+    # 
+    #   class Client
+    #     <snip...>
+    #     
+    #     provides_actionstamps
+    #     
+    #   end
+    #     
+    #     => creates the :current_client & :current_client= methods
+    # 
+    # 
+    # @api public
+    def provides_actionstamps 
+      @actionstamps_class = self
+      
+      extend DataMapper::Actionstamps::ClassMethods
+      
+      class_eval(<<-END, __FILE__, __LINE__)
+        def self.current_#{name.downcase}=(user)
+          Thread.current["#{name.downcase}_#{self.object_id}_actionstamp"] = user
+        end
+        def self.current_#{name.downcase}
+          Thread.current["#{name.downcase}_#{self.object_id}_actionstamp"]
+        end
+      END
+    end
+    
+    
+    ##
+    # The Receiver Model receives the actionstamps and defines the
+    # 
+    # ==== Examples
+    # 
+    #   class Bill
+    #     include DataMapper::Resource
+    #     property :id,     Serial
+    #     property :amount, Integer
+    #     ...<snip>
+    #     
+    #     actionstamps :by, Client
+    #     
+    #   end
+    #     
+    #     => creates the :created_by and :updated_by fields.
+    # 
+    #   actionstamps :by_id, Author
+    # 
+    # 
+    # @api public/private
+    def actionstamps(*args)
+      # set default args if none passed in
+      args = [:by, ::User ] if args.empty?
+      # if invalid args, just bail out
+      if ( args[0].is_a?(Hash) || nil ) || ( args[1].is_a?(Hash) || args[1].is_a?( Symbol) || args[1].is_a?(String) || nil )
+        raise ArgumentError, "Invalid arguments passed: syntax: actionstamps :by, ModelName"
+      end
+      
+      configs = { :suffix => args[0], :model => args[1] }
+      
+      # do we have the fields :created_? / :updated_? declared, if not we declare them
+      if properties.any? { |p| p.name.to_s =~ /^(created|updated)_#{Regexp.escape(configs[:suffix].to_s)}$/ }
+        # if they are declared then we use them
+        raise ArgumentError, "Full functionality NOT implemented yet. Please DO NOT declare your created_#{configs[:suffix]} / updated_#{configs[:suffix]} properties, they will be automatically declared by this plugin."
+      else
+        property "created_#{configs[:suffix]}".to_sym, Integer#, :default => 1
+        property "updated_#{configs[:suffix]}".to_sym, Integer#, :default => 1
+      end
+      
+      @actionstamps_receiver_properties = ["created_#{configs[:suffix]}".to_sym, "updated_#{configs[:suffix]}".to_sym ]
+      @actionstamps_model_class = configs[:model].to_s.capitalize
+      
+      extend DataMapper::Actionstamps::ClassMethods
+      include DataMapper::Actionstamps::ReceiverMethods
+      
+      
+      class_eval(<<-END, __FILE__, __LINE__)
+        def set_actionstamps
+          self.created_#{configs[:suffix].to_s} = #{configs[:model]}.current_#{configs[:model].to_s.downcase}.id if #{configs[:model]}.current_#{configs[:model].to_s.downcase} && self.new? && self.created_#{configs[:suffix].to_s}.nil?
+          self.updated_#{configs[:suffix].to_s} = #{configs[:model]}.current_#{configs[:model].to_s.downcase}.id if #{configs[:model]}.current_#{configs[:model].to_s.downcase}
+        end
+      END
+      
+    end #/def actionstamps
+    
+    module ClassMethods
+      attr_reader :actionstamps_class
+    end #/module ClassMethods
+    
+    
+    module ReceiverMethods
+      
+      def self.included(model)
+        model.before :save, :set_actionstamps_on_save
+        model.extend DataMapper::Actionstamps::ClassMethods
+      end
+      
+      ##
+      # Saves the record with the created_? / updated_? attributes set to the current time.
+      #  
+      # ==== Examples
+      # 
+      #   @model.touch
+      # 
+      # @api public
+      def touch 
+        set_actionstamps
+        save
+      end
+      
+      
+      private
+        
+        ##
+        # Callback method
+        #  
+        # ==== Examples
+        # 
+        #   before :save, :set_actionstamps_on_save
+        #   
+        # 
+        # @api public
+        def set_actionstamps_on_save 
+          return unless dirty?
+          set_actionstamps
+        end
+        
+        
+    end #/module ReceiverMethods
+    
+  end #/module Actionstamps
+  
+end #/module DataMapper

data/lib/dm-actionstamps/version.rb

@@ -0,0 +1,5 @@
+module DataMapper
+  module Actionstamps
+    VERSION = "0.0.3"
+  end
+end

data/spec/integration/actionstamps_spec.rb

@@ -0,0 +1,576 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+
+return unless HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
+
+describe "DataMapper::Actionstamps" do 
+  
+  describe "Default behaviours" do 
+    
+    before(:all) do 
+      class User 
+        include DataMapper::Resource
+        property :id, Serial
+        property :name, String
+        
+        provides_actionstamps
+      end
+      
+      class Article 
+        include DataMapper::Resource 
+        property :id, Serial 
+        property :title, String
+        
+        actionstamps #:by, User 
+      end
+      
+      DataMapper.auto_migrate!
+    end
+    
+    before(:each) do 
+      @user = User.create(:name => "Joe", :id => 99)
+      # User.current_user = @user
+    end
+    
+    after do 
+      User.all.destroy!
+      Article.all.destroy!
+    end
+    
+    describe "Provider Model" do 
+      
+      describe "#self.actionstamps_class" do 
+        
+        it "should return the constant of the Actionstamps provider class" do 
+          User.actionstamps_class.should == User
+          
+          class Donkey
+            include DataMapper::Resource
+            property :id, Serial
+            property :name, String
+            
+            provides_actionstamps
+          end
+          Donkey.actionstamps_class.should == Donkey
+        end
+        
+      end #/ #self.actionstamps_class
+      
+      describe "#self.current_user=(user)" do 
+        
+        it "should respond to :current_user=" do 
+          User.should respond_to(:current_user=)
+        end
+        
+        it "should allow setting a new user" do 
+          lambda { 
+            User.current_user = User.create(:id => 77, :name => "Adam")
+          }.should_not raise_error(Exception)
+        end
+        
+      end #/ #self.current_user=(user)
+      
+      
+      describe "#self.current_user" do 
+        
+        it "should respond to :current_user" do 
+          User.should respond_to(:current_user)
+        end
+        
+        it "should return the currently assigned User" do 
+          User.current_user.id.should == 77
+        end
+        
+      end #/ #self.current_user
+      
+    end #/ Provider Model
+    
+    describe "Receiver Model" do 
+      
+      describe "when there is NO current_user" do 
+        
+        before(:each) do 
+          User.current_user = nil
+        end
+        
+        it "should not set the created_by" do 
+          User.current_user.should == nil
+          a = Article.create(:title => "This also works")
+          a.created_by.should == nil
+          a.updated_by.should == nil
+        end
+        
+        it "should not set the updated_by" do 
+          User.current_user.should == nil
+          a = Article.create(:title => "This also works")
+          a.updated_by.should == nil
+        end
+        
+        it "should set :updated_by and NOT set :created_by when touched" do 
+          User.current_user.should == nil  # sanity
+          a = Article.create(:title => "Absolutely Amazing, it all works" )
+          
+          a.touch
+          
+          a.updated_by.should == nil
+          a.created_by.should == nil
+        end
+        
+      end #/ when there is NO current_user
+      
+      describe "when there is a current_user" do 
+        
+        before(:each) do 
+          User.current_user = @user
+        end
+        
+        it "should NOT set if :created_by is already set" do 
+          User.current_user.id.should == 99  # sanity
+          a = Article.new(:title => "Hell, this works too" )
+          a.created_by = 5
+          a.save
+          a.created_by.should == 5
+          a.created_by.should be_a_kind_of(Integer)
+        end
+        
+        it "should set :created_by on creation" do 
+          User.current_user.id.should == 99  # sanity
+          a = Article.new(:title => "Hell, this works as well!" )
+          a.created_by.should == nil
+          a.save
+          a.created_by.should be_a_kind_of(Integer)
+          a.created_by.should == User.current_user.id
+        end
+        
+        it "should NOT alter :created_by on model updates" do 
+          User.current_user.id.should == 99  # sanity
+          a = Article.new(:title => "Even this works" )
+          a.created_by.should == nil
+          a.save
+          a.created_by.should be_a_kind_of(Integer)
+          a.created_by.should == User.current_user.id
+          
+          u = User.create(:name => "Eve", :id => 88)
+          User.current_user = u
+          a.title = "Updating things works as well"
+          a.save
+          a.created_by.should_not == User.current_user.id
+          a.updated_by.should == User.current_user.id
+        end
+        
+        it "should set :updated_by on creation and on update" do 
+          User.current_user.id.should == 99  # sanity
+          a = Article.new(:title => "This is just great, it all works" )
+          a.updated_by.should == nil
+          a.save
+          a.updated_by.should be_a_kind_of(Integer)
+          a.updated_by.should == User.current_user.id
+          
+          u = User.create(:name => "Eve", :id => 88)
+          User.current_user = u
+          a.title = "Updating things works as well"
+          a.save
+          a.updated_by.should == User.current_user.id
+          a.updated_by.should_not == @user.id
+        end
+        
+        it "should set :updated_by and NOT set :created_by when touched" do 
+          User.current_user.id.should == 99  # sanity
+          a = Article.create(:title => "Absolutely Amazing, it all works" )
+          a.created_by.should be_a_kind_of(Integer)
+          a.created_by.should == User.current_user.id
+          a.updated_by.should be_a_kind_of(Integer)
+          a.updated_by.should == User.current_user.id
+          
+          User.current_user = User.create(:name => "Eve", :id => 88)
+          User.current_user.id.should == 88
+          
+          a.touch
+          
+          a.updated_by.should == User.current_user.id
+          a.created_by.should_not == User.current_user.id
+          a.created_by.should == @user.id
+        end
+        
+      end #/ when there is a current_user
+      
+    end #/ Receiver Model
+    
+  end #/ Default behaviours
+  
+  describe "Error Handling" do 
+    
+    describe "Provider declarations" do 
+      
+      it "should raise an ArgumentError when passed an arg" do 
+        lambda { 
+          class Client
+            include DataMapper::Resource 
+            property :id, Serial 
+            property :name, String
+            
+            provides_actionstamps :some_value
+            
+            # actionstamps :by, User
+          end
+          
+        }.should raise_error(ArgumentError)
+      end
+      
+    end #/ Provider declarations
+    
+    describe "Receiver declarations" do 
+      
+      it "should raise an ArgumentError when passed a Hash as the 1st arg" do 
+        lambda { 
+          class Post
+            include DataMapper::Resource 
+            property :id, Serial 
+            property :title, String
+            
+            actionstamps :model => :user 
+          end
+          
+        }.should raise_error(ArgumentError)
+      end
+      
+      it "should raise an ArgumentError when passed a Hash as the 2nd args" do 
+        lambda { 
+          class Post
+            include DataMapper::Resource 
+            property :id, Serial 
+            property :title, String
+            
+            actionstamps :by, :model => :user 
+          end
+        }.should raise_error(ArgumentError)
+      end
+      
+      it "should raise an ArgumentError when passed a Symbol as the 2nd args" do 
+        lambda { 
+          class Post
+            include DataMapper::Resource 
+            property :id, Serial 
+            property :title, String
+            
+            actionstamps :by, :user 
+          end
+        }.should raise_error(ArgumentError)
+      end
+      
+      it "should raise an ArgumentError when passed a String as the 2nd args" do 
+        lambda { 
+          class Post
+            include DataMapper::Resource 
+            property :id, Serial 
+            property :title, String
+            
+            actionstamps :by, "User" 
+          end
+        }.should raise_error(ArgumentError)
+      end
+      
+      it "should raise an ArgumentError when passed a non-existant model as the 2nd args" do 
+        lambda { 
+          class Post
+            include DataMapper::Resource 
+            property :id, Serial 
+            property :title, String
+            
+            actionstamps :by, ::DoesNotExist
+          end
+        }.should raise_error(NameError)
+      end
+      
+      it "should raise an ArgumentError when declaring a property by the same name" do 
+        lambda { 
+          class Post
+            include DataMapper::Resource 
+            property :id, Serial 
+            property :title, String
+            
+            property :created_by_id, Integer
+            
+            actionstamps :by_id, ::User
+          end
+        }.should raise_error(ArgumentError)
+      end
+      
+    end #/ Receiver declarations
+    
+  end #/ Error Handling
+  
+  describe "Associations" do 
+    
+    describe "when using :created_by_id" do 
+      
+      before(:each) do 
+        class Author
+          include DataMapper::Resource
+          property :id, Serial
+          property :name, String
+          
+          provides_actionstamps
+          
+          has n, :articles, 'Article', :parent_key => [:id], :child_key => [:created_by_id] 
+          has n, :authored_articles, 'Article', :parent_key => [:id], :child_key => [:created_by_id] 
+          has n, :updated_articles, 'Article', :parent_key => [:id], :child_key => [:updated_by_id] 
+        end
+        
+        class Article 
+          include DataMapper::Resource
+          property :id, Serial
+          property :title, String
+          
+          actionstamps :by_id, Author
+          
+          belongs_to :author, 'Author', :parent_key => [:id], :child_key => [:created_by_id]
+          belongs_to :updater, 'Author', :parent_key => [:id], :child_key => [:updated_by_id]
+        end
+        
+        DataMapper.auto_migrate!
+        
+        @author_joe = Author.create(:id => 22, :name => "Joe")
+        @author_jane = Author.create(:id => 33, :name => "Jane")
+        
+        Author.current_author = @author_joe
+        
+        @article1 = Article.create(:title => "Article 1")
+        @article2 = Article.create(:title => "Article 2")
+        @article3 = Article.create(:title => "Article 3")
+        
+        Author.current_author = @author_jane      
+        @article4 = Article.create(:title => "Article 4")
+        @article5 = Article.create(:title => "Article 5")
+        @article6 = Article.create(:title => "Article 6")
+        
+        # update
+        @article3.title = "Article 3 updated"  # set updater to Jane
+        @article3.save
+        
+      end
+      
+      describe "Author" do 
+        
+        describe "has n :authored_articles" do 
+          
+          it "should respond to :authored_articles" do 
+            @author_joe.should respond_to(:authored_articles)
+          end
+          
+          it "should return all the articles created by the author" do 
+            @author_joe.authored_articles.map(&:id).should == [1,2,3]
+            @author_jane.authored_articles.map(&:id).should == [4,5,6]
+          end
+          
+        end #/ has n :authored_articles
+        
+        describe "has n :updated_articles" do 
+          
+          it "should respond to :updated_articles" do 
+            @author_joe.should respond_to(:updated_articles)
+          end
+          
+          it "should return all the articles updated by author" do 
+            @author_joe.updated_articles.map(&:id).should == [1,2]
+            @author_jane.updated_articles.map(&:id).should == [3,4,5,6]
+          end
+          
+        end #/ has n :updated_articles
+        
+        describe "has n :articles" do 
+          
+          it "should respond to :articles" do 
+            @author_joe.should respond_to(:articles)
+          end
+          
+          it "should return all the articles created by the author" do 
+            @author_joe.articles.map(&:id).should == [1,2,3]
+            @author_jane.articles.map(&:id).should == [4,5,6]
+          end
+          
+        end #/ has n :articles
+        
+      end #/ Author
+      
+      describe "Article" do 
+        
+        describe "belongs_to :author" do 
+          
+          it "should respond to :author" do 
+            @article1.should respond_to(:author)
+          end
+          
+          it "should return the author" do 
+            @article1.author.should == @author_joe
+            @article4.author.should == @author_jane
+          end
+          
+        end #/ belongs_to :author
+        
+        describe "belongs_to :updater" do 
+          
+          it "should respond to :updater" do 
+            @article1.should respond_to(:updater)
+          end
+          
+          it "should return the updater" do 
+            @article1.updater.should == @author_joe
+            @article3.updater.should == @author_jane
+          end
+          
+        end #/ belongs_to :author
+        
+      end #/ Article
+      
+    end #/ when using :created_by_id 
+    
+    describe "when using :created_by" do 
+      
+      before(:each) do 
+        class Author
+          include DataMapper::Resource
+          property :id, Serial
+          property :name, String
+          
+          provides_actionstamps
+          
+          has n, :articles, 'Article', :parent_key => [:id], :child_key => [:created_by] 
+          has n, :authored_articles, 'Article', :parent_key => [:id], :child_key => [:created_by] 
+          has n, :updated_articles, 'Article', :parent_key => [:id], :child_key => [:updated_by] 
+        end
+        
+        class Article 
+          include DataMapper::Resource
+          property :id, Serial
+          property :title, String
+          
+          actionstamps :by, Author
+          
+          belongs_to :author, 'Author', :parent_key => [:id], :child_key => [:created_by]
+          belongs_to :updater, 'Author', :parent_key => [:id], :child_key => [:updated_by]
+        end
+        
+        DataMapper.auto_migrate!
+        
+        @author_joe = Author.create(:id => 22, :name => "Joe")
+        @author_jane = Author.create(:id => 33, :name => "Jane")
+        
+        Author.current_author = @author_joe
+        
+        @article1 = Article.create(:title => "Article 1")
+        @article2 = Article.create(:title => "Article 2")
+        @article3 = Article.create(:title => "Article 3")
+        
+        Author.current_author = @author_jane      
+        @article4 = Article.create(:title => "Article 4")
+        @article5 = Article.create(:title => "Article 5")
+        @article6 = Article.create(:title => "Article 6")
+        
+        # update
+        @article3.title = "Article 3 updated"  # set updater to Jane
+        @article3.save
+        
+      end
+      
+      describe "Author" do 
+        
+        describe "has n :authored_articles" do 
+          
+          it "should respond to :authored_articles" do 
+            @author_joe.should respond_to(:authored_articles)
+          end
+          
+          it "should return all the articles created by the author" do 
+            @author_joe.authored_articles.map(&:id).should == [1,2,3]
+            @author_jane.authored_articles.map(&:id).should == [4,5,6]
+          end
+          
+        end #/ has n :authored_articles
+        
+        describe "has n :updated_articles" do 
+          
+          it "should respond to :updated_articles" do 
+            @author_joe.should respond_to(:updated_articles)
+          end
+          
+          it "should return all the articles updated by author" do 
+            @author_joe.updated_articles.map(&:id).should == [1,2]
+            @author_jane.updated_articles.map(&:id).should == [3,4,5,6]
+          end
+          
+        end #/ has n :updated_articles
+        
+        describe "has n :articles" do 
+          
+          it "should respond to :articles" do 
+            @author_joe.should respond_to(:articles)
+          end
+          
+          it "should return all the articles created by the author" do 
+            @author_joe.articles.map(&:id).should == [1,2,3]
+            @author_jane.articles.map(&:id).should == [4,5,6]
+          end
+          
+        end #/ has n :articles
+        
+      end #/ Author
+      
+      describe "Article" do 
+        
+        describe "belongs_to :author" do 
+          
+          it "should respond to :author" do 
+            @article1.should respond_to(:author)
+          end
+          
+          it "should return the author" do 
+            @article1.author.should == @author_joe
+            @article4.author.should == @author_jane
+          end
+          
+        end #/ belongs_to :author
+        
+        describe "belongs_to :updater" do 
+          
+          it "should respond to :updater" do 
+            @article1.should respond_to(:updater)
+          end
+          
+          it "should return the updater" do 
+            @article1.updater.should == @author_joe
+            @article3.updater.should == @author_jane
+          end
+          
+        end #/ belongs_to :author
+        
+      end #/ Article
+      
+    end #/ when using :created_by 
+    
+  end #/ Associations
+  
+  
+  describe "Client Model" do 
+    
+    before(:each) do 
+      class Client
+        include DataMapper::Resource
+        property :id, Serial
+        property :name, String
+        
+        provides_actionstamps
+      end
+      
+    end
+    %w(current_client current_client=).each do |m|
+      it "should respond to :#{m}" do 
+        Client.should respond_to(m.to_sym)
+      end
+    end
+    
+  end #/ Client Model
+  
+  
+end #/ DataMapper::Actionstamps

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+
+require 'rubygems'
+require 'spec'
+require 'pathname'
+require Pathname(__FILE__).dirname.parent.expand_path + 'lib/dm-actionstamps'
+require 'dm-core'
+require 'dm-migrations'
+
+def load_driver(name, default_uri)
+  return false if ENV['ADAPTER'] != name.to_s
+  
+  lib = "dm-#{name}-adapter"
+  
+  begin
+    gem lib, '>=1.0'
+    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}"
+    false
+  end
+end
+
+ENV['ADAPTER'] ||= 'sqlite'
+
+HAS_SQLITE3  = load_driver(:sqlite,  'sqlite3::memory:')
+HAS_MYSQL    = load_driver(:mysql,    'mysql://localhost/dm_core_test')
+HAS_POSTGRES = load_driver(:postgres, 'postgres://postgres@localhost/dm_core_test')

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: dm-actionstamps-jwr
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- kematzy
+- jreed
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dm-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: A few fixes to kematzy's DataMapper plugin that works similar to the
+  dm-timestamps in that it 'automagically' adds/updates the created_?, updated_? fields
+  of your models.
+email: joelwreed@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- dm-actionstamps.gemspec
+- lib/dm-actionstamps.rb
+- lib/dm-actionstamps/actionstamps.rb
+- lib/dm-actionstamps/version.rb
+- spec/integration/actionstamps_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/joelwreed/dm-actionstamps
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A DataMapper plugin that automatically adds/updates the created_?, updated_?
+  fields of your models.
+test_files:
+- spec/integration/actionstamps_spec.rb
+- spec/spec_helper.rb