userstamps 0.0.2

data/.gitignore

@@ -0,0 +1 @@
+pkg/*

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Reid MacDonald <reid@laruby.com>
+
+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,64 @@
+= UserStamps
+
+Adds a simple +belongs_to+ associations to a user model based on a magic columns
++created_by+ and +updated_by+ as it's foreign key.
+
+== Example
+
+  class User < ActiveRecord::Base
+  end
+
+  class Item < ActiveRecord::Base
+    stamped_by :user
+  end
+
+  i = Item.find(1)
+  i.created_by  #=> 3
+  i.creator     #=> #<User id:3>
+  i.updated_by  #=> 5
+  i.updator     #=> #<User id:5>
+
+== Configuration
+
+You can specify configure how your +creator+ and +updator+ can be specified but
+you have to pass options to +created_by+ and +updated_by+ separately:
+
+  class Item < ActiveRecord::Base
+    created_by :user
+    updated_by :admin
+  end
+
+  i = Item.find(1)
+  i.created_by  #=> 3
+  i.creator     #=> #<User id:3>
+  i.updated_by  #=> 1
+  i.updator     #=> #<Admin id:1>
+
+== Options
+
+By default, the creator is required, you can turn this off with a :required option:
+
+  created_by :user, :required => false
+
+By default, the updator is _not_ required because on create you will need to specify
+an updator, but you can turn this on with a :required option:
+
+  updated_by :admin, :required => true
+
+You could pass a :foriegn_key option to set a specific +created_by+ or +updated_by+
+foriegn key but you might as well just setup the association yourself at that point.
+
+== Using only Created By
+
+If you only care about creators you can just specify a +created_by+ instead of
++stamped_by+ as an option.
+
+  class Item < ActiveRecord::Base
+    created_by :user
+  end
+
+  i = Item.find(1)
+  i.created_by  #=> 3
+  i.creator     #=> #<User id:3>
+
+Copyright (c) 2010 Reid MacDonald <reid@laruby.com>, released under the MIT license

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "userstamps"
+    gem.summary = %Q{Extending ActiveRecord with stamping for created_by and updated_by fields}
+    gem.description = %Q{Gem that extends ActiveRecord with stamping for created_by and updated_by fields}
+    gem.email = "stephan.kaag@holder.nl"
+    gem.homepage = "http://github.com/stephankaag/userstamps"
+    gem.authors = ["Stephan Kaag"]
+    # 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'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run the specs'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

data/VERSION

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

data/lib/active_record/associations/user_stamps.rb

@@ -0,0 +1,50 @@
+module ActiveRecord   # :nodoc:
+  module Associations # :nodoc:
+    module UserStamps  # :nodoc:
+      ##
+      # Extends ActiveRecord::Base with ClassMethods
+      def self.included base
+        base.extend(ClassMethods)
+      end
+
+      ##
+      # Methods added to ActiveRecord::Base
+      module ClassMethods
+        ##
+        # Creates associations for +created_by+ and +updated_by+ using the respective configuration of each.
+        def stamped_by user_model
+          created_by user_model
+          updated_by user_model
+        end
+
+        ##
+        # Creates an association on the +created_by+ column to the supplied +user_model+ argument.
+        # You can override the +created_by+ column name with :foriegn_key but at that point you might
+        # as well set up the relationship yourself.
+        #
+        # Required by default.
+        def created_by user_model, options = {}
+          user_association :creator, user_model, options.reverse_merge(:foreign_key => 'created_by', :required => true)
+        end
+
+        ##
+        # Creates an association on the +updated_by+ column to the supplied +user_model+ argument.
+        # You can override the +updated_by+ column name with :foriegn_key but at that point you might
+        # as well set up the relationship yourself.
+        #
+        # Not required by default.
+        def updated_by user_model, options = {}
+          user_association :updator, user_model, options.reverse_merge(:foreign_key => 'updated_by', :required => false)
+        end
+
+        private
+          def user_association association, user_model, options
+            configuration = {:class_name => user_model.to_s.classify}.merge!(options)
+
+            belongs_to association, :foreign_key => configuration[:foreign_key], :class_name => configuration[:class_name]
+            validates_presence_of association if configuration[:required]
+          end
+      end
+    end
+  end
+end

data/lib/userstamps.rb

@@ -0,0 +1,3 @@
+require 'active_record/associations/user_stamps'
+
+ActiveRecord::Base.send :include, ActiveRecord::Associations::UserStamps

data/spec/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
+rescue LoadError => e
+  puts e
+  puts "You need to install rspec in your base app"
+  exit
+end
+
+plugin_spec_dir = File.dirname(__FILE__)
+ActiveRecord::Base.logger = Logger.new(plugin_spec_dir + "/debug.log")

data/spec/user_stamps_spec.rb

@@ -0,0 +1,101 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class MockActiveRecord < ActiveRecord::Base
+  def self.column_names
+    %w[id created_by updated_by]
+  end
+
+  def self.columns
+    column_names.map do |name|
+      ActiveRecord::ConnectionAdapters::Column.new(name.to_s, nil)
+    end
+  end
+end
+
+describe ActiveRecord::Base do
+  it "includes ActiveRecord::Assocations::UserStamps::ClassMethods" do
+    ActiveRecord::Base.methods.should be_member('stamped_by')
+    ActiveRecord::Base.methods.should be_member('created_by')
+    ActiveRecord::Base.methods.should be_member('updated_by')
+  end
+end
+
+describe :created_by do
+  describe :belongs_to do
+    it "creates the belongs_to :creator association with default options" do
+      MockActiveRecord.should_receive(:belongs_to).with(:creator, :class_name => 'MockCreator', :foreign_key => 'created_by')
+      MockActiveRecord.created_by :mock_creator
+    end
+
+    it "creates the belongs_to association with alternate foreign_key" do
+      MockActiveRecord.should_receive(:belongs_to).with(:creator, :class_name => 'MockCreator', :foreign_key => 'creator_id')
+      MockActiveRecord.created_by :mock_creator, :foreign_key => 'creator_id'
+    end
+
+    it "creates the belongs_to association with alternate class_name (but why?)" do
+      MockActiveRecord.should_receive(:belongs_to).with(:creator, :class_name => 'AnotherClassName', :foreign_key => 'created_by')
+      MockActiveRecord.created_by :mock_creator, :class_name => 'AnotherClassName'
+    end
+
+    it 'ignores all other options' do
+      MockActiveRecord.should_receive(:belongs_to).with(:creator, :class_name => 'MockCreator', :foreign_key => 'created_by')
+      MockActiveRecord.created_by :mock_creator, :foo => 'Bar'
+    end
+  end
+
+  describe :validates_presence_of do
+    it 'is added by default' do
+      MockActiveRecord.should_receive(:validates_presence_of).with(:creator)
+      MockActiveRecord.created_by :mock_creator
+    end
+
+    it 'turns off validation for creator' do
+      MockActiveRecord.should_not_receive(:validates_presence_of)
+      MockActiveRecord.created_by :mock_creator, :required => false
+    end
+  end
+end
+
+describe :updated_by do
+  describe :belongs_to do
+    it "creates the belongs_to :updator association with default options" do
+      MockActiveRecord.should_receive(:belongs_to).with(:updator, :class_name => 'MockUpdator', :foreign_key => 'updated_by')
+      MockActiveRecord.updated_by :mock_updator
+    end
+
+    it "creates the belongs_to association with alternate foreign_key" do
+      MockActiveRecord.should_receive(:belongs_to).with(:updator, :class_name => 'MockUpdator', :foreign_key => 'updator_id')
+      MockActiveRecord.updated_by :mock_updator, :foreign_key => 'updator_id'
+    end
+
+    it "creates the belongs_to association with alternate class_name (but why?)" do
+      MockActiveRecord.should_receive(:belongs_to).with(:updator, :class_name => 'AnotherClassName', :foreign_key => 'updated_by')
+      MockActiveRecord.updated_by :mock_updator, :class_name => 'AnotherClassName'
+    end
+
+    it 'ignores all other options' do
+      MockActiveRecord.should_receive(:belongs_to).with(:updator, :class_name => 'MockUpdator', :foreign_key => 'updated_by')
+      MockActiveRecord.updated_by :mock_updator, :foo => 'Bar'
+    end
+  end
+
+  describe :validates_presence_of do
+    it 'is not added by default' do
+      MockActiveRecord.should_not_receive(:validates_presence_of).with(:updator)
+      MockActiveRecord.updated_by :mock_updator
+    end
+
+    it 'turns on validation for updator' do
+      MockActiveRecord.should_receive(:validates_presence_of)
+      MockActiveRecord.updated_by :mock_updator, :required => true
+    end
+  end
+end
+
+describe :stamped_by do
+  it 'uses the same model on created_by and updated_by' do
+    MockActiveRecord.should_receive(:created_by).with(:user)
+    MockActiveRecord.should_receive(:updated_by).with(:user)
+    MockActiveRecord.stamped_by :user
+  end
+end

data/userstamps.gemspec

@@ -0,0 +1,51 @@
+# 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{userstamps}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Stephan Kaag"]
+  s.date = %q{2010-06-04}
+  s.description = %q{Gem that extends ActiveRecord with stamping for created_by and updated_by fields}
+  s.email = %q{stephan.kaag@holder.nl}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/active_record/associations/user_stamps.rb",
+     "lib/userstamps.rb",
+     "spec/.gitignore",
+     "spec/spec_helper.rb",
+     "spec/user_stamps_spec.rb",
+     "userstamps.gemspec"
+  ]
+  s.homepage = %q{http://github.com/stephankaag/userstamps}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Extending ActiveRecord with stamping for created_by and updated_by fields}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/user_stamps_spec.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
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: userstamps
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Stephan Kaag
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-04 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Gem that extends ActiveRecord with stamping for created_by and updated_by fields
+email: stephan.kaag@holder.nl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/active_record/associations/user_stamps.rb
+- lib/userstamps.rb
+- spec/.gitignore
+- spec/spec_helper.rb
+- spec/user_stamps_spec.rb
+- userstamps.gemspec
+has_rdoc: true
+homepage: http://github.com/stephankaag/userstamps
+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 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Extending ActiveRecord with stamping for created_by and updated_by fields
+test_files: 
+- spec/spec_helper.rb
+- spec/user_stamps_spec.rb