zxcvbn-ruby 0.1.0 → 1.2.0

data/spec/scoring/math_spec.rb

@@ -10,7 +10,7 @@ describe Zxcvbn::Math do
   describe '#bruteforce_cardinality' do
     context 'when empty password' do
       it 'should return 0 if empty password' do
-        bruteforce_cardinality('').should eql 0
+        expect(bruteforce_cardinality('')).to eql 0
       end
     end
 
@@ -18,7 +18,7 @@ describe Zxcvbn::Math do
       context 'and a digit' do
         it 'should return 10' do
           (0..9).each do |digit|
-            bruteforce_cardinality(digit.to_s).should eql 10
+            expect(bruteforce_cardinality(digit.to_s)).to eql 10
           end
         end
       end
@@ -26,7 +26,7 @@ describe Zxcvbn::Math do
       context 'and an upper case character' do
         it 'should return 26' do
           ('A'..'Z').each do |character|
-            bruteforce_cardinality(character).should eql 26
+            expect(bruteforce_cardinality(character)).to eql 26
           end
         end
       end
@@ -34,7 +34,7 @@ describe Zxcvbn::Math do
       context 'and a lower case character' do
         it 'should return 26' do
           ('a'..'z').each do |character|
-            bruteforce_cardinality(character).should eql 26
+            expect(bruteforce_cardinality(character)).to eql 26
           end
         end
       end
@@ -42,7 +42,7 @@ describe Zxcvbn::Math do
       context 'and a symbol' do
         it 'should return 33' do
           %w|/ [ ` {|.each do |symbol|
-            bruteforce_cardinality(symbol).should eql 33
+            expect(bruteforce_cardinality(symbol)).to eql 33
           end
         end
       end
@@ -51,31 +51,31 @@ describe Zxcvbn::Math do
     context 'when password is more than one character long' do
       context 'and only digits' do
         it 'should return 10' do
-          bruteforce_cardinality('123456789').should eql 10
+          expect(bruteforce_cardinality('123456789')).to eql 10
         end
       end
 
       context 'and only lowercase characters' do
         it 'should return 26' do
-          bruteforce_cardinality('password').should eql 26
+          expect(bruteforce_cardinality('password')).to eql 26
         end
       end
 
       context 'and only uppercase characters' do
         it 'should return 26' do
-          bruteforce_cardinality('PASSWORD').should eql 26
+          expect(bruteforce_cardinality('PASSWORD')).to eql 26
         end
       end
 
       context 'and only symbols' do
         it 'should return 33' do
-          bruteforce_cardinality('/ [ ` {').should eql 33
+          expect(bruteforce_cardinality('/ [ ` {')).to eql 33
         end
       end
 
       context 'and a mixed of character types' do
         it 'should add up every character type cardinality' do
-          bruteforce_cardinality('p1SsWorD!').should eql 95
+          expect(bruteforce_cardinality('p1SsWorD!')).to eql 95
         end
       end
     end
@@ -84,25 +84,25 @@ describe Zxcvbn::Math do
   describe '#average_degree_for_graph' do
     context 'when keyboard is qwerty' do
       it 'returns the correct average degree over all keys' do
-        average_degree_for_graph('qwerty').should eql 4.595744680851064
+        expect(average_degree_for_graph('qwerty')).to eql 4.595744680851064
       end
     end
 
     context 'when keyboard is dvorak' do
       it 'returns the correct average degree over all keys' do
-        average_degree_for_graph('dvorak').should eql 4.595744680851064
+        expect(average_degree_for_graph('dvorak')).to eql 4.595744680851064
       end
     end
 
     context 'when keyboard is keypad' do
       it 'returns the correct average degree over all keys' do
-        average_degree_for_graph('keypad').should eql 5.066666666666666
+        expect(average_degree_for_graph('keypad')).to eql 5.066666666666666
       end
     end
 
     context 'when keyboard is mac keypad' do
       it 'returns the correct average degree over all keys' do
-        average_degree_for_graph('mac_keypad').should eql 5.25
+        expect(average_degree_for_graph('mac_keypad')).to eql 5.25
       end
     end
   end
@@ -110,25 +110,25 @@ describe Zxcvbn::Math do
   describe '#starting_positions_for_graph' do
     context 'when keyboard is qwerty' do
       it 'returns the correct average degree over all keys' do
-        starting_positions_for_graph('qwerty').should eql 94
+        expect(starting_positions_for_graph('qwerty')).to eql 94
       end
     end
 
     context 'when keyboard is dvorak' do
       it 'returns the correct average degree over all keys' do
-        starting_positions_for_graph('dvorak').should eql 94
+        expect(starting_positions_for_graph('dvorak')).to eql 94
       end
     end
 
     context 'when keyboard is keypad' do
       it 'returns the correct average degree over all keys' do
-        starting_positions_for_graph('keypad').should eql 15
+        expect(starting_positions_for_graph('keypad')).to eql 15
       end
     end
 
     context 'when keyboard is mac keypad' do
       it 'returns the correct average degree over all keys' do
-        starting_positions_for_graph('mac_keypad').should eql 16
+        expect(starting_positions_for_graph('mac_keypad')).to eql 16
       end
     end
   end

data/spec/support/js_helpers.rb

@@ -1,4 +1,4 @@
-require 'v8'
+require 'mini_racer'
 require 'json'
 
 module JsHelpers
@@ -6,9 +6,8 @@ module JsHelpers
     JS_SOURCE_PATH = Pathname(File.expand_path('../js_source/', __FILE__))
 
     def initialize
-      @ctx = V8::Context.new do |ctx|
-        ctx.eval(JS_SOURCE_PATH.join('compiled.js').read)
-      end
+      @ctx = MiniRacer::Context.new
+      @ctx.eval(JS_SOURCE_PATH.join('compiled.js').read)
     end
 
     def eval(string)

data/spec/support/matcher.rb

@@ -17,7 +17,7 @@ RSpec::Matchers.define :match_js_results do |expected_js_results|
     @missing.empty? && @extra.empty?
   end
 
-  failure_message_for_should do |actual|
+  failure_message do |actual|
     "Matches missing from ruby results:\n#{@missing.inspect}\nMatches unique to ruby results:\n#{@extra.inspect}"
   end
 

data/spec/tester_spec.rb

@@ -1,4 +1,7 @@
-require 'spec_helper'
+# coding: utf-8
+# frozen_string_literal: true
+
+require "spec_helper"
 
 describe Zxcvbn::Tester do
   let(:tester) { Zxcvbn::Tester.new }
@@ -8,44 +11,89 @@ describe Zxcvbn::Tester do
       ruby_result = tester.test(password)
       js_result = js_zxcvbn(password)
 
-      ruby_result.calc_time.should_not be_nil
-      ruby_result.password.should eq js_result['password']
-      ruby_result.entropy.should eq js_result['entropy']
-      ruby_result.crack_time.should eq js_result['crack_time']
-      ruby_result.crack_time_display.should eq js_result['crack_time_display']
-      ruby_result.score.should eq js_result['score']
-      ruby_result.pattern.should eq js_result['pattern']
-      ruby_result.match_sequence.count.should eq js_result['match_sequence'].count
+      expect(ruby_result.calc_time).not_to be_nil
+      expect(ruby_result.password).to eq js_result["password"]
+      expect(ruby_result.entropy).to eq js_result["entropy"]
+      expect(ruby_result.crack_time).to eq js_result["crack_time"]
+      expect(ruby_result.crack_time_display).to eq js_result["crack_time_display"]
+      expect(ruby_result.score).to eq js_result["score"]
+      expect(ruby_result.pattern).to eq js_result["pattern"]
+      expect(ruby_result.match_sequence.count).to eq js_result["match_sequence"].count
+
+      # NOTE: feedback didn't exist in the version of the JS library this gem
+      #       is based on, so instead we just check that it put `Feedback` in
+      #       there. Real tests for its values go in `feedback_giver_spec.rb`.
+      expect(ruby_result.feedback).to be_a Zxcvbn::Feedback
     end
   end
 
-  context 'with a custom user dictionary' do
-    it 'scores them against the user dictionary' do
-      result = tester.test('themeforest', ['themeforest'])
-      result.entropy.should eq 0
-      result.score.should eq 0
+  context "with a custom user dictionary" do
+    it "scores them against the user dictionary" do
+      result = tester.test("themeforest", ["themeforest"])
+      expect(result.entropy).to eq 0
+      expect(result.score).to eq 0
     end
 
-    it 'matches l33t substitutions on this dictionary' do
-      result = tester.test('th3m3for3st', ['themeforest'])
-      result.entropy.should eq 1
-      result.score.should eq 0
+    it "matches l33t substitutions on this dictionary" do
+      result = tester.test("th3m3for3st", ["themeforest"])
+      expect(result.entropy).to eq 1
+      expect(result.score).to eq 0
+    end
+  end
+
+  context "with Unicode entries in the password" do
+    it "validates the password" do
+      result = tester.test("✅🐴🔋staple", %w[Theme Forest themeforest])
+      expect(result.entropy).to be_positive
+      expect(result.score).to be_positive
     end
   end
 
-  context 'with a custom global dictionary' do
-    before { tester.add_word_lists('envato' => ['envato']) }
+  context "with Unicode entries in the dictionary" do
+    it "validates the password" do
+      result = tester.test("correct horse battery staple", %w[✅ 🐴 🔋])
+      expect(result.entropy).to be_positive
+      expect(result.score).to be_positive
+    end
+  end
+
+  context "with Unicode entries in the password and the dictionary" do
+    it "validates the password" do
+      result = tester.test("✅🐴🔋staple", %w[✅ 🐴 🔋])
+      expect(result.entropy).to be_positive
+      expect(result.score).to be_zero
+    end
+  end
+
+  context "with invalid entries in the dictionary" do
+    it "ignores those entries" do
+      result = tester.test("themeforest", [nil, 1, "themeforest"])
+      expect(result.entropy).to eq 0
+      expect(result.score).to eq 0
+    end
+  end
+
+  context "with a custom global dictionary" do
+    before { tester.add_word_lists("envato" => ["envato"]) }
+
+    it "scores them against the dictionary" do
+      result = tester.test("envato")
+      expect(result.entropy).to eq 0
+      expect(result.score).to eq 0
+    end
+
+    context "with invalid entries in a custom dictionary" do
+      before { tester.add_word_lists("themeforest" => [nil, 1, "themeforest"]) }
 
-    it 'scores them against the dictionary' do
-      result = tester.test('envato')
-      result.entropy.should eq 0
-      result.score.should eq 0
+      it "ignores those entries" do
+        expect(tester.test("themeforest")).to have_attributes(entropy: 0, score: 0, crack_time: 0)
+      end
     end
   end
 
-  context 'nil password' do
+  context "nil password" do
     specify do
-      expect { tester.test(nil) }.to_not raise_error
+      expect(tester.test(nil)).to have_attributes(entropy: 0, score: 0, crack_time: 0)
     end
   end
-end
+end

data/zxcvbn-ruby.gemspec

@@ -1,6 +1,8 @@
 # -*- encoding: utf-8 -*-
 require File.expand_path('../lib/zxcvbn/version', __FILE__)
 
+GITHUB_URL = 'https://github.com/envato/zxcvbn-ruby'
+
 Gem::Specification.new do |gem|
   gem.authors       = ["Steve Hodgkiss", "Matthieu Aussaguel"]
   gem.email         = ["steve@hodgkiss.me", "matthieu.aussaguel@gmail.com"]
@@ -14,7 +16,18 @@ Gem::Specification.new do |gem|
   gem.name          = "zxcvbn-ruby"
   gem.require_paths = ["lib"]
   gem.version       = Zxcvbn::VERSION
+  gem.license       = 'MIT'
+
+  gem.required_ruby_version = '>= 2.5'
 
-  gem.add_development_dependency 'therubyracer'
+  gem.add_development_dependency 'mini_racer'
   gem.add_development_dependency 'rspec'
+
+  gem.metadata = {
+    'bug_tracker_uri' => "#{GITHUB_URL}/issues",
+    'changelog_uri' => "#{GITHUB_URL}/blob/HEAD/CHANGELOG.md",
+    'documentation_uri' => "#{GITHUB_URL}/blob/HEAD/README.md",
+    'homepage_uri' => GITHUB_URL,
+    'source_code_uri' => GITHUB_URL
+  }
 end

metadata

@@ -1,47 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: zxcvbn-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - Steve Hodgkiss
 - Matthieu Aussaguel
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-04-28 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: therubyracer
+  name: mini_racer
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby port of Dropboxs zxcvbn.js
@@ -52,10 +47,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
-- LICENSE
+- Guardfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - data/adjacency_graphs.json
@@ -69,6 +68,8 @@ files:
 - lib/zxcvbn/data.rb
 - lib/zxcvbn/dictionary_ranker.rb
 - lib/zxcvbn/entropy.rb
+- lib/zxcvbn/feedback.rb
+- lib/zxcvbn/feedback_giver.rb
 - lib/zxcvbn/match.rb
 - lib/zxcvbn/matchers/date.rb
 - lib/zxcvbn/matchers/dictionary.rb
@@ -88,6 +89,7 @@ files:
 - lib/zxcvbn/tester.rb
 - lib/zxcvbn/version.rb
 - spec/dictionary_ranker_spec.rb
+- spec/feedback_giver_spec.rb
 - spec/matchers/date_spec.rb
 - spec/matchers/dictionary_spec.rb
 - spec/matchers/digits_spec.rb
@@ -117,37 +119,36 @@ files:
 - spec/zxcvbn_spec.rb
 - zxcvbn-ruby.gemspec
 homepage: http://github.com/envato/zxcvbn-ruby
-licenses: []
-post_install_message: 
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/envato/zxcvbn-ruby/issues
+  changelog_uri: https://github.com/envato/zxcvbn-ruby/blob/HEAD/CHANGELOG.md
+  documentation_uri: https://github.com/envato/zxcvbn-ruby/blob/HEAD/README.md
+  homepage_uri: https://github.com/envato/zxcvbn-ruby
+  source_code_uri: https://github.com/envato/zxcvbn-ruby
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 3120558835973257605
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3120558835973257605
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23.2
-signing_key: 
-specification_version: 3
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
 summary: ''
 test_files:
 - spec/dictionary_ranker_spec.rb
+- spec/feedback_giver_spec.rb
 - spec/matchers/date_spec.rb
 - spec/matchers/dictionary_spec.rb
 - spec/matchers/digits_spec.rb