glebtv_mongoid_userstamp 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d873bed4646aeb401c5a38861a424b2006b8772
+  data.tar.gz: 79534179cd97ff59c8007a72f1fe519f6b1c2eda
+SHA512:
+  metadata.gz: 797365acd8a2be727c354256545ca8edc2b8a60f65e86fd6672fa4904a39efc2cc6beed6fcf799106cef63fb5168db708cd91237311a0a0b737e5291684b55a1
+  data.tar.gz: 8ae7c9dec30f9a1eb145989af3469adc9f51bd26bfec9be34a5e5f2ff4a4fc9d2f2617514cb73bdb5d41e5f2665cac013740af46fc6484eb5b271702f3d06cee

data/.gitignore

@@ -0,0 +1,13 @@
+.DS_Store
+
+/.idea
+/.yardoc
+/.bundle
+
+/pkg
+/doc
+
+/.ruby-version
+/.rbenv-version
+/*.gem
+/Gemfile.lock

data/.ruby-gemset

@@ -0,0 +1 @@
+mongoid_userstamp

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - ruby-head
+  - jruby
+  - jruby-19mode
+  - rbx
+  - rbx-19mode
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby
+    - rvm: jruby-19mode
+    - rvm: rbx
+    - rvm: rbx-19mode
+
+services: mongodb

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+## [0.3.2](https://github.com/tbpro/mongoid_userstamp/releases/tag/v0.3.2) - 2014-01-12
+
+* Fix bad gem release
+
+## [0.3.1](https://github.com/tbpro/mongoid_userstamp/releases/tag/v0.3.1) - 2014-01-11
+
+* Improvement
+  * Remove autoload and replace with require in gem root lib file
+  * Add log warning for `#configure` deprecation
+
+* Admin
+  * Remove Jeweler dependency, replace with gem-release gem
+  * Add Gemfile.lock to .gitignore (best practice for gems)
+  * Simplify version file
+
+## [0.3.0](https://github.com/tbpro/mongoid_userstamp/releases/tag/v0.3.0) - 2013-10-02
+
+* Improvement
+  * BREAKING: Default value for `updated_accessor` was `:updator`, is now `:updater` (@johnnyshields)
+  * DEPRECATION: `#configure` is now an alias for `#config` and is deprecated (@johnnyshields)
+  * Replace `Mongoid::Userstamp.configuration` and `Mongoid::Userstamp.configure` with `#config` (@johnnyshields)
+  * Replace usages of `id` with `_id`, since there are many gems which override the behavior of `id` (@johnnyshields)
+  * Do not overwrite creator if it has already been set manually (@johnnyshields)
+  * Define setter methods for updated_accessor/created_accessor which assign the user id. Accepts both `Mongoid::Document` and `BSON::ObjectID` types (@johnnyshields)
+  * Allow pass-in of Mongoid field options for updated_column/created_column. Useful to set field aliases, default value, etc. (@johnnyshields)
+  * Expose current_user as `Mongoid::Userstamp.current_user` (@johnnyshields)
+  * Field type is now `::Moped::BSON::ObjectID` instead of Object (@johnnyshields)
+  * Query for creator/updater user using `unscoped` (@johnnyshields)
+  * Improve code readability (@johnnyshields)
+  * Improve test coverage, including adding tests for config (@johnnyshields)
+
+* Bugfix
+  * Catch error if creator/updater has been deleted and return nil (@johnnyshields)
+
+## [0.2.1](https://github.com/tbpro/mongoid_userstamp/releases/tag/v0.2.1) - 2013-03-24
+
+* Improvement
+  * Added some specs for test coverage (@johnnyshields)
+  * Removed dependecy for `Mongoid::Timestamps` (@johnnyshields)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2012 Thomas Boerger Programmierung <http://www.tbpro.de>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# WARNING
+
+This fork is INCOMPATIBLE with upstream due to different default field names
+
+This fork uses actual mongoid belongs_to relations instead of low level work with BSON fields. Primary reason for doing
+this is to support eager loading for creator/updater modifier
+
+MongoidUserstamp adds stamp columns for created by and updated by
+information within Rails applications using Mongoid ORM.
+
+## Version Support
+
+MongoidUserstamp is tested on the following versions:
+
+* Ruby 1.9.3 and 2.0.0
+* Rails 3
+* Mongoid 3
+
+## Install
+
+```ruby
+  gem 'mongoid_userstamp'
+```
+
+## Usage
+
+```ruby
+  # Default config
+  Mongoid::Userstamp.config do |c|
+
+    # Default config values
+
+    c.user_reader = :current_user
+    c.user_model = :user
+
+    c.creator_field = :creator
+    c.updater_field = :updater
+
+  end
+
+  # Example model
+  class Person
+    include Mongoid::Document
+    include Mongoid::Userstamp
+  end
+ 
+  # Create instance
+  p = Person.create
+
+  # Updater ObjectID or nil
+  p.updater_id
+  # => BSON::ObjectId('4f7c719f476da850ba000039')
+
+  # Updater instance or nil
+  p.updater
+  # => <User _id: 4f7c719f476da850ba000039>
+
+  # Set updater manually (usually not required)
+  p.updater = my_user # can be a Mongoid::Document or a BSON::ObjectID
+  # => sets updated_by to my_user's ObjectID
+
+  # Creator ObjectID or nil
+  p.creator_id
+  # => BSON::ObjectId('4f7c719f476da850ba000039')
+
+  # Creator instance or nil
+  p.creator
+  # => <User _id: 4f7c719f476da850ba000039>
+
+  # Set creator manually (usually not required)
+  p.creator = my_user # can be a Mongoid::Document or a BSON::ObjectID
+  # => sets created_by to my_user._id
+```
+
+## Contributing
+
+Fork -> Patch -> Spec -> Push -> Pull Request
+
+Please use Ruby 1.9.3 hash syntax, as Mongoid 3 requires Ruby >= 1.9.3
+
+## Authors
+
+* [Thomas Boerger](http://www.tbpro.de)
+* [John Shields](https://github.com/johnnyshields)
+* [GlebTV](https://github.com/glebtv)
+
+## Copyright
+
+Copyright (c) 2012-2013 Thomas Boerger Programmierung <http://www.tbpro.de>
+Copyright (c) 2014 glebtv <http://rocketscience.pro>
+
+Licensed under the MIT License (MIT). Refer to LICENSE for details.

data/Rakefile

@@ -0,0 +1,13 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "./spec/**/*_spec.rb"
+end
+

data/lib/glebtv_mongoid_userstamp.rb

@@ -0,0 +1,2 @@
+require 'mongoid_userstamp'
+

data/lib/mongoid/userstamp/config.rb

@@ -0,0 +1,30 @@
+module Mongoid
+  module Userstamp
+    class Config
+      attr_writer :user_model
+      attr_accessor :user_reader
+      attr_accessor :creator_field
+      attr_accessor :updater_field
+
+      def initialize(&block)
+        reset!
+        instance_eval(&block) if block_given?
+      end
+
+      def reset!
+        @user_model = :user
+        @user_reader = :current_user
+        @creator_field = :creator
+        @updater_field = :updater
+      end
+
+      def user_model_name
+        @user_model.to_s.classify
+      end
+
+      def user_model
+        @user_model.to_s.classify.constantize
+      end
+    end
+  end
+end

data/lib/mongoid/userstamp/railtie.rb

@@ -0,0 +1,22 @@
+# -*- 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
+
+          begin
+            Mongoid::Userstamp.config.user_model.current = c.send(Mongoid::Userstamp.config.user_reader)
+          rescue
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/userstamp/user.rb

@@ -0,0 +1,37 @@
+# -*- 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/lib/mongoid/userstamp/version.rb

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

data/lib/mongoid/userstamp.rb

@@ -0,0 +1,51 @@
+module Mongoid
+  module Userstamp
+    extend ActiveSupport::Concern
+
+    included do
+      belongs_to Userstamp.config.creator_field, class_name: Userstamp.config.user_model_name
+      belongs_to Userstamp.config.updater_field, class_name: Userstamp.config.user_model_name
+
+      before_save :set_updater
+      before_create :set_creator
+
+      protected
+
+      def set_updater
+        return if !Userstamp.has_current_user?
+        self.send("#{Userstamp.config.updater_field}=", Userstamp.current_user)
+      end
+
+      def set_creator
+        return if !Userstamp.has_current_user? || self.send(Userstamp.config.creator_field)
+        self.send("#{Userstamp.config.creator_field}=", Userstamp.current_user)
+      end
+    end
+
+    class << self
+      def config(&block)
+        if block_given?
+          @@config = Userstamp::Config.new(&block)
+        else
+          @@config ||= Userstamp::Config.new
+        end
+      end
+
+      def has_current_user?
+        config.user_model.respond_to?(:current)
+      end
+
+      def current_user
+        config.user_model.try(:current)
+      end
+
+      def find_user(user_id)
+        begin
+          user_id ? Userstamp.config.user_model.unscoped.find(user_id) : nil
+        rescue Mongoid::Errors::DocumentNotFound => e
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/mongoid_userstamp.rb

@@ -0,0 +1,6 @@
+# -*- encoding : utf-8 -*-
+require 'mongoid/userstamp'
+require 'mongoid/userstamp/version'
+require 'mongoid/userstamp/config'
+require 'mongoid/userstamp/user'
+require 'mongoid/userstamp/railtie' if defined? Rails

data/mongoid_mongoid_userstamp.gemspec

@@ -0,0 +1,27 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'mongoid/userstamp/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'glebtv_mongoid_userstamp'
+  s.version     = Mongoid::Userstamp::VERSION
+  s.authors     = ['GlebTv', 'Thomas Boerger', 'Johnny Shields']
+  s.homepage    = 'https://github.com/glebtv/mongoid_userstamp'
+  s.license     = 'MIT'
+  s.summary     = 'Userstamp for Mongoid'
+  s.description = 'Userstamp for creator and updater columns using Mongoid'
+  s.email       = 'glebtv@gmail.com'
+
+  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_runtime_dependency 'mongoid', '~> 4.0.0.beta1'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'gem-release'
+end
+

data/spec/mongoid/userstamp_spec.rb

@@ -0,0 +1,158 @@
+# -*- 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 { is_expected.to respond_to :creator_id }
+  it { is_expected.to respond_to :creator }
+  it { is_expected.to respond_to :updater_id }
+  it { is_expected.to 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 { is_expected.to be_nil }
+    end
+
+    context 'when current user is set' do
+      before{ User.current = user_1 }
+      it { is_expected.to eq user_1 }
+    end
+  end
+
+  context 'when created without a user' do
+    before do
+      User.current = nil
+      subject.save!
+    end
+
+    it { expect(subject.creator_id).to be_nil }
+    it { expect(subject.creator).to be_nil }
+    it { expect(subject.updater_id).to be_nil }
+    it { expect(subject.updater).to be_nil }
+  end
+
+  context 'when creator is manually set' do
+    before{ User.current = user_1 }
+
+    context 'set by id' do
+      before do
+        subject.creator_id = user_2._id
+        subject.save!
+      end
+
+      it 'should not be overridden when saved' do
+        expect(subject.creator_id).to eq user_2.id
+        expect(subject.creator).to eq user_2
+        expect(subject.updater_id).to eq user_1.id
+        expect(subject.updater).to 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
+        expect(subject.creator_id).to eq user_2.id
+        expect(subject.creator).to eq user_2
+        expect(subject.updater_id).to eq user_1.id
+        expect(subject.updater).to eq user_1
+      end
+    end
+  end
+
+  context 'when created by a user' do
+    before do
+      User.current = user_1
+      subject.save!
+    end
+
+    it { expect(subject.creator_id).to eq(user_1.id) }
+    it { expect(subject.creator).to eq(user_1) }
+    it { expect(subject.updater_id).to eq(user_1.id) }
+    it { expect(subject.updater).to eq(user_1) }
+
+    context 'when updated by a user' do
+      before do
+        User.current = user_2
+        subject.save!
+      end
+
+      it { expect(subject.creator_id).to eq(user_1.id) }
+      it { expect(subject.creator).to eq(user_1) }
+      it { expect(subject.updater_id).to eq(user_2.id) }
+      it { expect(subject.updater).to eq(user_2) }
+    end
+
+    context 'when user has been destroyed' do
+      before do
+        User.current = user_2
+        subject.save!
+        user_1.destroy
+        user_2.destroy
+        subject.reload
+      end
+
+      it { expect(subject.creator_id).to eq(user_1.id) }
+      it { expect(subject.creator).to eq(nil) }
+      it { expect(subject.updater_id).to eq(user_2.id) }
+      it { expect(subject.updater).to eq(nil) }
+    end
+  end
+
+  describe '#config' do
+    before :all do
+      Mongoid::Userstamp.config do |c|
+        c.user_reader = :current_user
+        c.user_model  = :user
+
+        c.creator_field   = :c_by
+        c.updater_field   = :u_by
+      end
+
+      # class definition must come after config
+      class Novel
+        include Mongoid::Document
+        include Mongoid::Userstamp
+
+        field :name
+      end
+    end
+    after :all do
+      Mongoid::Userstamp.config.reset!
+    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 { expect(subject.c_by_id).to eq(user_1.id) }
+      it { expect(subject.c_by).to eq(user_1) }
+      it { expect(subject.u_by_id).to eq(user_1.id) }
+      it { expect(subject.u_by).to eq(user_1) }
+
+      context 'when updated by a user' do
+        before do
+          User.current = user_2
+          subject.save!
+        end
+
+        it { expect(subject.c_by_id).to eq(user_1.id) }
+        it { expect(subject.c_by).to eq(user_1) }
+        it { expect(subject.u_by_id).to eq(user_2.id) }
+        it { expect(subject.u_by).to eq(user_2) }
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+# -*- encoding : utf-8 -*-
+require 'rubygems'
+
+$:.push File.expand_path('../../lib', __FILE__)
+
+require 'active_support/all'
+require 'mongoid'
+require 'mongoid_userstamp'
+
+Mongoid.configure do |config|
+  config.connect_to(
+    'mongoid_userstamp_test'
+  )
+end
+
+Object.send :remove_const, :Config
+Config = RbConfig
+
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each do |f|
+  require f
+end
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  
+  config.after :suite do
+    Mongoid.purge!
+  end
+end

data/spec/support/book.rb

@@ -0,0 +1,7 @@
+# -*- encoding : utf-8 -*-
+class Book
+  include Mongoid::Document
+  include Mongoid::Userstamp
+
+  field :name
+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

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: glebtv_mongoid_userstamp
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- GlebTv
+- Thomas Boerger
+- Johnny Shields
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta1
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  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: glebtv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/glebtv_mongoid_userstamp.rb
+- lib/mongoid/userstamp.rb
+- lib/mongoid/userstamp/config.rb
+- lib/mongoid/userstamp/railtie.rb
+- lib/mongoid/userstamp/user.rb
+- lib/mongoid/userstamp/version.rb
+- lib/mongoid_userstamp.rb
+- mongoid_mongoid_userstamp.gemspec
+- spec/mongoid/userstamp_spec.rb
+- spec/spec_helper.rb
+- spec/support/book.rb
+- spec/support/user.rb
+homepage: https://github.com/glebtv/mongoid_userstamp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Userstamp for Mongoid
+test_files:
+- spec/mongoid/userstamp_spec.rb
+- spec/spec_helper.rb
+- spec/support/book.rb
+- spec/support/user.rb
+has_rdoc: