Lucaslg7 opened a new pull request, #445:
URL: https://github.com/apache/commons-cli/pull/445
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
Thanks for your contribution to [Apache
Commons](https://commons.apache.org/)! Your help is appreciated!
Before you push a pull request, review this list:
- [x] Read the [contribution guidelines](CONTRIBUTING.md) for this project.
- [x] Read the [ASF Generative Tooling
Guidance](https://www.apache.org/legal/generative-tooling.html) if you use
Artificial Intelligence (AI).
- [x] I used AI to create any part of, or all of, this pull request. Which
AI tool was used to create this pull request, and to what extent did it
contribute?
- [x] Run a successful build using the default
[Maven](https://maven.apache.org/) goal with `mvn`; that's `mvn` on the command
line by itself.
- [ ] Write unit tests that match behavioral changes, where the tests fail
if the changes to the runtime are not applied. This may not always be possible,
but it is a best practice.
- [x] Write a pull request description that is detailed enough to understand
what the pull request does, how, and why.
- [x] Each commit in the pull request should have a meaningful subject line
and body. Note that a maintainer may squash commits during the merge process.
## What changed
- Renamed local variables in `Parser.processOption()`:
- `hasOption` → `optionIsRecognized`
- `opt` → `optionToProcess`
- Removed five comments that merely narrated the statements immediately
below them.
- Removed the redundant `// empty` comment from the constructor.
- Added `testParsedArgumentIsStoredOnOptionClone()` to the shared parser
test class.
## Why
The selected comments illustrate the Comments code smell: they repeat
operations already expressed by the code rather than explaining intent,
constraints, or non-obvious decisions.
This refactoring replaces generic local names with descriptive ones and
removes redundant narrative comments, making `Parser.processOption()`
readable without those explanations. The redundant `// empty` constructor
comment is also removed.
Useful API documentation is preserved. Method signatures, operation order,
option cloning, and exception messages remain unchanged.
## Tests and verification
The added characterization test verifies that:
- The parsed option is a different instance from the original option
definition.
- The argument value is stored on the parsed option.
- The original option definition remains without values.
This test runs through the shared test class for `BasicParser`,
`GnuParser`, `PosixParser`, and `DefaultParser`.
The behavioral-change checklist item is left unchecked intentionally:
this is a behavior-preserving refactoring. The characterization test passes
both before and after the production changes rather than failing against
the original implementation.
Validation performed:
- Focused legacy-parser tests passed before and after the refactoring.
- Full test suite passed: 998 tests total, 61 skipped, 0 failures, 0 errors.
- The default Maven build (`mvn`) completed successfully.
- `git diff --check` passed.
Tests were executed using Maven in Docker with Java 17.
## AI assistance disclosure
OpenAI GPT, accessed through OpenCode, assisted with repository selection,
implemented the refactoring and characterization test, and helped draft this
pull request description. I reviewed the changes and ran the build.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
