Class: AlfonsoX::SpellChecker::Word

Inherits:

Object

• Object
• AlfonsoX::SpellChecker::Word

Defined in:

lib/alfonsox/spellchecker/word.rb

Overview

Each of the spell-checked words

Instance Attribute Summary

• #line ⇒ Object readonly

  Returns the value of attribute line.

• #word ⇒ Object readonly

  Returns the value of attribute word.

Instance Method Summary

• #check ⇒ Boolean

  Check if the word is right.

• #initialize(word, line, dictionaries) ⇒ Word constructor

  Initialize a spell-checked word.

Constructor Details

#initialize(word, line, dictionaries) ⇒ Word

Initialize a spell-checked word.

Parameters:

• word (String) —

  Word to be spell-checked.

• line (Integer) —

  Line number this word belongs to.

• dictionaries (Array<AlfonsoX::SpellChecker::Dictionary::Hunspell, AlfonsoX::SpellChecker::Dictionary::Rubymine>) —

  Array of dictionaries that will be used to check if this word spelling is right.

# File 'lib/alfonsox/spellchecker/word.rb', line 15

def initialize(word, line, dictionaries)
  @word = word
  @line = line
  @dictionaries = dictionaries
  @right = nil
end

Instance Attribute Details

#line ⇒ Object (readonly)

Returns the value of attribute line.

# File 'lib/alfonsox/spellchecker/word.rb', line 8

def line
  @line
end

#word ⇒ Object (readonly)

Returns the value of attribute word.

# File 'lib/alfonsox/spellchecker/word.rb', line 8

def word
  @word
end

Instance Method Details

#check ⇒ Boolean

Check if the word is right. Assigns the Word#right attribute.

Returns:

• (Boolean) —

  true if the word is rightfully written, false otherwise.

# File 'lib/alfonsox/spellchecker/word.rb', line 25

def check
  @dictionaries.each do |dictionary|
    @right = check_for_dictionary(dictionary)
    return true if @right
  end
  false
end