tmuxinator 0.5.0 → 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c72488b63a209871431234e08cab3d8e4de46429
+  data.tar.gz: 32b983eff05dc7171872ad9d49f37e179e0e5baf
+SHA512:
+  metadata.gz: c2e491f97e5ba428c3284a4afe19abca683fc10b41a560e10a747d44f81bf3ca8da1460705703445aff33aa8d70ec59ec0ab7214365f3541feb3f45f025daf6b
+  data.tar.gz: 12d830182076112c8e188f2a784433a117b993ee0fc523e9d2ce70063fef9576a554736a52fed0f1e45caeaac9396e6b128f590c9fac59f5c4432b83448af173

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.coveralls.yml
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+tmp
+db

data/.rspec

@@ -1 +1 @@
---color
+--color --format=nested

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+script: bundle exec rspec spec

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+## 0.6.0
+
+- Rewrote core functionality with proper abstractions and unit tests
+- Fixed outstanding bugs #72 #89 #90 #93 #101 #102 #103 #104 #109
+- Switched to thor for command line argument parsing
+- Switched to Erubis for more Rails like ERB
+- Added simplecov for test coverage
+- Added debug command line option to view generated shell commands
+- Added commands and completion options for completion scripts
+- Added `pre_window` option for running commands before all panes and windows
+- Deprecated `rbenv` in favour of `pre_window`
+- Deprecated `rvm` in favour of `pre_window`
+- Deprecated `cli_args` in favour of `tmux_options`
+- Deprecated `tabs` in favour of `windows`
+- Dropped support for Ruby 1.9.2
+
+## 0.5.0
+- Added optional socket name support (Thanks to Adam Walters)
+- Added auto completion (Thanks to Jose Pablo Barrantes)
+
+## 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)
+
+## 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
+
+## 0.2.0
+- Added pane support (Thanks to Aaron Spiegel)
+- RVM support (Thanks to Jay Adkisoon)
+

data/CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Contributing
+
+## First
+
+* Check if the issue you're going to submit isn't already submitted in
+  the [Issues](https://github.com/aziz/tmuxinator/issues) page.
+
+## Issues
+
+* Submit a ticket for your issue, assuming one does not already exist.
+* The issue must:
+  * Clearly describe the problem including steps to reproduce when it is a bug.
+  * Also include all the information you can to make it easier for us to reproduce it,
+    like OS version, gem versions, rbenv or rvm versions etc...
+  * Even better, provide a failing test case for it.
+
+## Pull Requests
+
+If you've gone the extra mile and have a patch that fixes the issue, you
+should submit a Pull Request!
+
+* Fork the repo on Github.
+* Create a topic branch from where you want to base your work.
+* Add a test for your change. Only refactoring and documentation changes
+  require no new tests. If you are adding functionality or fixing a bug,
+  we need a test!
+* Run _all_ the tests to assure nothine else was broken. We only take pull requests with passing tests.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Push to your fork and submit a pull request.

data/Gemfile

@@ -1,8 +1,5 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
-group :development do
-  gem "rspec",   "~> 2.6.0"
-  gem "bundler", "~> 1.0.18"
-  gem "jeweler", "~> 1.6.4"
-  gem "rcov",    "~> 0.9.10"
-end
+
+# Specify your gem's dependencies in tmuxinator.gemspec
+gemspec

data/{LICENSE.txt → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Allen Bargi
+Copyright (c) 2010-2012 Allen Bargi
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,4 +1,4 @@
-# Tmuxinator
+# Tmuxinator [![Build Status](https://secure.travis-ci.org/aziz/tmuxinator.png)](http://travis-ci.org/aziz/tmuxinator?branch=master) [![Coverage Status](https://coveralls.io/repos/aziz/tmuxinator/badge.png)](https://coveralls.io/r/aziz/tmuxinator) [![Code Climate](https://codeclimate.com/github/aziz/tmuxinator.png)](https://codeclimate.com/github/aziz/tmuxinator) [![Dependency Status](https://gemnasium.com/aziz/tmuxinator.png)](https://gemnasium.com/aziz/tmuxinator)
 
 Create and manage tmux sessions easily.
 
@@ -6,170 +6,180 @@ Create and manage tmux sessions easily.
 
 ![Screenshot](http://f.cl.ly/items/3e3I1l1t3D2U472n1h0h/Screen%20shot%202010-12-10%20at%2010.59.17%20PM.png)
 
-### Installation
+## Installation
 
-    $ gem install tmuxinator
+``` bash
+$ 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:
+tmuxinator uses your shell's default editor for opening files.  If you're not
+sure what that is type:
 
-    $ echo $EDITOR
+``` bash
+$ echo $EDITOR
+```
 
-For me that produces "mate -w"
-If you want to change your default editor simple put a line in ~/.bashrc that changes it. Mine looks like this:
+For me that produces "vim" If you want to change your default editor simple
+put a line in ~/.bashrc that changes it. Mine looks like this:
 
-    export EDITOR='mate -w'
+``` bash
+export EDITOR='vim'
+```
 
+## Completion
 
-### Environment Integration
+Download the appropriate completion file from the repo.
 
-Add this to your ~/.bashrc (or similar)
+### bash
 
-    [[ -s $HOME/.tmuxinator/scripts/tmuxinator ]] && source $HOME/.tmuxinator/scripts/tmuxinator
+Add the following to your `~/.bashrc`:
 
-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.
+    source `which tmuxinator.zsh`
 
-### Usage
+### zsh
 
-#### Create a project
+Add the following to your `~/.zshrc`:
 
-    $ tmuxinator new project_name
+    source `which tmuxinator.zsh`
 
-Create or edit your projects with this command, for editing you can also use `tmuxinator open project_name`. `new` aliased to `o`,`open` and `n`. Your default editor ($EDITOR) is used to open the file. If this is a new project you will see this default config:
+## Usage
 
-    # ~/.tmuxinator/project_name.yml
-    # you can make as many tabs as you wish...
+### Create a project
 
-    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:
-      - editor:
-          layout: main-vertical
-          panes:
-            - vim
-            - #empty, will just run plain bash
-            - top
-      - shell: git pull
-      - database: rails db
-      - server: rails s
-      - logs: tail -f logs/development.log
-      - console: rails c
-      - capistrano:
-      - server: ssh me@myhost
+Create or edit your projects with:
 
+``` bash
+$ tmuxinator new [project]
+```
 
-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
+For editing you can also use `tmuxinator open [project]`. `new` is aliased to
+`o`,`open` and `n`. Your default editor (`$EDITOR`) is used to open the file.
+If this is a new project you will see this default config:
 
-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.
+``` yaml
+name: Tmuxinator
+root: ~/Code/tmuxinator
+socket_name: foo # Remove to use default socket
+pre: sudo /etc/rc.d/mysqld start # Runs before everything
+pre_window: rbenv shell 2.0.0-p247 # Runs in each tab and pane
+tmux_options: -v -2 # Pass arguments to tmux
+windows:
+  - editor:
+      layout: main-vertical
+      panes:
+        - vim
+        - #empty, will just run plain bash
+        - top
+  - shell: git pull
+  - database: rails db
+  - server: rails s
+  - logs: tail -f logs/development.log
+  - console: rails c
+  - capistrano:
+  - server: ssh me@myhost
+```
 
-### Panes Support
-you can define your own panes inside a window likes this:
+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`
 
-    - window_with_panes
-        layout: main-vertical
-        panes:
-          - vim
-          - #empty, will just run plain bash
-          - top
+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.
 
-### Starting a project
+## Panes Support
 
-    $ start_[project_name]
+You can define your own panes inside a window likes this:
 
-### Shorthand
+``` yaml
+- window_with_panes
+    layout: main-vertical
+    panes:
+      - vim
+      - #empty, will just run plain bash
+      - top
+```
 
-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
-
-    $ tmuxinator copy existing_project new_project
-
-Copy an existing project. aliased to `c`
-
-
-    $ tmuxinator list
+The layout setting gets handed down to tmux directly, so you can choose from
+one of [the five standard
+layouts](http://manpages.ubuntu.com/manpages/precise/en/man1/tmux.1.html#contenttoc6)
+or [specify your own](http://stackoverflow.com/a/9976282/183537).
 
-List all the projects you have configured. aliased to `l`
+## Starting a session
 
+This will fire up tmux with all the tabs and panes you configured.
 
-    $ tmuxinator delete project_name
+``` bash
+$ tmuinxator start [project]
+```
 
-Remove a project
-
-
-    $ tmuxinator implode
-
-Remove all tmuxinator configs, aliases and scripts. aliased to `i`
-
-    $ tmuxinator doctor
-
-Examines your environment and identifies problems with your configuration
+## Shorthand
 
+You can also use this shorthand alias for tmuxinator
 
-    $ tmuxinator version
+``` bash
+$ mux [command]
+```
 
-shows tmuxinator's version. aliased to `v`
+## Interpreter Managers & Environment Variables
 
+To use tmuxinator with rbenv, RVM, NVM etc, use the `pre_tab` option.
 
-    $ tmuxinator help
+```
+pre_tab: rbenv shell 2.0.0-p247
+```
 
-shows tmuxinator's help. aliased to `h`
+These commands will run before any pane or window.
 
-### Questions? Comments? Feature Request?
+## Other Commands
 
-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.
+Copy an existing project. Aliased to `c` and `cp`
+``` bash
+$ tmuxinator copy [existing] [new]
+```
 
-### Contributors
+List all the projects you have configured. Aliased to `l` and `ls`
 
-[See the full list of contributors](https://github.com/aziz/tmuxinator/contributors)
+``` bash
+$ tmuxinator list
+```
 
-### History
-#### v. 0.5.0
-* Added optional socket name support (Thanks to Adam Walters)
-* Added auto completion (Thanks to Jose Pablo Barrantes)
+Remove a project. Aliased to `rm`
+``` bash
+$ tmuxinator delete [project]
+```
 
-####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)
+Remove all tmuxinator configs, aliases and scripts. Aliased to `i`
+``` bash
+$ tmuxinator implode
+```
 
-####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
+Examines your environment and identifies problems with your configuration
+``` bash
+$ tmuxinator doctor
+```
 
-####v. 0.2.0
-* added pane support (Thanks to Aaron Spiegel)
-* RVM support (Thanks to Jay Adkisoon)
+Shows tmuxinator's help. Aliased to `h`
+``` bash
+$ tmuxinator help
+```
 
-### Inspiration and Thanks
+Shows the shell commands that get executed for a project
+```bash
+$ tmuxinator debug [project]
+```
 
-Inspired by Jon Druse's ([Screeninator](https://github.com/jondruse/screeninator)) and Arthur Chiu's ([Terminitor](http://github.com/achiu/terminitor))
+Shows tmuxinator's version.
+``` bash
+$ tmuxinator version
+```
 
-### Contributing to tmuxinator
+## Contributing
 
-* 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
-* Fork the project
-* 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.
+To contribute, please read the [contributing guide](https://github.com/aziz/tmuxinator/blob/master/CONTRIBUTING.md).
 
-### Copyright
+## Copyright
 
-Copyright (c) 2010--2011 Allen Bargi. See LICENSE.txt for further details.
+Copyright (c) 2010-2013 Allen Bargi. See LICENSE for further details.

data/Rakefile

@@ -1,72 +1 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "tmuxinator"
-  gem.homepage = "http://github.com/aziz/tmuxinator"
-  gem.license = "MIT"
-  gem.summary = %Q{Create and manage complex tmux sessions easily.}
-  gem.description = %Q{Create and manage complex tmux sessions easily.}
-  gem.email = "allen.bargi@gmail.com"
-  gem.authors = ["Allen Bargi"]
-  gem.post_install_message = %{
-  __________________________________________________________
-  ..........................................................
-
-  Thank you for installing tmuxinator
-  Please be sure to to drop a line in your ~/.bashrc file, similar 
-  to RVM if you've used that before:
-
-  [[ -s $HOME/.tmuxinator/scripts/tmuxinator ]] && source $HOME/.tmuxinator/scripts/tmuxinator
-  
-  also ensure that you've set these variables in your ENV:
-  
-  $EDITOR, $SHELL
-  
-  you can run `tmuxinator doctor` to make sure everything is set.
-  happy tmuxing with tmuxinator!
-
-  ..........................................................
-  __________________________________________________________
-  
-  }
-  
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
-  #  gem.add_development_dependency 'rspec', '> 1.2.3'
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "tmuxinator #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require "bundler/gem_tasks"