mongoid_userstamp 0.3.2 → 0.4.0

data/lib/mongoid/userstamp/mixins/user.rb

@@ -0,0 +1,46 @@
+# -*- encoding : utf-8 -*-
+
+module Mongoid
+module Userstamp
+
+  module User
+
+    extend ActiveSupport::Concern
+
+    included do
+
+      Mongoid::Userstamp.add_user_class(self)
+
+      def current?
+        self._id == Mongoid::Userstamp.current_user(self.class).try(:_id)
+      end
+    end
+
+    module ClassMethods
+
+      def current
+        Mongoid::Userstamp.current_user(self)
+      end
+
+      def current=(value)
+        Mongoid::Userstamp.set_current_user(value, self)
+      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
+
+      def mongoid_userstamp_user(opts = {})
+        @mongoid_userstamp_user ||= Mongoid::Userstamp::UserConfig.new(opts)
+      end
+    end
+  end
+end
+end

data/lib/mongoid/userstamp/railtie.rb

@@ -1,18 +1,35 @@
 # -*- encoding : utf-8 -*-
+
 module Mongoid
-  module Userstamp
-    class Railtie < Rails::Railtie
-      ActiveSupport.on_load :action_controller do
-        before_filter do |c|
-          unless Mongoid::Userstamp.config.user_model.respond_to? :current
-            Mongoid::Userstamp.config.user_model.send(
-              :include,
-              Mongoid::Userstamp::User
-            )
-          end
+module Userstamp
+
+  class Railtie < Rails::Railtie
+
+    # Include Mongoid::Userstamp::User into User class, if not already done
+    config.to_prepare do
+      Mongoid::Userstamp.user_classes.each do |user_class|
+        unless user_class.included_modules.include?(Mongoid::Userstamp::User)
+          user_class.send(:include, Mongoid::Userstamp::User)
+        end
+      end
+    end
+
+    # Add userstamp to models where Mongoid::Userstamp was included, but
+    # mongoid_userstamp was not explicitly called
+    config.to_prepare do
+      Mongoid::Userstamp.model_classes.each do |model_class|
+        unless model_class.included_modules.include?(Mongoid::Userstamp::Model)
+          model_class.send(:include, Mongoid::Userstamp::Model)
+        end
+      end
+    end
 
+    # Set current_user from controller reader method
+    ActiveSupport.on_load :action_controller do
+      before_filter do |c|
+        Mongoid::Userstamp.user_classes.each do |user_class|
           begin
-            Mongoid::Userstamp.config.user_model.current = c.send(Mongoid::Userstamp.config.user_reader)
+            user_class.current = c.send(user_class.mongoid_userstamp_user.reader)
           rescue
           end
         end
@@ -20,3 +37,4 @@ module Mongoid
     end
   end
 end
+end

data/lib/mongoid/userstamp/version.rb

@@ -1,6 +1,7 @@
 # -*- encoding : utf-8 -*-
+
 module Mongoid
   module Userstamp
-    VERSION = '0.3.2'
+    VERSION = '0.4.0'
   end
 end

data/lib/mongoid_userstamp.rb

@@ -1,6 +1,10 @@
 # -*- encoding : utf-8 -*-
+
 require 'mongoid/userstamp'
 require 'mongoid/userstamp/version'
-require 'mongoid/userstamp/config'
-require 'mongoid/userstamp/user'
+require 'mongoid/userstamp/config/gem_config'
+require 'mongoid/userstamp/config/model_config'
+require 'mongoid/userstamp/config/user_config'
+require 'mongoid/userstamp/mixins/user'
+require 'mongoid/userstamp/mixins/model'
 require 'mongoid/userstamp/railtie' if defined? Rails

data/mongoid_userstamp.gemspec

@@ -4,7 +4,7 @@ require 'mongoid/userstamp/version'
 Gem::Specification.new do |s|
   s.name        = 'mongoid_userstamp'
   s.version     = Mongoid::Userstamp::VERSION
-  s.authors     = ['Thomas Boerger', 'Johnny Shields']
+  s.authors     = ['Thomas Boerger', 'Johnny Shields', 'Bharat Gupta']
   s.homepage    = 'https://github.com/tbpro/mongoid_userstamp'
   s.license     = 'MIT'
   s.summary     = 'Userstamp for Mongoid'
@@ -20,7 +20,8 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'mongoid', '>= 3.0.4'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec', '>= 2.13.0'
+  s.add_development_dependency 'rspec', '>= 3.0.0'
   s.add_development_dependency 'yard'
   s.add_development_dependency 'gem-release'
+  s.add_development_dependency 'request_store'
 end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 # -*- encoding : utf-8 -*-
 require 'rubygems'
+require 'ostruct'
 
 $:.push File.expand_path('../../lib', __FILE__)
 
@@ -7,14 +8,12 @@ require 'active_support/all'
 require 'mongoid'
 require 'mongoid_userstamp'
 
-Mongoid.configure do |config|
-  config.connect_to(
-    'mongoid_userstamp_test'
-  )
+%w(admin user book post).each do |file_name|
+  require "support/#{file_name}"
 end
 
-Dir[File.expand_path('../support/**/*.rb', __FILE__)].each do |f|
-  require f
+Mongoid.configure do |config|
+  config.connect_to 'mongoid_userstamp_test'
 end
 
 RSpec.configure do |config|

data/spec/support/admin.rb

@@ -0,0 +1,7 @@
+# -*- encoding : utf-8 -*-
+class Admin
+  include Mongoid::Document
+  include Mongoid::Userstamp::User
+
+  field :name
+end

data/spec/support/book.rb

@@ -3,5 +3,7 @@ class Book
   include Mongoid::Document
   include Mongoid::Userstamp
 
+  mongoid_userstamp user_model: 'User'
+
   field :name
-end
+end

data/spec/support/post.rb

@@ -0,0 +1,11 @@
+# -*- encoding : utf-8 -*-
+class Post
+  include Mongoid::Document
+  include Mongoid::Userstamp
+
+  mongoid_userstamp user_model: 'Admin',
+                    created_name: :writer,
+                    updated_name: :editor
+
+  field :title
+end

data/spec/unit/gem_config_spec.rb

@@ -0,0 +1,46 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe Mongoid::Userstamp::GemConfig do
+
+  subject { Mongoid::Userstamp::GemConfig.new }
+
+  describe '#initialize' do
+
+    context 'without block' do
+      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::GemConfig.new 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
+  end
+
+  describe 'deprecated methods' do
+    subject do
+      Mongoid::Userstamp::GemConfig.new do |u|
+        u.user_model = :bar
+        u.created_column = :bing
+        u.updated_column = :baz
+      end
+    end
+    it { ->{ subject }.should_not raise_error }
+    it { should be_a Mongoid::Userstamp::GemConfig }
+    it { subject.created_name.should eq :bing }
+    it { subject.updated_name.should eq :baz }
+  end
+end

data/spec/unit/model_config_spec.rb

@@ -0,0 +1,31 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe Mongoid::Userstamp::ModelConfig do
+
+  subject { Mongoid::Userstamp::ModelConfig.new }
+  before  { Mongoid::Userstamp.stub('config').and_return(OpenStruct.new(created_name: :created_by,
+                                                                        updated_name: :updated_by)) }
+  before  { Mongoid::Userstamp.stub('user_classes').and_return(['User']) }
+
+  describe '#initialize' do
+
+    context 'with opts hash' do
+      subject { Mongoid::Userstamp::ModelConfig.new(user_model: :bar,
+                                                    created_name: :c_by,
+                                                    updated_name: :u_by) }
+
+      it { should be_a Mongoid::Userstamp::ModelConfig }
+      it { subject.user_model.should eq :bar }
+      it { subject.created_name.should eq :c_by }
+      it { subject.updated_name.should eq :u_by }
+    end
+
+    context 'without opts hash' do
+      it { should be_a Mongoid::Userstamp::ModelConfig }
+      it { subject.user_model.should eq 'User' }
+      it { subject.created_name.should eq :created_by }
+      it { subject.updated_name.should eq :updated_by }
+    end
+  end
+end

data/spec/unit/model_spec.rb

@@ -0,0 +1,157 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe Mongoid::Userstamp::Model 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 '::mongoid_userstamp_config' do
+    before do
+      @config = Book.instance_variable_get(:'@mongoid_userstamp_config')
+      Book.instance_variable_set(:'@mongoid_userstamp_config', nil)
+    end
+
+    after do
+      Book.instance_variable_set(:'@mongoid_userstamp_config', @config)
+    end
+
+    context 'when options are not given' do
+      subject{ Book.mongoid_userstamp_config }
+      it { should be_a Mongoid::Userstamp::ModelConfig }
+      it { subject.user_model.should eq Admin }
+      it { subject.created_name.should eq :created_by }
+      it { subject.updated_name.should eq :updated_by }
+    end
+
+    context 'when options are given' do
+      subject{ Book.mongoid_userstamp_config(user_model: 'User', created_name: :foo, updated_name: :bar) }
+      it { should be_a Mongoid::Userstamp::ModelConfig }
+      it { subject.user_model.should eq 'User' }
+      it { subject.created_name.should eq :foo }
+      it { subject.updated_name.should eq :bar }
+    end
+
+    context 'when mongoid_userstamp_user has been set' do
+      subject{ Book.mongoid_userstamp_config; Book.mongoid_userstamp_config(user_model: 'User', created_name: :foo, updated_name: :bar) }
+      it { should be_a Mongoid::Userstamp::ModelConfig }
+      it { subject.user_model.should eq Admin }
+      it { subject.created_name.should eq :created_by }
+      it { subject.updated_name.should eq :updated_by }
+    end
+
+    context 'when set via mongoid_userstamp method' do
+      subject{ Book.mongoid_userstamp(user_model: 'User', created_name: :foo, updated_name: :bar); Book.mongoid_userstamp_config }
+      it { should be_a Mongoid::Userstamp::ModelConfig }
+      it { subject.user_model.should eq 'User' }
+      it { subject.created_name.should eq :foo }
+      it { subject.updated_name.should eq :bar }
+    end
+  end
+
+  describe '::current_user' do
+
+    before { Admin.current = nil; User.current = nil }
+
+    context 'when current book user is not set' do
+      it { Book.current_user.should be_nil }
+      it { Post.current_user.should be_nil }
+    end
+
+    context 'when current book user is set' do
+      before{ User.current = user_1 }
+      it { Book.current_user.should eq user_1 }
+      it { Post.current_user.should be_nil }
+    end
+
+    context 'when current post user is set' do
+      before{ Admin.current = admin_1 }
+      it { Book.current_user.should be_nil }
+      it { Post.current_user.should eq admin_1 }
+    end
+  end
+
+  describe 'relations and callbacks' do
+
+    context 'when created without a user' do
+      before do
+        User.current = nil
+        Admin.current = nil
+        book.save!
+        post.save!
+      end
+
+      it { book.created_by.should be_nil }
+      it { book.updated_by.should be_nil }
+      it { post.writer.should be_nil }
+      it { post.editor.should be_nil }
+    end
+
+    context 'when created with a user' do
+      before do
+        User.current = user_1
+        Admin.current = admin_1
+        book.save!
+        post.save!
+      end
+
+      it { book.created_by.should eq user_1 }
+      it { book.updated_by.should eq user_1 }
+      it { post.writer.should eq admin_1 }
+      it { post.editor.should eq admin_1 }
+    end
+
+    context 'when creator is manually set' do
+      before do
+        User.current = user_1
+        Admin.current = admin_1
+        book.created_by = user_2
+        book.save!
+        post.writer = admin_2
+        post.save!
+      end
+
+      it { book.created_by.should eq user_2 }
+      it { book.updated_by.should eq user_1 }
+      it { post.writer.should eq admin_2 }
+      it { post.editor.should eq admin_1 }
+    end
+
+    context 'when updater is manually set' do
+      before do
+        User.current = user_1
+        Admin.current = admin_1
+        book.updated_by = user_2
+        book.save!
+        post.editor = admin_2
+        post.save!
+      end
+
+      it { book.created_by.should eq user_1 }
+      it { book.updated_by.should eq user_1 }
+      it { post.writer.should eq admin_1 }
+      it { post.editor.should eq admin_1 }
+    end
+
+    context 'when user has been destroyed' do
+      before do
+        User.current = user_1
+        Admin.current = admin_1
+        book.save!
+        post.save!
+        user_1.destroy
+        admin_1.destroy
+      end
+
+      it { Book.first.created_by.should be_nil }
+      it { Book.first.updated_by.should be_nil }
+      it { Post.first.writer.should be_nil }
+      it { Post.first.editor.should be_nil }
+    end
+  end
+end

data/spec/unit/user_config_spec.rb

@@ -0,0 +1,23 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe Mongoid::Userstamp::UserConfig do
+
+  subject { Mongoid::Userstamp::UserConfig.new }
+  before  { Mongoid::Userstamp.stub('config').and_return(OpenStruct.new(user_reader: :foo)) }
+
+  describe '#initialize' do
+
+    context 'with opts hash' do
+      subject { Mongoid::Userstamp::UserConfig.new({reader: :bar}) }
+
+      it { should be_a Mongoid::Userstamp::UserConfig }
+      it { subject.reader.should eq :bar }
+    end
+
+    context 'without opts hash' do
+      it { should be_a Mongoid::Userstamp::UserConfig }
+      it { subject.reader.should eq :foo }
+    end
+  end
+end