listpager 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d4f836e524e3a80691d2a2a0212b3e447d683c7
-  data.tar.gz: 4d68a1eee960c026cfbcbaa24b3b9f7378218e26
+  metadata.gz: 1cb09a07756c07b56bc85e800cc44c160c164c0e
+  data.tar.gz: ccfa85c999c3b235699461e3ef78dd9e428c9a16
 SHA512:
-  metadata.gz: c2942ab1c84e13c509b4958b6002604f81c3ee7ee8708eeb3a6e6dce0e0286ff2df89b5a3d60463535d4c7941b0052c4755519452b394d3bf87095c3ef101d29
-  data.tar.gz: 8789bc607ee28fdf54d6018144c18df4583e61fd4c250739f46e7209e25cf638371e5ec7cb1f5ffca89f8b79df0aff660d926da9112fb0a8bea78a6b1b088f3f
+  metadata.gz: 7d83d8ee3ed4476a2e19e1b11a75a5233d8bd215994481a559a455bc055903355b1baa6b9f83d2d8cfe2d82d48a5e21b0e435b016d50cb7e3148da704ba3acc2
+  data.tar.gz: 218bbe3375248ba86926f6a9244e2457acbd93e77c747c2bcf2498ee513a11dbcd686381aa95d006e0eff617dad24876c6096351b04a5d54848d60708123bb65

data/README.md

@@ -28,9 +28,7 @@ listpager.sync = true
   listpager.puts "Item #{i}"
 end
 
-# Enter command mode.
-listpager.puts "%%"
-listpager.puts "select 35"
+listpager.puts "%set-selected 35"
 ```
 
 If you want to play with the protocol, it's easiest to use two terminals and
@@ -48,28 +46,20 @@ And a "client", like:
 socat TCP:localhost:4500 -
 ```
 
-Add some items on your keyboard, then enter `%%` to enter command mode.  Another
-`%%` will put you back in command mode.  If you need a literal `%%` list item,
-escape it with `\%%`.  If you need a literal `\\%%`, you're out of luck, because
-complete escaping isn't available yet.
+Add some items on your keyboard, then enter some commands, prefixed by `%`.  If
+you need an item that starts with a liter `%`, start it with `%%`.
 
 There are a lot of obvious things the protocol could do, that it doesn't
-currently.  It's way low-hanging fruit for any contributors (`clear`, `rename`,
-`move`, etc.)
+currently.  It's way low-hanging fruit for any contributors.
 
 ## Protocol
 listpager reads each item from stdin, and it becomes a list item.  As the user
 arrows through the list, it outputs messages like:
 
-`select 21 apples` where `21` is the index into the list, and `abacate` is the
-caption.  Any other keys pressed on an item are written out like
+`is-selected 21 apples` where `21` is the index into the list, and `apples` is
+the caption.  Any other keys pressed on an item are written out like
 `keypress enter apples`.
 
-listpager stops considering input bulk list items once it sees: `%%`, where it
-enters command mode.  Currently, command mode does nothing, but in the future,
-it will allow the calling program to instruct listpager to select certain items,
-ask for statuses, manipulate the list, add badges, change captions, etc.
-
 
 ## Dependencies and Installation
 Install listpager with `gem install listpager`.  It has few dependencies:
@@ -83,7 +73,7 @@ sudo apt install libncursesw5-dev
 
 ## Implementation Notes
 curses is terrible but portable.  'curses' doesn't expose enough to be useful,
-'ncurses-ruby' is about as good as you'll do in Ruby.
+'ncursesw' is about as good as you'll do in Ruby.
 
 
 ## Upcoming Features
@@ -96,6 +86,7 @@ be more functional, I'd like to add a few features:
   * Mouse support, with scroll wheels.
   * Checkboxes
   * Extend command mode
+  * `Listpager::Client`
 
 
 ## Contributing

data/lib/listpager/client_terminal.rb

@@ -11,11 +11,13 @@ module Listpager
     attr_reader :tty
     attr_reader :self_pipe
     attr_reader :list
-    attr_reader :mode
+
+    attr_reader :locked
 
     def initialize
       @tty = File.open('/dev/tty', 'r+')
       @self_pipe = IO.pipe
+      @locked = false
 
       [@tty, *self_pipe].each do |io|
         io.sync = true
@@ -24,8 +26,35 @@ module Listpager
       initialize_curses
 
       @list = List.new(Ncurses.stdscr)
-      @mode = :append
+      connect_list
+
       @buffer = ''
+      @locked_buffer = []
+    end
+
+    def key_name(v)
+      @m ||= {
+        27  => 'esc',
+        10  => 'enter',
+        260 => 'left',
+        261 => 'right',
+        127 => 'backspace',
+        330 => 'delete',
+        ' ' => 'space',
+      }
+      @m[v] || (v < 255 && v.chr.match(/[[:print:]]/) ? v.chr : "\##{v}")
+    end
+
+    def connect_list
+      cterm = self
+      list.define_singleton_method :on_select_change do
+        cterm.cmd!('is-selected', selected, selected_value, observe_lock: true)
+      end
+
+      list.define_singleton_method :on_key_press do |k|
+        cterm.cmd!('key-pressed', cterm.key_name(k),
+                   selected, selected_value, observe_lock: true)
+      end
     end
 
     def initialize_curses
@@ -50,45 +79,77 @@ module Listpager
       @tty.close
     end
 
-    def append_mode?
-      @mode == :append
+    def line!(line, observe_lock: false)
+      if observe_lock && @locked
+        @locked_buffer.push(line)
+      else
+        $stdout.puts line
+        $stdout.flush
+      end
+    end
+
+    def cmd!(*args, observe_lock: false)
+      line!('%' + Shellwords.join(args.map(&:to_s)),
+            observe_lock: observe_lock)
     end
 
     def process_command(argv)
       cmd, *args = argv
       case cmd
-        when 'append-mode', '%'
-          @mode = :append
-        when 'title'
-          @list.title = args[0]
+        # TODO: This to be refactored into CommandProcessor
+        when 'quit'
+          raise Interrupt
+
         when 'clear'
-          @list.values = []
-          @list.selected = 0
+          list.values = []
+          list.selected = 0
+          list.dirty!
+
+        when 'append'
+          list.values.push(args.fetch(0))
           list.dirty!
+
+        when 'lock'
+          @locked = true
+          cmd! 'lock'
+
+        when 'unlock'
+          @locked = false
+          cmd! 'unlock'
+          @locked_buffer.each do |line|
+            line!(line)
+          end
+          @locked_buffer = []
+
+        when 'get-title'
+          cmd! 'title-is', @list.title
+        when 'set-title'
+          @list.title = args[0]
+          cmd! 'title-is', @list.title
+
         when 'get-selected'
-          list.selection_changed
-        when 'select'
+          cmd! 'selected-is', list.selected, list.selected_value
+        when 'set-selected'
           list.selected = args.fetch(0).to_i
+          cmd! 'seleted-is', list.selected, list.selected_value
+
         when 'get-item'
-          puts ["item", args.fetch(0), list.values[args.fetch(0).to_i]].join ' '
-        when 'quit'
-          raise Interrupt
+          cmd! 'item-is', args.fetch(0), list.values[args.fetch(0).to_i]
+        when 'set-item'
+          cmd! 'item-is'
       end
     end
 
     def process_line(line)
-      if append_mode?
-        if line == '%%'
-          @mode = :command
-        elsif line[0] == '%'
-          cmd = Shellwords.split(line[1..-1])
-          process_command(cmd)
-        else
-          list.values.push(line)
-          list.dirty!
-        end
+      if line[0] == '%' && line[1] != '%'
+        cmd = Shellwords.split(line[1..-1])
+        process_command(cmd)
       else
-        process_command(Shellwords.split(line))
+        if line[0] == '%'
+          line = line[1..-1]
+        end
+        list.values.push(line)
+        list.dirty!
       end
     end
 

data/lib/listpager/list.rb

@@ -14,11 +14,9 @@ module Listpager
     BLANK_SPACE  = ' '
 
     def on_select_change
-      puts "select #{selected} #{values[selected]}"
     end
 
     def on_key_press(k)
-      puts "keypress #{key_name(k)} #{selected} #{values[selected]}"
     end
 
     attr_reader :window
@@ -72,25 +70,18 @@ module Listpager
 
       if v != @selected
         dirty!
+        @selected = v
         on_select_change
       end
 
-      return (@selected = v)
+      return @selected
     end
 
-    def key_name(v)
-      @m ||= {
-        27  => 'esc',
-        10  => 'enter',
-        260 => 'left',
-        261 => 'right',
-        127 => 'backspace',
-        330 => 'delete',
-        ' ' => 'space',
-      }
-      @m[v] || (v < 255 && v.chr.match(/[[:print:]]/) ? v.chr : "\##{v}")
+    def selected_value
+      values[selected]
     end
 
+
     def key_input(value)
       maxx, maxy = getmaxxy
 

data/lib/listpager/version.rb

@@ -1,3 +1,3 @@
 module Listpager
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: listpager
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Mike Owens