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 735A11FFA5 for ; Thu, 31 Dec 2020 13:51:56 +0000 (UTC) From: Eric Wong To: meta@public-inbox.org Subject: [PATCH 17/36] lei: rename "extinbox" => "external" Date: Thu, 31 Dec 2020 13:51:35 +0000 Message-Id: <20201231135154.6070-18-e@80x24.org> In-Reply-To: <20201231135154.6070-1-e@80x24.org> References: <20201231135154.6070-1-e@80x24.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit List-Id: The words "extinbox" and "extindex" are too close and easy to confuse with the other. Rename "extinbox" to "external", since these could be IMAP, JMAP or other non-public-inbox search APIs. Link: https://public-inbox.org/meta/20201226112649.GB6226@dcvr/ --- MANIFEST | 2 +- lib/PublicInbox/LEI.pm | 12 +++++----- .../{LeiExtinbox.pm => LeiExternal.pm} | 18 +++++++-------- lib/PublicInbox/LeiXSearch.pm | 2 +- t/lei.t | 22 +++++++++---------- t/lei_xsearch.t | 2 +- 6 files changed, 29 insertions(+), 29 deletions(-) rename lib/PublicInbox/{LeiExtinbox.pm => LeiExternal.pm} (75%) diff --git a/MANIFEST b/MANIFEST index 96ad52bf..6dc08f01 100644 --- a/MANIFEST +++ b/MANIFEST @@ -164,7 +164,7 @@ lib/PublicInbox/Isearch.pm lib/PublicInbox/KQNotify.pm lib/PublicInbox/LEI.pm lib/PublicInbox/LeiDedupe.pm -lib/PublicInbox/LeiExtinbox.pm +lib/PublicInbox/LeiExternal.pm lib/PublicInbox/LeiSearch.pm lib/PublicInbox/LeiStore.pm lib/PublicInbox/LeiToMail.pm diff --git a/lib/PublicInbox/LEI.pm b/lib/PublicInbox/LEI.pm index 9aa4d95a..f960aa72 100644 --- a/lib/PublicInbox/LEI.pm +++ b/lib/PublicInbox/LEI.pm @@ -8,7 +8,7 @@ package PublicInbox::LEI; use strict; use v5.10.1; -use parent qw(PublicInbox::DS PublicInbox::LeiExtinbox); +use parent qw(PublicInbox::DS PublicInbox::LeiExternal); use Getopt::Long (); use Socket qw(AF_UNIX SOCK_STREAM pack_sockaddr_un); use Errno qw(EAGAIN ECONNREFUSED ENOENT); @@ -70,19 +70,19 @@ sub _config_path ($) { our %CMD = ( # sorted in order of importance/use: 'q' => [ 'SEARCH_TERMS...', 'search for messages matching terms', qw( save-as=s output|o=s format|f=s dedupe|d=s thread|t augment|a - sort|s=s@ reverse|r offset=i remote local! extinbox! + sort|s=s@ reverse|r offset=i remote local! external! since|after=s until|before=s), opt_dash('limit|n=i', '[0-9]+') ], 'show' => [ 'MID|OID', 'show a given object (Message-ID or object ID)', qw(type=s solve! format|f=s dedupe|d=s thread|t remote local!), pass_through('git show') ], -'add-extinbox' => [ 'URL_OR_PATHNAME', +'add-external' => [ 'URL_OR_PATHNAME', 'add/set priority of a publicinbox|extindex for extra matches', qw(boost=i quiet|q) ], -'ls-extinbox' => [ '[FILTER...]', 'list publicinbox|extindex locations', +'ls-external' => [ '[FILTER...]', 'list publicinbox|extindex locations', qw(format|f=s z|0 local remote quiet|q) ], -'forget-extinbox' => [ '{URL_OR_PATHNAME|--prune}', +'forget-external' => [ '{URL_OR_PATHNAME|--prune}', 'exclude further results from a publicinbox|extindex', qw(prune quiet|q) ], @@ -189,7 +189,7 @@ my %OPTDESC = ( 'q format|f=s' => [ 'OUT|maildir|mboxrd|mboxcl2|mboxcl|html|oid|json', 'specify output format, default depends on --output'], 'ls-query format|f=s' => $ls_format, -'ls-extinbox format|f=s' => $ls_format, +'ls-external format|f=s' => $ls_format, 'limit|n=i@' => ['NUM', 'limit on number of matches (default: 10000)' ], 'offset=i' => ['OFF', 'search result offset (default: 0)'], diff --git a/lib/PublicInbox/LeiExtinbox.pm b/lib/PublicInbox/LeiExternal.pm similarity index 75% rename from lib/PublicInbox/LeiExtinbox.pm rename to lib/PublicInbox/LeiExternal.pm index c2de7735..0378551a 100644 --- a/lib/PublicInbox/LeiExtinbox.pm +++ b/lib/PublicInbox/LeiExternal.pm @@ -1,22 +1,22 @@ # Copyright (C) 2020 all contributors # License: AGPL-3.0+ -# *-extinbox commands of lei -package PublicInbox::LeiExtinbox; +# *-external commands of lei +package PublicInbox::LeiExternal; use strict; use v5.10.1; use parent qw(Exporter); -our @EXPORT = qw(lei_ls_extinbox lei_add_extinbox lei_forget_extinbox); +our @EXPORT = qw(lei_ls_external lei_add_external lei_forget_external); -sub lei_ls_extinbox { +sub lei_ls_external { my ($self, @argv) = @_; my $stor = $self->_lei_store(0); my $cfg = $self->_lei_cfg(0); my $out = $self->{1}; my ($OFS, $ORS) = $self->{opt}->{z} ? ("\0", "\0\0") : (" ", "\n"); my (%boost, @loc); - for my $sec (grep(/\Aextinbox\./, @{$cfg->{-section_order}})) { - my $loc = substr($sec, length('extinbox.')); + for my $sec (grep(/\Aexternal\./, @{$cfg->{-section_order}})) { + my $loc = substr($sec, length('external.')); $boost{$loc} = $cfg->{"$sec.boost"}; push @loc, $loc; } @@ -28,14 +28,14 @@ sub lei_ls_extinbox { } } -sub lei_add_extinbox { +sub lei_add_external { my ($self, $url_or_dir) = @_; my $cfg = $self->_lei_cfg(1); if ($url_or_dir !~ m!\Ahttps?://!) { $url_or_dir = File::Spec->canonpath($url_or_dir); } my $new_boost = $self->{opt}->{boost} // 0; - my $key = "extinbox.$url_or_dir.boost"; + my $key = "external.$url_or_dir.boost"; my $cur_boost = $cfg->{$key}; return if defined($cur_boost) && $cur_boost == $new_boost; # idempotent $self->lei_config($key, $new_boost); @@ -44,7 +44,7 @@ sub lei_add_extinbox { $stor->done; } -sub lei_forget_extinbox { +sub lei_forget_external { # TODO } diff --git a/lib/PublicInbox/LeiXSearch.pm b/lib/PublicInbox/LeiXSearch.pm index 1a81b14a..7d251afd 100644 --- a/lib/PublicInbox/LeiXSearch.pm +++ b/lib/PublicInbox/LeiXSearch.pm @@ -18,7 +18,7 @@ sub new { }, $class } -sub attach_extinbox { +sub attach_external { my ($self, $ibxish) = @_; # ibxish = ExtSearch or Inbox if (!$ibxish->can('over')) { push @{$self->{remotes}}, $ibxish diff --git a/t/lei.t b/t/lei.t index a95a0efc..764a7fe4 100644 --- a/t/lei.t +++ b/t/lei.t @@ -154,38 +154,38 @@ my $setup_publicinboxes = sub { $seen || BAIL_OUT 'no imports'; }; -my $test_extinbox = sub { +my $test_external = sub { $setup_publicinboxes->(); $cleanup->(); - $lei->('ls-extinbox'); - is($out.$err, '', 'ls-extinbox no output, yet'); + $lei->('ls-external'); + is($out.$err, '', 'ls-external no output, yet'); ok(!-e $config_file && !-e $store_dir, - 'nothing created by ls-extinbox'); + 'nothing created by ls-external'); my $cfg = PublicInbox::Config->new; $cfg->each_inbox(sub { my ($ibx) = @_; - ok($lei->(qw(add-extinbox -q), $ibx->{inboxdir}), - 'added extinbox'); + ok($lei->(qw(add-external -q), $ibx->{inboxdir}), + 'added external'); is($out.$err, '', 'no output'); }); ok(-s $config_file && -e $store_dir, - 'add-extinbox created config + store'); + 'add-external created config + store'); my $lcfg = PublicInbox::Config->new($config_file); $cfg->each_inbox(sub { my ($ibx) = @_; - is($lcfg->{"extinbox.$ibx->{inboxdir}.boost"}, 0, + is($lcfg->{"external.$ibx->{inboxdir}.boost"}, 0, "configured boost on $ibx->{name}"); }); - $lei->('ls-extinbox'); - like($out, qr/boost=0\n/s, 'ls-extinbox has output'); + $lei->('ls-external'); + like($out, qr/boost=0\n/s, 'ls-external has output'); }; my $test_lei_common = sub { $test_help->(); $test_config->(); $test_init->(); - $test_extinbox->(); + $test_external->(); }; my $test_lei_oneshot = $ENV{TEST_LEI_ONESHOT}; diff --git a/t/lei_xsearch.t b/t/lei_xsearch.t index c41213bd..178c3d37 100644 --- a/t/lei_xsearch.t +++ b/t/lei_xsearch.t @@ -49,7 +49,7 @@ $eidx->eidx_sync({fsync => 0}); my $es = PublicInbox::ExtSearch->new("$home/eidx"); my $lxs = PublicInbox::LeiXSearch->new; for my $ibxish (shuffle($es, @ibx)) { - $lxs->attach_extinbox($ibxish); + $lxs->attach_external($ibxish); } my $nr = $lxs->xdb->get_doccount; my $mset = $lxs->mset('d:19931002..19931003', { limit => $nr });