cani 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2b242538b6ab9ffed230b58d02a7e8ce24eb0485f5c8360a3275da7d72c3e99
-  data.tar.gz: d623b2ea9fd17610916c4c17b2d4f52dd49d1fc7fd51c938969bcc3c4e4b7792
+  metadata.gz: 1779bf69b0e5700933653fecb00fc5d01afa4356fdb9b0f6e3c33dee79e83b40
+  data.tar.gz: 54b9a94174250fc18a2593c05a474f3fa15e1f106f9146dd2fcb91373733a10f
 SHA512:
-  metadata.gz: e4d4ebcced02abe4ed0d85152221fa93a1628ffac9549afbd1f0de16839dce2c353490c92d4874a93cbf5f23d364c44e5acde27254a6a7941313996280c412eb
-  data.tar.gz: 3bdf7ce824afbc541ff5cd03ab815d29503b750551f1c08c3980eb645bdb0f72612a717f26baebce2b076ae4461dab51370e177c452a48cdf944874616d5d28f
+  metadata.gz: d9d4bb3348016465616eaea9463e5f34a1f67b2f53bbd4ceba9c0395641c28f5de9144051af7e319986b7f712f3a84782ef218460911bbcd0a494987bf1f326f
+  data.tar.gz: 4f75d70a8ad7ca34887baadbf2ee1273d452aa3b63c945c1c687c5c35ff000576347e026d8af9763c82e011f682244541684ca5d7ec0f1a633933719314b8f69

data/README.md

@@ -1,4 +1,4 @@
-# Cani — a [caniuse.com](caniuse.com) tui interface ![Licence](https://img.shields.io/badge/license-MIT-E9573F.svg) [![Gem Version](https://img.shields.io/gem/v/cani.svg?colorB=E9573F&style=square)](rubygems.org/gems/cani) [![Issues](https://img.shields.io/github/issues/SidOfc/cani.svg)](https://github.com/SidOfc/cani/issues)
+# Cani — a [caniuse.com](caniuse.com) tui interface ![Licence](https://img.shields.io/badge/license-MIT-E9573F.svg) [![Gem Version](https://img.shields.io/gem/v/cani.svg?colorB=E9573F&style=square)](https://rubygems.org/gems/cani) [![Issues](https://img.shields.io/github/issues/SidOfc/cani.svg)](https://github.com/SidOfc/cani/issues)
 
 ![cani cli](/assets/cani.png)
 
@@ -34,7 +34,7 @@ Or install it yourself as:
 
 **dependencies**
 
-Cani depends on [fzf](https://github.com/junegunn/fzf) to display most menu's.
+Cani depends on [fzf](https://github.com/junegunn/fzf) to display most menu's and Curses for displaying the feature support table.
 <!-- Fzf is not a requirement when piping the output to another command -->
 
 ## Configuration
@@ -47,11 +47,16 @@ After installation, running the command (`cani`) for the first time will create
 - `~/.config/cani/completions/_cani.zsh` - zsh completion
 - `~/.config/fish/completions/cani.fish` - fish completions
 
-Some existing files will also be modified:
+**Existing shell configuration files will also be modified by default:**
 
 - `~/.bashrc` - A source line to bash completions will be added, or updated if it exists
 - `~/.zshrc` - A source line to zsh completions will be added, or updated if it exists
 
+This behavior can be permanently disabled at any time by adding the `--no-modify`
+[option](#options) at the end of the `cani` command. A built-in command is provided to print
+the completion paths for each shell: [`cani completion_paths`](#completion_paths). This allows
+you to add the path manually.
+
 After running the command for the first time, please restart your shell or `source` your `~/.*rc` file to load completions.
 There are some commented settings that can be adjusted in the `~/.config/cani/config.yml` file.
 
@@ -66,9 +71,17 @@ Cani supports the following actions:
 - [`version`](#version) - print the version number
 - [`update`](#update) - force update data and completions
 - [`install_completions`](#install_completions) - install shell completions
+- [`completion_paths`](#completion_paths) - prints paths to shell completion files (for sourcing)
 - [`purge`](#purge) - purge files and directories created by `cani`
 - [`edit`](#edit) - edit the default configuration file with `$EDITOR`
 
+## Options
+
+`cani` supports the following command line flags / options:
+
+- `--no-modify` - permanently disable automatic addition / deletion of shell config files.
+- `--modify` - permanently enable automatic addition / deletion of shell config files.
+
 ### use
 
 ```sh
@@ -157,6 +170,20 @@ Completions are supported for `zsh`, `bash` and `fish` shells (currently).
 They are automatically installed upon first invocation of the `cani` command.
 This command is only a fallback in case there were any issues with permissions etc..
 
+### completion_paths
+
+When `--no-modify` is applied the completion paths are no longer automatically inserted
+in your shell configuration files. In order to figure out where the files you need to
+source are located, you can run this command. It will output something like this:
+
+```plain
+fish: /home/sidofc/.config/fish/completions/cani.fish
+bash: /home/sidofc/.config/cani/completions/_cani.bash
+zsh:  /home/sidofc/.config/cani/completions/_cani.zsh
+```
+
+The fish completions are autoloaded and do not need to be sourced manually.
+
 ### purge
 
 ```sh

data/lib/cani.rb

@@ -23,8 +23,10 @@ module Cani
     @settings ||= Config.new
   end
 
+  def self.exec!(command, *args_and_options)
+    return config if command.start_with? '-'
 
-  def self.exec!(command, *args)
+    args    = args_and_options.reject { |arg| arg.start_with? '-' }
     command = :help unless command && respond_to?(command)
     command = command.to_s.downcase.to_sym
 
@@ -35,7 +37,8 @@ module Cani
       use args[0]
     when :show
       show args[0], args[1]
-    when :update, :purge, :help, :version, :install_completions
+    when :update, :purge, :help, :version,
+         :install_completions, :completion_paths
       send command
     else
       help
@@ -52,20 +55,23 @@ 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 'cani is dependent on fzf (https://github.com/junegunn/fzf)'.light_black
+    puts 'for the interactive TUI to work. Without fzf,'.light_black
+    puts 'commands can still be piped to get the regular (colorless) output.'.light_black
     puts ''
-    puts 'Cani requires at least 20 lines and 40 cols to work properly, this is not a hard limit but'.light_black
-    puts 'below this width, long lines could wrap a lot and significantly reduce visible information.'.light_black
+    puts 'Cani requires at least 20 lines and 40 cols to work properly,'.light_black
+    puts 'this is not a hard limit but below this width long lines could wrap'.light_black
+    puts 'a lot and significantly reduce visible information.'.light_black
     puts ''
     puts 'Usage:'.red
-    puts '   cani'.yellow + ' [COMMAND [ARGUMENTS]]'
+    puts '   cani'.yellow + ' [COMMAND [ARGUMENTS] [OPTIONS]]'
     puts ''
     puts 'Commands:'.red
     puts '   use '.blue + ' [FEATURE]             ' + 'show browser support for FEATURE'.light_black
     puts '   show'.blue + ' [BROWSER [VERSION]]   ' + 'show information about specific BROWSER and VERSION'.light_black
     puts '   '
     puts '   install_completions        '.blue      + 'installs completions for bash, zsh and fish'.light_black
+    puts '   completion_paths           '.blue      + 'prints completion paths that must be sourced in your shell configuration files'.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
@@ -74,6 +80,10 @@ module Cani
     puts '   help                       '.blue      + 'show this help'.light_black
     puts '   version                    '.blue      + 'print the version number'.light_black
     puts ''
+    puts 'Options:'.red
+    puts '   --[no-]modify              '.white + 'permanently enable/disable automatic adding/removing'.light_black
+    puts '                              '.white + 'of source lines in shell configuration files'.light_black
+    puts ''
     puts 'Examples:'.red
     puts '   cani'.yellow + ' use'.blue
     puts '   cani'.yellow + ' use'.blue  + ' \'box-shadow\''
@@ -95,8 +105,12 @@ module Cani
     puts VERSION
   end
 
+  def self.completion_paths
+    Completions.paths
+  end
+
   def self.install_completions
-    Completions.install!
+    Completions.install! || exit(1)
   end
 
   def self.purge
@@ -106,7 +120,7 @@ module Cani
   end
 
   def self.update
-    api.update! && Completions.install! || exit(1) unless api.updated?
+    api.update! && install_completions unless api.updated?
   end
 
   def self.edit

data/lib/cani/completions.rb

@@ -7,14 +7,14 @@ module Cani
       shw = Cani.api.browsers.reduce String.new do |acc, browser|
         versions = browser.versions.reverse.join(' ')
         acc +
-        "\ncomplete -f -c cani -n '__fish_cani_using_command show' -a '#{browser.abbr}' -d '#{browser.label}'" +
-        "\ncomplete -f -c cani -n '__fish_cani_showing_browser #{browser.abbr}' -a '#{versions}'"
+          "\ncomplete -f -c cani -n '__fish_cani_using_command show' -a '#{browser.abbr}' -d '#{browser.label}'" +
+          "\ncomplete -f -c cani -n '__fish_cani_showing_browser #{browser.abbr}' -a '#{versions}'"
       end
 
       use = Cani.api.features.reduce String.new do |acc, feature|
         description = feature.title.size > 40 ? feature.title[0..28] + '..' : feature.title
         acc +
-        "\ncomplete -f -c cani -n '__fish_cani_using_command use' -a '#{feature.name}' -d '#{description}'"
+          "\ncomplete -f -c cani -n '__fish_cani_using_command use' -a '#{feature.name}' -d '#{description}'"
       end
 
       tpl + shw + "\n" + use
@@ -26,8 +26,8 @@ module Cani
       indent    = 10
       versions  = Cani.api.browsers.reduce String.new do |acc, browser|
         acc + (' ' * (indent - 2)) + browser.abbr + ")\n" +
-        (' ' * indent) + "_arguments -C \"1: :(#{browser.versions.join(' ')})\"\n" +
-        (' ' * indent) + ";;\n"
+          (' ' * indent) + "_arguments -C \"1: :(#{browser.versions.join(' ')})\"\n" +
+          (' ' * indent) + ";;\n"
       end.strip
 
       tpl.gsub('{{names}}', Cani.api.browsers.map(&:abbr).join(' '))
@@ -41,8 +41,8 @@ module Cani
       indent    = 10
       versions  = Cani.api.browsers.reduce String.new do |acc, browser|
         acc + (' ' * (indent - 2)) + '"' + browser.abbr + "\")\n" +
-        (' ' * indent) + "COMPREPLY=($(compgen -W \"#{browser.versions.join(' ')}\" ${COMP_WORDS[COMP_CWORD]}))\n" +
-        (' ' * indent) + ";;\n"
+          (' ' * indent) + "COMPREPLY=($(compgen -W \"#{browser.versions.join(' ')}\" ${COMP_WORDS[COMP_CWORD]}))\n" +
+          (' ' * indent) + ";;\n"
       end.strip
 
       tpl.gsub('{{names}}', Cani.api.browsers.map(&:abbr).join(' '))
@@ -55,13 +55,8 @@ module Cani
       FileUtils.mkdir_p Cani.config.fish_comp_dir
       FileUtils.mkdir_p Cani.config.comp_dir
 
-      # write each completion file
-      File.open File.join(Cani.config.fish_comp_dir, 'cani.fish'), 'w' do |file|
-        file << generate_fish
-      end
-
-      %w[bash zsh].each do |shell|
-        File.open File.join(Cani.config.comp_dir, "_cani.#{shell}"), 'w' do |file|
+      %w[bash zsh fish].each do |shell|
+        File.open completion_path(shell), 'w' do |file|
           file << send("generate_#{shell}")
         end
       end
@@ -71,12 +66,8 @@ module Cani
     end
 
     def self.remove!
-      fish_comp = File.join Cani.config.fish_comp_dir, 'cani.fish'
-
-      File.unlink fish_comp if File.exist? fish_comp
-
-      %w[bash zsh].each do |shell|
-        shell_comp = File.join Cani.config.comp_dir, "_cani.#{shell}"
+      %w[bash zsh fish].each do |shell|
+        shell_comp = completion_path shell
 
         File.unlink shell_comp if File.exist? shell_comp
       end
@@ -85,12 +76,36 @@ module Cani
       delete_source_lines!
     end
 
+    def self.paths
+      puts "fish: #{completion_path(:fish)}"
+      puts "bash: #{completion_path(:bash)}"
+      puts "zsh:  #{completion_path(:zsh)}"
+    end
+
+    def self.completion_path(shell)
+      return File.join Cani.config.fish_comp_dir, 'cani.fish' if shell == :fish
+
+      File.join Cani.config.comp_dir, "_cani.#{shell}"
+    end
+
+    def self.compile_source_line(path)
+      return "test -e #{path}; and source #{path}" if path.end_with? '.fish'
+
+      "[ -f #{path} ] && source #{path}"
+    end
+
     def self.delete_source_lines!
+      return unless Cani.config.modify_shell_configs
+
       %w[bash zsh].each do |shell|
-        shellrc   = File.join Dir.home, ".#{shell}rc"
+        shellrc = File.join Dir.home, ".#{shell}rc"
+
+        next unless File.exist? shellrc
+
         lines     = File.read(shellrc).split "\n"
-        comp_path = File.join Cani.config.comp_dir, "_cani.#{shell}"
-        rm_idx    = lines.find_index { |l| l.match comp_path }
+        comp_path = completion_path shell
+        comp_src  = compile_source_line comp_path
+        rm_idx    = lines.find_index { |l| l.match comp_src }
 
         lines.delete_at rm_idx unless rm_idx.nil?
         File.write shellrc, lines.join("\n")
@@ -98,18 +113,19 @@ module Cani
     end
 
     def self.insert_source_lines!
+      return unless Cani.config.modify_shell_configs
+
       %w[bash zsh].each do |shell|
-        shellrc   = File.join Dir.home, ".#{shell}rc"
+        shellrc = File.join Dir.home, ".#{shell}rc"
+
+        next unless File.exist? shellrc
+
         lines     = File.read(shellrc).split "\n"
-        comp_path = File.join Cani.config.comp_dir, "_cani.#{shell}"
-        slidx     = lines.find_index { |l| l.match comp_path }
-
-        if slidx
-          lines[slidx] =
-            "#{lines[slidx][/^\s+/]}[ -f #{comp_path} ] && source #{comp_path}"
-        else
-          lines << "[ -f #{comp_path} ] && source #{comp_path}"
-        end
+        comp_path = completion_path shell
+        comp_src  = compile_source_line comp_path
+
+        lines << comp_src \
+          unless lines.find_index { |l| l.match comp_src }
 
         File.write shellrc, lines.join("\n")
       end

data/lib/cani/config.rb

@@ -1,13 +1,14 @@
 module Cani
   class Config
-    attr_reader :settings
-
-    FILE          = File.join(Dir.home, '.config', 'cani', 'config.yml').freeze
-    DIRECTORY     = File.dirname(FILE).freeze
-    COMP_DIR      = File.join(DIRECTORY, 'completions').freeze
-    FISH_DIR      = File.join(Dir.home, '.config', 'fish').freeze
-    FISH_COMP_DIR = File.join(FISH_DIR, 'completions').freeze
-    DEFAULTS      = {
+    attr_reader :settings, :modify_shell_configs
+
+    FILE           = File.join(Dir.home, '.config', 'cani', 'config.yml').freeze
+    DIRECTORY      = File.dirname(FILE).freeze
+    COMP_DIR       = File.join(DIRECTORY, 'completions').freeze
+    FISH_DIR       = File.join(Dir.home, '.config', 'fish').freeze
+    FISH_COMP_DIR  = File.join(FISH_DIR, 'completions').freeze
+    NO_MODIFY_FILE = File.join(DIRECTORY, '.no-modify-shellrc').freeze
+    DEFAULTS       = {
       # data settings
       'expire'   => 86_400,
       'source'   => 'https://raw.githubusercontent.com/Fyrd/caniuse/master/data.json',
@@ -20,7 +21,16 @@ module Cani
     }.freeze
 
     def initialize(**opts)
-      @settings = DEFAULTS.merge opts
+      no_modify_exists      = File.exist? NO_MODIFY_FILE
+      @settings             = DEFAULTS.merge opts
+      @modify_shell_configs =
+        if allow_shellrc_modification?
+          File.delete NO_MODIFY_FILE if no_modify_exists
+          true
+        elsif disallow_shellrc_modification?
+          FileUtils.touch NO_MODIFY_FILE unless no_modify_exists
+          false
+        end
 
       if File.exist? file
         if (yml = YAML.load_file(file))
@@ -31,6 +41,14 @@ module Cani
       end
     end
 
+    def disallow_shellrc_modification?
+      ARGV.include?('--no-modify') || File.exist?(NO_MODIFY_FILE)
+    end
+
+    def allow_shellrc_modification?
+      ARGV.include?('--modify') || !disallow_shellrc_modification?
+    end
+
     def file
       FILE
     end

data/lib/cani/fzf.rb

@@ -13,7 +13,11 @@ module Cani
         header = ohdr.is_a?(Array) ? [:cani, *ohdr].map { |v| v.to_s.downcase }.join(':')
                                    : 'cani:' + ohdr.to_s
 
-        `echo "#{rows}" | fzf --ansi --header="[#{header}]" #{query}`.split '   '
+        IO.popen("fzf --ansi --header=\"[#{header}]\" #{query}", 'r+') do |io|
+          io.write rows
+          io.close_write
+          io.read
+        end.split '   '
       else
         # when output of any initial command is being piped
         # print results and exit this command.

data/lib/cani/version.rb

@@ -1,3 +1,3 @@
 module Cani
-  VERSION = "0.5.4"
+  VERSION = "0.5.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cani
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - Sidney Liebrand
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-06 00:00:00.000000000 Z
+date: 2019-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -161,8 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A simple caniuse CLI.