Skip to content
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

Adding approach for Bob #2861

Open
wants to merge 32 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
a58600a
Adding approach for Bob
jagdish-15 Nov 9, 2024
fa97c07
Fixing style errors
jagdish-15 Nov 9, 2024
f5f7680
Fixing style errors
jagdish-15 Nov 9, 2024
f6ae1f1
Fixing style errors
jagdish-15 Nov 9, 2024
4be572f
Adding uuid for new approach of bob exercise
jagdish-15 Nov 14, 2024
da71900
Fixing nameing issues
jagdish-15 Nov 14, 2024
51a8cd3
Adding snippet.txt
jagdish-15 Nov 14, 2024
3ddea06
FIxing formatting of config.josn for approach of bob
jagdish-15 Nov 14, 2024
64261e0
Adding approach for Bob
jagdish-15 Nov 9, 2024
b644b1c
Fixing style errors
jagdish-15 Nov 9, 2024
1dcbe19
Fixing style errors
jagdish-15 Nov 9, 2024
f06c782
Fixing style errors
jagdish-15 Nov 9, 2024
d0346c1
Adding uuid for new approach of bob exercise
jagdish-15 Nov 14, 2024
8f2ac6b
Fixing nameing issues
jagdish-15 Nov 14, 2024
0bf84b5
Adding snippet.txt
jagdish-15 Nov 14, 2024
e509381
FIxing formatting of config.josn for approach of bob
jagdish-15 Nov 14, 2024
f0543c3
Chnaging the introduction.md for consistancy
jagdish-15 Nov 18, 2024
e67fc43
Merge branch 'main' into add-approach-bob
jagdish-15 Nov 18, 2024
ad27bb2
Chnaging the introduction.md for consistancy
jagdish-15 Nov 18, 2024
6def244
Chnaging the introduction.md for fixing styling errors
jagdish-15 Nov 18, 2024
498ae46
Update exercises/practice/bob/.approaches/introduction.md
jagdish-15 Dec 26, 2024
ff35ee4
Update exercises/practice/bob/.approaches/method-based/content.md
jagdish-15 Dec 26, 2024
b017e6c
Merge branch 'main' into add-approach-bob
jagdish-15 Dec 26, 2024
e8da28d
Updating approach bob
jagdish-15 Dec 26, 2024
c3dcc96
Updating approach name
jagdish-15 Dec 26, 2024
173ce32
Updating content of if statements approach
jagdish-15 Dec 26, 2024
521160b
Updating content of if statements approach
jagdish-15 Dec 26, 2024
eaa5cdf
Updating content of if statements approach
jagdish-15 Dec 26, 2024
1802823
Merge branch 'main' into add-approach-bob
jagdish-15 Dec 31, 2024
fc74587
Merge branch 'main' into add-approach-bob
jagdish-15 Jan 14, 2025
2e6b670
Changing approach names
jagdish-15 Jan 14, 2025
1093c5b
Changing content titles for consistancy
jagdish-15 Jan 14, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions exercises/practice/bob/.approaches/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,26 @@
"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",
Expand Down
73 changes: 53 additions & 20 deletions exercises/practice/bob/.approaches/introduction.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,56 @@
# 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.";
}

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

- Perhaps consider making `questioning` and `shouting` values set once instead of functions that are possibly called twice.
private boolean isQuestioning(String input) {
return input.endsWith("?");
}

- 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 isSilent(String input) {
return input.length() == 0;
}
}
```

- 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.
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

Expand Down Expand Up @@ -56,7 +84,7 @@ class Bob {
}
```

For more information, check the [`if` statements approach][approach-if].
This approach utilizes nested `if` statements and a predicate for determining if a message is a shout. For more details, refer to the [`if` Statements Approach][approach-if].

## Approach: answer array

Expand Down Expand Up @@ -86,16 +114,21 @@ 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**, **Nested `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.
- **`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-method-if]: https://exercism.org/tracks/java/exercises/bob/approaches/method-based-if-statements
[approach-if]: https://exercism.org/tracks/java/exercises/bob/approaches/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,87 @@
# 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.

### 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.";