support/file/file.go (3)

14-34: LGTM! Consider enhancing documentation.

The implementation follows the functional options pattern, which is idiomatic Go. The code is well-structured and clear.

Consider adding examples to the documentation to show how to use these options:

// WithMode sets the file mode for PutContent
//
// Example:
//
//	err := PutContent("file.txt", "content", WithMode(0644))

---

53-54: Enhance deprecation notice with migration example.

Good practice marking the function as deprecated while providing a migration path.

Consider enhancing the deprecation notice with a migration example:

// Deprecated: Use PutContent instead.
// Before: Create("file.txt", "content")
// After: PutContent("file.txt", "content")

---

Line range hint 1-1: Add package documentation.

Consider adding package-level documentation to describe the package's purpose and common usage patterns.

Add at the top of the file:

// Package file provides utilities for file operations in the Goravel framework,
// including reading, writing, and manipulating files with various options.
package file

support/file/file_test.go (2)

52-56: Use t.TempDir() for consistency.

For consistency with TestCreate and better test isolation, consider using t.TempDir().

-	pwd, _ := os.Getwd()
-	filePath := path.Join(pwd, "goravel/goravel.txt")
+	filePath := path.Join(t.TempDir(), "goravel.txt")
 	assert.Nil(t, Create(filePath, `goravel`))
 	assert.Nil(t, Remove(filePath))
-	assert.Nil(t, Remove(path.Join(pwd, "goravel")))

---

65-75: Use t.TempDir() for file testing.

Consider using t.TempDir() for testing successful file operations instead of relying on an existing file.

 func TestGetContent(t *testing.T) {
 	// file not exists
 	content, err := GetContent("files.go")
 	assert.NotNil(t, err)
 	assert.Empty(t, content)
+
 	// get content successfully
-	content, err = GetContent("../constant.go")
+	testFile := path.Join(t.TempDir(), "test.txt")
+	assert.NoError(t, PutContent(testFile, "const Version = 1"))
+	content, err = GetContent(testFile)
 	assert.Nil(t, err)
 	assert.NotNil(t, content)
 	assert.Contains(t, content, "const Version")
 }

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

support/file/file_test.go (2)

52-56: Consider using t.TempDir() for consistency.

While using path.Join is good, consider using t.TempDir() like in TestCreate for better test isolation and consistency.

-	pwd, _ := os.Getwd()
-	filePath := path.Join(pwd, "goravel/goravel.txt")
+	filePath := path.Join(t.TempDir(), "goravel.txt")

---

65-75: Consider using t.TempDir() for test data.

Instead of relying on existing files, create test files in a temporary directory for better test isolation and reliability.

-	content, err := GetContent("files.go")
+	content, err := GetContent(path.Join(t.TempDir(), "nonexistent.txt"))

-	content, err = GetContent("../constant.go")
+	testFile := path.Join(t.TempDir(), "test.txt")
+	assert.NoError(t, PutContent(testFile, "const Version = \"1.0.0\""))
+	content, err = GetContent(testFile)

support/file/file.go (1)

98-106: Add documentation for GetContent.

Consider adding a documentation comment explaining the function's purpose and error conditions.

+// GetContent reads the entire file and returns its content as a string.
+// It returns an error if the file doesn't exist or cannot be read.
 func GetContent(file string) (string, error) {

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

support/file/options.go (1)

5-11: Enhance documentation for Option type and struct.

The documentation could be more descriptive about the available options and their default values.

-// Option represents an option for FilePutContents
+// Option represents a configuration option for PutContent.
 type Option func(*option)
 
 type option struct {
+	// mode specifies the file permissions (default: os.ModePerm)
 	mode   os.FileMode
+	// append determines if content should be appended (default: false)
 	append bool
 }

support/file/file.go (3)

31-33: Enhance deprecation notice.

The deprecation notice should provide more context about migration.

-// Create a file with the given content
-// Deprecated: Use PutContent instead
+// Create creates a file with the given content.
+// Deprecated: Use PutContent instead, which provides more flexibility through options
+// such as file permissions and append mode.
 func Create(file string, content string) error {

---

76-84: Add error documentation for GetContent.

The function should document possible error conditions.

+// GetContent reads and returns the entire contents of the specified file as a string.
+// It returns an error if the file doesn't exist or cannot be read.
 func GetContent(file string) (string, error) {

---

109-147: LGTM! Well-structured PutContent implementation.

The implementation:

• Properly handles default options
• Creates directories if needed
• Uses appropriate file flags
• Has good error handling

However, consider adding comprehensive documentation:

+// PutContent creates or writes content to a file with configurable options.
+// It creates the parent directories if they don't exist.
+//
+// Options:
+//   - WithMode: sets file permissions (default: os.ModePerm)
+//   - WithAppend: enables append mode (default: false)
+//
+// Returns an error if:
+//   - Directory creation fails
+//   - File cannot be opened
+//   - Write operation fails
 func PutContent(file string, content string, options ...Option) error {

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

Learnt from: almas1992
PR: goravel/framework#824
File: support/file/file.go:0-0
Timestamp: 2025-01-21T05:37:10.012Z
Learning: In Go, making a file read-only (chmod 0400) will cause os.OpenFile to fail with a permission error before reaching any write operations. This approach cannot be used to test write failures in functions that use os.OpenFile followed by write operations.

support/file/file.go (3)

31-32: Enhance the deprecation notice.

While marking the function as deprecated is good, the notice could be more informative by including:

1. The version when it was deprecated
2. A code example showing how to migrate to PutContent

-// Create a file with the given content
-// Deprecated: Use PutContent instead
+// Create a file with the given content.
+// Deprecated: Use PutContent instead. For example:
+//   err := file.PutContent(filename, content)
+// This function will be removed in a future version.
 func Create(file string, content string) error {

---

76-84: Add documentation for the GetContent function.

While the implementation is correct, adding documentation would help users understand:

1. The function's purpose
2. Error conditions (e.g., file not found, permission issues)
3. Memory considerations for large files

+// GetContent reads and returns the entire content of a file as a string.
+// For large files, consider using os.OpenFile directly to avoid loading
+// the entire content into memory.
+// Returns an error if the file doesn't exist or cannot be read.
 func GetContent(file string) (string, error) {

---

109-147: Add comprehensive documentation for PutContent.

The implementation is well-structured, but adding documentation would help users understand:

1. The function's purpose and behavior
2. Available options and their defaults
3. Error conditions

+// PutContent writes the specified content to a file, creating it if it doesn't exist.
+// The function supports the following options:
+//   - WithMode(mode os.FileMode): Set file permissions (default: os.ModePerm)
+//   - WithAppend(append bool): Append to file instead of overwriting (default: false)
+// Returns an error if:
+//   - Directory creation fails
+//   - File cannot be opened
+//   - Write operation fails
 func PutContent(file string, content string, options ...Option) error {

🧰 Tools

🪛 GitHub Check: codecov/patch

[warning] 143-144: support/file/file.go#L143-L144
Added lines #L143 - L144 were not covered by tests

support/file/file_test.go (1)

66-76: Consider adding more test cases.

While the current test cases cover basic scenarios, consider adding:

1. Empty file test case
2. File with special characters
3. Large file handling test

 func TestGetContent(t *testing.T) {
+	// empty file
+	emptyFile := path.Join(t.TempDir(), "empty.txt")
+	assert.NoError(t, os.WriteFile(emptyFile, []byte{}, 0644))
+	content, err := GetContent(emptyFile)
+	assert.Nil(t, err)
+	assert.Empty(t, content)
+
 	// file not exists

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

Learnt from: almas1992
PR: goravel/framework#824
File: support/file/file.go:0-0
Timestamp: 2025-01-21T05:37:10.012Z
Learning: In Go, making a file read-only (chmod 0400) will cause os.OpenFile to fail with a permission error before reaching any write operations. This approach cannot be used to test write failures in functions that use os.OpenFile followed by write operations.