teamocil 0.4 → 0.4.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZjUwMTBkNTkxZjQyMjMzOTU5ZTAxYmZlN2EyZDdlMDNjZmFmOWRlZQ==
+    ZDU3ZmI2YzQ4NWYyZThlYzM1NmExNTQ4MjE3YjgxMGU3ZGYzZjg0Yg==
   data.tar.gz: !binary |-
-    NTY4Nzc1ZjAzMjQzZTYyOTA4NzhhNWRiNjI4NGE0NzFiNWZhYzMzOQ==
+    M2Q2Y2NkYTMzYzVhNjc5Njk2NGRkMjU0OTQ1NGRhMjlkZjI3M2JiYg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZmVhMDQ3ZWUyOGZkOGYwZWE4NzdlNTcwZjkxNTZmYmEyZjYwMDg1MzBjYjEz
-    MjU5MGEwZmQ5YWM0ZjI0MzJmMDFjYzM3Y2M1ZjVhMGJmMTQxNjk1ZWE5N2Q3
-    ZjZhZjExNDEyZDlhOWQ2MmRjMmQxMDJlYWQ3M2UyYWE4MWMxNjY=
+    OWM1OTVjMWE1YmZjMjViODFhN2RkNDIwMDlmNDc0NzZlZmJhZjhiNDEzN2I0
+    ZWQyMDExNWJlMjUxODZiNjk0Y2JlMGViY2E1MzAyMDYyNDY3OTc1NGU3NmVj
+    YmUyYmQ3YTAwMjFiNGRlNTI3NDI2YWU4Yzk5NzhhYmJlOWJhNWI=
   data.tar.gz: !binary |-
-    NTZjOWZmMTFmMDNkNGFkNGFhZjkxNTdlZjY2MDhiNWYyNWI0ZGYwOTExMTgx
-    MzY4NjYyYWVhOWZlNGViMmQ3ZGJjMWZiY2QyZTliMjExOTdhMjQxNDcxMGM2
-    ZDgwY2EzOTcwNzE5NzdlZDgxNWQ4Yjg0YjU2M2IyNzNiY2IyZWE=
+    YTA5ODk0OGVlZmFiNzA3MjM1YjhlNjEyYTlmYjBiYzc0OWU3MDViZDUyMTE0
+    MDk4N2E4YmU1ZDMxODQ3ZDRiM2E5ZDk1YThmOTUxNmFjNGE0MTQ1MTlmZWFk
+    OWVhNmI0NzQ3NTMyOWU4MWIwZTRjZDJhZDlkMDY1NzllMmQ2N2M=

data/README.md

@@ -1,6 +1,6 @@
 # Teamocil [![Build Status](https://secure.travis-ci.org/remiprev/teamocil.png?branch=master)](http://travis-ci.org/remiprev/teamocil)
 
-Teamocil is a simple tool used to automatically create sessions, windows and splits in [tmux](http://tmux.sourceforge.net/) with YAML files.
+Teamocil is a simple tool used to automatically create sessions, windows and panes in [tmux](http://tmux.sourceforge.net/) with YAML files.
 
 ## Usage
 
@@ -48,11 +48,11 @@ If you are not using a top-level `session` key, then the first key of your layou
 #### Item keys
 
 * `name` (the name that will appear in `tmux` statusbar)
-* `root` (the directory in which every split will be created)
-* `filters` (a hash of `before` and `after` commands to run for each split)
+* `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)
-* `splits` (an array of split items)
+* `panes` (an array of pane items)
 * `options` (a hash of `tmux` options, see `man tmux` for a list)
 
 #### Notes
@@ -68,7 +68,7 @@ You can then use the value as a string, like so:
 ```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]}"
-    splits: …
+    panes: …
 ```
 
 #### Example
@@ -82,33 +82,33 @@ windows:
     root: "~/Projects/foo-www"
     filters:
       before:
-        - "echo 'Let’s use ruby-1.9.3 for each split in this window.'"
+        - "echo 'Let’s use ruby-1.9.3 for each pane in this window.'"
         - "rbenv local 1.9.3-p374"
-    splits:
-      [splits list]
+    panes:
+      [panes list]
   - name: "my-second-window"
     layout: tiled
     root: "~/Projects/foo-api"
-    splits:
-      [splits list]
+    panes:
+      [panes list]
   - name: "my-third-window"
     layout: main-vertical
     root: "~/Projects/foo-daemons"
-    splits:
-      [splits list]
+    panes:
+      [panes list]
 ```
 
-### Splits
+### Panes
 
-Every window must define an array of splits that will be created within it. A vertical or horizontal split 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.
+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.
 
 #### Item keys
 
-* `cmd` (the commands to initially execute in the split)
-* `width` (the split width, in percentage)
-* `height` (the split width, in percentage)
-* `target` (the split to set focus on before creating the current one)
-* `focus` (the split to set focus on after initializing all the splits for a window)
+* `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)
 
 #### Example
 
@@ -119,8 +119,8 @@ windows:
     layout: even-vertical
     filters:
       before: "rbenv local 2.0.0-p0"
-      after: "echo 'I am done initializing this split.'"
-    splits:
+      after: "echo 'I am done initializing this pane.'"
+    panes:
       - cmd: "git status"
       - cmd: "bundle exec rails server --port 4000"
         focus: true
@@ -133,16 +133,16 @@ windows:
 
 See more example files in the `examples` directory.
 
-### Simple two splits window
+### Simple two panes window
 
 #### Content of `~/.teamocil/sample-1.yml`
 
 ```yaml
 windows:
-  - name: "sample-two-splits"
+  - name: "sample-two-panes"
     root: "~/Code/sample/www"
     layout: even-horizontal
-    splits:
+    panes:
       - cmd: ["pwd", "ls -la"]
       - cmd: "rails server --port 3000"
 ```
@@ -162,16 +162,16 @@ windows:
     |                  |                  |
     '------------------'------------------'
 
-### Four tiled splits window
+### Four tiled panes window
 
 #### Content of `~/.teamocil/sample-2.yml`
 
 ```yaml
 windows:
-  - name: "sample-four-splits"
+  - name: "sample-four-panes"
     root: "~/Code/sample/www"
     layout: tiled
-    splits:
+    panes:
       - cmd: "pwd"
       - cmd: "pwd"
       - cmd: "pwd"
@@ -218,7 +218,7 @@ You can use ERB in your layouts. For example, you can use an environment variabl
 windows:
   - name: "erb-example"
     root: <%= ENV['MY_PROJECT_ROOT'] %>
-    splits:
+    panes:
       - cmd: "pwd"
 ```
 

data/examples/four-splits.yml

@@ -1,8 +1,8 @@
 windows:
-  - name: simple-four-splits
+  - name: simple-four-panes
     layout: tiled
-    splits:
-      - cmd: echo 'first split'
-      - cmd: echo 'second split'
-      - cmd: echo 'fourth split'
-      - cmd: echo 'third split'
+    panes:
+      - cmd: echo 'first pane'
+      - cmd: echo 'second pane'
+      - cmd: echo 'fourth pane'
+      - cmd: echo 'third pane'

data/examples/one-and-three-splits.yml

@@ -1,8 +1,8 @@
 windows:
-  - name: simple-one-and-three-splits
+  - name: simple-one-and-three-panes
     layout: main-vertical
-    splits:
-      - cmd: echo 'first split'
-      - cmd: echo 'second split'
-      - cmd: echo 'third split'
-      - cmd: echo 'fourth split'
+    panes:
+      - cmd: echo 'first pane'
+      - cmd: echo 'second pane'
+      - cmd: echo 'third pane'
+      - cmd: echo 'fourth pane'

data/examples/six-splits.yml

@@ -1,10 +1,10 @@
 windows:
-  - name: simple-six-splits
+  - name: simple-six-panes
     layout: tiled
-    splits:
-      - cmd: echo 'first split'
-      - cmd: echo 'second split'
-      - cmd: echo 'fourth split'
-      - cmd: echo 'third split'
-      - cmd: echo 'sixth split'
-      - cmd: echo 'fifth split'
+    panes:
+      - cmd: echo 'first pane'
+      - cmd: echo 'second pane'
+      - cmd: echo 'fourth pane'
+      - cmd: echo 'third pane'
+      - cmd: echo 'sixth pane'
+      - cmd: echo 'fifth pane'

data/examples/two-horizontal-splits.yml

@@ -1,6 +1,6 @@
 windows:
-  - name: simple-two-vertical-splits
+  - name: simple-two-vertical-panes
     layout: even-horizontal
-    splits:
-      - cmd: echo 'first split'
-      - cmd: echo 'second split'
+    panes:
+      - cmd: echo 'first pane'
+      - cmd: echo 'second pane'

data/examples/two-vertical-splits.yml

@@ -1,6 +1,6 @@
 windows:
-  - name: simple-two-horizontal-splits
+  - name: simple-two-horizontal-panes
     layout: even-vertical
-    splits:
-      - cmd: echo 'first split'
-      - cmd: echo 'second split'
+    panes:
+      - cmd: echo 'first pane'
+      - cmd: echo 'second pane'

data/lib/teamocil.rb

@@ -3,5 +3,5 @@ require "teamocil/cli"
 require "teamocil/error"
 
 module Teamocil
-  VERSION = "0.4"
+  VERSION = "0.4.1"
 end

data/lib/teamocil/layout.rb

@@ -1,6 +1,6 @@
 require "teamocil/layout/session"
 require "teamocil/layout/window"
-require "teamocil/layout/split"
+require "teamocil/layout/pane"
 
 module Teamocil
   # This class act as a wrapper around a tmux YAML layout file

data/lib/teamocil/layout/{split.rb → pane.rb}

@@ -1,16 +1,16 @@
 module Teamocil
   class Layout
-    # This class represents a split within a tmux window
-    class Split
+    # This class represents a pane within a tmux window
+    class Pane
       attr_reader :width, :height, :cmd, :index, :target, :focus
 
-      # Initialize a new tmux split
+      # Initialize a new tmux pane
       #
-      # @param session [Session] the window where the split is initialized
-      # @param index [Fixnnum] the split index
-      # @param attrs [Hash] the split data from the layout file
+      # @param session [Session] the window where the pane is initialized
+      # @param index [Fixnnum] the pane index
+      # @param attrs [Hash] the pane data from the layout file
       def initialize(window, index, attrs={})
-        raise Teamocil::Error::LayoutError.new("You cannot have empty splits") if attrs.nil?
+        raise Teamocil::Error::LayoutError.new("You cannot have empty panes") if attrs.nil?
         @height = attrs["height"]
         @width = attrs["width"]
         @cmd = attrs["cmd"]
@@ -27,7 +27,7 @@ module Teamocil
       def generate_commands
         commands = []
 
-        # Is it a vertical or horizontal split?
+        # Is it a vertical or horizontal pane
         init_command = ""
         unless @index == @window.pane_base_index
           if !@width.nil?
@@ -44,13 +44,13 @@ module Teamocil
         # Wrap all commands around filters
         @cmd = [@window.filters["before"]] + [@window.clear] + [@cmd] + [@window.filters["after"]]
 
-        # If a `root` key exist, start each split in this directory
+        # If a `root` key exist, start each pane in this directory
         @cmd.unshift "cd \"#{@window.root}\"" unless @window.root.nil?
 
         # Set the TEAMOCIL environment variable
         @cmd.unshift "export TEAMOCIL=1"
 
-        # Execute each split command
+        # Execute each pane command
         commands << "tmux send-keys -t #{@index} \"#{@cmd.flatten.compact.join(" && ")}\""
         commands << "tmux send-keys -t #{@index} Enter"
 

data/lib/teamocil/layout/window.rb

@@ -2,7 +2,7 @@ module Teamocil
   class Layout
     # This class represents a window within tmux
     class Window
-      attr_reader :filters, :root, :splits, :options, :index, :name, :clear, :layout
+      attr_reader :filters, :root, :panes, :options, :index, :name, :clear, :layout
 
       # Initialize a new tmux window
       #
@@ -16,9 +16,9 @@ module Teamocil
         @options = attrs["options"] || {}
         @layout = attrs["layout"]
 
-        @splits = attrs["splits"] || []
-        raise Teamocil::Error::LayoutError.new("You must specify a `splits` key for every window.") if @splits.empty?
-        @splits = @splits.each_with_index.map { |split, split_index| Split.new(self, split_index + pane_base_index, split) }
+        @panes = attrs["panes"] || attrs["splits"] || []
+        raise Teamocil::Error::LayoutError.new("You must specify a `panes` (or legacy `splits`) key for every window.") if @panes.empty?
+        @panes = @panes.each_with_index.map { |pane, pane_index| Pane.new(self, pane_index + pane_base_index, pane) }
 
         @filters = attrs["filters"] || {}
         @filters["before"] ||= []
@@ -40,7 +40,7 @@ module Teamocil
           commands << "tmux new-window -n \"#{@name}\""
         end
 
-        commands << @splits.map(&:generate_commands)
+        commands << @panes.map(&:generate_commands)
 
         @options.each_pair do |option, value|
           value = "on"  if value === true
@@ -49,7 +49,7 @@ module Teamocil
         end
 
         commands << "tmux select-layout \"#{@layout}\"" if @layout
-        commands << "tmux select-pane -t #{@splits.map(&:focus).index(true) || 0}"
+        commands << "tmux select-pane -t #{@panes.map(&:focus).index(true) || 0}"
 
         commands
       end

data/spec/cli_spec.rb

@@ -2,6 +2,9 @@
 require File.join(File.dirname(__FILE__), "spec_helper.rb")
 
 describe Teamocil::CLI do
+  let(:window_pane_base_index) { 0 }
+  before { Teamocil::Layout::Window.any_instance.stub(:pane_base_index).and_return(window_pane_base_index) }
+
   context "executing" do
     before do
       @fake_env = { "TMUX" => 1, "HOME" => File.join(File.dirname(__FILE__), "fixtures") }

data/spec/fixtures/.my-fancy-layouts-directory/sample-3.yml

@@ -3,8 +3,8 @@ session:
   root: ~
   windows:
     - name: "foo"
-      splits:
+      panes:
       - cmd: "pwd"
     - name: "bar"
-      splits:
+      panes:
       - cmd: "pwd"

data/spec/fixtures/.teamocil/sample-2.yml

@@ -3,8 +3,8 @@ session:
   root: ~
   windows:
     - name: "foo"
-      splits:
+      panes:
       - cmd: "pwd"
     - name: "bar"
-      splits:
+      panes:
       - cmd: "pwd"

data/spec/fixtures/.teamocil/sample.yml

@@ -3,8 +3,8 @@ session:
   root: ~
   windows:
     - name: <%= "foo" %>
-      splits:
+      panes:
       - cmd: "pwd"
     - name: "bar"
-      splits:
+      panes:
       - cmd: "pwd"

data/spec/fixtures/layouts.yml

@@ -5,7 +5,7 @@ two-windows:
       clear: true
       root: "/foo"
       layout: "tiled"
-      splits:
+      panes:
         - cmd: "echo 'foo'"
         - cmd: "echo 'foo again'"
           width: 50
@@ -32,7 +32,7 @@ two-windows-with-filters:
         after:
           - "echo first after filter"
           - "echo second after filter"
-      splits:
+      panes:
         - cmd: "echo 'foo'"
         - cmd: "echo 'foo again'"
           width: 50
@@ -42,11 +42,11 @@ three-windows-within-a-session:
     name: "my awesome session"
     windows:
       - name: "first window"
-        splits:
+        panes:
         - cmd: "echo 'foo'"
       - name: "second window"
-        splits:
+        panes:
         - cmd: "echo 'foo'"
       - name: "third window"
-        splits:
+        panes:
         - cmd: "echo 'foo'"

data/spec/layout_spec.rb

@@ -16,13 +16,13 @@ describe Teamocil::Layout do
         expect { @layout.compile! }.to raise_error Teamocil::Error::LayoutError
       end
 
-      it "does not compile without splits" do
+      it "does not compile without panes" do
         @layout = Teamocil::Layout.new({ "windows" => [{ "name" => "foo" }] }, {})
         expect { @layout.compile! }.to raise_error Teamocil::Error::LayoutError
       end
 
-      it "does not compile with empty splits" do
-        @layout = Teamocil::Layout.new({ "windows" => [{ "name" => "foo", "splits" => [nil, nil] }] }, {})
+      it "does not compile with empty panes" do
+        @layout = Teamocil::Layout.new({ "windows" => [{ "name" => "foo", "panes" => [nil, nil] }] }, {})
         expect { @layout.compile! }.to raise_error Teamocil::Error::LayoutError
       end
     end
@@ -60,36 +60,43 @@ describe Teamocil::Layout do
       end
     end
 
-    describe "splits" do
-      it "creates splits" do
+    describe "panes" do
+      it "creates panes" do
         session = @layout.compile!
-        session.windows.first.splits.each do |split|
-          split.should be_an_instance_of Teamocil::Layout::Split
+        session.windows.first.panes.each do |pane|
+          pane.should be_an_instance_of Teamocil::Layout::Pane
         end
       end
 
-      it "creates splits with dimensions" do
+      it "creates panes with legacy `splits` key" do
         session = @layout.compile!
-        session.windows.first.splits[0].width.should == nil
-        session.windows.first.splits[1].width.should == 50
+        session.windows.last.panes.each do |pane|
+          pane.should be_an_instance_of Teamocil::Layout::Pane
+        end
+      end
+
+      it "creates panes with dimensions" do
+        session = @layout.compile!
+        session.windows.first.panes[0].width.should == nil
+        session.windows.first.panes[1].width.should == 50
       end
 
-      it "creates splits with commands specified in strings" do
+      it "creates panes with commands specified in strings" do
         session = @layout.compile!
-        session.windows.first.splits[0].cmd.should == "echo 'foo'"
+        session.windows.first.panes[0].cmd.should == "echo 'foo'"
       end
 
-      it "creates splits with commands specified in an array" do
+      it "creates panes with commands specified in an array" do
         session = @layout.compile!
-        session.windows.last.splits[0].cmd.length.should == 2
-        session.windows.last.splits[0].cmd.first.should == "echo 'bar'"
-        session.windows.last.splits[0].cmd.last.should == "echo 'bar in an array'"
+        session.windows.last.panes[0].cmd.length.should == 2
+        session.windows.last.panes[0].cmd.first.should == "echo 'bar'"
+        session.windows.last.panes[0].cmd.last.should == "echo 'bar in an array'"
       end
 
-      it "handles focused splits" do
+      it "handles focused panes" do
         session = @layout.compile!
-        session.windows.last.splits[1].focus.should be_true
-        session.windows.last.splits[0].focus.should be_false
+        session.windows.last.panes[1].focus.should be_true
+        session.windows.last.panes[0].focus.should be_false
       end
     end
 
@@ -120,14 +127,14 @@ describe Teamocil::Layout do
     end
 
     describe "targets" do
-      it "should handle splits without a target" do
+      it "should handle panes without a target" do
         session = @layout.compile!
-        session.windows.last.splits.last.target.should == nil
+        session.windows.last.panes.last.target.should == nil
       end
 
-      it "should handle splits with a target" do
+      it "should handle panes with a target" do
         session = @layout.compile!
-        session.windows.last.splits.first.target.should == "bottom-right"
+        session.windows.last.panes.first.target.should == "bottom-right"
       end
     end
 
@@ -144,15 +151,15 @@ describe Teamocil::Layout do
   context "generating commands" do
     before { @layout = Teamocil::Layout.new(layouts["two-windows"], {}) }
 
-    it "should generate split commands" do
+    it "should generate pane commands" do
       session = @layout.compile!
-      commands = session.windows.last.splits[0].generate_commands
+      commands = session.windows.last.panes[0].generate_commands
       commands.length.should == 2
       commands.first.should == "tmux send-keys -t 0 \"export TEAMOCIL=1 && cd \"/bar\" && echo 'bar' && echo 'bar in an array'\""
       commands.last.should == "tmux send-keys -t 0 Enter"
 
       session = @layout.compile!
-      commands = session.windows.first.splits[0].generate_commands
+      commands = session.windows.first.panes[0].generate_commands
       commands.length.should == 2
       commands.first.should == "tmux send-keys -t 0 \"export TEAMOCIL=1 && cd \"/foo\" && clear && echo 'foo'\""
       commands.last.should == "tmux send-keys -t 0 Enter"
@@ -168,9 +175,9 @@ describe Teamocil::Layout do
     context "with custom pane-base-index option" do
       let(:window_pane_base_index) { 2 }
 
-      it "should generate split commands" do
+      it "should generate pane commands" do
         session = @layout.compile!
-        commands = session.windows.last.splits[0].generate_commands
+        commands = session.windows.last.panes[0].generate_commands
         commands.length.should == 2
         commands.first.should == "tmux send-keys -t 2 \"export TEAMOCIL=1 && cd \"/bar\" && echo 'bar' && echo 'bar in an array'\""
         commands.last.should == "tmux send-keys -t 2 Enter"

data/teamocil.gemspec

@@ -12,8 +12,8 @@ spec = Gem::Specification.new do |s|
   s.email        = "remi@exomel.com"
   s.homepage     = "http://remiprev.github.com/teamocil"
   s.license      = "MIT"
-  s.summary      = "Easy window and split layouts for tmux"
-  s.description  = "Teamocil helps you set up window and splits layouts for tmux using YAML configuration files."
+  s.summary      = "Easy session, window and pane layouts for tmux"
+  s.description  = "Teamocil helps you set up window and pane layouts for tmux using YAML configuration files."
 
   # Manifest
   s.files         = `git ls-files`.split("\n")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teamocil
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: 0.4.1
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-03 00:00:00.000000000 Z
+date: 2013-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,7 +66,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Teamocil helps you set up window and splits layouts for tmux using YAML
+description: Teamocil helps you set up window and pane layouts for tmux using YAML
   configuration files.
 email: remi@exomel.com
 executables:
@@ -90,8 +90,8 @@ files:
 - lib/teamocil/cli.rb
 - lib/teamocil/error.rb
 - lib/teamocil/layout.rb
+- lib/teamocil/layout/pane.rb
 - lib/teamocil/layout/session.rb
-- lib/teamocil/layout/split.rb
 - lib/teamocil/layout/window.rb
 - spec/cli_spec.rb
 - spec/fixtures/.my-fancy-layouts-directory/sample-3.yml
@@ -123,10 +123,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
-summary: Easy window and split layouts for tmux
+summary: Easy session, window and pane layouts for tmux
 test_files:
 - spec/cli_spec.rb
 - spec/fixtures/.my-fancy-layouts-directory/sample-3.yml