mongoid_token 2.0.2 → 2.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
 !binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NzAzMmIyYTMyMzIwMTkxZDk2NTI4OTU1NWQ5MDYwMDgzNmYwYTBiOQ==
-  data.tar.gz: !binary |-
-    MjZiZDAzN2MyM2UxMjQ1Zjg5MWJhMWRhZDBiN2ZmMDczMDUzMDJjYg==
+  metadata.gz: 13ce75b253568cef707efd8bfefc9a36c528426b
+  data.tar.gz: eb17e324405d6a4a6845df7338f16f4e348d3242
 SHA512:
-  metadata.gz: !binary |-
-    NDQ3YjNiYjFmMWIyYWFlYjRiODdjYmRhNzRhOTIyNjEyOTVjM2Y5ZDk2ZTg5
-    MWEzYTEyYjA5MTFmMGE4NGM4ZDFlNWMwODcwMzNkNzliZDRkYTE3NzJjYmIy
-    OGMyOTkxOTE3M2JkNDNiNGZiZTFjN2VkZGY2MGQ1ZGI5MWQxNWQ=
-  data.tar.gz: !binary |-
-    NGYzN2NlZjlhZWIzYmNjZWEyNDJhZjcxMGIzMDgyYWVlZDhmMDhiMWVhYzMw
-    ZDE3NDIwZGMwY2Q0MzU2Y2NhM2IxZWMwZjBmYzBlMTMyMzU0NGUyNjM3YTFl
-    YTdmZjVlZTU0NmQwNzYwYjc5MWMxMjFkMjExNzk5MmVhNjVjNjg=
+  metadata.gz: a81e923d8f4c7c5f0472df99d90a45a3bf37fedf6a87c897ba989ddad7de6c194f84d79a2db3431506fd974d7023023151ad685bccbc8740ac17b57343b69d2b
+  data.tar.gz: ab820d32511412cda5f7730587a29697d147e720c3ad51ec106b089eeb0d70a4be112fd8dcfdaa2098c6a1af38b512e7ec0fe320a3b36833e1c83e30964fcc0f

data/.rspec

@@ -1,2 +1 @@
 --color
---format documentation

data/.travis.yml

@@ -1,12 +1,18 @@
-script: "bundle exec rspec spec"
 language: ruby
+
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0
+  - 2.1.1
+
 gemfile:
   - Gemfile
-notifications:
-  recipients:
-    - nicholas@bruning.com.au
+
 services:
   - mongodb
+
+env:
+  - CODECLIMATE_REPO_TOKEN=b216164ab66da464aa02fe5b862811ba0526c8dc7ea291ebe53056be4b6b5e1f
+
+script: "bundle exec rspec"

data/Gemfile

@@ -3,6 +3,8 @@ source "http://rubygems.org"
 gemspec
 
 group :test do
+  gem 'rspec', '2.14.1'
+  gem "codeclimate-test-reporter", require: nil
   gem 'database_cleaner'
   gem 'mongoid-rspec', '1.5.1'
 end

data/README.md

@@ -1,6 +1,7 @@
 # Mongoid::Token - Short snappy tokens for Mongoid documents
 
 [![Build Status](https://secure.travis-ci.org/thetron/mongoid_token.png)](http://travis-ci.org/thetron/mongoid_token)
+[![Code Climate](https://codeclimate.com/github/thetron/mongoid_token.png)](https://codeclimate.com/github/thetron/mongoid_token)
 
 This library is a quick and simple way to generate unique, random tokens
 for your mongoid documents, in the cases where you can't, or don't want
@@ -28,7 +29,7 @@ Then update your bundle
 In your Mongoid documents, just add `include Mongoid::Token` and the
 `token` method will take care of all the setup, like so:
 
-````
+```ruby
 class Person
   include Mongoid::Document
   include Mongoid::Token
@@ -38,7 +39,7 @@ class Person
   token
 end
 
-````
+```
 
 And that's it! There's lots of configuration options too - which are all
 listed [below](#configuration). By default, the `token` method will
@@ -57,10 +58,10 @@ 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).
 
-````
+```ruby
 Video.find("x3v98")
 Account.find("ACC-123456")
-````
+```
 
 
 ## Configuration
@@ -68,7 +69,7 @@ Account.find("ACC-123456")
 ### Tokens
 
 As of `Mongoid::Token` 2.0.0, you can now choose between two different
-systems for managing how your tokens look. 
+systems for managing how your tokens look.
 
 For simple setup, you can use
 combination of the [`length`](#length-length) and [`contains`](#contains-contains), which modify the length and
@@ -81,18 +82,18 @@ prefixes, infixes or suffixes.
 
 #### Length (`:length`)
 
-This one is easy, it's just an integer. 
+This one is easy, it's just an integer.
 
 __Example:__
 
-````
+```ruby
 token :length => 6 # Tokens are now of length 6
 token :length => 12 # Whow, whow, whow. Slow down egghead.
-````
+```
 
 You get the idea.
 
-The only caveat here is that if used in combination with the 
+The only caveat here is that if used in combination with the
 `:contains => :numeric` option, tokens may vary in length _up to_ the
 specified length.
 
@@ -111,14 +112,14 @@ as numbers
 never start with zeros
 
 __Examples:__
-````
+```ruby
 token :contains => :alpha_upper, :length => 8
 token :contains => :fixed_numeric
-````
+```
 
 #### Patterns (`:pattern`)
 
-New in 2.0.0, patterns allow you find-grained control over how your
+New in 2.0.0, patterns allow you fine-grained control over how your
 tokens look. It's great for generating random data that has a
 requirements to also have some basic structure. If you use the
 `:pattern` option, it will override both the `:length` and `:contains`
@@ -141,18 +142,18 @@ generated character, and are as follows:
 
 __Example:__
 
-````
+```ruby
 token :pattern => "PRE-%C%C-%d%d%d%d" # Generates something like: 'PRE-ND-3485'
-````
+```
 
 You can also add a repetition modifier, which can help improve readability on
 more complex patterns. You simply add any integer after the letter.
 
 __Examples:__
 
-````
-token :sku => "APP-%d6" # Generates something like; "APP-638924"
-````
+```ruby
+token :pattern => "APP-%d6" # Generates something like; "APP-638924"
+```
 
 ### Field Name (`:field_name`)
 
@@ -161,11 +162,11 @@ This allows you to change the field name used by `Mongoid::Token`
 use multiple tokens one a single document.
 
 __Examples:__
-````
+```ruby
 token :length => 6
 token :field_name => :sharing_token, :length => 12
 token :field_name => :yet_another
-````
+```
 
 
 ### Skip Finders (`:skip_finders`)
@@ -174,9 +175,9 @@ This will prevent the gem from creating the customised finders and
 overrides for the default `find` behaviour used by Mongoid.
 
 __Example:__
-````
+```ruby
 token :skip_finders => true
-````
+```
 
 
 ### Override to_param (`:override_to_param`)
@@ -186,9 +187,9 @@ drop-in replacement for the default ObjectIDs. If needed, you can turn
 this behaviour off:
 
 __Example:__
-````
+```ruby
 token :override_to_param => false
-````
+```
 
 
 ### Retry Count (`:retry_count`)
@@ -199,10 +200,10 @@ error. If you're wanting it to try harder, or less hard, then this
 option is for you.
 
 __Examples:__
-````
+```ruby
 token :retry_count => 9
 token :retry_count => 0
-````
+```
 
 # Notes
 

data/lib/mongoid/token.rb

@@ -10,37 +10,51 @@ module Mongoid
 
     module ClassMethods
       def initialize_copy(source)
-        super
+        super(source)
         self.token = nil
       end
 
       def token(*args)
         options = Mongoid::Token::Options.new(args.extract_options!)
 
+        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.index({ options.field_name => 1 }, { :unique => true })
+        self.index({ options.field_name => 1 }, { :unique => true, :sparse => true })
+      end
 
+      def add_token_collision_resolver(options)
         resolver = Mongoid::Token::CollisionResolver.new(self, options.field_name, options.retry_count)
         resolver.create_new_token = Proc.new do |document|
           document.send(:create_token, options.field_name, options.pattern)
         end
+      end
 
-        if options.skip_finders? == false
-          Finders.define_custom_token_finder_for(self, options.field_name)
-        end
+      def define_custom_finders(options)
+        Finders.define_custom_token_finder_for(self, options.field_name)
+      end
 
+      def set_token_callbacks(options)
         set_callback(:create, :before) do |document|
-          document.create_token options.field_name, options.pattern
+          document.create_token_if_nil options.field_name, options.pattern
         end
 
         set_callback(:save, :before) do |document|
           document.create_token_if_nil options.field_name, options.pattern
         end
+      end
 
-        if options.override_to_param?
-          self.send(:define_method, :to_param) do
-            self.send(options.field_name) || super
-          end
+      def override_to_param(options)
+        self.send(:define_method, :to_param) do
+          self.send(options.field_name) || super(*args)
         end
       end
     end

data/lib/mongoid/token/finders.rb

@@ -7,7 +7,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
-          args.all?{|arg| Moped::BSON::ObjectId.legal?(arg)} ? send(:"find_without_#{field_name}",*args) : klass.send(:"find_by_#{field_name.to_s}", args.first)
+          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

data/lib/mongoid/token/generator.rb

@@ -40,12 +40,16 @@ module Mongoid
       end
 
       private
+      def self.rand_string_from_chars(chars, length = 1)
+        Array.new(length).map{ chars.sample }.join
+      end
+
       def self.down_character(length = 1)
-        Array.new(length).map{['a'..'z'].map{|r|r.to_a}.flatten[rand(26)]}.join
+        self.rand_string_from_chars ('a'..'z').to_a, length
       end
 
       def self.up_character(length = 1)
-        Array.new(length).map{['A'..'Z'].map{|r|r.to_a}.flatten[rand(26)]}.join
+        self.rand_string_from_chars ('A'..'Z').to_a, length
       end
 
       def self.integer(length = 1)
@@ -57,7 +61,7 @@ module Mongoid
       end
 
       def self.alpha(length = 1)
-        Array.new(length).map{['A'..'Z','a'..'z'].map{|r|r.to_a}.flatten[rand(52)]}.join
+        self.rand_string_from_chars (('A'..'Z').to_a + ('a'..'z').to_a), length
       end
 
       def self.alphanumeric(length = 1)
@@ -65,7 +69,7 @@ module Mongoid
       end
 
       def self.punctuation(length = 1)
-        Array.new(length).map{['.','-','_','=','+','$'].map{|r|r.to_a}.flatten[rand(52)]}.join
+        self.rand_string_from_chars ['.','-','_','=','+','$'], length
       end
     end
   end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module MongoidToken
-  VERSION = "2.0.2"
+  VERSION = "2.1.0"
 end

data/mongoid_token.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.description = %q{Mongoid token is a gem for creating random, unique tokens for mongoid documents. Highly configurable and great for making URLs a little more compact.}
 
   s.rubyforge_project = "mongoid_token"
-  s.add_dependency 'mongoid', '~> 3.0'
+  s.add_dependency 'mongoid', '~> 4.0.0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/mongoid/token/collisions_spec.rb

@@ -1,7 +1,5 @@
 require File.join(File.dirname(__FILE__), %w[.. .. spec_helper])
 
-require 'pp'
-
 describe Mongoid::Token::Collisions do
   let(:document) { Object.new }
   describe "#resolve_token_collisions" do

data/spec/mongoid/token/finders_spec.rb

@@ -12,16 +12,16 @@ describe Mongoid::Token::Finders do
   end
 
   it "override the `find` method of the document" do
-    klass = Class.new 
+    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(Moped::BSON::ObjectId.new).should == :original_find
-    klass.find(Moped::BSON::ObjectId.new, Moped::BSON::ObjectId.new).should == :original_find
+    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(Moped::BSON::ObjectId.new, "token").should == :token_find
+    klass.find(BSON::ObjectId.new, "token").should == :token_find
     klass.find("token").should == :token_find
   end
 
@@ -33,9 +33,9 @@ describe Mongoid::Token::Finders do
   end
 
   it "retrieve a document using the `find` method" do
-    class Document; include Mongoid::Document; field :token; end
-    document = Document.create! :token => "1234"
-    Mongoid::Token::Finders.define_custom_token_finder_for(Document)
-    Document.find("1234").should == document
+    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
 end

data/spec/mongoid/token_spec.rb

@@ -2,6 +2,11 @@ require File.join(File.dirname(__FILE__), %w[.. spec_helper])
 
 describe Mongoid::Token do
   let(:document_class) do
+    Object.send(:remove_const, :Document)
+    class Document
+      include Mongoid::Document
+      include Mongoid::Token
+    end
     Class.new(Document)
   end
 
@@ -17,7 +22,10 @@ describe Mongoid::Token do
       end
 
       it "should be indexed" do
-        expect(document).to have_index_for(:token => 1).with_options(:unique => true)
+        index = document.index_specifications.first
+        expect(index.fields).to eq([:token])
+        expect(index.options).to have_key(:unique)
+        expect(index.options).to have_key(:sparse)
       end
     end
 
@@ -154,6 +162,13 @@ describe Mongoid::Token do
           expect(document.token).to_not eq token_before
         end
       end
+      context "when the document is initialized with a token" do
+        it "should not change the token after being saved" do
+          document_class.send(:token)
+          token = 'test token'
+          expect(document_class.create!(token: token).token).to eq token
+        end
+      end
     end
     context "when the document is cloned" do
       it "should set the token to nil" do
@@ -210,6 +225,7 @@ describe Mongoid::Token do
     end
 
     it "should not raise a custom error if another error is thrown during saving" do
+      I18n.enforce_available_locales = false # Supress warnings in this example
       document_class.send(:field, :name)
       document_class.send(:validates_presence_of, :name)
       document_class.any_instance.stub(:generate_token).and_return("1234")

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 $: << File.expand_path("../../lib", __FILE__)
 
 require 'database_cleaner'
@@ -7,11 +10,6 @@ require 'mongoid_token'
 
 ENV['MONGOID_ENV'] = "test"
 
-class Document
-  include Mongoid::Document
-  include Mongoid::Token
-end
-
 RSpec.configure do |config|
   config.include Mongoid::Matchers
   config.before(:suite) do
@@ -24,4 +22,12 @@ RSpec.configure do |config|
   end
 end
 
-Mongoid.load!( File.join(File.dirname(__FILE__), 'mongoid.yml') )
+Mongoid.configure do |config|
+  config.sessions = {
+    default: {
+      database: "mongoid_token_test",
+      hosts: [ "localhost:#{ENV['BOXEN_MONGODB_PORT'] || 27017}" ],
+      options: {}
+    }
+  }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_token
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Nicholas Bruning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-10 00:00:00.000000000 Z
+date: 2014-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 4.0.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:
@@ -50,7 +50,6 @@ files:
 - lib/mongoid_token.rb
 - lib/version.rb
 - mongoid_token.gemspec
-- spec/mongoid.yml
 - spec/mongoid/token/collisions_spec.rb
 - spec/mongoid/token/exceptions_spec.rb
 - spec/mongoid/token/finders_spec.rb
@@ -77,12 +76,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: mongoid_token
-rubygems_version: 2.1.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A little random, unique token generator for Mongoid documents.
 test_files:
-- spec/mongoid.yml
 - spec/mongoid/token/collisions_spec.rb
 - spec/mongoid/token/exceptions_spec.rb
 - spec/mongoid/token/finders_spec.rb

data/spec/mongoid.yml

@@ -1,9 +0,0 @@
-test:
-  sessions:
-    default:
-      database: mongoid_token_test
-      hosts:
-        - localhost:<%= ENV['BOXEN_MONGODB_PORT'] || 27017 %>
-      options:
-        consistency: :strong
-        safe: false