File Coverage

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

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