From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-Status: No, score=-4.0 required=3.0 tests=ALL_TRUSTED,BAYES_00 shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from localhost (dcvr.yhbt.net [127.0.0.1]) by dcvr.yhbt.net (Postfix) with ESMTP id 1E07D1FF9E for ; Fri, 18 Dec 2020 12:09:52 +0000 (UTC) From: Eric Wong To: meta@public-inbox.org Subject: [PATCH 14/26] lei: help: show actual paths being operated on Date: Fri, 18 Dec 2020 12:09:38 +0000 Message-Id: <20201218120950.23272-15-e@80x24.org> In-Reply-To: <20201218120950.23272-1-e@80x24.org> References: <20201218120950.23272-1-e@80x24.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit List-Id: This allows us to respect XDG_* environment variables to override HOME. We'll also make the $lei wrapper easier-to-use by auto-clearing $out/$err and reducing [] needed for common cases. --- lib/PublicInbox/LEI.pm | 42 +++++++++++++++++++++++++++--------------- t/lei.t | 27 ++++++++++++++++++++++----- 2 files changed, 49 insertions(+), 20 deletions(-) diff --git a/lib/PublicInbox/LEI.pm b/lib/PublicInbox/LEI.pm index dbd2875d..667ef765 100644 --- a/lib/PublicInbox/LEI.pm +++ b/lib/PublicInbox/LEI.pm @@ -35,6 +35,20 @@ our %PATH2CFG; # persistent for socket daemon # (may) pass options through to another command: sub pass_through { $GLP_PASS } +sub _store_path ($) { + my ($env) = @_; + File::Spec->rel2abs(($env->{XDG_DATA_HOME} // + ($env->{HOME} // '/nonexistent').'/.local/share') + .'/lei/store', $env->{PWD}); +} + +sub _config_path ($) { + my ($env) = @_; + File::Spec->rel2abs(($env->{XDG_CONFIG_HOME} // + ($env->{HOME} // '/nonexistent').'/.config') + .'/lei/config', $env->{PWD}); +} + # TODO: generate shell completion + help using %CMD and %OPTDESC # command => [ positional_args, 1-line description, Getopt::Long option spec ] our %CMD = ( # sorted in order of importance/use: @@ -99,12 +113,13 @@ our %CMD = ( # sorted in order of importance/use: qw(stdin| limit|n=i offset=i recursive|r exclude=s include=s !flags), ], -'config' => [ '[...]', 'git-config(1) wrapper for ~/.config/lei/config', - qw(config-file|system|global|file|f=s), # conflict detection +'config' => [ '[...]', sub { + 'git-config(1) wrapper for '._config_path($_[0]); + }, qw(config-file|system|global|file|f=s), # for conflict detection pass_through('git config') ], -'init' => [ '[PATHNAME]', - 'initialize storage, default: ~/.local/share/lei/store', - qw(quiet|q) ], +'init' => [ '[PATHNAME]', sub { + 'initialize storage, default: '._store_path($_[0]); + }, qw(quiet|q) ], 'daemon-stop' => [ '', 'stop the lei-daemon' ], 'daemon-pid' => [ '', 'show the PID of the lei-daemon' ], 'daemon-env' => [ '[NAME=VALUE...]', 'set, unset, or show daemon environment', @@ -233,9 +248,10 @@ sub _help ($;$) { my @info = @{$CMD{$cmd} // [ '...', '...' ]}; my @top = ($cmd, shift(@info) // ()); my $cmd_desc = shift(@info); + $cmd_desc = $cmd_desc->($client->{env}) if ref($cmd_desc) eq 'CODE'; my @opt_desc; my $lpad = 2; - for my $sw (grep { !ref($_) } @info) { # ("prio=s", "z", $GLP_PASS) + for my $sw (grep { !ref } @info) { # ("prio=s", "z", $GLP_PASS) my $desc = $OPTDESC{"$cmd\t$sw"} // $OPTDESC{$sw} // next; my $arg_vals = ''; ($arg_vals, $desc) = @$desc if ref($desc) eq 'ARRAY'; @@ -307,8 +323,8 @@ sub optparse ($$$) { my ($client, $cmd, $argv) = @_; $client->{cmd} = $cmd; my $opt = $client->{opt} = {}; - my $info = $CMD{$cmd} // [ '[...]', '(undocumented command)' ]; - my ($proto, $desc, @spec) = @$info; + my $info = $CMD{$cmd} // [ '[...]' ]; + my ($proto, undef, @spec) = @$info; my $glp = ref($spec[-1]) ? pop(@spec) : $GLP; # or $GLP_PASS push @spec, qw(help|h); my $lone_dash; @@ -389,10 +405,7 @@ sub dispatch { sub _lei_cfg ($;$) { my ($client, $creat) = @_; - my $env = $client->{env}; - my $cfg_dir = File::Spec->canonpath(( $env->{XDG_CONFIG_HOME} // - ($env->{HOME} // '/nonexistent').'/.config').'/lei'); - my $f = "$cfg_dir/config"; + my $f = _config_path($client->{env}); my @st = stat($f); my $cur_st = @st ? pack('dd', $st[10], $st[7]) : ''; # 10:ctime, 7:size if (my $cfg = $PATH2CFG{$f}) { # reuse existing object in common case @@ -403,6 +416,7 @@ sub _lei_cfg ($;$) { delete $client->{cfg}; return; } + my (undef, $cfg_dir, undef) = File::Spec->splitpath($f); -d $cfg_dir or mkpath($cfg_dir) or die "mkpath($cfg_dir): $!\n"; open my $fh, '>>', $f or die "open($f): $!\n"; @st = stat($fh) or die "fstat($f): $!\n"; @@ -456,9 +470,7 @@ sub lei_init { my $cfg = _lei_cfg($client, 1); my $cur = $cfg->{'leistore.dir'}; my $env = $client->{env}; - $dir //= ( $env->{XDG_DATA_HOME} // - ($env->{HOME} // '/nonexistent').'/.local/share' - ) . '/lei/store'; + $dir //= _store_path($env); $dir = File::Spec->rel2abs($dir, $env->{PWD}); # PWD is symlink-aware my @cur = stat($cur) if defined($cur); $cur = File::Spec->canonpath($cur) if $cur; diff --git a/t/lei.t b/t/lei.t index b0943962..bdf6cc1c 100644 --- a/t/lei.t +++ b/t/lei.t @@ -9,13 +9,18 @@ use PublicInbox::Config; use File::Path qw(rmtree); require_mods(qw(json DBD::SQLite Search::Xapian)); my $LEI = 'lei'; +my $opt = { 1 => \(my $out = ''), 2 => \(my $err = '') }; my $lei = sub { my ($cmd, $env, $opt) = @_; + $out = $err = ''; + if (!ref($cmd)) { + ($env, $opt) = grep { (!defined) || ref } @_; + $cmd = [ grep { defined } @_ ]; + } run_script([$LEI, @$cmd], $env, $opt); }; my ($home, $for_destroy) = tmpdir(); -my $opt = { 1 => \(my $out = ''), 2 => \(my $err = '') }; delete local $ENV{XDG_DATA_HOME}; delete local $ENV{XDG_CONFIG_HOME}; local $ENV{XDG_RUNTIME_DIR} = "$home/xdg_run"; @@ -23,10 +28,7 @@ local $ENV{HOME} = $home; local $ENV{FOO} = 'BAR'; mkdir "$home/xdg_run", 0700 or BAIL_OUT "mkdir: $!"; my $home_trash = [ "$home/.local", "$home/.config" ]; -my $cleanup = sub { - rmtree([@$home_trash, @_]); - $out = $err = ''; -}; +my $cleanup = sub { rmtree([@$home_trash, @_]) }; my $test_help = sub { ok(!$lei->([], undef, $opt), 'no args fails'); @@ -48,6 +50,21 @@ my $test_help = sub { isnt($err, '', 'something in stderr'); is($out, '', 'nothing in stdout'); } + ok($lei->(qw(init -h), undef, $opt), 'init -h'); + like($out, qr! \Q$home\E/\.local/share/lei/store\b!, + 'actual path shown in init -h'); + ok($lei->(qw(init -h), { XDG_DATA_HOME => '/XDH' }, $opt), + 'init with XDG_DATA_HOME'); + like($out, qr! /XDH/lei/store\b!, 'XDG_DATA_HOME in init -h'); + is($err, '', 'no errors from init -h'); + + ok($lei->(qw(config -h), undef, $opt), 'config-h'); + like($out, qr! \Q$home\E/\.config/lei/config\b!, + 'actual path shown in config -h'); + ok($lei->(qw(config -h), { XDG_CONFIG_HOME => '/XDC' }, $opt), + 'config with XDG_CONFIG_HOME'); + like($out, qr! /XDC/lei/config\b!, 'XDG_CONFIG_HOME in config -h'); + is($err, '', 'no errors from config -h'); }; my $ok_err_info = sub {