Homebrew formula

[sbryngelson]

User description

bottle

---

PR Type

Enhancement, Bug fix

---

Description

• Simplify Homebrew wrapper syntax from mfc run <case.py> to mfc <case.py>

• Improve argument parsing with better validation and error handling

• Add --version flag support to wrapper command

• Streamline CI/CD workflows by removing redundant smoke tests and consolidating to single macOS job

• Update documentation and examples across multiple files to reflect simplified syntax

---

Diagram Walkthrough

flowchart LR
  A["Homebrew Wrapper<br/>mfc.rb"] -->|"Simplified syntax"| B["User runs<br/>mfc case.py"]
  A -->|"Enhanced validation"| C["Better error<br/>messages"]
  A -->|"New feature"| D["--version flag<br/>support"]
  E["CI/CD Workflows"] -->|"Streamlined"| F["Single macOS<br/>test job"]
  G["Documentation"] -->|"Updated"| H["Consistent<br/>examples"]

Loading

File Walkthrough

	Relevant files
Enhancement	mfc.rb Simplify wrapper syntax and enhance argument validation    packaging/homebrew/mfc.rb Removed mfc run command requirement; wrapper now auto-detects case files and prepends run internally Replaced SUBCMD variable with direct ${ARGS[0]-} checks for cleaner logic Added --version flag support to display MFC version Implemented comprehensive argument validation: detects missing case files, rejects mfc run syntax, validates Python file existence Updated help text and examples to show simplified mfc case.py syntax instead of mfc run case.py Improved error messages with clear usage instructions +40/-14  homebrew.yml Consolidate and simplify CI/CD workflow                                    .github/workflows/homebrew.yml Consolidated two-job workflow (smoke-test + test-formula) into single macOS test job Removed path-based workflow triggers; now runs on all pushes to master and pull requests Removed homebrew-formula branch from triggers Simplified installation to use brew install with fallback to source build Streamlined test case execution with improved error handling using set -euo pipefail Consolidated verification checks into single step with clearer output Removed extensive logging and artifact upload logic Reduced workflow from 264 lines to 65 lines +42/-241
Bug fix	deploy-tap.yml Fix workflow triggers and shell quoting                                    .github/workflows/deploy-tap.yml Removed homebrew-formula branch from trigger conditions (now only responds to tag events and path changes) Fixed shell variable quoting in GitHub Actions output commands using "$GITHUB_OUTPUT" instead of $GITHUB_OUTPUT Added blank line for formatting consistency Removed trailing newline at end of file +5/-6
Documentation	README.md Update Homebrew example syntax                                                      README.md Updated Homebrew quickstart example from mfc run case.py -n 2 to mfc case.py -n 2 +1/-1      getting-started.md Update getting started guide with simplified syntax            docs/documentation/getting-started.md Changed example command from mfc run case.py -n 2 to mfc case.py -n 2 Updated notes to clarify simplified syntax: "just mfc to run cases" Improved documentation clarity about Homebrew wrapper capabilities +3/-2      running.md Update running guide with simplified command syntax            docs/documentation/running.md Updated command example from mfc run to mfc Clarified that Homebrew uses simplified syntax instead of requiring run command Improved documentation consistency with new wrapper behavior +2/-2      README.md Update Homebrew README with simplified syntax                        packaging/homebrew/README.md Updated usage example from mfc run case.py -n 2 to mfc case.py -n 2 Updated usage section header from mfc run to mfc Clarified note that wrapper supports "only running cases" instead of "only mfc run" +3/-3

---

[qodo-merge-pro]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Possible Issue The non-flag detection treats any token not starting with '-' as the first argument; this may mis-handle positional options or subcommands in future and rejects 'run' unconditionally. Confirm this won’t break valid workflows and that flags like '--' or arguments beginning with '+' are handled as expected. # Find first non-flag argument first_nonflag="" for arg in "${ARGS[@]}"; do if [[ "$arg" != -* ]]; then first_nonflag="$arg" break fi done # Check if no case file provided if [[ -z "${first_nonflag}" ]]; then echo "mfc (Homebrew): missing case file." echo "Usage: mfc <case.py> [options]" echo "Example: mfc case.py -n 2" exit 2 fi # Check if user accidentally used 'mfc run' syntax (even with flags before it) if [[ "${first_nonflag}" == "run" ]]; then echo "mfc (Homebrew): The 'run' command is not needed." echo "Usage: mfc <case.py> [options]" echo "Example: mfc case.py -n 2" exit 2 fi Path Handling Earlier normalization prepends ORIG_DIR only for certain extensions; later validation checks the unnormalized path for '-f' which may fail if the user relies on relative paths from the original directory. Ensure consistent path normalization before '-f' checks and execution. # If argument looks like a file path and exists as relative path if [[ "$arg" =~ \\.(py|txt|json|yaml|yml)$ ]] && [ -e "${ORIG_DIR}/${arg}" ]; then ARGS+=("${ORIG_DIR}/${arg}") else ARGS+=("$arg") fi done # Friendly help and guardrails if [[ ${#ARGS[@]} -eq 0 ]] || [[ "${ARGS[0]-}" == "--help" ]] || [[ "${ARGS[0]-}" == "-h" ]]; then cat <<'HHELP' MFC (Homebrew) #{version} Usage: mfc <case.py> [options] Examples: mfc case.py -n 2 mfc examples/1D_sodshocktube/case.py -n 2 -t pre_process simulation Notes: - This Homebrew wrapper uses prebuilt binaries and a preinstalled venv. - Developer commands (build, clean, test, etc.) are not available here. Clone the MFC repo for the full developer workflow. HHELP exit 0 fi # Handle --version flag if [[ "${ARGS[0]-}" == "--version" ]] || [[ "${ARGS[0]-}" == "-v" ]]; then echo "MFC (Homebrew) #{version}" exit 0 fi # Find first non-flag argument first_nonflag="" for arg in "${ARGS[@]}"; do if [[ "$arg" != -* ]]; then first_nonflag="$arg" break fi done # Check if no case file provided if [[ -z "${first_nonflag}" ]]; then echo "mfc (Homebrew): missing case file." echo "Usage: mfc <case.py> [options]" echo "Example: mfc case.py -n 2" exit 2 fi # Check if user accidentally used 'mfc run' syntax (even with flags before it) if [[ "${first_nonflag}" == "run" ]]; then echo "mfc (Homebrew): The 'run' command is not needed." echo "Usage: mfc <case.py> [options]" echo "Example: mfc case.py -n 2" exit 2 fi # Require a readable Python file (not a directory) if [[ ! "${first_nonflag}" =~ .py$ ]] || [[ ! -f "${first_nonflag}" ]]; then echo "mfc (Homebrew): first argument must be a readable Python case file." echo "Given: ${first_nonflag}" echo "Usage: mfc <case.py> [options]" exit 2 fi Flaky Test Risk The workflow relies on running a full example with many cores and minimal logging/artifacts. If the simulation intermittently fails, triage will be hard. Consider modest logging or artifact retention on failure to aid debugging. - name: Run MFC test case run: | set -euo pipefail echo "Running a simple test case (1D Sod shock tube)..." TESTDIR=$(mktemp -d) cp "$(brew --prefix mfc)/examples/1D_sodshocktube/case.py" "$TESTDIR/" echo "Running with $(sysctl -n hw.ncpu) processors..." mfc "$TESTDIR/case.py" -j "$(sysctl -n hw.ncpu)" test -d "$TESTDIR/silo_hdf5" echo "✅ Test case completed successfully and produced output" - name: Basic installation verification run: | set -euo pipefail echo "1. Checking binaries..." test -x "$(brew --prefix mfc)/bin/pre_process" test -x "$(brew --prefix mfc)/bin/simulation" test -x "$(brew --prefix mfc)/bin/post_process" test -x "$(brew --prefix mfc)/bin/mfc" echo "2. Checking toolchain..." test -d "$(brew --prefix mfc)/toolchain" echo "3. Checking Python venv..." test -d "$(brew --prefix mfc)/libexec/venv" test -x "$(brew --prefix mfc)/libexec/venv/bin/python" echo "4. Checking examples..." test -d "$(brew --prefix mfc)/examples" echo "5. Testing mfc command..." mfc --help echo "✅ All verification checks passed"

[qodo-merge-pro]

High-level Suggestion

Reintroduce the brew audit step into the homebrew.yml CI workflow. This ensures the Homebrew formula is validated for correctness, style, and checksums, which was a quality check removed during simplification. [High-level, importance: 8]

Solution Walkthrough:

Before:

# .github/workflows/homebrew.yml
jobs:
  homebrew-mfc:
    runs-on: macos-latest
    steps:
      - name: Checkout repo
        ...
      - name: Set up Homebrew
        ...
      - name: Install MFC via Homebrew
        run: |
          brew install mflowcode/mfc/mfc || brew install --build-from-source mflowcode/mfc/mfc
      - name: Run MFC test case
        ...
      - name: Basic installation verification
        ...

After:

# .github/workflows/homebrew.yml
jobs:
  homebrew-mfc:
    runs-on: macos-latest
    steps:
      - name: Checkout repo
        ...
      - name: Set up Homebrew
        ...
      - name: Validate formula
        run: |
          brew audit --online packaging/homebrew/mfc.rb
      - name: Install MFC via Homebrew
        run: |
          brew install mflowcode/mfc/mfc || brew install --build-from-source mflowcode/mfc/mfc
      - name: Run MFC test case
        ...
      - name: Basic installation verification
        ...

[qodo-merge-pro]

Suggestion: Correct the regex for Python file validation by escaping the dot in \\.py$ to ensure it matches a literal dot instead of any character. [possible issue, importance: 6]

Suggested change

	# Require a readable Python file (not a directory)
	if [[ ! "${first_nonflag}" =~ .py$ ]] || [[ ! -f "${first_nonflag}" ]]; then
	echo "mfc (Homebrew): first argument must be a readable Python case file."
	echo "Given: ${first_nonflag}"
	echo "Usage: mfc <case.py> [options]"
	exit 2
	fi
	# Require a readable Python file (not a directory)
	if [[ ! "${first_nonflag}" =~ \.py$ ]] || [[ ! -f "${first_nonflag}" ]]; then
	echo "mfc (Homebrew): first argument must be a readable Python case file."
	echo "Given: ${first_nonflag}"
	echo "Usage: mfc <case.py> [options]"
	exit 2
	fi

[Copilot]

Pull Request Overview

This PR simplifies the Homebrew formula wrapper syntax by removing the need for the explicit run subcommand. Users can now execute cases directly with mfc <case.py> instead of mfc run <case.py>.

Key changes:

• Simplified command syntax: mfc <case.py> replaces mfc run <case.py>
• Enhanced argument validation with better error messages for common mistakes
• Streamlined CI workflow with faster, more focused tests
• Consistent documentation updates across all files

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
packaging/homebrew/mfc.rb	Refactored wrapper script to auto-prepend 'run', added robust validation for case files, and improved help/version handling
packaging/homebrew/README.md	Updated usage examples to reflect simplified syntax without 'run' command
docs/documentation/running.md	Updated Homebrew usage section with simplified command syntax
docs/documentation/getting-started.md	Updated quick start examples to use simplified syntax
README.md	Updated macOS quick start example to use simplified syntax
.github/workflows/homebrew.yml	Simplified workflow from multi-job validation to single focused test job with installation verification
.github/workflows/deploy-tap.yml	Minor cleanup: removed obsolete branch trigger, improved quoting, and removed trailing whitespace

[Copilot]

The regex pattern .py$ is missing an escape for the literal dot. It should be \\.py$ to match the literal '.py' extension, consistent with line 90 which correctly uses \\. in its pattern.

Without the escape, this pattern matches any character followed by 'py' at the end (e.g., 'xpy', '1py'), not specifically '.py' files.

Suggested change

	if [[ ! "${first_nonflag}" =~ .py$ ]] || [[ ! -f "${first_nonflag}" ]]; then
	if [[ ! "${first_nonflag}" =~ \.py$ ]] || [[ ! -f "${first_nonflag}" ]]; then

[cursor]

This is the final PR Bugbot will review for you during this billing cycle

Your free Bugbot reviews will reset on December 8

Details

You are on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle.

To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.

[cursor]

Bug: Wrapper Argument Rejection Breaks Formula Tests

The wrapper now rejects run as the first non-flag argument (lines 141-146), but the test do block at line 303 still calls system bin/"mfc", "run", "case.py", "-j", "1". This causes the formula's test to fail because the wrapper exits with error code 2 when it detects run, even though the test is otherwise valid.

 

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

[chatgpt-codex-connector]

Limit deploy workflow to protected branches

The deploy-tap workflow no longer restricts which branches can trigger it—on.push now runs for any branch that happens to modify packaging/homebrew/**. Because the job always ends by committing and pushing the formula to MFlowCode/homebrew-mfc using the PAT, any contributor pushing a feature branch (or even a draft PR) will now publish their unreviewed formula straight to the public tap. Previously this workflow ran only after changes landed on main/master/homebrew-formula, guaranteeing review before publishing. Please reinstate a branch filter (or otherwise guard the job) so that only vetted branches can trigger the tap sync.

Useful? React with 👍 / 👎.

[chatgpt-codex-connector]

Tag releases never trigger deploy workflow

A new tag-specific path was added (if: github.ref_type == 'tag'), but the workflow still declares a paths: filter under on.push. GitHub only evaluates the paths filter against files changed in the pushed commits, and tag pushes do not carry any file changes, so the workflow will never trigger for refs/tags/v*.*.*. As a result the “Update formula (for tag events)” step and the subsequent tap sync never run when creating a release tag, breaking the intended automation. Remove the paths restriction for tag events (or split them into a separate trigger) so that release tags actually invoke this workflow.

Useful? React with 👍 / 👎.