clerk 0.1.2 → 0.2.1

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode
+script: bundle exec rspec spec

data/README.md

@@ -1,11 +1,13 @@
 # Clerk
 
+[![Build Status](https://travis-ci.org/house9/clerk.png)](https://travis-ci.org/house9/clerk) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/house9/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, 
+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
 
@@ -13,8 +15,8 @@ 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
+* you have 2 columns which are foreign keys of users.id
+  * the gems uses the following as defaults `created_by_id` and `updated_by_id`
 
 ## Installation
 
@@ -29,7 +31,7 @@ And then execute:
 Or install it yourself as:
 
     $ gem install clerk
-    
+
 Then follow the directions under Setup
 
 ## Setup
@@ -39,22 +41,22 @@ Step 1: include the `sentient_user` SentientUser module on your User `/app/model
     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    
-    
+    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
@@ -62,15 +64,21 @@ We probably want our User model to `track_who_does_it` as well
       track_who_does_it
     end
 
-## Usage 
+You can optionally override the default column names `created_by_id` and `updated_by_id`
 
-Once you have finished the Setup and restarted your rails server 
+    class Post < ActiveRecord::Base
+      track_who_does_it :creator_foreign_key => "user_id", :updater_foreign_key => "updater_id"
+    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)

data/clerk.gemspec

@@ -2,12 +2,12 @@
 require File.expand_path('../lib/clerk/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  
+
   summary = %q{
-    For Rails applications - add creator and updater to your ActiveRecord models 
+    For Rails applications - add creator and updater to your ActiveRecord models
     and automatically set these from current_user
   }
-  
+
   gem.authors       = ["Jesse House"]
   gem.email         = ["jesse.house@gmail.com"]
   gem.description   = "#{summary}\nSee the README on github for more info"
@@ -20,14 +20,20 @@ Gem::Specification.new do |gem|
   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' 
+
+  if defined?(JRUBY_VERSION)
+    gem.add_development_dependency 'activerecord-jdbcsqlite3-adapter'
+    gem.add_development_dependency 'jruby-openssl'
+  else
+    gem.add_development_dependency 'sqlite3'
+  end
 end

data/lib/clerk.rb

@@ -5,11 +5,14 @@ require 'clerk/callback'
 require 'clerk/railtie'
 
 module Clerk
-  def track_who_does_it
+  def track_who_does_it(options = {})
     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"
+    creator_fk = options.fetch(:creator_foreign_key) { "created_by_id" }
+    updater_fk = options.fetch(:updater_foreign_key) { "updated_by_id" }
+
+    belongs_to :creator, :class_name => "User", :foreign_key => creator_fk
+    belongs_to :updater, :class_name => "User", :foreign_key => updater_fk
   end
 end

data/lib/clerk/version.rb

@@ -1,3 +1,3 @@
 module Clerk
-  VERSION = "0.1.2"
+  VERSION = "0.2.1"
 end

data/spec/clerk_spec.rb

@@ -9,37 +9,37 @@ describe Clerk 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
   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")
@@ -52,11 +52,28 @@ describe Clerk 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"      
+      this.updater.name.should == "updater"
     end
-  end  
+  end
+
+  describe "specified foreign_keys" do
+    Foo.extend Clerk
+
+    class FooExtended < Foo
+      track_who_does_it :creator_foreign_key => "user_id", :updater_foreign_key => "updater_id"
+    end
+
+    it "can override default foreign_keys" do
+      creator = User.create!(:name => "creator")
+      creator.make_current
+      this = FooExtended.new(:bar => "Test")
+      this.save
+      this.creator.name.should == "creator"
+      this.updater.name.should == "creator"
+    end
+  end
 end

data/spec/support/models.rb

@@ -4,4 +4,8 @@ end
 
 class User < ActiveRecord::Base
   include SentientUser
+end
+
+class Foo < ActiveRecord::Base
+
 end

data/spec/support/schema.rb

@@ -8,11 +8,18 @@ ActiveRecord::Schema.define do
     t.integer :updated_by_id
     t.timestamps
   end
-  
+
+  create_table :foos, :force => true do |t|
+    t.string :bar
+    t.integer :user_id
+    t.integer :updater_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
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clerk
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-25 00:00:00.000000000Z
+date: 2012-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70277505884660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '3'
   type: :runtime
   prerelease: false
-  version_requirements: *70277505884660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &70277505883260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: '3'
   type: :runtime
   prerelease: false
-  version_requirements: *70277505883260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: sentient_user
-  requirement: &70277505882440 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: 0.3.2
   type: :runtime
   prerelease: false
-  version_requirements: *70277505882440
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.2
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70277505881640 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: 1.1.3
   type: :development
   prerelease: false
-  version_requirements: *70277505881640
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70277505880820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +85,15 @@ dependencies:
         version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *70277505880820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70277505880280 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,9 +101,14 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70277505880280
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! "\n    For Rails applications - add creator and updater to your ActiveRecord
-  models \n    and automatically set these from current_user\n  \nSee the README on
+  models\n    and automatically set these from current_user\n  \nSee the README on
   github for more info"
 email:
 - jesse.house@gmail.com
@@ -87,7 +117,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .rvmrc
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -122,11 +154,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: For Rails applications - add creator and updater to your ActiveRecord models  and
-  automatically set these from current_user
+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