cani 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae8ae8c652d00d36462bc6061152f8fc0ace6a1ef2a60829454e36a13724c61b
-  data.tar.gz: 57c8faa58ecee7055cd551cd04c22ec716741ffe4efdc8d1a2c039dd63fe6392
+  metadata.gz: c5da8f2224f0f5cbdc98b4e1d7a8a6a95575953b125cd2c3cf2c28655ed61108
+  data.tar.gz: c6bb2e718e250eb2c404198e635ab4efb5559f1ff0f2afffc476158a94c04d7e
 SHA512:
-  metadata.gz: 4b1a3afd03c2ee8a129ed679693f4c632c64221297ae2467194c41dad11baa1fb579a4288871613d0afe4bb759a8859b4a4771bb085438c072a156248e336532
-  data.tar.gz: 89939e8bceaf23bcd3e94317de9ed73231da669d339c828a06932d3864fe3b2a268fba435498b1a642e00b3411711f36577742662985e99145f44f448a976ad2
+  metadata.gz: bef86b81aae7fb02b08b5c977e00b73a79ee96e7e72671d72f62d4063c0ee6a19b5e109dd5180e2eb4975275739c61d8d797ca902b87b6a11dcc85b4d9bede19
+  data.tar.gz: 5380aa3abf603f177676595e95bb04c0c9d641d96db4a5d4e3a03246513a66a9a7222bc17595d5add80c01b457003a7c98b97e1121028a035bb2f727d93e19b5

data/README.md

@@ -59,7 +59,7 @@ Cani supports the following actions:
 - [`update`](#update) - force update data and completions
 - [`install_completions`](#install_completions) - install shell completions
 - [`purge`](#purge) - purge files and directories created by `cani`
-- [`edit`](#edit) - edit the default configuration file
+- [`edit`](#edit) - edit the default configuration file with `$EDITOR`
 
 ### use
 
@@ -73,11 +73,11 @@ each individual browser's support on a single row.
 This command may be invoked with a feature and supports <kbd>tab</kbd> completion in `bash`, `zsh` and `fish`:
 
 ```sh
-cani use box-shadow
+cani use grid-layout
 
 # or:
-# cani use 'box shadow'
-# cani use 'boxshadow'
+# cani use 'grid layout'
+# cani use 'gridlayout'
 ```
 
 The above command will show the following table:
@@ -85,8 +85,13 @@ The above command will show the following table:
 ![Cani use box-shadow support table](/assets/cani-feature-table.png)
 
 The table is responsive and will show browsers that fit in available space, everything else wraps accordingly.
-The 3-line high era in the middle resembles the "current era" of most used browsers. Browser versions with less than `0.5%` usage aren't shown.
-At the bottom there is a legend that provides an abbreviated status color overview.
+The current era has a light-black border. Browser versions with less than `0.5%` usage aren't shown.
+At the bottom there is a legend that provides an abbreviated status color overview. Below that, additional notes can be found.
+Notes are shown based on relevant and visible browsers, all other notes are hidden (this can be changed in the config).
+
+If your display height is `<= 40` lines, era's will be displayed in a more compact manner while still allowing space for notes:
+
+![Cani use box-shadow support table](/assets/cani-feature-table-compressed.png)
 
 ### show
 
@@ -98,6 +103,7 @@ Show a list of browsers. Selecting a browser will take you to the versions for t
 Selecting a version shows the final window with feature support for that specific browser version.
 Navigating to the previous window is possible by pressing <kbd>escape</kbd>, this will move you up one level.
 When <kbd>escape</kbd> is pressed at the browser selection menu, the command will exit.
+Selecting a feature using <kbd>enter</kbd> will show you the **current** support table for that feature **regardless** of selected version.
 
 This command may be invoked with a browser and / or version and supports <kbd>tab</kbd> completion in `bash`, `zsh` and `fish`:
 
@@ -105,7 +111,7 @@ This command may be invoked with a browser and / or version and supports <kbd>ta
 # show all versions of chrome
 cani show chr
 
-# show all supported features in chrome 70
+# show all features with support level in chrome 70
 cani show chr 70
 ```
 

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

@@ -160,8 +160,17 @@ module Cani
             Curses.addstr status_format
           end
 
+          # 'more or less' predict a height that is too small
+          # since we don't know the entire height but draw it line-by-line at the moment
           compact_height = height <= 40
 
+          # by default, notes are only shown if visible in the actual table
+          # this means there might be more notes than actually displayed
+          # but this allows us to optimally use available space to display
+          # the most useful information to the user
+          # TODO: provide a config setting to disable this behaviour
+          notes_visible = []
+
           # meaty part, loop through browsers to create
           # the final feature table
           browsers[0...viewable].each.with_index do |browser, x|
@@ -222,6 +231,7 @@ module Cani
                 end
 
                 if note_nums.any?
+                  notes_visible.concat(note_nums).uniq!
                   Curses.setpos ey - top_pad, bx
                   Curses.attron(note_color(supp_type)) { Curses.addstr ' ' + note_nums.join(' ') }
                 end
@@ -269,7 +279,11 @@ module Cani
           cy += 1
 
           notes_chunked = feature.notes.map { |nt| nt.chars.each_slice(outer_width).map(&:join).map(&:strip) }
-          num_chunked   = feature.notes_by_num.each_with_object({}) { |(k, nt), h| h[k] = nt.chars.each_slice(outer_width - 5).map(&:join).map(&:strip) }
+          filter_vis    = Cani.config.notes == 'relevant' ? notes_visible.map(&:to_s) : feature.notes_by_num.keys
+
+          num_chunked   = feature.notes_by_num
+                            .select { |(k, _)| filter_vis.include? k }
+                            .each_with_object({}) { |(k, nt), h| h[k] = nt.chars.each_slice(outer_width - 5).map(&:join).map(&:strip) }
           notes_total   = (notes_chunked.map(&:size) + num_chunked.map(&:size)).reduce(0) { |total, add| total + add }
 
           if height > cy + 2 && (notes_chunked.any? || num_chunked.any?)

data/lib/cani/config.rb

@@ -15,7 +15,8 @@ module Cani
       # usage settings
       'versions' => 1,
       'browsers' => %w[ie edge chrome firefox safari ios_saf opera android bb],
-      'navigate' => 'always'
+      'navigate' => 'always',
+      'notes'    => 'relevant'
     }.freeze
 
     def initialize(**opts)
@@ -95,6 +96,11 @@ module Cani
         f << "#   * 'always'  - always navigate back to the previous menu, exit only at root menu with <escape>\n"
         f << "#   * 'forward' - only allow navigating forward and backwards upto the menu that cani was initially open\n"
         f << "navigate: #{navigate}\n\n"
+        f << "# the notes property defines how notes should be displayed\n"
+        f << "# there are two different modes:\n"
+        f << "#   * 'all'      - show all notes, regardless of relevance\n"
+        f << "#   * 'relevant' - show only relevant (visible in an era) notes\n"
+        f << "notes: #{notes}\n\n"
         f << "# the \"versions\" key defines how many versions of support\n"
         f << "# will be shown in the \"use\" command\n"
         f << "# e.g. `-ie +edge` becomes `--ie ++edge` when this is set to 2, etc...\n"

data/lib/cani/version.rb

@@ -1,3 +1,3 @@
 module Cani
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cani
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Sidney Liebrand