Class: SecID::Suggestion

Inherits:

Data

• Object
• Data
• SecID::Suggestion

Defined in:

lib/sec_id/suggestion.rb,
lib/sec_id/suggestion.rb

Overview

Reopened to add the domain enumerations and serialization helpers per the repo convention (see Base#as_json).

Constant Summary

EDIT_KINDS =

The edit kinds edit can take, in rank order (see SecID::Suggestable::RANK).

%i[substitution transposition checksum].freeze

CONFIDENCE_LEVELS =

The non-nil confidence tiers confidence can take; :checksum candidates carry nil.

%i[high medium].freeze

Instance Attribute Summary

• #confidence ⇒ Symbol^? readonly

  :high (homoglyph), :medium (transposition), or nil (:checksum).

• #edit ⇒ Symbol readonly

  :substitution, :transposition, or :checksum.

• #from ⇒ String readonly

  The original character(s).

• #identifier ⇒ SecID::Base readonly

  The valid, parsed corrected identifier.

• #position ⇒ Integer^? readonly

  The edit position (nil for :checksum).

• #to ⇒ String readonly

  The replacement character(s).

• #type ⇒ Symbol readonly

  The identifier type key (e.g. :isin).

Instance Method Summary

• #as_json ⇒ Hash

  The symbol-keyed field hash (JSON-compatible).

• #to_s ⇒ String

  The corrected identifier string.

Instance Attribute Details

#confidence ⇒ Symbol^? (readonly)

Returns :high (homoglyph), :medium (transposition), or nil (:checksum).

Returns:

• (Symbol, nil) —

  :high (homoglyph), :medium (transposition), or nil (:checksum)

# File 'lib/sec_id/suggestion.rb', line 38

Suggestion = Data.define(:type, :identifier, :edit, :position, :from, :to, :confidence)

#edit ⇒ Symbol (readonly)

Returns :substitution, :transposition, or :checksum.

Returns:

• (Symbol) —

  :substitution, :transposition, or :checksum

# File 'lib/sec_id/suggestion.rb', line 38

Suggestion = Data.define(:type, :identifier, :edit, :position, :from, :to, :confidence)

#from ⇒ String (readonly)

Returns the original character(s).

Returns:

• (String) —

  the original character(s)

# File 'lib/sec_id/suggestion.rb', line 38

Suggestion = Data.define(:type, :identifier, :edit, :position, :from, :to, :confidence)

#identifier ⇒ SecID::Base (readonly)

Returns the valid, parsed corrected identifier.

Returns:

• (SecID::Base) —

  the valid, parsed corrected identifier

# File 'lib/sec_id/suggestion.rb', line 38

Suggestion = Data.define(:type, :identifier, :edit, :position, :from, :to, :confidence)

#position ⇒ Integer^? (readonly)

Returns the edit position (nil for :checksum).

Returns:

• (Integer, nil) —

  the edit position (nil for :checksum)

# File 'lib/sec_id/suggestion.rb', line 38

Suggestion = Data.define(:type, :identifier, :edit, :position, :from, :to, :confidence)

#to ⇒ String (readonly)

Returns the replacement character(s).

Returns:

• (String) —

  the replacement character(s)

# File 'lib/sec_id/suggestion.rb', line 38

Suggestion = Data.define(:type, :identifier, :edit, :position, :from, :to, :confidence)

#type ⇒ Symbol (readonly)

Returns the identifier type key (e.g. :isin).

Returns:

• (Symbol) —

  the identifier type key (e.g. :isin)

# File 'lib/sec_id/suggestion.rb', line 38

Suggestion = Data.define(:type, :identifier, :edit, :position, :from, :to, :confidence)

Instance Method Details

#as_json ⇒ Hash

Returns the symbol-keyed field hash (JSON-compatible).

Returns:

• (Hash) —

  the symbol-keyed field hash (JSON-compatible)

# File 'lib/sec_id/suggestion.rb', line 50

def as_json(*)
  to_h
end

#to_s ⇒ String

Returns the corrected identifier string.

Returns:

• (String) —

  the corrected identifier string

# File 'lib/sec_id/suggestion.rb', line 55

def to_s
  identifier.to_s
end