zxcvbn-ruby 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36aa566fe4268e91239c2232628e3eb7397cdf06c99608efa63670842a5b5b4c
-  data.tar.gz: 8c736d0a2f84507600e9ba3da51a368f056c2e8918672238415f636bffcd6ca3
+  metadata.gz: 43a759e1040848c8da4bea8d1e871eb7d811d5cab0ebf962255990963b796f75
+  data.tar.gz: c78d0453bb8c92d1f3b21c37f1493f305a6667f24e6ae85a621841a9396fb584
 SHA512:
-  metadata.gz: f569dc2cee3a3eee7c8b1adad5f924d74c0b5d2aac11eb61ec4e3330f3043f89d5543a74f073b508b0820bde71e0473b7e096c4d10138fb459fd90dcd7461667
-  data.tar.gz: f5873e8cdf377c6e30097025c5e8b3c02a4a8c65da2fd2051ef14791ee0123a8224e1c1627a0559338e1e16aa6808e1691afd3d00515057ba79732c62737247a
+  metadata.gz: 552d40a11c071613eefb14819b4dabbd3abc6a1f2d336e6bf9bfbc873a34640a229b3bedcc0bd77aca6ffe5e43e31fefec74fe94d74f3cdaebd4e7169610ec02
+  data.tar.gz: 84c006df22e0224da4a891f8fa923c81b69229f2b99e5d60ba29104473e566c83a36fbcc404defe980d80cfb176964864f00dbdfa02d655e05eaac7753e64360

data/CHANGELOG.md

@@ -6,7 +6,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-[Unreleased]: https://github.com/envato/zxcvbn-ruby/compare/v1.3.0...HEAD
+[Unreleased]: https://github.com/envato/zxcvbn-ruby/compare/v1.4.0...HEAD
+
+## [1.4.0] - 2026-01-15
+
+### Added
+ - RBS type signatures for improved type checking and IDE support ([#68])
+
+### Changed
+ - Minor fixups in gem metadata ([#67]).
+
+[1.4.0]: https://github.com/envato/zxcvbn-ruby/compare/v1.3.0...v1.4.0
+[#67]: https://github.com/envato/zxcvbn-ruby/pull/67
+[#68]: https://github.com/envato/zxcvbn-ruby/pull/68
 
 ## [1.3.0] - 2026-01-02
 

data/lib/zxcvbn/version.rb

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

data/sig/README.md

@@ -0,0 +1,65 @@
+# RBS Type Signatures
+
+This directory contains [RBS](https://github.com/ruby/rbs) type signatures for the zxcvbn-ruby gem.
+
+## What is RBS?
+
+RBS is Ruby's type signature language. It provides a way to describe the structure of Ruby programs with:
+- Class and module definitions
+- Method signatures with parameter and return types
+- Instance variables and constants
+- Duck typing and union types
+
+## Usage
+
+### Validating Type Signatures
+
+To validate that the RBS files are syntactically correct:
+
+```bash
+bundle exec rake rbs:validate
+```
+
+### Runtime Type Checking
+
+To run runtime type checking against the actual Ruby code during tests:
+
+```bash
+bundle exec rake rbs:test
+```
+
+This runs the RSpec test suite with RBS type checking enabled, verifying that method calls match their type signatures at runtime. Note: This takes about 2 minutes to run.
+
+### Other Useful Commands
+
+List all Zxcvbn types:
+```bash
+bundle exec rake rbs:list
+```
+
+Check syntax of RBS files:
+```bash
+bundle exec rake rbs:parse
+```
+
+## File Structure
+
+The signatures mirror the structure of the `lib/` directory:
+
+- `sig/zxcvbn.rbs` - Main Zxcvbn module
+- `sig/zxcvbn/*.rbs` - Core classes (Tester, Score, Match, etc.)
+- `sig/zxcvbn/matchers/*.rbs` - Pattern matcher classes
+
+## Adding New Signatures
+
+When adding new classes or methods to the codebase, remember to:
+
+1. Create or update the corresponding `.rbs` file in the `sig/` directory
+2. Run `bundle exec rake rbs_validate` to ensure the syntax is correct
+3. Keep type signatures in sync with the actual implementation
+
+## Resources
+
+- [RBS Documentation](https://github.com/ruby/rbs)
+- [RBS Syntax Guide](https://github.com/ruby/rbs/blob/master/docs/syntax.md)
+- [Ruby Signature Collection](https://github.com/ruby/gem_rbs_collection)

data/sig/zxcvbn/crack_time.rbs

@@ -0,0 +1,13 @@
+module Zxcvbn
+  module CrackTime
+    SINGLE_GUESS: Float
+    NUM_ATTACKERS: Integer
+    SECONDS_PER_GUESS: Float
+
+    def entropy_to_crack_time: (Numeric entropy) -> Float
+
+    def crack_time_to_score: (Numeric seconds) -> Integer
+
+    def display_time: (Numeric seconds) -> String
+  end
+end

data/sig/zxcvbn/data.rbs

@@ -0,0 +1,31 @@
+module Zxcvbn
+  class Data
+    type ranked_dictionary = Hash[String, Integer]
+    type adjacency_graph = Hash[String, Array[String?]]
+    type graph_stats = Hash[String, { average_degree: Float, starting_positions: Integer }]
+
+    @ranked_dictionaries: Hash[String, ranked_dictionary]
+    @adjacency_graphs: Hash[String, adjacency_graph]
+    @dictionary_tries: Hash[String, Trie]
+    @graph_stats: graph_stats
+
+    attr_reader ranked_dictionaries: Hash[String, ranked_dictionary]
+    attr_reader adjacency_graphs: Hash[String, adjacency_graph]
+    attr_reader dictionary_tries: Hash[String, Trie]
+    attr_reader graph_stats: graph_stats
+
+    def initialize: () -> void
+
+    def add_word_list: (String name, Array[String] list) -> void
+
+    private
+
+    def read_word_list: (String file) -> Array[String]
+
+    def build_tries: () -> Hash[String, Trie]
+
+    def build_trie: (ranked_dictionary ranked_dictionary) -> Trie
+
+    def compute_graph_stats: () -> graph_stats
+  end
+end

data/sig/zxcvbn/dictionary_ranker.rbs

@@ -0,0 +1,7 @@
+module Zxcvbn
+  class DictionaryRanker
+    def self.rank_dictionaries: (Hash[String | Symbol, Array[String]] lists) -> Hash[String | Symbol, Hash[String, Integer]]
+
+    def self.rank_dictionary: (Array[String] words) -> Hash[String, Integer]
+  end
+end

data/sig/zxcvbn/entropy.rbs

@@ -0,0 +1,33 @@
+module Zxcvbn
+  module Entropy
+    include Zxcvbn::Math
+
+    def calc_entropy: (Match match) -> Float
+
+    def repeat_entropy: (Match match) -> Float
+
+    def sequence_entropy: (Match match) -> Float
+
+    def digits_entropy: (Match match) -> Float
+
+    def year_entropy: (Match? match) -> Float
+
+    def date_entropy: (Match match) -> Float
+
+    def dictionary_entropy: (Match match) -> Float
+
+    def extra_uppercase_entropy: (Match match) -> Numeric
+
+    def extra_l33t_entropy: (Match match) -> Numeric
+
+    def spatial_entropy: (Match match) -> Float
+
+    NUM_YEARS: Integer
+    NUM_MONTHS: Integer
+    NUM_DAYS: Integer
+    START_UPPER: Regexp
+    END_UPPER: Regexp
+    ALL_UPPER: Regexp
+    ALL_LOWER: Regexp
+  end
+end

data/sig/zxcvbn/feedback.rbs

@@ -0,0 +1,8 @@
+module Zxcvbn
+  class Feedback
+    attr_accessor warning: String?
+    attr_accessor suggestions: Array[String]
+
+    def initialize: (?warning: String?, ?suggestions: Array[String]) -> void
+  end
+end

data/sig/zxcvbn/feedback_giver.rbs

@@ -0,0 +1,13 @@
+module Zxcvbn
+  class FeedbackGiver
+    NAME_DICTIONARIES: Array[String]
+    DEFAULT_FEEDBACK: Feedback
+    EMPTY_FEEDBACK: Feedback
+
+    def self.get_feedback: (Integer? score, Array[Match] sequence) -> Feedback
+
+    def self.get_match_feedback: (Match match, bool is_sole_match) -> Feedback?
+
+    def self.get_dictionary_match_feedback: (Match match, bool is_sole_match) -> Feedback
+  end
+end

data/sig/zxcvbn/match.rbs

@@ -0,0 +1,38 @@
+module Zxcvbn
+  class Match
+    attr_accessor pattern: String?
+    attr_accessor i: Integer?
+    attr_accessor j: Integer?
+    attr_accessor token: String?
+    attr_accessor matched_word: String?
+    attr_accessor rank: Integer?
+    attr_accessor dictionary_name: String?
+    attr_accessor reversed: bool?
+    attr_accessor l33t: bool?
+    attr_accessor sub: Hash[String, String]?
+    attr_accessor sub_display: String?
+    attr_accessor l: Integer?
+    attr_accessor entropy: Numeric?
+    attr_accessor base_entropy: Numeric?
+    attr_accessor uppercase_entropy: Numeric?
+    attr_accessor l33t_entropy: Numeric?
+    attr_accessor repeated_char: String?
+    attr_accessor sequence_name: String?
+    attr_accessor sequence_space: Integer?
+    attr_accessor ascending: bool?
+    attr_accessor graph: String?
+    attr_accessor turns: Integer?
+    attr_accessor shifted_count: Integer?
+    attr_accessor shiffted_count: Integer?
+    attr_accessor year: Integer?
+    attr_accessor month: Integer?
+    attr_accessor day: Integer?
+    attr_accessor separator: String?
+    attr_accessor cardinality: Integer?
+    attr_accessor offset: Integer?
+
+    def initialize: (**untyped attributes) -> void
+
+    def to_hash: () -> Hash[String, untyped]
+  end
+end

data/sig/zxcvbn/math.rbs

@@ -0,0 +1,13 @@
+module Zxcvbn
+  module Math
+    def bruteforce_cardinality: (String password) -> Integer
+
+    def lg: (Numeric n) -> Float
+
+    def nCk: (Integer n, Integer k) -> Integer
+
+    def average_degree_for_graph: (String graph_name) -> Float
+
+    def starting_positions_for_graph: (String graph_name) -> Integer
+  end
+end

data/sig/zxcvbn/omnimatch.rbs

@@ -0,0 +1,16 @@
+module Zxcvbn
+  class Omnimatch
+    @data: Data
+    @matchers: Array[untyped]
+
+    def initialize: (Data data) -> void
+
+    def matches: (String password, ?Array[String] user_inputs) -> Array[Match]
+
+    private
+
+    def user_input_matchers: (Array[String] user_inputs) -> Array[untyped]
+
+    def build_matchers: () -> Array[untyped]
+  end
+end

data/sig/zxcvbn/password_strength.rbs

@@ -0,0 +1,10 @@
+module Zxcvbn
+  class PasswordStrength
+    @omnimatch: Omnimatch
+    @scorer: Scorer
+
+    def initialize: (Data data) -> void
+
+    def test: (String? password, ?Array[untyped] user_inputs) -> Score
+  end
+end

data/sig/zxcvbn/score.rbs

@@ -0,0 +1,15 @@
+module Zxcvbn
+  class Score
+    attr_accessor entropy: Numeric?
+    attr_accessor crack_time: Numeric?
+    attr_accessor crack_time_display: String?
+    attr_accessor score: Integer?
+    attr_accessor pattern: String?
+    attr_accessor match_sequence: Array[Match]?
+    attr_accessor password: String?
+    attr_accessor calc_time: Float?
+    attr_accessor feedback: Feedback?
+
+    def initialize: (?entropy: Numeric?, ?crack_time: Numeric?, ?crack_time_display: String?, ?score: Integer?, ?match_sequence: Array[Match]?, ?password: String?) -> void
+  end
+end

data/sig/zxcvbn/scorer.rbs

@@ -0,0 +1,20 @@
+module Zxcvbn
+  class Scorer
+    include Entropy
+    include CrackTime
+
+    @data: Data
+
+    attr_reader data: Data
+
+    def initialize: (Data data) -> void
+
+    def minimum_entropy_match_sequence: (String password, Array[Match] matches) -> Score
+
+    def score_for: (String password, Array[Match] match_sequence, Array[Float] up_to_k) -> Score
+
+    def pad_with_bruteforce_matches: (Array[Match] match_sequence, String password, Integer bruteforce_cardinality) -> Array[Match]
+
+    def make_bruteforce_match: (String password, Integer i, Integer j, Integer bruteforce_cardinality) -> Match
+  end
+end

data/sig/zxcvbn/tester.rbs

@@ -0,0 +1,17 @@
+module Zxcvbn
+  class Tester
+    @data: Data
+
+    def initialize: () -> void
+
+    def test: (String? password, ?Array[untyped] user_inputs) -> Score
+
+    def add_word_lists: (Hash[String, Array[untyped]] lists) -> void
+
+    def inspect: () -> String
+
+    private
+
+    def sanitize: (Array[untyped] user_inputs) -> Array[String]
+  end
+end

data/sig/zxcvbn/trie.rbs

@@ -0,0 +1,13 @@
+module Zxcvbn
+  class Trie
+    type node = Hash[untyped, untyped]
+
+    @root: node
+
+    def initialize: () -> void
+
+    def insert: (String word, Integer rank) -> void
+
+    def search_prefixes: (String text, Integer start_pos) -> Array[[String, Integer?, Integer, Integer]]
+  end
+end

data/sig/zxcvbn.rbs

@@ -0,0 +1,10 @@
+module Zxcvbn
+  VERSION: String
+
+  DATA_PATH: Pathname
+
+  type word_list = Hash[String, Array[String]]
+  type user_inputs = Array[String]
+
+  def self.test: (String? password, ?user_inputs user_inputs, ?word_list word_lists) -> Score
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zxcvbn-ruby
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Steve Hodgkiss
@@ -54,15 +54,32 @@ files:
 - lib/zxcvbn/tester.rb
 - lib/zxcvbn/trie.rb
 - lib/zxcvbn/version.rb
-homepage: http://github.com/envato/zxcvbn-ruby
+- sig/README.md
+- sig/zxcvbn.rbs
+- sig/zxcvbn/crack_time.rbs
+- sig/zxcvbn/data.rbs
+- sig/zxcvbn/dictionary_ranker.rbs
+- sig/zxcvbn/entropy.rbs
+- sig/zxcvbn/feedback.rbs
+- sig/zxcvbn/feedback_giver.rbs
+- sig/zxcvbn/match.rbs
+- sig/zxcvbn/math.rbs
+- sig/zxcvbn/omnimatch.rbs
+- sig/zxcvbn/password_strength.rbs
+- sig/zxcvbn/score.rbs
+- sig/zxcvbn/scorer.rbs
+- sig/zxcvbn/tester.rbs
+- sig/zxcvbn/trie.rbs
+homepage: https://github.com/envato/zxcvbn-ruby
 licenses:
 - MIT
 metadata:
+  allowed_push_host: https://rubygems.org
   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
+  documentation_uri: https://www.rubydoc.info/gems/zxcvbn-ruby/1.4.0
   homepage_uri: https://github.com/envato/zxcvbn-ruby
-  source_code_uri: https://github.com/envato/zxcvbn-ruby
+  source_code_uri: https://github.com/envato/zxcvbn-ruby/tree/v1.4.0
 rdoc_options: []
 require_paths:
 - lib
@@ -77,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.4
 specification_version: 4
 summary: ''
 test_files: []