cani 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 251888e57335b837a8f6d6e917375856174c209901e3cad22915fedc73e5ae5d
-  data.tar.gz: 25c6288f4c8ce97a9a7ffed32ffd1de0c9d5b3a17ca64df7ef4781d362f32253
+  metadata.gz: 9de90bea20bfdaed9282223a8f2326c9a57515cba421460382388152613a92d5
+  data.tar.gz: a8dfeba0857de5d4e8a35e3971aa05feb3b1d60aca948d3383357074e449b581
 SHA512:
-  metadata.gz: 53defce406c9855805a7e7cc0e173ce978d1bfbc9ec7c2d5fa604e2fa6f28c8394114a461373f642290cd5b460988dd43de688a33c804db5e1c7f3f1a9931e22
-  data.tar.gz: 822dc5a1ec329b0ecb95be0dfdff821a2d2a1c5ff97362d3a66d37fb74627247df49381914db4889df178823d53abc26df6a515c64f4d30250a5f2c89026f14e
+  metadata.gz: 63e0d0bf53d8e72915b0c5fe5f7997e7f3dd5341b973dc37c3180fe3b4a91c7f35370d43f57ccc717c24ad3d12a42b6a9bbb413de5afb2901ae0ed66b4c4678d
+  data.tar.gz: 514d3cf80000acd736d86f4bc5fdb991ed6d43a986cb6469760be5d92b4e1620ad4331fd34078906e17a3f1d16d17db11c52d2e4d63abba9560cee436b01d19b

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    cani (0.1.1)
+    cani (0.1.2)
       colorize
+      curses
       json
 
 GEM
@@ -10,6 +11,7 @@ GEM
   specs:
     coderay (1.1.2)
     colorize (0.8.1)
+    curses (1.2.4)
     diff-lcs (1.3)
     json (2.1.0)
     method_source (0.9.0)

data/cani.gemspec

@@ -23,10 +23,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'colorize'
+  spec.add_runtime_dependency 'curses'
   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 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/exe/cani

@@ -4,17 +4,4 @@
 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
+Cani.exec! ARGV[0], *ARGV[1..-1]

data/lib/cani/api/browser.rb

@@ -1,7 +1,7 @@
 module Cani
   class Api
     class Browser
-      attr_reader :name, :title, :prefix, :type, :versions, :usage, :abbr, :label
+      attr_reader :name, :title, :prefix, :type, :versions, :usage, :abbr, :label, :eras
 
       ABBR_MAP  = { 'ios' => 'saf.ios' }.freeze
       LABEL_MAP = {
@@ -34,12 +34,30 @@ module Cani
         @title    = attributes['browser'].downcase
         @prefix   = attributes['prefix'].downcase
         @type     = attributes['type'].downcase
-        @usage    = attributes['usage_global']
+        @usage    = attributes['usage_global'].each_with_object({}) do |(v, u), h|
+          v.split('-').each { |ver| h[ver] = u }
+        end
+        @eras = attributes['versions'].each_with_object([]) do |v, a|
+          if v
+            v.split('-').each { |ver| a << ver }
+          else
+            a << v
+          end
+        end
         @versions = @usage.keys
+        @features = {}
+      end
+
+      def most_popular_era_idx
+        eras.find_index usage.sort_by { |_, v| -v }.first.first
+      end
+
+      def max_column_width
+        [name.size, versions.map(&:size).max].max
       end
 
       def features_for(version)
-        @features ||= Cani.api.features.each_with_object({}) do |ft, h|
+        @features[version] ||= 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 }

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

@@ -0,0 +1,293 @@
+module Cani
+  class Api
+    class Feature
+      class Viewer
+        attr_reader :width, :height, :feature, :browsers, :viewable, :col_width, :table_width
+
+        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 => [128, -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)
+
+
+          # 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, 128], # white on magenta    (flag features)
+          11  => [7,  75], # white on blue       (prefix feature)
+          100 => [7,   8], # 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)
+        }.freeze
+
+        COLORS = {
+          # table headers
+          header:      {fg: Curses.color_pair(254), bg: Curses.color_pair(254)},
+
+          # support types
+          default:     {fg: Curses.color_pair(69),  bg: Curses.color_pair(70)},
+          partial:     {fg: Curses.color_pair(213), bg: Curses.color_pair(208)},
+          prefix:      {fg: Curses.color_pair(12),  bg: Curses.color_pair(11)},
+          polyfill:    {fg: Curses.color_pair(204), bg: Curses.color_pair(205)},
+          flag:        {fg: Curses.color_pair(133), bg: Curses.color_pair(134)},
+          unsupported: {fg: Curses.color_pair(195), bg: Curses.color_pair(196)},
+          unknown:     {fg: Curses.color_pair(99),  bg: Curses.color_pair(100)},
+
+          # statuses
+          un:          {fg: Curses.color_pair(213), bg: Curses.color_pair(208)},
+          ot:          {fg: Curses.color_pair(133), bg: Curses.color_pair(134)}
+        }.freeze
+
+        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)},
+          0..40   => {fg: Curses.color_pair(195), bg: Curses.color_pair(196)}
+        }.freeze
+
+        ERAS    = 6  # range of eras to show around current era (incl current)
+        COMPACT = 60 # column width at which to compress the layout
+        PADDING = 1  # horizontal cell padding
+        MARGIN  = 1  # horizontal cell margin
+
+        def initialize(feature, browsers = Cani.api.browsers)
+          @feature  = feature
+          @browsers = browsers
+          @viewable = browsers.size
+
+          resize
+
+          Curses.init_screen
+          Curses.curs_set 0
+          Curses.noecho
+          Curses.cbreak
+
+          if Curses.has_colors?
+            Curses.use_default_colors
+            Curses.start_color
+          end
+
+          COLOR_PAIRS.each do |(cn, clp)|
+            Curses.init_pair cn, *clp
+          end
+
+          trap('INT', &method(:close))
+          at_exit(&method(:close))
+        end
+
+        def close(*args)
+          Curses.close_screen
+        end
+
+        def draw
+          Curses.clear
+
+          percent_num   = format '%.2f%%', feature.percent
+          status_format = "[#{feature.status}]"
+          percent_label = compact? ? '' : 'support: '
+          legend_format = 'legend'.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
+          cy            = 0
+
+          # positioning and drawing of percentage
+          perc_num_xs = table_width - percent_num.size
+          Curses.setpos offset_y + cy, offset_x + perc_num_xs
+          Curses.attron percent_color(feature.percent) do
+            Curses.addstr percent_num
+          end
+
+          # positioning and drawing of 'support: ' text
+          # ditch this part all together when in compact mode
+          unless compact?
+            perc_lbl_xs = perc_num_xs - percent_label.size
+            Curses.setpos offset_y + cy, offset_x + perc_lbl_xs
+            Curses.addstr percent_label
+          end
+
+          # draw possibly multi-line feature title
+          title_chunks.each do |part|
+            Curses.setpos offset_y + cy, offset_x
+            Curses.addstr part
+
+            cy += 1
+          end
+
+          # status positioning and drawing
+          # when compact? draw it on the second line instead of the first line at the end of the title
+          cy       += 1
+          status_yp = offset_y + (compact? ? 1 : 0)
+          status_xp = offset_x + (compact? ? table_width - status_format.size
+                                           : [title_size, feature.title.size].min + 1)
+
+          Curses.setpos status_yp, status_xp
+          Curses.attron status_color(feature.status) do
+            Curses.addstr status_format
+          end
+
+          # meaty part, loop through browsers to create
+          # the final feature table
+          browsers[0...viewable].each.with_index do |browser, x|
+            # some set up to find the current era for each browser
+            # and creating a range around that to show past / coming support
+            era_idx   = browser.most_popular_era_idx
+            era_range = (era_idx - (ERAS / 2.0).floor + 1)..(era_idx + (ERAS / 2.0).ceil)
+            bx        = offset_x + x * col_width + x
+            by        = offset_y + cy
+
+            # draw browser names
+            Curses.setpos by, bx
+            Curses.attron color(:header) do
+              Curses.addstr browser.name.tr('_', '.').center(col_width)
+            end
+
+            # accordingly increment current browser y for the table header (browser names)
+            # and an additional empty line below the table header
+            by += 2
+
+            # 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))
+
+              # only show 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
+
+                # 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
+                  end
+                end
+              end
+            end
+          end
+
+          # increment current y by amount of eras
+          # 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
+
+          # print legend header
+          Curses.setpos offset_y + cy, offset_x
+          Curses.attron color(:header) do
+            Curses.addstr legend_format
+          end
+
+          # increment current y by 2
+          # one for the header line
+          # plus one for a blank line below it
+          cy += 2
+
+          # 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)
+              end
+            end
+
+            # if there is more than one group, print the next
+            # group on a new line
+            cy += 1
+          end
+
+          Curses.refresh
+        end
+
+        def render
+          loop do
+            Curses.clear
+            draw
+
+            key = Curses.getch
+            case key
+            when Curses::KEY_RESIZE then resize
+            else break unless key.nil?
+            end
+          end
+
+          close
+        end
+
+        def colw
+          colw = PADDING * 2 + browsers[0..viewable].map(&:max_column_width).max
+
+          colw.even? ? colw : colw + 1
+        end
+
+        def tablew
+          colw * viewable + viewable - 1
+        end
+
+        def resize
+          @height, @width = IO.console.winsize
+          @viewable       = browsers.size
+
+          while tablew > @width
+            @viewable -= 1
+          end
+
+          @col_width   = [colw, Feature::TYPES.map { |(_, h)| h[:short].size }.max + 3].max
+          @table_width = tablew
+        end
+
+        def compact?
+          width < COMPACT
+        end
+
+        def color(key, type = :bg)
+          target = key.to_s.downcase.to_sym
+          type   = type.to_sym
+
+          COLORS.find { |(k, _)| k == target }.to_a
+                .fetch(1, {})
+                .fetch(type, COLORS[:default][type])
+        end
+
+        def status_color(status)
+          color status, :fg
+        end
+
+        def percent_color(percent)
+          PERCENT_COLORS.find { |(r, _)| r.include? percent }.to_a
+                        .fetch(1, {})
+                        .fetch(:fg, COLORS[:unknown][:fg])
+        end
+      end
+    end
+  end
+end

data/lib/cani/api/feature.rb

@@ -1,7 +1,7 @@
 module Cani
   class Api
     class Feature
-      attr_reader :title, :status, :spec, :stats, :percent
+      attr_reader :title, :status, :spec, :stats, :percent, :name
 
       STATUSES = {
         'rec'   => 'rc',
@@ -10,38 +10,42 @@ module Cani
       }.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}
+        'y' => {symbol: '+', name: :default,     short: :sup},
+        'a' => {symbol: '~', name: :partial,     short: :prt},
+        'n' => {symbol: '-', name: :unsupported, short: :not},
+        'p' => {symbol: '#', name: :polyfill,    short: :ply},
+        'x' => {symbol: '@', name: :prefix,      short: :pfx},
+        'd' => {symbol: '!', name: :flag,        short: :flg},
+        'u' => {symbol: '?', name: :unknown,     short: :unk}
       }.freeze
 
       def initialize(attributes = {})
+        @name    = attributes[:name].to_s.downcase
         @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.map { |(vv, s)| [vv.downcase, s.to_s[0] || ''] }.to_h
+          h[k] = v.each_with_object({}) do |(vv, s), hh|
+            vv.split('-').each { |ver| hh[ver] = s[0] }
+          end
         end
       end
 
       def current_support
-        @current_support ||= Cani.api.config.browsers.map do |browser|
+        @current_support ||= Cani.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  = stats[browser].values.compact.last(Cani.config.versions)
+                                .map { |s| TYPES[s][:symbol] || '' }
+                                .join.rjust Cani.config.versions
 
           syms + brwsr.abbr
         end
       end
 
       def support_in(browser, version)
-        TYPES.fetch(stats[browser.to_s][version.to_s], {})
+        TYPES.fetch(stats[browser.to_s][version.to_s.downcase], {})
              .fetch :name, :unknown
       end
 

data/lib/cani/api.rb

@@ -1,8 +1,8 @@
 require 'net/http'
 
-require_relative 'api/config'
 require_relative 'api/browser'
 require_relative 'api/feature'
+require_relative 'api/feature/viewer'
 
 module Cani
   class Api
@@ -12,9 +12,9 @@ module Cani
 
     def load_data(fetch: false)
       @upd = false
-      data_file       = File.join config.directory, 'caniuse.json'
+      data_file       = File.join Cani.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)
+      data_up_to_date = data_exists ? (Time.now.to_i - File.mtime(data_file).to_i < Cani.config.expire.to_i)
                                     : false
 
       if !fetch && data_exists && data_up_to_date
@@ -40,7 +40,7 @@ module Cani
     end
 
     def remove!
-      data_file = File.join config.directory, 'caniuse.json'
+      data_file = File.join Cani.config.directory, 'caniuse.json'
 
       File.unlink data_file if File.exist? data_file
     end
@@ -53,14 +53,19 @@ module Cani
       @upd
     end
 
-    def config(**opts)
-      @settings ||= Config.new(**opts)
+    def find_feature(name)
+      name = Regexp.new name.to_s.downcase.gsub(/(\W)/, '.*')
+      idx  = features.find_index do |ft|
+        ft.title.downcase.match?(name) || ft.name.downcase.match?(name)
+      end
+
+      features[idx] if idx
     end
 
     def find_browser(name)
       name = name.to_s.downcase
       idx  = browsers.find_index do |bwsr|
-        [bwsr.title, bwsr.name, bwsr.abbr].include? name
+        [bwsr.title, bwsr.name, bwsr.abbr].map(&:downcase).include? name
       end
 
       browsers[idx] if idx
@@ -73,12 +78,12 @@ module Cani
     end
 
     def features
-      @features ||= @data['data'].values.map(&Feature.method(:new))
+      @features ||= @data['data'].map { |(name, info)| Feature.new info.merge(name: name) }
     end
 
     def raw
       begin
-        Net::HTTP.get URI(config.source)
+        Net::HTTP.get URI(Cani.config.source)
       rescue
         nil
       end

data/lib/cani/completions.rb

@@ -3,12 +3,21 @@ module Cani
     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")
+
+      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}'"
+      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}'"
       end
 
-      tpl + shw
+      tpl + shw + "\n" + use
     end
 
     def self.generate_zsh
@@ -22,6 +31,7 @@ module Cani
       end.strip
 
       tpl.gsub('{{names}}', Cani.api.browsers.map(&:abbr).join(' '))
+         .gsub('{{features}}', Cani.api.features.map(&:name).join(' '))
          .gsub '{{versions}}', versions
     end
 
@@ -36,21 +46,22 @@ module Cani
       end.strip
 
       tpl.gsub('{{names}}', Cani.api.browsers.map(&:abbr).join(' '))
+         .gsub('{{features}}', Cani.api.features.map(&:name).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
+      FileUtils.mkdir_p Cani.config.fish_comp_dir
+      FileUtils.mkdir_p Cani.config.comp_dir
 
       # write each completion file
-      File.open File.join(Cani.api.config.fish_comp_dir, 'cani.fish'), 'w' do |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.api.config.comp_dir, "_cani.#{shell}"), 'w' do |file|
+        File.open File.join(Cani.config.comp_dir, "_cani.#{shell}"), 'w' do |file|
           file << send("generate_#{shell}")
         end
       end
@@ -60,12 +71,12 @@ module Cani
     end
 
     def self.remove!
-      fish_comp = File.join Cani.api.config.fish_comp_dir, 'cani.fish'
+      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.api.config.comp_dir, "_cani.#{shell}"
+        shell_comp = File.join Cani.config.comp_dir, "_cani.#{shell}"
 
         File.unlink shell_comp if File.exist? shell_comp
       end
@@ -78,7 +89,7 @@ module Cani
       %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}"
+        comp_path = File.join Cani.config.comp_dir, "_cani.#{shell}"
         rm_idx    = lines.find_index { |l| l.match? comp_path }
 
         lines.delete_at rm_idx unless rm_idx.nil?
@@ -90,7 +101,7 @@ module Cani
       %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}"
+        comp_path = File.join Cani.config.comp_dir, "_cani.#{shell}"
         slidx     = lines.find_index { |l| l.match? comp_path }
 
         if slidx

data/lib/cani/config.rb

@@ -0,0 +1,111 @@
+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      = {
+      # data settings
+      'expire'   => 86_400,
+      'source'   => 'https://raw.githubusercontent.com/Fyrd/caniuse/master/data.json',
+
+      # usage settings
+      'versions' => 1,
+      'browsers' => %w[ie edge chrome firefox 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 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

data/lib/cani/fzf.rb

@@ -29,7 +29,7 @@ module Cani
     end
 
     def self.feature_rows
-      Cani.api.features.map do |ft|
+      @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)

data/lib/cani/version.rb

@@ -1,3 +1,3 @@
 module Cani
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/cani.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
+require 'io/console'
+require 'curses'
 require 'colorize'
 require 'json'
 require 'yaml'
 
-require 'cani/version'
 require 'cani/api'
 require 'cani/fzf'
+require 'cani/config'
+require 'cani/version'
 require 'cani/completions'
 
 # Cani
@@ -15,6 +18,27 @@ module Cani
     @api ||= Api.new
   end
 
+  def self.config
+    @settings ||= Config.new
+  end
+
+
+  def self.exec!(command, *args)
+    command = :help unless command && respond_to?(command)
+    command = command.to_s.downcase.to_sym
+
+    case command
+    when :use
+      use args[0]
+    when :show
+      show args[0], args[1]
+    when :update, :purge, :help, :version, :install_completions
+      send command
+    else
+      help
+    end
+  end
+
   def self.help
     puts "Cani #{VERSION} <https://github.com/SidOfc/cani>"
     puts ''
@@ -57,7 +81,7 @@ module Cani
   def self.purge
     Completions.remove!
     api.remove!
-    api.config.remove!
+    config.remove!
   end
 
   def self.update
@@ -65,16 +89,28 @@ module Cani
   end
 
   def self.edit
-    system ENV.fetch('EDITOR', 'vim'), api.config.file
+    system ENV.fetch('EDITOR', 'vim'), config.file
   end
 
-  def self.use
-    Fzf.pick Fzf.feature_rows,
-             header: 'use]   [' + Api::Feature.support_legend,
-             colors: %i[green light_black light_white light_black]
+  def self.use(feature = nil)
+    if feature && (feature = api.find_feature(feature))
+      Api::Feature::Viewer.new(feature).render
+      use
+    elsif (chosen = Fzf.pick(Fzf.feature_rows,
+                             header: 'use]   [' + Api::Feature.support_legend,
+                             colors: %i[green light_black light_white light_black]))
+
+      # chosen[2] is the index of the title column from Fzf.feature_rows
+      if chosen.any? && (feature = api.find_feature(chosen[2]))
+        Api::Feature::Viewer.new(feature).render
+        use
+      else
+        exit
+      end
+    end
   end
 
-  def self.show(brws = api.config.args[1], version = api.config.args[2])
+  def self.show(brws = nil, version = nil)
     browser = api.find_browser brws
 
     if browser
@@ -83,14 +119,14 @@ module Cani
                  header: "show:#{browser.title.downcase}:#{version}]   [#{Api::Feature.support_legend}",
                  colors: [:green, :light_black, :light_white]
 
-        show browser.title, nil
+        show browser.title
       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
+          show
         end
       end
     else
@@ -98,7 +134,7 @@ module Cani
                                           header: [:show],
                                           colors: %i[white light_black]).first
 
-      show browser.title, nil unless browser.nil?
+      show browser.title unless browser.nil?
     end
   end
 end

data/shell/completions/functions.bash

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

data/shell/completions/functions.zsh

@@ -20,6 +20,9 @@ function _cani {
         {{versions}}
       esac
       ;;
+    use)
+      _arguments -C "1: :({{features}})"
+      ;;
   esac
 }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cani
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Sidney Liebrand
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-17 00:00:00.000000000 Z
+date: 2018-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: curses
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,33 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -118,9 +132,10 @@ files:
 - lib/cani.rb
 - lib/cani/api.rb
 - lib/cani/api/browser.rb
-- lib/cani/api/config.rb
 - lib/cani/api/feature.rb
+- lib/cani/api/feature/viewer.rb
 - lib/cani/completions.rb
+- lib/cani/config.rb
 - lib/cani/fzf.rb
 - lib/cani/version.rb
 - shell/completions/functions.bash

data/lib/cani/api/config.rb

@@ -1,121 +0,0 @@
-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