browser: truncate maximum usage score to 99
[sheet.git] / browser.plp
index e65395ea1cba69b0c20a047ade609b17756be26e..a135d357c861c5279c3b7a27b21eebb5d12ba9b9 100644 (file)
@@ -1,27 +1,26 @@
 <(common.inc.plp)><:
-use 5.010;
-use utf8;
 use List::Util qw(sum max first);
+no if $] >= 5.018, warnings => 'experimental::smartmatch';
 
 Html({
        title => 'browser compatibility cheat sheet',
-       version => 'v1.0',
+       version => '1.4',
        description => [
                "Compatibility table of new web features (HTML5, CSS3, SVG, Javascript)",
                "comparing support and usage share for all popular browser versions.",
        ],
        keywords => [qw'
-               web browser support compatibility usage available feature
+               web browser support compatibility usage matrix available feature
                html html5 css css3 svg javascript js dom mobile
                ie internet explorer firefox chrome safari webkit opera
        '],
        stylesheet => [qw'circus dark mono red light'],
-       data => ['browser-support.inc.pl'],
+       data => ['data/browser/support.inc.pl'],
 });
 
 say "<h1>Browser compatibility</h1>\n";
 
-my $caniuse = do 'browser-support.inc.pl' or die $! || $@;
+my $caniuse = do 'data/browser/support.inc.pl' or die $@ || $!;
 $_->{verrelease} = {
        # mark last three (future) versions as unreleased, ensure current isn't
        map {
@@ -40,27 +39,32 @@ my %CSTATS = (
        'y x' => 'l5 ex',
        'a'   => 'l3',
        'a x' => 'l3 ex',
-       'p j' => 'l2',
-       'j'   => 'l2',
        'p'   => 'l2',
-       'p p' => 'l2',
        'u'   => 'l0',
 );
 my %DSTATS = (
        u => 'unknown',
        n => 'unsupported',
        p => 'plugin required',
-       j => 'javascript required',
        a => 'partial',
        y => 'supported',
-       d => 'disabled by default',
+       d => '(disabled by default)',
        x => sub {
                join(' ',
-                       'requires prefix',
-                       (map "-$_-", $caniuse->{agents}->{$_[0]}->{prefix} // ()),
+                       'with prefix',
+                       map {"-$_-"}
+                       ($caniuse->{agents}->{$_[0]}->{prefix_exceptions} // {})->{$_[1]}
+                       // $caniuse->{agents}->{$_[0]}->{prefix} // (),
                );
        },
 );
+my %PSTATS = (  # score percentage
+       y => 1,  'y x' => .9,
+       a => .5, 'a x' => .5, 'a d' => .2,
+       p => .2, 'p d' => .1,
+       n => 0,  'n d' => .2, 'n x d' => .2,
+       u => 0,
+);
 my %CSTATUS = (
        unoff => 'l1', # unofficial
        wd    => 'l2', # draft
@@ -72,32 +76,35 @@ my %CSTATUS = (
        other => 'l0', # non-w3
 );
 my %versions;
-if (my ($somerow) = values %{ $caniuse->{data} }) {
-       while (my ($browser, $row) = each %{ $somerow->{stats} }) {
-               $versions{$browser} = [ sort { paddedver($a) cmp paddedver($b) } keys %$row ];
-       }
+while (my ($browser, $row) = each %{ $caniuse->{agents} }) {
+       $versions{$browser} = [
+               sort { paddedver($a) cmp paddedver($b) } grep { defined }
+               @{ $row->{versions} }
+       ];
 }
 
 print <<'';
 <p id="intro">Alternate rendition of Fyrd's <a href="http://caniuse.com/">when can I use...</a> page
 
 my ($canihas, $usage);
-my $minusage = $get{threshold} // .5;
+my $minusage = $get{threshold} // 1;
 given ($get{usage} // 'wm') {
        when (!$_) {
                # none
        }
-       when (!/^[a-z][\w-]+$/) {
-               printf "<p>Invalid browser usage data request: <em>%s</em>",
-                       'identifier must be alphanumeric name or <q>0</q>';
+       when (!m{ \A [a-z]\w+ (?:/\d[\d-]*\d)? \z }x) {
+               Alert([
+                       'Invalid browser usage data request',
+                       'Identifier must be alphanumeric name or <q>0</q>.',
+               ]);
        }
-       $canihas = do "browser-usage-$_.inc.pl" or do {
-               printf "<p>Browser usage data not found: <em>%s</em>", $! || $@;
+       $canihas = do "data/browser/usage-$_.inc.pl" or do {
+               Alert('Browser usage data not found', $@ || $!);
                break;
        };
        $usage = $_;
        my $ref = $canihas->{-title} || 'unknown';
-       $ref = sprintf '<a href="%s">%s</a>', $_, $ref
+       $ref = showlink($ref, $_)
                for $canihas->{-site} || $canihas->{-source} || ();
        $ref .= " $_" for $canihas->{-date} || ();
        print "\nwith $ref browser usage statistics";
@@ -159,6 +166,7 @@ if ($usage) { # first() does not work inside given >:(
 }
 else {
        # order browser columns by name grouped by engine
+       @{$_} = map { [$_] } @{$_} for values %versions;
        @browsers = sort {
                $caniuse->{agents}->{$b}->{prefix} cmp
                $caniuse->{agents}->{$a}->{prefix}
@@ -184,13 +192,14 @@ $canihas ||= {
                }
        } @browsers
 }; # fallback hash based on release semantics
-my $usagemax = (max(map { ref $_ eq 'HASH' && sum(values %$_) } values %$canihas) // 1) / 100;
 
 my $usagepct = 1;  # score multiplier for 0..100 result
 # normalise usage percentage to only include shown browsers
-$usagepct = 100.01 / featurescore({  # yes for every possible version
+$usagepct = 99.99 / featurescore({  # yes for every possible version
        map { $_ => { map {$_ => 'y'} map { @{$_} } @{$versions{$_}} } } keys %versions
 });
+$_->{usage} = featurescore($_->{stats}) * $usagepct
+       for values %{ $caniuse->{data} };
 
 print '<table class="mapped">';
 print '<col span="3">';  # should match first thead row
@@ -199,7 +208,7 @@ say '</colgroup><col>';
 
 my $header = join('',
        '<tr>',
-       '<th colspan="3">feature',
+       '<th colspan="3" rowspan="2">feature',
        (map {
                my $name = $caniuse->{agents}->{$_}->{browser};
                sprintf('<th colspan="%d" class="%s" title="%s">%s',
@@ -212,34 +221,32 @@ my $header = join('',
                                $name,
                        ),
                        do {
-                               length $name < 3 + @{ $versions{$_} }*2 ? $name
+                               length $name <= (3 * @{ $versions{$_} }) ? $name
                                        : $caniuse->{agents}->{$_}->{abbr};
                        },
                )
        } @browsers),
-       '<th>%',
+       '<th rowspan="2">%',
 );
 print '<thead>', $header;
 # preceding row without any colspan to work around gecko bug
 print "\n<tr>";
-print '<td>' x 3;
 for my $browser (@browsers) {
-       for (@{ $versions{$browser} }) {
-               my $lastver = $_->[-1];
-               my $release = $caniuse->{agents}->{$browser}->{verrelease}->{$lastver};
-               my $future = defined $release;
+       for my $span (@{ $versions{$browser} }) {
+               my $lastver = first {
+                       !defined $caniuse->{agents}->{$browser}->{verrelease}->{$_} # stable
+               } reverse @{$span};
                printf('<td title="%s"%s>%s',
                        join(' ',
-                               sprintf('%.1f%%', sum(@{ $canihas->{$browser} }{@$_}) * $usagepct),
-                               $future ? 'development' : (),
-                               'version ' . join(', ', @{$_}),
+                               sprintf('%.1f%%', sum(@{ $canihas->{$browser} }{ @{$span} }) * $usagepct),
+                               'version ' . showversions(@{$span}, undef),
+                               $span->[-1] eq $lastver ? () : '(development)',
                        ),
-                       $future && ' class="ex"',
+                       !defined $lastver && ' class="ex"',
                        showversions($lastver),
                );
        }
 }
-print '<td>' x 1;
 say '</thead>';
 say '<tfoot>', $header;
 {
@@ -252,22 +259,20 @@ say '<tfoot>', $header;
        }
 
        print "\n", '<tr class="cat">';
-       print '<td>' x 3;
        printf '<th colspan="%d">%s', $familycount{$_}, $_ for @families;
-       print '<td>';
 }
 say '</tfoot>';
 
 sub featurescore {
        # relative amount of support for given feature
-       state $statspts = { y=>1, 'y x'=>1, a=>.5, 'a x'=>.5, j=>.2, 'p j'=>.2, 'p p'=>.2, p=>.1 };
        my $rank = 0;
        if (my $row = shift) {
                if ($canihas) {
                        while (my ($browser, $versions) = each %$row) {
                                ref $versions eq 'HASH' or next;
-                               while (my ($version, $_) = each %$versions) {
-                                       $rank += ($canihas->{$browser}->{$version} || .001) * $statspts->{$_};
+                               while (my ($version, $status) = each %$versions) {
+                                       $status =~ s/\h\#\d+//g;
+                                       $rank += ($canihas->{$browser}->{$version} || .001) * $PSTATS{$status};
                                }
                        }
                        return $rank;
@@ -285,12 +290,34 @@ sub featurescore {
                                }
                                splice @vers, -1, 0, @future;  # move ahead to decrease precedence
                        }
-                       $rank += $statspts->{$_} * 2**($div--) for reverse @vers;
+                       $rank += $PSTATS{$_} * 2**($div--) for reverse @vers;
                }
        }
        return $rank;
 }
 
+sub formatnotes {
+       my @html = @_;
+       for (@html) {
+               s/\r\n?/\n/g;  # windows returns
+               s/\h* $//gmx;  # trailing whitespace
+               s/(?<= [^.\n]) $/./gmx;  # consistently end each line by a period
+               Entity($_);
+               s{  ` ([^`]*)  ` }{<code>$1</code>}gx;
+               s{ \[ ([^]]*) \] \( ([^)]*) \) }{<a href="$2">$1</a>}gx;
+       }
+       return @html;
+}
+
+sub notestotitle {
+       my @notes = @_;
+       for (@notes) {
+               EscapeHTML($_);
+               s{ \[ ([^]]*) \] \( [^)]* \) }{$1}gx;  # strip link urls
+       }
+       return @notes;
+}
+
 sub saytitlecol {
        my ($id) = @_;
        my $row = $caniuse->{data}->{$id};
@@ -311,14 +338,18 @@ sub saytitlecol {
                );
        } $row->{title};
        print '<div class=aside>';
-       s/\.?$/./, print "<p>$_</p>" for map { ref $_ ? @$_ : $_ || () }
-               Entity($row->{description}),
-               map { s/\s*\n/\n<br>/g; $_ } $row->{notes};
+       print "<p>$_</p>"
+               for formatnotes($row->{description}, $row->{notes} || ());
+       if (my %notes = %{ $row->{notes_by_num} }) {
+               say '<p>Browser-specific notes:';
+               say "<br>#$_: ", formatnotes($notes{$_}) for sort keys %notes;
+               say '</p>';
+       }
        printf 'Resources: %s.', join(', ', map {
-               sprintf '<a href="%s">%s</a>', EscapeHTML($_->{url}), $_->{title}
+               showlink($_->{title}, $_->{url})
        } @$_) for grep { @$_ } $row->{links} // ();
        printf '<br>Parent feature: %s.', join(', ', map {
-               sprintf '<a href="%s">%s</a>', EscapeHTML("#$_"), $caniuse->{data}->{$_}->{title}
+               showlink($caniuse->{data}->{$_}->{title}, "#$_")
        } $_) for $row->{parent} || ();
        print '</div>';
 }
@@ -329,7 +360,7 @@ sub saystatuscol {
 
        for ($row->{status}) {
                my $cell = $_ // '-';
-               $cell = sprintf '<a href="%s">%s</a>', $_, $cell for $row->{spec} // ();
+               $cell = showlink($cell, $_) for $row->{spec} // ();
                printf '<td title="%s" class="l %s">%s',
                        $caniuse->{statuses}->{$_}, $CSTATUS{$_} // '', $cell;
        }
@@ -358,7 +389,12 @@ sub saybrowsercols {
                        || 'u'                       # unsure
                );
                unless (!defined $prev or $prev ~~ $compare) {
-                       my $usage = sum(@{ $canihas->{$browser} }{ map { @{$_} } @span });
+                       my @vercover = (map { @{$_} } @span);
+                       for ($ver ? @{$ver} : ()) {
+                               $data->{$_} eq $data->{$vercover[-1]} or last;
+                               push @vercover, $_;  # matches from next span start
+                       }
+                       my $usage = sum(@{ $canihas->{$browser} }{@vercover});
 
                        # strip #\d note references from support class
                        my @notes;
@@ -366,13 +402,16 @@ sub saybrowsercols {
                                while $prev =~ s/\h \# (\d+) \b//x;
 
                        # prepare version hover details
-                       my $title = sprintf('%.1f%% %s', $usage * $usagepct, join(', ',
-                               map { ref $_ eq 'CODE' ? $_->($browser) : $_ }
-                               map { $DSTATS{$_} // () }
-                               map { split / /, $_ }
-                               $prev
+                       my $title = sprintf('%.1f%% %s', $usage * $usagepct, join(' ',
+                               (map { ref $_ eq 'CODE' ? $_->($browser, $vercover[0]) : $_ }
+                                map { $DSTATS{$_} // () }
+                                map { split / /, $_ }
+                                $prev
+                               ),
+                               'in', $caniuse->{agents}->{$browser}->{abbr},
+                               showversions(@vercover, undef),
                        ));
-                       $title .= "\n".EscapeHTML($_) for @notes;
+                       $title .= "\n$_" for notestotitle(@notes);
 
                        printf('<td class="%s" colspan="%d" title="%s">%s',
                                join(' ',
@@ -381,11 +420,10 @@ sub saybrowsercols {
                                                sprintf('p%01d', $usage * ($usagepct - .0001) / 10),
                                                sprintf('p%02d', $usage * ($usagepct - .0001)),
                                        ),
-                                       sprintf('pp%02d', $usage / $usagemax),
                                ),
                                scalar @span,
                                $title,
-                               showversions($span[0]->[0], @span > 1 ? ($span[-1]->[-1]) : ()),
+                               showversions($span[0]->[0], @span > 1 ? $span[-1]->[-1] : ()),
                        );
                        undef $prev;
                        @span = ();
@@ -397,13 +435,12 @@ sub saybrowsercols {
 
 sub sayusagecol {
        my ($id) = @_;
-       print '<td>', int featurescore($caniuse->{data}->{$id}->{stats}) * $usagepct;
+       print '<td>', int $caniuse->{data}->{$id}->{usage};
 }
 
 say '<tbody>';
 for my $id (sort {
-           featurescore($caniuse->{data}->{$b}->{stats})
-       <=> featurescore($caniuse->{data}->{$a}->{stats})
+       $caniuse->{data}->{$b}->{usage} <=> $caniuse->{data}->{$a}->{usage}
 } keys %{ $caniuse->{data} }) {
        $caniuse->{data}->{$id}->{stats} or next;  # skip metadata [summary]
        printf '<tr id="%s">', $id;
@@ -424,13 +461,10 @@ sub paddedver {
 }
 
 sub showversions {
-       my @span = ($_[0], @_>1 ? $_[-1] : ());
-       s/-.*// for $span[0];
-       for (@span) {
-               s/^\./0./;
-               s/x$/.*/;
-               s/.*-//;
-       }
+       # title to describe minumum version and optional maximum for multiple cells
+       my @span = (map { split /-/ } grep { defined } @_);
+       return $span[0] =~ s/\.0\z//r if @_ <= 1;
+       splice @span, 1, -1;
        return join('‒', @span);
 }