File Coverage

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

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