Skip to content

refactor: added helper method #2666

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 4, 2025

Conversation

rahul31124
Copy link
Contributor

@rahul31124 rahul31124 commented Apr 3, 2025

Added Helper Method

Fixes #2664 and Fixes #2665

Changes

Added Helper Method

Screenshots / Recordings

N/A

Checklist:

  • No hard coding: I have used resources from strings.xml, dimens.xml and colors.xml without hard coding any value.
  • No end of file edits: No modifications done at end of resource files strings.xml, dimens.xml or colors.xml.
  • Code reformatting: I have reformatted code and fixed indentation in every file included in this pull request.
  • No extra space: My code does not contain any extra lines or extra spaces than the ones that are necessary.

Summary by Sourcery

Refactor degree input handling in RoboticArmActivity by introducing a helper method to fix issues #2664 and #2665, improving code maintainability and reducing redundancy.

Bug Fixes:

Enhancements:

  • Refactor degree input handling by introducing a helper method 'processDegreeInput' to streamline and centralize the logic.

Added Helper Method
Copy link

sourcery-ai bot commented Apr 3, 2025

Reviewer's Guide by Sourcery

This pull request introduces a helper method, processDegreeInput, to handle the common logic for processing degree inputs from the text fields associated with each servo. This change reduces code duplication and improves maintainability by centralizing the input validation and processing steps.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Refactored repetitive degree input processing logic into a single helper method.
  • Created a new method processDegreeInput to handle degree input processing.
  • Replaced duplicated code blocks in onEditorAction for each servo with calls to the new helper method.
app/src/main/java/io/pslab/activity/RoboticArmActivity.java

Assessment against linked issues

Issue Objective Addressed Explanation
#2664 Encapsulate the repeated logic of retrieving, trimming, checking if empty, and conditionally setting the 'degree' value for text fields into a private helper method.
#2664 Replace the repeated logic in the codebase with calls to the new helper method.
#2664 Ensure no functionality is broken by the refactor.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @rahul31124 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider renaming degreeStr to degreeText for consistency with the parameter name.
  • The helper method could be static since it doesn't access any instance members.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@@ -550,6 +478,33 @@ private void setReceivedData() {
((TextView) servo4TimeLine.getChildAt(i).findViewById(R.id.timeline_box_degree_text)).setText(servoData.getDegree4() + getResources().getString(R.string.robotic_arm_degree_symbol));
}
}
private void processDegreeInput(EditText degreeText, SeekArc seekArc) {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (bug_risk): Review global state usage in processDegreeInput.

The method modifies a shared global variable 'degree' (and 'editEnter'). Ensure that this side effect is intentional and safe given the UI's handling, particularly if multiple text inputs could be manipulated concurrently.

Suggested implementation:

    private int processDegreeInput(EditText degreeText, SeekArc seekArc, int currentDegree) {
        int previousDegree = currentDegree;
        String degreeStr = degreeText.getText().toString().trim();

        if (degreeStr.isEmpty()) {
            int newDegree = (currentDegree == 0) ? (int) (seekArc.getProgress() * 3.6) : previousDegree;
            return newDegree;
        } else {
            try {
                int newDegree = Integer.parseInt(degreeStr);
                return newDegree;
            } catch (NumberFormatException e) {
                degreeText.setText(getResources().getString(R.string.zero));
                seekArc.setProgress(0);
                toastInvalidValueMessage();
                return 0;
            }
        }
    }
                    degree = processDegreeInput(degreeText4, seekArc4, degree);

Note:

  1. If there is similar global state usage for "editEnter" or other shared variables, refactor them likewise (e.g., pass them as method parameters or use local variables) so that state changes are explicit.
  2. Verify that all calling code is updated to use the returned degree value appropriately.
  3. Adjust any tests or related UI handling to reflect these changes.

Copy link

github-actions bot commented Apr 3, 2025

@AsCress AsCress enabled auto-merge (squash) April 4, 2025 08:03
@AsCress AsCress disabled auto-merge April 4, 2025 08:03
@AsCress AsCress changed the title fix: helper method refactor: added helper method Apr 4, 2025
@AsCress AsCress enabled auto-merge (squash) April 4, 2025 08:04
Copy link
Collaborator

@AsCress AsCress left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM @rahul31124 ! Thank you very much !

@AsCress AsCress merged commit e653cb8 into fossasia:development Apr 4, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants