acts_as_blamable 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+Manifest

data/CHANGELOG.rdoc

@@ -0,0 +1,7 @@
+v0.0.2 (2010-04-20)
+
+* Edited documentation
+
+v0.0.1 (2010-04-20)
+
+* Initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Create
+
+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,45 @@
+== Description
+
+The <tt>acts_as_blamable</tt> plugin stores the creator and updater of an ActiveRecord model.
+
+== Installation
+
+ gem install acts_as_blamable
+
+== Usage
+
+Add a <tt>current_user</tt> class method to the User model, which returns for example the logged in user.
+
+ class User < ActiveRecord::Base
+   def self.current_user
+     ...
+   end
+ end
+	
+ class Post < ActiveRecord::Base
+  acts_as_blamable
+ end
+
+Add <tt>created_by</tt> and <tt>updated_by</tt> attributes to the <tt>posts</tt> table.
+
+ create_table :posts do |t|
+   t.integer :created_by, :updated_by
+ end
+
+== Configuration
+
+Defaults
+
+ { :current_user_method => 'current_user', :class_name => 'User', :creator_foreign_key => :created_by, :updater_foreign_key => :updated_by }
+
+Modify the defaults if necessary
+
+ class Person < ActiveRecord::Base
+   def self.current_person
+     Person.first
+   end
+ end
+ 
+ class Comment < ActiveRecord::Base
+   acts_as_blamable :class_name => 'Person', :creator_foreign_key => :creator_id, :updater_foreign_key => :updater_id, :current_user_method => 'current_person'
+ end

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'acts_as_blamable'
+    gem.summary = 'Stores the creator and updater of a database record'
+    gem.description = 'Automatically set created_by and updated_by fields'
+    gem.email = 'philipp.ullmann@create.at'
+    gem.homepage = 'http://github.com/create-philipp-ullmann/acts_as_blamable'
+    gem.authors = ['Philipp Ullmann']
+    gem.add_development_dependency 'rspec', '>= 1.3.0'
+    gem.add_development_dependency 'sqlite3-ruby', '>=1.2.5'
+    gem.add_development_dependency 'activerecord', '>= 2.3.5'
+  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_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
+
+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 = "test #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/acts_as_blamable.gemspec

@@ -0,0 +1,62 @@
+# 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{acts_as_blamable}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Philipp Ullmann"]
+  s.date = %q{2010-04-20}
+  s.description = %q{Automatically set created_by and updated_by fields}
+  s.email = %q{philipp.ullmann@create.at}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "CHANGELOG.rdoc",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "acts_as_blamable.gemspec",
+     "lib/acts_as_blamable.rb",
+     "spec/acts_as_blamable_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/create-philipp-ullmann/acts_as_blamable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Stores the creator and updater of a database record}
+  s.test_files = [
+    "spec/acts_as_blamable_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::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 1.2.5"])
+      s.add_development_dependency(%q<activerecord>, [">= 2.3.5"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 1.2.5"])
+      s.add_dependency(%q<activerecord>, [">= 2.3.5"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 1.2.5"])
+    s.add_dependency(%q<activerecord>, [">= 2.3.5"])
+  end
+end
+

data/lib/acts_as_blamable.rb

@@ -0,0 +1,46 @@
+module ActsAsBlamable
+  def self.included(base)
+    base.extend ClassMethods
+  end
+  
+  module ClassMethods
+    def acts_as_blamable(options={})
+      class_variable_set :@@bl_conf, { :current_user_method => :current_user, :class_name => 'User', :creator_foreign_key => :created_by, :updater_foreign_key => :updated_by }
+      bl_conf.update(options) if options.is_a? Hash
+      
+      class_eval do
+        include ActsAsBlamable::InstanceMethods
+        
+        with_options :class_name => bl_conf[:class_name] do |o|
+          o.belongs_to :creator, :foreign_key => bl_conf[:creator_foreign_key]
+          o.belongs_to :updater, :foreign_key => bl_conf[:updater_foreign_key]
+        end
+        
+        before_create :save_creator
+        before_update :save_updater
+      end
+    end
+    
+    def bl_conf
+      class_variable_get :@@bl_conf
+    end
+  end
+  
+  module InstanceMethods
+    private
+    
+    def save_creator
+      self.creator = current_user
+    end
+    
+    def save_updater
+      self.updater = current_user
+    end
+    
+    def current_user
+      Kernel.const_get(self.class.bl_conf[:class_name]).send("#{self.class.bl_conf[:current_user_method]}")
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval { include ActsAsBlamable }

data/spec/acts_as_blamable_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'A Post' do
+  before(:each) do
+    setup_db
+    @user = User.create!
+    @post = Post.create!
+  end
+  
+  after(:each) do
+    teardown_db
+  end
+  
+  it 'should have been created by an user' do
+    @post.creator.reload.should == @user
+    @post.updater.should be_nil
+  end
+  
+  it 'should have been updated by an user' do
+    @post.update_attributes :content => 'content'
+    @post.creator.reload.should == @user
+    @post.updater.reload.should == @user
+  end
+end
+
+describe 'A Comment' do
+  before(:each) do
+    setup_db
+    @person = Person.create!
+    @comment = Comment.create!
+  end
+  
+  after(:each) do
+    teardown_db
+  end
+  
+  it 'should have been created by a person' do
+    @comment.creator.reload.should == @person
+    @comment.updater.should be_nil
+  end
+  
+  it 'should have been updated by a person' do
+    @comment.update_attributes :content => 'content'
+    @comment.creator.reload.should == @person
+    @comment.updater.reload.should == @person
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,59 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'active_record'
+require 'acts_as_blamable'
+require 'spec'
+require 'spec/autorun'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :users do |t|
+      t.string :name
+    end
+    
+    create_table :posts do |t|
+      t.integer :created_by, :updated_by
+      t.text :content
+    end
+    
+    create_table :people do |t|
+      t.string :name
+    end
+    
+    create_table :comments do |t|
+      t.integer :creator_id, :updater_id
+      t.text :content
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table table
+  end
+end
+
+class User < ActiveRecord::Base
+  def self.current_user
+    User.first
+  end
+end
+
+class Post < ActiveRecord::Base
+  acts_as_blamable
+end
+
+class Person < ActiveRecord::Base
+  def self.current_person
+    Person.first
+  end
+end
+
+class Comment < ActiveRecord::Base
+  acts_as_blamable :class_name => 'Person', :creator_foreign_key => :creator_id, :updater_foreign_key => :updater_id, :current_user_method => 'current_person'
+end
+
+Spec::Runner.configure do |config|
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_blamable
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Philipp Ullmann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-20 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 5
+        version: 1.2.5
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :development
+  version_requirements: *id003
+description: Automatically set created_by and updated_by fields
+email: philipp.ullmann@create.at
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- CHANGELOG.rdoc
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- acts_as_blamable.gemspec
+- lib/acts_as_blamable.rb
+- spec/acts_as_blamable_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/create-philipp-ullmann/acts_as_blamable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Stores the creator and updater of a database record
+test_files: 
+- spec/acts_as_blamable_spec.rb
+- spec/spec_helper.rb