File Coverage

File:lib/CheckSpelling/Util.pm
Coverage:97.5%

linestmtbrancondsubtimecode
1#! -*-perl-*-
2
3
13
13
158671
16
use v5.20;
4
13
13
13
18
14
28
use utf8;
5
13
13
13
169
13
779
use feature 'unicode_strings';
6
7package CheckSpelling::Util;
8
9
13
13
13
237
4349
415
use Encode qw/decode_utf8 encode_utf8 FB_DEFAULT/;
10
13
13
13
2083
23626
412
use HTTP::Date;
11
13
13
13
26
7
246
use feature 'signatures';
12
13
13
13
18
7
11091
no warnings qw(experimental::signatures);
13
14our $VERSION='0.1.0';
15
16sub get_file_from_env {
17
428
259
  my ($var, $fallback) = @_;
18
428
527
  return $fallback unless defined $ENV{$var};
19
145
140
  $ENV{$var} =~ /(.*)/s;
20
145
121
  return $fallback if $1 eq '';
21
144
377
  return $1;
22}
23
24sub get_file_from_env_utf8 {
25
90
47
  return decode_utf8(get_file_from_env(@_));
26}
27
28sub get_val_from_env {
29
107
272
  my ($var, $fallback) = @_;
30
107
114
  return $fallback unless defined $ENV{$var};
31
52
91
  $ENV{$var} =~ /^(\d+)$/;
32
52
94
  return $1 || $fallback;
33}
34
35
133
133
133
133
74
59
65
60
sub case_biased :prototype($$) ($a, $b) {
36
133
214
  lc($a) cmp lc($b) || $a cmp $b;
37}
38
39
66
66
66
66
28
34
32
22
sub number_biased :prototype($$) ($a, $b) {
40
66
47
  my ($aUnchecked, $bUnchecked) = ($a, $b);
41
66
107
  while ($aUnchecked ne '' && $bUnchecked ne '') {
42
92
37
    my ($aNumber, $bNumber);
43
92
108
    if ($aUnchecked =~ m/^(\d+)(.*)/) {
44
25
13
      $aNumber = $1;
45
25
16
      $aUnchecked = $2;
46    }
47
92
70
    if ($bUnchecked =~ m/^(\d+)(.*)/) {
48
25
12
      $bNumber = $1;
49
25
15
      $bUnchecked = $2;
50    }
51
92
81
    if (defined $aNumber && defined $bNumber) {
52
22
39
      return $aNumber <=> $bNumber if ($aNumber != $bNumber);
53    } else {
54
70
46
      return $aNumber cmp $bUnchecked if defined $aNumber;
55
67
37
      return $aUnchecked cmp $bNumber if defined $bNumber;
56
64
24
      my ($aLetters, $bLetters);
57
64
48
      $aUnchecked =~ m/^(\D+)(.*)/;
58
64
33
      $aLetters = $1;
59
64
37
      $aUnchecked = $2;
60
61
64
43
      $bUnchecked =~ m/^(\D+)(.*)/;
62
64
27
      $bLetters = $1;
63
64
29
      $bUnchecked = $2;
64
65
64
166
      return case_biased($aLetters, $bLetters) if (defined $aLetters && defined $bLetters && !($aLetters eq $bLetters));
66    }
67  }
68
4
5
  return $aUnchecked cmp $bUnchecked;
69}
70
71sub list_with_terminator {
72
8
815
  my ($terminator, @list) = @_;
73
8
66
7
59
  return join "", map { "$_$terminator" } @list;
74}
75
76sub read_file {
77
4
872
  my ($name) = @_;
78
4
10
  local $/ = undef;
79
4
5
  my ($text, $file);
80
4
57
  if (open $file, '<:utf8', $name) {
81
3
65
    $text = <$file>;
82
3
10
    close $file;
83  } else {
84
1
21
    print STDERR "Could not open file ($name)\n";
85  }
86
4
14
  return $text;
87}
88
89sub maybe_str2time {
90
10
8
  my ($time) = @_;
91
10
10
  $time = str2time $time;
92
10
169
  return $time if $time;
93}
94
95sub print_insert {
96
2
14
  open INSERT, "<", $ENV{insert};
97
2
2
  local $/=undef;
98
2
21
  print <INSERT>;
99
2
4
  print "\n";
100
2
7
  close INSERT;
101}
102
103sub insert_into_summary {
104
2
2354
  my $state=0;
105
2
12
  open BASE, "<", $ENV{base};
106
2
16
  while (<BASE>){
107
20
19
    if ($state==0) {
108
2
5
      $state = 1 if /^(?:#+ |<details><summary>)Unrecognized words/;
109    } elsif ($state==1) {
110
5
8
      if (/<details><summary>These words/) {
111
1
0
        $state=2;
112      } elsif (m{<details><summary>To accept }) {
113
1
5
        $state=3;
114
1
1
        print_insert();
115
1
2
        print "**OR**\n\n\n";
116      } elsif (m{^<details><summary>}) {
117
1
1
        $state=3;
118
1
1
        print_insert();
119      }
120    } elsif ($state==2) {
121
3
3
      $state=1 if m{^</details><p></p>};
122    }
123
20
69
    print;
124  }
125
2
7
  close BASE;
126}
127
128sub calculate_delay {
129
11
995
  my (@lines) = @_;
130
11
5
  my $now_stamp = time;
131
11
6
  my ($requested, $expires, $delay);
132
11
8
  for my $line (@lines) {
133
15
22
    if ($line =~ /^date:\s*(.*)/i) {
134
5
4
      $requested = maybe_str2time($1);
135
5
5
      next;
136    }
137
10
12
    if ($line =~ /^expires:\s*(.*)/i) {
138
5
5
      $expires = maybe_str2time($1);
139
5
5
      next;
140    }
141
5
8
    next unless $line =~ /^retry-after:\s*(\d+)/i;
142
4
7
    $delay = $1 || 1;
143  }
144
11
12
  return $delay if defined $delay;
145
8
11
  if (defined $requested && defined $expires) {
146
2
1
    $delay = $expires - $requested;
147  }
148
8
8
  $delay = 5 unless defined $delay && $delay > 0;
149
150
8
15
  return $delay;
151}
152
153sub truncate_with_ellipsis {
154
8
9
  my ($text, $length) = @_;
155
8
75
  $text =~ s/^(.{$length}).{4,}?(\s?`+|)$/$1$2…/;
156
8
15
  return $text;
157}
158
159sub wrap_in_backticks {
160
1351
999
  my ($a) = @_;
161
1351
547
  my $longest = 0;
162
1351
960
  while ($a =~ /(`+)/g) {
163
7
5
    my $length = length $1;
164
7
9
    $longest = $length if $length > $longest;
165  }
166
1351
748
  my $q = '`'x ($longest + 1);
167
1351
1272
  $a = " $a " if ($a =~ m<^`|`$>);
168
1351
1226
  return "$q$a$q";
169}
170
171sub tear_here {
172
7
24
  my ($exit) = @_;
173
7
5
  our $exited;
174
7
13
  return if defined $exited;
175
7
59
  print STDERR "\n<<<TEAR HERE<<<exit: $exit\n";
176
7
65
  print STDOUT "\n<<<TEAR HERE<<<exit: $exit\n";
177
7
16
  $exited = $exit;
178}
179sub die_custom {
180
3
10
  my ($program, $line, $message) = @_;
181
3
40
  print STDERR "$message at $program line $line.\n";
182
3
5
  tear_here(1);
183
3
26
  die "stopping";
184}
185
1861;