clerk 0.1.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.sqlite3

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2@clerk --create

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jesse House
+
+MIT License
+
+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.md

@@ -0,0 +1,88 @@
+# Clerk
+
+Clerk adds the following attributes to your ActiveRecord objects
+
+* creator
+* updater
+
+Used in conjunction with the [`sentient_user`](https://github.com/bokmann/sentient_user) gem, 
+Clerk will automatically update these attributes using `before_create` and `before_update`
+ActiveRecord callback methods
+
+The gem assumes the following:
+
+* you have a User model
+* you have a `current_user` method on your ApplicationController
+* you are using columns named `created_by_id` and `updated_by_id` on your database tables
+* these columns are foreign keys to users.id
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'clerk'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clerk
+    
+Then follow the directions under Setup
+
+## Setup
+
+Step 1: include the `sentient_user` SentientUser module on your User `/app/models/user.rb`
+
+    class User < ActiveRecord::Base
+      include SentientUser
+    endis
+    
+Step 2: include the `sentient_user` SentientController module on your ApplicationController `/app/controllers/application_controller.rb`
+    
+    class ApplicationController < ActionController::Base
+      protect_from_forgery
+      include SentientController
+      
+      # ...
+    end    
+    
+Step 3: Add the `track_who_does_it` macro to any ActiveRecord models that have `created_by_id` and `updated_by_id` database columns
+    
+    class Post < ActiveRecord::Base
+      track_who_does_it
+    end
+    
+We probably want our User model to `track_who_does_it` as well
+
+    class User < ActiveRecord::Base
+      include SentientUser
+      track_who_does_it
+    end
+
+## Usage 
+
+Once you have finished the Setup and restarted your rails server 
+your models should automatically update the creator and the updater attributes after being saved.
+
+Since your models have the creator and updater attributes you can display these in any views
+
+    Updated by <%= @post.updater.full_name %> at <%= l(@post.updated_at, :format => :long) %>
+    
+Since we are using `sentient_user` you can also set the updater or creator in tests or rake tasks
+
+    user = User.find(5150)
+    user.make_current # now all models marked as track_who_does_it will save with this user tracked
+    Post.create!(:title => "New Post")
+    Post.last.creator == user # => true
+
+## Resources used in the development of this gem
+
+* [http://ryanbigg.com/2011/01/extending-active-record/](http://ryanbigg.com/2011/01/extending-active-record/)
+* [http://charlotteruby.org/gem_workshop_tutorial/](http://charlotteruby.org/gem_workshop_tutorial/)
+* [http://yehudakatz.com/2009/11/12/better-ruby-idioms/](http://yehudakatz.com/2009/11/12/better-ruby-idioms/)
+* [http://www.cowboycoded.com/2011/01/31/developing-is_able-or-acts_as-plugins-for-rails/](http://www.cowboycoded.com/2011/01/31/developing-is_able-or-acts_as-plugins-for-rails/)
+* [http://api.rubyonrails.org/classes/ActiveRecord/Callbacks.html](http://api.rubyonrails.org/classes/ActiveRecord/Callbacks.html)
+* [https://github.com/bokmann/sentient_user](https://github.com/bokmann/sentient_user)

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/clerk.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/clerk/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jesse House"]
+  gem.email         = ["jesse.house@gmail.com"]
+  gem.description   = File.open('README.md') { |f| f.read }
+  gem.summary       = %q{
+    For Rails applications - add creator and updater to your ActiveRecord models 
+    and automatically set these from current_user
+  }
+  gem.homepage      = "https://github.com/house9/clerk"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "clerk"
+  gem.require_paths = ["lib"]
+  gem.version       = Clerk::VERSION
+  
+  # gem.add_dependency 'rails', '~> 3'
+  gem.add_dependency 'activerecord', '~> 3'
+  gem.add_dependency 'railties', '~> 3'
+  gem.add_dependency 'sentient_user', '~> 0.3.2'
+
+  
+  gem.add_development_dependency 'bundler', '>= 1.1.3'
+  gem.add_development_dependency 'rspec', '~> 2.9.0'
+  gem.add_development_dependency 'sqlite3' 
+end

data/lib/clerk.rb

@@ -0,0 +1,15 @@
+require 'active_record'
+require 'sentient_user'
+require 'clerk/version'
+require 'clerk/callback'
+require 'clerk/railtie'
+
+module Clerk
+  def track_who_does_it
+    before_create Clerk::Callback.new
+    before_update Clerk::Callback.new
+
+    belongs_to :creator, :class_name => "User", :foreign_key => "created_by_id"
+    belongs_to :updater, :class_name => "User", :foreign_key => "updated_by_id"
+  end
+end

data/lib/clerk/callback.rb

@@ -0,0 +1,24 @@
+module Clerk
+  class Callback
+    def before_create(record)
+      record.creator = current_user if record.respond_to?(:creator) && current_user
+      record.updater = current_user if record.respond_to?(:updater) && current_user
+    end
+  
+    def before_update(record)
+      record.updater = current_user if record.respond_to?(:updater) && current_user
+    end
+    
+    # relies on `include SentientUser` on User
+    def current_user
+      logger.warn "WARNING: User#current is not defined, are you including SentientUser on your User model?" unless User.respond_to?(:current)
+      logger.warn "WARNING: User#current is nil, are you including SentientController on your ApplicationController?" unless User.current
+
+      User.current
+    end  
+    
+    def logger
+      Rails.logger
+    end
+  end
+end

data/lib/clerk/railtie.rb

@@ -0,0 +1,10 @@
+require 'clerk'
+require 'rails/railtie'
+
+module Clerk
+  class Railtie < Rails::Railtie
+    initializer 'clerk.ar_extensions' do |app|
+      ActiveRecord::Base.extend Clerk
+    end
+  end
+end

data/lib/clerk/version.rb

@@ -0,0 +1,3 @@
+module Clerk
+  VERSION = "0.1.1"
+end

data/spec/clerk_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Clerk do
+  it "should have a version" do
+    Clerk::VERSION.length.should > 0
+  end
+
+  it "should expose track_who_does_it" do
+    Post.extend Clerk
+    Post.should respond_to :track_who_does_it
+  end
+  
+  describe "extended objects" do
+    Post.extend Clerk
+    
+    class PostExtended < Post
+      track_who_does_it
+    end
+        
+    it "should respond to creator" do
+      post = PostExtended.new
+      post.should respond_to :creator
+    end
+    
+    it "should respond to updater" do
+      post = PostExtended.new
+      post.should respond_to :updater
+    end    
+  end
+  
+  describe "clerical objects can be tracked automatically" do
+    Post.extend Clerk
+    
+    class PostExtended < Post
+      track_who_does_it
+    end
+    
+    before(:each) do
+      @creator = User.create!(:name => "creator")
+      @updater = User.create!(:name => "updater")
+    end
+    
+    it "by creator" do
+      @creator.make_current
+      this = PostExtended.new(:title => "Test")
+      this.save
+      this.creator.name.should == "creator"
+      this.updater.name.should == "creator"
+    end
+
+    it "by updater" do
+      @creator.make_current
+      this = PostExtended.new(:title => "Test2")
+      this.save
+      
+      @updater.make_current
+      this.update_attribute(:title, "Updated")
+      this.creator.name.should == "creator"
+      this.updater.name.should == "updater"      
+    end
+  end  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'clerk'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => File.dirname(__FILE__) + "/clerk_test_db.sqlite3")
+load File.dirname(__FILE__) + '/support/schema.rb'
+load File.dirname(__FILE__) + '/support/models.rb'
+load File.dirname(__FILE__) + '/support/data.rb'

data/spec/support/data.rb

@@ -0,0 +1 @@
+Post.create!(:title => "TEST POST")

data/spec/support/models.rb

@@ -0,0 +1,7 @@
+class Post < ActiveRecord::Base
+
+end
+
+class User < ActiveRecord::Base
+  include SentientUser
+end

data/spec/support/schema.rb

@@ -0,0 +1,18 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :posts, :force => true do |t|
+    t.string :title
+    t.string :body
+    t.integer :created_by_id
+    t.integer :updated_by_id
+    t.timestamps
+  end
+  
+  create_table :users, :force => true do |t|
+    t.string :name
+    t.integer :created_by_id
+    t.integer :updated_by_id
+    t.timestamps
+  end  
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: clerk
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Jesse House
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-25 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70208941589700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70208941589700
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: &70208941588800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70208941588800
+- !ruby/object:Gem::Dependency
+  name: sentient_user
+  requirement: &70208941587760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70208941587760
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70208941586920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :development
+  prerelease: false
+  version_requirements: *70208941586920
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70208941586240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: *70208941586240
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70208941585700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70208941585700
+description: ! "# Clerk\n\nClerk adds the following attributes to your ActiveRecord
+  objects\n\n* creator\n* updater\n\nUsed in conjunction with the [`sentient_user`](https://github.com/bokmann/sentient_user)
+  gem, \nClerk will automatically update these attributes using `before_create` and
+  `before_update`\nActiveRecord callback methods\n\nThe gem assumes the following:\n\n*
+  you have a User model\n* you have a `current_user` method on your ApplicationController\n*
+  you are using columns named `created_by_id` and `updated_by_id` on your database
+  tables\n* these columns are foreign keys to users.id\n\n## Installation\n\nAdd this
+  line to your application's Gemfile:\n\n    gem 'clerk'\n\nAnd then execute:\n\n
+  \   $ bundle\n\nOr install it yourself as:\n\n    $ gem install clerk\n    \nThen
+  follow the directions under Setup\n\n## Setup\n\nStep 1: include the `sentient_user`
+  SentientUser module on your User `/app/models/user.rb`\n\n    class User < ActiveRecord::Base\n
+  \     include SentientUser\n    endis\n    \nStep 2: include the `sentient_user`
+  SentientController module on your ApplicationController `/app/controllers/application_controller.rb`\n
+  \   \n    class ApplicationController < ActionController::Base\n      protect_from_forgery\n
+  \     include SentientController\n      \n      # ...\n    end    \n    \nStep 3:
+  Add the `track_who_does_it` macro to any ActiveRecord models that have `created_by_id`
+  and `updated_by_id` database columns\n    \n    class Post < ActiveRecord::Base\n
+  \     track_who_does_it\n    end\n    \nWe probably want our User model to `track_who_does_it`
+  as well\n\n    class User < ActiveRecord::Base\n      include SentientUser\n      track_who_does_it\n
+  \   end\n\n## Usage \n\nOnce you have finished the Setup and restarted your rails
+  server \nyour models should automatically update the creator and the updater attributes
+  after being saved.\n\nSince your models have the creator and updater attributes
+  you can display these in any views\n\n    Updated by <%= @post.updater.full_name
+  %> at <%= l(@post.updated_at, :format => :long) %>\n    \nSince we are using `sentient_user`
+  you can also set the updater or creator in tests or rake tasks\n\n    user = User.find(5150)\n
+  \   user.make_current # now all models marked as track_who_does_it will save with
+  this user tracked\n    Post.create!(:title => \"New Post\")\n    Post.last.creator
+  == user # => true\n\n## Resources used in the development of this gem\n\n* [http://ryanbigg.com/2011/01/extending-active-record/](http://ryanbigg.com/2011/01/extending-active-record/)\n*
+  [http://charlotteruby.org/gem_workshop_tutorial/](http://charlotteruby.org/gem_workshop_tutorial/)\n*
+  [http://yehudakatz.com/2009/11/12/better-ruby-idioms/](http://yehudakatz.com/2009/11/12/better-ruby-idioms/)\n*
+  [http://www.cowboycoded.com/2011/01/31/developing-is_able-or-acts_as-plugins-for-rails/](http://www.cowboycoded.com/2011/01/31/developing-is_able-or-acts_as-plugins-for-rails/)\n*
+  [http://api.rubyonrails.org/classes/ActiveRecord/Callbacks.html](http://api.rubyonrails.org/classes/ActiveRecord/Callbacks.html)\n*
+  [https://github.com/bokmann/sentient_user](https://github.com/bokmann/sentient_user)\n"
+email:
+- jesse.house@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- clerk.gemspec
+- lib/clerk.rb
+- lib/clerk/callback.rb
+- lib/clerk/railtie.rb
+- lib/clerk/version.rb
+- spec/clerk_spec.rb
+- spec/spec_helper.rb
+- spec/support/data.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+homepage: https://github.com/house9/clerk
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: For Rails applications - add creator and updater to your ActiveRecord models  and
+  automatically set these from current_user
+test_files:
+- spec/clerk_spec.rb
+- spec/spec_helper.rb
+- spec/support/data.rb
+- spec/support/models.rb
+- spec/support/schema.rb