Class: File

Inherits:
Object
  • Object
show all
Defined in:
lib/immosquare-extensions/file.rb

Class Method Summary collapse

Class Method Details

.normalize_last_line(file_path) ⇒ Object

##

This method ensures the file ends with a single newline, facilitating cleaner multi-line blocks. It operates by reading all lines of the file, removing any empty lines at the end, and then appending a newline. This guarantees the presence of a newline at the end, and also prevents multiple newlines from being present at the end.

Params:

file_path

The path to the file to be normalized.

Returns: The total number of lines in the normalized file.

##


16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/immosquare-extensions/file.rb', line 16

def self.normalize_last_line(file_path)
  end_of_line = $INPUT_RECORD_SEPARATOR || "\n"
  ##============================================================##
  ## Read all lines from the file
  ## https://gist.github.com/guilhermesimoes/d69e547884e556c3dc95
  ## Detect the encoding of the file using uchardet
  ## Read the content of the file with the detected encoding,
  ## falling back to UTF-8 if the detected encoding is empty or invalid.
  ##============================================================##
  detected_encoding = `uchardet #{file_path}`.strip
  encoding_to_use   = detected_encoding.empty? ? "UTF-8" : "#{detected_encoding}:UTF-8"
  content           = File.read(file_path, :encoding => encoding_to_use)

  ##===========================================================================##
  ## Remove all trailing empty lines at the end of the file
  ##===========================================================================##
  content.gsub!(/#{Regexp.escape(end_of_line)}+\z/, "")

  ##===========================================================================##
  ## Append an EOL at the end to maintain the file structure
  ##===========================================================================##
  content << end_of_line

  ##===========================================================================##
  ## Write the modified lines back to the file
  ##===========================================================================##
  File.write(file_path, content, :encoding => encoding_to_use)

  ##===========================================================================##
  ## Return the total number of lines in the modified file
  ##===========================================================================##
  content.lines.size
end