teamocil 0.3.7 → 0.3.8

data/README.md

@@ -51,6 +51,7 @@ If you are not using a top-level `session` key, then the first key of your layou
 * `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)
+* `clear` (whether or not to prepend a `clear` command before the `before` filters list)
 * `splits` (an array of split items)
 * `options` (a hash of tmux options, see `man tmux` for a list)
 
@@ -59,6 +60,7 @@ If you are not using a top-level `session` key, then the first key of your layou
 ```yaml
 windows:
   - name: "my-first-window"
+    clear: true
     options:
       synchronize-panes: true
     root: "~/Projects/foo-www"
@@ -87,7 +89,8 @@ Every window must define an array of splits that will be created within it. A ve
 * `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)
+* `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)
 
 #### Example
 
@@ -101,6 +104,7 @@ windows:
     splits:
       - cmd: "git status"
       - cmd: "bundle exec rails server --port 4000"
+        focus: true
         width: 50
       - cmd:
           - "sudo service memcached start"
@@ -185,9 +189,9 @@ To get autocompletion when typing `teamocil <Tab>` in a zsh session, add this li
 compctl -g '~/.teamocil/*(:t:r)' teamocil
 ```
 
-### ERB Support
+### ERB support
 
-You can use ERB in your config files.  For example, you can use an environment variable in your config like so:
+You can use ERB in your layouts. For example, you can use an environment variable in a layout like so:
 
 ```yaml
 windows:
@@ -208,6 +212,7 @@ Feel free to contribute and submit issues/pull requests [on GitHub](https://gith
 
 * Samuel Garneau ([garno](https://github.com/garno))
 * Jimmy Bourassa ([jbourassa](https://github.com/jbourassa))
+* Brandon Dimcheff ([bdimcheff](https://github.com/bdimcheff))
 
 Take a look at the `spec` folder before you do, and make sure `bundle exec rake spec` passes after your modifications :)
 

data/examples/simple-four-splits.yml

@@ -4,6 +4,7 @@ windows:
       - cmd: "echo 'first split'"
       - cmd: "echo 'second split'"
         width: 50
+        focus: true
       - cmd: "echo 'fourth split'"
         height: 50
         target: bottom-right

data/lib/teamocil.rb

@@ -1,5 +1,6 @@
 module Teamocil
-  VERSION = "0.3.7"
+  VERSION = "0.3.8"
   autoload :Layout, "teamocil/layout"
   autoload :CLI,    "teamocil/cli"
+  autoload :Error,  "teamocil/error"
 end

data/lib/teamocil/cli.rb

@@ -36,7 +36,12 @@ module Teamocil
         yaml = ERB.new(File.read(file)).result
 
         @layout = Teamocil::Layout.new(YAML.load(yaml), @options)
-        @layout.compile!
+
+        begin
+          @layout.compile!
+        rescue Teamocil::Error::LayoutError => e
+          bail e.message
+        end
         @layout.execute_commands(@layout.generate_commands)
       end
     end # }}}

data/lib/teamocil/error.rb

@@ -0,0 +1,6 @@
+module Teamocil
+  module Error
+    class StandardError < ::StandardError; end
+    class LayoutError < StandardError; end
+  end
+end

data/lib/teamocil/layout/session.rb

@@ -10,7 +10,8 @@ module Teamocil
       # @param options [Hash] the options, mostly passed by the CLI
       # @param attrs [Hash] the session data from the layout file
       def initialize(options, attrs={}) # {{{
-        @name = attrs["name"]
+        raise Teamocil::Error::LayoutError.new("You must specify a `windows` or `session` key for your layout.") unless attrs["windows"]
+        @name = attrs["name"] || "teamocil-session"
         @windows = attrs["windows"].each_with_index.map { |window, window_index| Window.new(self, window_index, window) }
         @options = options
       end # }}}
@@ -22,8 +23,6 @@ module Teamocil
         commands = []
         commands << "tmux rename-session \"#{@name}\"" unless @name.nil?
         commands << @windows.map(&:generate_commands)
-        commands << "tmux select-pane -t 0"
-        commands
       end # }}}
 
     end

data/lib/teamocil/layout/split.rb

@@ -3,7 +3,7 @@ module Teamocil
 
     # This class represents a split within a tmux window
     class Split
-      attr_reader :width, :height, :cmd, :index, :target
+      attr_reader :width, :height, :cmd, :index, :target, :focus
 
       # Initialize a new tmux split
       #
@@ -11,10 +11,12 @@ module Teamocil
       # @param index [Fixnnum] the split index
       # @param attrs [Hash] the split data from the layout file
       def initialize(window, index, attrs={}) # {{{
+        raise Teamocil::Error::LayoutError.new("You cannot have empty splits") if attrs.nil?
         @height = attrs["height"]
         @width = attrs["width"]
         @cmd = attrs["cmd"]
         @target = attrs["target"]
+        @focus = attrs["focus"] || false
 
         @window = window
         @index = index
@@ -41,7 +43,7 @@ module Teamocil
         end
 
         # Wrap all commands around filters
-        @cmd = [@window.filters["before"]] + [@cmd] + [@window.filters["after"]]
+        @cmd = [@window.filters["before"]] + [@window.clear] + [@cmd] + [@window.filters["after"]]
 
         # If a `root` key exist, start each split in this directory
         @cmd.unshift "cd \"#{@window.root}\"" unless @window.root.nil?

data/lib/teamocil/layout/window.rb

@@ -3,7 +3,7 @@ module Teamocil
 
     # This class represents a window within tmux
     class Window
-      attr_reader :filters, :root, :splits, :options, :index, :name
+      attr_reader :filters, :root, :splits, :options, :index, :name, :clear
 
       # Initialize a new tmux window
       #
@@ -11,11 +11,13 @@ module Teamocil
       # @param index [Fixnnum] the window index
       # @param attrs [Hash] the window data from the layout file
       def initialize(session, index, attrs={}) # {{{
-        @name = attrs["name"]
-        @root = attrs["root"]
+        @name = attrs["name"] || "teamocil-window-#{index+1}"
+        @root = attrs["root"] || "."
+        @clear = attrs["clear"] == true ? "clear" : nil
         @options = attrs["options"] || {}
 
         @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, split) }
 
         @filters = attrs["filters"] || {}
@@ -46,6 +48,8 @@ module Teamocil
           commands << "tmux set-window-option #{option} #{value}"
         end
 
+        commands << "tmux select-pane -t #{@splits.map(&:focus).index(true) || 0}"
+
         commands
       end # }}}
 

data/spec/fixtures/layouts.yml

@@ -2,6 +2,7 @@
 two-windows:
   windows:
     - name: "foo"
+      clear: true
       root: "/foo"
       splits:
         - cmd: "echo 'foo'"
@@ -15,6 +16,7 @@ two-windows:
           - "echo 'bar in an array'"
           target: bottom-right
         - cmd: "echo 'bar again'"
+          focus: true
           width: 50
 
 # Simple two windows layout with filters
@@ -39,5 +41,11 @@ three-windows-within-a-session:
     name: "my awesome session"
     windows:
       - name: "first window"
+        splits:
+        - cmd: "echo 'foo'"
       - name: "second window"
+        splits:
+        - cmd: "echo 'foo'"
       - name: "third window"
+        splits:
+        - cmd: "echo 'foo'"

data/spec/layout_spec.rb

@@ -8,6 +8,23 @@ describe Teamocil::Layout do
       @layout = Teamocil::Layout.new(layouts["two-windows"], {})
     end # }}}
 
+    describe "handles bad layouts" do # {{{
+      it "does not compile without windows" do # {{{
+        @layout = Teamocil::Layout.new({ "name" => "foo" }, {})
+        lambda { @layout.compile! }.should raise_error Teamocil::Error::LayoutError
+      end # }}}
+
+      it "does not compile without splits" do # {{{
+        @layout = Teamocil::Layout.new({ "windows" => [{ "name" => "foo" }] }, {})
+        lambda { @layout.compile! }.should raise_error Teamocil::Error::LayoutError
+      end # }}}
+
+      it "does not compile with empty splits" do # {{{
+        @layout = Teamocil::Layout.new({ "windows" => [{ "name" => "foo", "splits" => [nil, nil] }] }, {})
+        lambda { @layout.compile! }.should raise_error Teamocil::Error::LayoutError
+      end # }}}
+    end # }}}
+
     describe "windows" do # {{{
       it "creates windows" do # {{{
         session = @layout.compile!
@@ -27,6 +44,12 @@ describe Teamocil::Layout do
         session.windows[0].root.should == "/foo"
         session.windows[1].root.should == "/bar"
       end # }}}
+
+      it "creates windows with clear option" do # {{{
+        session = @layout.compile!
+        session.windows[0].clear.should == "clear"
+        session.windows[1].clear.should be_nil
+      end # }}}
     end # }}}
 
     describe "splits" do # {{{
@@ -54,6 +77,12 @@ describe Teamocil::Layout do
         session.windows.last.splits[0].cmd.first.should == "echo 'bar'"
         session.windows.last.splits[0].cmd.last.should == "echo 'bar in an array'"
       end # }}}
+
+      it "handles focused splits" do # {{{
+        session = @layout.compile!
+        session.windows.last.splits[1].focus.should be_true
+        session.windows.last.splits[0].focus.should be_false
+      end # }}}
     end # }}}
 
     describe "filters" do # {{{
@@ -109,12 +138,25 @@ describe Teamocil::Layout do
       @layout = Teamocil::Layout.new(layouts["two-windows"], {})
     end # }}}
 
-    it "should generate commands" do #{{{
+    it "should generate split commands" do #{{{
       session = @layout.compile!
       commands = session.windows.last.splits[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.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"
+    end # }}}
+
+    it "should generate window commands" do #{{{
+      session = @layout.compile!
+      commands = session.windows.last.generate_commands
+      commands.first.should == "tmux new-window -n \"bar\""
+      commands.last.should == "tmux select-pane -t 1"
     end # }}}
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teamocil
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-29 00:00:00.000000000Z
+date: 2012-08-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -97,6 +97,7 @@ files:
 - examples/simple-two-vertical-splits.yml
 - lib/teamocil.rb
 - lib/teamocil/cli.rb
+- lib/teamocil/error.rb
 - lib/teamocil/layout.rb
 - lib/teamocil/layout/session.rb
 - lib/teamocil/layout/split.rb
@@ -126,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2721488511741570961
+      hash: -4311130867002785670
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -135,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2721488511741570961
+      hash: -4311130867002785670
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.18