dev-pty-screen 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8413b6443bdf23c7d815c537cd2cc7f406bff86a
-  data.tar.gz: 59ae1732cd1bc370eb32ac029fc0f82c8702a24b
+  metadata.gz: 07d88e540bdcbc42e947294026fb92a8de5f7c4a
+  data.tar.gz: ce402f29c2ce458cde567512c843401a36522e7f
 SHA512:
-  metadata.gz: bbabc50f961876b31fd38b15d00f2031495e38abc6728c05f66cae10c0a0d8874b0bc59aceac25e2d44eb12125bd35c2b581f5e90a59c9cbf03fdcc0f1863e5d
-  data.tar.gz: 41d24a6784db21dbb14f6854a823cc7f6e49ec7fd3fb257fb492145a0ebc65ded1eeeda68943e9132a6b84f85d42e4cf64491a088dac4b53ac284cb9be276e4a
+  metadata.gz: 88f51147a68273b19fe389aeb1dfe5e112b34f6b9394b5ff84eaf70cd0dd19b8337694e7cc05ca5c04495e3ec2b9781f4c7d803c6390234cf857d1e934365075
+  data.tar.gz: b821d4d0d5ad9f2b76d3bf62dc66aba3efd341f8f9936cdfae4c388969cd860c24a60217a5d975f49d9f29bb93292790db58c11bb5e0dcccd8445d30177937b9

data/README.markdown

@@ -1,5 +1,5 @@
 # /dev/pty/screen
-> VIM pair programming without raster graphics.
+> Terminal pair programming without raster graphics.
 
 > Desktop sharing is for windows devs!
 
@@ -11,10 +11,10 @@
 > Yo dawg, anyone want to pair with me on my pair programming program?
 
 ## What's It Do:
-  - Only the server runs VIM (or even needs it installed for that matter).
+  - Only the server runs the application (or even needs it installed for that matter).
+  - VIM will be used for example purposes in the rest of this document, but any program can be used
   - Everyone who wishes to be part of the paring session connects to the server.
   - This is a very similar technique to what GNU Screen or TMux do.
-  - [Here's an animated demo](http://dapplebeforedawn.github.io/dev-pty-vim/)
 
 ## How's It Work:
   - The server's VIM is loaded into a pseudoterminal that is controlled by the server
@@ -22,6 +22,7 @@
   - The server then passes those on to the captive VIM
   - STDOUT from the pseudoterminal is forwarded to the server and the broadcast to cleints
   - Clients have their display updated to match the forwareded STDOUT
+  - `ctrl-z` allows clients to disconnect.
 
 ## TL;DR - An Animated Gif
 ![dev-pyt-screen](https://raw.github.com/dapplebeforedawn/dev-pty-screen/master/dev-pty-screen.gif)
@@ -51,19 +52,32 @@ or:
   - On the computer hosting the code to work on.
   ```bash
     cd /a/directory/with/some/code
-    dev-pty-server
+    dev-pty-server "vim"
   ```
 
   - On each client
   ```bash
-    dev-pty-server
-
-    #program will appear to hang
-    :tabnew <cr>
+    dev-pty-client
   ```
 
   - Quitting: ^Z (ctrl+z) prompts your client to quit.  All other keys are forwarded to the server.
 
+## Another Example:
+  - Any terminal program can be used (say, the Guard your probably running with your vim)
+  ```bash
+    dev-pty-server "tail -f log/development.log"
+  ```
+
+  - On the client, for a quick log sharing session:
+  ```bash
+    dev-pty-client
+  ```
+
+  - With non-interactive programs, like tail, the clients screen will refresh when the server has new data.
+
+## Defaults:
+Since the terminal output from the server is shared with the clients directly, the number of rows/columns on the screen is set by the server.  When starting dev-pty-server, rows/columns are defaulted to the size of the terminal window housing the server.  This can be changed by using the `--rows` and `--columns` options.
+
 ## Considerations:
   This approach has a few draw-backs compared to the run-your-own-VIM tact that /dev/pty/vim uses (and a few advantages)
 
@@ -87,19 +101,19 @@ or:
 ## Application Structure
   ```
   ├── bin
-  │   ├── dev-pty-client        # Run this to start a client
-  │   └── dev-pty-server        # Run this to start a server
+  │   ├── dev-pty-client                # Run this to start a client
+  │   └── dev-pty-server                # Run this to start a server
   ├── lib
   │   ├── client
   │   │   ├── app.rb
-  │   │   └── options.rb        # Options parser for the client
+  │   │   └── options.rb                # Options parser for the client
   │   └── server
   │       ├── app.rb
-  │       ├── key_server.rb     # Listens for keys strokes from clients
-  │       ├── options.rb        # Options parser for the server
-  │       ├── pty_server.rb     # Manages the screen/key servers and the vim_interface
-  │       ├── screen_server.rb  # Pushes STDOUT updates to clients
-  │       └── vim_interface.rb  # Sends keystrokes to the captive VIM
+  │       ├── key_server.rb             # Listens for keys strokes from clients
+  │       ├── options.rb                # Options parser for the server
+  │       ├── pty_server.rb             # Manages the screen/key servers and the application_interface
+  │       ├── screen_server.rb          # Pushes STDOUT updates to clients
+  │       └── application_interface.rb  # Sends keystrokes to the captive VIM
   |
   ├── spec
       ├── client

data/bin/dev-pty-client

@@ -12,7 +12,6 @@ class DevPtyClient
   CLEAR    = "\e[H\e[2J"
   SUSPEND  = ?\C-z
 
-
   def initialize
     startup_message
 
@@ -25,11 +24,23 @@ class DevPtyClient
 
   def screen_loop
     -> do
-      loop { STDOUT.write @screen_sock.readpartial( READSIZE ) }
+      loop { STDOUT.write read_screen }
     end
   end
   private :screen_loop
 
+  def read_screen
+    return @screen_sock.readpartial( READSIZE )
+    rescue EOFError; disconnected
+  end
+  private :read_screen
+
+  def disconnected
+    clear_screen
+    abort("The dev-pty-server has closed the session.")
+  end
+  private :disconnected
+
   def key_loop
     -> do
       loop {
@@ -60,7 +71,7 @@ class DevPtyClient
   private :will_exit
 
   def wont_exit
-    print "Run any vim command to re-draw the screen."
+    print "Run any command to re-draw the screen."
     return true
   end
   private :wont_exit
@@ -83,5 +94,4 @@ class DevPtyClient
   private :startup_message
 end
 
-at_exit { `reset` }
 DevPtyClient.new and sleep

data/bin/dev-pty-server

@@ -3,5 +3,5 @@
 require_relative '../lib/server/pty_server'
 Thread.abort_on_exception = true
 
-PtyServer.new.start
-sleep
+pid = PtyServer.new.start
+Process.wait(pid)

data/dev-pty-screen.gemspec

@@ -5,7 +5,6 @@ require 'version'
 
 Gem::Specification.new do |s|
   s.name          = 'dev-pty-screen'
-  s.version       = '0.0.1'
   s.version       = DevPtyScreen::VERSION
   s.date          = '2013-10-13'
   s.summary       = 'VIM screen sharing as the neckbeards intended'

data/doc/welcome.txt

@@ -4,9 +4,11 @@
                Welcome to dev/pty/screen!
                --------------------------
 
-               Type any vim command to
+             Type any application command to
                   refresh the screen.
 
+                    [ctrl+z quits]
+
 
  Support:
    https://github.com/dapplebeforedawn/dev-pty-screen

data/lib/server/{vim_interface.rb → application_interface.rb}

@@ -1,6 +1,6 @@
 require 'thread'
 
-class VimInterface
+class ApplicationInterface
   def initialize pty_m
     @pty_m = pty_m
     @queue = Queue.new

data/lib/server/options.rb

@@ -2,16 +2,30 @@ require 'optparse'
 module Options
   def self.parse!
     # default_key_file = File.join(__dir__, '../', 'tmp/keys')
-    options = OpenStruct.new  key_port: 2000, screen_port: 2001,
-                                  rows: 35,       columns: 100
+    default_rows = `tput lines`.to_i
+    default_cols = `tput cols`.to_i
+    options = OpenStruct.new  key_port: 2000,     screen_port: 2001,
+                                  rows: default_rows, columns: default_cols
 
     OptionParser.new do |opts|
+      opts.banner =<<HEREDOC
+dev/pty/server: Quickly share any terminal application with remote users
+Usage:    dev-pty-server <application name and arguments> [opts]
+Example:  dev-pty-server "vim"
+
+Defaults:
+  #{options.to_h.map{|k,v| "#{k} = #{v}"}.join("\n  ")}
+
+Options:
+HEREDOC
+
       opts.on("-k", "--key_port=val",     Integer) { |arg| options.key_port    = arg }
       opts.on("-s", "--screen_port=val",  Integer) { |arg| options.screen_port = arg }
       opts.on("-r", "--rows=val",         Integer) { |arg| options.rows        = arg }
       opts.on("-c", "--columns=val",      Integer) { |arg| options.columns     = arg }
       opts.on("-h", "--help")                      { puts opts; exit }
     end.parse!
+    options.application = ARGV[0] or abort( "An application name is required." )
     options
   end
 end

data/lib/server/pty_server.rb

@@ -3,7 +3,7 @@ require 'io/console'
 
 require_relative 'screen_server'
 require_relative 'key_server'
-require_relative 'vim_interface'
+require_relative 'application_interface'
 require_relative 'app'
 
 Thread.abort_on_exception = true
@@ -13,25 +13,26 @@ class PtyServer
   ENTER_KEY = ?\C-m
 
   def initialize
-    @pty_m, @pty_s  = PTY.open
-    @vim_interface  = VimInterface.new @pty_m
-    @screen_server  = ScreenServer.new App.options.screen_port
-    @key_server     = KeyServer.new App.options.key_port, key_callback
-    @pty_s.winsize  = [ App.options.rows, App.options.columns ]
+    @pty_m, @pty_s         = PTY.open
+    @application_interface = ApplicationInterface.new @pty_m
+    @screen_server         = ScreenServer.new App.options.screen_port
+    @key_server            = KeyServer.new App.options.key_port, key_callback
+    @pty_s.winsize         = [ App.options.rows, App.options.columns ]
+    @application           = App.options.application
   end
 
   def start
-    spawn_vim
     initialize_pty
     @screen_server.listen
     @key_server.listen
     screen_loop
+    spawn_application
   end
 
   def key_callback
     ->(key){
       print key
-      @vim_interface << key
+      @application_interface << key
     }
   end
 
@@ -43,11 +44,10 @@ class PtyServer
     end
   end
 
-  def spawn_vim
-    spawn("vim", in: @pty_s, out: @pty_s)
-    sleep 0.2 # give it a moment to boot
+  def spawn_application
+    spawn(@application, in: @pty_s, out: @pty_s)
   end
-  private :spawn_vim
+  private :spawn_application
 
   # WTH? -- Let me 'splain:
   # There a difference between the mode that PTY
@@ -56,7 +56,7 @@ class PtyServer
   #
   # This means the cursor moves around the screen on the server
   # when you press the arrow keys, but when they are transmitted
-  # through the PTY to vim, the escape encoding is different,
+  # through the PTY to application, the escape encoding is different,
   # this results in vim just honking at you and not moving the cursor.
   #
   # By running `tput rmkx` from vim we are setting the PTY to
@@ -78,9 +78,10 @@ class PtyServer
   # That is just too cool.
   #
   def initialize_pty
-    @vim_interface << ENTER_KEY
-    @vim_interface << ":!tput rmkx"
-    @vim_interface << ENTER_KEY
+  #   # `printf "\033?1h\033=" > #{@pty_s.path}`
+  #   @application_interface << ENTER_KEY
+  #   @application_interface << ":!tput rmkx"
+  #   @application_interface << ENTER_KEY
   end
   private :initialize_pty
 

data/lib/version.rb

@@ -1,3 +1,3 @@
 module DevPtyScreen
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dev-pty-screen
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Mark Lorenz
@@ -78,11 +78,11 @@ files:
 - lib/client/app.rb
 - lib/client/options.rb
 - lib/server/app.rb
+- lib/server/application_interface.rb
 - lib/server/key_server.rb
 - lib/server/options.rb
 - lib/server/pty_server.rb
 - lib/server/screen_server.rb
-- lib/server/vim_interface.rb
 - lib/version.rb
 - outline.markdown
 - spec/server/key_server_spec.rb