How to Create a File in Ruby: Simple Syntax and Example

In Ruby, you can create a file using File.open with the write mode 'w'. Inside the block, you can write content to the file using file.write. This method creates the file if it does not exist or overwrites it if it does.

Syntax

The basic syntax to create a file in Ruby is:

• File.open('filename', 'w') do |file|: Opens or creates a file named 'filename' in write mode.
• file.write('content'): Writes the given content to the file.
• The block ensures the file is properly closed after writing.

ruby

File.open('example.txt', 'w') do |file|
  file.write('Hello, Ruby!')
end

Example

This example creates a file named greeting.txt and writes the text Hello, world! inside it.

ruby

File.open('greeting.txt', 'w') do |file|
  file.write('Hello, world!')
end

puts "File 'greeting.txt' created with content."

Output

File 'greeting.txt' created with content.

Common Pitfalls

Common mistakes when creating files in Ruby include:

• Using the wrong mode like 'r' which is read-only and will cause an error if the file does not exist.
• Not closing the file, which can happen if you don't use a block with File.open.
• Overwriting existing files unintentionally by using 'w' mode instead of 'a' (append) mode.

ruby

begin
  # Wrong mode: 'r' for reading only
  File.open('newfile.txt', 'r') do |file|
    file.write('This will fail')
  end
rescue => e
  puts "Error: #{e.message}"
end

# Correct way to create or overwrite
File.open('newfile.txt', 'w') do |file|
  file.write('This works')
end

Output

Error: No such file or directory @ rb_sysopen - newfile.txt

Quick Reference

Mode	Description
'w'	Write mode: creates file or overwrites existing file
'a'	Append mode: adds content to the end of the file
'r'	Read mode: opens file for reading only (file must exist)
'w+'	Read-write mode: creates or overwrites file
'a+'	Read-append mode: creates file if missing, appends content

Key Takeaways

Use File.open with 'w' mode to create or overwrite a file in Ruby.

Always use a block with File.open to ensure the file closes automatically.

Avoid using 'r' mode to create files as it requires the file to exist.

Use 'a' mode to add content without deleting existing data.

Check for errors when working with files to handle missing files or permission issues.