mongoid_token 1.1.0 → 1.1.1

data/.travis.yml

@@ -7,3 +7,5 @@ gemfile:
 notifications:
   recipients:
     - nicholas@bruning.com.au
+services:
+  - mongodb

data/Gemfile

@@ -4,6 +4,5 @@ gemspec
 
 group :test do
   gem 'database_cleaner'
-  gem 'autotest'
   gem 'mongoid-rspec', '1.5.1'
 end

data/README.md

@@ -15,11 +15,19 @@ Into something more like this:
     http://myawesomewebapp.com/video/83xQ3r/edit
 
 
+## Mongoid 3.x Support
+
+As of version 1.1.0, Mongoid::Token now supports Mongoid 3.x.
+
+> If you still require __Mongoid 2.x__ support, please install
+> Mongoid::Token 1.0.0.
+
+
 ## Getting started
 
 In your gemfile, add:
 
-    gem 'mongoid_token', '~> 1.0.0'
+    gem 'mongoid_token', '~> 1.1.0'
 
 Then update your bundle
 
@@ -63,9 +71,13 @@ The options for `contains` are as follows:
 
 * `:alphanumeric` - letters (upper and lowercase) and numbers
 * `:alpha` - letters (upper and lowercase) only
+* `:alpha_lower` - letters (lowercase) only
+* `:alpha_upper` - letters (uppercase) only
 * `:numeric` - numbers only, anything from 1 character long, up to and
   `length`
 * `:fixed_numeric` - numbers only, but with the number of characters always the same as `length`
+* `:fixed_numeric_no_leading_zeros` - as above, but will never start with
+zeros
 
 You can also rename the token field, if required, using the
 `:field_name` option:
@@ -77,10 +89,13 @@ You can also rename the token field, if required, using the
 * `token :length => 8, :contains => :alphanumeric` generates something like `8Sdc98dQ`
 * `token :length => 5, :contains => :alpha` gereates something like
   `ASlkj`
+* token :length 
 * `token :length => 4, :contains => :numeric` could generate anything
   from `0` upto `9999` - but in a random order
 * `token :length => 4, :contains => :fixed_numeric` will generate
   anything from `0000` to `9999` in a random order
+* `token :length => 4, :contains => :fixed_numeric_no_leading_zeros` will
+generate anything from `1000` to `9999` in a random order
 
 
 ## Finders
@@ -127,5 +142,14 @@ If you find a problem, please [submit an issue](http://github.com/thetron/mongoi
 you can). Pull requests and feature requests are always welcome and
 greatly appreciated.
 
-Thanks to everyone that has contributed to this gem over the past year,
-in particular [eagleas](https://github.com/eagleas) and [jamesotron](https://github.com/jamesotron). Many, many thanks guys.
+Thanks to everyone that has contributed to this gem over the past year.
+Many, many thanks - you guys rawk.
+
+## Contributors:
+
+* [olliem](https://github.com/olliem)
+* [msolli](https://github.com/msolli)
+* [siong1987](https://github.com/siong1987)
+* [stephan778](https://github.com/stephan778) 
+* [eagleas](https://github.com/eagleas) 
+* [jamesotron](https://github.com/jamesotron).

data/benchmarks/benchmark.rb

@@ -2,25 +2,24 @@ $: << File.expand_path("../../lib", __FILE__)
 
 require 'database_cleaner'
 require 'mongoid'
-require 'mongoid-rspec'
 require 'mongoid_token'
 require 'benchmark'
 
 Mongoid.configure do |config|
-  config.master = Mongo::Connection.new.db("mongoid_token_benchmark")
+  config.connect_to("mongoid_token_benchmark")
 end
 
 DatabaseCleaner.strategy = :truncation
 
 # start benchmarks
 
-token_length = 2
+TOKEN_LENGTH = 8
 
 class Link
   include Mongoid::Document
   include Mongoid::Token
   field :url
-  token :length => 2, :contains => :alphanumeric
+  token :length => TOKEN_LENGTH, :contains => :alphanumeric
 end
 
 class NoTokenLink
@@ -39,7 +38,7 @@ end
 Link.destroy_all
 Link.create_indexes
 num_records = [1, 50, 100, 1000, 2000, 3000, 4000]
-puts "-- Alphanumeric token of length #{token_length} (#{62**token_length} possible tokens)"
+puts "-- Alphanumeric token of length #{TOKEN_LENGTH} (#{62**TOKEN_LENGTH} possible tokens)"
 Benchmark.bm do |b|
   num_records.each do |qty|
     b.report("#{qty.to_s.rjust(5, " ")} records    "){ qty.times{ create_link(false) } }

data/lib/mongoid_token.rb

@@ -50,16 +50,22 @@ module Mongoid
     end
 
     def to_param
-      self.send(@token_field_name.to_sym)
+      self.send(@token_field_name.to_sym) || super
     end
 
     protected
 
     def resolve_token_collisions
       retries = @max_collision_retries
+
       begin
         yield
       rescue Moped::Errors::OperationFailure => e
+        # This is horrible, but seems to be the only way to get the details of the exception?
+        continue unless [11000, 11001].include?(e.details['code'])
+        continue unless   e.details['err'] =~ /dup key/ &&
+                          e.details['err'] =~ /"#{self.send(@token_field_name.to_sym)}"/
+
         if (retries -= 1) > 0
           self.create_token(@token_length, @token_contains)
           retry
@@ -83,7 +89,9 @@ module Mongoid
     end
 
     def create_token_if_nil(length, characters)
-      self.create_token(length, characters) if self[@token_field_name.to_sym].nil?
+      if self[@token_field_name.to_sym].blank?
+        self.create_token(length, characters) 
+      end
     end
 
     def generate_token(length, characters = :alphanumeric)
@@ -94,8 +102,14 @@ module Mongoid
         rand(10**length).to_s
       when :fixed_numeric
         rand(10**length).to_s.rjust(length,rand(10).to_s)
+      when :fixed_numeric_no_leading_zeros
+        (rand(10**length - 10**(length-1)) + 10**(length-1)).to_s
       when :alpha
         Array.new(length).map{['A'..'Z','a'..'z'].map{|r|r.to_a}.flatten[rand(52)]}.join
+      when :alpha_lower
+        Array.new(length).map{['a'..'z'].map{|r|r.to_a}.flatten[rand(26)]}.join
+      when :alpha_upper
+        Array.new(length).map{['A'..'Z'].map{|r|r.to_a}.flatten[rand(26)]}.join
       end
     end
   end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module MongoidToken
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

data/spec/mongoid.yml

@@ -6,3 +6,4 @@ test:
         - localhost:27017
       options:
         consistency: :strong
+        safe: false

data/spec/mongoid/token_spec.rb

@@ -20,6 +20,8 @@ class Link
 
   field :url
   token :length => 3, :contains => :alphanumeric
+
+  validates :url, :presence => true
 end
 
 class FailLink
@@ -37,6 +39,22 @@ class Video
   token :length => 8, :contains => :alpha, :field_name => :vid
 end
 
+class Image
+  include Mongoid::Document
+  include Mongoid::Token
+
+  field :url
+  token :length => 8, :contains => :fixed_numeric_no_leading_zeros
+end
+
+class Event
+  include Mongoid::Document
+  include Mongoid::Token
+
+  field :name
+  token :length => 8, :contains => :alpha_lower
+end
+
 class Node
   include Mongoid::Document
   include Mongoid::Token
@@ -60,11 +78,15 @@ describe Mongoid::Token do
     @account = Account.create(:name => "Involved Pty. Ltd.")
     @link = Link.create(:url => "http://involved.com.au")
     @video = Video.create(:name => "Nyan nyan")
+    @image = Image.create(:url => "http://involved.com.au/image.png")
+    @event = Event.create(:name => "Super cool party!")
 
     Account.create_indexes
     Link.create_indexes
     FailLink.create_indexes
     Video.create_indexes
+    Image.create_indexes
+    Event.create_indexes
     Node.create_indexes
   end
 
@@ -78,6 +100,7 @@ describe Mongoid::Token do
     @account.token.length.should == 16
     @link.token.length.should == 3
     @video.vid.length.should == 8
+    @image.token.length.should == 8
   end
 
   it "should only generate unique tokens" do
@@ -106,6 +129,11 @@ describe Mongoid::Token do
       @video = Video.create(:name => "A test video")
       @video.vid.gsub(/[A-Za-z]/, "").length.should == 0
     end
+    
+    50.times do |index|
+      @event = Event.create(:name => "Super cool party!2")
+      @event.token.gsub(/[a-z]/, "").length.should == 0
+    end
   end
 
   it "should create the only after the first save" do
@@ -145,7 +173,7 @@ describe Mongoid::Token do
     @account.token.should_not be_nil
   end
 
-  it "should fail with an exception after 3 retries (by default)" do
+  it "should fail with an exception after 3 retries" do
     Link.destroy_all
     Link.create_indexes
 
@@ -153,7 +181,6 @@ describe Mongoid::Token do
     Link.any_instance.stub(:generate_token).and_return(@first_link.token)
     @link = Link.new(:url => "http://fail.com")
 
-    #lambda{ @link.save! }.should raise_error(Mongoid::Token::CollisionRetriesExceeded)
     expect { @link.save! }.to raise_error(Mongoid::Token::CollisionRetriesExceeded)
 
     Link.count.should == 1
@@ -165,8 +192,13 @@ describe Mongoid::Token do
 
     Link.any_instance.stub(:generate_token).and_return(link.token)
 
-    expect { Link.create!(url: "http://example.com/2") }
-    .to raise_error(Mongoid::Token::CollisionRetriesExceeded)
+    expect { Link.create!(url: "http://example.com/2") }.to raise_error(Mongoid::Token::CollisionRetriesExceeded)
+  end
+
+  it "should not raise a custom error if an operation failure is thrown for another reason" do
+    link = Link.new
+    lambda{ link.save! }.should_not raise_error(Mongoid::Token::CollisionRetriesExceeded)
+    link.valid?.should == false
   end
 
   it "should not raise a custom exception if retries are set to zero" do
@@ -177,7 +209,7 @@ describe Mongoid::Token do
     Link.any_instance.stub(:generate_token).and_return(@first_link.token)
     @link = FailLink.new(:url => "http://fail.com")
 
-    lambda{ @link.save }.should_not raise_error(Mongoid::Token::CollisionRetriesExceeded)
+    lambda{ @link.save! }.should_not raise_error(Mongoid::Token::CollisionRetriesExceeded)
   end
 
   it "should create unique indexes on embedded documents" do
@@ -191,4 +223,13 @@ describe Mongoid::Token do
       node.token.match(/[0-9]{8}/).should_not == nil
     end
   end
+
+  describe "with :fixed_numeric_not_null" do
+    it "should not start with 0" do
+      1000.times do
+        image = Image.create(:url => "http://something.com/image.png")
+        image.token.should_not start_with "0"
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_token
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-07 00:00:00.000000000 Z
+date: 2013-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &70226827473880 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,12 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70226827473880
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Mongoid token is a gem for creating random, unique tokens for mongoid
   documents. Highly configurable and great for making URLs a little more compact.
 email:
@@ -65,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: mongoid_token
-rubygems_version: 1.8.15
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A little random, unique token generator for Mongoid documents.