dql, encoding: fs

[xushiwei]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @xushiwei, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the DQL (Data Query Language) capabilities by introducing a dedicated module for file system interactions, allowing for declarative querying and manipulation of files and directories. It also includes a refactoring effort to standardize internal function naming across existing DQL packages and updates the object handling in various encoding packages to use pointer types, ensuring more consistent and robust behavior.

Highlights

• New File System DQL Package: Introduced a new dql/fs package that provides Data Query Language (DQL) capabilities for interacting with file systems. This includes Node and NodeSet types to represent files/directories and collections thereof, respectively.
• File System Querying Methods: The dql/fs package now offers a rich set of methods for navigating and filtering file system nodes, such as Dir(), File(), XGo_Child(), XGo_Any(), and Match(), enabling declarative file system queries.
• NodeSet Utility Functions: Added various utility methods to NodeSet in dql/fs for data retrieval and manipulation, including All(), One(), Single(), First(), Collect(), Path(), Name(), IsDir(), Size(), Mode(), and ModTime().
• Refactored Internal Helper Functions: Renamed internal helper functions rangeChildNodes and rangeAnyNodes to yieldChildNodes and yieldAnyNodes across dql/html, dql/maps, dql/reflects, and dql/xml packages for improved consistency and clarity.
• Updated Encoding Package Type Aliases: Modified the Object type aliases and New function return types in encoding/golang, encoding/html, encoding/regexp, encoding/regexposix, encoding/xgo, and encoding/xml packages to use pointer types (e.g., *golang.File instead of golang.File), affecting how these objects are handled.
• New Encoding FS Package: Added a new encoding/fs package that provides a convenient New function to create an fs.NodeSet from a specified directory, serving as an entry point for file system DQL operations.
• File System DQL Demo: Included a new demo file demo/dql-fs/fsq.xgo to illustrate the usage of the new dql/fs package for finding and listing .xgo files within a directory.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• demo/dql-fs/fsq.xgo
  • Added a new demo file to showcase file system querying.
• dql/fs/fs.go
  • Added a new package for file system DQL operations, including Node and NodeSet types.
• dql/html/html.go
  • Renamed internal helper functions rangeChildNodes to yieldChildNodes.
  • Renamed internal helper functions rangeAnyNodes to yieldAnyNodes.
• dql/maps/maps.go
  • Renamed internal helper functions rangeChildNodes to yieldChildNodes.
  • Renamed internal helper functions rangeAnyNodes to yieldAnyNodes.
• dql/reflects/reflects.go
  • Renamed internal helper functions rangeChildNodes to yieldChildNodes.
  • Renamed internal helper functions rangeAnyNodes to yieldAnyNodes.
• dql/xml/xml.go
  • Renamed internal helper functions rangeChildNodes to yieldChildNodes.
  • Renamed internal helper functions rangeAnyNodes to yieldAnyNodes.
• encoding/fs/fs.go
  • Added a new package to provide an entry point for file system DQL.
• encoding/golang/golang.go
  • Changed Object type alias and New function return type to use a pointer to golang.File.
• encoding/html/html.go
  • Changed Object type alias and New function return type to use a pointer to html.File.
• encoding/regexp/regexp.go
  • Changed Object type alias and New function return type to use a pointer to regexp.Regexp.
• encoding/regexposix/regexp.go
  • Changed Object type alias and New function return type to use a pointer to regexp.Regexp.
• encoding/xgo/xgo.go
  • Changed Object type alias and New function return type to use a pointer to xgo.File.
• encoding/xml/xml.go
  • Changed Object type alias and New function return type to use a pointer to xml.Node.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a new DQL provider for filesystem operations (dql/fs), along with a corresponding encoding/fs package and a demo. It also includes several refactorings across existing DQL packages for consistency (renaming range... functions to yield...) and fixes type definitions in various encoding packages. No vulnerabilities were found during the SAST reconnaissance. However, I have a few suggestions to improve maintainability and robustness: refactor duplicated code in dql/fs/fs.go for fetching file info, improve determinism in rootDirEntry, and handle potential errors from path.Match to avoid silent failures.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.10%. Comparing base (a166095) to head (b8b24b1).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2635   +/-   ##
=======================================
  Coverage   94.10%   94.10%           
=======================================
  Files          32       32           
  Lines        9964     9964           
=======================================
  Hits         9377     9377           
  Misses        419      419           
  Partials      168      168           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.