mongoid-userstamps 1.0.0

data/lib/mongoid/userstamps.rb

@@ -0,0 +1,30 @@
+# -*- encoding : utf-8 -*-
+
+require 'mongoid/userstamps/version'
+require 'mongoid/userstamps/config'
+require 'mongoid/userstamps/user'
+require 'mongoid/userstamps/model'
+require 'mongoid/userstamps/created'
+require 'mongoid/userstamps/updated'
+require 'mongoid/userstamps/deleted'
+require 'mongoid/userstamps/railtie' if defined? Rails
+
+module Mongoid
+  module Userstamps
+    extend ActiveSupport::Concern
+
+    include Created
+    include Updated
+
+    included do
+      if defined?(Mongoid::Paranoia) && self < Mongoid::Paranoia
+        include Deleted
+      end
+    end
+
+    def self.config
+      Mongoid::Userstamps::Config.module_eval(&Proc.new)
+    end
+  end
+end
+

data/lib/mongoid-userstamps.rb

@@ -0,0 +1,4 @@
+# -*- encoding : utf-8 -*-
+
+require 'mongoid/userstamps'
+

data/mongoid-userstamps.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+
+require 'mongoid/userstamps/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'mongoid-userstamps'
+  s.version     = Mongoid::Userstamps::VERSION
+  s.authors     = ['Geoffroy Planquart', 'Thomas Boerger', 'Johnny Shields', 'Bharat Gupta']
+  s.homepage    = 'https://github.com/tbpro/mongoid_userstamp'
+  s.license     = 'MIT'
+  s.summary     = 'Userstamps for Mongoid'
+  s.description = 'Userstamps for creator and updater fields using Mongoid'
+  s.email       = ['geoffroy@planquart.fr', 'tboerger@tbpro.de']
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.post_install_message = File.read('UPGRADING') if File.exists?('UPGRADING')
+
+  s.add_dependency 'mongoid', '~> 4.0'
+  s.add_dependency 'activesupport', '~> 4.0'
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# -*- encoding : utf-8 -*-
+require 'rubygems'
+require 'ostruct'
+
+$:.push File.expand_path('../../lib', __FILE__)
+
+require 'active_support/all'
+require 'mongoid'
+require 'mongoid_userstamp'
+
+%w(admin user book post).each do |file_name|
+  require "support/#{file_name}"
+end
+
+Mongoid.configure do |config|
+  config.connect_to 'mongoid_userstamp_test'
+end
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  
+  config.after :suite do
+    Mongoid.purge!
+  end
+end

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

@@ -0,0 +1,9 @@
+# -*- encoding : utf-8 -*-
+class Book
+  include Mongoid::Document
+  include Mongoid::Userstamp
+
+  mongoid_userstamp user_model: 'User'
+
+  field :name
+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/support/user.rb

@@ -0,0 +1,7 @@
+# -*- encoding : utf-8 -*-
+class User
+  include Mongoid::Document
+  include Mongoid::Userstamp::User
+
+  field :name
+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_id = admin_2._id
+        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_id = admin_2._id
+        post.save!
+      end
+
+      it { book.created_by.should eq user_1 }
+      it { book.updated_by.should eq user_2 }
+      it { post.writer.should eq admin_1 }
+      it { post.editor.should eq admin_2 }
+    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

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,121 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe Mongoid::Userstamp do
+
+  subject{ Mongoid::Userstamp }
+
+  let(:user_1){ User.create!(name: 'Edmund Wells') }
+  let(:user_2){ User.create!(name: 'Charles Dikkens') }
+  let(:admin_1){ 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(admin_1)
+    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 admin_1 }
+    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 admin_1
+      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

data/test/config_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class ConfigTest < BaseTest
+  test 'should config using block' do
+    Mongoid::Userstamps.config do |c|
+      c.created_name = :creator
+      c.updated_name = :updater
+      c.deleted_name = :deleter
+      c.user_reader = :get_user
+    end
+    assert_equal :creator, Mongoid::Userstamps::Config.created_name
+    assert_equal :updater, Mongoid::Userstamps::Config.updated_name
+    assert_equal :deleter, Mongoid::Userstamps::Config.deleted_name
+    assert_equal :get_user, Mongoid::Userstamps::Config.user_reader
+  end
+end
+

data/test/model_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+class ModelTest < BaseTest
+  test 'should set created_by and updated_by on creation' do
+    @user = User.create(name: 'John')
+    Mongoid::Userstamps::Config.set_current_user(User, @user)
+    @post = Post.create(title: 'Hello')
+    assert_equal @user, @post.created_by
+    assert_equal @user, @post.updated_by
+  end
+end
+

data/test/models/post.rb

@@ -0,0 +1,7 @@
+class Post
+  include Mongoid::Document
+  include Mongoid::Userstamps
+
+  field :title
+end
+

data/test/models/user.rb

@@ -0,0 +1,7 @@
+class User
+  include Mongoid::Document
+  include Mongoid::Userstamps::User
+
+  field :name
+end
+

data/test/mongoid.yml

@@ -0,0 +1,6 @@
+test:
+  sessions:
+    default:
+      database: mongoid_userstamps_test
+      hosts:
+        - localhost:27017

data/test/test_helper.rb

@@ -0,0 +1,25 @@
+require 'bundler/setup'
+require 'simplecov'
+SimpleCov.configure do
+  add_filter '/test/'
+end
+SimpleCov.start if ENV['COVERAGE']
+
+require 'minitest/autorun'
+require 'mongoid'
+require 'pry'
+
+require File.expand_path("../../lib/mongoid-userstamps", __FILE__)
+
+Mongoid.load!("#{File.dirname(__FILE__)}/mongoid.yml", "test")
+
+Dir["#{File.dirname(__FILE__)}/models/*.rb"].each { |f| require f }
+
+ActiveSupport::TestCase.test_order = :random
+
+class BaseTest < ActiveSupport::TestCase
+  def teardown
+    Mongoid::Sessions.default.use('mongoid_userstamps_test').drop
+  end
+end
+