Fix Ruby 3.2 Deprecated `File.exists?` #12

thdurante · 2025-01-08T07:50:03Z

Summary by CodeRabbit

New Features
- Updated documentation to explain the release process using Google's release-please action.
- Improved commit message guidelines for automated releases.
Chores
- Updated Ruby version to 3.4.1.
- Updated CI workflow configuration.
- Bumped gem version from 1.2.6 to 1.3.3.
- Updated dependency declaration method.
Bug Fixes
- Corrected file existence check method in CLI.

coderabbitai · 2025-01-08T07:50:11Z

Walkthrough

This pull request encompasses updates to the CI workflow, README, gemspec, and a CLI method. The changes include upgrading the Ruby version to 3.4.1, switching to Google's release-please action for release management, updating the gem version to 1.3.3, modifying dependency declaration methods, and correcting a file existence check method in the CLI. These modifications aim to improve the project's development and release processes while maintaining code quality and consistency.

Changes

File	Changes
`.github/workflows/ci.yml`	- Updated Ruby version from 3.1 to 3.4.1 - Changed release action from `krystal/release-please-manifest-action@v1` to `googleapis/release-please-action@v4` - Updated conditional syntax and environment variable
`README.md`	- Added new "Release" section explaining `release-please` action and Conventional Commits
`deploy-agent.gemspec`	- Bumped version from 1.2.6 to 1.3.3 - Replaced `add_runtime_dependency` with `add_dependency` for three dependencies
`lib/deploy_agent/cli.rb`	- Changed `File.exists?` to `File.exist?` in `write_pid` method

Suggested reviewers

facundofarias

Possibly related PRs

Update CI Script #10: The changes in this PR directly relate to the updates made in the CI workflow configuration, including the Ruby version upgrade and modifications to the release-please job, which are also present in the main PR.

Poem

🐰 A Rabbit's Release Rhyme 🚀

Workflows dance with Ruby's might,
Commits now structured just right.
Release-please springs to life with glee,
Versions bump, dependencies free.
Code evolves with each new height!

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5373d31 and fb227ed.

📒 Files selected for processing (1)

.github/workflows/ci.yml (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

.github/workflows/ci.yml

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 1

🔭 Outside diff range comments (1)

.github/workflows/ci.yml (1)
Consider splitting unrelated changes into separate PRs

While the PR does fix the deprecated File.exists? method in lib/deploy_agent/cli.rb, it includes several unrelated changes that would be clearer if split into separate PRs:

PR 1: Fix deprecated File.exists? method

PR 2: Update Ruby version and dependencies

PR 3: Update release-please configuration and documentation

This separation would make the changes easier to review, test, and revert if needed.

🔗 Analysis chain

Line range hint 1-51: Verify PR objective alignment.

The changes in this PR seem to go beyond fixing the deprecated File.exists? method. While updating dependencies and CI configuration is good, it might be better to split these changes into separate PRs for clearer change management:

Fix Ruby 3.2 Deprecated File.exists?

Update dependencies and their declaration

Update CI configuration and release process

Let's check if there are any actual fixes for File.exists?:
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Check for File.exists? usage in the codebase
echo "Checking for File.exists? usage..."
rg "File\.exists\?" --type ruby

# Check for potential fixes (File.exist? is the new recommended way)
echo "Checking for File.exist? usage..."
rg "File\.exist\?" --type ruby
Length of output: 311

Script:
#!/bin/bash
# Check git history for removed File.exists? instances
git log -p | rg -B 5 -A 5 "File\.exists?"

# Get the PR diff to see all changes
git diff origin/master...HEAD
Length of output: 4361
🧰 Tools

🪛 actionlint (1.7.4)

32-32: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c9d33e9 and 5373d31.

📒 Files selected for processing (4)

.github/workflows/ci.yml (3 hunks)
README.md (1 hunks)
deploy-agent.gemspec (2 hunks)
lib/deploy_agent/cli.rb (1 hunks)

✅ Files skipped from review due to trivial changes (2)

README.md
lib/deploy_agent/cli.rb

🧰 Additional context used

🪛 actionlint (1.7.4)

.github/workflows/ci.yml

32-32: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

🔇 Additional comments (3)

deploy-agent.gemspec (2)

5-5: Verify if version bump from 1.2.6 to 1.3.3 follows semver.

The version bump seems significant for a deprecation fix. According to semver, this should probably be a patch version bump (1.2.7) since it's fixing a deprecated method warning.

18-20: Consider updating outdated dependencies.

The current dependencies are quite old and may have security vulnerabilities:

nio4r 2.1.0 (current is 2.7.0)

rb-readline 0.5.5 (unmaintained)

timers 4.1.2 (current is 4.3.5)

Let's check for any known vulnerabilities:

.github/workflows/ci.yml (1)

11-11: Consider using a more stable Ruby version.

Ruby 3.4.1 was just released (December 2023) and might be too new for production use. Consider using Ruby 3.2.x or 3.3.x which are more stable and still support the deprecation fixes.

Also applies to: 36-36

.github/workflows/ci.yml

thdurante added 5 commits January 8, 2025 08:36

fix: Fix rubocop offenses.

5d7ba4f

fix: Replace deprecated File.exists? method.

2b65cf1

ci: Use Google's release-please action + Use ruby 3.4.1.

b911f9a

docs: Improve README with Release instructions.

73cfc3b

fix: Fix release-please configuration.

5373d31

thdurante requested a review from facundofarias January 8, 2025 07:50

thdurante self-assigned this Jan 8, 2025

coderabbitai bot reviewed Jan 8, 2025

View reviewed changes

.github/workflows/ci.yml Outdated Show resolved Hide resolved

ci: Bump outdated actions/checkout@v3 runner to v4.

fb227ed

facundofarias approved these changes Jan 8, 2025

View reviewed changes

facundofarias merged commit 3cdaacc into master Jan 8, 2025
6 checks passed

facundofarias deleted the fix-ruby-deprecated-method branch January 8, 2025 07:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix Ruby 3.2 Deprecated `File.exists?` #12

Fix Ruby 3.2 Deprecated `File.exists?` #12

Uh oh!

thdurante commented Jan 8, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jan 8, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Fix Ruby 3.2 Deprecated File.exists? #12

Fix Ruby 3.2 Deprecated File.exists? #12

Uh oh!

Conversation

thdurante commented Jan 8, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jan 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Suggested reviewers

Possibly related PRs

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Fix Ruby 3.2 Deprecated `File.exists?` #12

Fix Ruby 3.2 Deprecated `File.exists?` #12

thdurante commented Jan 8, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 8, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)