mongoid-userstamps 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f50851182f67227d7ce48d89b444cc6d0404cef2
+  data.tar.gz: 951bff1d14fce51b98ff36e2203d0e7cc42f23ed
+SHA512:
+  metadata.gz: 623715ef2edd2124ebb2b2886c7c8e82256a211157c851dec91b11ad6054faaadc069e33f47c4a12156d206bad213a7b470c0f7b191fcb88e7a87ff1a98f168e
+  data.tar.gz: 5c3ed62b39cd302a306956971407a8948883825fae1d963741083f75c6b16a4cfa40c88fbde5f196ba5f78c9387837611af537712762858747820b861c96f85b

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,66 @@
+# Changelog
+
+## [0.4.1](https://github.com/tbpro/mongoid_userstamp/releases/tag/v0.4.1) - 2014-08-21
+
+* Improvement
+  * Do not overwrite the `updater` if has been manually set (i.e. is in a dirty state.)
+  * Add specs for Rails 4/Mongoid 4
+
+* Documentation
+  * Document `User.do_as` feature.
+
+
+## [0.4.0](https://github.com/tbpro/mongoid_userstamp/releases/tag/v0.4.0) - 2014-02-24
+
+* Improvement
+  * BREAKING: Change userstamp keys to use Mongoid relations. This will change the underlying database field names, and as such will require a migration.
+  * BREAKING: Do not include Mongoid::Userstamp in "User" class by default.
+  * Mongoid::Userstamp config initializer is now optional.
+  * Add support for multiple user classes.
+  * Add class-level config override capability for both users and userstamped model classes.
+  * Add automatic support for `RequestStore` gem as drop-in replacement for `Thread.current`
+* Refactor
+  * DEPRECATION: `created_column` config is now `created_name`
+  * DEPRECATION: `created_updated` config is now `created_updated`
+  * DEPRECATION: `user_model` config is no longer used. Instead, include Mongoid::Userstamp::User in your user model.
+  * Substantial refactoring of all classes and test cases. Among other changes, all access to `Thread.current` variables is now done in the Mongoid::Userstamp module singleton.
+
+## [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,9 @@
+source 'http://rubygems.org'
+
+gemspec
+
+gem 'request_store', require: false
+
+gem 'simplecov', :require => false
+gem 'pry-nav', '~> 0.2.4'
+

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,185 @@
+# Mongoid::Userstamps
+
+Mongoid::Userstamps adds stamp fields for created by, updated by and optionally deleted by
+information within a ruby application using Mongoid ORM.
+
+This is a fork from [mongoid_userstamp](https://github.com/tbpro/mongoid_userstamp) but it
+has been completely rewritten to provide with some new feature and improvements.
+
+## Install
+
+```ruby
+  gem 'mongoid-userstamps'
+```
+
+## Usage
+
+Mongoid::Userstamps does the following:
+* Defines Mongoid `belongs_to` relations to the user class for `created_by` and `updated_by` on each class where `Mongoid::Userstamps` is included
+* Adds the possibility to define only `created_by` or `updated_by` by including `Mongoid::Userstamps::Created` or `Mongoid::Userstamps::Updated` respectively
+* Automatically tracks the current user via a `before_filter` (see Rails Integration below)
+* Sets the `created_by` and `updated_by` values in `before_create` and `before_save` callbacks respectively on the target models.
+* Adds methods to the user class to check for the current user.
+* Defines `belongs_to` relation to the user class for `deleted_by` when the class includes `Mongoid::Paranoia` or when `Mongoid::Userstamps::Deleted` is specifically included
+
+```ruby
+  # Default config (optional unless you want to customize the values)
+  Mongoid::Userstamps.config do |c|
+    c.user_reader = :current_user
+    c.created_name = :created_by
+    c.updated_name = :updated_by
+    c.deleted_name = :deleted_by
+  end
+
+  # Example model class
+  class Product
+    include Mongoid::Document
+    include Mongoid::Userstamps
+
+    # optional class-level config override
+    # mongoid_userstamp user_model: 'MyUser',
+    #                   created_name: :creator,
+    #                   updated_name: :updater,
+  end
+ 
+  # Example user class
+  class MyUser
+    include Mongoid::Document
+    include Mongoid::Userstamps::User
+
+    # optional class-level config override
+    # mongoid_userstamp_user reader: :current_my_user
+  end
+
+  # Create instance
+  p = Product.create
+
+  # Creator ObjectID   |   Updater ObjectID
+  p.created_by_id      |   p.updated_by_id
+  # => BSON::ObjectId('4f7c719f476da850ba000039')
+
+  # Creator instance   |   Updater instance
+  p.created_by         |   p.updated_by
+  # => <User _id: 4f7c719f476da850ba000039>
+
+  # Set creator/updater manually (usually not required)
+  p.created_by = MyUser.where(name: 'Will Smith')
+  p.updated_by = MyUser.where(name: 'DJ Jazzy Jeff')
+```
+
+
+## Preservation of Manually-set Values
+
+Mongoid::Userstamps will not overwrite manually set values in the creator and updater fields. Specifically:
+
+* The creator is only set during the creation of new models (`before_create` callback). Mongoid::Userstamps will not
+overwrite the creator field if it already contains a value (i.e. was manually set.)
+* The updater is set each time the model is saved (`before_save` callback), which includes the initial
+creation. Mongoid::Userstamps will not overwrite the updater field if it been modified since the last save, as
+per Mongoid's built-in "dirty tracking" feature.
+* The same logic goes for the deleter field if `Mongoid::Userstamps::Deleted` is included.
+
+
+## Rails Integration
+
+Popular Rails authentication frameworks such as Devise and Sorcery make a `current_user` method available in
+your Controllers. Mongoid::Userstamps will automatically use this to set its user reference in a `before_filter`
+on each request. (You can set an alternative method name via the `user_reader` config.)
+
+*Gotcha:* If you have special controller actions which change/switch the current user to a new user, you will
+need to set `User.current = new_user` after the switch occurs.
+
+
+## Thread Safety
+
+Mongoid::Userstamps stores all-related user variables in `Thread.current`. If the
+[RequestStore](https://github.com/steveklabnik/request_store) gem is installed, Mongoid::Userstamps
+will automatically store variables in the `RequestStore.store` instead. RequestStore is recommended
+for threaded web servers like Thin or Puma.
+
+
+## Advanced Usage: Scoped Execution
+
+It is possible to execute a block of code within the context of a given user as follows:
+
+```ruby
+User.current = staff
+User.current          #=> staff
+
+User.sudo(admin) do
+  my_model.save!
+  User.current        #=> admin
+end
+
+User.current          #=> staff
+```
+
+
+## Advanced Usage: Multiple User Classes
+
+Most Rails apps use a single user model. However, Mongoid::Userstamps supports using multiple user models
+at once, and will track a separate current_user for each class.
+
+Please note that each model may subscribe to only one user type for its userstamps, set via the
+`:user_model` option.
+
+```ruby
+  class Admin
+    include Mongoid::Document
+    include Mongoid::Userstamps::User
+
+    mongoid_userstamp_user reader: :current_admin
+  end
+
+  class Customer
+    include Mongoid::Document
+    include Mongoid::Userstamps::User
+
+    mongoid_userstamp_user reader: :current_customer
+  end
+
+  class Album
+    include Mongoid::Document
+    include Mongoid::Userstamps
+
+    mongoid_userstamp user_model: 'Customer'
+  end
+
+  class Label
+    include Mongoid::Document
+    include Mongoid::Userstamps
+
+    mongoid_userstamp user_model: 'Admin'
+  end
+
+  # Set current user for each type
+  Admin.current = Admin.where(name: 'Biz Markie')
+  Customer.current = Customer.where(name: 'Sir Mix-A-Lot')
+
+  # In your Controller action
+  album = Album.new('Baby Got Back Single')
+  album.save!
+  album.created_by.name   #=> 'Sir Mix-A-Lot'
+
+  label = Label.new('Cold Chillin Records')
+  label.save!
+  label.created_by.name   #=> 'Biz Markie'
+```
+
+## Contributing
+
+Fork -> Patch -> Test -> Push -> Pull Request
+
+Please use Ruby 1.9.3 hash syntax, as Mongoid 3 requires Ruby >= 1.9.3
+
+## Authors
+
+* [Geoffroy Planquart](https://github.com/Aethelflaed)
+* [Thomas Boerger](http://www.tbpro.de)
+* [John Shields](https://github.com/johnnyshields)
+* [Bharat Gupta](https://github.com/Bharat311)
+
+## Copyright
+
+Licensed under the MIT License (MIT). Refer to LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,15 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+desc 'Default: run unit tests'
+task :default => :test
+
+desc 'Run tests'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+

data/init.rb

@@ -0,0 +1,2 @@
+# -*- encoding : utf-8 -*-
+require 'mongoid_userstamp'

data/lib/mongoid/userstamps/config/model.rb

@@ -0,0 +1,43 @@
+# -*- encoding : utf-8 -*-
+
+module Mongoid
+  module Userstamps
+    module Config
+      class Model
+        attr_accessor :created_name
+        attr_accessor :updated_name
+        attr_accessor :deleted_name
+        attr_accessor :user_model
+
+        def initialize(opts = {})
+          @created_name = opts[:created_name]
+          @updated_name = opts[:updated_name]
+          @user_model   = opts[:user_model]
+        end
+
+        def created_name
+          @created_name || Mongoid::Userstamps::Config.created_name
+        end
+
+        def updated_name
+          @updated_name || Mongoid::Userstamps::Config.updated_name
+        end
+
+        def deleted_name
+          @deleted_name || Mongoid::Userstamps::Config.deleted_name
+        end
+
+        def user_model
+          @user_model || Mongoid::Userstamps::Config.user_classes.first.to_s
+        end
+        def user_model=(value)
+          @user_model = value.to_s if value
+        end
+        def user_model_defined?
+          !!@user_model
+        end
+      end
+    end
+  end
+end
+

data/lib/mongoid/userstamps/config/user.rb

@@ -0,0 +1,20 @@
+# -*- encoding : utf-8 -*-
+
+module Mongoid
+  module Userstamps
+    module Config
+      class User
+        attr_accessor :reader
+
+        def initialize(opts = {})
+          @reader = opts[:reader]
+        end
+
+        def reader
+          @reader || Mongoid::Userstamps::Config.user_reader
+        end
+      end
+    end
+  end
+end
+

data/lib/mongoid/userstamps/config.rb

@@ -0,0 +1,79 @@
+# -*- encoding : utf-8 -*-
+
+require 'mongoid/userstamps/config/model'
+require 'mongoid/userstamps/config/user'
+
+module Mongoid
+  module Userstamps
+    module Config
+      class << self
+        attr_accessor :created_name
+        attr_accessor :updated_name
+        attr_accessor :deleted_name
+        attr_accessor :user_reader
+
+        def eval
+          instance_eval(&Proc.new)
+        end
+
+        def user_classes
+          @user_classes ||= []
+        end
+
+        def add_user_class(klass)
+          user_classes << klass
+          model_classes.each do |model|
+            config = model.userstamps_model
+            if !config.user_model_defined?
+              model.relations[config.created_name.to_s].try(:[]=, :class_name, config.user_model)
+            end
+          end
+        end
+
+        def model_classes
+          @model_classes ||= []
+        end
+
+        def add_model_class(klass)
+          model_classes << klass
+        end
+
+        def created_name
+          @created_name ||= :created_by
+        end
+
+        def updated_name
+          @updated_name ||= :updated_by
+        end
+
+        def deleted_name
+          @deleted_name ||= :deleted_by
+        end
+
+        def user_reader
+          @user_reader ||= :current_user
+        end
+
+        def current_user(user_class)
+          store(user_class)
+        end
+
+        def set_current_user(user_class, value)
+          store(user_class, value)
+        end
+
+        def store(model, value = false)
+          return if !model
+          key = "mongoid-userstamps/#{model.to_s.underscore}".to_sym
+          store = defined?(RequestStore) ? RequestStore.store : Thread.current
+          if value == false
+            store[key]
+          else
+            store[key] = value
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/mongoid/userstamps/created.rb

@@ -0,0 +1,29 @@
+# -*- encoding : utf-8 -*-
+
+module Mongoid
+  module Userstamps
+    module Created
+      extend ActiveSupport::Concern
+
+      included do
+        if !self.included_modules.include?(Mongoid::Userstamps::Model)
+          include Mongoid::Userstamps::Model
+        end
+
+        belongs_to userstamps_model.created_name, {
+          class_name: userstamps_model.user_model,
+          inverse_of: nil
+        }
+
+        set_callback :create, :before, :set_created_by
+      end
+
+      def set_created_by
+        user = self.class.current_user
+        return if !user || self.public_send(userstamps_model.created_name)
+        self.public_send("#{userstamps_model.created_name}=", user)
+      end
+    end
+  end
+end
+

data/lib/mongoid/userstamps/deleted.rb

@@ -0,0 +1,29 @@
+# -*- encoding : utf-8 -*-
+
+module Mongoid
+  module Userstamps
+    module Deleted
+      extend ActiveSupport::Concern
+
+      included do
+        if !self.included_modules.include?(Mongoid::Userstamps::Model)
+          include Mongoid::Userstamps::Model
+        end
+
+        belongs_to userstamps_model.deleted_name, {
+          class_name: userstamps_model.user_model,
+          inverse_of: nil
+        }
+
+        set_callback :destroy, :before, :set_deleted_by
+      end
+
+      def set_deleted_by
+        user = self.class.current_user
+        return if !user || self.public_send("#{userstamps_model.deleted_name}_id_changed?")
+        self.public_send("#{userstamps_model.deleted_name}=", user)
+      end
+    end
+  end
+end
+

data/lib/mongoid/userstamps/model.rb

@@ -0,0 +1,26 @@
+module Mongoid
+  module Userstamps
+    module Model
+      extend ActiveSupport::Concern
+
+      included do
+        Mongoid::Userstamps::Config.add_model_class(self)
+      end
+
+      def userstamps_model
+        self.class.userstamps_model
+      end
+
+      class_methods do
+        def userstamps_model(opts = {})
+          @userstamps_model ||= Mongoid::Userstamps::Config::Model.new(opts)
+        end
+
+        def current_user
+          Mongoid::Userstamps::Config.current_user(userstamps_model.user_model)
+        end
+      end
+    end
+  end
+end
+

data/lib/mongoid/userstamps/railtie.rb

@@ -0,0 +1,20 @@
+# -*- encoding : utf-8 -*-
+
+module Mongoid
+  module Userstamps
+    class Railtie < Rails::Railtie
+      # Set current_user from controller reader method
+      ActiveSupport.on_load :action_controller do
+        before_filter do |c|
+          Mongoid::Userstamps::Config.user_classes.each do |user_class|
+            begin
+              user_class.current = c.public_send(user_class.userstamps_user.reader)
+            rescue
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/mongoid/userstamps/updated.rb

@@ -0,0 +1,29 @@
+# -*- encoding : utf-8 -*-
+
+module Mongoid
+  module Userstamps
+    module Updated
+      extend ActiveSupport::Concern
+
+      included do
+        if !self.included_modules.include?(Mongoid::Userstamps::Model)
+          include Mongoid::Userstamps::Model
+        end
+
+        belongs_to userstamps_model.updated_name, {
+          class_name: userstamps_model.user_model,
+          inverse_of: nil
+        }
+
+        set_callback :save, :before, :set_updated_by
+      end
+
+      def set_updated_by
+        user = self.class.current_user
+        return if !user || self.public_send("#{userstamps_model.updated_name}_id_changed?")
+        self.public_send("#{userstamps_model.updated_name}=", user)
+      end
+    end
+  end
+end
+

data/lib/mongoid/userstamps/user.rb

@@ -0,0 +1,43 @@
+# -*- encoding : utf-8 -*-
+module Mongoid
+  module Userstamps
+    module User
+      extend ActiveSupport::Concern
+
+      included do
+        Mongoid::Userstamps::Config.add_user_class(self)
+      end
+
+      def current?
+        self.id == self.class.current.try(:id)
+      end
+
+      def userstamps_user
+        self.class.userstamps_user
+      end
+
+      class_methods do
+        def current
+          Mongoid::Userstamps::Config.current_user(self)
+        end
+
+        def current=(value)
+          Mongoid::Userstamps::Config.set_current_user(self, value)
+        end
+
+        def sudo(user)
+          old = self.current
+          self.current = user
+          yield
+        ensure
+          self.current = old
+        end
+
+        def userstamps_user(opts = {})
+          @userstamps_user ||= Mongoid::Userstamps::Config::User.new(opts)
+        end
+      end
+    end
+  end
+end
+

data/lib/mongoid/userstamps/version.rb

@@ -0,0 +1,8 @@
+# -*- encoding : utf-8 -*-
+
+module Mongoid
+  module Userstamps
+    VERSION = '1.0.0'
+  end
+end
+