tmuxinator 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78a605e6c1ca2f15a4e38232b48dfc576b3f0e8f
-  data.tar.gz: 750b9013143c741b0cadeb9ddccef2c20ce28ecf
+  metadata.gz: 6d9d7fb728f65009f6058f0810d48d28bbea8d78
+  data.tar.gz: 428a7e368197fdad498e10ba1af3fd63d4bdabd3
 SHA512:
-  metadata.gz: e24273e7128ff0fc956aa31f0f29e344e8930933b90f705b5ef36da0a10adf3ca109a5b1235899f87594b5b379210772bb836b93ee738b439f8df467c99acfdb
-  data.tar.gz: 8ad475904be0e362572c7f3a8fd81a5bbd5e53f199b44ea931668c79897b16dd701ab180c44e26ae37ebba0a3f8d01397b1e5a65637842bad16ea2e4e4dd2dfb
+  metadata.gz: f8ac28cc11f7a1ec80ec1a832d67d7a786e98d13396dbef493b6e5ea003a48822c4a55a23dac74d7a204875232013ec10d279a6872079673ae9170da76e1f328
+  data.tar.gz: 7889d60c7f2071f6c267bec80c7d13e6bc734bc991e154c530c3b230a742452b1674110ad1cee6e455ec02ac1ca98565fbcef1dad9f70e42be370a7ab9a0f507

data/.gitignore

@@ -16,3 +16,4 @@ spec/reports
 tmp
 db
 vendor/
+tags

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.6.5
+- Change deprecation continue message from any key to just the enter key
+- Dramatically clean up the readme to be clearer for new users
+- Update the contributing guide with references to the GitHub styleguide and add examples of how to leave good commit messages
+- Use Erubis to render the project sample and fix a bad binding reference
+- Update the sample project to be much simpler
+- Fix not working delete command #142
+- Fix an error in the bash completion script
+- Fix an issue where the wrong project path was being returned
+- Fix an issue where command aliases were being ignored
+
 ## 0.6.4
 - Fixes broken backwards compatibility of multiple pre commands #129
 - Fixes tmuxinator ignoring project root when started from within a tmux session #132

data/CONTRIBUTING.md

@@ -19,6 +19,8 @@
 If you've gone the extra mile and have a patch that fixes the issue, you
 should submit a Pull Request!
 
+* Please follow the [GitHub Styleguide](https://github.com/styleguide/ruby) for
+  Ruby in both implementation and tests!
 * 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
@@ -26,4 +28,15 @@ should submit a Pull Request!
   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.
+* Structure your commit messages like this:
+
+```
+Summarize clearly in one line what the commit is about
+
+Describe the problem the commit solves or the use
+case for a new feature. Justify why you chose
+the particular solution.
+```
+
+* Use "fix", "add", "change" instead of "fixed", "added", "changed" in your commit messages.
 * Push to your fork and submit a pull request.

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2012 Allen Bargi
+Copyright (c) 2010-2013 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

@@ -4,183 +4,205 @@
 
 Create and manage tmux sessions easily.
 
-### Example
-
-![Screenshot](http://f.cl.ly/items/3e3I1l1t3D2U472n1h0h/Screen%20shot%202010-12-10%20at%2010.59.17%20PM.png)
+![Screenshot](https://f.cloud.github.com/assets/141213/916084/065fef7c-fe82-11e2-9c23-a9622c7d83c3.png)
 
 ## Installation
 
-``` bash
-$ gem install tmuxinator
+```
+gem install tmuxinator
 ```
 
 ## Editor and Shell
 
-tmuxinator uses your shell's default editor for opening files.  If you're not
+tmuxinator uses your shell's default editor for opening files. If you're not
 sure what that is type:
 
 ``` bash
-$ echo $EDITOR
+echo $EDITOR
 ```
 
-For me that produces "vim" If you want to change your default editor simple
+For me that produces "vim" If you want to change your default editor simply
 put a line in ~/.bashrc that changes it. Mine looks like this:
 
-``` bash
+```
 export EDITOR='vim'
 ```
 
+## tmux
+
+The recommended version of tmux to use is 1.8. You're mileage may vary for
+earlier versions. Refer to the FAQ for any odd behaviour.
+
+### base-index
+
+If you use a `base-index` other than the default, please be sure to also set the `pane-base-index`
+
+```
+set-window-option -g pane-base-index 1
+```
+
 ## Completion
 
-Download the appropriate completion file from the repo.
+Download the appropriate completion file from the repo and `source` the file.
+The following are example where the completion file has been downloaded into
+`~/.bin`.
 
 ### bash
 
 Add the following to your `~/.bashrc`:
 
-    source `which tmuxinator.bash`
+    source ~/.bin/tmuxinator.bash
 
 ### zsh
 
 Add the following to your `~/.zshrc`:
 
-    source `which tmuxinator.zsh`
+    source ~/.bin/tmuxinator.zsh
 
 ## Usage
 
+A working knowledge of tmux is assumed. You should understand what window and
+panes are in tmux. If not please consult the [man pages](http://manpages.ubuntu.com/manpages/precise/en/man1/tmux.1.html#contenttoc6) for tmux.
+
 ### Create a project
 
 Create or edit your projects with:
 
-``` bash
-$ tmuxinator new [project]
+```
+tmuxinator new [project]
 ```
 
 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:
 
-``` 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
+```yaml
+# ~/.tmuxinator/sample.yml
+
+name: sample
+root: ~/
+
+# Optional. tmux socket
+# socket_name: foo
+
+# Runs before everything. Use it to start daemons etc.
+# pre: sudo /etc/rc.d/mysqld start
+
+# Runs in each window and pane before window/pane specific commands. Useful for setting up interpreter versions.
+# pre_window: rbenv shell 2.0.0-p247
+
+# Pass command line options to tmux. Useful for specifying a different tmux.conf.
+# tmux_options: -f ~/.tmux.mac.conf
+
 windows:
   - editor:
       layout: main-vertical
       panes:
         - vim
-        - #empty, will just run plain bash
-        - top
-  - shell: git pull
-  - database: rails db
-  - server: rails s
+        - guard
+  - server: bundle exec rails s
   - logs: tail -f logs/development.log
-  - console: rails c
-  - capistrano:
-  - server: ssh me@myhost
 ```
 
-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`
+## Windows
 
-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.
+The windows option allows the specfication of any number of tmux windows. Each window is denoted by a YAML array entry, followed by a name
+and command to be run.
+
+```
+windows:
+  - editor: vim
+```
 
-## Panes Support
+## Panes
 
-You can define your own panes inside a window likes this:
+Panes are optional and are children of window entries, but unlike windows, they do not need a name. In the following example, the `editor` window has 2 panes, one running vim, the other guard.
 
-``` yaml
-- window_with_panes
-    layout: main-vertical
-    panes:
-      - vim
-      - #empty, will just run plain bash
-      - top
+```yaml
+windows:
+  - editor:
+      layout: main-vertical
+      panes:
+        - vim
+        - guard
 ```
 
 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)
+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).
 
-## Starting a session
+## Interpreter Managers & Environment Variables
 
-This will fire up tmux with all the tabs and panes you configured.
+To use tmuxinator with rbenv, RVM, NVM etc, use the `pre_window` option.
 
-``` bash
-$ tmuxinator start [project]
+```
+pre_window: rbenv shell 2.0.0-p247
 ```
 
-## Shorthand
+These command(s) will run before any subsequent commands in all panes and windows.
 
-You can also use this shorthand alias for tmuxinator
 
-``` bash
-$ mux [command]
+## Starting a session
+
+This will fire up tmux with all the tabs and panes you configured.
+
+```
+tmuxinator start [project]
 ```
 
-## Interpreter Managers & Environment Variables
+## Shorthand
 
-To use tmuxinator with rbenv, RVM, NVM etc, use the `pre_window` option.
+An shorthand alias for tmuxinator can also be used.
 
 ```
-pre_window: rbenv shell 2.0.0-p247
+mux [command]
 ```
 
-These commands will run before any pane or window.
-
 ## Other Commands
 
 Copy an existing project. Aliased to `c` and `cp`
-``` bash
-$ tmuxinator copy [existing] [new]
+```
+tmuxinator copy [existing] [new]
 ```
 
 List all the projects you have configured. Aliased to `l` and `ls`
-
-``` bash
-$ tmuxinator list
+```
+tmuxinator list
 ```
 
 Remove a project. Aliased to `rm`
-``` bash
-$ tmuxinator delete [project]
+```
+tmuxinator delete [project]
 ```
 
 Remove all tmuxinator configs, aliases and scripts. Aliased to `i`
-``` bash
-$ tmuxinator implode
+```
+tmuxinator implode
 ```
 
 Examines your environment and identifies problems with your configuration
-``` bash
-$ tmuxinator doctor
+```
+tmuxinator doctor
 ```
 
 Shows tmuxinator's help. Aliased to `h`
-``` bash
-$ tmuxinator help
+```
+tmuxinator help
 ```
 
 Shows the shell commands that get executed for a project
-```bash
-$ tmuxinator debug [project]
+```
+tmuxinator debug [project]
 ```
 
 Shows tmuxinator's version.
-``` bash
-$ tmuxinator version
+```
+tmuxinator version
 ```
 
 ## FAQ
 
-### Window names are not displayed properly?
+### Window names are not displaying properly?
 
 Add `export DISABLE_AUTO_TITLE=true` to your `.zshrc` or `.bashrc`
 

data/bin/mux

@@ -4,8 +4,14 @@ $: << File.expand_path("../../lib/", __FILE__)
 require "thor"
 require "tmuxinator"
 
-if ARGV.length == 1 && (ARGV & Tmuxinator::Cli.new.command_list).empty?
-  Tmuxinator::Cli.new.start(ARGV[0])
+if ARGV.length == 1
+  name = ARGV[0]
+
+  if Tmuxinator::Config.exists?(name)
+    Tmuxinator::Cli.new.start(name)
+  else
+    Tmuxinator::Cli.start
+  end
 else
   Tmuxinator::Cli.start
 end

data/bin/tmuxinator

@@ -4,8 +4,14 @@ $: << File.expand_path("../../lib/", __FILE__)
 require "thor"
 require "tmuxinator"
 
-if ARGV.length == 1 && (ARGV & Tmuxinator::Cli.new.command_list).empty?
-  Tmuxinator::Cli.new.start(ARGV[0])
+if ARGV.length == 1
+  name = ARGV[0]
+
+  if Tmuxinator::Config.exists?(name)
+    Tmuxinator::Cli.new.start(name)
+  else
+    Tmuxinator::Cli.start
+  end
 else
   Tmuxinator::Cli.start
 end

data/completion/tmuxinator.bash

@@ -15,4 +15,4 @@ _tmuxinator() {
     fi
 }
 
-complete -F _tmuxinator -o tmuxinator mux
+complete -F _tmuxinator tmuxinator mux

data/lib/tmuxinator/assets/sample.yml

@@ -1,35 +1,25 @@
-# ~/.tmuxinator/<%= @name %>.yml
-# you can make as many tabs as you wish...
+# ~/.tmuxinator/<%= name %>.yml
+
+name: <%= name %>
+root: ~/
+
+# Optional tmux socket
+# socket_name: foo
+
+# Runs before everything. Use it to start daemons etc.
+# pre: sudo /etc/rc.d/mysqld start
+
+# Runs in each window and pane before window/pane specific commands. Useful for setting up interpreter versions.
+# pre_window: rbenv shell 2.0.0-p247
+
+# Pass command line options to tmux. Useful for specifying a different tmux.conf.
+# tmux_options: -f ~/.tmux.mac.conf
 
-name: sample
-root: ~/test
-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:
-      pre:
-        - echo "I get run in each pane, before each pane command!"
-        -
       layout: main-vertical
       panes:
         - vim
-        - #empty, will just run plain bash
-        - top
-  - shell: git pull
-  - guard:
-      layout: tiled
-      pre:
-        - echo "I get run in each pane."
-        - echo "Before each pane command!"
-      panes:
-        -
-        - #empty, will just run plain bash
-        -
-  - database: bundle exec rails db
+        - guard
   - server: bundle exec rails s
-  - logs: tail -f log/development.log
-  - console: bundle exec rails c
-  - capistrano:
-  - server: ssh user@example.com
+  - logs: tail -f logs/development.log

data/lib/tmuxinator/cli.rb

@@ -36,7 +36,7 @@ module Tmuxinator
 
       unless Tmuxinator::Config.exists?(name)
         template = Tmuxinator::Config.default? ? Tmuxinator::Config.default : Tmuxinator::Config.sample
-        erb  = ERB.new(File.read(template)).result(binding)
+        erb  = Erubis::Eruby.new(File.read(template)).result(binding)
         File.open(config, "w") { |f| f.write(erb) }
       end
 
@@ -52,7 +52,7 @@ module Tmuxinator
       if project.deprecations.any?
         project.deprecations.each { |deprecation| say deprecation, :red }
         puts
-        print "Press any key to continue."
+        print "Press ENTER to continue."
         STDIN.getc
       end
 
@@ -92,9 +92,9 @@ module Tmuxinator
     map "rm" => :delete
 
     def delete(project)
-      config =  "#{Tmuxinator::Config.root}#{project}.yml"
+      if Tmuxinator::Config.exists?(project)
+        config =  "#{Tmuxinator::Config.root}/#{project}.yml"
 
-      if Tmuxinator::Config.exists?(config)
         if yes?("Are you sure you want to delete #{project}?", :red)
           FileUtils.rm(config)
           say "Deleted #{project}"
@@ -104,7 +104,7 @@ module Tmuxinator
       end
     end
 
-    desc "implode", "Delets all tmuxinator projects"
+    desc "implode", "Deletes all tmuxinator projects"
     map "i" => :implode
 
     def implode

data/lib/tmuxinator/config.rb

@@ -36,7 +36,7 @@ module Tmuxinator
 
       def project(name)
         projects = Dir.glob("#{root}/**/*.yml")
-        project_file = projects.detect { |project| project =~ /#{name}.yml/ }
+        project_file = projects.detect { |project| project =~ /^#{name}.yml$/ }
         project_file || "#{root}/#{name}.yml"
       end
 

data/lib/tmuxinator/version.rb

@@ -1,3 +1,3 @@
 module Tmuxinator
-  VERSION = "0.6.4"
+  VERSION = "0.6.5"
 end

data/spec/fixtures/sample.deprecations.yml

@@ -1,5 +1,4 @@
 # ~/.tmuxinator/sample.deprecations.yml
-# you can make as many tabs as you wish...
 
 project_name: sample
 project_root: ~/test

data/spec/lib/tmuxinator/config_spec.rb

@@ -114,13 +114,13 @@ describe Tmuxinator::Config do
       Tmuxinator::Config.stub(:root => path)
     end
 
-    context 'with project yml' do
+    context "with project yml" do
       it "gets the project as path to the yml file" do
         expect(Tmuxinator::Config.project("sample")).to eq "#{root}/sample.yml"
       end
     end
 
-    context 'without project yml' do
+    context "without project yml" do
       it "gets the project as path to the yml file" do
         expect(Tmuxinator::Config.project("new-project")).to eq "#{root}/new-project.yml"
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tmuxinator
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors:
 - Allen Bargi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-06 00:00:00.000000000 Z
+date: 2013-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor