tmuxinator 0.1.6 → 0.2.0

data/README.md

@@ -42,6 +42,7 @@ Create or edit your projects with this command. aliased to `o`. Your default edi
 
     project_name: tmuxinator
     project_root: ~/code/rails_project
+    rvm: 1.9.2@rails_project
     tabs:
       - shell: git pull
       - database: rails db
@@ -50,12 +51,26 @@ Create or edit your projects with this command. aliased to `o`. Your default edi
         - cd logs
         - tail -f development.log
       - ssh: ssh me@myhost
-
+      - window_with_panes
+          layout: main-vertical
+          panes:
+            - vim
+            - #empty, will just run plain bash
+            - top
 
 If a tab contains multiple commands, they will be 'joined' together with '&&'.
-
 If you want to have your own default config, place it into $HOME/.tmuxinator/default.yml
 
+## Panes Support
+you can define your own panes inside a window likes this:
+
+    - window_with_panes
+        layout: main-vertical
+        panes:
+          - vim
+          - #empty, will just run plain bash
+          - top
+
 
 ## Starting a project
 
@@ -111,6 +126,19 @@ shows tmuxinator's help. aliased to `h`
 
 I would love to hear your feedback on this project!  Send me a message!
 
+## 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)
+
+## History
+###v. 0.2.0
+* added pane support (Thanks to Aaron Spiegel)
+* RVM support (Thanks to Jay Adkisoon)
+
 ## 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
@@ -123,4 +151,4 @@ I would love to hear your feedback on this project!  Send me a message!
 
 ## Copyright
 
-Copyright (c) 2010 Allen Bargi. See LICENSE.txt for further details.
+Copyright (c) 2010 Allen Bargi. See LICENSE.txt for further details.

data/TODO

@@ -1,3 +1,9 @@
+Add contributors
+
+Features:
+pane 
+RVM
+
 Later:
 x. support panes
 x. install theme

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.2.0

data/lib/tmuxinator.rb

@@ -5,5 +5,7 @@ require 'tmuxinator/helper'
 require 'tmuxinator/cli'
 require 'tmuxinator/config_writer'
 
+TMUX_TEMPLATE  = "#{File.dirname(__FILE__)}/tmuxinator/assets/tmux_config.tmux"
+
 module Tmuxinator
 end

data/lib/tmuxinator/assets/sample.yml

@@ -3,7 +3,14 @@
 
 project_name: Tmuxinator
 project_root: ~/code/rails_project
+rvm: 1.9.2@rails_project
 tabs:
+  - editor:
+      layout: main-vertical
+      panes:
+        - vim
+        - #empty, will just run plain bash
+        - top
   - shell: git pull
   - database: rails db
   - server: rails s

data/lib/tmuxinator/assets/tmux_config.tmux

@@ -1,23 +1,37 @@
-cd <%= @project_root %>
+#!<%= ENV['SHELL'] || '/bin/bash' %>
+cd <%=s @project_root %>
 tmux start-server
 
-if ! $(tmux has-session -t <%= @project_name %>); then
+if ! $(tmux has-session -t <%=s @project_name %>); then
 
+tmux new-session -d -s <%=s @project_name %> -n <%=s @tabs[0].name %>
 tmux set-option base-index 1
-tmux new-session -d -s <%= @project_name %> -n <%= @tabs[0].name %>
 
-<% @tabs.each do |tab| %>
-  <% unless @tabs.index(tab) == 0 %>
-tmux new-window -t <%= @project_name %>:<%= @tabs.index(tab) + 1 %> -n <%= tab.name %>
-  <% end %>
+<% @tabs[1..-1].each_with_index do |tab, i| %>
+tmux new-window -t <%= window(i+2) %> -n <%=s tab.name %>
 <% end %>
 
-<% @tabs.each do |tab| %>
-tmux send-keys  -t <%= @project_name %>:<%= @tabs.index(tab) + 1 %> '<%= tab.stuff %>' C-m
+# set up tabs and panes
+<% @tabs.each_with_index do |tab, i| %>
+# tab "<%= tab.name %>"
+<%   if tab.command %>
+<%=    send_keys(tab.command, i+1) %>
+<%   elsif tab.panes %>
+<%=    send_keys(tab.panes.shift, i+1) %>
+<%     tab.panes.each do |pane| %>
+tmux splitw -t <%= window(i+1) %>
+<%=      send_keys(pane, i+1) %>
+<%     end %>
+tmux select-layout -t <%= window(i+1) %> <%=s tab.layout %>
+<%   end %>
 <% end %>
 
-tmux select-window -t <%= @project_name %>:1
+tmux select-window -t <%= window(1) %>
 
 fi
 
-tmux -u attach-session -t <%= @project_name %>
+if [ -z $TMUX ]; then
+    tmux -u attach-session -t <%=s @project_name %>
+else
+    tmux -u switch-client -t <%=s @project_name %>
+fi

data/lib/tmuxinator/cli.rb

@@ -6,7 +6,7 @@ module Tmuxinator
     class << self
       include Tmuxinator::Helper
 
-      def start(*args)
+      def start *args
         if args.empty?
           self.usage
         else
@@ -40,7 +40,7 @@ module Tmuxinator
       alias :h :usage
 
       # Open a config file, it's created if it doesn't exist already.
-      def open(*args)
+      def open *args
         exit!("You must specify a name for the new project") unless args.size > 0
         puts "warning: passing multiple arguments to open will be ignored" if args.size > 1
         @name = args.shift
@@ -56,7 +56,7 @@ module Tmuxinator
       end
       alias :o :open
 
-      def copy(*args)
+      def copy *args
         @copy = args.shift
         @name = args.shift
         @config_to_copy = "#{root_dir}#{@copy}.yml"
@@ -72,11 +72,11 @@ module Tmuxinator
             puts "Overwriting #{@name}"
           end
         end
-        open(@name)
+        open @name
       end
       alias :c :copy
 
-      def delete(*args)
+      def delete *args
         puts "warning: passing multiple arguments to delete will be ignored" if args.size > 1
         filename  = args.shift
         file_path = "#{root_dir}#{filename}.yml"
@@ -92,7 +92,7 @@ module Tmuxinator
       end
       alias :d :delete
 
-      def implode(*args)
+      def implode *args
         exit!("delete_all doesn't accapt any arguments!") unless args.empty?
         confirm!("Are you sure you want to delete all tmuxinator configs? (type yes or no):") do
           FileUtils.remove_dir(root_dir)
@@ -101,7 +101,7 @@ module Tmuxinator
       end
       alias :i :implode
 
-      def list(*args)
+      def list *args
         verbose = args.include?("-v")
         puts "tmuxinator configs:"
         Dir["#{root_dir}**"].each do |path|
@@ -123,7 +123,6 @@ module Tmuxinator
         Dir["#{root_dir}*.tmux"].each {|p| FileUtils.rm(p) }
         aliases = []
         Dir["#{root_dir}*.yml"].each do |path|
-          path = File.basename(path, '.yml')
           aliases << Tmuxinator::ConfigWriter.new(path).write!
         end
         Tmuxinator::ConfigWriter.write_aliases(aliases)
@@ -145,7 +144,7 @@ module Tmuxinator
 }
       end
 
-      def method_missing(method, *args, &block)
+      def method_missing method, *args, &block
         puts "There's no command called #{method} in tmuxinator"
         usage
       end

data/lib/tmuxinator/config_writer.rb

@@ -1,26 +1,34 @@
 module Tmuxinator
   
   class ConfigWriter
+    attr :file_name, :file_path, :project_name, :project_root, :rvm, :tabs
     
     include Tmuxinator::Helper
     
-    def self.write_aliases(aliases)
+    def self.write_aliases aliases
       File.open("#{ENV["HOME"]}/.tmuxinator/scripts/tmuxinator", 'w') {|f| f.write(aliases.join("\n")) }
     end
     
-    def initialize(filename)
-      @filename  = filename
-      @file_path = "#{root_dir}#{@filename}.yml"
-      process_config!
+    def initialize this_full_path=nil
+      self.file_path = this_full_path if this_full_path
+    end
+    
+    def file_path= full_path
+      @file_path = full_path
+      @file_name = File.basename full_path, '.yml'
+      process_config! if full_path && File.exist?(full_path)
     end
     
     def write!
-      template    = "#{File.dirname(__FILE__)}/assets/tmux_config.tmux"
-      erb         = ERB.new(IO.read(template)).result(binding)
-      config_path = "#{root_dir}#{@filename}.tmux"
+      raise "Unable to write with out a file_name defined" unless self.file_name
+      erb         = ERB.new(IO.read(TMUX_TEMPLATE)).result(binding)
       tmp         = File.open(config_path, 'w') {|f| f.write(erb) }
       
-      "alias start_#{@filename}='$SHELL #{config_path}'"
+      "alias start_#{file_name}='$SHELL #{config_path}'"
+    end
+    
+    def config_path
+      "#{root_dir}#{file_name}.tmux" if file_name
     end
     
     private
@@ -30,7 +38,7 @@ module Tmuxinator
     end
     
     def process_config!
-      yaml = YAML.load(File.read(@file_path))
+      yaml = YAML.load(File.read(file_path))
 
       exit!("Your configuration file should include some tabs.")        if yaml["tabs"].nil?
       exit!("Your configuration file didn't specify a 'project_root'")  if yaml["project_root"].nil?
@@ -38,21 +46,55 @@ module Tmuxinator
       
       @project_name = yaml["project_name"]
       @project_root = yaml["project_root"]
+      @rvm          = yaml["rvm"]
       @tabs         = []
       
       yaml["tabs"].each do |tab|
         t       = OpenStruct.new
         t.name  = tab.keys.first
         value   = tab.values.first
-        t.stuff = value.is_a?(Array) ? value.join(" && ") : value
+        case value
+        when Array
+          value.unshift "rvm use #{@rvm}" if @rvm
+          t.command = value.join(" && ")
+        when String
+          value = "rvm use #{@rvm} && #{value}" if @rvm
+          t.command = value
+        when Hash
+          t.panes = (value["panes"] || ['']).map do |pane|
+            if pane.is_a? Array
+              pane.unshift! "rvm use #{@rvm}" if @rvm
+              pane = pane.join(' && ')
+            end
+            pane = "rvm use #{@rvm} && #{pane}" if @rvm
+            pane
+          end
+          t.layout = value["layout"]
+        end
         @tabs << t
       end
-      
+    end
+
+    def parse_tabs tab_list
     end
     
-    def write_alias(stuff)
+    def write_alias stuff
       File.open("#{root_dir}scripts/#{@filename}", 'w') {|f| f.write(stuff) }
     end
+
+    def shell_escape str
+      "'#{str.to_s.gsub("'") { %('\'') }}'"
+    end
+    alias s shell_escape
+
+    def window(i)
+      "#{s @project_name}:#{i}"
+    end
+
+    def send_keys cmd, window_number
+      return '' unless cmd
+      "tmux send-keys -t #{window(window_number)} #{s cmd} C-m"
+    end
   end
   
-end
+end

data/spec/spec_helper.rb

@@ -7,6 +7,8 @@ require 'tmuxinator'
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
+SAMPLE_CONFIG = File.join(File.dirname(__FILE__), '..', 'lib', 'tmuxinator', 'assets', 'sample.yml')
+
 RSpec.configure do |config|
   
 end

data/spec/tmuxinator_spec.rb

@@ -1,7 +1,50 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe "Tmuxinator" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+describe Tmuxinator::ConfigWriter do
+  context "With no defined filename" do
+    its(:file_path){ should be_nil }
+    its(:project_name){ should be_nil }
+    its(:project_root){ should be_nil }
+    its(:rvm){ should be_nil }
+    its(:tabs){ should be_nil }
+    its(:config_path){ should be_nil }
+  end
+  
+  context "While Defining the filename on init" do
+    subject{ Tmuxinator::ConfigWriter.new(SAMPLE_CONFIG) }
+    its(:file_path){ should eql SAMPLE_CONFIG }
+    its(:file_name){ should eql "sample" }
+  end
+  
+  context "After filename has been defined" do
+    before do
+      subject.file_path = SAMPLE_CONFIG
+    end
+    
+    its(:file_path){ should eql SAMPLE_CONFIG }
+    its(:file_name){ should eql File.basename(SAMPLE_CONFIG, '.yml')}
+    its(:project_name){ should eql 'Tmuxinator' }
+    its(:project_root){ should eql '~/code/rails_project' }
+    its(:rvm){ should eql '1.9.2@rails_project' }
+    its(:tabs){ should be_an Array  }
+    
+    let(:first_tab){ subject.tabs[0] }
+    
+    specify{ first_tab.should be_an OpenStruct }
+    specify{ first_tab.name.should eql "editor" }
+    specify{ first_tab.layout.should eql "main-vertical" }
+    specify{ first_tab.panes.should be_an Array }
+    
+    it "should prepend each pane with the rvm string" do
+      first_tab.panes.map{|p| p.split(/ && /)[0] }.should eql ["rvm use 1.9.2@rails_project"] * 3
+    end
+    
+    it "should append each pane with the command string" do
+      first_tab.panes.map{|p| p.split(/ && /)[1] }.should eql ["vim", nil, "top"]
+    end
+    
+    let(:second_tab){ subject.tabs[1] }
+    specify{ second_tab.name.should eql "shell" }
+    specify{ second_tab.command.should eql "rvm use 1.9.2@rails_project && git pull"}
   end
 end

data/tmuxinator.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tmuxinator}
-  s.version = "0.1.6"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Allen Bargi"]
-  s.date = %q{2011-02-02}
+  s.date = %q{2011-03-08}
   s.default_executable = %q{tmuxinator}
   s.description = %q{Create and manage complex tmux sessions easily.}
   s.email = %q{allen.bargi@gmail.com}
@@ -63,7 +63,7 @@ Gem::Specification.new do |s|
   
   }
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.0}
+  s.rubygems_version = %q{1.6.1}
   s.summary = %q{Create and manage complex tmux sessions easily.}
   s.test_files = [
     "spec/spec_helper.rb",

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 6
-  version: 0.1.6
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Allen Bargi
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-02 00:00:00 +01:00
+date: 2011-03-08 00:00:00 +01:00
 default_executable: tmuxinator
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,8 +31,8 @@ dependencies:
         - 1
         - 0
         version: 2.1.0
-  name: rspec
   version_requirements: *id001
+  name: rspec
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
@@ -47,8 +47,8 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  name: bundler
   version_requirements: *id002
+  name: bundler
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
@@ -63,8 +63,8 @@ dependencies:
         - 5
         - 1
         version: 1.5.1
-  name: jeweler
   version_requirements: *id003
+  name: jeweler
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
@@ -77,8 +77,8 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: rcov
   version_requirements: *id004
+  name: rcov
   prerelease: false
 description: Create and manage complex tmux sessions easily.
 email: allen.bargi@gmail.com
@@ -140,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.6.1
 signing_key: 
 specification_version: 3
 summary: Create and manage complex tmux sessions easily.