mongoid_token 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e7e198c4a8ca7b585adc467c61fea48a3305c09
-  data.tar.gz: 567b35c7a5325948819bdd451e81bc6c70ae947e
+  metadata.gz: 8c76063246f7bcb7225d68d373cfbc1b1ec569e1
+  data.tar.gz: cb1d18edee2bd3c1b201d51345c0d28bf0bdecf0
 SHA512:
-  metadata.gz: 6b6efae4558362e1ecd71578b754f572511f99c31aa0e130a1aaedb1102185f50acf265c5e39c8ed7a679eab0780d7d98355fb2bc87a91da7eeee989aa3c6117
-  data.tar.gz: 7f94095e40997135530fc3d4751033555379bda52e6dc200779823ed4f8a34466e9c9166a8def733039146926fc6f492082ae2a22f7698a633c2cb207d6d17fc
+  metadata.gz: 7f5e3b6924961274b881d0e9fa74fb524fad4eb622135d2668e4756ffc97c1ff28700d19db3d046aaaba22a9ed5a688efaf95cc1e361fb279b2aeebf74c1778a
+  data.tar.gz: f801efb0a8d8541b08d0b15c9dc777bbb821a37b6a4dfeac4a4b32096276e6a6117d3dabd9450995579e00262cdb01f68b9d756ae979566c602ae139c03ccf6d

data/README.md

@@ -60,20 +60,18 @@ 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 add a convenience `find_by_[token name]` method, to
+make it a tiny bit simpler to query by your tokens. If you'd rather it didn't,
+you can disable these with the
+[`skip_finders` configuration option](#skip-finders-skip_finders).
 
-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
-with the [`skip_finders` configuration option](#skip-finders-skip_finders).
+The methods accept either a single token, or an array of tokens:
 
 ```ruby
-Video.find("x3v98")
-Account.find("ACC-123456")
+Video.find_by_token("x3v98") # If your token was named 'token'
+Account.find_by_account_number(["ACC-123456", "ACC-567890"]) # If your token was named 'account_number'
 ```
 
-
 ## Configuration
 
 ### Tokens
@@ -184,8 +182,7 @@ token :field_name => :yet_another
 
 ### Skip Finders (`:skip_finders`)
 
-This will prevent the gem from creating the customised finders and
-overrides for the default `find` behaviour used by Mongoid.
+This will prevent the gem from creating the extra `find_by_*` methods.
 
 __Example:__
 ```ruby

data/lib/mongoid/token/finders.rb

@@ -9,15 +9,6 @@ module Mongoid
             self.find_by field_name.to_sym => token
           end
         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
-
-        # this craziness taken from, and then compacted into a string class_eval
-        # http://geoffgarside.co.uk/2007/02/19/activesupport-alias-method-chain-modules-and-class-methods/
-        klass.class_eval("class << self; alias_method_chain :find, :#{field_name} if self.method_defined?(:find); end")
       end
     end
   end

data/lib/mongoid/token/options.rb

@@ -16,7 +16,7 @@ class Mongoid::Token::Options
   end
 
   def field_name
-    @options[:field_name]
+    !@options[:id] && @options[:field_name] || :_id
   end
 
   def skip_finders?
@@ -27,6 +27,10 @@ class Mongoid::Token::Options
     @options[:override_to_param]
   end
 
+  def generate_on_init
+    @options[:id] || @options[:generate_on_init]
+  end
+
   def pattern
     @options[:pattern] ||= case @options[:contains].to_sym
     when :alphanumeric
@@ -61,12 +65,14 @@ class Mongoid::Token::Options
 
   def merge_defaults(options)
     {
-      :length => 4,
-      :retry_count => 3,
-      :contains => :alphanumeric,
-      :field_name => :token,
-      :skip_finders => false,
-      :override_to_param => true,
+      id: false,
+      length: 4,
+      retry_count: 3,
+      contains: :alphanumeric,
+      field_name: :token,
+      skip_finders: false,
+      override_to_param: true,
+      generate_on_init: false
     }.merge(options)
   end
 end

data/lib/mongoid/token.rb

@@ -20,14 +20,14 @@ module Mongoid
         add_token_field_and_index(options)
         add_token_collision_resolver(options)
         set_token_callbacks(options)
-        
+
         define_custom_finders(options) if options.skip_finders? == false
         override_to_param(options) if options.override_to_param?
       end
 
       private
       def add_token_field_and_index(options)
-        self.field options.field_name, :type => String, :default => nil
+        self.field options.field_name, :type => String, :default => default_value(options)
         self.index({ options.field_name => 1 }, { :unique => true, :sparse => true })
       end
 
@@ -57,6 +57,10 @@ module Mongoid
           self.send(options.field_name) || super()
         end
       end
+
+      def default_value(options)
+        options.generate_on_init && Mongoid::Token::Generator.generate(options.pattern) || nil
+      end
     end
 
     protected

data/lib/version.rb

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

data/spec/mongoid/token/finders_spec.rb

@@ -1,13 +1,7 @@
 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
@@ -19,20 +13,6 @@ describe Mongoid::Token::Finders do
     klass.singleton_methods.should include(:"find_by_#{field}")
   end
 
-  it "override the `find` method of the document" do
-    klass = Class.new
-    klass.define_singleton_method(:find) {|*args| :original_find }
-    klass.define_singleton_method(:find_by) {|*args| :token_find }
-
-    Mongoid::Token::Finders.define_custom_token_finder_for(klass)
-
-    klass.find(BSON::ObjectId.new).should == :original_find
-    klass.find(BSON::ObjectId.new, BSON::ObjectId.new).should == :original_find
-    klass.find().should == :original_find
-    klass.find(BSON::ObjectId.new, "token").should == :token_find
-    klass.find("token").should == :token_find
-  end
-
   it "retrieve a document using the dynamic finder" do
     class Document; include Mongoid::Document; field :token; end
     document = Document.create!(:token => "1234")
@@ -47,30 +27,4 @@ describe Mongoid::Token::Finders do
     Mongoid::Token::Finders.define_custom_token_finder_for(Document)
     Document.find_by_token(["1234", "5678"]).should == [document, document2]
   end
-
-  it "retrieve a document using the `find` method" 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").should == document
-  end
-
-  it 'retrieves multiple documents using the `find` method' do
-    class AnotherDocument; include Mongoid::Document; field :token; end
-    document = AnotherDocument.create! :token => "1234"
-    document2 = AnotherDocument.create! :token => "5678"
-    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

data/spec/mongoid/token/options_spec.rb

@@ -67,4 +67,36 @@ describe Mongoid::Token::Options do
       expect(Mongoid::Token::Options.new.skip_finders?).to eq false
     end
   end
+
+  describe "id" do
+    context "when true" do
+      it "returns '_id' sa the field name" do
+        expect(Mongoid::Token::Options.new({id: true, field_name: :a_token}).field_name).to eq :_id
+      end
+    end
+
+    context "when false" do
+      it "returns the field_name option as the field name" do
+        expect(Mongoid::Token::Options.new({id: false, field_name: :a_token}).field_name).to eq :a_token
+      end
+    end
+  end
+
+  describe :generate_on_init do
+    it "defaults to false" do
+      expect(Mongoid::Token::Options.new({}).generate_on_init).to eq false
+    end
+
+    context "when id option set" do
+      it "is true" do
+        expect(Mongoid::Token::Options.new({id: true}).generate_on_init).to eq true
+      end
+    end
+
+    context "when id option is not set" do
+      it "is false" do
+        expect(Mongoid::Token::Options.new({id: false}).generate_on_init).to eq false
+      end
+    end
+  end
 end

data/spec/mongoid/token_spec.rb

@@ -4,6 +4,7 @@ describe Mongoid::Token do
   after do
     Object.send(:remove_const, :Document) if Object.constants.include?(:Document)
     Object.send(:remove_const, :AnotherDocument) if Object.constants.include?(:AnotherDocument)
+    Object.send(:remove_const, :UntaintedDocument) if Object.constants.include?(:UntaintedDocument)
   end
 
   let(:document_class) do
@@ -259,4 +260,28 @@ describe Mongoid::Token do
       end
     end
   end
+
+  describe "with overriden id" do
+    # Capture warnings about overriding _id, for cleaner test output
+    before do
+      @orig_stdout = $stdout
+      $stdout = StringIO.new
+      document_class.send(:token, id: true)
+    end
+
+    after do
+      $stdout = @orig_stdout
+    end
+
+    let(:document){ document_class.new }
+
+    it "should replace the _id field with a token" do
+      expect(document).to have_field(:_id)
+      expect(document).to_not have_field(:token)
+    end
+
+    it "should have a default token" do
+      expect(document.id).to_not be_blank
+    end
+  end
 end

metadata

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