zxcvbn-ruby 0.1.0 → 1.2.0

data/spec/matchers/date_spec.rb

@@ -15,16 +15,16 @@ describe Zxcvbn::Matchers::Date do
       let(:matches) { matcher.matches(password) }
 
       it 'finds matches' do
-        matches.should_not be_empty
+        expect(matches).not_to be_empty
       end
 
       it 'finds the correct matches' do
-        matches.count.should eq 1
-        matches[0].token.should eq %w[ 02 12 1997 ].join(separator)
-        matches[0].separator.should eq separator
-        matches[0].day.should eq 2
-        matches[0].month.should eq 12
-        matches[0].year.should eq 1997
+        expect(matches.count).to eq 1
+        expect(matches[0].token).to eq %w[ 02 12 1997 ].join(separator)
+        expect(matches[0].separator).to eq separator
+        expect(matches[0].day).to eq 2
+        expect(matches[0].month).to eq 12
+        expect(matches[0].year).to eq 1997
       end
     end
   end
@@ -103,7 +103,7 @@ describe Zxcvbn::Matchers::Date do
     let(:matches) { matcher.matches('testing0.x.1997') }
 
     it 'doesnt match' do
-      matches.should be_empty
+      expect(matches).to be_empty
     end
   end
 end

data/spec/matchers/dictionary_spec.rb

@@ -1,19 +1,30 @@
-require 'spec_helper'
+# frozen_string_literal: true
+
+require "spec_helper"
 
 describe Zxcvbn::Matchers::Dictionary do
-  let(:matcher) { described_class.new('english', dictionary) }
-  let(:dictionary) { Zxcvbn::Data.new.ranked_dictionaries['english'] }
+  subject(:matcher) { described_class.new("Test dictionary", dictionary) }
 
-  it 'finds all the matches' do
-    matches = matcher.matches('whatisinit')
-    matches.count.should == 14
-    expected_matches = ['wha', 'what', 'ha', 'hat', 'a', 'at', 'tis', 'i', 'is',
-                       'sin', 'i', 'in', 'i', 'it']
-    matches.map(&:matched_word).should == expected_matches
-  end
+  describe "#matches" do
+    let(:matches) { matcher.matches(password) }
+    let(:matched_words) { matches.map(&:matched_word) }
+
+    context "Given a dictionary of English words" do
+      let(:dictionary) { Zxcvbn::Data.new.ranked_dictionaries["english"] }
+      let(:password) { "whatisinit" }
+
+      it "finds all the matches" do
+        expect(matched_words).to match_array %w[wha what ha hat a at tis i is sin i in i it]
+      end
+    end
+
+    context "Given a custom dictionary" do
+      let(:dictionary) { Zxcvbn::DictionaryRanker.rank_dictionary(%w[test AB10CD]) }
+      let(:password) { "AB10CD" }
 
-  it 'matches uppercase' do
-    matcher = described_class.new('user_inputs', Zxcvbn::DictionaryRanker.rank_dictionary(['test','AB10CD']))
-    matcher.matches('AB10CD').should_not be_empty
+      it "matches uppercase passwords with normalised dictionary entries" do
+        expect(matched_words).to match_array(%w[ab10cd])
+      end
+    end
   end
-end
+end

data/spec/matchers/digits_spec.rb

@@ -5,11 +5,11 @@ describe Zxcvbn::Matchers::Digits do
   let(:matches) { matcher.matches('testing1239xx9712') }
 
   it 'sets the pattern name' do
-    matches.all? { |m| m.pattern == 'digits' }.should eql(true)
+    expect(matches.all? { |m| m.pattern == 'digits' }).to eql(true)
   end
 
   it 'finds the correct matches' do
-    matches.count.should == 2
-    matches[0].token.should eq '1239'
+    expect(matches.count).to eq(2)
+    expect(matches[0].token).to eq '1239'
   end
 end

data/spec/matchers/l33t_spec.rb

@@ -7,7 +7,7 @@ describe Zxcvbn::Matchers::L33t do
 
   describe '#relevant_l33t_substitutions' do
     it 'returns relevant l33t substitutions' do
-      matcher.relevent_l33t_subtable('p@ssw1rd24').should eq(
+      expect(matcher.relevent_l33t_subtable('p@ssw1rd24')).to eq(
         {'a' => ['4', '@'], 'i' => ['1'], 'l' => ['1'], 'z' => ['2']}
       )
     end
@@ -17,14 +17,14 @@ describe Zxcvbn::Matchers::L33t do
     context 'with 2 possible substitutions' do
       it 'returns the correct possible substitutions' do
         substitutions = {'a' => ['@'], 'i' => ['1']}
-        matcher.l33t_subs(substitutions).should match_array([
+        expect(matcher.l33t_subs(substitutions)).to match_array([
           {'@' => 'a', '1' => 'i'}
         ])
       end
 
       it 'returns the correct possible substitutions with multiple options' do
         substitutions = {'a' => ['@', '4'], 'i' => ['1']}
-        matcher.l33t_subs(substitutions).should match_array([
+        expect(matcher.l33t_subs(substitutions)).to match_array([
           {'@' => 'a', '1' => 'i'},
           {'4' => 'a', '1' => 'i'}
         ])
@@ -34,7 +34,7 @@ describe Zxcvbn::Matchers::L33t do
     context 'with 3 possible substitutions' do
       it 'returns the correct possible substitutions' do
         substitutions = {'a' => ['@'], 'i' => ['1'], 'z' => ['3']}
-        matcher.l33t_subs(substitutions).should match_array([
+        expect(matcher.l33t_subs(substitutions)).to match_array([
           {'@' => 'a', '1' => 'i', '3' => 'z'}
         ])
       end
@@ -43,7 +43,7 @@ describe Zxcvbn::Matchers::L33t do
     context 'with 4 possible substitutions' do
       it 'returns the correct possible substitutions' do
         substitutions = {'a' => ['@'], 'i' => ['1'], 'z' => ['3'], 'b' => ['8']}
-        matcher.l33t_subs(substitutions).should match_array([
+        expect(matcher.l33t_subs(substitutions)).to match_array([
           {'@' => 'a', '1' => 'i', '3' => 'z', '8' => 'b'}
         ])
       end
@@ -51,12 +51,14 @@ describe Zxcvbn::Matchers::L33t do
   end
 
   describe '#matches' do
-    let(:matches) { matcher.matches('p@ssword') }
-    # it doesn't match on 'password' because that's not in the english
-    # dictionary/frequency list
+    subject(:matches) { matcher.matches('p@ssword') }
+
+    it "doesn't find 'password' because it's not in english.txt" do
+      expect(matches.map(&:matched_word)).not_to include "password"
+    end
 
     it 'finds the correct matches' do
-      matches.map(&:matched_word).should eq([
+      expect(matches.map(&:matched_word)).to match_array([
         'pas',
         'a',
         'as',
@@ -65,7 +67,7 @@ describe Zxcvbn::Matchers::L33t do
     end
 
     it 'sets the token correctly on those matches' do
-      matches.map(&:token).should eq([
+      expect(matches.map(&:token)).to match_array([
         'p@s',
         '@',
         '@s',
@@ -74,7 +76,7 @@ describe Zxcvbn::Matchers::L33t do
     end
 
     it 'sets the substituions used' do
-      matches.map(&:sub).should eq([
+      expect(matches.map(&:sub)).to match_array([
         {'@' => 'a'},
         {'@' => 'a'},
         {'@' => 'a'},
@@ -82,4 +84,4 @@ describe Zxcvbn::Matchers::L33t do
       ])
     end
   end
-end
+end

data/spec/matchers/repeat_spec.rb

@@ -5,14 +5,14 @@ describe Zxcvbn::Matchers::Repeat do
   let(:matches) { matcher.matches('bbbbbtestingaaa') }
 
   it 'sets the pattern name' do
-    matches.all? { |m| m.pattern == 'repeat' }.should eql(true)
+    expect(matches.all? { |m| m.pattern == 'repeat' }).to eql(true)
   end
 
   it 'finds the repeated patterns' do
-    matches.count.should eq 2
-    matches[0].token.should eq 'bbbbb'
-    matches[0].repeated_char.should eq 'b'
-    matches[1].token.should eq 'aaa'
-    matches[1].repeated_char.should eq 'a'
+    expect(matches.count).to eq 2
+    expect(matches[0].token).to eq 'bbbbb'
+    expect(matches[0].repeated_char).to eq 'b'
+    expect(matches[1].token).to eq 'aaa'
+    expect(matches[1].repeated_char).to eq 'a'
   end
 end

data/spec/matchers/sequences_spec.rb

@@ -5,17 +5,17 @@ describe Zxcvbn::Matchers::Sequences do
   let(:matches) { matcher.matches('abcde87654') }
 
   it 'sets the pattern name' do
-    matches.all? { |m| m.pattern == 'sequence' }.should eql(true)
+    expect(matches.all? { |m| m.pattern == 'sequence' }).to eql(true)
   end
 
   it 'finds the correct matches' do
-    matches.count.should == 2
-    matches[0].token.should eq 'abcde'
-    matches[1].token.should eq '87654'
+    expect(matches.count).to eq(2)
+    expect(matches[0].token).to eq 'abcde'
+    expect(matches[1].token).to eq '87654'
   end
 
   it 'finds overlapping matches' do
     matches = matcher.matches('abcba')
-    matches.map(&:token).should eq ['abc', 'cba']
+    expect(matches.map(&:token)).to eq ['abc', 'cba']
   end
 end

data/spec/matchers/spatial_spec.rb

@@ -8,13 +8,13 @@ describe Zxcvbn::Matchers::Spatial do
     let(:matches) { matcher.matches('rtyikm') }
 
     it 'finds the correct of matches' do
-      matches.count.should eq 3
-      matches[0].token.should eq 'rty'
-      matches[0].graph.should eq 'qwerty'
-      matches[1].token.should eq 'ikm'
-      matches[1].graph.should eq 'qwerty'
-      matches[2].token.should eq 'yik'
-      matches[2].graph.should eq 'dvorak'
+      expect(matches.count).to eq 3
+      expect(matches[0].token).to eq 'rty'
+      expect(matches[0].graph).to eq 'qwerty'
+      expect(matches[1].token).to eq 'ikm'
+      expect(matches[1].graph).to eq 'qwerty'
+      expect(matches[2].token).to eq 'yik'
+      expect(matches[2].graph).to eq 'dvorak'
     end
   end
 end

data/spec/matchers/year_spec.rb

@@ -5,11 +5,11 @@ describe Zxcvbn::Matchers::Year do
   let(:matches) { matcher.matches('testing1998') }
 
   it 'sets the pattern name' do
-    matches.all? { |m| m.pattern == 'year' }.should eql(true)
+    expect(matches.all? { |m| m.pattern == 'year' }).to eql(true)
   end
 
   it 'finds the correct matches' do
-    matches.count.should == 1
-    matches[0].token.should eq '1998'
+    expect(matches.count).to eq(1)
+    expect(matches[0].token).to eq '1998'
   end
 end

data/spec/omnimatch_spec.rb

@@ -18,7 +18,7 @@ describe Zxcvbn::Omnimatch do
       js_results = js_omnimatch(password)
       ruby_results = omnimatch(password)
 
-      ruby_results.should match_js_results js_results
+      expect(ruby_results).to match_js_results js_results
     end
   end
 end

data/spec/scoring/crack_time_spec.rb

@@ -5,38 +5,38 @@ describe Zxcvbn::CrackTime do
 
   describe '#entropy_to_crack_time' do
     specify do
-      entropy_to_crack_time(15.433976574415976).should eq 2.2134000000000014
+      expect(entropy_to_crack_time(15.433976574415976)).to eq 2.2134000000000014
     end
   end
 
   describe '#crack_time_to_score' do
     context 'crack time less than 10 to the power 2' do
       it 'returns 0' do
-        crack_time_to_score(90).should eq 0
+        expect(crack_time_to_score(90)).to eq 0
       end
     end
 
     context 'crack time in between 10**2 and 10**4' do
       it 'returns 1' do
-        crack_time_to_score(5000).should eq 1
+        expect(crack_time_to_score(5000)).to eq 1
       end
     end
 
     context 'crack time in between 10**4 and 10**6' do
       it 'returns 2' do
-        crack_time_to_score(500_000).should eq 2
+        expect(crack_time_to_score(500_000)).to eq 2
       end
     end
 
     context 'crack time in between 10**6 and 10**8' do
       it 'returns 3' do
-        crack_time_to_score(50_000_000).should eq 3
+        expect(crack_time_to_score(50_000_000)).to eq 3
       end
     end
 
     context 'crack time above 10**8' do
       it 'returns 4' do
-        crack_time_to_score(110_000_000).should eq 4
+        expect(crack_time_to_score(110_000_000)).to eq 4
       end
     end
   end
@@ -52,7 +52,7 @@ describe Zxcvbn::CrackTime do
     context 'when less than a minute' do
       it 'should return instant' do
         [0, minute_to_seconds - 1].each do |seconds|
-          display_time(seconds).should eql 'instant'
+          expect(display_time(seconds)).to eql 'instant'
         end
       end
     end
@@ -60,7 +60,7 @@ describe Zxcvbn::CrackTime do
     context 'when less than an hour' do
       it 'should return a readable time in minutes' do
         [60, (hour_to_seconds - 1)].each do |seconds|
-          display_time(seconds).should =~ /[0-9]+ minutes$/
+          expect(display_time(seconds)).to match(/[0-9]+ minutes$/)
         end
       end
     end
@@ -68,7 +68,7 @@ describe Zxcvbn::CrackTime do
     context 'when less than a day' do
       it 'should return a readable time in hours' do
         [hour_to_seconds, (day_to_seconds - 1)].each do |seconds|
-          display_time(seconds).should =~ /[0-9]+ hours$/
+          expect(display_time(seconds)).to match(/[0-9]+ hours$/)
         end
       end
     end
@@ -76,7 +76,7 @@ describe Zxcvbn::CrackTime do
     context 'when less than 31 days' do
       it 'should return a readable time in days' do
         [day_to_seconds, month_to_seconds - 1].each do |seconds|
-          display_time(seconds).should =~ /[0-9]+ days$/
+          expect(display_time(seconds)).to match(/[0-9]+ days$/)
         end
       end
     end
@@ -84,7 +84,7 @@ describe Zxcvbn::CrackTime do
     context 'when less than 1 year' do
       it 'should return a readable time in days' do
         [month_to_seconds, (year_to_seconds - 1)].each do |seconds|
-          display_time(seconds).should =~ /[0-9]+ months$/
+          expect(display_time(seconds)).to match(/[0-9]+ months$/)
         end
       end
     end
@@ -92,14 +92,14 @@ describe Zxcvbn::CrackTime do
     context 'when less than a century' do
       it 'should return a readable time in days' do
         [year_to_seconds, (century_to_seconds - 1)].each do |seconds|
-          display_time(seconds).should =~ /[0-9]+ years$/
+          expect(display_time(seconds)).to match(/[0-9]+ years$/)
         end
       end
     end
 
     context 'when a century or more' do
       it 'should return centuries' do
-        display_time(century_to_seconds).should eql 'centuries'
+        expect(display_time(century_to_seconds)).to eql 'centuries'
       end
     end
   end

data/spec/scoring/entropy_spec.rb

@@ -15,7 +15,7 @@ describe Zxcvbn::Entropy do
   describe '#repeat_entropy' do
     it 'returns the correct value' do
       match = Zxcvbn::Match.new(:token => '2222')
-      entropy.repeat_entropy(match).should eq 5.321928094887363
+      expect(entropy.repeat_entropy(match)).to eq 5.321928094887363
     end
   end
 
@@ -27,7 +27,7 @@ describe Zxcvbn::Entropy do
         let(:token) { token }
 
         it 'returns the correct value' do
-          entropy.sequence_entropy(match).should eq 3.807354922057604
+          expect(entropy.sequence_entropy(match)).to eq 3.807354922057604
         end
       end
     end
@@ -36,7 +36,7 @@ describe Zxcvbn::Entropy do
       let(:token) { '23456' }
 
       it 'returns the correct value' do
-        entropy.sequence_entropy(match).should eq 5.643856189774725
+        expect(entropy.sequence_entropy(match)).to eq 5.643856189774725
       end
     end
 
@@ -44,7 +44,7 @@ describe Zxcvbn::Entropy do
       let(:token) { 'bcdef' }
 
       it 'returns the correct value' do
-        entropy.sequence_entropy(match).should eq 7.022367813028454
+        expect(entropy.sequence_entropy(match)).to eq 7.022367813028454
       end
     end
 
@@ -52,7 +52,7 @@ describe Zxcvbn::Entropy do
       let(:token) { 'BCDEF' }
 
       it 'returns the correct value' do
-        entropy.sequence_entropy(match).should eq 8.022367813028454
+        expect(entropy.sequence_entropy(match)).to eq 8.022367813028454
       end
     end
 
@@ -61,7 +61,7 @@ describe Zxcvbn::Entropy do
       let(:token) { 'bcdef' }
 
       it 'returns the correct value' do
-        entropy.sequence_entropy(match).should eq 8.022367813028454
+        expect(entropy.sequence_entropy(match)).to eq 8.022367813028454
       end
     end
   end
@@ -69,13 +69,13 @@ describe Zxcvbn::Entropy do
   describe '#digits_entropy' do
     it 'returns the correct value' do
       match = Zxcvbn::Match.new(:token => '12345678')
-      entropy.digits_entropy(match).should eq 26.5754247590989
+      expect(entropy.digits_entropy(match)).to eq 26.5754247590989
     end
   end
 
   describe '#year_entropy' do
     it 'returns the correct value' do
-      entropy.year_entropy(nil).should eq 6.894817763307944
+      expect(entropy.year_entropy(nil)).to eq 6.894817763307944
     end
   end
 
@@ -83,21 +83,21 @@ describe Zxcvbn::Entropy do
     context 'with a two digit year' do
       it 'returns the correct value' do
         match = Zxcvbn::Match.new(:year => 98)
-        entropy.date_entropy(match).should eq 15.183015000882756
+        expect(entropy.date_entropy(match)).to eq 15.183015000882756
       end
     end
 
     context 'with a four digit year' do
       it 'returns the correct value' do
         match = Zxcvbn::Match.new(:year => 2012)
-        entropy.date_entropy(match).should eq 15.433976574415976
+        expect(entropy.date_entropy(match)).to eq 15.433976574415976
       end
     end
 
     context 'with a separator' do
       it 'returns the correct value' do
         match = Zxcvbn::Match.new(:year => 2012, :separator => '/')
-        entropy.date_entropy(match).should eq 17.433976574415976
+        expect(entropy.date_entropy(match)).to eq 17.433976574415976
       end
     end
   end
@@ -112,42 +112,42 @@ describe Zxcvbn::Entropy do
       let(:token) { 'you' }
       let(:rank)  { 1 }
 
-      specify { calculated_entropy.should eq 0 }
+      specify { expect(calculated_entropy).to eq 0 }
     end
 
     context 'with all upper case characters' do
       let(:token) { 'YOU' }
       let(:rank)  { 1 }
 
-      specify { calculated_entropy.should eq 1 }
+      specify { expect(calculated_entropy).to eq 1 }
     end
 
     context 'starting with uppercase' do
       let(:token) { 'You' }
       let(:rank)  { 1 }
 
-      specify { calculated_entropy.should eq 1 }
+      specify { expect(calculated_entropy).to eq 1 }
     end
 
     context 'starting with uppercase' do
       let(:token) { 'yoU' }
       let(:rank)  { 1 }
 
-      specify { calculated_entropy.should eq 1 }
+      specify { expect(calculated_entropy).to eq 1 }
     end
 
     context 'mixed upper and lower' do
       let(:token) { 'tEsTiNg' }
       let(:rank)  { 1 }
 
-      specify { calculated_entropy.should eq 6 }
+      specify { expect(calculated_entropy).to eq 6 }
     end
 
     context 'starting with digits' do
       let(:token) { '12345' }
       let(:rank)  { 1 }
 
-      specify { calculated_entropy.should eq 0 }
+      specify { expect(calculated_entropy).to eq 0 }
     end
 
     context 'extra l33t entropy' do
@@ -156,7 +156,7 @@ describe Zxcvbn::Entropy do
       let(:l33t)  { true }
       let(:sub)   { {'3' => 'e', '0' => 'o'} }
 
-      specify { calculated_entropy.should eq 1 }
+      specify { expect(calculated_entropy).to eq 1 }
     end
   end
 
@@ -167,7 +167,7 @@ describe Zxcvbn::Entropy do
       it 'should return the correct entropy' do
         match.graph = 'qwerty'
 
-        entropy.spatial_entropy(match).should eql 11.562242424221074
+        expect(entropy.spatial_entropy(match)).to eql 11.562242424221074
       end
     end
 
@@ -175,7 +175,7 @@ describe Zxcvbn::Entropy do
       it 'should return the correct entropy' do
         match.graph = 'dvorak'
 
-        entropy.spatial_entropy(match).should eql 11.562242424221074
+        expect(entropy.spatial_entropy(match)).to eql 11.562242424221074
       end
     end
 
@@ -183,7 +183,7 @@ describe Zxcvbn::Entropy do
       it 'should return the correct entropy' do
         match.graph = 'keypad'
 
-        entropy.spatial_entropy(match).should eql 9.05528243550119
+        expect(entropy.spatial_entropy(match)).to eql 9.05528243550119
       end
     end
 
@@ -191,7 +191,7 @@ describe Zxcvbn::Entropy do
       it 'should return the correct entropy' do
         match.turns = 5
 
-        entropy.spatial_entropy(match).should eql 21.761397858718993
+        expect(entropy.spatial_entropy(match)).to eql 21.761397858718993
       end
     end
 
@@ -199,7 +199,7 @@ describe Zxcvbn::Entropy do
       it 'should return the correct entropy' do
         match.shiffted_count = 5
 
-        entropy.spatial_entropy(match).should eql 9.05528243550119
+        expect(entropy.spatial_entropy(match)).to eql 9.05528243550119
       end
     end
 
@@ -208,7 +208,7 @@ describe Zxcvbn::Entropy do
         match.shiffted_count = 5
         match.turns          = 5
 
-        entropy.spatial_entropy(match).should eql 21.761397858718993
+        expect(entropy.spatial_entropy(match)).to eql 21.761397858718993
       end
     end
   end