cani 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95f111716af0ddbdcc7341fee4f664ce201f717a0e9eac416f2677149cc641fc
-  data.tar.gz: f2284ea6bb64a1087e08d618238898a13f0914cf27d31893e0cbdcd5d4c82579
+  metadata.gz: 8ff42679497b6da393ca2d601e565ca49d501b76b1367e32dfbb2adf3adee28d
+  data.tar.gz: 332bf2512f53057c7cd7cca0009e073c220793b59e125ba9f3fc1c6d0fc98b7e
 SHA512:
-  metadata.gz: 01c58a9b40c957fc38c538496cf92fb717f1ab0edc0a79c703964516e294eb442003ba0f21338dd87467e6e14e41a2b4cf18f147f8933b9abf81da92bb92ad66
-  data.tar.gz: 28ce0494ce59876a5f96ac631461cb43388490e04db11caebe5fc56d9254136043211e3e85cf6167488b3bb92d4c90969994c40addc6557c4e0740a9aa6b4a03
+  metadata.gz: 1c15d317bf97d80e28f16912b7dc87d3ee40b5cd3b7780265a69fb233fd966091f9713ecd0ec86e20214976290472086bf94ab6d9571ecd67a8e0db8110d8ac7
+  data.tar.gz: 9171b98adfe8438716418044a53aca5f5dc3da5838933302a3280a4b7d326b8aaa603fda6e710981a0fa469cc6a9e411766911b53d5e707af8a59102be960a3b

data/Gemfile.lock

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

data/lib/cani/config.rb

@@ -14,7 +14,8 @@ module Cani
 
       # usage settings
       'versions' => 1,
-      'browsers' => %w[ie edge chrome firefox safari ios_saf opera android bb]
+      'browsers' => %w[ie edge chrome firefox safari ios_saf opera android bb],
+      'navigate' => 'always'
     }.freeze
 
     def initialize(**opts)
@@ -54,6 +55,10 @@ module Cani
       FileUtils.rm_rf directory if Dir.exist? directory
     end
 
+    def nav_type?(type)
+      navigate == type.to_s
+    end
+
     def install!
       hrs  = (DEFAULTS['expire'] / 3600.to_f).round 2
       days = (hrs / 24.to_f).round 2
@@ -84,16 +89,20 @@ module Cani
         f << "# the \"source\" key is used to fetch the data required for\n"
         f << "# this command to work.\n"
         f << "source: #{source}\n\n"
+        f << "# navigating means reopening the previously open window when going back by pressing <escape>\n"
+        f << "# or opening the next menu by selecting an entry in fzf with <enter>\n"
+        f << "# there are two different navigation modes:\n"
+        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 \"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..."
+        f << "# e.g. `-ie +edge` becomes `--ie ++edge` when this is set to 2, etc...\n"
         f << "versions: #{versions}\n\n"
         f << "# the \"browsers\" key defines which browsers are shown\n"
         f << "# in the \"use\" command\n"
         f << "browsers:\n"
-        f << "  # enabled:\n"
         f << browsers.map { |bn| "  - #{bn}" }.join("\n") + "\n"
-        f << "  # others:\n"
         f << (Cani.api.browsers.map(&:name) - browsers).map { |bn| "  # - #{bn}" }.join("\n")
       end
 

data/lib/cani/version.rb

@@ -1,3 +1,3 @@
 module Cani
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/cani.rb

@@ -28,6 +28,8 @@ module Cani
     command = command.to_s.downcase.to_sym
 
     case command
+    when :edit
+      edit
     when :use
       use args[0]
     when :show
@@ -49,6 +51,9 @@ module Cani
     puts 'in the \'use\' overview or calling \'use some-feature\' will display a'.light_black
     puts 'table as seen on caniuse.com using curses.'.light_black
     puts ''
+    puts 'cani is dependent on fzf (https://github.com/junegunn/fzf) for the interactive TUI to work.'.light_black
+    puts 'without fzf, commands can still be piped to get the regular (colorless) output'.light_black
+    puts ''
     puts 'Usage:'.red
     puts '   cani'.yellow + ' [COMMAND [ARGUMENTS]]'
     puts ''
@@ -58,6 +63,7 @@ module Cani
     puts '   '
     puts '   install_completions        '.blue      + 'installs completions for bash, zsh and fish'.light_black
     puts '   update                     '.blue      + 'force update api data and completions'.light_black
+    puts '   edit                       '.blue      + 'edit configuration in $EDITOR'.light_black
     puts '   purge                      '.blue      + 'remove all completion, configuration and data'.light_black
     puts '                              '.blue      + 'stored by this cani'.light_black
     puts '   '
@@ -69,6 +75,7 @@ module Cani
     puts '   cani'.yellow + ' use'.blue  + ' \'box-shadow\''
     puts '   cani'.yellow + ' show'.blue + ' ie'
     puts '   cani'.yellow + ' show'.blue + ' ie 11'
+    puts '   cani'.yellow + ' show'.blue + ' ie' + ' |'.light_black + ' cat'.yellow
     puts ''
     puts 'Statuses:'.red
     puts '   [ls]'.green   + '   WHATWG Living Standard'.light_black
@@ -103,9 +110,11 @@ module Cani
   end
 
   def self.use(feature = nil)
+    @use_min_depth ||= feature ? 1 : 0
+
     if feature && (feature = api.find_feature(feature))
       Api::Feature::Viewer.new(feature).render
-      use
+      use unless config.nav_type?('forward') && @use_min_depth > 0
     elsif (chosen = Fzf.pick(Fzf.feature_rows,
                              header: 'use]   [' + Api::Feature.support_legend,
                              colors: %i[green light_black light_white light_black]))
@@ -121,16 +130,24 @@ module Cani
   end
 
   def self.show(brws = nil, version = nil)
-    browser = api.find_browser brws
+    browser           = api.find_browser brws
+    @show_min_depth ||= 0 + (browser ? 1 : 0) + (version ? 1 : 0)
 
     if browser
       if version
-        Fzf.pick Fzf.browser_feature_rows(browser, version),
-                 header: "show:#{browser.title.downcase}:#{version}]   [#{Api::Feature.support_legend}",
-                 colors: [:green, :light_black, :light_white]
+        chosen = Fzf.pick Fzf.browser_feature_rows(browser, version),
+                          header: "show:#{browser.title.downcase}:#{version}]   [#{Api::Feature.support_legend}",
+                          colors: [:green, :light_black, :light_white]
 
-        show browser.title
+        if chosen.any? && (feature = api.find_feature(chosen[2]))
+          Api::Feature::Viewer.new(feature).render
+          show browser.title, version
+        else
+          show browser.title
+        end
       else
+        exit if config.nav_type?('forward') && @show_min_depth > 1
+
         if (version = Fzf.pick(Fzf.browser_usage_rows(browser),
                                header: [:show, browser.title],
                                colors: %i[white light_black]).first)
@@ -140,6 +157,8 @@ module Cani
         end
       end
     else
+      exit if config.nav_type?('forward') && @show_min_depth > 0
+
       browser = api.find_browser Fzf.pick(Fzf.browser_rows,
                                           header: [:show],
                                           colors: %i[white light_black]).first

data/shell/completions/functions.bash

@@ -19,7 +19,7 @@ _cani_completions() {
       COMPREPLY=($(compgen -W "{{features}}" "${COMP_WORDS[COMP_CWORD]}"))
       ;;
     *)
-      COMPREPLY=($(compgen -W "use show help version update purge install_completions" "${COMP_WORDS[COMP_CWORD]}"))
+      COMPREPLY=($(compgen -W "use show help version update purge edit install_completions" "${COMP_WORDS[COMP_CWORD]}"))
       ;;
   esac
 }

data/shell/completions/functions.fish

@@ -39,5 +39,6 @@ complete -f -c cani -n '__fish_cani_needs_command' -a 'help' -d 'Show command he
 complete -f -c cani -n '__fish_cani_needs_command' -a 'version' -d 'Print the version number'
 complete -f -c cani -n '__fish_cani_needs_command' -a 'update' -d 'force update api data and completions'
 complete -f -c cani -n '__fish_cani_needs_command' -a 'purge' -d 'remove all completion, configuration files and data stored by this cani'
+complete -f -c cani -n '__fish_cani_needs_command' -a 'edit' -d 'open configuration in $EDITOR'
 complete -f -c cani -n '__fish_cani_needs_command' -a 'install_completions' -d 'install completions for bash, zsh and fish'
 # update purge install_completions

data/shell/completions/functions.zsh

@@ -8,7 +8,7 @@
 function _cani {
   local line
 
-  _arguments -C "1: :(use show help version update purge install_completions)" \
+  _arguments -C "1: :(use show help version update purge edit install_completions)" \
                 "*::arg:->args"
 
   case $line[1] in

metadata

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