Class: AlfonsoX::SpellChecker::File

Inherits:

Object

• Object
• AlfonsoX::SpellChecker::File

Defined in:

lib/alfonsox/spellchecker/file.rb

Overview

Each one of the source code files we want to spell-check

Instance Attribute Summary

• #incorrect_words ⇒ Object readonly

  Returns the value of attribute incorrect_words.

Class Method Summary

• .word_splitter(word_line) ⇒ Array<String>

  Tokenize a line, i.e.

Instance Method Summary

• #initialize(file_path, dictionaries) ⇒ File constructor

  Initialize spellcheck on a file with some dictionaries.

• #spellcheck ⇒ Object

  Perform the spellcheck on the file.

Constructor Details

#initialize(file_path, dictionaries) ⇒ File

Initialize spellcheck on a file with some dictionaries

Parameters:

• file_path (String) —

  File path of the file to be spellchecked.

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

  Array of dictionaries, as constructed by AlfonsoX package.

# File 'lib/alfonsox/spellchecker/file.rb', line 16

def initialize(file_path, dictionaries)
  @file_path = file_path
  @dictionaries = dictionaries
  @incorrect_words = []
end

Instance Attribute Details

#incorrect_words ⇒ Object (readonly)

Returns the value of attribute incorrect_words.

# File 'lib/alfonsox/spellchecker/file.rb', line 10

def incorrect_words
  @incorrect_words
end

Class Method Details

.word_splitter(word_line) ⇒ Array<String>

Tokenize a line, i.e. split words of a line.

Parameters:

• word_line (String) —

  A line of a text.

Returns:

• (Array<String>) —

  Words of the word_line.

# File 'lib/alfonsox/spellchecker/file.rb', line 34

def self.word_splitter(word_line)
  word_line.split(/[_\-\s\d]+|(?<=[a-z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|\W+/).map(&:downcase)
end

Instance Method Details

#spellcheck ⇒ Object

Perform the spellcheck on the file

# File 'lib/alfonsox/spellchecker/file.rb', line 23

def spellcheck
  lines = ::File.open(@file_path).readlines
  lines.each_with_index do |line, line_index|
    check_line(line, line_index + 1)
  end
  @incorrect_words
end