8a5fba88bcc86b6e2585c238ec7f97d443073dac
[sheet.git] / browser.plp
1 <(common.inc.plp)><:
2 use 5.010;
3 use utf8;
4 use List::Util qw(sum max first);
5
6 Html({
7         title => 'browser compatibility cheat sheet',
8         version => 'v1.2',
9         description => [
10                 "Compatibility table of new web features (HTML5, CSS3, SVG, Javascript)",
11                 "comparing support and usage share for all popular browser versions.",
12         ],
13         keywords => [qw'
14                 web browser support compatibility usage matrix available feature
15                 html html5 css css3 svg javascript js dom mobile
16                 ie internet explorer firefox chrome safari webkit opera
17         '],
18         stylesheet => [qw'circus dark mono red light'],
19         data => ['data/browser/support.inc.pl'],
20 });
21
22 say "<h1>Browser compatibility</h1>\n";
23
24 my $caniuse = do 'data/browser/support.inc.pl' or die $! || $@;
25 $_->{verrelease} = {
26         # mark last three (future) versions as unreleased, ensure current isn't
27         map {
28                 $_->[-1] => 0, $_->[-2] => 0, $_->[-3] => 0,
29                 $_->[-4] => undef,
30         } $_->{versions}
31 } for values %{ $caniuse->{agents} };
32
33 my %CSTATS = (
34         'n'   => 'l1',
35         'n d' => 'l2',
36         'n x d' => 'l2 ex',
37         'p d' => 'l2',
38         'a d' => 'l2',
39         'y'   => 'l5',
40         'y x' => 'l5 ex',
41         'a'   => 'l3',
42         'a x' => 'l3 ex',
43         'p j' => 'l2',
44         'j'   => 'l2',
45         'p'   => 'l2',
46         'p p' => 'l2',
47         'u'   => 'l0',
48 );
49 my %DSTATS = (
50         u => 'unknown',
51         n => 'unsupported',
52         p => 'plugin required',
53         j => 'javascript required',
54         a => 'partial',
55         y => 'supported',
56         d => 'disabled by default',
57         x => sub {
58                 join(' ',
59                         'requires prefix',
60                         (map "-$_-", $caniuse->{agents}->{$_[0]}->{prefix} // ()),
61                 );
62         },
63 );
64 my %PSTATS = (  # score percentage
65         y => 1,  'y x' => .9,
66         a => .5, 'a x' => .5, 'a d' => .1,
67         j => .2, 'p j' => .2, 'n d' => .2, 'n x d' => .2,
68         p => .2, 'p p' => .2, 'p d' => .1,
69 );
70 my %CSTATUS = (
71         unoff => 'l1', # unofficial
72         wd    => 'l2', # draft
73         cr    => 'l3', # candidate
74         pr    => 'l3', # proposed
75         rec   => 'l5', # recommendation
76         ls    => 'l4', # whatwg
77         ietf  => 'l0', # standard
78         other => 'l0', # non-w3
79 );
80 my %versions;
81 if (my ($somerow) = values %{ $caniuse->{data} }) {
82         while (my ($browser, $row) = each %{ $somerow->{stats} }) {
83                 $versions{$browser} = [ sort { paddedver($a) cmp paddedver($b) } keys %$row ];
84         }
85 }
86
87 print <<'';
88 <p id="intro">Alternate rendition of Fyrd's <a href="http://caniuse.com/">when can I use...</a> page
89
90 my ($canihas, $usage);
91 my $minusage = $get{threshold} // .7;
92 given ($get{usage} // 'wm') {
93         when (!$_) {
94                 # none
95         }
96         when (!m{ \A [a-z]\w+ (?:/\d[\d-]*\d)? \z }x) {
97                 printf "<p>Invalid browser usage data request: <em>%s</em>",
98                         'identifier must be alphanumeric name or <q>0</q>';
99         }
100         $canihas = do "data/browser/usage-$_.inc.pl" or do {
101                 printf "<p>Browser usage data not found: <em>%s</em>", $! || $@;
102                 break;
103         };
104         $usage = $_;
105         my $ref = $canihas->{-title} || 'unknown';
106         $ref = sprintf '<a href="%s">%s</a>', $_, $ref
107                 for $canihas->{-site} || $canihas->{-source} || ();
108         $ref .= " $_" for $canihas->{-date} || ();
109         print "\nwith $ref browser usage statistics";
110 }
111
112 my @browsers;
113 if ($usage) { # first() does not work inside given >:(
114         # adapt version usage to actual support data
115         my %engineuse;  # prefix => usage sum
116         for my $browser (keys %versions) {
117                 my $row = $canihas->{$browser} // {};
118                 my $verlist = $versions{$browser} or next;
119                 if ($minusage and sum(values %$row) < $minusage) {
120                         delete $versions{$browser};
121                         next;
122                 }
123                 my %supported = map { $_ => 1 } @$verlist;
124
125                 # cascade unknown versions
126                 $row->{$_} //= undef for @$verlist;  # ensure stable keys during iteration
127                 while (my ($version, $usage) = each %$row) {
128                         next if defined $supported{$version};
129                         my $next = first { paddedver($_) ge paddedver($version) } @$verlist
130                                 or warn("No fallback found for $browser v$version; $usage% ignored"), next;
131                         $row->{$next} += $usage;
132                         $row->{$version} = 0;  # balance browser total
133                 }
134
135                 # build row list for each version
136                 if ($minusage) {
137                         my @vershown;  # $verlist replacement
138                         my ($rowusage, @verrow) = (0);  # replacement row tracking
139                         for (@$verlist) {
140                                 push @verrow, $_;  # queue each version
141                                 if (($rowusage += $row->{$_}) >= $minusage) {
142                                         push @vershown, [@verrow];   # add row
143                                         ($rowusage, @verrow) = (0);  # reset row tracking
144                                 }
145                         }
146                         push @vershown, \@verrow if @verrow;  # always add latest
147                         @$verlist = @vershown;
148                 }
149                 else {
150                         @$verlist = map { [$_] } @$verlist;
151                 }
152
153                 # reusable aggregates (grouped by prefix (engine) and browser)
154                 $engineuse{ $caniuse->{agents}->{$browser}->{prefix} } +=
155                 $row->{-total} = sum(values %$row);
156         }
157
158         # order browser columns by usage grouped by engine
159         @browsers = sort {
160                 $engineuse{ $caniuse->{agents}->{$b}->{prefix} } <=>
161                 $engineuse{ $caniuse->{agents}->{$a}->{prefix} }
162                         ||
163                 $canihas->{$b}->{-total} <=> $canihas->{$a}->{-total}
164         } keys %versions;
165 }
166 else {
167         # order browser columns by name grouped by engine
168         @{$_} = map { [$_] } @{$_} for values %versions;
169         @browsers = sort {
170                 $caniuse->{agents}->{$b}->{prefix} cmp
171                 $caniuse->{agents}->{$a}->{prefix}
172                         ||
173                 $a cmp $b
174         } keys %versions;
175 }
176 :>.
177 </p>
178
179 <:
180 $canihas ||= {
181         map {
182                 $_ => +{
183                         map {
184                                 my $zero = $#$_ - 2;  # baseline index
185                                 ($_->[$zero - 2] =>  .5), # past
186                                 ($_->[$zero - 1] => 10 ), # previous
187                                 ($_->[$zero + 2] =>  0 ), # future
188                                 ($_->[$zero + 1] =>  .5), # next
189                                 ($_->[$zero    ] => 30 ), # current
190                         } $caniuse->{agents}->{$_}->{versions}
191                 }
192         } @browsers
193 }; # fallback hash based on release semantics
194 my $usagemax = (max(map { ref $_ eq 'HASH' && sum(values %$_) } values %$canihas) // 1) / 100;
195
196 my $usagepct = 1;  # score multiplier for 0..100 result
197 # normalise usage percentage to only include shown browsers
198 $usagepct = 100.01 / featurescore({  # yes for every possible version
199         map { $_ => { map {$_ => 'y'} map { @{$_} } @{$versions{$_}} } } keys %versions
200 });
201
202 print '<table class="mapped">';
203 print '<col span="3">';  # should match first thead row
204 printf '<colgroup span="%d">', scalar @{ $versions{$_} } for @browsers;
205 say '</colgroup><col>';
206
207 my $header = join('',
208         '<tr>',
209         '<th colspan="3" rowspan="2">feature',
210         (map {
211                 my $name = $caniuse->{agents}->{$_}->{browser};
212                 sprintf('<th colspan="%d" class="%s" title="%s">%s',
213                         scalar @{ $versions{$_} },
214                         join(' ', map {"b-a-$_"} grep {$_}
215                                 $_, @{ $caniuse->{agents}->{$_} }{'prefix', 'type'},
216                         ),
217                         join(' ',
218                                 sprintf('%.1f%%', $canihas->{$_}->{-total} * $usagepct),
219                                 $name,
220                         ),
221                         do {
222                                 length $name <= (3 * @{ $versions{$_} }) ? $name
223                                         : $caniuse->{agents}->{$_}->{abbr};
224                         },
225                 )
226         } @browsers),
227         '<th rowspan="2">%',
228 );
229 print '<thead>', $header;
230 # preceding row without any colspan to work around gecko bug
231 print "\n<tr>";
232 for my $browser (@browsers) {
233         for (@{ $versions{$browser} }) {
234                 my $lastver = $_->[-1];
235                 my $release = $caniuse->{agents}->{$browser}->{verrelease}->{$lastver};
236                 my $future = defined $release;
237                 printf('<td title="%s"%s>%s',
238                         join(' ',
239                                 sprintf('%.1f%%', sum(@{ $canihas->{$browser} }{@$_}) * $usagepct),
240                                 $future ? 'development' : (),
241                                 'version ' . join(', ', @{$_}),
242                         ),
243                         $future && ' class="ex"',
244                         showversions($lastver),
245                 );
246         }
247 }
248 say '</thead>';
249 say '<tfoot>', $header;
250 {
251         # prefix indicates browser family; count adjacent families
252         my (@families, %familycount);
253         for my $browser (@browsers) {
254                 my $family = $caniuse->{agents}->{$browser}->{prefix};
255                 push @families, $family unless $familycount{$family};
256                 $familycount{$family} += @{ $versions{$browser} };
257         }
258
259         print "\n", '<tr class="cat">';
260         printf '<th colspan="%d">%s', $familycount{$_}, $_ for @families;
261 }
262 say '</tfoot>';
263
264 sub featurescore {
265         # relative amount of support for given feature
266         my $rank = 0;
267         if (my $row = shift) {
268                 if ($canihas) {
269                         while (my ($browser, $versions) = each %$row) {
270                                 ref $versions eq 'HASH' or next;
271                                 while (my ($version, $_) = each %$versions) {
272                                         $rank += ($canihas->{$browser}->{$version} || .001) * $PSTATS{$_};
273                                 }
274                         }
275                         return $rank;
276                 }
277
278                 while (my ($browser, $vercols) = each %versions) {
279                         my $div = 0;  # multiplier exponent (decreased to lower value)
280                         my @vers = map { $row->{$browser}->{$_} } @$vercols;
281                         if (my $current = $caniuse->{agents}->{$browser}->{versions}->[-3]) {
282                                 my @future;  # find upcoming releases (after current)
283                                 for (reverse @$vercols) {
284                                         last if $_ eq $current;
285                                         push @future, pop @vers;
286                                         $_ eq 'u' and $_ = $vers[-1] for $future[-1];  # inherit latest value if unknown
287                                 }
288                                 splice @vers, -1, 0, @future;  # move ahead to decrease precedence
289                         }
290                         $rank += $PSTATS{$_} * 2**($div--) for reverse @vers;
291                 }
292         }
293         return $rank;
294 }
295
296 sub formatnotes {
297         my @html = @_;
298         for (@html) {
299                 s/\h* $//gmx;  # trailing whitespace
300                 s/(?<= [^.\n]) $/./gmx;  # consistently end each line by a period
301                 Entity($_);
302                 s{  ` ([^`]*)  ` }{<code>$1</code>}gx;
303                 s{ \[ ([^]]*) \] \( ([^)]*) \) }{<a href="$2">$1</a>}gx;
304         }
305         return @html;
306 }
307
308 sub saytitlecol {
309         my ($id) = @_;
310         my $row = $caniuse->{data}->{$id};
311
312         for ($row->{categories}) {
313                 my $cell = $_ ? lc $_->[0] : '-';
314                 $cell =~ s/ api$//;  # trim unessential fluff in 'js api'
315                 printf '<th title="%s">%s', join(' + ', @$_), $cell;
316         }
317
318         print '<td>', map {
319                 sprintf('<a href="%s" onclick="%s">%s</a>',
320                         "#$id",
321                         sprintf("try { %s; return false } catch(err) { return true }",
322                                 "document.getElementById('$id').classList.toggle('target')",
323                         ),
324                         Entity($_),
325                 );
326         } $row->{title};
327         print '<div class=aside>';
328         print "<p>$_</p>"
329                 for formatnotes($row->{description}, $row->{notes} || ());
330         printf 'Resources: %s.', join(', ', map {
331                 sprintf '<a href="%s">%s</a>', EscapeHTML($_->{url}), $_->{title}
332         } @$_) for grep { @$_ } $row->{links} // ();
333         printf '<br>Parent feature: %s.', join(', ', map {
334                 sprintf '<a href="%s">%s</a>', EscapeHTML("#$_"), $caniuse->{data}->{$_}->{title}
335         } $_) for $row->{parent} || ();
336         print '</div>';
337 }
338
339 sub saystatuscol {
340         my ($id) = @_;
341         my $row = $caniuse->{data}->{$id};
342
343         for ($row->{status}) {
344                 my $cell = $_ // '-';
345                 $cell = sprintf '<a href="%s">%s</a>', $_, $cell for $row->{spec} // ();
346                 printf '<td title="%s" class="l %s">%s',
347                         $caniuse->{statuses}->{$_}, $CSTATUS{$_} // '', $cell;
348         }
349 }
350
351 sub saybrowsercols {
352         my ($id, $browser) = @_;
353         my $feature = $caniuse->{data}->{$id};
354         my $data = $feature->{stats}->{$browser};
355         if (ref $data eq 'ARRAY') {
356                 # special case for unsupported
357                 my $release = $caniuse->{agents}->{$browser}->{verrelease};
358                 $data = {
359                         map { $_ => defined $release->{$_} ? 'u' : 'n' } keys %$release
360                 };
361         }
362
363         my ($prev, @span);
364         for my $ver (@{ $versions{$browser} }, undef) {
365                 my $compare = (
366                         !defined $ver ? undef :      # last column if nameless
367                         ref $data ne 'HASH' ? '' :   # unclassified if no support hash
368                         $data->{ $ver->[-1] } // $prev  # known or inherit from predecessor
369                         // (grep { defined } @{$data}{ map { $_->[0] } @{ $versions{$browser} } })[0]
370                            ~~ 'n' && 'n'             # first known version is unsupported
371                         || 'u'                       # unsure
372                 );
373                 unless (!defined $prev or $prev ~~ $compare) {
374                         my $usage = sum(@{ $canihas->{$browser} }{ map { @{$_} } @span });
375
376                         # strip #\d note references from support class
377                         my @notes;
378                         push @notes, $feature->{notes_by_num}->{$1}
379                                 while $prev =~ s/\h \# (\d+) \b//x;
380
381                         # prepare version hover details
382                         my $title = sprintf('%.1f%% %s', $usage * $usagepct, join(', ',
383                                 map { ref $_ eq 'CODE' ? $_->($browser) : $_ }
384                                 map { $DSTATS{$_} // () }
385                                 map { split / /, $_ }
386                                 $prev
387                         ));
388                         $title .= "\n".EscapeHTML($_) for @notes;
389
390                         printf('<td class="%s" colspan="%d" title="%s">%s',
391                                 join(' ',
392                                         X => $CSTATS{$prev},
393                                         !$usage ? ('p0') : ('p',
394                                                 sprintf('p%01d', $usage * ($usagepct - .0001) / 10),
395                                                 sprintf('p%02d', $usage * ($usagepct - .0001)),
396                                         ),
397                                         sprintf('pp%02d', $usage / $usagemax),
398                                 ),
399                                 scalar @span,
400                                 $title,
401                                 showversions($span[0]->[0], @span > 1 ? ($span[-1]->[-1]) : ()),
402                         );
403                         undef $prev;
404                         @span = ();
405                 }
406                 push @span, $ver && [ grep { $data->{ $_ } eq $data->{ $ver->[-1] } } @{$ver} ];
407                 $prev = $compare;
408         }
409 }
410
411 sub sayusagecol {
412         my ($id) = @_;
413         print '<td>', int featurescore($caniuse->{data}->{$id}->{stats}) * $usagepct;
414 }
415
416 say '<tbody>';
417 for my $id (sort {
418             featurescore($caniuse->{data}->{$b}->{stats})
419         <=> featurescore($caniuse->{data}->{$a}->{stats})
420 } keys %{ $caniuse->{data} }) {
421         $caniuse->{data}->{$id}->{stats} or next;  # skip metadata [summary]
422         printf '<tr id="%s">', $id;
423         saytitlecol($id);
424         saystatuscol($id);
425         saybrowsercols($id, $_) for @browsers;
426         sayusagecol($id);
427         say '</tr>';
428 }
429 say '</tbody>';
430 say '</table>';
431
432 sub paddedver {
433         # normalised version number comparable as string (cmp)
434         shift =~ /(?:.*-|^)(\d*)(.*)/;
435         # matched (major)(.minor) of last value in range (a-B)
436         return sprintf('%02d', $1 || 99) . $2;
437 }
438
439 sub showversions {
440         my @span = ($_[0], @_>1 ? $_[-1] : ());
441         s/-.*// for $span[0];
442         for (@span) {
443                 s/^\./0./;
444                 s/x$/.*/;
445                 s/.*-//;
446         }
447         return join('‒', @span);
448 }
449
450 :>
451 <hr>
452
453 <div class="legend">
454         <table class="glyphs"><tr>
455         <td class="X l5">supported
456         <td class="X l3">partial
457         <td class="X l2">optional
458         <td class="X l1">missing
459         <td class="X l0">unknown
460         <td class="X ex">prefixed
461         </table>
462
463         <p><: if ($usage) { :>
464                 Usage percentage:
465                 <span class="  p0">0</span> -
466                 <span class="p p0 p00">.01</span> -
467                 <span class="p p0 p05">1-9</span> -
468                 <span class="p p1">10</span> -
469                 <span class="p p2">20</span> -
470                 <span class="p p5">majority</span>
471 <: } else { :>
472                 <table class="glyphs"><tr>
473                         <td class="p p1">previous version</td>
474                         <td class="p p3">current</td>
475                         <td class="p p0 p00">upcoming (within months)</td>
476                         <td class="  p0">future (within a year)</td>
477                 </table>
478 <: } :> </p>
479
480         <div class="right">
481                 <ul class="legend legend-set">
482                 <li>default <strong>style</strong> is
483                         <:= defined $get{style} && 'set to ' :><em><:= $style :></em>
484                 <li><strong>usage</strong> source is
485                         <:= !defined $get{usage} && 'default ' :><:= defined $usage ? "<em>$usage</em>" : 'not included (<em>0</em>)' :>
486                 <li>usage <strong>threshold</strong> is
487                         <:= defined $get{threshold} && 'changed to ' :><em><:= $minusage :>%</em>
488                 </ul>
489         </div>
490 </div>
491
492 <script type="text/javascript" src="/searchlocal.js"></script>
493 <script type="text/javascript"> prependsearch(document.getElementById('intro')) </script>
494