teamocil 0.4.5 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae4d2a262a756ec11e9a2e0f2be1c6bc8ecdfafe
-  data.tar.gz: 4e5afa56cb394b6d433d16680e304b2776ae91e2
+  metadata.gz: ec181d7aedf97f5a86ff36a951f9e6778871d715
+  data.tar.gz: 898335772480c6026daa85a96ad83c083b553dba
 SHA512:
-  metadata.gz: 5373b8ca262482ad3166bd046565bf8a96f68d7ac8c93d0cc8f9ba0ca3cff1ef40c036951e656cb518d1cf7c174f4936c67159f7d8a46eae5a33ac8643cbdea8
-  data.tar.gz: d589b51c3cb65f77e3d4a78fa072a2c0206ecf7551e48d1b1a9bbd5a5358aac1fbdcc86c59a1fef3e0d66b93f4a2497539e5ca6f836d42fead7a24c2fd2c6eda
+  metadata.gz: 04b7e11004f212c832c72f4bc6e14690294dd7526c9fb820bbaac3c62c16a7bb5ecdc83f72f42e0b3c4ad9551d27986390b0539c799fcf3d61d86046fbee61e5
+  data.tar.gz: 066d82e108560b8633c6d79dd5d4ff1b57ec1596286c0738d81ecfc2110eacd6d212cda02c1cd713fc624eaa1a21e3c04c8053b218f45b56175f94233040fc82

data/.gitignore

@@ -1,7 +1,17 @@
 *.gem
-.rvmrc
-.local*
+*.rbc
+.bundle
+.config
 .yardoc
-doc
-pkg
 Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rubocop.yml

@@ -0,0 +1,48 @@
+AllCops:
+  Include:
+    - Rakefile
+    - teamocil.gemspec
+
+Documentation:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+LineLength:
+  Max: 200
+
+AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+IfUnlessModifier:
+  Enabled: false
+
+CaseIndentation:
+  IndentWhenRelativeTo: case
+  IndentOneStep: true
+
+MethodLength:
+  CountComments: false
+  Max: 20
+
+SignalException:
+  Enabled: false
+
+ColonMethodCall:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+Lambda:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+RedundantBegin:
+  Enabled: false
+
+AssignmentInCondition:
+  Enabled: false

data/.travis.yml

@@ -1,2 +1,2 @@
-rvm: 1.9.2
-script: "bundle exec rake spec"
+rvm: 2.1.2
+script: bundle exec phare

data/Gemfile

@@ -1,2 +1,2 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 gemspec

data/README.md

@@ -1,199 +1,172 @@
-# Teamocil
+<p align="center">
+  <a href="https://github.com/remiprev/teamocil">
+    <img src="http://i.imgur.com/NX2eV2X.png" alt="Teamocil" />
+  </a>
+  <br />
+  Teamocil is a simple tool used to automatically create sessions,<br /> windows and panes in <a href="http://tmux.sourceforge.net">tmux</a> with YAML files.
+  <br /><br />
+  <a href="https://rubygems.org/gems/teamocil"><img src="http://img.shields.io/gem/v/teamocil.svg" /></a>
+  <a href="https://travis-ci.org/remiprev/teamocil"><img src="http://img.shields.io/travis/remiprev/teamocil.svg" /></a>
+</p>
 
-<a href="https://rubygems.org/gems/teamocil"><img src="http://img.shields.io/gem/v/teamocil.svg" /></a>
-<a href="https://travis-ci.org/remiprev/teamocil"><img src="http://img.shields.io/travis/remiprev/teamocil.svg" /></a>
+---
 
-Teamocil is a simple tool used to automatically create sessions, windows and panes in [tmux](http://tmux.sourceforge.net/) with YAML files.
-
-## Usage
+## Installation
 
 ```bash
+# Install the `teamocil` Ruby gem
 $ gem install teamocil
+
+# Create your layout directory
 $ mkdir ~/.teamocil
+
+# Edit ~/.teamocil/sample.yml (look for sample layouts in this very `README.md`)
 $ teamocil --edit sample
+
+# Launch tmux
 $ tmux
+
+# Run your newly-created sample layout
 $ teamocil sample
 ```
 
-## Options
-
-* `--here` opens the session in the current window, do not create an empty first window.
-* `--layout` takes a custom file path to a YAML layout file.
-* `--edit` opens the layout file (whether or not `--layout` is used) with `$EDITOR`.
-* `--list` lists all available layouts in `./.teamocil` or `$TEAMOCIL_PATH`.
-* `--show` show the layout content instead of executing it.
-
-## Layout file structure
-
-A layout file is a single YAML file located in `~/.teamocil` or `$TEAMOCIL_PATH` (eg. `~/.teamocil/my-project.yml`).
-
-### Session
-
-You can wrap your entire layout file in a `session` and Teamocil will rename the current session (so that you can find it more easily when running `tmux list-sessions`) before creating your windows.
-
-#### Keys
-
-* `name` (the name of the session)
-
-#### Example
+## Usage
 
-```yaml
-session:
-  name: "my-awesome-session"
-  windows:
-    [windows list]
+```bash
+$ teamocil [options] [layout-name]
 ```
 
-### Windows
+### Global options
 
-If you are not using a top-level `session` key, then the first key of your layout file will be `windows`, an array of window items.
+| Option      | Description
+|-------------|----------------------------
+| `--list`    | Lists all available layouts in `~/.teamocil`
 
-#### Item keys
+### Layout options
 
-* `name` (the name that will appear in `tmux` statusbar)
-* `root` (the directory in which every pane will be created)
-* `filters` (a hash of `before` and `after` commands to run for each pane)
-* `clear` (whether or not to prepend a `clear` command before the `before` filters list)
-* `layout` (a layout name or serialized string supported by the `tmux select-layout` command)
-* `panes` (an array of pane items)
-* `options` (a hash of `tmux` options, see `man tmux` for a list)
+| Option      | Description
+|-------------|----------------------------
+| `--layout`  | Takes a custom file path to a YAML layout file instead of `[layout-name]`
+| `--here`    | Uses the current window as the layout’s first window
+| `--edit`    | Opens the layout file with `$EDITOR` instead of executing it
+| `--show`    | Shows the layout content instead of executing it
 
-#### Notes
+## Upgrading
 
-If you want to use a custom value for the `layout` key, running this command will give you the layout of the current window:
+Teamocil 1.0 is a complete rewrite (from scratch!) of Teamocil. The code is now
+very much simpler, cleaner and easier to maintain.
 
-```bash
-$ tmux list-windows -F "#{window_active} #{window_layout}" | grep "^1" | cut -d " " -f 2
-```
+The downside of that is that several features were dropped during the rewrite
+process, mostly because I didn’t actually use/need them and I got tired of
+maintaining features I don’t think are useful.
 
-You can then use the value as a string, like so:
+But hey, that’s just my opinion. Feel free to fork the repository and add as
+many features as you want :smile:.
 
-```yaml
-  - name: "a-window-with-weird-layout"
-    layout: "4d71,204x51,0,0{101x51,0,0,114,102x51,102,0[102x10,102,0,118,102x40,102,11,115]}"
-    panes: …
-```
+## Configuration
 
-#### Example
+### Windows
 
-```yaml
-windows:
-  - name: "my-first-window"
-    clear: true
-    options:
-      synchronize-panes: true
-    root: "~/Projects/foo-www"
-    filters:
-      before:
-        - "echo 'Let’s use ruby-1.9.3 for each pane in this window.'"
-        - "rbenv local 1.9.3-p374"
-    panes:
-      [panes list]
-  - name: "my-second-window"
-    layout: tiled
-    root: "~/Projects/foo-api"
-    panes:
-      [panes list]
-  - name: "my-third-window"
-    layout: main-vertical
-    root: "~/Projects/foo-daemons"
-    panes:
-      [panes list]
-```
+| Key      | Description
+|----------|----------------------------
+| `name`   | The tmux window name
+| `root`   | The path where all panes in the window will be started
+| `layout` | The layout that will be set after all panes are created by Teamocil
+| `panes`  | An `Array` of panes
+| `focus`  | If set to `true`, the window will be selected after the layout has been executed
 
 ### Panes
 
-Every window must define an array of panes that will be created within it. A vertical or horizontal pane will be created, depending on whether the `width` or `height` parameter is used. If a `layout` option is used for the window, the `width` and `height` attributes won’t have any effect.
+A pane can either be a `String` or a `Hash`. If it’s a `String`, Teamocil will
+treat it as a single-command pane.
 
-#### Item keys
+| Key        | Description
+|------------|----------------------------
+| `commands` | An `Array` of commands that will be ran when the pane is created
+| `focus`    | If set to `true`, the pane will be selected after the layout has been executed
 
-* `cmd` (the commands to initially execute in the pane)
-* `width` (the pane width, in percentage)
-* `height` (the pane width, in percentage)
-* `target` (the pane to set focus on before creating the current one)
-* `focus` (the pane to set focus on after initializing all the panes for a window)
+## Examples
 
-#### Example
+### Simple two pane window
 
 ```yaml
 windows:
-  - name: "my-first-window"
-    root: "~/Projects/foo-www"
-    layout: even-vertical
-    filters:
-      before: "rbenv local 2.0.0-p0"
-      after: "echo 'I am done initializing this pane.'"
+  - name: sample-two-panes
+    root: ~/Code/sample/www
+    layout: even-horizontal
     panes:
-      - cmd: "git status"
-      - cmd: "bundle exec rails server --port 4000"
-        focus: true
-      - cmd:
-          - "sudo service memcached start"
-          - "sudo service mongodb start"
+      - git status
+      - rails server
 ```
 
-## Layout examples
-
-See more example files in the `examples` directory.
-
-### Simple two panes window
+```
+.------------------.------------------.
+| (0)              | (1)              |
+|                  |                  |
+|                  |                  |
+|                  |                  |
+|                  |                  |
+|                  |                  |
+|                  |                  |
+|                  |                  |
+|                  |                  |
+'------------------'------------------'
+```
 
-#### Content of `~/.teamocil/sample-1.yml`
+### Simple three pane window
 
 ```yaml
 windows:
-  - name: "sample-two-panes"
-    root: "~/Code/sample/www"
-    layout: even-horizontal
+  - name: sample-three-panes
+    root: ~/Code/sample/www
+    layout: main-vertical
     panes:
-      - cmd: ["pwd", "ls -la"]
-      - cmd: "rails server --port 3000"
+      - vim
+      - rails server
+      - git status
 ```
-        
-
-#### Result of `$ teamocil sample-1`
 
-    .------------------.------------------.
-    | (0)              | (1)              |
-    |                  |                  |
-    |                  |                  |
-    |                  |                  |
-    |                  |                  |
-    |                  |                  |
-    |                  |                  |
-    |                  |                  |
-    |                  |                  |
-    '------------------'------------------'
-
-### Four tiled panes window
+```
+.------------------.------------------.
+| (0)              | (1)              |
+|                  |                  |
+|                  |                  |
+|                  |                  |
+|                  |------------------|
+|                  | (2)              |
+|                  |                  |
+|                  |                  |
+|                  |                  |
+'------------------'------------------'
+```
 
-#### Content of `~/.teamocil/sample-2.yml`
+### Simple four pane window
 
 ```yaml
 windows:
-  - name: "sample-four-panes"
-    root: "~/Code/sample/www"
+  - name: sample-two-panes
+    root: ~/Code/sample/www
     layout: tiled
     panes:
-      - cmd: "pwd"
-      - cmd: "pwd"
-      - cmd: "pwd"
-      - cmd: "pwd"
+      - vim
+      - foreman start web
+      - git status
+      - foreman start worker
 ```
 
-#### Result of `$ teamocil sample-2`
-
-    .------------------.------------------.
-    | (0)              | (1)              |
-    |                  |                  |
-    |                  |                  |
-    |                  |                  |
-    |------------------|------------------|
-    | (3)              | (2)              |
-    |                  |                  |
-    |                  |                  |
-    |                  |                  |
-    '------------------'------------------'
+```
+.------------------.------------------.
+| (0)              | (1)              |
+|                  |                  |
+|                  |                  |
+|                  |                  |
+|------------------|------------------|
+| (2)              | (3)              |
+|                  |                  |
+|                  |                  |
+|                  |                  |
+'------------------'------------------'
+```
 
 ## Extras
 
@@ -213,26 +186,11 @@ To get autocompletion when typing `teamocil <Tab>` in a bash session, add this l
 complete -W "$(teamocil --list)" teamocil
 ```
 
-### ERB support
-
-You can use ERB in your layouts. For example, you can use an environment variable in a layout like so:
-
-```yaml
-windows:
-  - name: "erb-example"
-    root: <%= ENV['MY_PROJECT_ROOT'] %>
-    panes:
-      - cmd: "pwd"
-```
-
-## Todo list
-
-* Making sure the layout is valid before executing it (ie. throw exceptions).
-* Add more specs.
-
 ## Contributors
 
-Feel free to contribute and submit issues/pull requests [on GitHub](https://github.com/remiprev/teamocil/issues), just like these fine folks did:
+Feel free to contribute and submit issues/pull requests
+[on GitHub](https://github.com/remiprev/teamocil/issues), just like these fine
+folks did:
 
 * [@garno](https://github.com/garno)
 * [@jbourassa](https://github.com/jbourassa)
@@ -240,8 +198,8 @@ Feel free to contribute and submit issues/pull requests [on GitHub](https://gith
 * [@jscheel](https://github.com/jscheel)
 * [@mklappstuhl](https://github.com/mklappstuhl)
 
-Take a look at the `spec` folder before you do, and make sure `bundle exec rake spec` passes after your modifications :)
-
 ## License
 
-Teamocil is © 2011-2014 [Rémi Prévost](http://exomel.com) and may be freely distributed under the [MIT license](https://github.com/remiprev/teamocil/blob/master/LICENSE). See the `LICENSE` file.
+Teamocil is © 2011-2014 [Rémi Prévost](http://exomel.com) and may be freely
+distributed under the [MIT license](https://github.com/remiprev/teamocil/blob/master/LICENSE.md).
+See the `LICENSE.md` file for more information.