zxcvbn-ruby 1.2.1 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e00f4d1e74aab0e662091f1adbcd1e86abeb11bfe3ac0440f0d5c83988b16649
-  data.tar.gz: 30164328d27edf8e12a8fcb0d79a3eea47c910f0f2cd6cf1d56b9aa1da515b9e
+  metadata.gz: 62e582cfff03a7e2075efea27771a6e8a542e799546b67ab7e342df77fc503e5
+  data.tar.gz: 9ac56545038db446e0dac7421f8d5ebc22bdb62abc808ba9801f18fbaf474257
 SHA512:
-  metadata.gz: e50ab32776c2ab1aed4bb5adccd6067efad60bf203f9d3f7e700e03ba5ecd60e8fb06725fa95ca44683045f2f5471f00a0af586cd8ded69bd985e4f14a09e9e5
-  data.tar.gz: 107abf8ef445ad4462c62801d53b14c6d6f695707ecb40819973b2e949eaf385dee15bf3e8326138febc088df2c069f959a937e852c0dce56acda6b3bbad051d
+  metadata.gz: 15a3f510c69b660169c08e7552f04ba5072db4865977aa436e3b673cd2053dadd0af5a5d143ea936a86993c1cbe48653957384bf97aac7056d80d31a99c986a9
+  data.tar.gz: 6c69b9142475710c4ce02ccbef7da7faaa4c54426118d29383f55d20c1b9c1d62459bd8de842f37830b22568ba41cb4a5717dc6531d9c4edb7625691cf3d1229

data/CHANGELOG.md

@@ -6,7 +6,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-[Unreleased]: https://github.com/envato/zxcvbn-ruby/compare/v1.2.1...HEAD
+[Unreleased]: https://github.com/envato/zxcvbn-ruby/compare/v1.2.3...HEAD
+
+## [1.2.3] - 2025-12-07
+
+### Changed
+ - Address linting issues ([#52])
+ - Address style issues ([#53], [#54], [#55])
+
+[1.2.3]: https://github.com/envato/zxcvbn-ruby/compare/v1.2.2...v1.2.3
+[#52]: https://github.com/envato/zxcvbn-ruby/pull/52
+[#53]: https://github.com/envato/zxcvbn-ruby/pull/53
+[#54]: https://github.com/envato/zxcvbn-ruby/pull/54
+[#55]: https://github.com/envato/zxcvbn-ruby/pull/55
+
+## [1.2.2] - 2025-12-06
+
+### Changed
+ - Address layout and frozen string literal issues ([#49])
+
+[1.2.2]: https://github.com/envato/zxcvbn-ruby/compare/v1.2.1...v1.2.2
+[#49]: https://github.com/envato/zxcvbn-ruby/pull/49
 
 ## [1.2.1] - 2025-12-05
 
@@ -14,7 +34,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Removed the dependency on the Ruby `benchmark` module ([#44]).
 - Tests are no longer included in the gem package ([#45]).
 
-[1.2.1]: https://github.com/envato/zxcvbn-ruby/compare/v1.2.0...v.1.2.1
+[1.2.1]: https://github.com/envato/zxcvbn-ruby/compare/v1.2.0...v1.2.1
 [#44]: https://github.com/envato/zxcvbn-ruby/pull/44
 [#45]: https://github.com/envato/zxcvbn-ruby/pull/45
 
@@ -27,7 +47,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
  - Use [mini\_racer] for running JavaScript specs (thanks [@RSO] ([#33]))
  - Moved CI to GitHub Actions ([#34])
 
-[1.2.0]: https://github.com/envato/zxcvbn-ruby/compare/v1.1.0...v.1.2.0
+[1.2.0]: https://github.com/envato/zxcvbn-ruby/compare/v1.1.0...v1.2.0
 [@rso]: https://github.com/RSO
 [mini\_racer]: https://rubygems.org/gems/mini_racer/
 [#32]: https://github.com/envato/zxcvbn-ruby/pull/32

data/README.md

@@ -126,11 +126,6 @@ attacker. For this reason we advise you not to store the results of
  - [GitHub project](https://github.com/envato/zxcvbn-ruby)
  - Bug reports and feature requests are welcome via [GitHub Issues](https://github.com/envato/zxcvbn-ruby/issues)
 
-## Maintainers
-
- - [Pete Johns](https://github.com/johnsyweb)
- - [Steve Hodgkiss](https://github.com/stevehodgkiss)
-
 ## Authors
 
  - [Steve Hodgkiss](https://github.com/stevehodgkiss)
@@ -162,18 +157,14 @@ For larger new features: Do everything as above, but first also make contact wit
 
 ## About [![code with heart by Envato](https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-Envato-ff69b4.svg?style=flat-square)](https://github.com/envato/zxcvbn-ruby)
 
-This project is maintained by the [Envato engineering team][webuild] and funded by [Envato][envato].
-
-[<img src="http://opensource.envato.com/images/envato-oss-readme-logo.png" alt="Envato logo">][envato]
+This project is maintained by the Envato engineering team and funded by [Envato][envato].
 
 Encouraging the use and creation of open source software is one of the ways we
-serve our community. See [our other projects][oss] or [come work with us][careers]
+serve our community. Perhaps [come work with us][careers]
 where you'll find an incredibly diverse, intelligent and capable group of people
 who help make our company succeed and make our workplace fun, friendly and
 happy.
 
  [careers]: https://envato.com/careers/?utm_source=github
  [envato]: https://envato.com?utm_source=github
- [oss]: https://opensource.envato.com/?utm_source=github
- [webuild]: https://webuild.envato.com?utm_source=github
  [zxcvbn.js]: https://github.com/dropbox/zxcvbn

data/lib/zxcvbn/clock.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zxcvbn
   module Clock
     def self.realtime
@@ -7,4 +9,3 @@ module Zxcvbn
     end
   end
 end
-

data/lib/zxcvbn/crack_time.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zxcvbn
   module CrackTime
     SINGLE_GUESS = 0.010
@@ -6,18 +8,17 @@ module Zxcvbn
     SECONDS_PER_GUESS = SINGLE_GUESS / NUM_ATTACKERS
 
     def entropy_to_crack_time(entropy)
-      0.5 * (2 ** entropy) * SECONDS_PER_GUESS
+      0.5 * (2**entropy) * SECONDS_PER_GUESS
     end
 
     def crack_time_to_score(seconds)
-      case
-      when seconds < 10**2
+      if seconds < 10**2
         0
-      when seconds < 10**4
+      elsif seconds < 10**4
         1
-      when seconds < 10**6
+      elsif seconds < 10**6
         2
-      when seconds < 10**8
+      elsif seconds < 10**8
         3
       else
         4
@@ -32,22 +33,21 @@ module Zxcvbn
       year    = month * 12
       century = year * 100
 
-      case
-      when seconds < minute
+      if seconds < minute
         'instant'
-      when seconds < hour
+      elsif seconds < hour
         "#{1 + (seconds / minute).ceil} minutes"
-      when seconds < day
+      elsif seconds < day
         "#{1 + (seconds / hour).ceil} hours"
-      when seconds < month
+      elsif seconds < month
         "#{1 + (seconds / day).ceil} days"
-      when seconds < year
+      elsif seconds < year
         "#{1 + (seconds / month).ceil} months"
-      when seconds < century
+      elsif seconds < century
         "#{1 + (seconds / year).ceil} years"
       else
         'centuries'
       end
     end
   end
-end
+end

data/lib/zxcvbn/data.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'zxcvbn/dictionary_ranker'
 
@@ -5,11 +7,11 @@ module Zxcvbn
   class Data
     def initialize
       @ranked_dictionaries = DictionaryRanker.rank_dictionaries(
-        "english" =>      read_word_list("english.txt"),
-        "female_names" => read_word_list("female_names.txt"),
-        "male_names" =>   read_word_list("male_names.txt"),
-        "passwords" =>    read_word_list("passwords.txt"),
-        "surnames" =>     read_word_list("surnames.txt")
+        'english' => read_word_list('english.txt'),
+        'female_names' => read_word_list('female_names.txt'),
+        'male_names' => read_word_list('male_names.txt'),
+        'passwords' => read_word_list('passwords.txt'),
+        'surnames' => read_word_list('surnames.txt')
       )
       @adjacency_graphs = JSON.load(DATA_PATH.join('adjacency_graphs.json').read)
     end
@@ -23,7 +25,7 @@ module Zxcvbn
     private
 
     def read_word_list(file)
-      DATA_PATH.join("frequency_lists", file).read.split
+      DATA_PATH.join('frequency_lists', file).read.split
     end
   end
 end

data/lib/zxcvbn/dictionary_ranker.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Zxcvbn
   class DictionaryRanker
     def self.rank_dictionaries(lists)
-      lists.each_with_object({}) do |(dict_name, words), dictionaries|
-        dictionaries[dict_name] = rank_dictionary(words)
+      lists.transform_values do |words|
+        rank_dictionary(words)
       end
     end
 

data/lib/zxcvbn/entropy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zxcvbn/math'
 
 module Zxcvbn::Entropy
@@ -6,24 +8,25 @@ module Zxcvbn::Entropy
   def calc_entropy(match)
     return match.entropy unless match.entropy.nil?
 
-    match.entropy = case match.pattern
-                    when 'repeat'
-                      repeat_entropy(match)
-                    when 'sequence'
-                      sequence_entropy(match)
-                    when 'digits'
-                      digits_entropy(match)
-                    when 'year'
-                      year_entropy(match)
-                    when 'date'
-                      date_entropy(match)
-                    when 'spatial'
-                      spatial_entropy(match)
-                    when 'dictionary'
-                      dictionary_entropy(match)
-                    else
-                      0
-                    end
+    match.entropy =
+      case match.pattern
+      when 'repeat'
+        repeat_entropy(match)
+      when 'sequence'
+        sequence_entropy(match)
+      when 'digits'
+        digits_entropy(match)
+      when 'year'
+        year_entropy(match)
+      when 'date'
+        date_entropy(match)
+      when 'spatial'
+        spatial_entropy(match)
+      when 'dictionary'
+        dictionary_entropy(match)
+      else
+        0
+      end
   end
 
   def repeat_entropy(match)
@@ -33,41 +36,41 @@ module Zxcvbn::Entropy
 
   def sequence_entropy(match)
     first_char = match.token[0]
-    base_entropy = if ['a', '1'].include?(first_char)
-      1
-    elsif first_char.match(/\d/)
-      lg(10)
-    elsif first_char.match(/[a-z]/)
-      lg(26)
-    else
-      lg(26) + 1
-    end
+    base_entropy =
+      if ['a', '1'].include?(first_char)
+        1
+      elsif first_char.match(/\d/)
+        lg(10)
+      elsif first_char.match(/[a-z]/)
+        lg(26)
+      else
+        lg(26) + 1
+      end
     base_entropy += 1 unless match.ascending
     base_entropy + lg(match.token.length)
   end
 
   def digits_entropy(match)
-    lg(10 ** match.token.length)
+    lg(10**match.token.length)
   end
 
   NUM_YEARS = 119 # years match against 1900 - 2019
   NUM_MONTHS = 12
   NUM_DAYS = 31
 
-  def year_entropy(match)
+  def year_entropy(_match)
     lg(NUM_YEARS)
   end
 
   def date_entropy(match)
-    if match.year < 100
-      entropy = lg(NUM_DAYS * NUM_MONTHS * 100)
-    else
-      entropy = lg(NUM_DAYS * NUM_MONTHS * NUM_YEARS)
-    end
+    entropy =
+      if match.year < 100
+        lg(NUM_DAYS * NUM_MONTHS * 100)
+      else
+        lg(NUM_DAYS * NUM_MONTHS * NUM_YEARS)
+      end
 
-    if match.separator
-      entropy += 2
-    end
+    entropy += 2 if match.separator
 
     entropy
   end
@@ -80,18 +83,18 @@ module Zxcvbn::Entropy
     match.base_entropy + match.uppercase_entropy + match.l33t_entropy
   end
 
-  START_UPPER = /^[A-Z][^A-Z]+$/
-  END_UPPER   = /^[^A-Z]+[A-Z]$/
-  ALL_UPPER   = /^[A-Z]+$/
-  ALL_LOWER   = /^[a-z]+$/
+  START_UPPER = /^[A-Z][^A-Z]+$/.freeze
+  END_UPPER   = /^[^A-Z]+[A-Z]$/.freeze
+  ALL_UPPER   = /^[A-Z]+$/.freeze
+  ALL_LOWER   = /^[a-z]+$/.freeze
 
   def extra_uppercase_entropy(match)
     word = match.token
     [START_UPPER, END_UPPER, ALL_UPPER].each do |regex|
       return 1 if word.match(regex)
     end
-    num_upper = word.chars.count{|c| c.match(/[A-Z]/) }
-    num_lower = word.chars.count{|c| c.match(/[a-z]/) }
+    num_upper = word.chars.count { |c| c.match(/[A-Z]/) }
+    num_lower = word.chars.count { |c| c.match(/[a-z]/) }
     possibilities = 0
     (0..[num_upper, num_lower].min).each do |i|
       possibilities += nCk(num_upper + num_lower, i)
@@ -102,20 +105,21 @@ module Zxcvbn::Entropy
   def extra_l33t_entropy(match)
     word = match.token
     return 0 unless match.l33t
+
     possibilities = 0
     match.sub.each do |subbed, unsubbed|
-      num_subbed = word.chars.count{|c| c == subbed}
-      num_unsubbed = word.chars.count{|c| c == unsubbed}
+      num_subbed = word.chars.count { |c| c == subbed }
+      num_unsubbed = word.chars.count { |c| c == unsubbed }
       (0..[num_subbed, num_unsubbed].min).each do |i|
         possibilities += nCk(num_subbed + num_unsubbed, i)
       end
     end
     entropy = lg(possibilities)
-    entropy == 0 ? 1 : entropy
+    entropy.zero? ? 1 : entropy
   end
 
   def spatial_entropy(match)
-    if %w|qwerty dvorak|.include? match.graph
+    if %w[qwerty dvorak].include? match.graph
       starting_positions = starting_positions_for_graph('qwerty')
       average_degree     = average_degree_for_graph('qwerty')
     else
@@ -131,7 +135,7 @@ module Zxcvbn::Entropy
     (2..token_length).each do |i|
       possible_turns = [turns, i - 1].min
       (1..possible_turns).each do |j|
-        possibilities += nCk(i - 1, j - 1) * starting_positions * average_degree ** j
+        possibilities += nCk(i - 1, j - 1) * starting_positions * average_degree**j
       end
     end
 

data/lib/zxcvbn/feedback.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zxcvbn
   class Feedback
     attr_accessor :warning, :suggestions

data/lib/zxcvbn/feedback_giver.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zxcvbn/entropy'
 require 'zxcvbn/feedback'
 
@@ -16,14 +18,14 @@ module Zxcvbn
 
     def self.get_feedback(score, sequence)
       # starting feedback
-      return DEFAULT_FEEDBACK if sequence.length.zero?
+      return DEFAULT_FEEDBACK if sequence.empty?
 
       # no feedback if score is good or great.
       return EMPTY_FEEDBACK if score > 2
 
       # tie feedback to the longest match for longer sequences
       longest_match = sequence[0]
-      for match in sequence[1..-1]
+      sequence[1..-1].each do |match|
         longest_match = match if match.token.length > longest_match.token.length
       end
 
@@ -45,7 +47,6 @@ module Zxcvbn
         get_dictionary_match_feedback match, is_sole_match
 
       when 'spatial'
-        layout = match.graph.upcase
         warning = if match.turns == 1
                     'Straight rows of keys are easy to guess'
                   else

data/lib/zxcvbn/match.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ostruct'
 
 module Zxcvbn

data/lib/zxcvbn/matchers/date.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zxcvbn/matchers/regex_helpers'
 
 module Zxcvbn
@@ -5,23 +7,23 @@ module Zxcvbn
     class Date
       include RegexHelpers
 
-      YEAR_SUFFIX = /
+      YEAR_SUFFIX = %r{
         ( \d{1,2} )                         # day or month
-        ( \s | \- | \/ | \\ | \_ | \. )     # separator
+        ( \s | - | / | \\ | _ | \. )        # separator
         ( \d{1,2} )                         # month or day
         \2                                  # same separator
         ( 19\d{2} | 200\d | 201\d | \d{2} ) # year
-      /x
+      }x.freeze
 
-      YEAR_PREFIX = /
+      YEAR_PREFIX = %r{
         ( 19\d{2} | 200\d | 201\d | \d{2} ) # year
-        ( \s | - | \/ | \\ | _ | \. )       # separator
+        ( \s | - | / | \\ | _ | \. )        # separator
         ( \d{1,2} )                         # day or month
         \2                                  # same separator
         ( \d{1,2} )                         # month or day
-      /x
+      }x.freeze
 
-      WITHOUT_SEPARATOR = /\d{4,8}/
+      WITHOUT_SEPARATOR = /\d{4,8}/.freeze
 
       def matches(password)
         match_with_separator(password) + match_without_separator(password)
@@ -52,9 +54,11 @@ module Zxcvbn
 
       def match_without_separator(password)
         result = []
-        re_match_all(WITHOUT_SEPARATOR, password) do |match, re_match|
+        re_match_all(WITHOUT_SEPARATOR, password) do |match, _re_match|
           extract_dates(match.token).each do |candidate|
-            day, month, year = candidate[:day], candidate[:month], candidate[:year]
+            day = candidate[:day]
+            month = candidate[:month]
+            year = candidate[:year]
 
             match.pattern = 'date'
             match.day = day
@@ -71,11 +75,11 @@ module Zxcvbn
         dates = []
         date_patterns_for_length(token.length).map do |pattern|
           candidate = {
-            :year => '',
-            :month => '',
-            :day => ''
+            year: +'',
+            month: +'',
+            day: +''
           }
-          for i in 0...token.length
+          (0...token.length).each do |i|
             candidate[PATTERN_CHAR_TO_SYM[pattern[i]]] << token[i]
           end
           candidate.each do |component, value|
@@ -92,18 +96,18 @@ module Zxcvbn
       end
 
       DATE_PATTERN_FOR_LENGTH = {
-        8 => %w[ yyyymmdd ddmmyyyy mmddyyyy ],
-        7 => %w[ yyyymdd yyyymmd ddmyyyy dmmyyyy ],
-        6 => %w[ yymmdd ddmmyy mmddyy ],
-        5 => %w[ yymdd yymmd ddmyy dmmyy mmdyy mddyy ],
-        4 => %w[ yymd dmyy mdyy ]
-      }
+        8 => %w[yyyymmdd ddmmyyyy mmddyyyy].freeze,
+        7 => %w[yyyymdd yyyymmd ddmyyyy dmmyyyy].freeze,
+        6 => %w[yymmdd ddmmyy mmddyy].freeze,
+        5 => %w[yymdd yymmd ddmyy dmmyy mmdyy mddyy].freeze,
+        4 => %w[yymd dmyy mdyy].freeze
+      }.freeze
 
       PATTERN_CHAR_TO_SYM = {
         'y' => :year,
         'm' => :month,
         'd' => :day
-      }
+      }.freeze
 
       def date_patterns_for_length(length)
         DATE_PATTERN_FOR_LENGTH[length] || []
@@ -112,6 +116,7 @@ module Zxcvbn
       def valid_date?(day, month, year)
         return false if day > 31 || month > 12
         return false unless year >= 1900 && year <= 2019
+
         true
       end
 
@@ -120,7 +125,7 @@ module Zxcvbn
       end
 
       def expand_year(year)
-        return year
+        year
         # Block dates with 2 digit years for now to be compatible with the JS version
         # return year unless year < 100
         # now = Time.now.year

data/lib/zxcvbn/matchers/dictionary.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zxcvbn/match'
 
 module Zxcvbn
@@ -18,19 +20,21 @@ module Zxcvbn
         (0..password_length).each do |i|
           (i...password_length).each do |j|
             word = lowercased_password[i..j]
-            if @ranked_dictionary.has_key?(word)
-              results << Match.new(:matched_word => word,
-                                   :token => password[i..j],
-                                   :i => i,
-                                   :j => j,
-                                   :rank => @ranked_dictionary[word],
-                                   :pattern => 'dictionary',
-                                   :dictionary_name => @name)
-            end
+            next unless @ranked_dictionary.key?(word)
+
+            results << Match.new(
+              matched_word: word,
+              token: password[i..j],
+              i: i,
+              j: j,
+              rank: @ranked_dictionary[word],
+              pattern: 'dictionary',
+              dictionary_name: @name
+            )
           end
         end
         results
       end
     end
   end
-end
+end

data/lib/zxcvbn/matchers/digits.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zxcvbn/matchers/regex_helpers'
 
 module Zxcvbn
@@ -5,7 +7,7 @@ module Zxcvbn
     class Digits
       include RegexHelpers
 
-      DIGITS_REGEX = /\d{3,}/
+      DIGITS_REGEX = /\d{3,}/.freeze
 
       def matches(password)
         result = []

data/lib/zxcvbn/matchers/l33t.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 module Zxcvbn
   module Matchers
     class L33t
       L33T_TABLE = {
-        'a' => ['4', '@'],
-        'b' => ['8'],
-        'c' => ['(', '{', '[', '<'],
-        'e' => ['3'],
-        'g' => ['6', '9'],
-        'i' => ['1', '!', '|'],
-        'l' => ['1', '|', '7'],
-        'o' => ['0'],
-        's' => ['$', '5'],
-        't' => ['+', '7'],
-        'x' => ['%'],
-        'z' => ['2']
-      }
+        'a' => ['4', '@'].freeze,
+        'b' => ['8'].freeze,
+        'c' => ['(', '{', '[', '<'].freeze,
+        'e' => ['3'].freeze,
+        'g' => ['6', '9'].freeze,
+        'i' => ['1', '!', '|'].freeze,
+        'l' => ['1', '|', '7'].freeze,
+        'o' => ['0'].freeze,
+        's' => ['$', '5'].freeze,
+        't' => ['+', '7'].freeze,
+        'x' => ['%'].freeze,
+        'z' => ['2'].freeze
+      }.freeze
 
       def initialize(dictionary_matchers)
         @dictionary_matchers = dictionary_matchers
@@ -30,6 +32,7 @@ module Zxcvbn
             matcher.matches(subbed_password).each do |match|
               token = password[match.i..match.j]
               next if token.downcase == match.matched_word.downcase
+
               match_substitutions = {}
               substitution.each do |s, letter|
                 match_substitutions[s] = letter if token.include?(s)
@@ -79,6 +82,7 @@ module Zxcvbn
 
       def find_substitutions(subs, table, keys)
         return subs if keys.empty?
+
         first_key = keys[0]
         rest_keys = keys[1..-1]
         next_subs = []
@@ -113,8 +117,8 @@ module Zxcvbn
         subs.each do |sub|
           assoc = sub.dup
 
-          assoc.sort! rescue debugger
-          label = assoc.map{|k, v| "#{k},#{v}"}.join('-')
+          assoc.sort!
+          label = assoc.map { |k, v| "#{k},#{v}" }.join('-')
           unless members.include?(label)
             members << label
             deduped << sub
@@ -124,4 +128,4 @@ module Zxcvbn
       end
     end
   end
-end
+end

data/lib/zxcvbn/matchers/new_l33t.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 module Zxcvbn
   module Matchers
     class L33t
       L33T_TABLE = {
-        'a' => ['4', '@'],
-        'b' => ['8'],
-        'c' => ['(', '{', '[', '<'],
-        'e' => ['3'],
-        'g' => ['6', '9'],
-        'i' => ['1', '!', '|'],
-        'l' => ['1', '|', '7'],
-        'o' => ['0'],
-        's' => ['$', '5'],
-        't' => ['+', '7'],
-        'x' => ['%'],
-        'z' => ['2']
-      }
+        'a' => ['4', '@'].freeze,
+        'b' => ['8'].freeze,
+        'c' => ['(', '{', '[', '<'].freeze,
+        'e' => ['3'].freeze,
+        'g' => ['6', '9'].freeze,
+        'i' => ['1', '!', '|'].freeze,
+        'l' => ['1', '|', '7'].freeze,
+        'o' => ['0'].freeze,
+        's' => ['$', '5'].freeze,
+        't' => ['+', '7'].freeze,
+        'x' => ['%'].freeze,
+        'z' => ['2'].freeze
+      }.freeze
 
       def initialize(dictionary_matchers)
         @dictionary_matchers = dictionary_matchers
@@ -24,16 +26,15 @@ module Zxcvbn
         matches = []
         lowercased_password = password.downcase
         combinations_to_try = substitution_combinations(relevant_l33t_substitutions(lowercased_password))
-        # debugger if password == 'abcdefghijk987654321'
-        combinations_to_try.each do |substitution|
+        combinations_to_try.each do |substitutions|
           @dictionary_matchers.each do |matcher|
-            subbed_password = substitute(lowercased_password, substitution)
+            subbed_password = substitute(lowercased_password, substitutions)
             matcher.matches(subbed_password).each do |match|
               token = lowercased_password[match.i..match.j]
               next if token == match.matched_word.downcase
-              # debugger if token == '1'
+
               match_substitutions = {}
-              substitution.each do |letter, substitution|
+              substitutions.each do |letter, substitution|
                 match_substitutions[substitution] = letter if token.include?(substitution)
               end
               match.l33t = true
@@ -49,9 +50,9 @@ module Zxcvbn
         matches
       end
 
-      def substitute(password, substitution)
+      def substitute(password, substitutions)
         subbed_password = password.dup
-        substitution.each do |letter, substitution|
+        substitutions.each do |letter, substitution|
           subbed_password.gsub!(substitution, letter)
         end
         subbed_password
@@ -64,9 +65,7 @@ module Zxcvbn
         end
         L33T_TABLE.each do |letter, substibutions|
           password.each_char do |password_char|
-            if substibutions.include?(password_char)
-              subs[letter] << password_char
-            end
+            subs[letter] << password_char if substibutions.include?(password_char)
           end
         end
         subs
@@ -82,7 +81,7 @@ module Zxcvbn
         expanded_substitutions.each do |substitution_hash|
           # convert a hash to an array of hashes with 1 key each
           subs_array = substitution_hash.map do |letter, substitutions|
-            {letter => substitutions}
+            { letter => substitutions }
           end
           combinations << subs_array
 
@@ -94,15 +93,13 @@ module Zxcvbn
         end
 
         # convert back to simple hash per substitution combination
-        combination_hashes = combinations.map do |combination_set|
+        combinations.map do |combination_set|
           hash = {}
           combination_set.each do |combination_hash|
             hash.merge!(combination_hash)
           end
           hash
         end
-
-        combination_hashes
       end
 
       # expand possible combinations if multiple characters can be substituted
@@ -110,11 +107,11 @@ module Zxcvbn
       #      [{'a' => '4', 'i' => 1}, {'a' => '@', 'i' => '1'}]
       def expanded_substitutions(hash)
         return {} if hash.empty?
+
         values = hash.values
         product_values = values[0].product(*values[1..-1])
-        product_values.map{ |p| Hash[hash.keys.zip(p)] }
+        product_values.map { |p| Hash[hash.keys.zip(p)] }
       end
-
     end
   end
-end
+end

data/lib/zxcvbn/matchers/regex_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zxcvbn/match'
 
 module Zxcvbn
@@ -5,15 +7,15 @@ module Zxcvbn
     module RegexHelpers
       def re_match_all(regex, password)
         pos = 0
-        while re_match = regex.match(password, pos)
+        while (re_match = regex.match(password, pos))
           i, j = re_match.offset(0)
           pos = j
           j -= 1
 
           match = Match.new(
-            :i => i,
-            :j => j,
-            :token => password[i..j]
+            i: i,
+            j: j,
+            token: password[i..j]
           )
           yield match, re_match
         end

data/lib/zxcvbn/matchers/repeat.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zxcvbn/match'
 
 module Zxcvbn
@@ -9,17 +11,15 @@ module Zxcvbn
         while i < password.length
           cur_char = password[i]
           j = i + 1
-          while cur_char == password[j]
-            j += 1
-          end
+          j += 1 while cur_char == password[j]
 
           if j - i > 2 # don't consider length 1 or 2 chains.
             result << Match.new(
-              :pattern => 'repeat',
-              :i => i,
-              :j => j-1,
-              :token => password[i...j],
-              :repeated_char => cur_char
+              pattern: 'repeat',
+              i: i,
+              j: j - 1,
+              token: password[i...j],
+              repeated_char: cur_char
             )
           end
 

data/lib/zxcvbn/matchers/sequences.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zxcvbn/match'
 
 module Zxcvbn
@@ -7,14 +9,14 @@ module Zxcvbn
         'lower' => 'abcdefghijklmnopqrstuvwxyz',
         'upper' => 'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
         'digits' => '01234567890'
-      }
+      }.freeze
 
       def seq_match_length(password, from, direction, seq)
         index_from = seq.index(password[from])
         j = 1
         while from + j < password.length &&
               password[from + j] == seq[index_from + direction * j]
-          j+= 1
+          j += 1
         end
         j
       end
@@ -24,15 +26,13 @@ module Zxcvbn
       def applicable_sequence(password, i)
         SEQUENCES.each do |name, sequence|
           index1 = sequence.index(password[i])
-          index2 = sequence.index(password[i+1])
-          if index1 and index2
-            seq_direction = index2 - index1
-            if [-1, 1].include?(seq_direction)
-              return [name, sequence, seq_direction]
-            else
-              return nil
-            end
-          end
+          index2 = sequence.index(password[i + 1])
+          next unless index1 && index2
+
+          seq_direction = index2 - index1
+          return [name, sequence, seq_direction] if [-1, 1].include?(seq_direction)
+
+          return nil
         end
       end
 
@@ -46,13 +46,13 @@ module Zxcvbn
             length = seq_match_length(password, i, seq_direction, seq)
             if length > 2
               result << Match.new(
-                :pattern => 'sequence',
-                :i => i,
-                :j => i + length - 1,
-                :token => password[i, length],
-                :sequence_name => seq_name,
-                :sequence_space => seq.length,
-                :ascending => seq_direction == 1
+                pattern: 'sequence',
+                i: i,
+                j: i + length - 1,
+                token: password[i, length],
+                sequence_name: seq_name,
+                sequence_space: seq.length,
+                ascending: seq_direction == 1
               )
             end
             i += length - 1

data/lib/zxcvbn/matchers/spatial.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zxcvbn/match'
 
 module Zxcvbn
@@ -24,7 +26,7 @@ module Zxcvbn
           turns = 0
           shifted_count = 0
           loop do
-            prev_char = password[j-1]
+            prev_char = password[j - 1]
             found = false
             found_direction = -1
             cur_direction = -1
@@ -34,22 +36,22 @@ module Zxcvbn
               cur_char = password[j]
               adjacents.each do |adj|
                 cur_direction += 1
-                if adj && adj.index(cur_char)
-                  found = true
-                  found_direction = cur_direction
-                  if adj.index(cur_char) == 1
-                    # index 1 in the adjacency means the key is shifted, 0 means unshifted: A vs a, % vs 5, etc.
-                    # for example, 'q' is adjacent to the entry '2@'. @ is shifted w/ index 1, 2 is unshifted.
-                    shifted_count += 1
-                  end
-                  if last_direction != found_direction
-                    # adding a turn is correct even in the initial case when last_direction is null:
-                    # every spatial pattern starts with a turn.
-                    turns += 1
-                    last_direction = found_direction
-                  end
-                  break
+                next unless adj&.index(cur_char)
+
+                found = true
+                found_direction = cur_direction
+                if adj.index(cur_char) == 1
+                  # index 1 in the adjacency means the key is shifted, 0 means unshifted: A vs a, % vs 5, etc.
+                  # for example, 'q' is adjacent to the entry '2@'. @ is shifted w/ index 1, 2 is unshifted.
+                  shifted_count += 1
+                end
+                if last_direction != found_direction
+                  # adding a turn is correct even in the initial case when last_direction is null:
+                  # every spatial pattern starts with a turn.
+                  turns += 1
+                  last_direction = found_direction
                 end
+                break
               end
             end
             # if the current pattern continued, extend j and try to grow again
@@ -59,13 +61,13 @@ module Zxcvbn
               # otherwise push the pattern discovered so far, if any...
               if j - i > 2 # don't consider length 1 or 2 chains.
                 result << Match.new(
-                  :pattern => 'spatial',
-                  :i => i,
-                  :j => j-1,
-                  :token => password[i...j],
-                  :graph => graph_name,
-                  :turns => turns,
-                  :shifted_count => shifted_count
+                  pattern: 'spatial',
+                  i: i,
+                  j: j - 1,
+                  token: password[i...j],
+                  graph: graph_name,
+                  turns: turns,
+                  shifted_count: shifted_count
                 )
               end
               # ...and then start a new search for the rest of the password.
@@ -78,4 +80,4 @@ module Zxcvbn
       end
     end
   end
-end
+end

data/lib/zxcvbn/matchers/year.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zxcvbn/matchers/regex_helpers'
 
 module Zxcvbn
@@ -5,7 +7,7 @@ module Zxcvbn
     class Year
       include RegexHelpers
 
-      YEAR_REGEX = /19\d\d|200\d|201\d/
+      YEAR_REGEX = /19\d\d|200\d|201\d/.freeze
 
       def matches(password)
         result = []
@@ -17,4 +19,4 @@ module Zxcvbn
       end
     end
   end
-end
+end

data/lib/zxcvbn/math.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zxcvbn
   module Math
     def bruteforce_cardinality(password)
@@ -30,11 +32,12 @@ module Zxcvbn
 
     def nCk(n, k)
       return 0 if k > n
-      return 1 if k == 0
+      return 1 if k.zero?
+
       r = 1
       (1..k).each do |d|
-        r = r * n
-        r = r / d
+        r *= n
+        r /= d
         n -= 1
       end
       r

data/lib/zxcvbn/omnimatch.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zxcvbn/dictionary_ranker'
 require 'zxcvbn/matchers/dictionary'
 require 'zxcvbn/matchers/l33t'
@@ -26,13 +28,13 @@ module Zxcvbn
 
     def user_input_matchers(user_inputs)
       return [] unless user_inputs.any?
+
       user_ranked_dictionary = DictionaryRanker.rank_dictionary(user_inputs)
       dictionary_matcher = Matchers::Dictionary.new('user_inputs', user_ranked_dictionary)
       l33t_matcher = Matchers::L33t.new([dictionary_matcher])
       [dictionary_matcher, l33t_matcher]
     end
 
-
     def build_matchers
       matchers = []
       dictionary_matchers = @data.ranked_dictionaries.map do |name, dictionary|

data/lib/zxcvbn/password_strength.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zxcvbn/clock'
 require 'zxcvbn/feedback_giver'
 require 'zxcvbn/omnimatch'
@@ -11,7 +13,7 @@ module Zxcvbn
     end
 
     def test(password, user_inputs = [])
-      password = password || ''
+      password ||= ''
       result = nil
       calc_time = Clock.realtime do
         matches = @omnimatch.matches(password, user_inputs)

data/lib/zxcvbn/score.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zxcvbn
   class Score
     attr_accessor :entropy, :crack_time, :crack_time_display, :score, :pattern,
@@ -12,4 +14,4 @@ module Zxcvbn
       @password           = options[:password]
     end
   end
-end
+end

data/lib/zxcvbn/scorer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zxcvbn/entropy'
 require 'zxcvbn/crack_time'
 require 'zxcvbn/score'
@@ -16,19 +18,22 @@ module Zxcvbn
 
     def minimum_entropy_match_sequence(password, matches)
       bruteforce_cardinality = bruteforce_cardinality(password) # e.g. 26 for lowercase
-      up_to_k = []      # minimum entropy up to k.
-      backpointers = [] # for the optimal sequence of matches up to k, holds the final match (match.j == k). null means the sequence ends w/ a brute-force character.
+      up_to_k = [] # minimum entropy up to k.
+      # for the optimal sequence of matches up to k, holds the final match (match.j == k).
+      # null means the sequence ends w/ a brute-force character.
+      backpointers = []
       (0...password.length).each do |k|
         # starting scenario to try and beat: adding a brute-force character to the minimum entropy sequence at k-1.
-        previous_k_entropy = k > 0 ? up_to_k[k-1] : 0
+        previous_k_entropy = k.positive? ? up_to_k[k - 1] : 0
         up_to_k[k] = previous_k_entropy + lg(bruteforce_cardinality)
         backpointers[k] = nil
         matches.select do |match|
           match.j == k
         end.each do |match|
-          i, j = match.i, match.j
+          i = match.i
+          j = match.j
           # see if best entropy up to i-1 + entropy of this match is less than the current minimum at j.
-          previous_i_entropy = i > 0 ? up_to_k[i-1] : 0
+          previous_i_entropy = i.positive? ? up_to_k[i - 1] : 0
           candidate_entropy = previous_i_entropy + calc_entropy(match)
           if up_to_k[j] && candidate_entropy < up_to_k[j]
             up_to_k[j] = candidate_entropy
@@ -54,29 +59,26 @@ module Zxcvbn
       score_for(password, match_sequence, up_to_k)
     end
 
-    def score_for password, match_sequence, up_to_k
-      min_entropy = up_to_k[password.length - 1] || 0  # or 0 corner case is for an empty password ''
+    def score_for(password, match_sequence, up_to_k)
+      min_entropy = up_to_k[password.length - 1] || 0 # or 0 corner case is for an empty password ''
       crack_time = entropy_to_crack_time(min_entropy)
 
       # final result object
       Score.new(
-        :password => password,
-        :entropy => min_entropy.round(3),
-        :match_sequence => match_sequence,
-        :crack_time => crack_time.round(3),
-        :crack_time_display => display_time(crack_time),
-        :score => crack_time_to_score(crack_time)
+        password: password,
+        entropy: min_entropy.round(3),
+        match_sequence: match_sequence,
+        crack_time: crack_time.round(3),
+        crack_time_display: display_time(crack_time),
+        score: crack_time_to_score(crack_time)
       )
     end
 
-
     def pad_with_bruteforce_matches(match_sequence, password, bruteforce_cardinality)
       k = 0
       match_sequence_copy = []
       match_sequence.each do |match|
-        if match.i > k
-          match_sequence_copy << make_bruteforce_match(password, k, match.i - 1, bruteforce_cardinality)
-        end
+        match_sequence_copy << make_bruteforce_match(password, k, match.i - 1, bruteforce_cardinality) if match.i > k
         k = match.j + 1
         match_sequence_copy << match
       end
@@ -85,17 +87,18 @@ module Zxcvbn
       end
       match_sequence_copy
     end
+
     # fill in the blanks between pattern matches with bruteforce "matches"
     # that way the match sequence fully covers the password:
     # match1.j == match2.i - 1 for every adjacent match1, match2.
     def make_bruteforce_match(password, i, j, bruteforce_cardinality)
       Match.new(
-        :pattern => 'bruteforce',
-        :i => i,
-        :j => j,
-        :token => password[i..j],
-        :entropy => lg(bruteforce_cardinality ** (j - i + 1)),
-        :cardinality => bruteforce_cardinality
+        pattern: 'bruteforce',
+        i: i,
+        j: j,
+        token: password[i..j],
+        entropy: lg(bruteforce_cardinality**(j - i + 1)),
+        cardinality: bruteforce_cardinality
       )
     end
   end

data/lib/zxcvbn/tester.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "zxcvbn/data"
-require "zxcvbn/password_strength"
+require 'zxcvbn/data'
+require 'zxcvbn/password_strength'
 
 module Zxcvbn
   # Allows you to test the strength of multiple passwords without reading and

data/lib/zxcvbn/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Zxcvbn
-  VERSION = '1.2.1'
+  VERSION = '1.2.3'
 end

data/lib/zxcvbn.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'zxcvbn/version'
 require 'zxcvbn/tester'
 
 module Zxcvbn
-  extend self
+  module_function
 
-  DATA_PATH = Pathname(File.expand_path('../../data', __FILE__))
+  DATA_PATH = Pathname(File.expand_path('../data', __dir__))
 
   # Returns a Zxcvbn::Score for the given password
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zxcvbn-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.3
 platform: ruby
 authors:
 - Steve Hodgkiss
@@ -9,35 +9,7 @@ authors:
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: mini_racer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+dependencies: []
 description: Ruby port of Dropboxs zxcvbn.js
 email:
 - steve@hodgkiss.me