tweemux 0.0.1

data/.gemspec

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+require 'working/gemspec'
+$:.unshift './lib'
+require 'tweemux/version'
+
+Working.gemspec(
+  :name => 'tweemux',
+  :summary => Working.third_line_of_readme,
+  #:description => Working.readme_snippet(/== Usage/, /== TODO/),
+  :description => Working.third_line_of_readme,
+  :version => Tweemux::VERSION,
+  :authors => %w(☈king),
+  :email => 'rking-tweemux@sharpsaw.org',
+  :github => 'rking/tweemux',
+  :deps => %w(),
+)

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+group :development do
+  gem 'working'
+end

data/Guardfile

@@ -0,0 +1 @@
+require 'working/guard'

data/LICENSE.txt

@@ -0,0 +1 @@
+Copyleft (ↄ) 2013 ☈king — CC0/Public Domain.

data/README.rdoc

@@ -0,0 +1,49 @@
+= tweemux
+
+For Remote Pair Programming: A handy script to create-or-join a world-readable tmux session (smaller than wemux)
+
+One of the aims of this script is to be convenient. Another of its aims is to be transparent (read: loud) about what it's doing. None of the parts of this are inherently complicated, and any of them is prone to need additional debugging, so it's best that `tweemux`'s behavior is visible.
+
+== Problem
+
+Though tmux is an amazing tool, some of the parts of it are low-level. As you can see from the tmux portion of this script's source, there isn't much you have to do to get a shared session, but it's still more than you want you or your pair to think about when you're trying to work.  The `wemux` script is similar to this, but I don't care for its complexity/optionality/config (and the thing that really bothers me is that it has a 'read-only' mode that only is read-only because of the command used to connect to the socket — the socket itself is still `chmod 777`, so you might as well be honest about the idea that the session could be connected by any user in writeable mode).
+
+Once you've solved the "shared tmux" problem, that's actually the easier part of it. This script goes a little further and helps with the user and SSH connection problems.
+
+== Host Usage
+
+For starters:
+
+    gem install tweemux
+
+Then, create the user on your machine:
+
+    tweemux bro lwoodson # when their Github username == desired Unix username
+    # -or-
+    tweemux bro cirwin github: ConradIrwin
+    # -or-
+    tweemux sis ghopper # synonym for 'bro'
+
+If you're on a machine behind a firewall, use one that is *not* behind a firewall that you also have SSH access to (in this example, sharpsaw.org is the one not behind the firewall):
+
+    tweemux forward local 22 from sharpsaw.org 3322
+    # ^ Or, if you're in control of the router, you can just open a port and
+    # point your pair at your actual IP (`curl ifconfig.me` comes in handy for
+    # finding the public IP)
+
+Then finally:
+
+    tweemux host
+
+== Guest Usage
+
+    gem install tweemux
+    tweemux at sharpsaw.org 3322 # uses the 'forward' set up from above
+
+== Going Further
+
+It's also nice to share a windowing environment session as well. For example, the "Guest" can host a VNC that you, as the tweemux host, can then connect to. This allows you to "point" at things with the mouse, and to share web browsing, etc.
+
+== No Public Box?
+
+If you don't have a public SSH account (like the way I use sharpsaw.org, above), let me know ( i-am-stuck@sharpsaw.org ). We'll solve that.

data/Rakefile

@@ -0,0 +1 @@
+require 'working/rake_tasks'

data/bin/tweemux

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'tweemux'
+Tweemux.run ARGV

data/lib/tweemux.rb

@@ -0,0 +1,21 @@
+require 'tweemux/action'
+require 'tweemux/core_ext'
+
+class Tweemux
+  SOCK = '/tmp/tweemux.sock'
+
+  class << self
+    def run args
+      action = understand args
+      action.call
+    end
+
+    def understand args
+      action = args.shift
+      klass = Tweemux::Action.const_get action.capitalize
+      klass.new args
+    end
+  end
+end
+
+

data/lib/tweemux/action.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+
+class Tweemux
+  class Action
+    def initialize args; @args = args end
+
+    def call
+      run @args
+    end
+
+    class FunkyUsage < RuntimeError; end
+
+    def run args; raise 'Unimplemented' end
+
+    # Hrm. This is kinda gross, but I feel like it cleans up the subclasses
+    def explained_run *a; self.class.explained_run *a end
+    def tmux_S *a; self.class.tmux_S *a end
+
+    class DubiousSystemInvocation < RuntimeError; end
+    class << self
+      def tmux_S args, why
+        cmd = %W(tmux -S #{SOCK}) + args
+        explained_run cmd, why
+      end
+
+      def explained_run what, why
+        raise DubiousSystemInvocation, "Given string-arg of #{what}" \
+          if what.is_a? String
+            explain what, why
+            system_or_raise what
+        end
+
+        def explain what, why
+          warn highlight_command(what) + highlight_explanation(why)
+        end
+
+        def system_or_raise cmd
+          system *cmd or pseudo_restarts(*cmd)
+        end
+
+        def highlight_command arr
+          ':Running'.color(:middle_blue) \
+            + '; '.color(:gray245) \
+            + colorize_tmux_command(arr)
+        end
+
+        def highlight_explanation msg
+          '  # '.color(:orange) + msg.color(:lemon)
+        end
+
+        def colorize_tmux_command arr
+          # Index access in Ruby is a smell. @ConradIrwin, help me!!
+          socket_idx = arr.find_index '-S'
+          arr.inject [] do |a,e|
+            a <<
+              if socket_idx and (e == arr[socket_idx] or e == arr[socket_idx+1])
+                e.color :gray245
+              else
+                e.color :brighty_blue
+              end
+          end.join ' '
+        end
+
+        def pseudo_restarts cmd
+          warn '# failed ☹'.color :error
+          ctrl_c = 'Ctrl+c'.color :keypress, :prompt
+          enter = 'Enter'.color :keypress, :prompt
+          # TODO: work pry-rescue into this so we can offer a 'try-again'
+          # See also: https://github.com/ConradIrwin/pry-rescue/issues/29
+          warn <<-EOT.color :prompt
+  To give up, hit: #{ctrl_c}
+To run anyway, hit: #{enter}
+          EOT
+          $stdin.readline
+        end
+
+        def load_all!
+          dir = __FILE__.sub /\.rb$/, ''
+          Dir[dir + '/*.rb'].each do |e|
+            require e.sub /.*(tweemux\/.+)\.rb$/, '\1'
+          end
+        end
+      end
+  end
+end
+
+Tweemux::Action.load_all!

data/lib/tweemux/action/at.rb

@@ -0,0 +1,8 @@
+class Tweemux::Action::At < Tweemux::Action
+  def run args
+    host, port = args
+    port ||= 22
+    explained_run %W(ssh #{host} -p#{port} -t tmux -S #{Tweemux::SOCK} attach),
+      "Connect to #{host} on port #{port}, demand a pty, then attach to session"
+  end
+end

data/lib/tweemux/action/bro.rb

@@ -0,0 +1,3 @@
+class Tweemux::Action::Bro < Tweemux::Action
+
+end

data/lib/tweemux/action/forward.rb

@@ -0,0 +1,33 @@
+class Tweemux::Action::Forward < Tweemux::Action
+  def run args
+    usage_fail 'wrong number of thingies' unless 5 == args.size
+    host, hostport, from_, remote_host, port = args
+    usage_fail 'third thingy has to be numeric port' unless is_int? hostport
+    usage_fail 'fourth thingy has to be "from"' unless 'from' == from_
+    usage_fail 'fith thingy has to be numeric port' unless is_int? port
+    host = 'localhost' if 'local' == host
+    explained_run %W(ssh -fNR #{port}:#{host}:#{hostport} #{remote_host}),
+      '-f = background, -N = no remote command, -R = remote forward'
+  end
+
+  def usage_fail what_happened
+    raise FunkyUsage,
+      (what_happened+". Expected usage:\n  ").color(:error_explanation) + 
+      'tweemux '.color(:keyword) + colored_sample_command
+  end
+
+  def colored_sample_command
+    [
+      'forward'.color(:keyword),
+      'local'.color(:host),
+      '22'.color(:number),
+      'from'.color(:keyword),
+      'sharpsaw.org'.color(:host),
+      '3322'.color(:number),
+    ].join ' '
+  end
+
+  def is_int? str
+    str.to_i.to_s == str
+  end
+end

data/lib/tweemux/action/host.rb

@@ -0,0 +1,7 @@
+class Tweemux::Action::Host < Tweemux::Action
+  def run _
+    tmux_S %w'start-server', 'brings up the tmux process'
+    tmux_S ['new', 'tweemux share'],
+      "starts sesssion '0', repermissionizes, then runs '#{ENV['SHELL']}'"
+  end
+end

data/lib/tweemux/action/share.rb

@@ -0,0 +1,7 @@
+class Tweemux::Action::Share < Tweemux::Action
+  def run _
+    chmod_a_rw = %w(chmod a+rw) + [Tweemux::SOCK]
+    explained_run chmod_a_rw, 'makes the shared socket shareable'
+    explained_run [ENV['SHELL']], 'only here to prevent the session from ending'
+  end
+end

data/lib/tweemux/action/sis.rb

@@ -0,0 +1,2 @@
+require 'tweemux/action/bro'
+class Tweemux::Action::Sis < Tweemux::Action::Bro; end

data/lib/tweemux/core_ext.rb

@@ -0,0 +1,30 @@
+class String
+  # Pallete viewable from:
+  #   https://github.com/sharpsaw/tmux-dots/blob/master/bin/colortest
+  COLORS = {
+    :middle_blue => 69,
+    :brighty_blue => 39,
+    :gray245 => 245,
+    :orange => 172,
+    :pale_yellow => 180,
+    :lemon => 228,
+
+    :keypress => 157,
+    :prompt => 35,
+    :number => 48,
+    :keyword => 60,
+    :host => 148,
+
+    :error => 160,
+    :error_explanation => 178,
+    :default => 7
+  }
+  def color this_color, end_on = :default
+    [this_color, end_on].each{|e| fail "No color named #{e}" unless COLORS[e]}
+    if $stderr.tty?
+      "\e[38;5;#{COLORS[this_color]}m#{self}\e[38;5;#{COLORS[end_on]}m"
+    else
+      self
+    end
+  end
+end

data/lib/tweemux/version.rb

@@ -0,0 +1,3 @@
+class Tweemux
+  VERSION = '0.0.1'
+end

data/test/action_test_helper.rb

@@ -0,0 +1,25 @@
+require_relative 'test_helper'
+
+module TweemuxActionHelper
+  def test_run
+    explained_runs = []
+    Tweemux::Action.stub :explained_run, -> *a { explained_runs << a } do
+      Tweemux.run argv
+    end
+    got = explained_runs.map &:first
+    assert_equal got.to_yaml, expected_commands.to_yaml
+  end
+
+  def bad_runs; [] end
+  def test_bad_runs
+    bad_runs.each do |illegit|
+      begin
+        Tweemux.run illegit
+      rescue Tweemux::Action::FunkyUsage
+      else
+        fail "#{illegit} didn't raise expected error"
+      end
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+# Run this via 'beg'
+require 'working/test_helper'
+
+require 'tweemux'
+
+Spork.each_run do
+  Dir['lib/**/*.rb'].each{|e| load e}
+end
+# Spork.prefork doesn't like when this is missing

data/test/tweemux/action/at_test.rb

@@ -0,0 +1,16 @@
+require_relative '../../action_test_helper'
+class Tweemux::Action::AtTest  < MiniTest::Unit::TestCase
+  include TweemuxActionHelper
+  def argv; %w'at sharpsaw.org 2233' end
+  def expected_commands
+    [ %w(ssh sharpsaw.org -p2233 -t tmux -S /tmp/tweemux.sock attach) ]
+  end
+end
+
+class Tweemux::Action::AtImplicitPortTest  < MiniTest::Unit::TestCase
+  include TweemuxActionHelper
+  def argv; %w'at sharpsaw.org' end
+  def expected_commands
+    [ %w(ssh sharpsaw.org -p22 -t tmux -S /tmp/tweemux.sock attach) ]
+  end
+end

data/test/tweemux/action/forward_test.rb

@@ -0,0 +1,17 @@
+require_relative '../../action_test_helper'
+class Tweemux::Action::ForwardTest  < MiniTest::Unit::TestCase
+  include TweemuxActionHelper
+  def argv; %w'forward local 22 from sharpsaw.org 3322' end
+  def expected_commands
+    [ %w(ssh -fNR 3322:localhost:22 sharpsaw.org) ]
+  end
+
+  def bad_runs
+    [
+      %w(forward asdf asdf),
+      %w(forward local hi from sharpsaw.org 3322),
+      %w(forward local 22 from sharpsaw.org hi),
+      %w(forward local 22 zipzip sharpsaw.org 3322),
+    ]
+  end
+end

data/test/tweemux/action/host_test.rb

@@ -0,0 +1,11 @@
+require_relative '../../action_test_helper'
+class Tweemux::Action::HostTest  < MiniTest::Unit::TestCase
+  include TweemuxActionHelper
+  def argv; %w'host' end
+  def expected_commands
+    [
+      %w(tmux -S /tmp/tweemux.sock start-server),
+      %w(tmux -S /tmp/tweemux.sock new) + ['tweemux share'],
+    ]
+  end
+end

data/test/tweemux/action/share_test.rb

@@ -0,0 +1,11 @@
+require_relative '../../action_test_helper'
+class Tweemux::Action::ShareTest < MiniTest::Unit::TestCase
+  include TweemuxActionHelper
+  def argv; %w'share' end
+  def expected_commands
+    [
+      %w(chmod a+rw /tmp/tweemux.sock),
+      [ENV['SHELL']],
+    ]
+  end
+end

data/test/tweemux/action_test.rb

@@ -0,0 +1,10 @@
+require_relative '../test_helper'
+
+class Tweemux::ActionTest < MiniTest::Unit::TestCase
+  def test_explained_run_strictness
+    Tweemux::Action.explained_run 'echo > /tmp/hi', 'not shell-interpreted'
+  rescue Tweemux::Action::DubiousSystemInvocation
+  else
+    fail 'Should have refused to run a sketchy shell command.'
+  end
+end

data/test/tweemux_test.rb

@@ -0,0 +1,27 @@
+require_relative 'test_helper'
+
+class TweemuxTest < MiniTest::Unit::TestCase
+  def test_doc_claims
+    claimed_working = File.readlines('README.rdoc').grep /^ {4}tweemux/
+    claimed_working.each do |line|
+      line.sub! /#.*/, ''
+      fake_argv = line.sub(/^\s*tweemux/, '').split.map{|e| e.strip}
+      action = Tweemux.understand fake_argv
+      got_run = false
+      action.stub :run, -> *a { got_run = true } do
+        action.call
+      end
+      assert got_run, "running action for #{line}"
+    end
+  end
+
+  def test_ruby18
+    # TODO: optimize this by running them all in one command
+    Dir['{bin,lib}/*.rb'].each do |e|
+      fail "ruby18 hates #{e}" unless "Syntax OK\n" == `ruby18 -c #{e}`
+    end
+  rescue Errno::ENOENT => e
+    skip 'Needs ruby18 executable in $PATH' if e.message[/ruby18/]
+    raise e
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: tweemux
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- ☈king
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-25 00:00:00.000000000 Z
+dependencies: []
+description: ! 'For Remote Pair Programming: A handy script to create-or-join a world-readable
+  tmux session (smaller than wemux)
+
+
+  For Remote Pair Programming: A handy script to create-or-join a world-readable tmux
+  session (smaller than wemux)
+
+'
+email: rking-tweemux@sharpsaw.org
+executables:
+- tweemux
+extensions: []
+extra_rdoc_files: []
+files:
+- .gemspec
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- bin/tweemux
+- lib/tweemux.rb
+- lib/tweemux/action.rb
+- lib/tweemux/action/at.rb
+- lib/tweemux/action/bro.rb
+- lib/tweemux/action/forward.rb
+- lib/tweemux/action/host.rb
+- lib/tweemux/action/share.rb
+- lib/tweemux/action/sis.rb
+- lib/tweemux/core_ext.rb
+- lib/tweemux/version.rb
+- test/action_test_helper.rb
+- test/test_helper.rb
+- test/tweemux/action/at_test.rb
+- test/tweemux/action/forward_test.rb
+- test/tweemux/action/host_test.rb
+- test/tweemux/action/share_test.rb
+- test/tweemux/action_test.rb
+- test/tweemux_test.rb
+homepage: https://github.com/rking/tweemux
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ! 'For Remote Pair Programming: A handy script to create-or-join a world-readable
+  tmux session (smaller than wemux)'
+test_files:
+- test/action_test_helper.rb
+- test/test_helper.rb
+- test/tweemux/action/at_test.rb
+- test/tweemux/action/forward_test.rb
+- test/tweemux/action/host_test.rb
+- test/tweemux/action/share_test.rb
+- test/tweemux/action_test.rb
+- test/tweemux_test.rb
+has_rdoc: