Dir operations for directories in Ruby - Step-by-Step Execution

Concept Flow - Dir operations for directories

Start

↓

Open Directory

↓

Read Entries

↓

Process Each Entry

↓

Close Directory

↓

End

This flow shows how Ruby opens a directory, reads its entries one by one, processes them, and then closes the directory.

Execution Sample

Ruby

Dir.open("./") do |dir|
  dir.each do |entry|
    puts entry
  end
end

This code opens the current directory, reads each entry inside it, and prints the entry name.

Execution Table

Step	Action	Directory State	Entry Read	Output
1	Open directory './'	Directory opened, ready to read
2	Read first entry	Entries unread: all	"."	Prints '.' (current directory)
3	Read second entry	Entries unread: all except '.'	".."	Prints '..' (parent directory)
4	Read third entry	Entries unread: all except '.' and '..'	"file1.txt"	Prints 'file1.txt'
5	Read fourth entry	Entries unread: all except '.', '..', 'file1.txt'	"subdir"	Prints 'subdir'
6	No more entries	All entries read		End loop
7	Close directory	Directory closed

💡 All directory entries have been read and printed, directory closed.

Variable Tracker

Variable	Start	After Step 2	After Step 3	After Step 4	After Step 5	Final
entry	nil	"."	".."	"file1.txt"	"subdir"	nil

Key Moments - 3 Insights

Why do we see '.' and '..' as entries when reading a directory?

The '.' entry means the current directory and '..' means the parent directory. They are always present and shown in the execution_table rows 2 and 3.

What happens if we forget to close the directory?

Not closing the directory can cause resource leaks. In the example, the 'Dir.open' block automatically closes it at step 7, ensuring safety.

Can we use 'Dir.entries' instead of 'Dir.open' and 'each'?

Yes, 'Dir.entries' returns an array of entries at once. But 'Dir.open' with 'each' reads entries one by one, which is better for large directories.

Visual Quiz - 3 Questions

Look at the execution_table, what is the value of 'entry' at Step 4?

A "file1.txt"

B ".."

C "subdir"

D "."

💡 Hint

Check the 'Entry Read' column at Step 4 in the execution_table.

At which step does the directory close?

A Step 5

B Step 6

C Step 7

D Step 4

💡 Hint

Look for the 'Close directory' action in the execution_table.

If the directory had no files, what would happen in the loop?

A It would cause an error

B It would print only '.' and '..'

C It would print nothing

D It would print 'nil'

💡 Hint

Remember '.' and '..' always exist as shown in Steps 2 and 3.

Concept Snapshot

Dir operations in Ruby:
- Use Dir.open(path) { |dir| ... } to open directory safely
- Use dir.each to read entries one by one
- Entries include '.' (current) and '..' (parent)
- Directory auto-closes after block ends
- Useful for processing files step-by-step

Full Transcript

This visual trace shows how Ruby handles directory operations using Dir.open and reading entries with each. First, the directory './' is opened. Then entries are read one by one: '.', '..', 'file1.txt', and 'subdir'. Each entry is printed. After all entries are read, the directory is closed automatically. The variable 'entry' changes each step to hold the current entry name. Beginners often wonder why '.' and '..' appear; these represent the current and parent directories. Closing the directory is important to avoid resource leaks, and using the block form of Dir.open ensures this happens automatically. This method is efficient for large directories because it reads entries one at a time.

Practice

1. Which Ruby method lists all files and folders inside a directory including . and ..?

easy

A. Dir.chdir

B. Dir.mkdir

C. Dir.exist?

D. Dir.entries

Solution

1. Step 1: Understand the purpose of Dir.entries

   This method returns an array of all entries in the directory, including special entries . and ...

2. Step 2: Compare with other methods

   Dir.mkdir creates a directory, Dir.exist? checks if a directory exists, and Dir.chdir changes the current directory. None of these list contents.

3. Final Answer:

   Dir.entries -> Option D

4. Quick Check:

   List directory contents = Dir.entries [OK]

Hint: Use Dir.entries to list all files and folders [OK]

Common Mistakes:

• Confusing Dir.entries with Dir.mkdir
• Using Dir.exist? to list files
• Thinking Dir.chdir lists directory contents

2. Which of the following is the correct syntax to create a new directory named test_folder in Ruby?

easy

A. Dir.mkdir('test_folder')

B. Dir.create('test_folder')

C. Dir.make('test_folder')

D. Dir.new('test_folder')

Solution

1. Step 1: Recall the method to create directories

   The correct Ruby method to create a directory is Dir.mkdir.

2. Step 2: Check syntax correctness

   Dir.mkdir('test_folder') correctly creates a directory named 'test_folder'. Other options are invalid methods.

3. Final Answer:

   Dir.mkdir('test_folder') -> Option A

4. Quick Check:

   Create directory = Dir.mkdir [OK]

Hint: Use Dir.mkdir('folder_name') to create directories [OK]

Common Mistakes:

• Using Dir.create instead of Dir.mkdir
• Trying Dir.new for directory creation
• Misspelling method names

3. What will be the output of the following Ruby code?

Dir.mkdir('sample_dir') unless Dir.exist?('sample_dir')
entries = Dir.entries('sample_dir')
puts entries.inspect

medium

A. []

B. ["sample_dir"]

C. [".", ".."]

D. Error: Directory not found

Solution

1. Step 1: Check directory creation and existence

   The code creates 'sample_dir' if it does not exist, so the directory will exist before listing entries.

2. Step 2: Understand Dir.entries output for empty directory

   An empty directory still contains special entries: . (current directory) and .. (parent directory). So, Dir.entries returns [".", ".."].

3. Final Answer:

   [".", ".."] -> Option C

4. Quick Check:

   Empty directory entries = [".", ".."] [OK]

Hint: Empty dirs always show '.' and '..' in Dir.entries [OK]

Common Mistakes:

• Expecting empty array for empty directory
• Thinking directory name appears in entries
• Assuming error if directory just created

4. Identify the error in this Ruby code snippet that tries to remove a directory:

Dir.rmdir('my_folder')
puts 'Folder removed'

medium

A. Dir.rmdir only removes non-empty directories

B. Dir.rmdir requires the directory to be empty before removal

C. Dir.rmdir should be Dir.remove

D. Dir.rmdir needs a block to execute

Solution

1. Step 1: Understand Dir.rmdir behavior

   Dir.rmdir removes only empty directories. If 'my_folder' contains files or folders, it will raise an error.

2. Step 2: Check other options for correctness

   Dir.rmdir only removes non-empty directories is wrong because it says the opposite. Dir.rmdir should be Dir.remove is invalid method name. Dir.rmdir needs a block to execute is incorrect; no block needed.

3. Final Answer:

   Dir.rmdir requires the directory to be empty before removal -> Option B

4. Quick Check:

   Dir.rmdir removes empty dirs only [OK]

Hint: Dir.rmdir only deletes empty directories [OK]

Common Mistakes:

• Trying to remove non-empty directories with Dir.rmdir
• Using wrong method name like Dir.remove
• Expecting Dir.rmdir to accept a block

5. You want to change the current working directory to projects, create a new folder new_app inside it, and then list the contents of projects. Which sequence of Ruby commands correctly does this?

hard

A. Dir.chdir('projects')
Dir.mkdir('new_app')
puts Dir.entries('.')

B. Dir.mkdir('new_app')
Dir.chdir('projects')
puts Dir.entries('new_app')

C. Dir.entries('projects')
Dir.mkdir('new_app')
Dir.chdir('new_app')

D. Dir.chdir('new_app')
Dir.mkdir('projects')
puts Dir.entries('.')

Solution

1. Step 1: Change directory to 'projects'

   Using Dir.chdir('projects') sets the current directory to 'projects'.

2. Step 2: Create 'new_app' inside 'projects'

   Dir.mkdir('new_app') creates the new folder inside the current directory.

3. Step 3: List contents of current directory

   Dir.entries('.') lists all files and folders inside 'projects', including 'new_app'.

4. Final Answer:

   Dir.chdir('projects') Dir.mkdir('new_app') puts Dir.entries('.') -> Option A

5. Quick Check:

   Change dir, create folder, list contents = Dir.chdir('projects') Dir.mkdir('new_app') puts Dir.entries('.') [OK]

Hint: Change dir first, then create folder, then list with Dir.entries('.') [OK]

Common Mistakes:

• Creating folder before changing directory
• Listing wrong directory contents
• Changing to new folder before creating it