cani 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cd61890b987c88ef41a0dcf5e30ee5fb22dafd234e5855fadc3e3319753e0ba
-  data.tar.gz: c40c2b1cd8ebe4e6bf6ec16ee5cce0863b903711d21b518ac8e45c562b166a99
+  metadata.gz: 1df7e81ecfee9fcb8dde134bf7d3c6db8ae21520c3185b28055bfdefbf2f2f94
+  data.tar.gz: c3c2eb816e5ea8fb0707db1a49c19f5fbdd8ac9122f4e8678713e5a9d184b3d9
 SHA512:
-  metadata.gz: 4e16c24b8230c0d6515be703fa6ab9f1f0cf5a0672b4896e711c4ba230569c5c373cf27b4930559a4a57ff912010bdb131d2fffa675407304359ee32da4922a2
-  data.tar.gz: c252dc1cdb93ed2a18e229b55bec0b4f92429922326ce764f4f34b32909af4ba867a9eb4cd8df77429e23a840350d06977f36667695438e1502a024d8346ea31
+  metadata.gz: e5ca259ccc81e38e8646feb058863231439831a1fbc1f6adc06d32240286cf19cb68bbccefd0d9b3275f9d05a7d495472c11a7570056fddafb03a51307c8d3a8
+  data.tar.gz: a77833ff65dd10cfe9f71ba665d5979acf7d95dcb45042b0083afd023e979bdaebc98846bcc0a8a54682b54ee0595de4a92b03e4643cc746a2bbac1d06f3115a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cani (0.2.0)
+    cani (0.2.2)
       colorize
       curses
       json

data/lib/cani/api/feature.rb

@@ -1,7 +1,7 @@
 module Cani
   class Api
     class Feature
-      attr_reader :title, :status, :spec, :stats, :percent, :name
+      attr_reader :title, :status, :spec, :stats, :percent, :name, :browser_note_nums, :notes, :notes_by_num
 
       STATUSES = {
         'rec'   => 'rc',
@@ -25,9 +25,14 @@ module Cani
         @status  = STATUSES.fetch attributes['status'], attributes['status']
         @spec    = attributes['spec']
         @percent = attributes['usage_perc_y']
-        @stats   = attributes['stats'].each_with_object({}) do |(k, v), h|
-          h[k] = v.each_with_object({}) do |(vv, s), hh|
-            vv.split('-').each { |ver| hh[ver] = s[0] }
+        @notes   = attributes['notes'].split "\n"
+        @notes_by_num = attributes['notes_by_num']
+        @stats, @browser_note_nums = attributes['stats'].each_with_object([{}, {}]) do |(browser, info), (stts, notes)|
+          stts[browser], notes[browser] = info.each_with_object([{}, {}]) do |(version, stat), (st, nt)|
+            version.split('-').each do |v|
+              nt[v] = stat.scan(/#(\d+)/).flatten
+              st[v] = stat[' d '] ? 'd' : stat[0]
+            end
           end
         end
       end

data/lib/cani/api/feature/viewer.rb

@@ -7,31 +7,43 @@ module Cani
         COLOR_PAIRS = {
           # foreground colors
           69  => [70,  -1], # green on default   (legend supported, feature status, percentage counter)
-          213 => [214, -1], # orange on default  (legend partial, percentage counter)
-          195 => [9,   -1], # red on default     (legend unsupported, percentage counter)
-          133 => [13,  -1], # magenta on default (legend flag, current feature status)
+          213 => [208, -1], # orange on default  (legend partial, percentage counter)
+          195 => [160, -1], # red on default     (legend unsupported, percentage counter)
+          133 => [134, -1], # magenta on default (legend flag, current feature status)
           12  => [75,  -1], # blue on default    (legend prefix)
           204 => [205, -1], # pink on default    (legend polyfill)
-          99  => [8,   -1], # gray on default    (legend unknown)
+          99  => [239, -1], # gray on default    (legend unknown)
 
+          # note background + foreground colors
+          71  => [22,   70], # dark green on green     (supported feature)
+          209 => [130, 208], # dark orange on orange   (partial feature)
+          197 => [88,  160], # dark red on red         (unsupported feature)
+          135 => [91,  134], # dark magenta on magenta (flag features)
+          13  => [27,   75], # dark blue on blue       (prefix feature)
+          101 => [235, 239], # dark gray on gray       (unknown features)
+          206 => [127, 205], # dark pink on pink       (polyfill features)
 
           # background colors
           70  => [7,  70], # white on green      (supported feature)
-          208 => [7, 214], # white on orange     (partial feature)
-          196 => [7,   9], # white on red        (unsupported feature)
-          134 => [7,  13], # white on magenta    (flag features)
+          208 => [7, 208], # white on orange     (partial feature)
+          196 => [7, 160], # white on red        (unsupported feature)
+          134 => [7, 134], # white on magenta    (flag features)
           11  => [7,  75], # white on blue       (prefix feature)
-          100 => [7,   8], # white on gray       (unknown features)
+          100 => [7, 239], # white on gray       (unknown features)
           205 => [7, 205], # white on pink       (polyfill features)
 
           # misc / one-off
           254 => [238, 255], # black on light gray (browser names, legend title)
+          239 => [232, 236]
         }.freeze
 
         COLORS = {
           # table headers
           header:      {fg: Curses.color_pair(254), bg: Curses.color_pair(254)},
 
+          # current era border
+          era_border:  {fg: Curses.color_pair(239), bg: Curses.color_pair(239)},
+
           # support types
           default:     {fg: Curses.color_pair(69),  bg: Curses.color_pair(70)},
           partial:     {fg: Curses.color_pair(213), bg: Curses.color_pair(208)},
@@ -46,6 +58,16 @@ module Cani
           ot:          {fg: Curses.color_pair(133), bg: Curses.color_pair(134)}
         }.freeze
 
+        NOTE_COLORS = {
+          default:     {fg: Curses.color_pair(71),  bg: Curses.color_pair(70)},
+          partial:     {fg: Curses.color_pair(209), bg: Curses.color_pair(208)},
+          prefix:      {fg: Curses.color_pair(13),  bg: Curses.color_pair(11)},
+          polyfill:    {fg: Curses.color_pair(206), bg: Curses.color_pair(205)},
+          flag:        {fg: Curses.color_pair(135), bg: Curses.color_pair(134)},
+          unsupported: {fg: Curses.color_pair(197), bg: Curses.color_pair(196)},
+          unknown:     {fg: Curses.color_pair(101), bg: Curses.color_pair(100)},
+        }
+
         PERCENT_COLORS = {
           70..101 => {fg: Curses.color_pair(69),  bg: Curses.color_pair(70)},
           40..70  => {fg: Curses.color_pair(213), bg: Curses.color_pair(208)},
@@ -67,7 +89,6 @@ module Cani
           Curses.init_screen
           Curses.curs_set 0
           Curses.noecho
-          Curses.cbreak
 
           if Curses.has_colors?
             Curses.use_default_colors
@@ -93,14 +114,10 @@ module Cani
           status_format = "[#{feature.status}]"
           percent_label = compact? ? '' : 'support: '
           legend_format = 'legend'.center table_width
+          notes_format  = 'notes'.center table_width
 
-          title_size    = [table_width - percent_num.size - percent_label.size - status_format.size - 3, 1].max
-          title_size   += status_format.size if compact?
-          title_chunks  = feature.title.chars.each_slice(title_size).map { |chrs| chrs.compact.join }
-
-          type_count    = Feature::TYPES.keys.size
           offset_x      = ((width - table_width) / 2.0).floor
-          offset_y      = ((height - ERAS - title_chunks.size - 10 - (type_count / [type_count, viewable].min.to_f).ceil) / 2.0).floor
+          offset_y      = 1
           cy            = 0
 
           # positioning and drawing of percentage
@@ -119,6 +136,10 @@ module Cani
           end
 
           # draw possibly multi-line feature title
+          title_size    = [table_width - percent_num.size - percent_label.size - status_format.size - 3, 1].max
+          title_size   += status_format.size if compact?
+          title_chunks  = feature.title.chars.each_slice(title_size).map(&:join)
+
           title_chunks.each do |part|
             Curses.setpos offset_y + cy, offset_x
             Curses.addstr part
@@ -138,6 +159,8 @@ module Cani
             Curses.addstr status_format
           end
 
+          compact_height = height <= 40
+
           # meaty part, loop through browsers to create
           # the final feature table
           browsers[0...viewable].each.with_index do |browser, x|
@@ -156,39 +179,51 @@ module Cani
 
             # accordingly increment current browser y for the table header (browser names)
             # and an additional empty line below the table header
-            by += 2
+            by += 3
 
             # draw era's for the current browser
             era_range.each.with_index do |cur_era, y|
-              era  = browser.eras[cur_era].to_s
-              colr = color(feature.support_in(browser.name, era))
-
-              # since the current era versions are displayed as 3-line rows
-              # with an empty line before and after them, when we are at the current
-              # era we increment era y by an additional 2 for the lines above,
-              # whenever we are past the current era, increment by 2 for above plus 2
-              # extra lines below the current era
-              ey = by + y + (cur_era == era_idx ? 2 : (cur_era > era_idx ? 4 : 0))
+              era        = browser.eras[cur_era].to_s
+              supp_type  = feature.support_in(browser.name, era)
+              colr       = color supp_type
+              is_current = cur_era == era_idx
+              past_curr  = cur_era > era_idx
+              top_pad    = 1
+              bot_pad    = compact_height ? 0 : 1
+              ey         = by + (y * (2 + top_pad + bot_pad)) + (bot_pad.zero? && past_curr ? 1 : 0)
+              note_nums  = feature.browser_note_nums.fetch(browser.name, {})
+                                                    .fetch(era, [])
+
+              if is_current
+                Curses.setpos ey - top_pad - 1, bx - 1
+                Curses.attron(color(:era_border)) { Curses.addstr ' ' * (col_width + 2) }
+
+                Curses.setpos ey + (is_current ? 1 : bot_pad) + 1, bx - 1
+                Curses.attron(color(:era_border)) { Curses.addstr ' ' * (col_width + 2) }
+              end
 
-              # only show relevant browsers
+              # only show visible / relevant browsers
               if browser.usage[era].to_i >= 0.5 || (!era.empty? && cur_era >= era_idx)
-                Curses.setpos ey, bx
-                Curses.attron colr do
-                  Curses.addstr era.center(col_width)
-                end
+                ((ey - top_pad)..(ey + (is_current ? 1 : bot_pad))).each do |ry|
+                  txt = (bot_pad.zero? && !is_current) ? (ry >= ey + (is_current ? 1 : bot_pad) ? era.to_s : ' ')
+                                      : (ry == ey ? era.to_s : ' ')
+
+                  Curses.setpos ry, bx
+                  Curses.attron(colr) { Curses.addstr txt.center(col_width) }
+
+                  if is_current
+                    Curses.setpos ry, bx - 1
+                    Curses.attron(color(:era_border)) { Curses.addstr ' ' }
 
-                # previously, we only skipped some lines in order to create
-                # enough space to create the 3-line current era
-                # this snippet fills the line before and after the current era
-                # with the same color that the era has for that browser / feature
-                if cur_era == era_idx
-                  [-1, 1].each do |relative_y|
-                    Curses.setpos ey - relative_y, bx
-                    Curses.attron colr do
-                      Curses.addstr ' ' * col_width
-                    end
+                    Curses.setpos ry, offset_x + table_width + 2
+                    Curses.attron(color(:era_border)) { Curses.addstr ' ' }
                   end
                 end
+
+                if note_nums.any?
+                  Curses.setpos ey - top_pad, bx
+                  Curses.attron(note_color(supp_type)) { Curses.addstr ' ' + note_nums.join(' ') }
+                end
               end
             end
           end
@@ -197,12 +232,14 @@ module Cani
           # plus the 4 lines around the current era
           # plus the 1 line of browser names
           # plus the 2 blank lines above and below the eras
-          cy += ERAS + 7
+          cy += (ERAS - 1) * (compact_height ? 3 : 4) + ERAS
 
-          # print legend header
-          Curses.setpos offset_y + cy, offset_x
-          Curses.attron color(:header) do
-            Curses.addstr legend_format
+          if height > cy + 3
+            # print legend header
+            Curses.setpos offset_y + cy, offset_x
+            Curses.attron color(:header) do
+              Curses.addstr legend_format
+            end
           end
 
           # increment current y by 2
@@ -212,16 +249,64 @@ module Cani
 
           # loop through all features to create a legend
           # showing which label belongs to which color
-          Feature::TYPES.values.each_slice viewable do |group|
-            group.compact.each.with_index do |type, lx|
-              Curses.setpos offset_y + cy, offset_x + lx * col_width + lx
-              Curses.attron color(type[:name], :fg) do
-                Curses.addstr "#{type[:short]}(#{type[:symbol]})".center(col_width)
+          if height > cy + 1
+            Feature::TYPES.values.each_slice viewable do |group|
+              group.compact.each.with_index do |type, lx|
+                Curses.setpos offset_y + cy, offset_x + lx * col_width + lx
+                Curses.attron color(type[:name], :fg) do
+                  Curses.addstr "#{type[:short]}(#{type[:symbol]})".center(col_width)
+                end
               end
+
+              # if there is more than one group, print the next
+              # group on a new line
+              cy += 1
+            end
+          end
+
+          # add extra empty line after legend
+          cy += 1
+
+          notes_chunked = feature.notes.map { |nt| nt.chars.each_slice(table_width).map(&:join).map(&:strip) }
+          num_chunked   = feature.notes_by_num.each_with_object({}) { |(k, nt), h| h[k] = nt.chars.each_slice(table_width - 5).map(&:join).map(&:strip) }
+          notes_total   = notes_chunked.map(&:size).sum + num_chunked.map(&:size).sum
+
+          if height > cy + 2 && (notes_chunked.any? || num_chunked.any?)
+            # print notes header
+            Curses.setpos offset_y + cy, offset_x
+            Curses.attron color(:header) do
+              Curses.addstr notes_format
+            end
+          end
+
+          # add two new lines, one for the notes header
+          # and one empty line below it
+          cy += 2
+
+          notes_chunked.each do |chunks|
+            break if cy + 1 + chunks.size > height
+            chunks.each do |part|
+              Curses.setpos offset_y + cy, offset_x
+              Curses.addstr part
+              cy += 1
+            end
+
+            cy += 1
+          end
+
+          num_chunked.each do |num, chunks|
+            break if cy + 1 + chunks.size > height
+            Curses.setpos offset_y + cy, offset_x
+            Curses.attron color(:header) do
+              Curses.addstr num.center(3)
+            end
+
+            chunks.each do |part|
+              Curses.setpos offset_y + cy, offset_x + 5
+              Curses.addstr part
+              cy += 1
             end
 
-            # if there is more than one group, print the next
-            # group on a new line
             cy += 1
           end
 
@@ -262,20 +347,24 @@ module Cani
           end
 
           @col_width   = [colw, Feature::TYPES.map { |(_, h)| h[:short].size }.max + 3].max
-          @table_width = tablew
+          @table_width = tablew - 2 # vertical padding at start and end of current era line
         end
 
         def compact?
           width < COMPACT
         end
 
-        def color(key, type = :bg)
+        def color(key, type = :bg, source = COLORS)
           target = key.to_s.downcase.to_sym
           type   = type.to_sym
 
-          COLORS.find { |(k, _)| k == target }.to_a
+          source.find { |(k, _)| k == target }.to_a
                 .fetch(1, {})
-                .fetch(type, COLORS[:default][type])
+                .fetch(type, source[:default][type])
+        end
+
+        def note_color(status)
+          color status, :fg, NOTE_COLORS
         end
 
         def status_color(status)

data/lib/cani/version.rb

@@ -1,3 +1,3 @@
 module Cani
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cani
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Sidney Liebrand
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-19 00:00:00.000000000 Z
+date: 2018-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize