kv 0.2.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07f9b8b9be509c1a29acef17374146c9381713514e19c91a8a2942f9c2ba09e9
-  data.tar.gz: fb877ac8dbf8b5fac3f9b2c4e6690aa01fc25bca3b11fcf7abf88c52ef41fa23
+  metadata.gz: 573415b451a9344ac21da113782892338606925a3dd04c57d3e82805a5e55de2
+  data.tar.gz: 7d29a38d796aacb6d769a31c52313fc6e510ff68de5e51615e9ce7357e2f3b1a
 SHA512:
-  metadata.gz: c8c646ba69a9a977ea232dedaaff65db9f781d054e76d846913763821678c93c5362e7f4e153574d252505181da0a73a01b7865c38ac2c380c4bc9abaadcd6bc
-  data.tar.gz: eb9f37454be0ce707fbc02f6caae238541fe1865460e67de6c730a2eb81e2ba90d2fbaefa97f418426f19a8343e651b843f9943c61cd5e49cb2d22d15e5cde32
+  metadata.gz: bf24a502a46eead71095315a4d1e7c76872e849c04360e2d740e6521704ce56b75126fa45f7bfceb1b983845f4e0d9bf189fbde870e001a3a580b6b076116139
+  data.tar.gz: 720ac127b0e1960712493473d12254ec39b28c84f80cc0b7a99631728038da9e31a85f1970274badc89b36943632b938b3b557ac0633dd815e477259d248cdcf

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: [ko1]

data/README.md

@@ -1,6 +1,6 @@
-# kv: A page viewer written by Ruby
+# kv: A page viewer written in Ruby
 
-kv is a page viewer designed for streaming data written by Ruby.
+kv is a page viewer designed for streaming data written in Ruby.
 
 ## Installation
 
@@ -8,9 +8,7 @@ Install it yourself as:
 
     $ gem install kv
 
-# Usage
-
-kv requires Ruby and curses gem.
+kv requires recent Ruby and curses gem.
 
 ## Use kv
 
@@ -18,17 +16,27 @@ kv requires Ruby and curses gem.
 # View [FILE]
 $ kv [OPTIONS] [FILE]
 
+# View [URI] source code
+$ kv [URI]
+
 # View results of [CMD]
 $ [CMD] | kv [OPTIONS]
 
 # View command help
 $ kv
 
-Options:
+Usage: kv [options]
     -f                               following mode like "tail -f"
     -n, --line-number LINE           goto LINE
+    -N                               Show lines
+    -T, --time-stamp                 Enable time stamp
+    -e CMD                           Run CMD as a child process
+    -p, --pipe                       Open named pipe
+    -s                               Separation mode (tsv)
 ```
 
+Note that `--pipe` option creates a named pipe (`~/.kv_pipe` or a specified file) if there is not a fifo file.
+
 ## Command on a pager
 
 ```
@@ -72,12 +80,21 @@ kv: A pager by Ruby Command list
 
   # Output
   s: Save screen buffer to file
+  P: gist -p
+
+  # Child process
+  You can run child process using -e command line option like -e CMD
+  and you can send a meesage to the child process with x command.
+
+  x: send a message to the child process
 
   # Modes
   N: toggle line mode
+  T: toggle time stamp mode
   m: toggle mouse mode
   t: terminal (REPL) mode
   v: vi ("vi filename +[LINE]")
+  H: show HTTP response header
 ```
 
 `G` is notable feature, `less` doesn't have. This feature jumps to "current" last line even if the pipe source command does not close output (== input for kv). You can refresh the last line by putting any command.

data/lib/kv.rb

@@ -4,22 +4,24 @@ require "kv/version"
 require "curses"
 require 'stringio'
 require 'optparse'
+require 'open-uri'
 
 module KV
-class KV_PushScreen < Exception
+class PushScreen < Exception
   attr_reader :screen
   def initialize screen
     @screen = screen
   end
 end
 
-class KV_PopScreen < Exception
+class PopScreen < Exception
 end
 
-class KV_Screen
+class Screen
   RenderStatus = Struct.new(
-    :c_cols, :c_lines, :x, :y,
-    :search, :goto, :line_mode, :render_full, :last_lineno
+    :c_cols, :c_lines, :x, :y, :last_lineno,
+    :search, :goto, :wrapping,
+    :line_mode, :ts_mode, :separation_mode,
   )
   class RenderStatus
     def to_s
@@ -27,7 +29,10 @@ class KV_Screen
     end
   end
 
-  def initialize input, lines: [], search: nil, name: nil, following_mode: false, first_line: 0, line_mode: false
+  def initialize input, lines: [],
+                 name: nil, search: nil, first_line: 0,
+                 following_mode: false, line_mode: false, separation_mode: false,
+                 time_stamp: nil, ext_input: nil, fifo_file: nil
     @rs = RenderStatus.new
     @last_rs = nil
     @rs.y = first_line
@@ -36,14 +41,22 @@ class KV_Screen
     @rs.last_lineno = 0
     @rs.line_mode = line_mode
     @rs.search = search
+    @rs.wrapping = false
+    @rs.ts_mode = false
+    @rs.separation_mode = separation_mode
 
     @name = name
     @filename = @name if @name && File.exist?(@name)
 
+    @time_stamp = time_stamp
+    @ext_input = ext_input
+    @fifo_file = fifo_file
+
     @lines = lines
     @mode = :screen
 
-    @following_mode = following_mode
+    @following = following_mode
+    @apos = 0
 
     @mouse = false
     @search_ignore_case = false
@@ -51,25 +64,35 @@ class KV_Screen
     @loading = false
     @buffer_lines = 10_000
     @yq = Queue.new
-    @load_unlimited = false
+    if @filename
+      @load_unlimited = true
+    else
+      @load_unlimited = false
+    end
+
     @prev_render = {}
+    @meta = input.respond_to?(:meta) ? input.meta : nil
 
     read_async input if input
   end
 
   def setup_line line
     line = line.chomp
+    line.instance_variable_set(:@time_stamp, Time.now.strftime('%H:%M:%S')) if @time_stamp
     line.instance_variable_set(:@lineno, @rs.last_lineno += 1)
     line
   end
 
   def read_async input
     @loading = true
-    data = input.read_nonblock(4096)
+    begin
+      data = input.read_nonblock(800_000)
+    rescue IO::EAGAINWaitReadable, EOFError
+      data = ''
+    end
 
-    lines = data.each_line.to_a
     last_line = nil
-    lines.each{|line|
+    data.each_line{|line|
       if line[-1] != "\n"
         last_line = line
         break
@@ -86,6 +109,7 @@ class KV_Screen
         end
 
         @lines << setup_line(line)
+
         while !@load_unlimited && @lines.size > self.y + @buffer_lines
           @yq.pop; @yq.clear
         end
@@ -95,6 +119,10 @@ class KV_Screen
       if @filename
         @file_mtime = File.mtime(@filename)
         @file_lastpos = input.tell
+      elsif @fifo_file
+        input = open(@fifo_file)
+        log(input)
+        redo
       end
       input.close
       @loading = false
@@ -102,7 +130,8 @@ class KV_Screen
   end
 
   def y_max
-    @lines.size - Curses.lines + 2
+    max = @lines.size - Curses.lines + 2
+    max < 0 ? 0 : max
   end
 
   def y
@@ -131,6 +160,11 @@ class KV_Screen
     @rs.x
   end
 
+  def set_load_unlimited b
+    @load_unlimited = b
+    @yq << true
+  end
+
   def init_screen
     Curses.init_screen
     Curses.stdscr.keypad(true)
@@ -141,6 +175,11 @@ class KV_Screen
     else
       Curses.mousemask(0)
     end
+
+    if @loading && self.y_max < @rs.y
+      log [:going, self.y_max, @rs.y]
+      @following = :going
+    end
     self.y = @rs.y
   end
 
@@ -169,24 +208,12 @@ class KV_Screen
     end
   end
 
-  def screen_status status, post = nil
-    Curses.setpos Curses.lines-1, 0
-    Curses.addstr ' '.ljust(Curses.cols)
-
-    standout{
-      Curses.setpos Curses.lines-1, 0
-      Curses.addstr status
-    }
-    Curses.addstr post if post
-    Curses.standend
-  end
-
   LINE_ATTR = Curses::A_DIM
 
   def render_data
     # check update
-    c_lines = Curses.lines
-    c_cols  = Curses.cols
+    c_lines = @rs.c_lines = Curses.lines
+    c_cols = @rs.c_cols  = Curses.cols
 
     if @rs != @last_rs
       @last_rs = @rs.dup
@@ -196,6 +223,15 @@ class KV_Screen
 
     Curses.clear
 
+    if @rs.separation_mode && (lines = @lines[self.y ... (self.y + c_lines - 1)])
+      max_cols = []
+      lines.each.with_index{|line, ln|
+        line.split("\t").each_with_index{|w, i|
+          max_cols[i] = max_cols[i] ? [max_cols[i], w.size].max : w.size
+        }
+      }
+    end
+
     (c_lines-1).times{|i|
       lno = i + self.y
       line = @lines[lno]
@@ -229,8 +265,26 @@ class KV_Screen
         end
       end
 
+      if @rs.ts_mode && ts = line.instance_variable_get(:@time_stamp)
+        cattr LINE_ATTR do
+          ts = line.instance_variable_get(:@time_stamp)
+          Curses.addstr("#{ts} |")
+        end
+      end
+
       line = line[self.x, cols] || ''
 
+      if @rs.separation_mode
+        line = line.split(/\t/).tap{|e|
+          if (max = max_cols.size) > 0
+            # fill empty columns
+            e[max - 1] ||= nil
+          end
+        }.map.with_index{|w, i|
+          "%-#{max_cols[i]}s" % w
+        }.join(' | ')
+      end
+
       if !@rs.search || !(Regexp === @rs.search)
         Curses.addstr line
       else
@@ -263,11 +317,49 @@ class KV_Screen
     name = @name ? "<#{@name}>" : ''
     mouse  = @mouse ? ' [MOUSE]' : ''
     search = @rs.search ? " search[#{search_str}]" : ''
-    loading = @loading ? " (loading...#{@load_unlimited ? '!' : nil}#{@following_mode ? ' following' : ''}) " : ''
+    loading = @loading ? " (loading...#{@load_unlimited ? '!' : nil}#{@following ? ' following' : ''}) " : ''
     x = self.x > 0 ? " x:#{self.x}" : ''
     screen_status "#{name} lines:#{self.y+1}/#{@lines.size}#{x}#{loading}#{search}#{mouse}"
   end
 
+  ANIMATION = ['[O     ]',
+               '[o.    ]',
+               '[...   ]',
+               '[ ...  ]',
+               '[  ... ]',
+               '[   ...]',
+               '[    .o]',
+               '[     O]',
+               '[    .o]',
+               '[   ...]',
+               '[  ... ]',
+               '[  ... ]',
+               '[ ...  ]',
+               '[...   ]',
+               '[o.    ]',
+               ]
+
+  def screen_status status, post = nil
+    cols = Curses.cols
+    line = Curses.lines-1
+    Curses.setpos line, 0
+    Curses.addstr ' '.ljust(cols)
+    len  = status.size
+    len += post.size if post
+
+    standout{
+      Curses.setpos Curses.lines-1, 0
+      Curses.addstr status
+    }
+    Curses.addstr post if post
+
+    if !post && len < cols - ANIMATION.first.size
+      Curses.setpos line, cols - ANIMATION.first.size - 1
+      @apos = (@apos + 1) % ANIMATION.size
+      Curses.addstr ANIMATION[@apos]
+    end
+  end
+
   def check_update
     if @loading == false
       if @filename && File.exist?(@filename) && File.mtime(@filename) > @file_mtime
@@ -288,7 +380,7 @@ class KV_Screen
   def render_screen
     ev = nil
 
-    ms = @following_mode ? 100 : 500
+    ms = @following ? 100 : 500
 
     ctimeout ms do
       while ev == nil
@@ -296,39 +388,62 @@ class KV_Screen
         render_status
         ev = Curses.getch
         check_update
-        if @following_mode
-          if @rs.search && search_next_move(self.y + 1)
-            break
+        y_max = self.y_max
+
+        if @following
+          case @following
+          when :searching
+            break if search_next_move
+          when :going
+            if @rs.goto <= y_max
+              self.y = @rs.goto
+              break
+            end
+          when true
+            # ok
+          else
+            raise "unknown following mode: #{@following}"
           end
-          self.y = self.y_max
+
+          self.y = y_max
         end
       end
 
-      if @following_mode
-        @following_mode = false
-        @load_unlimited = false
-      end
+      @following = false
+      set_load_unlimited false
 
       return ev
     end
   end
 
-  def search_next_move start
-    (start...@lines.size).each{|i|
+  def search_next_move
+    last_line = @lines.size
+    # log (@searching..last_line)
+
+    (@searching...last_line).each{|i|
       if @rs.search === @lines[i]
         self.y = i
+        @searching = false
         return true
       end
     }
+    @searching = last_line
     return false
   end
 
   def search_next start
-    if search_next_move start
-      # OK
+    @searching = start
+    if search_next_move
+      # OK. self.y is updated.
     else
-      screen_status "not found: [#{self.search_str}]"
-      pause
+      if @loading
+        set_load_unlimited true
+        @following = :searching
+      else
+        screen_status "not found: [#{self.search_str}]"
+        pause
+        @searching = false
+      end
     end
   end
 
@@ -350,26 +465,32 @@ class KV_Screen
     ev
   end
 
-  def input_str pattern, str = ''.dup, other_actions: nil
-    loop{
-      ev = Curses.getch
+  def input_str pattern, str = ''.dup, other_actions: {}
+    update_action = other_actions[:update]
 
-      case ev
-      when 10
-        return str
-      when Curses::KEY_BACKSPACE
-        str.chop!
-      when pattern
-        str << ev
-      else
-        if other_actions && (action = other_actions[ev])
-          action.call(ev)
+    ctimeout update_action ? 200 : -1 do
+      loop do
+        ev = Curses.getch
+
+        case ev
+        when 10
+          return str
+        when Curses::KEY_BACKSPACE
+          str.chop!
+        when pattern
+          str << ev
+        when nil # timeout
+          update_action[str]
         else
-          log "failure: #{key_name ev}"
-          return nil
+          if action = other_actions[ev]
+            action.call(ev)
+          else
+            log "failure: #{key_name ev}"
+            return nil
+          end
         end
       end
-    }
+    end
   end
 
   def pause
@@ -382,7 +503,7 @@ class KV_Screen
 
     case ev
     when 'q'
-      raise KV_PopScreen
+      raise PopScreen
 
     when Curses::KEY_UP, 'k'
       self.y -= 1
@@ -412,13 +533,11 @@ class KV_Screen
       end
 
     when 'F'
-      @following_mode = true
-      @load_unlimited = true
-      @yq << true
+      @following = true
+      set_load_unlimited true
 
     when 'L'
-      @load_unlimited = !@load_unlimited
-      @yq << true
+      set_load_unlimited !@load_unlimited
 
     when '/'
       search_str = ''.dup
@@ -470,8 +589,8 @@ class KV_Screen
         filter_mode_title = "*filter mode [#{self.search_str}]*"
         if @name != filter_mode_title
           lines = @lines.grep(@rs.search)
-          fscr = KV_Screen.new nil, lines: lines, search: @rs.search, name: filter_mode_title
-          raise KV_PushScreen.new(fscr)
+          fscr = Screen.new nil, lines: lines, search: @rs.search, name: filter_mode_title
+          raise PushScreen.new(fscr)
         end
       end
 
@@ -498,10 +617,34 @@ class KV_Screen
 
     when 'v'
       if @filename
-        system("vi #{@filename} +#{self.y + 1}")
+        syste m("vi #{@filename} +#{self.y + 1}")
         @last_rs = nil
       end
 
+    when 'P'
+      begin
+        if v = `gist -v` and /^gist v\d/ =~ v
+          screen_status "gist-ing..."
+
+          url = IO.popen('gist -p', 'a+'){|rw|
+            @lines.each{|line| rw.puts line}
+            rw.close_write
+            rw.read
+          }
+          msg = "gist URL: #{url}"
+          at_exit{
+            puts msg
+          }
+          screen_status msg
+          pause
+        else
+          raise v.inspect
+        end
+      rescue Errno::ENOENT
+        screen_status 'gist command is not found'
+        pause
+      end
+
     when 'm'
       @mouse = !@mouse
       Curses.close_screen
@@ -514,16 +657,52 @@ class KV_Screen
 
     when 'N'
       @rs.line_mode = !@rs.line_mode
+    when 'T'
+      @rs.ts_mode = !@rs.ts_mode if @time_stamp
+    when 'S'
+      @rs.separation_mode = !@rs.separation_mode
     when 't'
       Curses.close_screen
       @mode = :terminal
+    when 'x'
+      while @ext_input && !@ext_input.closed?
+        update_ext_status = -> str do
+          screen_status "input for ext:", str
+        end
+        update_ext_status['']
+        actions = {
+          update: -> str do
+            self.y = self.y_max
+            render_data
+            update_ext_status[str]
+          end
+        }
+        str = input_str(/./, other_actions: actions)
+        if str && !str.empty?
+          @ext_input.puts str unless @ext_input.closed?
+        else
+          break
+        end
+      end
+
+    when 'H'
+      if @meta
+        lines = @meta.map{|k, v| "#{k}: #{v}"}
+        raise PushScreen.new(Screen.new nil, lines: lines, name: "Response header [#{@name}]")
+      end
+
+    when Curses::KEY_CTRL_G
+      # do nothing
 
     when '?'
-      raise KV_PushScreen.new(KV_Screen.new help_io)
+      raise PushScreen.new(Screen.new help_io)
 
     when nil
       # ignore
 
+    when Curses::KEY_RESIZE
+      # ignore
+
     else
       screen_status "unknown: #{key_name(ev)}"
       pause
@@ -548,6 +727,10 @@ class KV_Screen
       raise
     end
   end
+
+  def redraw!
+    @last_rs = nil
+  end
 end
 
 class KV
@@ -559,11 +742,39 @@ class KV
     }
 
     files = parse_option(argv)
+    name = files.shift
 
     @pipe_in = nil
 
-    if files.empty?
-      if STDIN.isatty
+    if @opts[:pipe] || (name && File.pipe?(name))
+      @opts.delete(:pipe)
+      @opts[:fifo_file] = name || '/tmp/kv_pipe'
+
+      if name && File.pipe?(name)
+        # ok
+      else
+        begin
+          name ||= File.expand_path('~/.kv_pipe')
+          unlink_name = name
+          File.mkfifo(name)
+          at_exit{ puts "$ rm #{unlink_name}"; File.unlink(unlink_name) }
+        rescue Errno::EEXIST
+          raise "#{name} already exists."
+        end
+      end
+
+      puts "waiting for #{name}"
+      input = @pipe_in = open(name)
+      name = nil
+    elsif !name
+      case
+      when @opts[:e]
+        cmd = @opts.delete(:e)
+        input = IO.popen(cmd, 'a+')
+        name = nil
+        @pipe_in = input
+        @opts[:ext_input] = input
+      when STDIN.isatty
         input = help_io
         name = 'HELP'
       else
@@ -573,16 +784,20 @@ class KV
         @pipe_in = input
       end
     else
-      name = files.shift
       begin
         input = open(name)
-      rescue
-        if /(.+):(\d+)/ =~ name
+      rescue Errno::ENOENT
+        case name
+        when /(.+):(\d+)/
           name = $1
-          @first_line = $2.to_i - 1
+          @opts[:first_line] = $2.to_i - 1
           retry
+        when URI.regexp
+          input = URI.open(name)
+        else
+          STDERR.puts "#{name}: No such file or directory"
+          exit 1
         end
-        raise
       end
     end
 
@@ -590,7 +805,7 @@ class KV
       log "SIGINT"
     }
 
-    @screens = [KV_Screen.new(input, name: name, **@opts)]
+    @screens = [Screen.new(input, name: name, **@opts)]
   end
 
   def parse_option argv
@@ -604,6 +819,18 @@ class KV
     opts.on('-N', 'Show lines'){
       @opts[:line_mode] = true
     }
+    opts.on('-T', '--time-stamp', 'Enable time stamp'){
+      @opts[:time_stamp] = true
+    }
+    opts.on('-e CMD', 'Run CMD as a child process'){|cmd|
+      @opts[:e] = cmd
+    }
+    opts.on('-p', '--pipe', 'Open named pipe'){
+      @opts[:pipe] = true
+    }
+    opts.on('-s', 'Separation mode (tsv)'){
+      @opts[:separation_mode] = true
+    }
     opts.parse!(argv)
   end
 
@@ -612,10 +839,12 @@ class KV
     until @screens.empty?
       begin
         @screens.last.control
-      rescue KV_PopScreen
+      rescue PopScreen
         @screens.pop
-      rescue KV_PushScreen => e
+        @screens.last.redraw!
+      rescue PushScreen => e
         @screens.push e.screen
+        @screens.last.redraw!
       end
     end
   ensure

data/lib/kv/version.rb

@@ -1,3 +1,3 @@
-module KV
-  VERSION = "0.2.0"
-end
+module KV
+  VERSION = "0.7.0"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kv
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Koichi Sasada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-08 00:00:00.000000000 Z
+date: 2020-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curses
@@ -32,6 +32,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".gitignore"
 - LICENSE
 - README.md
@@ -61,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.pre1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: 'kv: A page viewer written by Ruby'