mongoid_userstamp 0.3.0 → 0.3.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODA4YmMxOWYzZTRjMTQ3MzhjYTcwYjEyNTE3YjJkMzZmZjQzOGM4MQ==
+    ODZhMzk0MmJlYTI2NDZiMzFkZDM4N2JkNzZkOTU4ZGNlMTVmMDFlZg==
   data.tar.gz: !binary |-
-    MTIwZTFlMTM3YjEzODA0ZWUwMzliYzYwMWI1ODVmN2ZkZWJhZDFkNw==
+    NzNiZjUxYzc3ZWNkNTc4ZDQyOGNkNTE3NmEwOGYzOGU4M2QxYWE1NQ==
 SHA512:
   metadata.gz: !binary |-
-    MmZiN2E0ODk1YWRhMWM5ODkzMzljOWM2NzVkZmVkOGFiM2UzNzcxYTA1YTBi
-    MzBlMmFlZWUyMGQ1NDhkNjY1YTdkMjUyZThjNjc4NTA2YzJlMGM1ZDZlODEy
-    MWFkOGEyMTYyM2Q4NDJiMmY3ZTllZWM5MTJlMjlhOWEyN2ZmMmY=
+    NDRiMDkzOGNmYTJhY2Y4ZjljYTRiNmJmODM1Mjg2ZjliYzc2ODJhMzgwMzE2
+    MmNiM2I5NTkzZWVjNzlhYmIxOTVjZDFmMTkzY2E5ZGI4YjMwNDNmZDJkOGE2
+    YWQ0MzY5NDAyM2E0MTdlYjI1YzA1Y2I5MWExMmRhMzVmZTFhZDg=
   data.tar.gz: !binary |-
-    ZDdlMmYyZWI2ZjA0MDA0ZTg0NmJjYTVhOTY2MWJkN2I4ZWVkMzdlZTIwZTM0
-    YzcyZDRjNDYxNmU4NzUyNjdjZGZiMWE2MWVhMDYzYmQ1NjdmNDRhZGYyZjY1
-    ZGZjOGUxOGY3YTIyMWE5ZDkzNTFlNzU4YmVmM2JmZjUwYjk1Mjc=
+    OWNhNGYyMzY1NTc3NzI3ZWMwZjFhZjZlOTdkYjQwOTQxYTQxMzE1MzczY2Yy
+    OWJiZDA4MjBmMTI0NzdjMmIzZmZkZDViN2M2NjgyY2RlMTk5NjM5MGVkZmRj
+    MDQzODg4ODQxMDZiY2UyNTU0OGU5ODVhMDFlY2ZhN2RmZDQwOWE=

data/.gitignore

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

data/.travis.yml

@@ -1,8 +1,20 @@
-language: ruby
-rvm:
-  - 2.0.0
-  - 1.9.3
-  - jruby-19mode
-  - rbx-19mode
-
-services: mongodb
+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

@@ -1,26 +1,41 @@
-# Changelog
-
-## [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)
+# 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

@@ -1,9 +1,3 @@
-source 'http://rubygems.org'
-
-gem 'mongoid', '>= 3.0.4'
-
-group :development do
-  gem 'rspec', '>= 2.13.0'
-  gem 'yard', '>= 0.8.2.1'
-  gem 'jeweler', '>= 1.8.3'
-end
+source 'http://rubygems.org'
+
+gemspec

data/{LICENSE.md → LICENSE}

@@ -1,20 +1,22 @@
-Copyright (c) 2013 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.
+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

@@ -1,72 +1,92 @@
-# MongoidUserstamp [![Build Status](https://secure.travis-ci.org/tbpro/mongoid_userstamp.png)](https://travis-ci.org/tbpro/mongoid_userstamp) [![Code Climate](https://codeclimate.com/github/tbpro/mongoid_userstamp.png)](https://codeclimate.com/github/tbpro/mongoid_userstamp)
-
-MongoidUserstamp adds stamp columns for created by and updated by
-informations within rails applications. Mongoid requires a ruby 
-version above 1.8, so i've written the gem on the new 1.9 hash syntax.
-
-## 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.created_column = :created_by
-   c.created_accessor = :creator
-
-   c.updated_column = :updated_by
-   c.updated_accessor = :updater
-
-   # Optional config values
-
-   # c.created_alias = :c
-   # c.updated_alias = :u
- end
-
- # Example model
- class Person
-   include Mongoid::Document
-   include Mongoid::Userstamp
- end
- 
- # Create instance
- p = Person.create
-
- # Updater ObjectID or nil
- p.updated_by
- # => 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.created_by
- # => 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
- ```
-
-## Credits
-
-Copyright (c) 2012-2013 Thomas Boerger Programmierung <http://www.tbpro.de>
+# MongoidUserstamp [![Build Status](https://secure.travis-ci.org/tbpro/mongoid_userstamp.png)](https://travis-ci.org/tbpro/mongoid_userstamp) [![Code Climate](https://codeclimate.com/github/tbpro/mongoid_userstamp.png)](https://codeclimate.com/github/tbpro/mongoid_userstamp)
+
+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.created_column = :created_by
+    c.created_accessor = :creator
+
+    c.updated_column = :updated_by
+    c.updated_accessor = :updater
+
+    # Optional config values
+
+    # c.created_alias = :c
+    # c.updated_alias = :u
+  end
+
+  # Example model
+  class Person
+    include Mongoid::Document
+    include Mongoid::Userstamp
+  end
+ 
+  # Create instance
+  p = Person.create
+
+  # Updater ObjectID or nil
+  p.updated_by
+  # => 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.created_by
+  # => 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)
+
+## Copyright
+
+Copyright (c) 2012-2013 Thomas Boerger Programmierung <http://www.tbpro.de>
+
+Licensed under the MIT License (MIT). Refer to LICENSE for details.

data/Rakefile

@@ -1,41 +1,23 @@
-require 'rubygems'
-
-begin
-  require 'bundler'
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts 'Run `bundle install` to install missing gems'
-  
-  exit e.status_code
-end
-
-require 'rake'
-require 'jeweler'
-require 'yard'
-
-$:.push File.expand_path('../lib', __FILE__)
-require 'mongoid/userstamp/version'
-
-Jeweler::Tasks.new do |gem|
-  gem.name = 'mongoid_userstamp'
-  gem.version = Mongoid::Userstamp::Version::STRING
-  gem.homepage = 'https://github.com/tbpro/mongoid_userstamp'
-  gem.license = 'MIT'
-  gem.summary = %Q{Userstamp for mongoid}
-  gem.description = %Q{Userstamp for created and updated columns within mongoid}
-  gem.email = 'tboerger@tbpro.de'
-  gem.authors = ['Thomas Boerger', 'Johnny Shields']
-end
-
-YARD::Rake::YardocTask.new
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-  spec.rspec_opts = '--color --format progress'
-end
-
-task default: :spec
+begin
+  require 'bundler'
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+require 'bundler/gem_tasks'
+require 'yard'
+
+YARD::Rake::YardocTask.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.rspec_opts = '--color --format progress'
+end
+
+task default: :spec

data/init.rb

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

data/lib/mongoid/userstamp.rb

@@ -1,86 +1,89 @@
-# -*- encoding : utf-8 -*-
-
-module Mongoid
-  module Userstamp
-    extend ActiveSupport::Concern
-
-    included do
-      field Userstamp.config.updated_column, Userstamp.field_opts(Userstamp.config.updated_column_opts)
-      field Userstamp.config.created_column, Userstamp.field_opts(Userstamp.config.created_column_opts)
-
-      before_save :set_updater
-      before_create :set_creator
-
-      define_method Userstamp.config.updated_accessor do
-        Userstamp.find_user self.send(Userstamp.config.updated_column)
-      end
-
-      define_method Userstamp.config.created_accessor do
-        Userstamp.find_user self.send(Userstamp.config.created_column)
-      end
-
-      define_method "#{Userstamp.config.updated_accessor}=" do |user|
-        self.send("#{Userstamp.config.updated_column}=", Userstamp.extract_bson_id(user))
-      end
-
-      define_method "#{Userstamp.config.created_accessor}=" do |user|
-        self.send("#{Userstamp.config.created_column}=", Userstamp.extract_bson_id(user))
-      end
-
-      protected
-
-      def set_updater
-        return if !Userstamp.has_current_user?
-        self.send("#{Userstamp.config.updated_accessor}=", Userstamp.current_user)
-      end
-
-      def set_creator
-        return if !Userstamp.has_current_user? || self.send(Userstamp.config.created_column)
-        self.send("#{Userstamp.config.created_accessor}=", 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
-
-      # @deprecated Use {#config} instead
-      alias :configure :config
-
-      def field_opts(opts)
-        {type: ::Moped::BSON::ObjectId}.reverse_merge(opts || {})
-      end
-
-      def has_current_user?
-        config.user_model.respond_to?(:current)
-      end
-
-      def current_user
-        config.user_model.try(:current)
-      end
-
-      def extract_bson_id(value)
-        if value.respond_to?(:_id)
-          value.try(:_id)
-        elsif value.present?
-          ::Moped::BSON::ObjectId.from_string(value.to_s)
-        else
-          nil
-        end
-      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
+# -*- encoding : utf-8 -*-
+
+module Mongoid
+  module Userstamp
+    extend ActiveSupport::Concern
+
+    included do
+      field Userstamp.config.updated_column, Userstamp.field_opts(Userstamp.config.updated_column_opts)
+      field Userstamp.config.created_column, Userstamp.field_opts(Userstamp.config.created_column_opts)
+
+      before_save :set_updater
+      before_create :set_creator
+
+      define_method Userstamp.config.updated_accessor do
+        Userstamp.find_user self.send(Userstamp.config.updated_column)
+      end
+
+      define_method Userstamp.config.created_accessor do
+        Userstamp.find_user self.send(Userstamp.config.created_column)
+      end
+
+      define_method "#{Userstamp.config.updated_accessor}=" do |user|
+        self.send("#{Userstamp.config.updated_column}=", Userstamp.extract_bson_id(user))
+      end
+
+      define_method "#{Userstamp.config.created_accessor}=" do |user|
+        self.send("#{Userstamp.config.created_column}=", Userstamp.extract_bson_id(user))
+      end
+
+      protected
+
+      def set_updater
+        return if !Userstamp.has_current_user?
+        self.send("#{Userstamp.config.updated_accessor}=", Userstamp.current_user)
+      end
+
+      def set_creator
+        return if !Userstamp.has_current_user? || self.send(Userstamp.config.created_column)
+        self.send("#{Userstamp.config.created_accessor}=", 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
+
+      # DEPRECATED
+      def configure(&block)
+        warn 'Mongoid::Userstamp.configure is deprecated. Please use Mongoid::Userstamp.config instead'
+        config(block)
+      end
+
+      def field_opts(opts)
+        {type: ::Moped::BSON::ObjectId}.reverse_merge(opts || {})
+      end
+
+      def has_current_user?
+        config.user_model.respond_to?(:current)
+      end
+
+      def current_user
+        config.user_model.try(:current)
+      end
+
+      def extract_bson_id(value)
+        if value.respond_to?(:_id)
+          value.try(:_id)
+        elsif value.present?
+          ::Moped::BSON::ObjectId.from_string(value.to_s)
+        else
+          nil
+        end
+      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