dm-userstamp 0.0.1

data/History.txt

@@ -0,0 +1,2 @@
+0.0.1 (26-08-2008)
+  * Initial Release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Richard Livsey (richard@livsey.org)
+ 
+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/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+LICENSE
+Manifest.txt
+README.txt
+Rakefile
+TODO
+lib/dm-userstamps.rb
+lib/dm-userstamps/version.rb
+spec/integration/userstamps_spec.rb
+spec/spec.opts
+spec/spec_helper.rb

data/README.txt

@@ -0,0 +1,33 @@
+= dm-userstamp
+
+DataMapper plugin which adds "magic" to created_by_id, updated_by_id fields
+
+Assumes a model called User and a class attribute of current_user
+Just need to add created_by_id and/or updated_by_id Integer fields to the model
+
+Eg:
+
+class User
+  include DataMapper::Resource
+  
+  cattr_accessor :current_user
+  ...
+end
+
+class Monkey
+  include DataMapper::Resource
+  
+  property :created_by_id, Integer
+  property :updated_by_id, Integer      
+  ...
+end
+
+== Install
+
+sudo gem install dm-userstamp
+
+== Thanks
+
+Code based on:
+ * AR userstamp plugin - http://github.com/ctran/userstamp/tree/master
+ * DM timestamps plugin - http://github.com/sam/dm-more/tree/master/dm-timestamps

data/Rakefile

@@ -0,0 +1,18 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/dm-userstamps.rb'
+require './lib/dm-userstamps/version.rb'
+
+Hoe.new('dm-userstamp', DataMapper::Userstamps::VERSION) do |p|
+  p.name            = 'dm-userstamp'
+  p.remote_rdoc_dir = '' # Release to root
+  p.rubyforge_name  = 'dm-userstamp'
+  p.author          = "Richard Livsey"
+  p.description     = "DataMapper plugin to add automatic updating of created_by_id and updated_by_id attributes"
+  p.summary         = "DataMapper plugin to add automatic updating of created_by_id and updated_by_id attributes"
+  p.email           = 'richard@livsey.org' 
+end
+
+# vim: syntax=Ruby

data/TODO

@@ -0,0 +1 @@
+* make more flexible so User model and field names aren't hardcoded

data/lib/dm-userstamps/version.rb

@@ -0,0 +1,5 @@
+module DataMapper
+  module Userstamps
+    VERSION = "0.0.1"
+  end
+end

data/lib/dm-userstamps.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+
+gem 'dm-core', '=0.9.4'
+require 'dm-core'
+
+module DataMapper
+  module Userstamp
+    USERSTAMP_PROPERTIES = {
+      :created_by_id => lambda { |r| r.created_by_id = User.current_user.id if User.current_user && r.new_record? && r.created_by_id.nil? },
+      :updated_by_id => lambda { |r| r.updated_by_id = User.current_user.id if User.current_user}
+    }
+
+    def self.included(model)
+      model.before :save, :set_userstamp_properties
+    end
+
+    private
+
+    def set_userstamp_properties
+      self.class.properties.slice(*USERSTAMP_PROPERTIES.keys).compact.each do |property|
+        USERSTAMP_PROPERTIES[property.name][self]
+      end
+    end
+  end
+  
+  Resource::append_inclusions Userstamp
+end

data/spec/integration/userstamps_spec.rb

@@ -0,0 +1,112 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+require 'pp'
+
+return unless HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
+
+describe 'DataMapper::Userstamp' do
+  before :all do
+    class User
+      include DataMapper::Resource
+
+      cattr_accessor :current_user
+
+      property :id, Integer, :serial => true
+      property :name, String
+
+      auto_migrate!(:default)
+    end
+    
+    class Monkey
+      include DataMapper::Resource
+
+      property :id, Integer, :serial => true
+      property :name, String
+      property :created_by_id, Integer
+      property :updated_by_id, Integer      
+
+      auto_migrate!(:default)
+    end
+  
+  end
+  
+  before :each do
+    @user = User.create(:name => 'Bob')
+    User.current_user = @user
+  end
+  
+  after do
+   repository(:default).adapter.execute('DELETE from users');
+   repository(:default).adapter.execute('DELETE from monkeys');   
+  end  
+  
+  it "should not set created_by_id if there is no current user" do
+    repository(:default) do
+      User.current_user = nil
+      monkey = Monkey.new(:name => 'Eric')
+      monkey.save
+      monkey.created_by_id.should be_nil
+    end
+  end
+  
+  it "should not set updated_by_id if there is no current user" do
+    repository(:default) do
+      User.current_user = nil
+      monkey = Monkey.new(:name => 'Eric')
+      monkey.save
+      monkey.updated_by_id.should be_nil
+    end
+  end
+  
+  it "should not set created_by_id if already set" do
+    repository(:default) do
+      monkey = Monkey.new(:name => 'Eric')
+      monkey.created_by_id = 5
+      monkey.save
+      monkey.created_by_id.should == 5
+      monkey.created_by_id.should be_a_kind_of(Integer)
+    end
+  end
+  
+  it "should set created_by_id on creation" do
+    repository(:default) do
+      monkey = Monkey.new(:name => 'Clyde')
+      monkey.created_by_id.should be_nil
+      monkey.save
+      monkey.created_by_id.should be_a_kind_of(Integer)
+      monkey.created_by_id.should == User.current_user.id
+    end
+  end
+  
+  it "should not alter created_by_id on model updates" do
+    repository(:default) do
+      monkey = Monkey.new(:name => 'Chump')
+      monkey.created_by_id.should be_nil
+      monkey.save
+      original_created_by_id = monkey.created_by_id
+      monkey.name = 'Wilma'
+      monkey.save
+      monkey.created_by_id.should eql(original_created_by_id)
+    end
+  end
+  
+  it "should set updated_by_id on creation and on update" do
+    repository(:default) do
+      monkey = Monkey.new(:name => 'Johnny')
+      monkey.updated_by_id.should be_nil
+      monkey.save
+      
+      monkey.updated_by_id.should be_a_kind_of(Integer)
+      monkey.updated_by_id.should == User.current_user.id
+      
+      original_updated_by_id = monkey.updated_by_id
+
+      User.current_user = @user2 = User.create(:name => 'Fred')  
+
+      monkey.name = 'Roger'
+      monkey.save
+      monkey.updated_by_id.should == @user2.id
+    end
+  end
+  
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+gem 'rspec', '>=1.1.3'
+require 'spec'
+require 'pathname'
+require Pathname(__FILE__).dirname.parent.expand_path + 'lib/dm-userstamp'
+require 'dm-core'
+
+def load_driver(name, default_uri)
+  return false if ENV['ADAPTER'] != name.to_s
+
+  lib = "do_#{name}"
+
+  begin
+    gem lib, '=0.9.4'
+    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'] ||= 'sqlite3'
+
+HAS_SQLITE3  = load_driver(:sqlite3,  '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,75 @@
+--- !ruby/object:Gem::Specification 
+name: dm-userstamp
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Richard Livsey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-28 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+description: DataMapper plugin to add automatic updating of created_by_id and updated_by_id attributes
+email: richard@livsey.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- LICENSE
+- Manifest.txt
+- README.txt
+- Rakefile
+- TODO
+- lib/dm-userstamps.rb
+- lib/dm-userstamps/version.rb
+- spec/integration/userstamps_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: DataMapper plugin which adds "magic" to created_by_id, updated_by_id fields
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: dm-userstamp
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: DataMapper plugin to add automatic updating of created_by_id and updated_by_id attributes
+test_files: []
+