mongoid_token_r 4.0.0

data/spec/mongoid/token/options_spec.rb

@@ -0,0 +1,102 @@
+require File.join(File.dirname(__FILE__), %w[.. .. spec_helper])
+
+describe Mongoid::Token::Options do
+  before do
+    @options = Mongoid::Token::Options.new(
+      {
+        :length => 9999,
+        :retry_count => 8888,
+        :contains => :nonsense,
+        :field_name => :not_a_token
+      }
+    )
+  end
+
+  it "should have a length" do
+    @options.length.should == 9999
+  end
+
+  it "should default to a length of 4" do
+    Mongoid::Token::Options.new.length.should == 4
+  end
+
+  it "should have a retry count" do
+    @options.retry_count.should == 8888
+  end
+
+  it "should default to a retry count of 3" do
+    Mongoid::Token::Options.new.retry_count.should == 3
+  end
+
+  it "should have a list of characters to contain" do
+    @options.contains.should == :nonsense
+  end
+
+  it "should default to an alphanumeric set of characters to contain" do
+    Mongoid::Token::Options.new.contains.should == :alphanumeric
+  end
+
+  it "should have a field name" do
+    @options.field_name.should == :not_a_token
+  end
+
+  it "should default to a field name of 'token'" do
+    Mongoid::Token::Options.new.field_name.should == :token
+  end
+
+  it "should create a pattern" do
+    Mongoid::Token::Options.new.pattern.should == "%s4"
+  end
+
+  describe "override_to_param" do
+    it "should be an option" do
+      expect(Mongoid::Token::Options.new({:override_to_param => false}).override_to_param?).to eq false
+    end
+
+    it "should default to true" do
+      expect(Mongoid::Token::Options.new.override_to_param?).to eq true
+    end
+  end
+
+   describe "skip_finder" do
+    it "should be an option" do
+      expect(Mongoid::Token::Options.new({:skip_finders => true}).skip_finders?).to eq true
+    end
+
+    it "should default to false" 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

@@ -0,0 +1,287 @@
+require File.join(File.dirname(__FILE__), %w[.. spec_helper])
+
+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
+    class Document
+      include Mongoid::Document
+      include Mongoid::Token
+    end
+    Class.new(Document)
+  end
+
+  let(:document) do
+    document_class.create
+  end
+
+  describe "#token" do
+    describe "field" do
+      before(:each) { document_class.send(:token) }
+      it "should be created" do
+        expect(document).to have_field(:token)
+      end
+
+      it "should be indexed" do
+        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
+
+    describe "options" do
+      it "should accept custom field names" do
+        document_class.send(:token, :field_name => :smells_as_sweet)
+        expect(document).to have_field(:smells_as_sweet)
+      end
+
+      it "should accept custom lengths" do
+        document_class.send(:token, :length => 13)
+        expect(document.token.length).to eq 13
+      end
+
+      it "should disable custom finders" do
+        class UntaintedDocument
+          include Mongoid::Document
+          include Mongoid::Token
+        end
+        dc = Class.new(UntaintedDocument)
+
+        dc.send(:token, :skip_finders => true)
+        expect(dc.public_methods).to_not include(:find_with_token)
+      end
+
+      it "should disable `to_param` overrides" do
+        document_class.send(:token, :override_to_param => false)
+        expect(document.to_param).to_not eq document.token
+      end
+
+      it "should return id when token does not exist when calling `to_param`" do
+        document_class.send(:token, :override_to_param => true)
+        document.unset :token
+        expect(document.to_param).to eq document.id.to_s
+      end
+
+      describe "contains" do
+        context "with :alphanumeric" do
+          it "should contain only letters and numbers" do
+            document_class.send(:token, :contains => :alphanumeric, :length => 64)
+            expect(document.token).to match(/[A-Za-z0-9]{64}/)
+          end
+        end
+        context "with :alpha" do
+          it "should contain only letters" do
+            document_class.send(:token, :contains => :alpha, :length => 64)
+            expect(document.token).to match(/[A-Za-z]{64}/)
+          end
+        end
+        context "with :alpha_upper" do
+          it "should contain only uppercase letters" do
+            document_class.send(:token, :contains => :alpha_upper, :length => 64)
+            expect(document.token).to match(/[A-Z]{64}/)
+          end
+        end
+        context "with :alpha_lower" do
+          it "should contain only lowercase letters" do
+            document_class.send(:token, :contains => :alpha_lower, :length => 64)
+            expect(document.token).to match(/[a-z]{64}/)
+          end
+        end
+        context "with :numeric" do
+          it "should only contain numbers" do
+            document_class.send(:token, :contains => :numeric, :length => 64)
+            expect(document.token).to match(/[0-9]{1,64}/)
+          end
+        end
+        context "with :fixed_numeric" do
+          it "should contain only numbers and be a fixed-length" do
+            document_class.send(:token, :contains => :fixed_numeric, :length => 64)
+            expect(document.token).to match(/[0-9]{64}/)
+          end
+        end
+        context "with :fixed_numeric_no_leading_zeros" do
+          it "should contain only numbers, be a fixed length, and have no leading zeros" do
+            document_class.send(:token, :contains => :fixed_numeric_no_leading_zeros, :length => 64)
+            expect(document.token).to match(/[1-9]{1}[0-9]{63}/)
+          end
+        end
+      end
+
+      describe "pattern" do
+        it "should conform" do
+          document_class.send(:token, :pattern => "%d%d%d%d%C%C%C%C")
+          expect(document.token).to match(/[0-9]{4}[A-Z]{4}/)
+        end
+        context "when there's a static prefix" do
+          it "should start with the prefix" do
+            document_class.send(:token, :pattern => "PREFIX-%d%d%d%d")
+            expect(document.token).to match(/PREFIX\-[0-9]{4}/)
+          end
+        end
+        context "when there's an infix" do
+          it "should contain the infix" do
+            document_class.send(:token, :pattern => "%d%d%d%d-INFIX-%d%d%d%d")
+            expect(document.token).to match(/[0-9]{4}\-INFIX\-[0-9]{4}/)
+          end
+        end
+        context "when there's a suffix" do
+          it "should end with the suffix" do
+            document_class.send(:token, :pattern => "%d%d%d%d-SUFFIX")
+            expect(document.token).to match(/[0-9]{4}\-SUFFIX/)
+          end
+        end
+      end
+    end
+
+    it "should allow for multiple tokens of different names" do
+      document_class.send(:token, :contains => :alpha_upper)
+      document_class.send(:token, :field_name => :sharing_id, :contains => :alpha_lower)
+      expect(document.token).to match(/[A-Z]{4}/)
+      expect(document.sharing_id).to match(/[a-z]{4}/)
+    end
+  end
+
+  describe "callbacks" do
+    context "when the document is a new record" do
+      let(:document){ document_class.new }
+      it "should create the token after being saved" do
+        document_class.send(:token)
+        expect(document.token).to be_nil
+        document.save
+        expect(document.token).to_not be_nil
+      end
+    end
+    context "when the document is not a new record" do
+      it "should not change the token after being saved" do
+        document_class.send(:token)
+        token_before = document.token
+        document.save
+        expect(document.token).to eq token_before
+      end
+      context "and the token is nil" do
+        it "should create a new token after being saved" do
+          document_class.send(:token)
+          token_before = document.token
+          document.token = nil
+          document.save
+          expect(document.token).to_not be_nil
+          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
+        document.class.send(:token, :length => 64, :contains => :alpha_upper)
+        d2 = document.clone
+        expect(d2.token).to be_nil
+      end
+
+      it "should generate a new token with the same options as the source document" do
+        document.class.send(:token, :length => 64, :contains => :alpha_upper)
+        d2 = document.clone
+        d2.save
+        expect(d2.token).to_not eq document.token
+        expect(d2.token).to match(/[A-Z]{64}/)
+      end
+    end
+  end
+
+  describe "finders" do
+    it "should create a custom find method" do
+      document_class.send(:token, :field_name => :other_token)
+      expect(document.class.public_methods).to include(:find_by_other_token)
+    end
+  end
+
+  describe ".to_param" do
+    it "should return the token" do
+      document_class.send(:token)
+      expect(document.to_param).to eq document.token
+    end
+  end
+
+  describe "collision resolution" do
+    before(:each) do
+      document_class.send(:token)
+      document_class.create_indexes
+    end
+
+    context "when creating a new record" do
+      it "should raise an exception when collisions can't be resolved on save" do
+        document.token = "1234"
+        document.save
+        d2 = document.clone
+        d2.stub(:generate_token).and_return("1234")
+        expect{d2.save}.to raise_exception(Mongoid::Token::CollisionRetriesExceeded)
+      end
+
+      it "should raise an exception when collisions can't be resolved on create!" do
+        document.token = "1234"
+        document.save
+        document_class.any_instance.stub(:generate_token).and_return("1234")
+        expect{document_class.create!}.to raise_exception(Mongoid::Token::CollisionRetriesExceeded)
+      end
+    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")
+      document_class.stub(:model_name).and_return(ActiveModel::Name.new(document_class, nil, "temp"))
+      expect{document_class.create!}.to raise_exception(Mongoid::Errors::Validations)
+    end
+
+    context "with other unique indexes present" do
+      before(:each) do
+        document_class.send(:field, :name)
+        document_class.send(:index, {:name => 1}, {:unique => true})
+        document_class.create_indexes
+      end
+
+      context "when violating the other index" do
+        it "should raise an operation failure" do
+          duplicate_name = "Got Duped."
+          document_class.create!(:name => duplicate_name)
+          expect{ document_class.create!(:name => duplicate_name) }.to raise_exception(Mongo::Error::OperationFailure)
+        end
+      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

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+$: << File.expand_path("../../lib", __FILE__)
+
+require 'database_cleaner'
+require 'mongoid'
+require 'mongoid-rspec'
+require 'mongoid_token'
+
+ENV['MONGOID_ENV'] = "test"
+
+RSpec.configure do |config|
+  Mongo::Logger.logger.level = Logger::ERROR
+
+  config.include Mongoid::Matchers
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+    Mongoid.purge!
+  end
+end
+
+Mongoid.configure do |config|
+  config.connect_to("mongoid_token_test", {})
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_token_r
+version: !ruby/object:Gem::Version
+  version: 4.0.0
+platform: ruby
+authors:
+- Nicholas Bruning
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.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:
+- nicholas@bruning.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".autotest"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmarks/benchmark.rb
+- lib/mongoid/token.rb
+- lib/mongoid/token/collision_resolver.rb
+- lib/mongoid/token/collisions.rb
+- lib/mongoid/token/exceptions.rb
+- lib/mongoid/token/finders.rb
+- lib/mongoid/token/generator.rb
+- lib/mongoid/token/options.rb
+- lib/mongoid_token.rb
+- lib/version.rb
+- mongoid_token.gemspec
+- spec/mongoid/token/collisions_spec.rb
+- spec/mongoid/token/exceptions_spec.rb
+- spec/mongoid/token/finders_spec.rb
+- spec/mongoid/token/generator_spec.rb
+- spec/mongoid/token/options_spec.rb
+- spec/mongoid/token_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/thetron/mongoid_token
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: mongoid_token
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A little random, unique token generator for Mongoid documents.
+test_files:
+- spec/mongoid/token/collisions_spec.rb
+- spec/mongoid/token/exceptions_spec.rb
+- spec/mongoid/token/finders_spec.rb
+- spec/mongoid/token/generator_spec.rb
+- spec/mongoid/token/options_spec.rb
+- spec/mongoid/token_spec.rb
+- spec/spec_helper.rb