mongoid_token 2.1.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70068b3941cfb6ef389bf2b25f371702ef34d911
-  data.tar.gz: 8cb79b51d9b94fb6c93da485a8c3c488f327a9ca
+  metadata.gz: 2e7e198c4a8ca7b585adc467c61fea48a3305c09
+  data.tar.gz: 567b35c7a5325948819bdd451e81bc6c70ae947e
 SHA512:
-  metadata.gz: 9627f4505f3fbd85b499b16b04a5c2a578e480dd9033107e36549c7746a128eb6963bdc51af1eb93aaa7b2fa067d0901b2b20d7ebd0eb3343c9d788456bb063b
-  data.tar.gz: 3c7707128f42056c1feb7b8bd1ba88a731954106a67e273e93043cefa07177c8db97deb9f0cfdbfa202c16644a9891c6791a35aadb3e719ed9375af72ea15955
+  metadata.gz: 6b6efae4558362e1ecd71578b754f572511f99c31aa0e130a1aaedb1102185f50acf265c5e39c8ed7a679eab0780d7d98355fb2bc87a91da7eeee989aa3c6117
+  data.tar.gz: 7f94095e40997135530fc3d4751033555379bda52e6dc200779823ed4f8a34466e9c9166a8def733039146926fc6f492082ae2a22f7698a633c2cb207d6d17fc

data/README.md

@@ -60,6 +60,9 @@ in your app
 
 ## Finders
 
+**Note: overriding of the `find` method has been deprecated in this
+version and will be removed in the next major release.**
+
 By default, the gem will override the existing `find` method in Mongoid,
 in order to search for documents based on their token first (although
 the default behaviour of ObjectIDs is also there). You can disable these

data/lib/mongoid/token/finders.rb

@@ -11,6 +11,7 @@ module Mongoid
         end
 
         klass.define_singleton_method :"find_with_#{field_name}" do |*args| # this is going to be painful if tokens happen to look like legal object ids
+          warn "[DEPRECATION] Using `find' from Mongoid::Token has been deprecated and will be removed in version 3.0.0."
           args.all?{|arg| BSON::ObjectId.legal?(arg)} ? send(:"find_without_#{field_name}",*args) : klass.send(:"find_by_#{field_name.to_s}", args.first)
         end
 

data/lib/version.rb

@@ -1,3 +1,3 @@
 module MongoidToken
-  VERSION = "2.1.2"
+  VERSION = "2.2.0"
 end

data/spec/mongoid/token/finders_spec.rb

@@ -1,11 +1,17 @@
 require File.join(File.dirname(__FILE__), %w[.. .. spec_helper])
 
 describe Mongoid::Token::Finders do
+  before do
+    @orig_stderr = $stderr
+    $stderr = StringIO.new
+  end
+
   after do
+    $stderr = @orig_stderr
     Object.send(:remove_const, :Document) if Object.constants.include?(:Document)
     Object.send(:remove_const, :AnotherDocument) if Object.constants.include?(:AnotherDocument)
   end
-  
+
   it "define a finder based on a field_name" do
     klass = Class.new
     field = :another_token
@@ -56,4 +62,15 @@ describe Mongoid::Token::Finders do
     Mongoid::Token::Finders.define_custom_token_finder_for(AnotherDocument)
     AnotherDocument.find(["1234", "5678"]).should == [document, document2]
   end
+
+  describe :deprecations do
+    it "includes `find`" do
+      class AnotherDocument; include Mongoid::Document; field :token; end
+      document = AnotherDocument.create! :token => "1234"
+      Mongoid::Token::Finders.define_custom_token_finder_for(AnotherDocument)
+      AnotherDocument.find("1234")
+      $stderr.rewind
+      $stderr.string.chomp.should start_with("[DEPRECATION]"), "Expected deprecation warning for `find` method"
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_token
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Nicholas Bruning