tmuxinator 0.4.0 → 0.5.0

data/README.md

@@ -1,17 +1,16 @@
 # Tmuxinator
 
-Create and manage tmux sessions easily. Inspired by Jon Druse's ([Screeninator](https://github.com/jondruse/screeninator)) and Arthur Chiu's ([Terminitor](http://github.com/achiu/terminitor))
+Create and manage tmux sessions easily.
 
-## Example
+### Example
 
-![Sample](http://f.cl.ly/items/3e3I1l1t3D2U472n1h0h/Screen%20shot%202010-12-10%20at%2010.59.17%20PM.png)
+![Screenshot](http://f.cl.ly/items/3e3I1l1t3D2U472n1h0h/Screen%20shot%202010-12-10%20at%2010.59.17%20PM.png)
 
-
-## Installation
+### Installation
 
     $ gem install tmuxinator
 
-## Editor and Shell
+### Editor and Shell
 
 tmuxinator uses your shell's default editor for opening files.  If you're not sure what that is type:
 
@@ -22,16 +21,19 @@ If you want to change your default editor simple put a line in ~/.bashrc that ch
 
     export EDITOR='mate -w'
 
-## Environment Integration
+
+### Environment Integration
 
 Add this to your ~/.bashrc (or similar)
 
-[[ -s $HOME/.tmuxinator/scripts/tmuxinator ]] && source $HOME/.tmuxinator/scripts/tmuxinator
+    [[ -s $HOME/.tmuxinator/scripts/tmuxinator ]] && source $HOME/.tmuxinator/scripts/tmuxinator
 
-## Usage
+For command line completion you can source the `tmuxinator_completion` file, which is in the same directory as
+`tmuxinator` binary file. That will auto-complete `tmuxinator` commands, plus your `.yml` config files.
 
+### Usage
 
-### Create a project ###
+#### Create a project
 
     $ tmuxinator new project_name
 
@@ -42,6 +44,7 @@ Create or edit your projects with this command, for editing you can also use `tm
 
     project_name: Tmuxinator
     project_root: ~/code/rails_project
+    socket_name: foo # Not needed. Remove to use default socket
     rvm: 1.9.2@rails_project
     pre: sudo /etc/rc.d/mysqld start
     tabs:
@@ -65,7 +68,7 @@ If you want to have your own default config, place it into $HOME/.tmuxinator/def
 
 The `pre` command allows you to run anything before starting the tmux session. Could be handy to make sure you database daemons are running. Multiple commands can be specified, just like for tabs.
 
-## Panes Support
+### Panes Support
 you can define your own panes inside a window likes this:
 
     - window_with_panes
@@ -75,20 +78,19 @@ you can define your own panes inside a window likes this:
           - #empty, will just run plain bash
           - top
 
-
-## Starting a project
+### Starting a project
 
     $ start_[project_name]
 
-## Shorthand
+### Shorthand
 
-You can also use this shorthand alias for tmuxinator 
+You can also use this shorthand alias for tmuxinator
 
     $ mux [command/project_name]
 
 This will fire up tmux with all the tabs you configured.
 
-## Other Commands
+### Other Commands
 
     $ tmuxinator copy existing_project new_project
 
@@ -109,7 +111,7 @@ Remove a project
 
 Remove all tmuxinator configs, aliases and scripts. aliased to `i`
 
-	$ tmuxinator doctor
+    $ tmuxinator doctor
 
 Examines your environment and identifies problems with your configuration
 
@@ -123,41 +125,41 @@ shows tmuxinator's version. aliased to `v`
 
 shows tmuxinator's help. aliased to `h`
 
-## Questions? Comments? Feature Request?
+### Questions? Comments? Feature Request?
 
-I would love to hear your feedback on this project!  Send me a message!
+I would love to hear your feedback on this project! head over to [issues](https://github.com/aziz/tmuxinator/issues)
+section and make a ticket.
 
-## Contributors:
+### Contributors
 
-* [Aaron Spiegel](https://github.com/spiegela)
-* [Jay Adkisson](https://github.com/jayferd)
-* [Chris Lerum](https://github.com/chrislerum)
-* [David Bolton](https://github.com/lightningdb)
-* [Thibault Duplessis](https://github.com/ornicar)
-* [Ian Yang](https://github.com/doitian)
-* [Bjørn Arild Mæland](https://github.com/bmaland)
-* [Dane O'Connor](https://github.com/thedeeno)
-* [Eric Marden](https://github.com/xentek)
+[See the full list of contributors](https://github.com/aziz/tmuxinator/contributors)
 
+### History
+#### v. 0.5.0
+* Added optional socket name support (Thanks to Adam Walters)
+* Added auto completion (Thanks to Jose Pablo Barrantes)
 
-## History
-###v. 0.4.0
+####v. 0.4.0
 * Does not crash if given an invalid yaml file format. report it and exit gracefully.
 * Removed clunky scripts & shell aliases (Thanks to Dane O'Connor)
 * Config files are now rendered JIT (Thanks to Dane O'Connor)
 * Can now start sessions from cli (Thanks to Dane O'Connor)
 
-###v. 0.3.0
+####v. 0.3.0
 * Added pre command (Thanks to Ian Yang)
 * Added multiple pre command (Thanks to Bjørn Arild Mæland)
 * Using tmux set default-path for project root
 * New aliases
 
-###v. 0.2.0
+####v. 0.2.0
 * added pane support (Thanks to Aaron Spiegel)
 * RVM support (Thanks to Jay Adkisoon)
 
-## Contributing to tmuxinator
+### Inspiration and Thanks
+
+Inspired by Jon Druse's ([Screeninator](https://github.com/jondruse/screeninator)) and Arthur Chiu's ([Terminitor](http://github.com/achiu/terminitor))
+
+### Contributing to tmuxinator
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -165,8 +167,9 @@ I would love to hear your feedback on this project!  Send me a message!
 * Start a feature/bugfix branch
 * Commit and push until you are happy with your contribution
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is
+  otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-## Copyright
+### Copyright
 
-Copyright (c) 2010 Allen Bargi. See LICENSE.txt for further details.
+Copyright (c) 2010--2011 Allen Bargi. See LICENSE.txt for further details.

data/TODO

@@ -0,0 +1,4 @@
+- no need to create .tmuxinator
+- Adding support for specifying global tmux options https://github.com/jbettcher/tmuxinator/commit/6f2cf2ec67ff018e1d629e4eae6421287e190086
+- release the iterminator version of this
+- flush the issues

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/bin/tmuxinator_completion

@@ -0,0 +1,29 @@
+#!/usr/bin/env bash
+
+# Tmuxinator command line completion.
+
+have=$(command -v tmuxinator)
+
+test -n "$have" &&
+_tmuxinator_commands_complete()
+{
+  COMPREPLY=()
+  if [ $COMP_CWORD = 1 ]; then
+    local commands="open copy delete update_scripts implode list doctor help version"
+    COMPREPLY=(`compgen -W "$commands" -- $2`)
+  fi
+  return 0
+}
+
+_tmuxinator_open_complete()
+{
+  COMPREPLY=()
+  if [ $COMP_CWORD = 1 ]; then
+    local configs=`find ~/.tmuxinator/ -name *.yml | cut -d/ -f5 | sed s:.yml::g`
+    COMPREPLY=(`compgen -W "$configs" -- $2`)
+  fi
+  return 0
+}
+
+complete -F _tmuxinator_commands_complete -o default tmuxinator mux
+complete -F _tmuxinator_open_complete -o default muxo

data/lib/tmuxinator/assets/sample.yml

@@ -3,6 +3,7 @@
 
 project_name: Tmuxinator
 project_root: ~/code/rails_project
+socket_name: foo # Not needed.  Remove to use default socket
 rvm: 1.9.2@rails_project
 pre: sudo /etc/rc.d/mysqld start
 tabs:

data/lib/tmuxinator/assets/tmux_config.tmux

@@ -1,14 +1,14 @@
 #!<%= ENV['SHELL'] || '/bin/bash' %>
-tmux start-server
+tmux <%= socket %> start-server
 
-if ! $(tmux has-session -t <%=s @project_name %>); then
+if ! $(tmux <%= socket %> has-session -t <%=s @project_name %>); then
 cd <%= @project_root || "." %>
 <%= @pre.kind_of?(Array) ? @pre.join(" && ") : @pre %>
-env TMUX= tmux start-server \; set-option -g base-index 1 \; new-session -d -s <%=s @project_name %> -n <%=s @tabs[0].name %>
-tmux set-option -t <%=s @project_name %> default-path <%= @project_root %>
+env TMUX= tmux <%= socket %> start-server \; set-option -g base-index 1 \; new-session -d -s <%=s @project_name %> -n <%=s @tabs[0].name %>
+tmux <%= socket %> set-option -t <%=s @project_name %> default-path <%= @project_root %>
 
 <% @tabs[1..-1].each_with_index do |tab, i| %>
-tmux new-window -t <%= window(i+2) %> -n <%=s tab.name %>
+tmux <%= socket %> new-window -t <%= window(i+2) %> -n <%=s tab.name %>
 <% end %>
 
 # set up tabs and panes
@@ -19,19 +19,19 @@ tmux new-window -t <%= window(i+2) %> -n <%=s tab.name %>
 <%   elsif tab.panes %>
 <%=    send_keys(tab.panes.shift, i+1) %>
 <%     tab.panes.each do |pane| %>
-tmux splitw -t <%= window(i+1) %>
+tmux <%= socket %> splitw -t <%= window(i+1) %>
 <%=      send_keys(pane, i+1) %>
 <%     end %>
-tmux select-layout -t <%= window(i+1) %> <%=s tab.layout %>
+tmux <%= socket %> select-layout -t <%= window(i+1) %> <%=s tab.layout %>
 <%   end %>
 <% end %>
 
-tmux select-window -t <%= window(1) %>
+tmux <%= socket %> select-window -t <%= window(1) %>
 
 fi
 
 if [ -z $TMUX ]; then
-    tmux -u attach-session -t <%=s @project_name %>
+    tmux <%= socket %> -u attach-session -t <%=s @project_name %>
 else
-    tmux -u switch-client -t <%=s @project_name %>
-fi
+    tmux <%= socket %> -u switch-client -t <%=s @project_name %>
+fi

data/lib/tmuxinator/cli.rb

@@ -35,11 +35,11 @@ module Tmuxinator
   list [-v]
       list all existing projects
   doctor
-	  look for problems in your configuration
+    look for problems in your configuration
   help
       shows this help document
   version
-
+      shows tmuxinator version number
 }
       end
       alias :help :usage
@@ -52,7 +52,7 @@ module Tmuxinator
         @name = args.shift
         config_path = "#{root_dir}#{@name}.yml"
         unless File.exists?(config_path)
-          template = File.exists?(user_config) ? user_config : "#{File.dirname(__FILE__)}/assets/sample.yml"
+          template = File.exists?(user_config) ? user_config : sample_config
           erb      = ERB.new(File.read(template)).result(binding)
           tmp      = File.open(config_path, 'w') {|f| f.write(erb) }
         end
@@ -155,6 +155,8 @@ module Tmuxinator
       private #==============================
 
       def root_dir
+        # create ~/.tmuxinator directory if it doesn't exist
+        Dir.mkdir("#{ENV["HOME"]}/.tmuxinator/") unless File.directory?(File.expand_path("~/.tmuxinator"))
         "#{ENV["HOME"]}/.tmuxinator/"
       end
 

data/lib/tmuxinator/config_writer.rb

@@ -28,10 +28,14 @@ module Tmuxinator
       "#{root_dir}#{file_name}.tmux" if file_name
     end
 
+    def socket
+      "-L #{@socket_name}" if @socket_name
+    end
+
     private
 
     def root_dir
-      "#{ENV["HOME"]}/.tmuxinator/"
+      "$HOME/.tmuxinator/"
     end
 
     def process_config!
@@ -50,6 +54,7 @@ module Tmuxinator
       @rvm          = yaml["rvm"]
       @pre          = build_command(yaml["pre"])
       @tabs         = []
+      @socket_name  = yaml['socket_name']
 
       yaml["tabs"].each do |tab|
         t       = OpenStruct.new
@@ -83,7 +88,7 @@ module Tmuxinator
 
     def send_keys cmd, window_number
       return '' unless cmd
-      "tmux send-keys -t #{window(window_number)} #{s cmd} C-m"
+      "tmux #{socket} send-keys -t #{window(window_number)} #{s cmd} C-m"
     end
 
     def build_command(value)

data/spec/tmuxinator_spec.rb

@@ -9,6 +9,7 @@ describe Tmuxinator::ConfigWriter do
     its(:tabs){ should be_nil }
     its(:config_path){ should be_nil }
     its(:pre){ should be_nil }
+    its(:socket){ should be_nil }
   end
 
   context "While Defining the filename on init" do
@@ -29,6 +30,7 @@ describe Tmuxinator::ConfigWriter do
     its(:rvm){ should eql '1.9.2@rails_project' }
     its(:tabs){ should be_an Array  }
     its(:pre){ should eql 'rvm use 1.9.2@rails_project && sudo /etc/rc.d/mysqld start' }
+    its(:socket){ should eql '-L foo' }
 
     let(:first_tab){ subject.tabs[0] }
 

data/tmuxinator.gemspec

@@ -5,14 +5,14 @@
 
 Gem::Specification.new do |s|
   s.name = "tmuxinator"
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Allen Bargi"]
-  s.date = "2011-09-15"
+  s.date = "2011-10-10"
   s.description = "Create and manage complex tmux sessions easily."
   s.email = "allen.bargi@gmail.com"
-  s.executables = ["mux", "tmuxinator"]
+  s.executables = ["mux", "tmuxinator", "tmuxinator_completion"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md",
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
     "VERSION",
     "bin/mux",
     "bin/tmuxinator",
+    "bin/tmuxinator_completion",
     "lib/tmuxinator.rb",
     "lib/tmuxinator/assets/sample.yml",
     "lib/tmuxinator/assets/tmux_config.tmux",
@@ -43,7 +44,7 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT"]
   s.post_install_message = "\n  __________________________________________________________\n  ..........................................................\n\n  Thank you for installing tmuxinator\n  Please be sure to to drop a line in your ~/.bashrc file, similar \n  to RVM if you've used that before:\n\n  [[ -s $HOME/.tmuxinator/scripts/tmuxinator ]] && source $HOME/.tmuxinator/scripts/tmuxinator\n  \n  also ensure that you've set these variables in your ENV:\n  \n  $EDITOR, $SHELL\n  \n  you can run `tmuxinator doctor` to make sure everything is set.\n  happy tmuxing with tmuxinator!\n\n  ..........................................................\n  __________________________________________________________\n  \n  "
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.11"
   s.summary = "Create and manage complex tmux sessions easily."
 
   if s.respond_to? :specification_version then

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tmuxinator
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-15 00:00:00.000000000Z
+date: 2011-10-10 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70303485891940 !ruby/object:Gem::Requirement
+  requirement: &70349397703380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70303485891940
+  version_requirements: *70349397703380
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70303485890000 !ruby/object:Gem::Requirement
+  requirement: &70349397702580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.18
   type: :development
   prerelease: false
-  version_requirements: *70303485890000
+  version_requirements: *70349397702580
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70303485888060 !ruby/object:Gem::Requirement
+  requirement: &70349397701780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70303485888060
+  version_requirements: *70349397701780
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70303485886260 !ruby/object:Gem::Requirement
+  requirement: &70349397701040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,12 +54,13 @@ dependencies:
         version: 0.9.10
   type: :development
   prerelease: false
-  version_requirements: *70303485886260
+  version_requirements: *70349397701040
 description: Create and manage complex tmux sessions easily.
 email: allen.bargi@gmail.com
 executables:
 - mux
 - tmuxinator
+- tmuxinator_completion
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
@@ -76,6 +77,7 @@ files:
 - VERSION
 - bin/mux
 - bin/tmuxinator
+- bin/tmuxinator_completion
 - lib/tmuxinator.rb
 - lib/tmuxinator/assets/sample.yml
 - lib/tmuxinator/assets/tmux_config.tmux
@@ -108,7 +110,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3765836133335404318
+      hash: -770502179952499709
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -117,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Create and manage complex tmux sessions easily.