cani 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bbc79d5e5ddb3a2d40c39165c898d32ffa657a68dec23636f1b2b15da5bb9857
+  data.tar.gz: b93cf69ff6740b4fbd11010d5d3c05c196eb2e63edcdc5efbe09dba51279ba12
+SHA512:
+  metadata.gz: 688f7a52ab214dfeb46e46a1b93c8ab16e9ecc2fecd8d7e2a2de2c57b4cb0588e088bb24e313e8f9bb08e0e218842ea3b16439983357ad51dca35a778bacf706
+  data.tar.gz: eae2981b38417c952878e3dd9fd7309881f07fe39bf726bd7986a74bb5d7a9f053f4453d4e909e12927b8d5d46104570ba0a450781ebff66932ee390ff279990

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sidneyliebrand@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in cani.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    cani (0.1.0)
+      colorize
+      json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    colorize (0.8.1)
+    diff-lcs (1.3)
+    json (2.1.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  cani!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sidney Liebrand
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,140 @@
+# Cani
+
+![cani cli](/assets/cani.png)
+
+Cani is a small command-line wrapper around the data of [caniuse](https://caniuse.com).
+It uses [fzf](https://github.com/junegunn/fzf) to display results.
+This wrapper aims to be easy to use out of the box. To achieve this it ships with completions
+for `bash`, `fish`, and `zsh`. [Caniuse data (1.7MB)](https://github.com/Fyrd/caniuse/blob/master/data.json) is fetched and updated automatically
+on a regular interval together with completions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cani'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cani
+
+## Configuration
+
+After installation, running the command (`cani`) for the first time will create some files and directories:
+
+- `~/.config/cani/config.yml` - default configuration
+- `~/.config/cani/caniuse.json` - caniuse api data
+- `~/.config/cani/completions/_cani.bash` - bash completion
+- `~/.config/cani/completions/_cani.zsh` - zsh completion
+- `~/.config/fish/completions/cani.fish` - fish completions
+
+Some existing files will also be modified:
+
+- `~/.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
+
+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.
+
+## Usage
+
+Running `cani` without arguments yields the help description.
+Cani supports the following actions:
+
+- [`use`](#use) - show browser support for all features
+- [`show BROWSER VERSION`](#show) - show feature support based on selected browser / version
+- [`help`](#help) - show help
+- [`version`](#version) - print the version number
+- [`update`](#update) - force update data and completions
+- [`install_completions`](#install_completions) - install shell completions
+- [`purge`](#purge) - purge files and directories created by `cani`
+
+### use
+
+```sh
+cani use
+```
+
+Show a list of features with fzf. Features are shown with their current W3C status, percentage of support, title and
+each individual browser's support on a single row.
+
+### show
+
+```sh
+cani show
+```
+
+Show a list of browsers. Selecting a browser will take you to the versions for that browser.
+Selecting a version shows the final window with feature support for that specific browser version.
+
+This command can also be invoked directly with a browser and version:
+
+```sh
+# show all versions of chrome
+cani show chr
+
+# show all supported features in chrome 70
+cani show chr 70
+```
+
+### help
+
+```sh
+cani help
+```
+
+Displays short help for the `cani` command
+
+### version
+
+```sh
+cani version
+```
+
+Displays the current version e.g: `0.1.0`
+
+### update
+
+```sh
+cani update
+```
+
+Force update dataset and completions.
+
+### install_completions
+
+```sh
+cani install_completions
+```
+
+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..
+
+### purge
+
+```sh
+cani purge
+```
+
+Purges all files created by this command, removing every trace except the executable itself.
+It will also remove source lines added that pointed to the completions in `~/.zshrc` and `~/.bashrc`.
+After running a `purge`, all that remains is running `gem uninstall cani` to completely purge it.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sidofc/cani. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Cani project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cani/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'pry'
+require 'cani'
+
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cani.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cani/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cani'
+  spec.version       = Cani::VERSION
+  spec.authors       = ['Sidney Liebrand']
+  spec.email         = ['sidneyliebrand@gmail.com']
+
+  spec.summary       = 'A simple caniuse CLI.'
+  spec.description   = 'A rework of the ruby script from my medium post: https://medium.com/@sidneyliebrand/combining-caniuse-with-fzf-fb93ad235bae'
+  spec.homepage      = 'https://github.com/SidOfc/cani'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features|assets)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'colorize'
+  spec.add_runtime_dependency 'json'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/exe/cani

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'cani'
+
+# extract first non-option (options starting with '-' or '--')
+# argument in ARGV.
+cmd ||= Cani.api.config.args.first
+
+# refresh all completions after new data has been fetched
+Cani::Completions.install! if Cani.api.updated?
+
+if cmd && Cani.respond_to?(cmd)
+  # if the command is recognized, execute it
+  Cani.send cmd
+else
+  # otherwise, display help message
+  Cani.help
+end

data/lib/cani.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'colorize'
+require 'json'
+require 'yaml'
+
+require 'cani/version'
+require 'cani/api'
+require 'cani/fzf'
+require 'cani/completions'
+
+# Cani
+module Cani
+  def self.api
+    @api ||= Api.new
+  end
+
+  def self.help
+    puts "Cani #{VERSION} <https://github.com/SidOfc/cani>"
+    puts ''
+    puts 'Usage: cani [COMMAND [ARGUMENTS]]'
+    puts ''
+    puts 'Commands:'
+    puts '   use FEATURE             show browser support for FEATURE'
+    puts '   show BROWSER            show information about specific BROWSER'
+    puts '   install_completions     installs completions for bash, zsh and fish'
+    puts '   update                  force update api data and completions'
+    puts '   purge                   remove all completion, configuration and data'
+    puts '                           stored by this cani'
+    puts '   '
+    puts '   help                    show this help'
+    puts '   version                 print the version number'
+    puts ''
+    puts 'Examples:'
+    puts '   cani use'
+    puts '   cani show ie'
+    puts '   cani show chr.and'
+  end
+
+  def self.version
+    puts VERSION
+  end
+
+  def self.install_completions
+    Completions.install!
+  end
+
+  def self.purge
+    Completions.remove!
+    api.remove!
+    api.config.remove!
+  end
+
+  def self.update
+    api.update! && Completions.install! || exit(1) unless api.updated?
+  end
+
+  def self.edit
+    system ENV.fetch('EDITOR', 'vim'), api.config.file
+  end
+
+  def self.use
+    puts Fzf.pick Fzf.feature_rows,
+                  header: 'use]   [' + Api::Feature.support_legend,
+                  colors: %i[green light_black light_white light_black]
+  end
+
+  def self.show(brws = api.config.args[1], version = api.config.args[2])
+    browser = api.find_browser brws
+
+    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]
+
+        show browser.title, nil
+      else
+        if (version = Fzf.pick(Fzf.browser_usage_rows(browser),
+                               header: [:show, browser.title],
+                               colors: %i[white light_black]).first)
+          show browser.title, version
+        else
+          show nil, nil
+        end
+      end
+    else
+      browser = api.find_browser Fzf.pick(Fzf.browser_rows,
+                                          header: [:show],
+                                          colors: %i[white light_black]).first
+
+      show browser.title, nil unless browser.nil?
+    end
+  end
+end

data/lib/cani/api.rb

@@ -0,0 +1,87 @@
+require 'net/http'
+
+require_relative 'api/config'
+require_relative 'api/browser'
+require_relative 'api/feature'
+
+module Cani
+  class Api
+    def initialize
+      @data = load_data
+    end
+
+    def load_data(fetch: false)
+      @upd = false
+      data_file       = File.join config.directory, 'caniuse.json'
+      data_exists     = File.exist? data_file
+      data_up_to_date = data_exists ? (Time.now.to_i - File.mtime(data_file).to_i < config.expire.to_i)
+                                    : false
+
+      if !fetch && data_exists && data_up_to_date
+        # data is available and up to date
+        JSON.parse File.read(data_file)
+      elsif (data = raw)
+        @upd = true
+        # data either doesn't exist or isn't up to date
+        # if we can fetch new data, attempt to update
+        FileUtils.mkdir_p File.dirname(data_file)
+        File.open(data_file, 'w') { |f| f << data }
+        JSON.parse data
+      elsif data_exists
+        # if we are unable fetch new data, fall back
+        # to existing data if it exists
+        JSON.parse File.read(data_file)
+      else
+        # no other option but fail since we have no data
+        # and no way of fetching the data to display
+        puts 'fatal: no data available for display'
+        exit 1
+      end
+    end
+
+    def remove!
+      data_file = File.join config.directory, 'caniuse.json'
+
+      File.unlink data_file if File.exist? data_file
+    end
+
+    def update!
+      @data = load_data fetch: true
+    end
+
+    def updated?
+      @upd
+    end
+
+    def config(**opts)
+      @settings ||= Config.new(**opts)
+    end
+
+    def find_browser(name)
+      name = name.to_s.downcase
+      idx  = browsers.find_index do |bwsr|
+        [bwsr.title, bwsr.name, bwsr.abbr].include? name
+      end
+
+      browsers[idx] if idx
+    end
+
+    def browsers
+      @browsers ||= @data['agents'].map do |(name, info)|
+        Browser.new info.merge(name: name)
+      end
+    end
+
+    def features
+      @features ||= @data['data'].values.map(&Feature.method(:new))
+    end
+
+    def raw
+      begin
+        Net::HTTP.get URI(config.source)
+      rescue
+        nil
+      end
+    end
+  end
+end

data/lib/cani/api/browser.rb

@@ -0,0 +1,50 @@
+module Cani
+  class Api
+    class Browser
+      attr_reader :name, :title, :prefix, :type, :versions, :usage, :abbr, :label
+
+      ABBR_MAP  = { 'ios' => 'saf.ios' }.freeze
+      LABEL_MAP = {
+        'ie'      => 'Internet Explorer',
+        'edge'    => 'Edge',
+        'ff'      => 'Firefox',
+        'chr'     => 'Chrome',
+        'saf'     => 'Safari',
+        'op'      => 'Opera',
+        'saf.ios' => 'IOS Safari',
+        'o.mini'  => 'Opera Mini',
+        'and'     => 'Android Browser',
+        'bb'      => 'BlackBerry Browser',
+        'o.mob'   => 'Opera Mobile',
+        'chr.and' => 'Chrome for Android',
+        'ff.and'  => 'Firefox for Android',
+        'ie.mob'  => 'Internet Explorer Mobile',
+        'uc'      => 'UC Browser for android',
+        'ss'      => 'Samsung Internet',
+        'qq'      => 'QQ Browser',
+        'baidu'   => 'Baidu Browser'
+      }.freeze
+
+      def initialize(attributes = {})
+        abbr = attributes['abbr'].downcase.gsub(/^\.+|\.+$/, '').tr '/', '.'
+
+        @abbr     = ABBR_MAP.fetch abbr, abbr
+        @label    = LABEL_MAP.fetch abbr, abbr
+        @name     = attributes[:name].downcase
+        @title    = attributes['browser'].downcase
+        @prefix   = attributes['prefix'].downcase
+        @type     = attributes['type'].downcase
+        @usage    = attributes['usage_global']
+        @versions = @usage.keys
+      end
+
+      def features_for(version)
+        @features ||= Cani.api.features.each_with_object({}) do |ft, h|
+          type = ft.support_in name, version
+          (h[type] ||= []) << { support: type, title: ft.title,
+                                status: ft.status, percent: ft.percent }
+        end
+      end
+    end
+  end
+end

data/lib/cani/api/config.rb

@@ -0,0 +1,121 @@
+module Cani
+  class Api
+    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      = {
+        # data settings
+        'expire'   => 86_400,
+        'source'   => 'https://raw.githubusercontent.com/Fyrd/caniuse/master/data.json',
+
+        # usage settings
+        'versions' => 1,
+        'browsers' => %w[chrome firefox edge ie safari ios_saf opera android bb]
+      }.freeze
+
+      def initialize(**opts)
+        @settings = DEFAULTS.merge opts
+
+        if File.exist? file
+          if (yml = YAML.load_file(file))
+            @settings.merge! yml
+          end
+        else
+          install!
+        end
+      end
+
+      def file
+        FILE
+      end
+
+      def directory
+        DIRECTORY
+      end
+
+      def comp_dir
+        COMP_DIR
+      end
+
+      def fish_dir
+        FISH_DIR
+      end
+
+      def fish_comp_dir
+        FISH_COMP_DIR
+      end
+
+      def flags
+        @flags ||= ARGV.select { |arg| arg.start_with? '-' }
+      end
+
+      def args
+        @args ||= ARGV.reject { |arg| arg.start_with? '-' }
+      end
+
+      def remove!
+        File.unlink file if File.exist? file
+        FileUtils.rm_rf directory if Dir.exist? directory
+      end
+
+      def install!
+        hrs  = (DEFAULTS['expire'] / 3600.to_f).round 2
+        days = (hrs / 24.to_f).round 2
+        wk   = (days / 7.to_f).round 2
+        mo   = (days / 30.to_f).round 2
+        tstr = if mo >= 1
+                 "#{mo == mo.to_i ? mo.to_i : mo} month#{mo != 1 ? 's' : ''}"
+               elsif wk >= 1
+                 "#{wk == wk.to_i ? wk.to_i : wk} week#{wk != 1 ? 's' : ''}"
+               elsif days >= 1
+                 "#{days == days.to_i ? days.to_i : days} day#{days != 1 ? 's' : ''}"
+               else
+                 "#{hrs == hrs.to_i ? hrs.to_i : hrs} hour#{hrs != 1 ? 's' : ''}"
+               end
+
+        FileUtils.mkdir_p directory
+        File.open file, 'w' do |f|
+          f << "---\n"
+          f << "# this is the default configuration file for the \"Cani\" RubyGem.\n"
+          f << "# it contains some options to control what is shown, when new data\n"
+          f << "# is fetched, where it should be fetched from.\n"
+          f << "# documentation: https://github.com/sidofc/cani\n"
+          f << "# rubygems: https://rubygems.org/gems/cani\n\n"
+          f << "# the \"expire\" key defines the interval at which new data is\n"
+          f << "# fetched from \"source\". It's value is passed in as seconds\n"
+          f << "# default value: #{DEFAULTS['expire']} # => #{tstr}\n"
+          f << "expire: #{expire}\n\n"
+          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 << "# 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 << "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
+
+        Completions.install!
+      end
+
+      def method_missing(mtd, *args, &block)
+        settings.key?(mtd.to_s) ? settings[mtd.to_s] : super
+      end
+
+      def respond_to_missing?(mtd, include_private = false)
+        settings.key? mtd.to_s
+      end
+    end
+  end
+end

data/lib/cani/api/feature.rb

@@ -0,0 +1,54 @@
+module Cani
+  class Api
+    class Feature
+      attr_reader :title, :status, :spec, :stats, :percent
+
+      STATUSES = {
+        'rec'   => 'rc',
+        'unoff' => 'un',
+        'other' => 'ot'
+      }.freeze
+
+      TYPES = {
+        'y' => {symbol: '+', name: :default,     short: :def},
+        'a' => {symbol: '~', name: :partial,     short: :part},
+        'n' => {symbol: '-', name: :unsupported, short: :unsupp},
+        'p' => {symbol: '#', name: :polyfill,    short: :poly},
+        'x' => {symbol: '@', name: :prefix,      short: :prefix},
+        'd' => {symbol: '!', name: :flag,        short: :flag},
+        'u' => {symbol: '?', name: :unknown,     short: :unknown}
+      }.freeze
+
+      def initialize(attributes = {})
+        @title   = attributes['title']
+        @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.to_a.last(Cani.api.config.versions)
+                  .map { |(vv, s)| [vv.downcase, s.to_s[0] || ''] }.to_h
+        end
+      end
+
+      def current_support
+        @current_support ||= Cani.api.config.browsers.map do |browser|
+          bridx = Cani.api.browsers.find_index { |brs| brs.name == browser }
+          brwsr = Cani.api.browsers[bridx] unless bridx.nil?
+          syms  = stats[browser].values.map { |s| TYPES[s][:symbol] || '' }
+                                .join.rjust Cani.api.config.versions
+
+          syms + brwsr.abbr
+        end
+      end
+
+      def support_in(browser, version)
+        TYPES.fetch(stats[browser.to_s][version.to_s], {})
+             .fetch :name, :unknown
+      end
+
+      def self.support_legend
+        TYPES.map { |_, v| "#{v[:short]}(#{v[:symbol]})" }.join ' '
+      end
+    end
+  end
+end

data/lib/cani/completions.rb

@@ -0,0 +1,107 @@
+module Cani
+  module Completions
+    def self.generate_fish
+      gem_root = File.join File.dirname(__FILE__), '../../'
+      tpl      = File.read File.join(gem_root, 'shell/completions/functions.fish')
+      shw      = Cani.api.browsers.reduce String.new do |acc, browser|
+        [acc, "complete -f -c cani -n '__fish_cani_using_command show' -a '#{browser.abbr}' -d '#{browser.label}'",
+         "complete -f -c cani -n '__fish_cani_showing_browser #{browser.abbr}' -a '#{browser.versions.reverse.join(' ')}'"].join("\n")
+      end
+
+      tpl + shw
+    end
+
+    def self.generate_zsh
+      gem_root  = File.join File.dirname(__FILE__), '../../'
+      tpl       = File.read File.join(gem_root, 'shell/completions/functions.zsh')
+      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"
+      end.strip
+
+      tpl.gsub('{{names}}', Cani.api.browsers.map(&:abbr).join(' '))
+         .gsub '{{versions}}', versions
+    end
+
+    def self.generate_bash
+      gem_root  = File.join File.dirname(__FILE__), '../../'
+      tpl       = File.read File.join(gem_root, 'shell/completions/functions.bash')
+      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"
+      end.strip
+
+      tpl.gsub('{{names}}', Cani.api.browsers.map(&:abbr).join(' '))
+         .gsub '{{versions}}', versions
+    end
+
+    def self.install!
+      # create all parent folders
+      FileUtils.mkdir_p Cani.api.config.fish_comp_dir
+      FileUtils.mkdir_p Cani.api.config.comp_dir
+
+      # write each completion file
+      File.open File.join(Cani.api.config.fish_comp_dir, 'cani.fish'), 'w' do |file|
+        file << generate_fish
+      end
+
+      %w[bash zsh].each do |shell|
+        File.open File.join(Cani.api.config.comp_dir, "_cani.#{shell}"), 'w' do |file|
+          file << send("generate_#{shell}")
+        end
+      end
+
+      # append source lines to configurations
+      insert_source_lines!
+    end
+
+    def self.remove!
+      fish_comp = File.join Cani.api.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.api.config.comp_dir, "_cani.#{shell}"
+
+        File.unlink shell_comp if File.exist? shell_comp
+      end
+
+      # remove source lines to configurations
+      delete_source_lines!
+    end
+
+    def self.delete_source_lines!
+      %w[bash zsh].each do |shell|
+        shellrc   = File.join Dir.home, ".#{shell}rc"
+        lines     = File.read(shellrc).split "\n"
+        comp_path = File.join Cani.api.config.comp_dir, "_cani.#{shell}"
+        rm_idx    = lines.find_index { |l| l.match? comp_path }
+
+        lines.delete_at rm_idx unless rm_idx.nil?
+        File.write shellrc, lines.join("\n")
+      end
+    end
+
+    def self.insert_source_lines!
+      %w[bash zsh].each do |shell|
+        shellrc   = File.join Dir.home, ".#{shell}rc"
+        lines     = File.read(shellrc).split "\n"
+        comp_path = File.join Cani.api.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
+
+        File.write shellrc, lines.join("\n")
+      end
+    end
+  end
+end

data/lib/cani/fzf.rb

@@ -0,0 +1,88 @@
+module Cani
+  module Fzf
+    def self.pick(rows, **opts)
+      unless executable?
+        puts 'fatal: command "fzf" not found, is it installed?'
+        exit 1
+      end
+
+      if STDOUT.tty?
+        rows   = tableize_rows(rows, **opts).join "\n"
+        ohdr   = opts.fetch :header, []
+        header = ohdr.is_a?(Array) ? [:cani, *ohdr].map { |v| v.to_s.downcase }.join(':')
+                                   : 'cani:' + ohdr.to_s
+
+        `echo "#{rows}" | fzf --ansi --header="[#{header}]"`.split '   '
+      else
+        # when output of any initial command is being piped
+        # print results and exit this command.
+        puts tableize_rows(rows).join "\n"
+        exit
+      end
+    end
+
+    def self.executable?
+      @exe ||= begin
+        `command -v fzf`
+        $?.success?
+      end
+    end
+
+    def self.feature_rows
+      Cani.api.features.map do |ft|
+        pc = format('%.2f%%', ft.percent).rjust 6
+        tt = format('%-24s', ft.title.size > 24 ? ft.title[0..23].strip + '..'
+                                                : ft.title)
+
+        ["[#{ft.status}]", pc, tt, *ft.current_support]
+      end
+    end
+
+    def self.browser_rows
+      Cani.api.browsers.map do |bwsr|
+        [bwsr.title, 'usage: ' + format('%.4f%%', bwsr.usage.values.sum)]
+      end
+    end
+
+    def self.browser_usage_rows(brwsr)
+      brwsr.usage.map { |(v, u)| [v, 'usage: ' + format('%.4f%%', u)] }.reverse
+    end
+
+    def self.browser_feature_rows(brwsr, version)
+      features_by_support = brwsr.features_for version
+
+      Api::Feature::TYPES.flat_map do |(status, type)|
+        if (features = features_by_support.fetch(type[:name], nil))
+          features.map do |feature|
+            ["[#{feature[:status]}]", "[#{type[:symbol]}]", feature[:title]]
+          end
+        end
+      end.compact
+    end
+
+    def self.tableize_rows(rows, **opts)
+      col_widths = []
+      colors     = opts.fetch :colors, []
+
+      rows.each do |row|
+        row.each.with_index do |column, i|
+          col_width     = column.size
+          col_widths[i] = col_width if col_width > col_widths[i].to_i
+        end
+      end
+
+      rows.map do |row|
+        row.map.with_index do |col, i|
+          result = col.to_s.ljust col_widths[i]
+
+          if STDOUT.tty?
+            result.colorize(colors[i] || colors[-1] || :default)
+                  .gsub '"', '\"'
+          else
+            result
+          end
+        end.join('   ').rstrip
+      end
+    end
+  end
+end

data/lib/cani/version.rb

@@ -0,0 +1,3 @@
+module Cani
+  VERSION = "0.1.0"
+end

data/shell/completions/functions.bash

@@ -0,0 +1,26 @@
+# This is a template file that adds the most basic top level completions.
+# It is used during installation of completions via the CLI.
+# Unlike the functions.fish file, this one cannot be run directly.
+#
+# The invalid syntax will be replaced with valid BASH code
+# during the installation process.
+
+_cani_completions() {
+  case "${COMP_WORDS[1]}" in
+    "show")
+      case "${COMP_WORDS[2]}" in
+        {{versions}}
+        *)
+            COMPREPLY=($(compgen -W "{{names}}" "${COMP_WORDS[COMP_CWORD]}"))
+          ;;
+      esac
+      ;;
+    *)
+      COMPREPLY=($(compgen -W "use show help version" "${COMP_WORDS[COMP_CWORD]}"))
+      ;;
+  esac
+}
+
+complete -F _cani_completions cani
+
+

data/shell/completions/functions.fish

@@ -0,0 +1,39 @@
+# This is a template file that adds the most basic top level completions.
+# It is used during installation of completions via the CLI.
+#
+# Extra completions are added in the installation process.
+# These include completions for browsers and versions.
+
+function __fish_cani_needs_command
+  set -l cmd (commandline -opc)
+  set -q cmd[2]
+  or return 0
+
+  echo $cmd[2..-1]
+  return 1
+end
+
+function __fish_cani_showing_browser
+  set -l cmd (__fish_cani_needs_command | string split ' ')
+
+  test "$cmd[1]" = "show"
+  and contains -- "$cmd[2]" $argv
+  and return 0
+end
+
+function __fish_cani_using_command
+  set -l cmd (__fish_cani_needs_command)
+
+  test -z "$cmd"
+  and return 1
+
+  contains -- $cmd $argv
+  and return 0
+end
+
+complete -f -c cani
+
+complete -f -c cani -n '__fish_cani_needs_command' -a 'use' -d 'Display an overview of features including support'
+complete -f -c cani -n '__fish_cani_needs_command' -a 'show' -d 'Display feature support for a specific browser'
+complete -f -c cani -n '__fish_cani_needs_command' -a 'help' -d 'Show command help'
+complete -f -c cani -n '__fish_cani_needs_command' -a 'version' -d 'Print the version number'

data/shell/completions/functions.zsh

@@ -0,0 +1,26 @@
+# This is a template file that adds the most basic top level completions.
+# It is used during installation of completions via the CLI.
+# Unlike the functions.fish file, this one cannot be run directly.
+#
+# The invalid syntax will be replaced with valid ZSH code
+# during the installation process.
+
+function _cani {
+  local line
+
+  _arguments -C "1: :(use show help version)" \
+                "*::arg:->args"
+
+  case $line[1] in
+    show)
+      _arguments -C "1: :({{names}})" \
+                    "*::arg:->args"
+
+      case $line[1] in
+        {{versions}}
+      esac
+      ;;
+  esac
+}
+
+compdef _cani cani

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: cani
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sidney Liebrand
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'A rework of the ruby script from my medium post: https://medium.com/@sidneyliebrand/combining-caniuse-with-fzf-fb93ad235bae'
+email:
+- sidneyliebrand@gmail.com
+executables:
+- cani
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cani.gemspec
+- exe/cani
+- lib/cani.rb
+- lib/cani/api.rb
+- lib/cani/api/browser.rb
+- lib/cani/api/config.rb
+- lib/cani/api/feature.rb
+- lib/cani/completions.rb
+- lib/cani/fzf.rb
+- lib/cani/version.rb
+- shell/completions/functions.bash
+- shell/completions/functions.fish
+- shell/completions/functions.zsh
+homepage: https://github.com/SidOfc/cani
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A simple caniuse CLI.
+test_files: []