mongo_mapper-strict_keys 0.0.4 → 0.0.5

data/README.md

@@ -4,11 +4,11 @@
 
 ### In your Gemfile:
 
-        gem 'mongo_mapper-strict_keys', '~>0.0.4'
+        gem 'mongo_mapper-strict_keys', '~>0.0.5'
 
 To force strict keys for all models, from the outset:
 
-        gem 'mongo_mapper-strict_keys', '~>0.0.4', :require => 'mongo_mapper/strict_keys/force_plugin'
+        gem 'mongo_mapper-strict_keys', '~>0.0.5', :require => 'mongo_mapper/strict_keys/force_plugin'
 
 ### In your Source Code / Model:
 
@@ -16,5 +16,8 @@ To force strict keys for all models, from the outset:
 
         class StrictModel
           include MongoMapper::Document
-          include MongoMapper::Plugins::StrictKeys
+
+          strict_keys!
         end
+
+If you already required the force\_plugin, then you don't need to specify 'strict_keys!'

data/lib/mongo_mapper/strict_keys.rb

@@ -11,10 +11,15 @@ module MongoMapper
       module ClassMethods; end
 
       module InstanceMethods
+        # @param [Symbol, String] name The name of the key to be ensured
+        # @return [true] This method either returns true or raises an exception
+        # @raise [ArgumentError] If 'name' has not been specified as a key
+        # @see MongoMapper::Plugins::Keys#key
         def ensure_key_exists(name)
           unless respond_to?("#{name}=")
             raise ArgumentError.new("Attribute '#{name}' has not been explicitly defined as a key.")
           end
+          true
         end
       end
 

data/lib/mongo_mapper/strict_keys/version.rb

@@ -1,7 +1,7 @@
 module MongoMapper
   module Plugins
     module StrictKeys
-      VERSION = '0.0.4'
+      VERSION = '0.0.5'
     end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: mongo_mapper-strict_keys
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Scott Gonyea