mongoid_userstamp 0.3.2 → 0.4.0

data/spec/unit/user_spec.rb

@@ -0,0 +1,95 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe Mongoid::Userstamp::User do
+
+  subject(:book) { Book.new(name: 'Crafting Rails Applications') }
+  subject(:post) { Post.new(title: 'Understanding Rails') }
+
+  let(:user_1) { User.create!(name: 'Charles Dikkens') }
+  let(:user_2) { User.create!(name: 'Edmund Wells') }
+  let(:admin_1) { Admin.create!(name: 'JK Rowling') }
+  let(:admin_2) { Admin.create!(name: 'Stephan Norway') }
+
+  describe '::current and #current?' do
+    before { Admin.current = nil; User.current = nil }
+
+    context 'when current users are not set' do
+      it { Admin.current.should be_nil }
+      it { User.current.should be_nil }
+      it { admin_1.current?.should be_falsey }
+      it { admin_2.current?.should be_falsey }
+      it { user_1.current?.should be_falsey }
+      it { user_2.current?.should be_falsey }
+    end
+
+    context 'when current User is set' do
+      before{ User.current = user_1 }
+      it { User.current.should eq user_1 }
+      it { Admin.current.should be_nil }
+      it { admin_1.current?.should be_falsey }
+      it { admin_2.current?.should be_falsey }
+      it { user_1.current?.should be_truthy }
+      it { user_2.current?.should be_falsey }
+    end
+
+    context 'when current Admin is set' do
+      before{ Admin.current = admin_1 }
+      it { User.current.should be_nil }
+      it { Admin.current.should eq admin_1 }
+      it { admin_1.current?.should be_truthy }
+      it { admin_2.current?.should be_falsey }
+      it { user_1.current?.should be_falsey }
+      it { user_2.current?.should be_falsey }
+    end
+  end
+
+  describe '::do_as' do
+    it 'should set the current user' do
+      Admin.current = admin_1
+      Admin.do_as admin_2 do
+        Admin.current.should eq admin_2
+      end
+      Admin.current.should eq admin_1
+    end
+
+    it 'should return the value of the block' do
+      Admin.do_as admin_2 do
+        'foo'
+      end.should eq 'foo'
+    end
+
+    it 'should revert user in case of error' do
+      Admin.current = admin_1
+      begin
+        Admin.do_as admin_2 do
+          raise
+        end
+      rescue
+      end
+      Admin.current.should eq admin_1
+    end
+  end
+
+  describe '::mongoid_userstamp_user' do
+    before{ User.instance_variable_set(:'@mongoid_userstamp_user', nil) }
+
+    context 'when options are not given' do
+      subject{ User.mongoid_userstamp_user }
+      it { should be_a Mongoid::Userstamp::UserConfig }
+      it { subject.reader.should eq :current_user  }
+    end
+
+    context 'when options are given' do
+      subject{ User.mongoid_userstamp_user(reader: :foo) }
+      it { should be_a Mongoid::Userstamp::UserConfig }
+      it { subject.reader.should eq :foo  }
+    end
+
+    context 'when mongoid_userstamp_user has been set' do
+      subject{ User.mongoid_userstamp_user; User.mongoid_userstamp_user(reader: :foo) }
+      it { should be_a Mongoid::Userstamp::UserConfig }
+      it { subject.reader.should eq :current_user  }
+    end
+  end
+end

data/spec/unit/userstamp_spec.rb

@@ -0,0 +1,120 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe Mongoid::Userstamp do
+
+  subject{ Mongoid::Userstamp }
+
+  let(:user_1){ User.create!(name: 'Edmund Wells') }
+  let(:user_2){ Admin.create!(name: 'JK Rowling') }
+
+  describe '#config' do
+
+    before { Mongoid::Userstamp.instance_variable_set(:'@config', nil) }
+
+    context 'without block' do
+      subject{ Mongoid::Userstamp.config }
+      it { should be_a Mongoid::Userstamp::GemConfig }
+      it { subject.created_name.should eq :created_by }
+      it { subject.updated_name.should eq :updated_by }
+      it { subject.user_reader.should eq :current_user }
+    end
+
+    context 'with block' do
+      subject do
+        Mongoid::Userstamp.config do |u|
+          u.created_name = :c_by
+          u.updated_name = :u_by
+          u.user_reader = :foo
+        end
+      end
+      it { should be_a Mongoid::Userstamp::GemConfig }
+      it { subject.created_name.should eq :c_by }
+      it { subject.updated_name.should eq :u_by }
+      it { subject.user_reader.should eq :foo }
+    end
+
+    context 'deprecated method' do
+      subject{ Mongoid::Userstamp.configure }
+      it { should be_a Mongoid::Userstamp::GemConfig }
+    end
+  end
+
+  describe '#current_user' do
+    before do
+      Mongoid::Userstamp.set_current_user(user_1)
+      Mongoid::Userstamp.set_current_user(user_2)
+    end
+    context 'when user_class is User' do
+      subject{ Mongoid::Userstamp.current_user('User') }
+      it{ should eq user_1 }
+    end
+    context 'when user_class is Admin' do
+      subject{ Mongoid::Userstamp.current_user('Admin') }
+      it{ should eq user_2 }
+    end
+    context 'when user_class is other' do
+      subject{ Mongoid::Userstamp.current_user('foobar') }
+      it{ should be_nil }
+    end
+    context 'when user_class is not given' do
+      subject{ Mongoid::Userstamp.current_user }
+      it 'should use the default user_class' do
+        should eq user_2
+      end
+    end
+  end
+
+  describe '#model_classes' do
+    before { Mongoid::Userstamp.instance_variable_set(:'@model_classes', nil) }
+    context 'default value' do
+      it { subject.model_classes.should eq [] }
+    end
+    context 'setting values' do
+      before do
+        subject.add_model_class 'Book'
+        subject.add_model_class 'Post'
+      end
+      it { subject.model_classes.should eq [Book, Post] }
+    end
+  end
+
+  describe '#user_classes' do
+    before { Mongoid::Userstamp.instance_variable_set(:'@user_classes', nil) }
+    context 'default value' do
+      it { subject.user_classes.should eq [] }
+    end
+    context 'setting values' do
+      before do
+        subject.add_user_class 'Book'
+        subject.add_user_class 'Post'
+      end
+      it { subject.user_classes.should eq [Book, Post] }
+    end
+  end
+
+  describe '#store' do
+    context 'when RequestStore is defined' do
+      before do
+        stub_const('RequestStore', Object.new)
+        RequestStore.stub('store').and_return('foobar')
+      end
+      it { subject.store.should eq RequestStore.store }
+    end
+    context 'when RequestStore is not defined' do
+      before{ hide_const('RequestStore') }
+      it { subject.store.should eq Thread.current }
+    end
+  end
+
+  describe '#userstamp_key' do
+    context 'when model is a Class' do
+      subject{ Mongoid::Userstamp.userstamp_key(User) }
+      it{ should eq :"mongoid_userstamp/user" }
+    end
+    context 'when model is a String' do
+      subject{ Mongoid::Userstamp.userstamp_key('MyNamespace::User') }
+      it{ should eq :"mongoid_userstamp/my_namespace/user" }
+    end
+  end
+end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_userstamp
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Thomas Boerger
 - Johnny Shields
+- Bharat Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-12 00:00:00.000000000 Z
+date: 2014-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -45,14 +46,14 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +82,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Userstamp for creator and updater columns using Mongoid
 email: tboerger@tbpro.de
 executables: []
@@ -96,16 +111,26 @@ files:
 - Rakefile
 - init.rb
 - lib/mongoid/userstamp.rb
-- lib/mongoid/userstamp/config.rb
+- lib/mongoid/userstamp/config/gem_config.rb
+- lib/mongoid/userstamp/config/model_config.rb
+- lib/mongoid/userstamp/config/user_config.rb
+- lib/mongoid/userstamp/mixins/model.rb
+- lib/mongoid/userstamp/mixins/user.rb
 - lib/mongoid/userstamp/railtie.rb
-- lib/mongoid/userstamp/user.rb
 - lib/mongoid/userstamp/version.rb
 - lib/mongoid_userstamp.rb
 - mongoid_userstamp.gemspec
-- spec/mongoid/userstamp_spec.rb
 - spec/spec_helper.rb
+- spec/support/admin.rb
 - spec/support/book.rb
+- spec/support/post.rb
 - spec/support/user.rb
+- spec/unit/gem_config_spec.rb
+- spec/unit/model_config_spec.rb
+- spec/unit/model_spec.rb
+- spec/unit/user_config_spec.rb
+- spec/unit/user_spec.rb
+- spec/unit/userstamp_spec.rb
 homepage: https://github.com/tbpro/mongoid_userstamp
 licenses:
 - MIT
@@ -126,13 +151,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.8
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Userstamp for Mongoid
 test_files:
-- spec/mongoid/userstamp_spec.rb
 - spec/spec_helper.rb
+- spec/support/admin.rb
 - spec/support/book.rb
+- spec/support/post.rb
 - spec/support/user.rb
+- spec/unit/gem_config_spec.rb
+- spec/unit/model_config_spec.rb
+- spec/unit/model_spec.rb
+- spec/unit/user_config_spec.rb
+- spec/unit/user_spec.rb
+- spec/unit/userstamp_spec.rb
 has_rdoc: 

data/lib/mongoid/userstamp/config.rb

@@ -1,30 +0,0 @@
-# -*- encoding : utf-8 -*-
-module Mongoid
-  module Userstamp
-    class Config
-      attr_writer :user_model
-      attr_accessor :user_reader
-      attr_accessor :created_column
-      attr_accessor :created_column_opts
-      attr_accessor :created_accessor
-      attr_accessor :updated_column
-      attr_accessor :updated_column_opts
-      attr_accessor :updated_accessor
-
-      def initialize(&block)
-        @user_model = :user
-        @user_reader = :current_user
-        @created_column = :created_by
-        @created_accessor = :creator
-        @updated_column = :updated_by
-        @updated_accessor = :updater
-
-        instance_eval(&block) if block_given?
-      end
-
-      def user_model
-        @user_model.to_s.classify.constantize
-      end
-    end
-  end
-end

data/lib/mongoid/userstamp/user.rb

@@ -1,37 +0,0 @@
-# -*- encoding : utf-8 -*-
-module Mongoid
-  module Userstamp
-    module User
-      extend ActiveSupport::Concern
-
-      included do
-        def current?
-          !Thread.current[:user].nil? && self._id == Thread.current[:user]._id
-        end
-      end
-
-      module ClassMethods
-        def current
-          Thread.current[:user]
-        end
-
-        def current=(value)
-          Thread.current[:user] = value
-        end
-
-        def do_as(user, &block)
-          old = self.current
-
-          begin
-            self.current = user
-            response = block.call unless block.nil?
-          ensure
-            self.current = old
-          end
-
-          response
-        end
-      end
-    end
-  end
-end

data/spec/mongoid/userstamp_spec.rb

@@ -1,163 +0,0 @@
-# -*- encoding : utf-8 -*-
-require 'spec_helper'
-
-describe Mongoid::Userstamp do
-  subject { Book.new(name: 'Crafting Rails Applications') }
-  let(:user_1) { User.create!(name: 'Charles Dikkens') }
-  let(:user_2) { User.create!(name: 'Edmund Wells') }
-
-  it { should respond_to :created_by }
-  it { should respond_to :creator }
-  it { should respond_to :updated_by }
-  it { should respond_to :updater }
-
-  describe '#current_user' do
-    subject{ Mongoid::Userstamp.current_user }
-
-    context 'when current user is not set' do
-      before { User.current = nil }
-      it { should be_nil }
-    end
-
-    context 'when current user is set' do
-      before{ User.current = user_1 }
-      it { should eq user_1 }
-    end
-  end
-
-  context 'when created without a user' do
-    before do
-      User.current = nil
-      subject.save!
-    end
-
-    it { subject.created_by.should be_nil }
-    it { subject.creator.should be_nil }
-    it { subject.updated_by.should be_nil }
-    it { subject.updater.should be_nil }
-  end
-
-  context 'when creator is manually set' do
-    before{ User.current = user_1 }
-
-    context 'set by id' do
-      before do
-        subject.created_by = user_2._id
-        subject.save!
-      end
-
-      it 'should not be overridden when saved' do
-        subject.created_by.should eq user_2.id
-        subject.creator.should eq user_2
-        subject.updated_by.should eq user_1.id
-        subject.updater.should eq user_1
-      end
-    end
-    context 'set by model' do
-      before do
-        subject.creator = user_2
-        subject.save!
-      end
-      
-      it 'should not be overridden when saved' do
-        subject.created_by.should eq user_2.id
-        subject.creator.should eq user_2
-        subject.updated_by.should eq user_1.id
-        subject.updater.should eq user_1
-      end
-    end
-  end
-
-  context 'when created by a user' do
-    before do
-      User.current = user_1
-      subject.save!
-    end
-
-    it { subject.created_by.should == user_1.id }
-    it { subject.creator.should == user_1 }
-    it { subject.updated_by.should == user_1.id }
-    it { subject.updater.should == user_1 }
-
-    context 'when updated by a user' do
-      before do
-        User.current = user_2
-        subject.save!
-      end
-
-      it { subject.created_by.should == user_1.id }
-      it { subject.creator.should == user_1 }
-      it { subject.updated_by.should == user_2.id }
-      it { subject.updater.should == user_2 }
-    end
-
-    context 'when user has been destroyed' do
-      before do
-        User.current = user_2
-        subject.save!
-        user_1.destroy
-        user_2.destroy
-      end
-
-      it { subject.created_by.should == user_1.id }
-      it { subject.creator.should == nil }
-      it { subject.updated_by.should == user_2.id }
-      it { subject.updater.should == nil }
-    end
-  end
-
-  describe '#config' do
-    before do
-      Mongoid::Userstamp.config do |c|
-        c.user_reader = :current_user
-        c.user_model  = :user
-
-        c.created_column   = :c_by
-        c.created_column_opts = {as: :created_by_id}
-        c.created_accessor = :created_by
-
-        c.updated_column   = :u_by
-        c.updated_column_opts = {as: :updated_by_id}
-        c.updated_accessor = :updated_by
-      end
-
-      # class definition must come after config
-      class Novel
-        include Mongoid::Document
-        include Mongoid::Userstamp
-
-        field :name
-      end
-    end
-    subject { Novel.new(name: 'Ethyl the Aardvark goes Quantity Surveying') }
-
-    context 'when created by a user' do
-      before do
-        User.current = user_1
-        subject.save!
-      end
-
-      it { subject.c_by.should == user_1.id }
-      it { subject.created_by_id.should == user_1.id }
-      it { subject.created_by.should == user_1 }
-      it { subject.u_by.should == user_1.id }
-      it { subject.updated_by_id.should == user_1.id }
-      it { subject.updated_by.should == user_1 }
-
-      context 'when updated by a user' do
-        before do
-          User.current = user_2
-          subject.save!
-        end
-
-        it { subject.c_by.should == user_1.id }
-        it { subject.created_by_id.should == user_1.id }
-        it { subject.created_by.should == user_1 }
-        it { subject.u_by.should == user_2.id }
-        it { subject.updated_by_id.should == user_2.id }
-        it { subject.updated_by.should == user_2 }
-      end
-    end
-  end
-
-end