bitlair/revbank
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Introduce ';' as command/transaction separator

Browse source 
There's a slight mismatch between what users experience as a command,
and how commands are defined in RevBank. Specifically, the common input
"<productid> <username>" is two separate commands: the first adds the
product to the cart, the second finalizes the transaction. This also
means that "<productid> <username> <productid> <username>" was four
separate commands, resulting in TWO transactions.

That's all fine and useful, but when using this advanced input method,
where input is split on whitespace, it lead to unexpected results if
there are insufficient arguments for the follow-up questions of a
command. For example, "take jantje 10 take pietje 10" will interpret the
second "take" as the description, then "pietje" als the first command of
a new transaction, and finally, "10" which is typically not a valid
command. It is much more likely that the user intended two separate
"take" commands and just forgot to provide the description argument, but
RevBank had no way of inferring that intent.

From this commit on, whenever the user intends to enter further input
words beyond the one that finalizes a transaction ($cart->checkout), a
';' is required. If trailing input is present, the checkout is refused
and the user gets a retry prompt.

Similarly, if the user indicates the intention of having finished a
command by inserting a ';' while there are insufficient words in the
command line to satisfy all follow-up prompts (command arguments), the
rest of the command line is rejected with a retry prompt.

There is, however, still no specific requirement for a ';' separator
after a command that does not finalize a transaction (e.g. "<productid>
<username>" or even "<productid> x2 <productid> <username>" remains
valid), or for a command that precedes a ';' to finalize a transaction
(e.g. "<productid>; <username>;" is also valid).

This change catches many, but not all, mistakes.
This commit is contained in:
Juerd Waalboer 2023-12-26 00:21:01 +01:00
parent b5efbcdff9
commit daf0077d0d
2 changed files with 57 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

20
lib/RevBank/Cart.pm
View file

@ -11,6 +11,12 @@ use RevBank::Users;
use RevBank::FileIO;
use RevBank::Cart::Entry;
{
package RevBank::Cart::CheckoutProhibited;
sub new($class, $reason) { return bless \$reason, $class; }
sub reason($self) { return $$self; }
}
sub new($class) {
return bless { entries => [] }, $class;
}
@ -70,7 +76,21 @@ sub size($self) {
return scalar @{ $self->{entries} };
}
sub prohibit_checkout($self, $bool, $reason) {
if ($bool) {
$self->{prohibited} = $reason;
} else {
delete $self->{prohibited};
}
}
sub checkout($self, $user) {
if ($self->{prohibited}) {
die RevBank::Cart::CheckoutProhibited->new(
"Cannot complete transaction: $self->{prohibited}"
);
}
if ($self->entries('refuse_checkout')) {
$self->display;
die "Refusing to finalize deficient transaction";

47
revbank
View file

@ -2,7 +2,7 @@
use v5.32;
use warnings;
use feature qw(signatures);
use feature qw(signatures isa);
no warnings "experimental::signatures";
use IO::Select;
@ -17,14 +17,14 @@ use RevBank::Global;
use RevBank::Messages;
use RevBank::Cart;
our $VERSION = "4.3.0";
our $VERSION = "5.0.0-beta";
our %HELP1 = (
"abort" => "Abort the current transaction",
);
my @words;
my $retry;
my @retry;
my @words; # input
my $retry; # reason (text)
my @retry; # (@accepted, $rejected, [@trailing])
my $one_off = 0;
@ -84,6 +84,7 @@ sub prompt($prompt, $plugins, $completions) {
my @trailing = @{ pop @retry };
my @rejected = pop @retry;
my @accepted = @retry;
s/\0SEPARATOR/;/ for @accepted, @rejected, @trailing;
$readline->insert_text(join " ", @accepted, @rejected, @trailing);
$readline->Attribs->{point} = @accepted ? 1 + length "@accepted" : 0;
@retry = ();
@ -131,7 +132,7 @@ RevBank::Plugins->load;
call_hooks("startup");
OUTER: for (;;) {
if (not @words) {
if (not @words or $words[0] eq "\0SEPARATOR") {
call_hooks("cart_changed", $cart) if $cart->changed;
print "\n";
}
@ -169,7 +170,10 @@ OUTER: for (;;) {
length $input or redo PROMPT;
@words = ($split_input ? split(" ", $input) : $input);
@words = ($split_input
? map { $_ eq ';' ? "\0SEPARATOR" : $_ } grep length, split(/\s+|(;)/, $input)
: $input
);
}
WORD: for (;;) {
@ -181,8 +185,23 @@ OUTER: for (;;) {
push @retry, $word;
ALL_PLUGINS: { PLUGIN: for my $plugin (@plugins) {
next WORD if $word eq "\0SEPARATOR";
$cart->prohibit_checkout(
@words && $words[0] ne "\0SEPARATOR",
"unexpected trailing input (use ';' to separate transactions)."
);
my ($rv, @rvargs) = eval { $plugin->$method($cart, $word) };
if ($@) {
if ($@ isa 'RevBank::Cart::CheckoutProhibited') {
@words or die "Internal inconsistency"; # other cause than trailing input
push @retry, shift @words; # reject next word (first of trailing)
push @retry, [@words];
@words = ();
$retry = $@->reason;
redo OUTER;
} elsif ($@) {
call_hooks "plugin_fail", $plugin->id, "$method: $@";
abort;
}
@ -191,13 +210,22 @@ OUTER: for (;;) {
abort;
}
if (not ref $rv) {
abort "Incomplete command." if $one_off and not @words;
if (@words and $words[0] eq "\0SEPARATOR") {
push @retry, shift @words; # reject the ';'
push @retry, [@words];
@words = ();
$retry = "Incomplete command (expected: $rv)";
redo OUTER;
}
$prompt = $rv;
@plugins = $plugin;
($method) = @rvargs;
call_hooks "plugin_fail", $plugin->id, "$method: No method supplied"
if not ref $method;
abort "Incomplete command." if $one_off and not @words;
next WORD;
}
if ($rv == ABORT) {
@ -212,7 +240,6 @@ OUTER: for (;;) {
}
if ($rv == REJECT) {
my ($reason) = @rvargs;
#abort if @words;
if (@words) {
call_hooks "retry", $plugin->id, $reason, @words ? 1 : 0;
push @retry, [@words];