mongoid_userstamp 0.2.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODA4YmMxOWYzZTRjMTQ3MzhjYTcwYjEyNTE3YjJkMzZmZjQzOGM4MQ==
+  data.tar.gz: !binary |-
+    MTIwZTFlMTM3YjEzODA0ZWUwMzliYzYwMWI1ODVmN2ZkZWJhZDFkNw==
+SHA512:
+  metadata.gz: !binary |-
+    MmZiN2E0ODk1YWRhMWM5ODkzMzljOWM2NzVkZmVkOGFiM2UzNzcxYTA1YTBi
+    MzBlMmFlZWUyMGQ1NDhkNjY1YTdkMjUyZThjNjc4NTA2YzJlMGM1ZDZlODEy
+    MWFkOGEyMTYyM2Q4NDJiMmY3ZTllZWM5MTJlMjlhOWEyN2ZmMmY=
+  data.tar.gz: !binary |-
+    ZDdlMmYyZWI2ZjA0MDA0ZTg0NmJjYTVhOTY2MWJkN2I4ZWVkMzdlZTIwZTM0
+    YzcyZDRjNDYxNmU4NzUyNjdjZGZiMWE2MWVhMDYzYmQ1NjdmNDRhZGYyZjY1
+    ZGZjOGUxOGY3YTIyMWE5ZDkzNTFlNzU4YmVmM2JmZjUwYjk1Mjc=

data/.travis.yml

@@ -4,5 +4,5 @@ rvm:
   - 1.9.3
   - jruby-19mode
   - rbx-19mode
-  
+
 services: mongodb

data/CHANGELOG.md

@@ -1,4 +1,26 @@
-## v0.2.0 (2013-03-24)
+# Changelog
 
-* Added some specs for test coverage
-* Removed dependecy for `Mongoid::Timestamps`
+## [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/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Thomas Boerger Programmierung <http://www.tbpro.de>
+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

data/README.md

@@ -14,7 +14,10 @@ version above 1.8, so i've written the gem on the new 1.9 hash syntax.
 
  ```ruby
  # Default config
- Mongoid::Userstamp.configure do |c|
+ Mongoid::Userstamp.config do |c|
+
+   # Default config values
+
    c.user_reader = :current_user
    c.user_model = :user
 
@@ -22,7 +25,12 @@ version above 1.8, so i've written the gem on the new 1.9 hash syntax.
    c.created_accessor = :creator
 
    c.updated_column = :updated_by
-   c.updated_accessor = :updator
+   c.updated_accessor = :updater
+
+   # Optional config values
+
+   # c.created_alias = :c
+   # c.updated_alias = :u
  end
 
  # Example model
@@ -35,20 +43,28 @@ version above 1.8, so i've written the gem on the new 1.9 hash syntax.
  p = Person.create
 
  # Updater ObjectID or nil
- p.created_by
+ p.updated_by
  # => BSON::ObjectId('4f7c719f476da850ba000039')
 
  # Updater instance or nil
- p.creator
+ p.updater
  # => <User _id: 4f7c719f476da850ba000039>
 
- # Creater ObjectID or nil
- p.updated_by
+ # 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')
 
- # Creater instance or nil
- p.updator
+ # 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

data/Rakefile

@@ -22,12 +22,12 @@ Jeweler::Tasks.new do |gem|
   gem.version = Mongoid::Userstamp::Version::STRING
   gem.homepage = 'https://github.com/tbpro/mongoid_userstamp'
   gem.license = 'MIT'
-  gem.summary = %Q{Userstamp for created and updated columns within mongoid}
+  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']
+  gem.authors = ['Thomas Boerger', 'Johnny Shields']
 end
 
-Jeweler::RubygemsDotOrgTasks.new
 YARD::Rake::YardocTask.new
 
 require 'rspec/core'

data/lib/mongoid/userstamp.rb

@@ -1,53 +1,85 @@
 # -*- encoding : utf-8 -*-
+
 module Mongoid
   module Userstamp
     extend ActiveSupport::Concern
 
-    autoload :Version, 'mongoid/userstamp/version'
-    autoload :Railtie, 'mongoid/userstamp/railtie'
-    autoload :Config, 'mongoid/userstamp/config'
-    autoload :User, 'mongoid/userstamp/user'
-
     included do
-      field Mongoid::Userstamp.configuration.updated_column, :type => Object
-      field Mongoid::Userstamp.configuration.created_column, :type => Object
+      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_updator
+      before_save :set_updater
       before_create :set_creator
 
-      define_method Mongoid::Userstamp.configuration.updated_accessor do
-        updated_col = self.send(Mongoid::Userstamp.configuration.updated_column)
-        updated_col ? Mongoid::Userstamp.configuration.user_model.find(updated_col) : nil
+      define_method Userstamp.config.updated_accessor do
+        Userstamp.find_user self.send(Userstamp.config.updated_column)
       end
 
-      define_method Mongoid::Userstamp.configuration.created_accessor do
-        created_col = self.send(Mongoid::Userstamp.configuration.created_column)
-        created_col ? Mongoid::Userstamp.configuration.user_model.find(created_col) : nil
+      define_method Userstamp.config.created_accessor do
+        Userstamp.find_user self.send(Userstamp.config.created_column)
       end
 
-      protected
-        def set_updator
-          return unless Mongoid::Userstamp.configuration.user_model.respond_to? :current
-          column = "#{Mongoid::Userstamp.configuration.updated_column.to_s}=".to_sym
+      define_method "#{Userstamp.config.updated_accessor}=" do |user|
+        self.send("#{Userstamp.config.updated_column}=", Userstamp.extract_bson_id(user))
+      end
 
-          self.send(column, Mongoid::Userstamp.configuration.user_model.current.try(:id))
-        end
+      define_method "#{Userstamp.config.created_accessor}=" do |user|
+        self.send("#{Userstamp.config.created_column}=", Userstamp.extract_bson_id(user))
+      end
 
-        def set_creator
-          return unless Mongoid::Userstamp.configuration.user_model.respond_to? :current
-          column = "#{Mongoid::Userstamp.configuration.created_column.to_s}=".to_sym
+      protected
 
-          self.send(column, Mongoid::Userstamp.configuration.user_model.current.try(:id))
-        end
+      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 configure(&block)
-        @@configuration = Mongoid::Userstamp::Config.new(&block)
+      def config(&block)
+        if block_given?
+          @@config = Userstamp::Config.new(&block)
+        else
+          @@config ||= Userstamp::Config.new
+        end
       end
 
-      def configuration
-        @@configuration ||= Mongoid::Userstamp::Config.new
+      # @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

data/lib/mongoid/userstamp/config.rb

@@ -2,24 +2,22 @@
 module Mongoid
   module Userstamp
     class Config
+      attr_writer :user_model
       attr_accessor :user_reader
-      attr_accessor :user_model
-
       attr_accessor :created_column
+      attr_accessor :created_column_opts
       attr_accessor :created_accessor
-
       attr_accessor :updated_column
+      attr_accessor :updated_column_opts
       attr_accessor :updated_accessor
 
       def initialize(&block)
-        @user_reader = :current_user
         @user_model = :user
-
+        @user_reader = :current_user
         @created_column = :created_by
         @created_accessor = :creator
-
         @updated_column = :updated_by
-        @updated_accessor = :updator
+        @updated_accessor = :updater
 
         instance_eval(&block) if block_given?
       end

data/lib/mongoid/userstamp/railtie.rb

@@ -4,14 +4,14 @@ module Mongoid
     class Railtie < Rails::Railtie
       ActiveSupport.on_load :action_controller do
         before_filter do |c|
-          unless Mongoid::Userstamp.configuration.user_model.respond_to? :current
-            Mongoid::Userstamp.configuration.user_model.send(
+          unless Mongoid::Userstamp.config.user_model.respond_to? :current
+            Mongoid::Userstamp.config.user_model.send(
               :include,
               Mongoid::Userstamp::User
             )
           end
 
-          Mongoid::Userstamp.configuration.user_model.current = c.send(Mongoid::Userstamp.configuration.user_reader)
+          Mongoid::Userstamp.config.user_model.current = c.send(Mongoid::Userstamp.config.user_reader)
         end
       end
     end

data/lib/mongoid/userstamp/user.rb

@@ -6,7 +6,7 @@ module Mongoid
 
       included do
         def current?
-          !Thread.current[:user].nil? && self.id == Thread.current[:user].id
+          !Thread.current[:user].nil? && self._id == Thread.current[:user]._id
         end
       end
 

data/lib/mongoid/userstamp/version.rb

@@ -3,8 +3,8 @@ module Mongoid
   module Userstamp
     module Version
       MAJOR = 0
-      MINOR = 2
-      PATCH = 1
+      MINOR = 3
+      PATCH = 0
       BUILD = nil
 
       STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

data/lib/mongoid_userstamp.rb

@@ -1,3 +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_userstamp.gemspec

@@ -2,21 +2,23 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: mongoid_userstamp 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "mongoid_userstamp"
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Thomas Boerger"]
-  s.date = "2013-04-05"
+  s.authors = ["Thomas Boerger", "Johnny Shields"]
+  s.date = "2013-10-02"
+  s.description = "Userstamp for created and updated columns within mongoid"
   s.email = "tboerger@tbpro.de"
   s.extra_rdoc_files = [
     "LICENSE.md",
     "README.md"
   ]
   s.files = [
-    ".rbenv-version",
+    ".ruby-version",
     ".travis.yml",
     "CHANGELOG.md",
     "Gemfile",
@@ -40,11 +42,11 @@ Gem::Specification.new do |s|
   s.homepage = "https://github.com/tbpro/mongoid_userstamp"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
-  s.summary = "Userstamp for created and updated columns within mongoid"
+  s.rubygems_version = "2.1.5"
+  s.summary = "Userstamp for mongoid"
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<mongoid>, [">= 3.0.4"])

data/spec/mongoid/userstamp_spec.rb

@@ -1,62 +1,163 @@
 # -*- encoding : utf-8 -*-
 require 'spec_helper'
 
-describe 'Mongoid::Userstamp' do
-  subject {
-    Book.new(
-      name: 'Crafting Rails Applications'
-    )
-  }
+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 { should respond_to :created_by }
   it { should respond_to :creator }
   it { should respond_to :updated_by }
-  it { should respond_to :updator }
+  it { should 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 { should be_nil }
+    end
+
+    context 'when current user is set' do
+      before{ User.current = user_1 }
+      it { should eq user_1 }
+    end
+  end
 
   context 'when created without a user' do
-    before {
+    before do
+      User.current = nil
       subject.save!
-    }
+    end
 
     it { subject.created_by.should be_nil }
     it { subject.creator.should be_nil }
     it { subject.updated_by.should be_nil }
-    it { subject.updator.should be_nil }
+    it { subject.updater.should be_nil }
   end
 
-  context 'when created by a user' do
-    let(:user_1) {
-      User.create!(
-        name: 'Charles Dikkens'
-      )
-    }
+  context 'when creator is manually set' do
+    before{ User.current = user_1 }
+
+    context 'set by id' do
+      before do
+        subject.created_by = user_2._id
+        subject.save!
+      end
 
-    before {
+      it 'should not be overridden when saved' do
+        subject.created_by.should eq user_2.id
+        subject.creator.should eq user_2
+        subject.updated_by.should eq user_1.id
+        subject.updater.should 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
+        subject.created_by.should eq user_2.id
+        subject.creator.should eq user_2
+        subject.updated_by.should eq user_1.id
+        subject.updater.should eq user_1
+      end
+    end
+  end
+
+  context 'when created by a user' do
+    before do
       User.current = user_1
-      subject.save
-    }
+      subject.save!
+    end
 
     it { subject.created_by.should == user_1.id }
     it { subject.creator.should == user_1 }
     it { subject.updated_by.should == user_1.id }
-    it { subject.updator.should == user_1 }
+    it { subject.updater.should == user_1 }
 
     context 'when updated by a user' do
-      let(:user_2) {
-        User.create!(
-          name: 'Edmund Wells'
-        )
-      }
-
-      before {
+      before do
         User.current = user_2
         subject.save!
-      }
+      end
 
       it { subject.created_by.should == user_1.id }
       it { subject.creator.should == user_1 }
       it { subject.updated_by.should == user_2.id }
-      it { subject.updator.should == user_2 }
+      it { subject.updater.should == user_2 }
+    end
+
+    context 'when user has been destroyed' do
+      before do
+        User.current = user_2
+        subject.save!
+        user_1.destroy
+        user_2.destroy
+      end
+
+      it { subject.created_by.should == user_1.id }
+      it { subject.creator.should == nil }
+      it { subject.updated_by.should == user_2.id }
+      it { subject.updater.should == nil }
+    end
+  end
+
+  describe '#config' do
+    before do
+      Mongoid::Userstamp.config do |c|
+        c.user_reader = :current_user
+        c.user_model  = :user
+
+        c.created_column   = :c_by
+        c.created_column_opts = {as: :created_by_id}
+        c.created_accessor = :created_by
+
+        c.updated_column   = :u_by
+        c.updated_column_opts = {as: :updated_by_id}
+        c.updated_accessor = :updated_by
+      end
+
+      # class definition must come after config
+      class Novel
+        include Mongoid::Document
+        include Mongoid::Userstamp
+
+        field :name
+      end
+    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 { subject.c_by.should == user_1.id }
+      it { subject.created_by_id.should == user_1.id }
+      it { subject.created_by.should == user_1 }
+      it { subject.u_by.should == user_1.id }
+      it { subject.updated_by_id.should == user_1.id }
+      it { subject.updated_by.should == user_1 }
+
+      context 'when updated by a user' do
+        before do
+          User.current = user_2
+          subject.save!
+        end
+
+        it { subject.c_by.should == user_1.id }
+        it { subject.created_by_id.should == user_1.id }
+        it { subject.created_by.should == user_1 }
+        it { subject.u_by.should == user_2.id }
+        it { subject.updated_by_id.should == user_2.id }
+        it { subject.updated_by.should == user_2 }
+      end
     end
   end
+
 end

metadata

@@ -1,20 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_userstamp
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Thomas Boerger
+- Johnny Shields
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-05 00:00:00.000000000 Z
+date: 2013-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +21,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +28,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +35,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +42,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +49,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +56,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,12 +63,11 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.8.3
-description: 
+description: Userstamp for created and updated columns within mongoid
 email: tboerger@tbpro.de
 executables: []
 extensions: []
@@ -83,7 +75,7 @@ extra_rdoc_files:
 - LICENSE.md
 - README.md
 files:
-- .rbenv-version
+- .ruby-version
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
@@ -106,29 +98,26 @@ files:
 homepage: https://github.com/tbpro/mongoid_userstamp
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1819917974665948435
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.1.5
 signing_key: 
-specification_version: 3
-summary: Userstamp for created and updated columns within mongoid
+specification_version: 4
+summary: Userstamp for mongoid
 test_files: []
+has_rdoc: