Fix #5062 - Properly forward the --help flag to ruby/python scripts

[jmarrec]

Pull request overview

• Fixes OS 3.7 CLI regression for openstudio foo.rb --help #5062

When script omitted, --help displays the C++ subcommand help

$os_build_rel/Products/openstudio execute_ruby_script --help
Executes a ruby file
Usage: /Users/julien/Software/Others/OS-build-release/Products/openstudio execute_ruby_script [OPTIONS] path [args...]

Positionals:
  path RUBY_SCRIPT                 Path to Ruby file
  args ARG ...                     Extra Arguments forwarded to the Ruby script

Options:
  -h,--help                        Print this help message and exit

Any additional arguments passed after the Ruby file are forwarded

When --help is passed after the ruby script, the Ruby's script is displayed (if any):

$os_build_rel/Products/openstudio execute_ruby_script execute_ruby_script_optparse_path.rb --help
Usage: execute_ruby_script_optparse_path.rb -x building.xml

The Ruby help description.

    -x, --xml <FILE>                 HPXML file

Pull Request Author

• Model API Changes / Additions
• Any new or modified fields have been implemented in the EnergyPlus ForwardTranslator (and ReverseTranslator as appropriate)
• Model API methods are tested (in src/model/test)
• EnergyPlus ForwardTranslator Tests (in src/energyplus/Test)
• If a new object or method, added a test in NREL/OpenStudio-resources: Add Link
• If needed, added VersionTranslation rules for the objects (src/osversion/VersionTranslator.cpp)
• Verified that C# bindings built fine on Windows, partial classes used as needed, etc.
• All new and existing tests passes
• If methods have been deprecated, update rest of code to use the new methods

Labels:

• If change to an IDD file, add the label IDDChange
• If breaking existing API, add the label APIChange
• If deemed ready, add label Pull Request - Ready for CI so that CI builds your PR

Review Checklist

This will not be exhaustively relevant to every PR.

• Perform a Code Review on GitHub
• Code Style, strip trailing whitespace, etc.
• All related changes have been implemented: model changes, model tests, FT changes, FT tests, VersionTranslation, OS App
• Labeling is ok
• If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
• If feature, test running new feature, try creative ways to break it
• CI status: all green or justified

[ci-commercialbuildings]

CI Results for a52f8e0:

• Ubuntu 20.04:

  • OpenStudio-3.7.0+a52f8e00bf-Ubuntu-20.04-x86_64.deb
  • OpenStudio-3.7.0+a52f8e00bf-Ubuntu-20.04-x86_64.tar.gz
  • perf_test/results.html

• Ubuntu 22.04:

  • OpenStudio-3.7.0+a52f8e00bf-Ubuntu-22.04-x86_64.deb
  • OpenStudio-3.7.0+a52f8e00bf-Ubuntu-22.04-x86_64.tar.gz

• Darwin:

• Windows:

  • OpenStudio-3.7.0+a52f8e00bf-Windows.exe
  • OpenStudio-3.7.0+a52f8e00bf-Windows.tar.gz

• Code Coverage:

[wenyikuang]

Looks like the mac-incremental didn't work properly. I cleaned up the disk and re-ran it.

[jmarrec]

@wenyikuang I just killed that rerun, it has been stalled for 8 days.

[jmarrec]

@shorowit When you get a chance (after the holiday season is totally fine - and happy holidays!), if you could test that this is properly solving your problem that'd be great, then we can merge. Thanks!

[shorowit]

Just tested this and it worked as expected. Thanks for the quick fix, @jmarrec!