stampable 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.idea/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in stampable.gemspec
+gemspec

data/README.md

@@ -0,0 +1,60 @@
+Stampable gem
+=============
+
+Overview
+--------
+
+The Stampable gem is used to stamp ActiveRecord model with current user. This is a simple gem that stores who modified/created the record in a single field.
+
+
+Installation
+------------
+
+Installation of the plugin can be done using the built in Rails plugin script. Issue the following
+command from the root of your Rails application:
+
+    $ ./script/rails plugin install git://github.com/anandagrawal84/stampable.git
+
+or add it to your Gemfile:
+
+    gem 'stampable'
+
+and run `bundle install` to install the new dependency.
+
+Usage
+-----
+All you need to do is include Stampable module in the ActiveRecord model that you want to stamp.
+
+```ruby
+class Blog < ActiveRecord::Base
+  include Stampable
+end
+```
+
+and in case of rails set the current user in application controller
+
+```ruby
+class ApplicationController
+  before_filter :current_user
+
+  def current_user
+    Thread.current['current_user'] = <current user name or id>
+  end
+end
+```
+
+The value saved in current_user (say user name or user id) gets saved in the model that is stampable.
+
+Configuration
+-------------
+To save the stamp in `touched_by` instead of `modified_by` add following to environment.rb file
+
+```ruby
+Stampable::Base.config = {:stamp_field => 'touched_by'}
+```
+
+To specify a default user add following
+
+```ruby
+Stampable::Base.config = {:default_user => 'robot'}
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/stampable/base.rb

@@ -0,0 +1,22 @@
+module Stampable
+  module Base
+    def self.config= config
+      @config = self.config.merge(config)
+    end
+
+    def self.config
+      @config || {:stamp_field => :modified_by}
+    end
+
+    def self.included(klass)
+      klass.send :before_save, :set_modified_by
+    end
+
+    def set_modified_by
+      return unless changed?
+      user_name = Thread.current['current_user'] || Stampable::Base.config[:default_user]
+      stamp_writer = (Stampable::Base.config[:stamp_field].to_s + '=').to_sym
+      send(stamp_writer, user_name) if respond_to?(stamp_writer)
+    end
+  end
+end

data/lib/stampable/version.rb

@@ -0,0 +1,3 @@
+module Stampable
+  VERSION = "0.0.1"
+end

data/lib/stampable.rb

@@ -0,0 +1,5 @@
+require "stampable/version"
+
+module Stampable
+
+end

data/spec/stampable_spec.rb

@@ -0,0 +1,76 @@
+describe Stampable do
+  class ActiveRecordModel
+    attr_accessor :modified_by
+
+    #stub activerecord method
+    def self.before_save msg
+      @msg = msg
+    end
+
+    include Stampable::Base
+
+    def invoke_before_save
+      send :set_modified_by
+    end
+
+    #stub activerecord method
+    def changed?
+      true
+    end
+  end
+
+  before :all do
+    Stampable::Base.config = {:default_user => 'user'}
+  end
+
+  after :each do
+    Thread.current['current_user'] = nil
+  end
+
+
+  it 'should set default current user if not set in thread local' do
+    model = ActiveRecordModel.new
+    model.invoke_before_save
+    model.modified_by.should == 'user'
+  end
+
+  it 'should set user from thread local' do
+    Thread.current['current_user'] = 'user1'
+    model = ActiveRecordModel.new
+    model.invoke_before_save
+
+    model.modified_by.should == 'user1'
+  end
+
+  it 'should not set user if model is not changed' do
+    model = ActiveRecordModel.new
+    model.stub(:changed?).and_return(false)
+    model.invoke_before_save
+
+    model.modified_by.should == nil
+  end
+
+  it 'should not update user if model is not changed' do
+    model = ActiveRecordModel.new
+    model.modified_by = 'some user'
+    model.stub(:changed?).and_return(false)
+    model.invoke_before_save
+
+    model.modified_by.should == 'some user'
+  end
+
+
+  it 'should set user to the stamp_field' do
+    Stampable::Base.config = {:stamp_field => 'touched_by'}
+
+    class ActiveRecordModel
+      attr_accessor :touched_by
+    end
+
+    model = ActiveRecordModel.new
+    model.invoke_before_save
+
+    model.touched_by.should == 'user'
+    model.modified_by.should == nil
+  end
+end

data/stampable.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "stampable/version"
+require "stampable/base"
+
+Gem::Specification.new do |s|
+  s.name        = "stampable"
+  s.version     = Stampable::VERSION
+  s.authors     = ["Anand Agrawal"]
+  s.email       = ["anand.agrawal84@gmail.com", "rajashreermalvade@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Stamp any ActiveRecord model with last created/updated by}
+  s.description = %q{Stamp any ActiveRecord model with last created/updated by}
+
+  s.rubyforge_project = "stampable"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: stampable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Anand Agrawal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70246285937140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70246285937140
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70246285936660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70246285936660
+description: Stamp any ActiveRecord model with last created/updated by
+email:
+- anand.agrawal84@gmail.com
+- rajashreermalvade@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/stampable.rb
+- lib/stampable/base.rb
+- lib/stampable/version.rb
+- spec/stampable_spec.rb
+- stampable.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 172601517271973622
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 172601517271973622
+requirements: []
+rubyforge_project: stampable
+rubygems_version: 1.8.12
+signing_key: 
+specification_version: 3
+summary: Stamp any ActiveRecord model with last created/updated by
+test_files:
+- spec/stampable_spec.rb