terminal_multiplexer 0.1.1 → 1.0.0

data/README.md

@@ -17,10 +17,10 @@ require 'terminal-multiplexer'
 tmux = Terminal::Multiplexer.new
 #create new session to hold all windows
 tmux.new_session
-tmux.new_session('window_name','command')
+tmux.new_session(:session_name => 'session_name' , :window_name => 'window_name', :command => 'command')
 #create new window
 tmux.new_window
-tmux.new_window('window_name','command')
+tmux.new_window(:window_name => 'window_name', :command => 'command')
 #start tmux
 tmux.start
 ``` 

data/doc/examples/tmux_wrapper-thor.rb

@@ -10,8 +10,10 @@ class Default < Thor
     tmux.new_session
     tmux.new_window
     tmux.new_window
+    tmux.new_session(:session_name=>'session1',:window_name=>'window1',:command=>'zsh')
     tmux.new_window
-    tmux.new_window('tests', 'guard')
+    tmux.new_window(:name => 'tests', :command=>'guard')
+    tmux.active_window(2)
     tmux.start
   end
 end

data/env

@@ -11,7 +11,7 @@ class Default < Thor
     tmux.new_window
     tmux.new_window
     tmux.new_window
-    tmux.new_window('tests', 'guard')
+    tmux.new_window(:name => 'tests', :command => 'guard')
     tmux.active_window(2)
     tmux.start
   end

data/lib/terminal-multiplexer.rb

@@ -9,39 +9,62 @@ module Terminal
   class Multiplexer 
     include Exceptions
 
-
-    def initialize(*options)
-#      @options = {
-#        :default_cmd => 'zsh'
-#      }.update options
-#
+    def initialize
       @sessions = []
     end
 
-    def new_session(name='default', command='zsh')
-      if @sessions.find { |s| s.name == name }
-        raise DuplicateSessionIdentifier , "Please do not reuse the session identifier. You used \"#{name}\" at least twice."
+    # Creates a new tmux session 
+    #
+    # @session_name [String] name the name of the session
+    # @window_name [String] name the name of first window of the session
+    # @command [String] command the command which should be started in the first window of the session
+    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(name, command)
+      session = Session.new(options[:session_name], options[:window_name], options[:command])
       @sessions <<  session
       session
     end
 
+    # Creates a new tmux window
+    #
+    # @name [String] name the name of the window, which should be created
+    # @command [String] command the command which should be started in the created window
+    def new_window(options={})
+
+      options = { 
+        :name => 'tab',
+        :command => 'zsh'
+      }.update options
 
-    def new_window(name='tab', command='zsh')
+      # 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
-      
-      session.add_window Window.new( name , command )
+     
+      #windows belong to a session
+      session.add_window Window.new( options[:name] , options[:command] )
 
     end
-    
+   
+    # Set the active window in that session
+    #
+    # @num [Integer] number 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
@@ -49,10 +72,13 @@ module Terminal
     
     private
 
+    # Get the 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
     def build_multiplexer_command_string
       m_str = @sessions.collect{ |s| s.plain}.join(' ')
       m_str
@@ -60,10 +86,13 @@ module Terminal
 
     public
 
+    # Start tmux
+    #
+    # @process_info [Hash] process_information a hash containing information about the tmux process to be started
     def start(process_info={})
 
       process_info[:cmd] = 'tmux'
-      process_info[:status] = system("#{process_info[:cmd]} #{build_multiplexer_command_string}") 
+      process_info[:status] = system("#{process_info[:cmd]} #{build_multiplexer_command_string} attach") 
 
     end
 

data/lib/terminal-multiplexer/exceptions.rb

@@ -1,9 +1,16 @@
 module Terminal
   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
 

data/lib/terminal-multiplexer/session.rb

@@ -1,50 +1,67 @@
 module Terminal
   class Session
-    attr_reader :name, :command
+    attr_reader :session_name, :window_name, :command
 
-    def initialize(name = 'default', command = 'zsh')
+    # Create the session
+    #
+    # @session_name [String] session_name the name of the session
+    # @window_name [String] window_name the name of the first window of the session
+    # @command [String] command the command which should be executed in the first window of the session
+    def initialize(session_name, window_name, command)
 
-      name = 'default' if name == nil  or name == ''
-      command = 'zsh' if command == nil  or command == ''
-
-      @name = name
+      @session_name = session_name
+      @window_name = window_name
       @command = command
       @windows = []
       @active_window = 1
     end
 
+    # Set the active window in that session
+    #
+    # @num [Integer] number the number of the active window of that session
     def active_window(num)
       @active_window=num
     end
 
+    # Build the whole session string for tmux
+    #
     def plain
       w_defs ||= build_window_string
-      w_opts ||= build_window_options
+      s_opts ||= build_session_options
 
-      "new-session #{w_opts} #{command}\\;#{w_defs}"
+      "new-session #{s_opts} #{command}\\;#{w_defs}"
     end
 
     private
 
-    def build_window_options
-      "-n #{name}"
+    # Build the session options
+    #
+    def build_session_options
+      "-s #{session_name} -n #{window_name}"
     end
 
 
+    # Build the string containing all created windows
+    #
     def build_window_string
       w_str = ''
 
+      #strings for the windows
       if @windows.count > 0 
         w_str += ' '
         w_str += @windows.collect{|w| w.plain}.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
+    #
+    # @window [Window] window the object containing the window which should be added to the session
     def add_window(window)
       @windows << window
     end

data/lib/terminal-multiplexer/version.rb

@@ -1,3 +1,3 @@
 module Terminal
-    VERSION = "0.1.1"
+    VERSION = "1.0.0"
 end

data/lib/terminal-multiplexer/window.rb

@@ -2,6 +2,10 @@ module Terminal
   class Window
     attr_accessor :name, :command
 
+    # Create a tmux window 
+    #
+    # @name [String] name the name of the window
+    # @command [String] command the command executed in the window
     def initialize(name = 'tab', command = 'zsh')
 
       name = 'tab' if name == nil  or name == ''
@@ -12,6 +16,8 @@ module Terminal
       @options = []
     end
 
+    # Return the tmux string for the window
+    #
     def plain
       @options.push "-n #{name}"
       "new-window #{@options.join(' ')} #{command}\\;"

data/spec/session/session_spec.rb

@@ -2,36 +2,33 @@ require 'spec_helper'
 
 module Terminal
   describe Session do
-    let(:sess) { Session.new }
+    let(:sess) { Session.new('default','tab','zsh') }
 
     describe "run with rubbish options" do
-      let(:sess) { Session.new(nil,nil) }
+      let(:sess) { Session.new(nil,nil,nil) }
 
-      it "has a name" do
-        sess.name.should == 'default'
+      it "has a session name" do
+          sess.session_name.should == nil
       end
 
-      it " has a command associated with it" do
-        sess.command.should == 'zsh'
-      end
-    end
-
-    describe "run with no option" do
-
-      it "has a name" do
-        sess.name.should == 'default'
+      it "has a window name" do
+        sess.window_name.should == nil
       end
 
-      it " has a command associated with it" do
-        sess.command.should == 'zsh'
+      it "has a command associated with it" do
+        sess.command.should == nil
       end
     end
 
     describe "run with option" do
-      let(:sess) { Session.new('session','ksh') }
+      let(:sess) { Session.new('session','tab','ksh') }
+
+      it "has a session name" do
+        sess.session_name.should == 'session'
+      end
 
-      it "has a name" do
-        sess.name.should == 'session'
+      it "has a window name" do
+        sess.window_name.should == 'tab'
       end
 
       it "has a command associated with it" do
@@ -41,7 +38,7 @@ module Terminal
 
     describe "#plain" do
       it "returns the correct tmux string" do
-        sess.plain.should == "new-session -n default zsh\\; select-window -t:+1\\;" 
+        sess.plain.should == "new-session -s default -n tab zsh\\; select-window -t:+1\\;" 
       end
     end
 
@@ -53,7 +50,7 @@ module Terminal
 
       it "returns the correct tmux string" do
         sess.add_window(@win)
-        sess.plain.should == "new-session -n default zsh\\; new-window -n tab zsh\\; select-window -t:+1\\;" 
+        sess.plain.should == "new-session -s default -n tab zsh\\; new-window -n tab zsh\\; select-window -t:+1\\;" 
       end
     end
 

data/spec/spec_helper.rb

@@ -2,3 +2,8 @@ $LOAD_PATH << File.expand_path('../lib/terminal-multiplexer' , File.dirname(__FI
 
 require 'terminal-multiplexer'
 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

@@ -11,18 +11,18 @@ module Terminal
 
       it "creates a new session with default name" do
         multi.new_session
-        multi.send(:build_multiplexer_command_string).should == "new-session -n default zsh\\; select-window -t:+1\\;"
+        multi.send(:build_multiplexer_command_string).should == "new-session -s default -n tab zsh\\; select-window -t:+1\\;"
       end
 
       it "creates a new session with given name" do
-        multi.new_session('session1','ksh')
-        multi.send(:build_multiplexer_command_string).should == "new-session -n session1 ksh\\; select-window -t:+1\\;"
+        multi.new_session(:session_name => 'session1', :window_name => 'tab', :command => 'ksh')
+        multi.send(:build_multiplexer_command_string).should == "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('session1','ksh')
-        multi.send(:build_multiplexer_command_string).should == "new-session -n default zsh\\; select-window -t:+1\\; new-session -n session1 ksh\\; select-window -t:+1\\;"
+        multi.new_session(:session_name => 'session1', :window_name => 'tab', :command => 'ksh')
+        multi.send(:build_multiplexer_command_string).should == "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
@@ -36,47 +36,47 @@ module Terminal
     describe "#new_window" do
       it "creates a new window for the default session" do
         multi.new_window
-        multi.send(:build_multiplexer_command_string).should == "new-session -n default zsh\\; new-window -n tab zsh\\; select-window -t:+1\\;"
+        multi.send(:build_multiplexer_command_string).should == "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('session1','ksh')
+        multi.new_session(:session_name => 'session1', :window_name => 'tab', :command => 'ksh')
         multi.new_window
-        multi.send(:build_multiplexer_command_string).should == "new-session -n session1 ksh\\; new-window -n tab zsh\\; select-window -t:+1\\;"
+        multi.send(:build_multiplexer_command_string).should == "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 == "new-session -n default zsh\\; new-window -n tab zsh\\; select-window -t:+1\\;"
+        multi.send(:build_multiplexer_command_string).should == "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('session1','ksh')
-        multi.new_window('window1','ksh')
-        multi.new_window('window2','ksh')
-        multi.new_session('session2','ksh')
-        multi.new_window('window3','ksh')
-        multi.new_window('window4','ksh')
-        multi.send(:build_multiplexer_command_string).should == "new-session -n session1 ksh\\; new-window -n window1 ksh\\; new-window -n window2 ksh\\; select-window -t:+1\\; new-session -n session2 ksh\\; new-window -n window3 ksh\\; new-window -n window4 ksh\\; select-window -t:+1\\;"
+        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 == "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('session1','ksh')
-        multi.new_window('window1','ksh')
-        multi.new_window('window2','ksh')
+        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 == "new-session -n session1 ksh\\; new-window -n window1 ksh\\; new-window -n window2 ksh\\; select-window -t:+2\\;"
+        multi.send(:build_multiplexer_command_string).should == "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('session1','ksh')
+        multi.new_session(:session_name => 'session1', :window_name => 'tab', :command => 'ksh')
         multi.active_window(2)
-        multi.new_window('window1','ksh')
-        multi.new_window('window2','ksh')
-        multi.send(:build_multiplexer_command_string).should == "new-session -n session1 ksh\\; new-window -n window1 ksh\\; new-window -n window2 ksh\\; select-window -t:+2\\;"
+        multi.new_window(:name => 'window1', :command => 'ksh')
+        multi.new_window(:name => 'window2', :command => 'ksh')
+        multi.send(:build_multiplexer_command_string).should == "new-session -s session1 -n tab ksh\\; new-window -n window1 ksh\\; new-window -n window2 ksh\\; select-window -t:+2\\;"
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terminal_multiplexer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
-  requirement: &22895840 !ruby/object:Gem::Requirement
+  requirement: &13995980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *22895840
+  version_requirements: *13995980
 description: 
 email:
 - dev@fedux.org