Skip to content

Commit

Permalink
feat(core): clickable setting now takes unary operator
Browse files Browse the repository at this point in the history
default values for books are now in place to avoid potential boilerplate

BREAKING CHANGE: Book#setNextClickable() now takes UnaryOperator instead of Clickable

Signed-off-by: Jasper Lutz Severino <jasperlutzseverino@gmail.com>
  • Loading branch information
lutzseverino committed Aug 8, 2022
1 parent b0ddebb commit 82ffb90
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 20 deletions.
60 changes: 42 additions & 18 deletions core/src/main/java/com/lutzseverino/discordbooks/book/Book.java
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,22 @@
import com.lutzseverino.discordbooks.discord.channel.Receivable;
import com.lutzseverino.discordbooks.discord.component.ActionableRow;
import com.lutzseverino.discordbooks.discord.component.Clickable;
import com.lutzseverino.discordbooks.discord.component.impl.ClickableImpl;
import com.lutzseverino.discordbooks.discord.message.Sendable;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.ArrayList;
import java.util.List;
import java.util.function.UnaryOperator;

public abstract class Book {
public class Book {
private final String name;
private final List<Sendable> pages = new ArrayList<>();
private final List<ActionableRow> actionableRows = new ArrayList<>();
private final List<Clickable> clickables = new ArrayList<>();
private Clickable previousClickable;
private Clickable nextClickable;
private final Clickable previousClickable = new ClickableImpl(Clickable.Style.PRIMARY).setDisplay("Previous");
private final Clickable nextClickable = new ClickableImpl(Clickable.Style.PRIMARY).setDisplay("Next");
private final List<Clickable> clickables = new ArrayList<>(List.of(this.previousClickable, this.nextClickable));
private final List<ActionableRow> actionableRows = new ArrayList<>(List.of(new ActionableRow(this.clickables)));

public Book(String name) {
this.name = name;
Expand Down Expand Up @@ -90,14 +92,16 @@ private List<Clickable> getClickables() {
}

/**
* Sets the items of the {@link ActionableRow} of {@link Clickable}s.
* Clears the default list and sets the items of
* the {@link ActionableRow} of {@link Clickable}s.
*
* @param clickables the {@link Clickable}s to set
* @see #setClickables(Clickable...)
* @see #setNextClickable(Clickable)
* @see #setPreviousClickable(Clickable)
* @see #setNextClickable(UnaryOperator)
* @see #setPreviousClickable(UnaryOperator)
*/
public void setClickables(List<Clickable> clickables) {
this.clickables.clear();
this.clickables.addAll(clickables);
}

Expand All @@ -106,10 +110,11 @@ public void setClickables(List<Clickable> clickables) {
*
* @param clickables the {@link Clickable}s to set
* @see #setClickables(Clickable...)
* @see #setNextClickable(Clickable)
* @see #setPreviousClickable(Clickable)
* @see #setNextClickable(UnaryOperator)
* @see #setPreviousClickable(UnaryOperator)
*/
public void setClickables(Clickable... clickables) {
this.clickables.clear();
this.clickables.addAll(List.of(clickables));
}

Expand All @@ -127,10 +132,10 @@ public Clickable getNextClickable() {
* Some settings, such as the disabled state or ID will be overridden
* at send time.
*
* @param nextClickable the base {@link Clickable}
* @param nextClickable the operator to modify the {@link Clickable}
*/
public void setNextClickable(@NotNull Clickable nextClickable) {
this.nextClickable = nextClickable;
public void setNextClickable(@NotNull UnaryOperator<Clickable> nextClickable) {
nextClickable.apply(this.nextClickable);
}

/**
Expand All @@ -147,10 +152,10 @@ public Clickable getPreviousClickable() {
* Some settings, such as the disabled state or ID will be overridden
* at send time.
*
* @param previousClickable the base {@link Clickable}
* @param previousClickable the operator to modify the {@link Clickable}
*/
public void setPreviousClickable(@NotNull Clickable previousClickable) {
this.previousClickable = previousClickable;
public void setPreviousClickable(@NotNull UnaryOperator<Clickable> previousClickable) {
previousClickable.apply(this.previousClickable);
}

/**
Expand All @@ -163,6 +168,24 @@ public ActionableRow getClickableRow() {
return new ActionableRow(clickables);
}

/**
* Adds {@link ActionableRow}s to the book.
* <p>
* This method should be used to add your own {@link ActionableRow}s,
* as well as the {@link ActionableRow} of {@link Clickable}s
* containing the navigation.
* <p>
* Discord allows a maximum of 5 rows per message, but this
* library doesn't limit the number of rows by itself.
*
* @param actionRows the action rows to add
*/
public void setActionableRows(List<ActionableRow> actionRows) {
this.actionableRows.clear();
this.actionableRows.addAll(actionRows);
}


/**
* Adds {@link ActionableRow}s to the book.
* <p>
Expand All @@ -176,6 +199,7 @@ public ActionableRow getClickableRow() {
* @param actionRows the action rows to add
*/
public void setActionableRows(ActionableRow... actionRows) {
this.actionableRows.clear();
this.actionableRows.addAll(List.of(actionRows));
}

Expand Down Expand Up @@ -246,7 +270,7 @@ public Sendable edit(int index, @NotNull String... ownerIDs) {
public void buildNavigation(Sendable sendable, String... ownerIDs) {
int index = pages.indexOf(sendable);

previousClickable = previousClickable.setDisabled(index == 0).setId(getName() + "@" + (index - 1) + "@" + String.join("#", ownerIDs));
nextClickable = nextClickable.setDisabled(index == pages.size() - 1).setId(getName() + "@" + (index + 1) + "@" + String.join("#", ownerIDs));
previousClickable.setDisabled(index == 0).setId(getName() + "@" + (index - 1) + "@" + String.join("#", ownerIDs));
nextClickable.setDisabled(index == pages.size() - 1).setId(getName() + "@" + (index + 1) + "@" + String.join("#", ownerIDs));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ public ExampleBook() {
.setDescription("Need more convincing? Too bad, I've got no more pages left."))
);

setNextClickable(new ClickableImpl(Clickable.Style.PRIMARY).setEmoji("➡"));
setPreviousClickable(new ClickableImpl(Clickable.Style.PRIMARY).setEmoji("⬅️"));
setNextClickable(clickable -> clickable.setEmoji("➡"));
setPreviousClickable(clickable -> clickable.setEmoji("⬅️"));

setClickables(
getPreviousClickable(),
Expand Down

0 comments on commit 82ffb90

Please sign in to comment.