magic_userstamp 0.1.0

data/spec/compatibility_stamping_spec.rb

@@ -0,0 +1,76 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Userstamp do
+
+  Userstamp.compatibility_mode = true
+  
+  class CompatiblePerson < ActiveRecord::Base
+    set_table_name('people')
+    model_stamper
+  end  
+  
+  class CompatibleComment < ActiveRecord::Base
+    set_table_name('comments')
+    stampable   :stamper_class_name => :compatible_person
+    belongs_to  :post
+   end
+
+  Userstamp.compatibility_mode = false
+  
+  fixtures :people, :comments 
+
+  before(:each) do
+    @delynn = CompatiblePerson.find(people(:delynn).id)
+    @nicole = CompatiblePerson.find(people(:nicole).id)
+    @first_comment = CompatibleComment.find(comments(:first_comment).id)
+    @second_comment = CompatibleComment.find(comments(:second_comment).id)
+    CompatiblePerson.stamper = @delynn
+  end
+
+  it "comment_creation_with_stamped_object" do
+    CompatiblePerson.stamper.should == @delynn.id
+
+    comment = CompatibleComment.create(:comment => "Test Comment")
+    comment.created_by.should == @delynn.id
+    comment.updated_by.should == @delynn.id
+    comment.creator.should ==    @delynn
+    comment.updater.should ==    @delynn
+  end
+
+  it "comment_creation_with_stamped_integer" do
+    CompatiblePerson.stamper = 2
+    CompatiblePerson.stamper.should == 2
+
+    comment = CompatibleComment.create(:comment => "Test Comment - 2")
+    comment.created_by.should == @nicole.id
+    comment.updated_by.should == @nicole.id
+    comment.creator.should ==    @nicole
+    comment.updater.should ==    @nicole
+  end
+  
+  it "comment_updating_with_stamped_object" do
+    CompatiblePerson.stamper = @nicole
+    assert_equal @nicole.id, CompatiblePerson.stamper
+
+    @first_comment.comment << " - Updated"
+    @first_comment.save
+    @first_comment.reload
+    @first_comment.created_by.should == @delynn.id
+    @first_comment.updated_by.should == @nicole.id
+    @first_comment.creator.should ==    @delynn   
+    @first_comment.updater.should ==    @nicole   
+  end
+
+  it "comment_updating_with_stamped_integer" do
+    CompatiblePerson.stamper = 2
+    CompatiblePerson.stamper.should == 2
+
+    @first_comment.comment << " - Updated"
+    @first_comment.save
+    @first_comment.reload
+    @first_comment.created_by.should == @delynn.id
+    @first_comment.updated_by.should == @nicole.id
+    @first_comment.creator.should ==    @delynn
+    @first_comment.updater.should ==    @nicole
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,155 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Userstamp::Config do
+
+  class Foo
+  end
+
+  class Bar
+  end
+
+  class Baz
+  end
+
+
+  before(:each) do
+    @config = Userstamp::Config.new
+  end
+
+  describe "on" do
+    it "option's default value" do
+      pattern = @config.on(:create, :creator_id)
+      pattern.event_name.should == :create
+      pattern.column_name.should == :creator_id
+      pattern.stampable_class_names.should == nil # means all classes
+      pattern.stamper_class_name.should == 'User'
+      pattern.stamper_attr_name.should == nil # means PK attr name
+      [Foo, Bar, Baz].each do |klass|
+        pattern.stampable?(klass, 'creator_id').should == true
+        pattern.stampable?(klass, 'updater_id').should == false
+        pattern.stampable?(klass, 'deleter_id').should == false
+        pattern.stampable?(klass, :creator_id).should == true
+        pattern.stampable?(klass, :updater_id).should == false
+        pattern.stampable?(klass, :deleter_id).should == false
+
+        @config.pattern_for(klass, 'creator_id').should == pattern
+        @config.pattern_for(klass, 'updater_id').should == nil
+        @config.pattern_for(klass, 'deleter_id').should == nil
+      end
+    end
+    
+    it "full options" do
+      pattern = @config.on(:create, :creator_no, 
+        :stampable_class_names => %w(Bar Baz),
+        :stamper_class_name => 'Admin',
+        :stamper_attr_name => 'admin_no'
+        )
+      pattern.event_name.should == :create
+      pattern.column_name.should == :creator_no
+      pattern.stampable_class_names.should == ['Bar', 'Baz'] # means all classes
+      pattern.stamper_class_name.should == 'Admin'
+      pattern.stamper_attr_name.should == 'admin_no' # means PK attr name
+      [Bar, Baz].each do |klass|
+        pattern.stampable?(klass, 'creator_no').should == true
+        pattern.stampable?(klass, 'creator_id').should == false
+        pattern.stampable?(klass, 'updater_id').should == false
+        pattern.stampable?(klass, 'deleter_id').should == false
+
+        @config.pattern_for(klass, 'creator_no').should == pattern
+        @config.pattern_for(klass, 'creator_id').should == nil
+        @config.pattern_for(klass, 'updater_id').should == nil
+        @config.pattern_for(klass, 'deleter_id').should == nil
+      end
+    end
+  end
+
+  describe "defaults" do
+    it "should define about creator_id, updater_id" do
+      @config.defaults
+      @config.patterns.length.should == 2
+      [Foo, Bar, Baz].each do |klass|
+        @config.pattern_for(klass, 'creator_id').should_not be_nil
+        @config.pattern_for(klass, 'updater_id').should_not be_nil
+        @config.pattern_for(klass, 'deleter_id').should     be_nil
+        @config.pattern_for(klass, 'creator_by').should     be_nil
+        @config.pattern_for(klass, 'updater_by').should     be_nil
+        @config.pattern_for(klass, 'deleter_by').should     be_nil
+      end
+    end
+
+    it "should define about creator_id, updater_id, deleter_id with_destroy" do
+      @config.with_destroy = true
+      @config.defaults
+      @config.patterns.length.should == 3
+      [Foo, Bar, Baz].each do |klass|
+        @config.pattern_for(klass, 'creator_id').should_not be_nil
+        @config.pattern_for(klass, 'updater_id').should_not be_nil
+        @config.pattern_for(klass, 'deleter_id').should_not be_nil
+        @config.pattern_for(klass, 'creator_by').should be_nil
+        @config.pattern_for(klass, 'updater_by').should be_nil
+        @config.pattern_for(klass, 'deleter_by').should be_nil
+      end
+    end
+  end
+
+
+  describe "compatibles" do
+    it "should define about creator_by, updater_by" do
+      @config.compatibles
+      @config.patterns.length.should == 2
+      [Foo, Bar, Baz].each do |klass|
+        @config.pattern_for(klass, 'creator_id').should be_nil
+        @config.pattern_for(klass, 'updater_id').should be_nil
+        @config.pattern_for(klass, 'deleter_id').should be_nil
+        @config.pattern_for(klass, 'created_by').should_not be_nil
+        @config.pattern_for(klass, 'updated_by').should_not be_nil
+        @config.pattern_for(klass, 'deleted_by').should be_nil
+      end
+    end
+
+    it "should define about creator_by, updater_by, deleter_by with_destroy" do
+      @config.with_destroy = true
+      @config.compatibles
+      @config.patterns.length.should == 3
+      [Foo, Bar, Baz].each do |klass|
+        @config.pattern_for(klass, 'creator_id').should be_nil
+        @config.pattern_for(klass, 'updater_id').should be_nil
+        @config.pattern_for(klass, 'deleter_id').should be_nil
+        @config.pattern_for(klass, 'created_by').should_not be_nil
+        @config.pattern_for(klass, 'updated_by').should_not be_nil
+        @config.pattern_for(klass, 'deleted_by').should_not be_nil
+      end
+    end
+  end
+
+  describe Userstamp::Config::Pattern do
+    describe "args_for_stampable_on" do
+      
+      it "should return args to call Userstamp::Stampable.stampable_on" do
+        @config.defaults
+        p1 = @config.pattern_for(Foo, "creator_id")
+        p1.args_for_stampable_on.should == [:create, {
+            :attribute => :creator_id, 
+            :stamper_class_name=>"User", 
+            :stamper_attr_name=>nil}]
+      end
+      
+      it "should return args to call Userstamp::Stampable.stampable_on with options" do
+        @config.on(:update, :updater_id, :actual_hook => :before_update, 
+          :stamper_name => 'foo_updater', :stamper_class_name => 'Foo',
+          :stamper_attr_name => 'cd')
+        p1 = @config.pattern_for(Foo, "updater_id")
+        p1.args_for_stampable_on.should == [:update, {
+            :attribute => :updater_id,
+            :actual_hook => :before_update, 
+            :stamper_name => 'foo_updater', :stamper_class_name => 'Foo',
+            :stamper_attr_name => 'cd'}]
+      end
+      
+    end
+    
+  end
+
+
+
+end

data/spec/database.yml

@@ -0,0 +1,4 @@
+sqlite3:
+  adapter: sqlite3
+  database: userstamp_plugin_test.sqlite3
+  timeout: 5000

data/spec/fixtures/comments.yml

@@ -0,0 +1,16 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+first_comment:
+  id: 1
+  post_id: 1
+  comment: First Comment
+  created_by: 1
+second_comment:
+  id: 2
+  post_id: 1
+  comment: Second Comment
+  created_by: 2
+third_comment:
+  id: 3
+  post_id: 2
+  comment: Third Comment
+  created_by: 1

data/spec/fixtures/people.yml

@@ -0,0 +1,11 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+delynn:
+  id: 1
+  name: DeLynn
+  creator_id: 1
+  updater_id: 1
+nicole:
+  id: 2
+  name: Nicole
+  creator_id: 2
+  updater_id: 2

data/spec/fixtures/posts.yml

@@ -0,0 +1,9 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+first_post:
+  id: 1
+  title: First Post
+  creator_id: 1
+second_post:
+  id: 2
+  title: Second Post
+  creator_id: 1

data/spec/fixtures/users.yml

@@ -0,0 +1,7 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+zeus:
+  id: 1
+  name: Zeus
+hera:
+  id: 2
+  name: Hera

data/spec/magic_column_spec.rb

@@ -0,0 +1,171 @@
+# -*- coding: utf-8 -*-
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Userstamp do
+  
+  Userstamp::Config.setup do |config|
+    # config.verbose = true
+
+    config.defaults(:stamper_class_name => 'MagicPerson', :stampable_class_names => %w(MagicPost))
+    config.compatibles(:stamper_class_name => 'MagicPerson', :stampable_class_names => %w(MagicComment))
+
+    config.with_options(:stamper_class_name => 'MagicPerson', :stamper_attr_name => :name, :stampable_class_names => %w(MagicPing)) do |c|
+      c.on(:create , :creator_name)
+      c.on(:update , :updater_name)
+      # c.on(:destroy, :deleter_name)
+    end
+
+    config.defaults(:stamper_class_name => 'MagicUser')
+  end
+
+  class MagicUser < ActiveRecord::Base
+    set_table_name 'users'
+    # model_stamper
+  end
+
+  class MagicPerson < ActiveRecord::Base
+    set_table_name 'people'
+    # model_stamper
+  end
+
+  class MagicPost < ActiveRecord::Base
+    set_table_name 'posts'
+    # stampable :stamper_class_name => :person
+  end
+
+  class MagicComment < ActiveRecord::Base
+    set_table_name 'comments'
+    # stampable :stamper_class_name => :person
+  end
+
+  class MagicPing < ActiveRecord::Base
+    set_table_name 'pings'
+    # stampable :stamper_class_name => :person
+  end
+
+  after(:all) do
+    Userstamp::Config.clear
+  end
+  
+  fixtures :users, :people, :posts
+  
+  before(:each) do
+    @zeus = MagicUser.find(users(:zeus).id)
+    @hera = MagicUser.find(users(:hera).id)
+    @delynn = MagicPerson.find(people(:delynn).id)
+    @nicole = MagicPerson.find(people(:nicole).id)
+    @first_post = MagicPost.find(posts(:first_post).id)
+    @second_post = MagicPost.find(posts(:second_post).id)
+    MagicUser.model_stamper # 通常なら必要ないばすだけど、ここでは必要
+    MagicUser.stamper = @zeus
+    MagicPerson.model_stamper # 通常なら必要ないばすだけど、ここでは必要
+    MagicPerson.stamper = @delynn
+  end
+
+  it "Userstamp.config.pattern_for" do
+    Userstamp.config.patterns.length.should == 8
+    p1 = Userstamp.config.pattern_for(MagicUser, "creator_id")
+    p1.should_not be_nil
+    p2 = Userstamp.config.pattern_for(MagicPerson, "creator_id")
+    p2.should_not be_nil
+    p1 = Userstamp.config.pattern_for(MagicPost, "creator_id")
+    p1.should_not be_nil
+  end
+  
+
+  it "person_creation_with_stamped_object" do
+    MagicUser.stamper.should == @zeus.id
+    
+    person = MagicPerson.create(:name => "David")
+    person.creator_id.should == @zeus.id
+    person.updater_id.should == @zeus.id
+    person.creator.should == @zeus
+    person.updater.should == @zeus
+  end
+
+  it "person_creation_with_stamped_integer" do
+    MagicUser.stamper = 2
+    MagicUser.stamper.should == 2
+
+    person = MagicPerson.create(:name => "Daniel")
+    person.creator_id.should ==  @hera.id 
+    person.updater_id.should ==  @hera.id 
+    person.creator.should ==     @hera 
+    person.updater.should ==     @hera 
+  end
+
+  it "post_creation_with_stamped_object" do
+    MagicPerson.stamper.should == @delynn.id
+
+    post = MagicPost.create(:title => "Test Post - 1")
+    post.creator_id.should == @delynn.id
+    post.updater_id.should ==  @delynn.id
+    post.creator.should ==     @delynn
+    post.updater.should ==     @delynn
+  end
+
+  it "post_creation_with_stamped_integer" do
+    MagicPerson.stamper = 2
+    MagicPerson.stamper.should == 2
+
+    post = MagicPost.create(:title => "Test Post - 2")
+    post.creator_id.should == @nicole.id
+    post.updater_id.should == @nicole.id
+    post.creator.should ==    @nicole
+    post.updater.should ==    @nicole
+  end
+
+  it "person_updating_with_stamped_object" do
+    MagicUser.stamper = @hera
+    MagicUser.stamper.should == @hera.id
+
+    @delynn.name << " Berry"
+    @delynn.save
+    @delynn.reload
+    @delynn.creator.should ==    @zeus
+    @delynn.updater.should ==    @hera
+    @delynn.creator_id.should == @zeus.id
+    @delynn.updater_id.should == @hera.id
+  end
+
+  it "person_updating_with_stamped_integer" do
+    MagicUser.stamper = 2
+    MagicUser.stamper.should == 2
+
+    @delynn.name << " Berry"
+    @delynn.save
+    @delynn.reload
+    @delynn.creator_id.should == @zeus.id
+    @delynn.updater_id.should == @hera.id
+    @delynn.creator.should ==    @zeus
+    @delynn.updater.should ==    @hera
+  end
+
+  it "post_updating_with_stamped_object" do
+    MagicPerson.stamper = @nicole
+    MagicPerson.stamper.should == @nicole.id
+
+    @first_post.title << " - Updated"
+    @first_post.save
+    @first_post.reload
+    @first_post.creator_id.should == @delynn.id
+    @first_post.updater_id.should == @nicole.id
+    @first_post.creator.should ==    @delynn
+    @first_post.updater.should ==    @nicole
+  end
+
+  it "post_updating_with_stamped_integer" do
+    MagicPerson.stamper = 2
+    MagicPerson.stamper.should == 2
+
+    @first_post.title << " - Updated"
+    @first_post.save
+    @first_post.reload
+    @first_post.creator_id.should == @delynn.id
+    @first_post.updater_id.should == @nicole.id
+    @first_post.creator.should ==    @delynn
+    @first_post.updater.should ==    @nicole
+  end
+
+end
+

data/spec/posts_controller_spec.rb

@@ -0,0 +1,41 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe PostsController, :type => :controller do
+  fixtures :people, :posts
+  
+  before(:each) do
+    @delynn = people(:delynn)
+    @nicole = people(:nicole)
+    @first_post = posts(:first_post)
+    @second_post = posts(:second_post)
+  end
+
+  describe "update" do
+    it "single request" do
+      request.session[:person_id]  = 1
+      post :update, :id => 1, :post => {:title => 'Different'}
+      response.should be_success
+      assigns["post"].title.should == 'Different'
+      assigns["post"].updater.should == @delynn
+    end
+
+    it "multiple request" do
+      request.session[:person_id]  = 1
+      get :edit, :id => 2
+      response.should be_success
+      
+      request.session[:person_id]  = 2
+      post :update, :id => 1, :post => {:title => 'Different Second'}
+      response.should be_success
+      assigns["post"].title.should == 'Different Second'
+      assigns["post"].updater.should == @nicole
+
+      request.session[:person_id]  = 1
+      post :update, :id => 2, :post => {:title => 'Different'}
+      assert_response :success
+      assert_equal    'Different', assigns["post"].title
+      assert_equal    @delynn, assigns["post"].updater
+    end
+  end
+  
+end

data/spec/resources/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/resources/controllers/posts_controller.rb

@@ -0,0 +1,26 @@
+class PostsController < UserstampController
+  def edit
+    @post = Post.find(params[:id])
+    render(:inline  => "<%= @post.title %>")
+  end
+  
+  def update
+    @post = Post.find(params[:id])
+    @post.update_attributes(params[:post])
+    render(:inline => "<%= @post.title %>")
+  end
+
+  protected
+    def current_user
+      Person.find(session[:person_id])
+    end
+    
+    def set_stamper
+      Person.stamper = self.current_user
+    end
+
+    def reset_stamper
+      Person.reset_stamper
+    end    
+  #end
+end

data/spec/resources/controllers/users_controller.rb

@@ -0,0 +1,12 @@
+class UsersController < UserstampController
+  def edit
+    @user = User.find(params[:id])
+    render(:inline  => "<%= @user.name %>")
+  end
+
+  def update
+    @user = User.find(params[:id])
+    @user.update_attributes(params[:user])
+    render(:inline => "<%= @user.name %>")
+  end
+end

data/spec/resources/controllers/userstamp_controller.rb

@@ -0,0 +1,9 @@
+class UserstampController < ApplicationController
+  include Userstamp::Controller
+
+  protected
+    def current_user
+      User.find(session[:user_id])
+    end
+  #end
+end

data/spec/resources/models/comment.rb

@@ -0,0 +1,4 @@
+class Comment < ActiveRecord::Base
+  stampable   :stamper_class_name => :person
+  belongs_to  :post
+end

data/spec/resources/models/person.rb

@@ -0,0 +1,4 @@
+class Person < ActiveRecord::Base
+  model_stamper
+  stampable
+end

data/spec/resources/models/ping.rb

@@ -0,0 +1,7 @@
+class Ping < ActiveRecord::Base
+  stampable :stamper_class_name => :person,
+            :creator_attribute  => :creator_name,
+            :updater_attribute  => :updater_name,
+            :deleter_attribute  => :deleter_name
+  belongs_to :post
+end

data/spec/resources/models/post.rb

@@ -0,0 +1,4 @@
+class Post < ActiveRecord::Base
+  stampable :stamper_class_name => :person
+  has_many :comments
+end

data/spec/resources/models/user.rb

@@ -0,0 +1,4 @@
+class User < ActiveRecord::Base
+  model_stamper
+  stampable
+end

data/spec/schema.rb

@@ -0,0 +1,56 @@
+ActiveRecord::Schema.define(:version => 0) do
+  # Users are created and updated by other Users
+  create_table :users, :force => true do |t|
+    t.column :name,           :string
+    t.column :creator_id,     :integer
+    t.column :created_on,     :datetime
+    t.column :updater_id,     :integer
+    t.column :updated_at,     :datetime
+  end
+
+  # People are created and updated by Users
+  create_table :people, :force => true do |t|
+    t.column :name,           :string
+    t.column :creator_id,     :integer
+    t.column :created_on,     :datetime
+    t.column :updater_id,     :integer
+    t.column :updated_at,     :datetime
+  end
+
+  # Posts are created and updated by People
+  create_table :posts, :force => true do |t|
+    t.column :title,          :string
+    t.column :creator_id,     :integer
+    t.column :created_on,     :datetime
+    t.column :updater_id,     :integer
+    t.column :updated_at,     :datetime
+    t.column :deleter_id,     :integer
+    t.column :deleted_at,     :datetime
+  end
+
+  # Comments are created and updated by People
+  # and also use non-standard foreign keys.
+  create_table :comments, :force => true do |t|
+    t.column :post_id,        :integer
+    t.column :comment,        :string
+    t.column :created_by,     :integer
+    t.column :created_at,     :datetime
+    t.column :updated_by,     :integer
+    t.column :updated_at,     :datetime
+    t.column :deleted_by,     :integer
+    t.column :deleted_at,     :datetime
+  end
+
+  # Pings are created and updated by People,
+  # but they store their foreign keys as strings.
+  create_table :pings, :force => true do |t|
+    t.column :post_id,        :integer
+    t.column :ping,           :string
+    t.column :creator_name,   :string
+    t.column :created_at,     :datetime
+    t.column :updater_name,   :string
+    t.column :updated_at,     :datetime
+    t.column :deleter_name,   :string
+    t.column :deleted_at,     :datetime
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse