Syntax cleanup

1 files changed, 215 insertions, 203 deletions

diff --git a/lib/App/Raps2.pm b/lib/App/Raps2.pm
index 0f1fdc4..4a204aa 100644
--- a/lib/App/Raps2.pm
+++ b/lib/App/Raps2.pm
@@ -1,32 +1,5 @@
 package App::Raps2;
 
-=head1 NAME
-
-App::Raps2 - A Password safe
-
-=head1 SYNOPSIS
-
-    use App::Raps2;
-
-    my $raps2 = App::Raps2->new();
-    my ($action, @args) = @ARGV;
-
-    $raps2->sanity_check();
-    $raps2->load_config();
-
-    given ($action) {
-        when ('add')  { $raps2->cmd_add(@args) }
-        when ('dump') { $raps2->cmd_dump(@args) }
-        when ('get')  { $raps2->cmd_get(@args) }
-        when ('info') { $raps2->cmd_info(@args) }
-    }
-
-=head1 DESCRIPTION
-
-B<App::Raps2> is the backend for B<raps2>, a simple commandline password safe.
-
-=cut
-
 use strict;
 use warnings;
 use 5.010;
@@ -40,28 +13,8 @@ use File::Slurp qw(read_dir slurp write_file);
 
 our $VERSION = '0.3';
 
-=head1 METHODS
-
-=over
-
-=item $raps2 = App::Raps2->new(I<%conf>)
-
-Returns a new B<App::Raps2> object.
-
-Accepted configuration parameters are:
-
-=over
-
-=item B<cost> => I<int>
-
-B<cost> of key setup, passed on to App::Raps2::Password(3pm).
-
-=back
-
-=cut
-
 sub new {
-	my ($obj, %conf) = @_;
+	my ( $obj, %conf ) = @_;
 	my $ref = {};
 
 	$ref->{xdg_conf} = config_home('raps2');
@@ -71,24 +24,17 @@ sub new {
 
 	$ref->{default} = \%conf;
 
-	return bless($ref, $obj);
+	return bless( $ref, $obj );
 }
 
-=item $raps2->file_to_hash(I<$file>)
-
-Reads $file (lines with key/value separated by whitespace) and returns a hash
-with its key/value pairs.
-
-=cut
-
 sub file_to_hash {
-	my ($self, $file) = @_;
+	my ( $self, $file ) = @_;
 	my %ret;
 
-	for my $line (slurp($file)) {
-		my ($key, $value) = split(qr{\s+}, $line);
+	for my $line ( slurp($file) ) {
+		my ( $key, $value ) = split( qr{ \s+ }x, $line );
 
-		if (not ($key and $value)) {
+		if ( not( $key and $value ) ) {
 			next;
 		}
 
@@ -97,63 +43,44 @@ sub file_to_hash {
 	return %ret;
 }
 
-=item $raps2->sanity_check()
-
-Create working directories (~/.config/raps2 and ~/.local/share/raps2, or the
-respective XDG environment variable contents), if they don't exist yet.
-
-Calls B<create_config> if no raps2 config was found.
-
-=cut
-
 sub sanity_check {
 	my ($self) = @_;
 
-	make_path($self->{xdg_conf});
-	make_path($self->{xdg_data});
+	make_path( $self->{xdg_conf} );
+	make_path( $self->{xdg_data} );
 
-	if (not -e $self->{xdg_conf} . '/password') {
+	if ( not -e $self->{xdg_conf} . '/password' ) {
 		$self->create_config();
 	}
 
 	return;
 }
 
-=item $raps2->get_master_password()
-
-Asks the user for the master passphrase.
-
-=cut
-
 sub get_master_password {
 	my ($self) = @_;
-	my $pass = $self->ui->read_pw('Master Password', 0);
+	my $pass = $self->ui->read_pw( 'Master Password', 0 );
 
 	$self->{pass} = App::Raps2::Password->new(
-		cost => $self->{default}->{cost},
-		salt => $self->{master_salt},
+		cost       => $self->{default}->{cost},
+		salt       => $self->{master_salt},
 		passphrase => $pass,
 	);
 
-	$self->{pass}->verify($self->{master_hash});
-}
-
-=item $raps2->create_config()
-
-Creates a default config and asks the user to set a master password.
+	$self->{pass}->verify( $self->{master_hash} );
 
-=cut
+	return;
+}
 
 sub create_config {
 	my ($self) = @_;
 	my $cost = 12;
-	my $pass = $self->ui->read_pw('Master Password', 1);
+	my $pass = $self->ui->read_pw( 'Master Password', 1 );
 
 	$self->{pass} = App::Raps2::Password->new(
-		cost => $cost,
+		cost       => $cost,
 		passphrase => $pass,
 	);
-	my $hash = $self->pw->crypt();
+	my $hash = $self->pw->bcrypt();
 	my $salt = $self->pw->salt();
 
 	write_file(
@@ -162,61 +89,47 @@ sub create_config {
 		"salt ${salt}\n",
 		"hash ${hash}\n",
 	);
-}
-
-=item $raps2->load_config()
 
-Load config
-
-=cut
+	return;
+}
 
 sub load_config {
 	my ($self) = @_;
-	my %cfg = $self->file_to_hash($self->{xdg_conf} . '/password');
+	my %cfg = $self->file_to_hash( $self->{xdg_conf} . '/password' );
 	$self->{master_hash} = $cfg{hash};
 	$self->{master_salt} = $cfg{salt};
 	$self->{default}->{cost} //= $cfg{cost};
-}
-
-=item $raps2->pw()
-
-Returns the App::Raps2::Password(3pm) object.
 
-=cut
+	return;
+}
 
 sub pw {
 	my ($self) = @_;
 
-	if (defined $self->{pass}) {
+	if ( defined $self->{pass} ) {
 		return $self->{pass};
 	}
 	else {
-		confess('No App::Raps2::Password object, did you call get_master_password?');
+		confess(
+			'No App::Raps2::Password object, did you call get_master_password?'
+		);
 	}
-}
-
-=item $raps2->ui()
-
-Returns the App::Raps2::UI(3pm) object.
 
-=cut
+	return;
+}
 
 sub ui {
 	my ($self) = @_;
+
 	return $self->{ui};
 }
 
-=item $raps2->cmd_add(I<$name>)
-
-Adds a new password file called $name.
-
-=cut
-
 sub cmd_add {
-	my ($self, $name) = @_;
+	my ( $self, $name ) = @_;
+
 	my $pwfile = $self->{xdg_data} . "/${name}";
 
-	if (-e $pwfile) {
+	if ( -e $pwfile ) {
 		confess('Password file already exists');
 	}
 
@@ -225,39 +138,34 @@ sub cmd_add {
 	my $salt  = $self->pw->create_salt();
 	my $url   = $self->ui->read_line('URL');
 	my $login = $self->ui->read_line('Login');
-	my $pass  = $self->ui->read_pw('Password', 1);
+	my $pass  = $self->ui->read_pw( 'Password', 1 );
 	my $extra = $self->ui->read_multiline('Additional content');
 
 	$self->pw->salt($salt);
-	my $pass_hash = $self->pw->encrypt($pass);
+	my $pass_hash  = $self->pw->encrypt($pass);
 	my $extra_hash = (
-		$extra ?
-		$self->pw->encrypt($extra) :
-		q{}
+		  $extra
+		? $self->pw->encrypt($extra)
+		: q{}
 	);
 
-
 	write_file(
-		$pwfile,
-		"url ${url}\n",
+		$pwfile, "url ${url}\n",
 		"login ${login}\n",
 		"salt ${salt}\n",
 		"hash ${pass_hash}\n",
 		"extra ${extra_hash}\n",
 	);
-}
-
-=item $raps2->cmd_dump(I<$account>)
 
-Dumps the content of I<account>
-
-=cut
+	return;
+}
 
 sub cmd_dump {
-	my ($self, $name) = @_;
+	my ( $self, $name ) = @_;
+
 	my $pwfile = $self->{xdg_data} . "/${name}";
 
-	if (not -e $pwfile) {
+	if ( not -e $pwfile ) {
 		confess('Password file does not exist');
 	}
 
@@ -265,45 +173,42 @@ sub cmd_dump {
 
 	$self->get_master_password();
 
-	$self->pw->salt($key{salt});
+	$self->pw->salt( $key{salt} );
 
 	$self->ui()->output(
-		['URL', $key{url}],
-		['Login', $key{login}],
-		['Password', $self->pw->decrypt($key{hash})],
+		[ 'URL',      $key{url} ],
+		[ 'Login',    $key{login} ],
+		[ 'Password', $self->pw->decrypt( $key{hash} ) ],
 	);
-	if ($key{extra}) {
-		print $self->pw->decrypt($key{extra});
+	if ( $key{extra} ) {
+		print $self->pw->decrypt( $key{extra} );
 	}
-}
-
-=item $raps2->cmd_edit(I<$acount>)
 
-Edit I<account>.
-
-=cut
+	return;
+}
 
 sub cmd_edit {
-	my ($self, $name) = @_;
+	my ( $self, $name ) = @_;
+
 	my $pwfile = $self->{xdg_data} . "/${name}";
 	my $pass_hash;
 
-	if (not -e $pwfile) {
+	if ( not -e $pwfile ) {
 		confess('Password file does not exist');
 	}
 
 	my %key = $self->file_to_hash($pwfile);
 
 	$self->get_master_password();
-	$self->pw->salt($key{salt});
+	$self->pw->salt( $key{salt} );
 
-	my $salt = $key{salt};
-	my $url   = $self->ui->read_line('URL', $key{url});
-	my $login = $self->ui->read_line('Login', $key{login});
-	my $pass  = $self->ui->read_pw('New password (empty to keep old)', 1);
+	my $salt  = $key{salt};
+	my $url   = $self->ui->read_line( 'URL', $key{url} );
+	my $login = $self->ui->read_line( 'Login', $key{login} );
+	my $pass  = $self->ui->read_pw( 'New password (empty to keep old)', 1 );
 	my $extra = $key{extra} // q{};
 
-	if (length($pass)) {
+	if ( length($pass) ) {
 		$pass_hash = $self->pw->encrypt($pass);
 	}
 	else {
@@ -311,26 +216,22 @@ sub cmd_edit {
 	}
 
 	write_file(
-		$pwfile,
-		"url ${url}\n",
+		$pwfile, "url ${url}\n",
 		"login ${login}\n",
 		"salt ${salt}\n",
 		"hash ${pass_hash}\n",
 		"extra ${extra}\n",
 	);
-}
-
-=item $raps2->cmd_get(I<$name>)
 
-Puts the password saved in $name into the X clipboard.
-
-=cut
+	return;
+}
 
 sub cmd_get {
-	my ($self, $name) = @_;
+	my ( $self, $name ) = @_;
+
 	my $pwfile = $self->{xdg_data} . "/${name}";
 
-	if (not -e $pwfile) {
+	if ( not -e $pwfile ) {
 		confess('Password file does not exist');
 	}
 
@@ -338,79 +239,190 @@ sub cmd_get {
 
 	$self->get_master_password();
 
-	$self->pw->salt($key{salt});
+	$self->pw->salt( $key{salt} );
 
-	$self->ui()->to_clipboard($self->pw->decrypt($key{hash}));
+	$self->ui()->to_clipboard( $self->pw->decrypt( $key{hash} ) );
 
-	if ($key{extra}) {
-		print $self->pw->decrypt($key{extra})
+	if ( $key{extra} ) {
+		print $self->pw->decrypt( $key{extra} );
 	}
-}
-
-=item $raps2->cmd_info(I<$name>)
 
-Prints unencrypted information about $name.
-
-=cut
+	return;
+}
 
 sub cmd_info {
-	my ($self, $name) = @_;
+	my ( $self, $name ) = @_;
+
 	my $pwfile = $self->{xdg_data} . "/${name}";
 
-	if (not -e $pwfile) {
+	if ( not -e $pwfile ) {
 		confess('Password file does not exist');
 	}
 
 	my %key = $self->file_to_hash($pwfile);
-	$self->ui()->output(
-		['URL', $key{url}],
-		['Login', $key{login}],
-	);
-}
+	$self->ui()->output( [ 'URL', $key{url} ], [ 'Login', $key{login} ], );
 
-=item $raps2->cmd_list()
-
-Lists all saved passwords and their logins and urls
-
-=cut
+	return;
+}
 
 sub cmd_list {
 	my ($self) = @_;
-	my @files = read_dir($self->{xdg_data});
 
-	for my $file (sort @files) {
-		my %key = $self->file_to_hash($self->{xdg_data} . "/${file}");
+	my @files = read_dir( $self->{xdg_data} );
+
+	for my $file ( sort @files ) {
+		my %key = $self->file_to_hash( $self->{xdg_data} . "/${file}" );
 		$self->ui->list(
-			['Account', $file],
-			['Login', $key{login}],
-			['URL', $key{url}],
+			[ 'Account', $file ],
+			[ 'Login',   $key{login} ],
+			[ 'URL',     $key{url} ],
 		);
 	}
-}
-
-=item $raps2->cmd_remove(I<$name>)
-
-Remove (unlink) the account I<name>.
 
-=cut
+	return;
+}
 
 sub cmd_remove {
-	my ($self, $name) = @_;
+	my ( $self, $name ) = @_;
+
 	my $pwfile = $self->{xdg_data} . "/${name}";
 
-	if (-e $pwfile) {
+	if ( -e $pwfile ) {
 		unlink($pwfile);
 	}
 	else {
 		say STDERR 'File did not exist, so could not be removed';
 	}
+
+	return;
 }
 
+1;
+
+__END__
+
+=head1 NAME
+
+App::Raps2 - A Password safe
+
+=head1 SYNOPSIS
+
+    use App::Raps2;
+
+    my $raps2 = App::Raps2->new();
+    my ($action, @args) = @ARGV;
+
+    $raps2->sanity_check();
+    $raps2->load_config();
+
+    given ($action) {
+        when ('add')  { $raps2->cmd_add(@args) }
+        when ('dump') { $raps2->cmd_dump(@args) }
+        when ('get')  { $raps2->cmd_get(@args) }
+        when ('info') { $raps2->cmd_info(@args) }
+    }
+
+=head1 DESCRIPTION
+
+B<App::Raps2> is the backend for B<raps2>, a simple commandline password safe.
+
+=head1 VERSION
+
+This manual documents App::Raps2 version 0.3
+
+=head1 METHODS
+
+=over
+
+=item $raps2 = App::Raps2->new(I<%conf>)
+
+Returns a new B<App::Raps2> object.
+
+Accepted configuration parameters are:
+
+=over
+
+=item B<cost> => I<int>
+
+B<cost> of key setup, passed on to App::Raps2::Password(3pm).
+
 =back
 
+=item $raps2->file_to_hash(I<$file>)
+
+Reads $file (lines with key/value separated by whitespace) and returns a hash
+with its key/value pairs.
+
+=item $raps2->sanity_check()
+
+Create working directories (~/.config/raps2 and ~/.local/share/raps2, or the
+respective XDG environment variable contents), if they don't exist yet.
+
+Calls B<create_config> if no raps2 config was found.
+
+=item $raps2->get_master_password()
+
+Asks the user for the master passphrase.
+
+=item $raps2->create_config()
+
+Creates a default config and asks the user to set a master password.
+
+=item $raps2->load_config()
+
+Load config
+
+=item $raps2->pw()
+
+Returns the App::Raps2::Password(3pm) object.
+
+=item $raps2->ui()
+
+Returns the App::Raps2::UI(3pm) object.
+
+=item $raps2->cmd_add(I<$name>)
+
+Adds a new password file called $name.
+
+=item $raps2->cmd_dump(I<$account>)
+
+Dumps the content of I<account>
+
+=item $raps2->cmd_edit(I<$acount>)
+
+Edit I<account>.
+
+=item $raps2->cmd_get(I<$name>)
+
+Puts the password saved in $name into the X clipboard.
+
+=item $raps2->cmd_info(I<$name>)
+
+Prints unencrypted information about $name.
+
+=item $raps2->cmd_list()
+
+Lists all saved passwords and their logins and urls
+
+=item $raps2->cmd_remove(I<$name>)
+
+Remove (unlink) the account I<name>.
+
+=back
+
+=head1 DIAGNOSTICS
+
+If anything goes wrong, B<App::Raps2> will die with a backtrace (using
+B<confess> from Carp(3pm)).
+
 =head1 DEPENDENCIES
 
-L<App::Raps2::Password>, L<App::Raps2::UI>, L<File::BaseDir>, L<File::Slurp>.
+App::Raps2::Password(3pm), App::Raps2::UI(3pm), File::BaseDir(3pm),
+File::Slurp(3pm).
+
+=head1 BUGS AND LIMITATIONS
+
+Unknown.
 
 =head1 AUTHOR