Use Pathname#write where possible

[tagliala]

Also refactor title to use Pathname#read instead of using the global
File.read

[tagliala]

Copilot chat

The functionality of the refactored code is largely the same, but it has been modified to use Pathname objects and their methods for file operations instead of string concatenation and the File class methods directly. Here is a detailed comparison and analysis for potential breaking changes:

lib/document.rb

1. Title Method:

   • Original:

     return '' unless File.exist?(directory + 'title')
     File.read(directory + 'title').chomp

   • Refactored:

     title_file = directory.join('title')
     return '' unless title_file.file?
     title_file.read.chomp

   • Functionality:
     • Both versions check for the existence of the file and read its contents.
   • Potential Breaking Changes: None. The refactored code should work the same as the original.

2. Title Setter Method:

   • Original:

     File.open(directory + 'title', 'w') { |f| f.puts new_title }

   • Refactored:

     directory.join('title').write new_title

   • Functionality:
     • Both versions write the new title to the file.
   • Potential Breaking Changes: None. Both methods achieve the same result.

3. Add File Method:

   • Original:

     File.write(directory + version + AUTHOR_FILE, author)

   • Refactored:

     directory.join(version, AUTHOR_FILE).write author

   • Functionality:
     • Both versions write the author information to the specified file.
   • Potential Breaking Changes: None. The functionality remains the same.

4. Save Metadata Method:

   • Original:

     File.open(directory + 'metadata.json', "w") do |f|
       f.puts JSON.pretty_generate(to_hash)
     end

   • Refactored:

     directory.join('metadata.json').write JSON.pretty_generate(to_hash)

   • Functionality:
     • Both versions write the JSON metadata to the file.
   • Potential Breaking Changes: None. The refactored code should behave the same as the original.

lib/tika_config.rb

1. Path For Method:
   • Original:

     File.write(file, format(TEMPLATE, language_alpha3: language_alpha3))

   • Refactored:

     file.write format(TEMPLATE, language_alpha3: language_alpha3)

   • Functionality:
     • Both versions write the formatted string to the file.
   • Potential Breaking Changes: None. The functionality remains unchanged.

Summary

The refactored code uses Pathname objects and their methods, which simplifies file operations and improves readability. There should be no breaking changes as the overall functionality and logic remain the same. Ensure that Pathname is required if not already done:

require 'pathname'

If Pathname is consistently used across the codebase, these changes should integrate smoothly without any issues.

[tagliala]

This pull request focuses on refactoring file operations to utilize the Pathname library for cleaner and more readable code. The most significant changes involve replacing File operations with Pathname methods across various methods in the lib/document.rb and lib/tika_config.rb files.

Refactoring file operations:

• lib/document.rb: Updated the title method to use Pathname for file checks and reads.
• lib/document.rb: Modified the title= method to use Pathname for writing the title.
• lib/document.rb: Updated the add_file method to use Pathname for writing author information.
• lib/document.rb: Refactored the save_metadata method to use Pathname for writing metadata.
• lib/tika_config.rb: Changed the path_for! method to use Pathname for writing configuration files.

Test adjustments:

• spec/lib/tika_config_spec.rb: Adjusted tests to mock FileUtils.mkdir_p instead of File.write.