Class: Zxcvbn::Feedback

Inherits:
Data
  • Object
show all
Defined in:
lib/zxcvbn/feedback.rb,
sig/zxcvbn/feedback.rbs

Overview

Human-readable feedback for a low-scoring password.

Constant Summary

Constants inherited from Data

Data::RESERVED_NAMES

Instance Attribute Summary collapse

Attributes inherited from Data

#adjacency_graphs, #dictionaries, #graph_stats

Instance Method Summary collapse

Methods inherited from Data

#add_word_list, #build_tries, #compute_graph_stats, #dictionary_tries, #inspect, #ranked_dictionaries, #read_word_list

Constructor Details

#initialize(warning: nil, suggestions: []) ⇒ Feedback

Returns a new instance of Feedback.

Parameters:

  • warning (String) (defaults to: nil) —

    warning message (default: empty string)

  • suggestions (Array<String>) (defaults to: []) —

    improvement tips (default: [])

  • warning: (String) (defaults to: nil)
  • suggestions: (Array[String]) (defaults to: []) 


13
14
15
 
# File 'lib/zxcvbn/feedback.rb', line 13

def initialize(warning: nil, suggestions: [])
  super(warning: warning || '', suggestions: suggestions.freeze)
end

Instance Attribute Details

#suggestions ⇒ Array<String> (readonly)

Returns ordered list of improvement tips.

Returns:

  • (Array<String>) —

    ordered list of improvement tips



10
11
12
13
14
15
16
 
# File 'lib/zxcvbn/feedback.rb', line 10

Feedback = ::Data.define(:warning, :suggestions) do
  # @param warning [String] warning message (default: empty string)
  # @param suggestions [Array<String>] improvement tips (default: [])
  def initialize(warning: nil, suggestions: [])
    super(warning: warning || '', suggestions: suggestions.freeze)
  end
end

#warning ⇒ String (readonly)

Returns a single warning message, or empty string.

Returns:

  • (String) —

    a single warning message, or empty string



10
11
12
13
14
15
16
 
# File 'lib/zxcvbn/feedback.rb', line 10

Feedback = ::Data.define(:warning, :suggestions) do
  # @param warning [String] warning message (default: empty string)
  # @param suggestions [Array<String>] improvement tips (default: [])
  def initialize(warning: nil, suggestions: [])
    super(warning: warning || '', suggestions: suggestions.freeze)
  end
end

Instance Method Details

#with ⇒ Feedback

Parameters:

  • warning: (String)
  • suggestions: (Array[String])

Returns:



8
 
# File 'sig/zxcvbn/feedback.rbs', line 8

def with: (?warning: String, ?suggestions: Array[String]) -> Feedback