tmrb 1.2.3

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+pkg/*
+*.s??
+.rvmrc
+doc/yard
+.yardoc

data/Env

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'tmrb'
+
+tmux = TmRb::Multiplexer.new
+tmux.new_session(:window_name => 'zsh')
+tmux.new_window(:name => 'good code')
+tmux.new_window(:name => 'spec', :command => 'vim -p spec/**/*.rb')
+tmux.start

data/Gemfile

@@ -0,0 +1,19 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in terminal-multiplexer.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rspec'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'pry'
+  gem 'libnotify'
+  gem 'rb-inotify'
+  gem 'rb-readline'
+  gem 'fuubar'
+  gem 'yard'
+  gem 'redcarpet' 
+  gem 'github-markup'
+end

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    tmrb (1.2.3)
+      highline
+      thor
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.0.6)
+    diff-lcs (1.1.3)
+    ffi (1.0.11)
+    fuubar (1.0.0)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.2.0)
+      ruby-progressbar (~> 0.0.10)
+    github-markup (0.7.2)
+    guard (1.0.2)
+      ffi (>= 0.5.0)
+      thor (~> 0.14.6)
+    guard-rspec (0.7.0)
+      guard (>= 0.10.0)
+    highline (1.6.11)
+    libnotify (0.7.2)
+    method_source (0.7.1)
+    pry (0.9.9.4)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7.1)
+      slop (>= 2.4.4, < 3)
+    rake (0.9.2.2)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    rb-readline (0.4.2)
+    redcarpet (2.1.1)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.0)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-instafail (0.2.4)
+    rspec-mocks (2.10.1)
+    ruby-progressbar (0.0.10)
+    slop (2.4.4)
+    thor (0.14.6)
+    yard (0.8.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fuubar
+  github-markup
+  guard
+  guard-rspec
+  libnotify
+  pry
+  rake
+  rb-inotify
+  rb-readline
+  redcarpet
+  rspec
+  tmrb!
+  yard

data/Guardfile

@@ -0,0 +1,11 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', 
+  :version => 2 ,
+  :cli => '--color --format Fuubar' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENCE.md

@@ -0,0 +1,20 @@
+Copyright (c), 2012- Max Meyer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,55 @@
+# tmrb -- easy to use wrapper for tmux
+
+## DESCRIPTION
+
+`tmrb` (formerly known as terminal_multiplexer) is a wrapper for tmux to
+integrate easily in one's development workflow. 
+
+You should configure tmux via its config-file ".tmux.conf". You could use this
+library to create sessions and windows in that sessions.
+
+The library uses semantic versioning. Please see http://semver.org for further
+information.
+
+## SYNOPSIS
+
+```bash
+#require lib
+require 'terminal-multiplexer'
+#create new instance
+tmux = Terminal::Multiplexer.new
+#create new session to hold all windows
+tmux.new_session
+tmux.new_session(:session_name => 'session_name' , :window_name => 'window_name', :command => 'command')
+#create new window
+tmux.new_window
+tmux.new_window(:window_name => 'window_name', :command => 'command')
+#start tmux
+tmux.start
+``` 
+
+## INSTALL
+
+* `Packaged:`
+
+```bash
+gem install terminal_multiplexer
+```
+
+* `Source code:`
+
+```bash
+git clone https://github.com/maxmeyer/terminal_multiplexer.git
+cd terminal_multiplexer
+rake build
+gem install pkg/terminal_multiplexer-xxxx
+```
+
+## EXAMPLES
+
+Please see "doc/examples/" for example scripts.
+
+## FURTHER READING
+
+* http://tmux.sourceforge.net
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'yard'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb', 'README.md', 'LICENCE.md']
+  t.options = ['--output-dir=doc/yard', '--markup-provider=redcarpet', '--markup=markdown' ]
+end
+

data/doc/examples/tmux_wrapper-thor.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'thor'
+require 'tmrb'
+
+class Default < Thor
+  desc "work" , "Start working environment"
+  def work
+    tmux = TmRb::Multiplexer.new
+    tmux.new_session
+    tmux.new_window
+    tmux.new_window
+    tmux.new_session(:session_name=>'first session',:window_name=>'best_editor :)',:command=>'vim -p README.md')
+    tmux.new_window
+    tmux.new_window(:name => 'best shell', :command=>'zsh')
+    tmux.active_window(2)
+    tmux.start
+  end
+end
+
+Default.start

data/doc/examples/tmux_wrapper.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'tmrb'
+
+tmux = TmRb::Multiplexer.new
+tmux.new_session
+tmux.new_window
+tmux.start

data/lib/tmrb.rb

@@ -0,0 +1,107 @@
+require 'tmrb/version'
+require 'tmrb/window'
+require 'tmrb/session'
+require 'tmrb/exceptions'
+
+require 'highline/import'
+
+module TmRb
+  class Multiplexer 
+    include Exceptions
+
+    def initialize
+      @sessions = []
+    end
+
+    # Creates a new tmux session 
+    #
+    # @param [optional,Hash] options options to create a tmux session with 
+    # @option options [String] :session_name ('default') the name of the session itself
+    # @option options [String] :window_name ('tab') the name of first window of the session
+    # @option options [String] :command ('zsh') command which should be started in the first window of the session
+    # @raise [DuplicateSessionIdentifier]
+    def new_session(options={})
+
+      options = { 
+        :session_name => 'default',
+        :window_name => 'tab',
+        :command => 'zsh'
+      }.update options
+
+      if @sessions.find { |s| s.session_name == options[:session_name] }
+        raise DuplicateSessionIdentifier , "Please do not reuse the session identifier. You used \"#{options[:session_name]}\" at least twice."
+      end
+
+      session = Session.new(options[:session_name], options[:window_name], options[:command])
+      @sessions <<  session
+      session
+    end
+
+    # Creates a new tmux window
+    #
+    # @param [optional,Hash] options options to create a tmux window with 
+    # @option options [String] :name ('tab') the name of window 
+    # @option options [String] :command ('zsh') command which should be started in the window
+    def new_window(options={})
+
+      options = { 
+        :name => 'tab',
+        :command => 'zsh'
+      }.update options
+
+      # windows will be attached to the last session defined
+      session = get_last_session
+
+      #if no sessions have been created, create a new one
+      if session == nil
+        say "Warning: No valid session found. Create a default one"
+        session = new_session
+      end
+     
+      #windows belong to a session
+      session.add_window Window.new( options[:name] , options[:command] )
+
+    end
+   
+    # Set the active window in that session
+    #
+    # @param [Integer] num the number of window which should be active in that tmux session
+    def active_window(num)
+      # the active window will always be set for the last defined session
+      session = get_last_session
+      session.active_window(num)
+    end
+
+    
+    private
+
+    # Get the last defined session
+    #
+    # @return [Session] last defined session
+    def get_last_session
+      @sessions[-1]
+    end
+
+    # Build the parameter string for all the sessions + windows
+    # to be used as a parameter for tmux to create that sessions and windows
+    #
+    # @return [String] whole tmux command string
+    def build_multiplexer_command_string
+      m_str = @sessions.collect{ |s| s.to_string}.join(' ')
+      m_str
+    end
+
+    public
+
+    # Start tmux
+    #
+    # @param [optional,Hash] process_info a hash containing information about the tmux process to be started
+    def start(process_info={})
+
+      process_info[:cmd] = 'tmux'
+      process_info[:status] = system(%Q{#{process_info[:cmd]} #{build_multiplexer_command_string} attach}) 
+
+    end
+
+  end
+end

data/lib/tmrb/exceptions.rb

@@ -0,0 +1,18 @@
+module TmRb
+  module Exceptions
+
+    # Exception which should be raised 
+    # if no session is found which can be used
+    # for that particular command
+    #
+    class SessionNotFound < Exception
+    end
+
+    # If you create a session you could choose an identifier
+    # on your own. Every Session has to have its own 
+    # unique session identifier.
+    class DuplicateSessionIdentifier < Exception
+    end
+
+  end
+end

data/lib/tmrb/session.rb

@@ -0,0 +1,75 @@
+module Terminal
+  class Session
+    attr_reader :session_name, :window_name, :command
+
+    # Create the session
+    #
+    # @param [String] session_name the name of the session
+    # @param [String] window_name the name of the first window of the session
+    # @param [String] command the command which should be executed in the first window of the session
+    def initialize(session_name, window_name, command)
+
+      @session_name = session_name
+      @window_name = window_name
+      @command = command
+      @windows = []
+      @active_window = 1
+    end
+
+    # Set the active window in that session
+    #
+    # @param [Integer] num the number of the active window of that session
+    # @return [Integer] the number of the active window
+    def active_window(num)
+      @active_window=num
+    end
+
+    # Build the whole session string for tmux
+    #
+    # @return [String] tmux session
+    def to_string
+      w_defs ||= build_window_string
+      s_opts ||= build_session_options
+
+      %Q{new-session #{s_opts} "#{command}"\\;#{w_defs}}
+    end
+
+    private
+
+    # Build the session options
+    #
+    # @return [String] tmux session options
+    def build_session_options
+      %Q{-s "#{session_name}" -n "#{window_name}"}
+    end
+
+
+    # Build the string containing all created windows
+    #
+    # @return [String] tmux window declartions
+    def build_window_string
+      w_str = ''
+
+      #strings for the windows
+      if @windows.count > 0 
+        w_str += ' '
+        w_str += @windows.collect{|w| w.to_string}.join(' ')
+      end
+
+      #string for the selected window in that session
+      w_str += " select-window -t:+#{@active_window}\\;"
+
+    end
+
+    public
+
+    # Add a window to the session
+    #
+    # @param [Window] window the object containing the window which should be added to the session
+    # @return [Window] the object itself
+    def add_window(window)
+      @windows << window
+    end
+
+  end
+end

data/lib/tmrb/version.rb

@@ -0,0 +1,3 @@
+module TmRb
+    VERSION = "1.2.3"
+end

data/lib/tmrb/window.rb

@@ -0,0 +1,27 @@
+module TmRb
+  class Window
+    attr_accessor :name, :command
+
+    # Create a tmux window 
+    #
+    # @param [String] name the name of the window
+    # @param [String] command the command executed in the window
+    def initialize(name = 'tab', command = 'zsh')
+
+      name = 'tab' if name == nil  or name == ''
+      command = 'zsh' if command == nil  or command == ''
+
+      @name = name
+      @command = command
+      @options = []
+    end
+
+    # Return the tmux string for the window
+    #
+    # @return [String] window declaration
+    def to_string
+      @options.push %Q{-n "#{name}"}
+      %Q{new-window #{@options.join(' ')} "#{command}"\\;}
+    end
+  end
+end

data/spec/session/session_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+module Terminal
+  describe Session do
+    let(:sess) { Session.new('default','tab','zsh') }
+
+    describe "run with rubbish options" do
+      let(:sess) { Session.new(nil,nil,nil) }
+
+      it "has a session name" do
+          sess.session_name.should == nil
+      end
+
+      it "has a window name" do
+        sess.window_name.should == nil
+      end
+
+      it "has a command associated with it" do
+        sess.command.should == nil
+      end
+    end
+
+    describe "run with option" do
+      let(:sess) { Session.new('session','tab','ksh') }
+
+      it "has a session name" do
+        sess.session_name.should == 'session'
+      end
+
+      it "has a window name" do
+        sess.window_name.should == 'tab'
+      end
+
+      it "has a command associated with it" do
+        sess.command.should == 'ksh'
+      end
+    end
+
+    describe "#to_string" do
+      it "returns the correct tmux string" do
+        sess.to_string.should == %Q{new-session -s "default" -n "tab" "zsh"\\; select-window -t:+1\\;}
+      end
+    end
+
+    describe "#add_window" do
+      before :each do
+        @win = double('window')
+        @win.should_receive(:to_string).and_return('new-window -n "tab" "zsh"\\;')
+      end
+
+      it "returns the correct tmux string" do
+        sess.add_window(@win)
+        sess.to_string.should == %q{new-session -s "default" -n "tab" "zsh"\\; new-window -n "tab" "zsh"\\; select-window -t:+1\\;}
+      end
+    end
+
+    describe "#active_window" do
+      it "sets the active window after creation of session and windows" do
+        sess.active_window(2)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH << File.expand_path('../lib/tmrb' , File.dirname(__FILE__))
+
+require 'tmrb'
+require 'pry'
+
+RSpec.configure do |c|
+    c.treat_symbols_as_metadata_keys_with_true_values = true
+end
+

data/spec/terminal-multiplexer/terminal-multiplexer_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+module Terminal 
+  include Exceptions
+
+  describe Multiplexer do
+
+    let(:multi) { Multiplexer.new }
+
+    describe "#new_session" do
+
+      it "creates a new session with default name" do
+        multi.new_session
+        multi.send(:build_multiplexer_command_string).should == %Q{new-session -s "default" -n "tab" "zsh"\\; select-window -t:+1\\;}
+      end
+
+      it "creates a new session with given name" do
+        multi.new_session(:session_name => 'session1', :window_name => 'tab', :command => 'ksh')
+        multi.send(:build_multiplexer_command_string).should == %Q{new-session -s "session1" -n "tab" "ksh"\\; select-window -t:+1\\;}
+      end
+
+      it "creates a string for all sessions created" do
+        multi.new_session
+        multi.new_session(:session_name => 'session1', :window_name => 'tab', :command => 'ksh')
+        multi.send(:build_multiplexer_command_string).should == %Q{new-session -s "default" -n "tab" "zsh"\\; select-window -t:+1\\; new-session -s "session1" -n "tab" "ksh"\\; select-window -t:+1\\;}
+      end
+
+      it "raises an exception if a session identifier is reused" do
+        lambda{ 
+          multi.new_session
+          multi.new_session
+        }.should raise_error DuplicateSessionIdentifier
+      end
+    end
+    
+    describe "#new_window" do
+      it "creates a new window for the default session" do
+        multi.new_window
+        multi.send(:build_multiplexer_command_string).should == %Q{new-session -s "default" -n "tab" "zsh"\\; new-window -n "tab" "zsh"\\; select-window -t:+1\\;}
+      end
+      it "creates a new window for \"session1\"" do
+        multi.new_session(:session_name => 'session1', :window_name => 'tab', :command => 'ksh')
+        multi.new_window
+        multi.send(:build_multiplexer_command_string).should == %Q{new-session -s "session1" -n "tab" "ksh"\\; new-window -n "tab" "zsh"\\; select-window -t:+1\\;}
+      end
+
+      it "creates a new window for session \"default\"" do
+        multi.new_session
+        multi.new_window
+        multi.send(:build_multiplexer_command_string).should == %Q{new-session -s "default" -n "tab" "zsh"\\; new-window -n "tab" "zsh"\\; select-window -t:+1\\;}
+      end
+
+      it "creates 2 windows in session1 and 2 windows in session2 (the last defined session, after creating the windows)" do
+        multi.new_session(:session_name => 'session1', :window_name => 'tab', :command => 'ksh')
+        multi.new_window(:name => 'window1', :command => 'ksh')
+        multi.new_window(:name => 'window2', :command => 'ksh')
+        multi.new_session(:session_name => 'session2', :window_name => 'tab', :command => 'ksh')
+        multi.new_window(:name => 'window3', :command => 'ksh')
+        multi.new_window(:name => 'window4', :command => 'ksh')
+        multi.send(:build_multiplexer_command_string).should == %Q{new-session -s "session1" -n "tab" "ksh"\\; new-window -n "window1" "ksh"\\; new-window -n "window2" "ksh"\\; select-window -t:+1\\; new-session -s "session2" -n "tab" "ksh"\\; new-window -n "window3" "ksh"\\; new-window -n "window4" "ksh"\\; select-window -t:+1\\;}
+      end
+
+    end
+
+    describe "#active_window" do
+      it "selects the window from the last defined session" do
+        multi.new_session(:session_name => 'session1', :window_name => 'tab', :command => 'ksh')
+        multi.new_window(:name => 'window1', :command => 'ksh')
+        multi.new_window(:name => 'window2', :command => 'ksh')
+        multi.active_window(2)
+        multi.send(:build_multiplexer_command_string).should == %Q{new-session -s "session1" -n "tab" "ksh"\\; new-window -n "window1" "ksh"\\; new-window -n "window2" "ksh"\\; select-window -t:+2\\;}
+      end
+
+      it "doesn't matter where you place the window selector. It selects the window from the last defined session" do
+        multi.new_session(:session_name => 'session1', :window_name => 'tab', :command => 'ksh')
+        multi.active_window(2)
+        multi.new_window(:name => 'window1', :command => 'ksh')
+        multi.new_window(:name => 'window2', :command => 'ksh')
+        multi.send(:build_multiplexer_command_string).should == %Q{new-session -s "session1" -n "tab" "ksh"\\; new-window -n "window1" "ksh"\\; new-window -n "window2" "ksh"\\; select-window -t:+2\\;}
+      end
+    end
+  end
+end

data/spec/window/window_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+module Terminal
+  describe Window do
+    let(:win) { Window.new }
+
+    describe "run with no option" do
+      it "has a name" do
+        win.name.should == 'tab'
+      end
+
+      it "has a command associated with it" do
+        win.command.should == 'zsh'
+      end
+    end
+
+    describe "run with option" do
+      let(:win) { Window.new('win','ksh') }
+
+      it "has a name" do
+        win.name.should == 'win'
+      end
+
+      it "has a command associated with it" do
+        win.command.should == 'ksh'
+      end
+    end
+
+    describe "#to_string" do
+      it "returns the correct tmux string" do
+        win.to_string.should == %Q{new-window -n "tab" "zsh"\\;} 
+      end
+    end
+  end
+end
+

data/tmrb.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH << File.expand_path("../lib", __FILE__)
+require 'tmrb/version'
+
+Gem::Specification.new do |s|
+  s.name        = "tmrb"
+  s.version     = TmRb::VERSION
+  s.authors     = ["Max Meyer"]
+  s.email       = ["dev@fedux.org"]
+  s.homepage    = ""
+  s.summary     = %q{Building tmux sessions with ease}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "highline"
+  s.add_runtime_dependency "thor"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: tmrb
+version: !ruby/object:Gem::Version
+  version: 1.2.3
+  prerelease: 
+platform: ruby
+authors:
+- Max Meyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-09 00:00:00.000000000 +02:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: &12431960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *12431960
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &12431280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *12431280
+description: 
+email:
+- dev@fedux.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Env
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENCE.md
+- README.md
+- Rakefile
+- doc/examples/tmux_wrapper-thor.rb
+- doc/examples/tmux_wrapper.rb
+- lib/tmrb.rb
+- lib/tmrb/exceptions.rb
+- lib/tmrb/helper.rb
+- lib/tmrb/session.rb
+- lib/tmrb/version.rb
+- lib/tmrb/window.rb
+- spec/session/session_spec.rb
+- spec/spec_helper.rb
+- spec/terminal-multiplexer/terminal-multiplexer_spec.rb
+- spec/window/window_spec.rb
+- tmrb.gemspec
+has_rdoc: true
+homepage: ''
+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.6.2
+signing_key: 
+specification_version: 3
+summary: Building tmux sessions with ease
+test_files:
+- spec/session/session_spec.rb
+- spec/spec_helper.rb
+- spec/terminal-multiplexer/terminal-multiplexer_spec.rb
+- spec/window/window_spec.rb