Skip to content

Commit

Permalink
Add method based if approach for Bob (#2861)
Browse files Browse the repository at this point in the history
Co-authored-by: Kah Goh <[email protected]>
  • Loading branch information
jagdish-15 and kahgoh authored Feb 8, 2025
1 parent 3b72eac commit 3ec59e8
Show file tree
Hide file tree
Showing 6 changed files with 191 additions and 25 deletions.
21 changes: 19 additions & 2 deletions exercises/practice/bob/.approaches/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,30 @@
"introduction": {
"authors": [
"bobahop"
],
"contributors": [
"jagdish-15",
"kahgoh"
]
},
"approaches": [
{
"uuid": "6ca5c7c0-f8f1-49b2-b137-951fa39f89eb",
"slug": "method-based-if-statements",
"title": "method-based if statements",
"blurb": "Use if statements to return the answer with the help of methods.",
"authors": [
"jagdish-15"
],
"contributors": [
"BenjaminGale",
"kahgoh"
]
},
{
"uuid": "323eb230-7f27-4301-88ea-19c39d3eb5b6",
"slug": "if-statements",
"title": "if statements",
"slug": "variable-based-if-statements",
"title": "variable-based if statements",
"blurb": "Use if statements to return the answer.",
"authors": [
"bobahop"
Expand Down
86 changes: 64 additions & 22 deletions exercises/practice/bob/.approaches/introduction.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,65 @@
# Introduction

There are various idiomatic approaches to solve Bob.
A basic approach can use a series of `if` statements to test the conditions.
An array can contain answers from which the right response is selected by an index calculated from scores given to the conditions.
In this exercise, we’re working on a program to determine Bob’s responses based on the tone and style of given messages.
Bob responds differently depending on whether a message is a question, a shout, both, or silence.
Various approaches can be used to implement this logic efficiently and cleanly, ensuring the code remains readable and easy to maintain.

## General guidance

Regardless of the approach used, some things you could look out for include
When implementing your solution, consider the following tips to keep your code optimized and idiomatic:

- If the input is trimmed, [`trim()`][trim] only once.
- **Trim the Input Once**: Use [`trim()`][trim] only once at the start to remove any unnecessary whitespace.
- **Use Built-in Methods**: For checking if a message is a question, prefer [`endsWith("?")`][endswith] instead of manually checking the last character.
- **Single Determinations**: Use variables for `questioning` and `shouting` rather than calling these checks multiple times to improve efficiency.
- **DRY Code**: Avoid duplicating code by combining the logic for determining a shout and a question when handling shouted questions. Following the [DRY][dry] principle helps maintain clear and maintainable code.
- **Return Statements**: An early return in an `if` statement eliminates the need for additional `else` blocks, making the code more readable.
- **Curly Braces**: While optional for single-line statements, some teams may require them for readability and consistency.

- Use the [`endsWith()`][endswith] `String` method instead of checking the last character by index for `?`.
## Approach: method-based `if` statements

- Don't copy/paste the logic for determining a shout and for determining a question into determining a shouted question.
Combine the two determinations instead of copying them.
Not duplicating the code will keep the code [DRY][dry].
```java
class Bob {
String hey(String input) {
var inputTrimmed = input.trim();

if (isSilent(inputTrimmed)) {
return "Fine. Be that way!";
}
if (isShouting(inputTrimmed) && isQuestioning(inputTrimmed)) {
return "Calm down, I know what I'm doing!";
}
if (isShouting(inputTrimmed)) {
return "Whoa, chill out!";
}
if (isQuestioning(inputTrimmed)) {
return "Sure.";
}

return "Whatever.";
}

- Perhaps consider making `questioning` and `shouting` values set once instead of functions that are possibly called twice.
private boolean isShouting(String input) {
return input.chars()
.anyMatch(Character::isLetter) &&
input.chars()
.filter(Character::isLetter)
.allMatch(Character::isUpperCase);
}

- If an `if` statement can return, then an `else if` or `else` is not needed.
Execution will either return or will continue to the next statement anyway.
private boolean isQuestioning(String input) {
return input.endsWith("?");
}

- If the body of an `if` statement is only one line, curly braces aren't needed.
Some teams may still require them in their style guidelines, though.
private boolean isSilent(String input) {
return input.length() == 0;
}
}
```

This approach defines helper methods for each type of message—silent, shouting, and questioning—to keep each condition clean and easily testable.
For more details, refer to the [method-based `if` Statements Approach][approach-method-if].

## Approach: `if` statements
## Approach: variable-based `if` statements

```java
import java.util.function.Predicate;
Expand Down Expand Up @@ -56,7 +91,8 @@ class Bob {
}
```

For more information, check the [`if` statements approach][approach-if].
This approach uses variables to avoid rechecking whether Bob is silent, shouting or questioning.
For more details, refer to the [variable-based `if` Statements Approach][approach-variable-if].

## Approach: answer array

Expand Down Expand Up @@ -86,16 +122,22 @@ class Bob {
}
```

For more information, check the [Answer array approach][approach-answer-array].
This approach uses an array of answers and calculates the appropriate index based on flags for shouting and questioning.
For more details, refer to the [Answer Array Approach][approach-answer-array].

## Which Approach to Use?

The choice between the **Method-Based `if` Statements Approach**, **Variable-Based `if` Statements Approach**, and the **Answer Array Approach** depends on readability, maintainability, and efficiency:

## Which approach to use?
- **Method-Based `if` Statements Approach**: This is clear and easy to follow but checks conditions multiple times, potentially affecting performance. Storing results in variables like `questioning` and `shouting` can improve efficiency but may reduce clarity slightly.
- **Variable-Based `if` Statements Approach**: This approach can be more efficient by avoiding redundant checks, but its nested structure can reduce readability and maintainability.
- **Answer Array Approach**: Efficient and compact, this method uses an array of responses based on flags for questioning and shouting. However, it may be less intuitive and harder to modify if more responses are needed.

Since benchmarking with the [Java Microbenchmark Harness][jmh] is currently outside the scope of this document,
the choice between `if` statements and answers array can be made by perceived readability.
Each approach offers a balance between readability and performance, with trade-offs in flexibility and clarity.

[trim]: https://docs.oracle.com/javase/7/docs/api/java/lang/String.html#trim()
[endswith]: https://docs.oracle.com/javase/7/docs/api/java/lang/String.html#endsWith(java.lang.String)
[dry]: https://en.wikipedia.org/wiki/Don%27t_repeat_yourself
[approach-if]: https://exercism.org/tracks/java/exercises/bob/approaches/if-statements
[approach-method-if]: https://exercism.org/tracks/java/exercises/bob/approaches/method-based-if-statements
[approach-variable-if]: https://exercism.org/tracks/java/exercises/bob/approaches/variable-based-if-statements
[approach-answer-array]: https://exercism.org/tracks/java/exercises/bob/approaches/answer-array
[jmh]: https://github.com/openjdk/jmh
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
# Method-Based `if` statements

```java
class Bob {
String hey(String input) {
var inputTrimmed = input.trim();

if (isSilent(inputTrimmed)) {
return "Fine. Be that way!";
}
if (isShouting(inputTrimmed) && isQuestioning(inputTrimmed)) {
return "Calm down, I know what I'm doing!";
}
if (isShouting(inputTrimmed)) {
return "Whoa, chill out!";
}
if (isQuestioning(inputTrimmed)) {
return "Sure.";
}

return "Whatever.";
}

private boolean isShouting(String input) {
return input.chars()
.anyMatch(Character::isLetter) &&
input.chars()
.filter(Character::isLetter)
.allMatch(Character::isUpperCase);
}

private boolean isQuestioning(String input) {
return input.endsWith("?");
}

private boolean isSilent(String input) {
return input.length() == 0;
}
}
```

In this approach, the different conditions for Bob’s responses are separated into dedicated private methods within the `Bob` class.
This method-based approach improves readability and modularity by organizing each condition check into its own method, making the main response method easier to understand and maintain.

## Explanation

This approach simplifies the main method `hey` by breaking down each response condition into helper methods:

### Trimming the Input

The `input` is trimmed using the `String` [`trim()`][trim] method to remove any leading or trailing whitespace.
This helps to accurately detect if the input is empty and should prompt a `"Fine. Be that way!"` response.

~~~~exercism/caution
Note that a `null` `string` would be different from a `String` of all whitespace.
A `null` `String` would throw a `NullPointerException` if `trim()` were applied to it.
~~~~

### Delegating to Helper Methods

Each condition is evaluated using the following helper methods:

1. **`isSilent`**: Checks if the trimmed input has no characters.
2. **`isShouting`**: Checks if the input is all uppercase and contains at least one alphabetic character, indicating shouting.
3. **`isQuestioning`**: Verifies if the trimmed input ends with a question mark.

This modular approach keeps each condition encapsulated, enhancing code clarity.

### Order of Checks

The order of checks within `hey` is important:

1. Silence is evaluated first, as it requires an immediate response.
2. Shouted questions take precedence over individual checks for shouting and questioning.
3. Shouting comes next, requiring its response if not combined with a question.
4. Questioning (a non-shouted question) is checked afterward.

This ordering ensures that Bob’s response matches the expected behavior without redundancy.

## Shortening

When the body of an `if` statement is a single line, both the test expression and the body _could_ be put on the same line, like so:

```java
if (isSilent(inputTrimmed)) return "Fine. Be that way!";
```

or the body _could_ be put on a separate line without curly braces:

```java
if (isSilent(inputTrimmed))
return "Fine. Be that way!";
```

However, the [Java Coding Conventions][coding-conventions] advise always using curly braces for `if` statements, which helps to avoid errors.
Your team may choose to overrule them at its own risk.

[trim]: https://docs.oracle.com/javase/7/docs/api/java/lang/String.html#trim()
[coding-conventions]: https://www.oracle.com/java/technologies/javase/codeconventions-statements.html#449
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
if (isSilent(inputTrimmed))
return "Fine. Be that way!";
if (isShouting(inputTrimmed) && isQuestioning(inputTrimmed))
return "Calm down, I know what I'm doing!";
if (isShouting(inputTrimmed))
return "Whoa, chill out!";
if (isQuestioning(inputTrimmed))
return "Sure.";
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# `if` statements
# Variable-Based `if` statements

```java
import java.util.function.Predicate;
Expand Down

0 comments on commit 3ec59e8

Please sign in to comment.