teamocil 0.1.10 → 0.1.11

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.rvmrc
+.local*
+.yardoc

data/.yardopts

@@ -0,0 +1,13 @@
+--title             "Teamocil"
+
+--no-cache
+--protected
+--no-private
+
+--markup            "markdown"
+--markup-provider   "maruku"
+
+--format html
+
+"README.mkd"
+"lib/**/*.rb"

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    teamocil (0.1.10)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    maruku (0.6.0)
+      syntax (>= 1.0.0)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    syntax (1.0.0)
+    yard (0.7.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  maruku
+  rake
+  rspec
+  teamocil!
+  yard

data/README.md

@@ -0,0 +1,189 @@
+# Teamocil
+
+Teamocil is a simple tool used to automatically create sessions, windows and splits in [tmux](http://tmux.sourceforge.net/) with YAML files.
+
+## Usage
+
+    $ gem install teamocil
+    $ mkdir ~/.teamocil
+    $ teamocil --edit sample
+    $ tmux
+    $ teamocil sample
+
+## Options
+
+* `--here` opens the session in the current window, it doesn’t 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`.
+
+## Layout file structure
+
+A layout file is a single YAML file located in `~/.teamocil` (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
+
+    session:
+      name: my-awesome-session
+      windows:
+       [windows list]
+
+### Windows
+
+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.
+
+#### 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)
+* `splits` (an array of split items)
+* `options` (a hash of tmux options, see `man tmux` for a list)
+
+#### Example
+
+    windows:
+      - name: my-first-window
+        options:
+          synchronize-panes: true
+        root: ~/Projects/foo-www
+        filters:
+          before:
+            - "echo 'Let’s use ruby-1.9.2 for each split in this window.'"
+            - "rvm use 1.9.2"
+        splits:
+          [splits list]
+      - name: my-second-window
+        root: ~/Projects/foo-api
+        filters:
+          after: "rvm use 1.9.2"
+        splits:
+          [splits list]
+      - name: my-third-window
+        root: ~/Projects/foo-daemons
+        splits:
+          [splits list]
+
+### Splits
+
+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.
+
+#### 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)
+
+#### Example
+
+    windows:
+      - name: my-first-window
+        root: ~/Projects/foo-www
+        filters:
+          before: "rvm use 1.9.2"
+          after: "echo 'I am done initializing this split.'"
+        splits:
+          - cmd: "git status"
+          - cmd: "bundle exec rails server --port 4000"
+            width: 50
+          - cmd:
+              - sudo service memcached start
+              - sudo service mongodb start
+            height: 50
+
+## Layout examples
+
+See more example files in the `examples` directory.
+
+### Simple two splits window
+
+#### Content of `~/.teamocil/sample-1.yml`
+
+    windows:
+      - name: sample-two-splits
+        root: ~/Code/sample/www
+        splits:
+          - cmd:
+            - pwd
+            - ls -la
+          - cmd: rails server --port 3000
+            width: 50
+
+#### Result of `$ teamocil sample-1`
+
+    .------------------.------------------.
+    | (0)              | (1)              |
+    |                  |                  |
+    |                  |                  |
+    |                  |                  |
+    |                  |                  |
+    |                  |                  |
+    |                  |                  |
+    |                  |                  |
+    |                  |                  |
+    '------------------'------------------'
+
+### Four tiled splits window
+
+#### Content of `~/.teamocil/sample-2.yml`
+
+    windows:
+      - name: sample-four-splits
+        root: ~/Code/sample/www
+        splits:
+          - cmd: pwd
+          - cmd: pwd
+            width: 50
+          - cmd: pwd
+            height: 50
+            target: bottom-right
+          - cmd: pwd
+            height: 50
+            target: bottom-left
+
+#### Result of `$ teamocil sample-2`
+
+    .------------------.------------------.
+    | (0)              | (1)              |
+    |                  |                  |
+    |                  |                  |
+    |                  |                  |
+    |------------------|------------------|
+    | (3)              | (2)              |
+    |                  |                  |
+    |                  |                  |
+    |                  |                  |
+    '------------------'------------------'
+
+## Extras
+
+### Zsh autocompletion
+
+To get autocompletion when typing `teamocil <Tab>` in a zsh session, add this line to your `~/.zshrc` file:
+
+    compctl -g '~/.teamocil/*(:t:r)' teamocil
+
+## Todo list
+
+* Support tmux options for windows and splits (eg. `synchronize-panes`)
+* Making sure the layout is valid before executing it
+* Refactor the `Layout` class to make it “test-friendly”
+
+## Contributors
+
+Feel free to contribute and submit issues/pull requests [on GitHub](https://github.com/remiprev/teamocil/issues), just like these fine folks did:
+
+* Samuel Garneau ([garno](https://github.com/garno))
+* Jimmy Bourassa ([jbourassa](https://github.com/jbourassa))
+
+## License
+
+Teamocil is © 2011 [Rémi Prévost](http://exomel.com) and may be freely distributed under the [LITL license](http://litl.info/). See the `LICENSE` file.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+desc "Run specs"
+task :spec do # {{{
+  sh "bundle exec rspec --color --format=nested #{Dir.glob(File.join(File.dirname(__FILE__), "spec/**/*_spec.rb")).join(" ")}"
+end # }}}
+
+desc "Generate documentation"
+task :doc do # {{{
+  sh "bundle exec yard doc"
+end # }}}

data/examples/simple-four-splits.yml

@@ -0,0 +1,12 @@
+windows:
+  - name: simple-four-splits
+    splits:
+      - cmd: "echo 'first split'"
+      - cmd: "echo 'second split'"
+        width: 50
+      - cmd: "echo 'fourth split'"
+        height: 50
+        target: bottom-right
+      - cmd: "echo 'third split'"
+        height: 50
+        target: bottom-left

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

@@ -0,0 +1,12 @@
+windows:
+  - name: simple-one-and-three-splits
+    splits:
+      - cmd: "echo 'first split'"
+      - cmd: "echo 'second split'"
+        width: 50
+      - cmd: "echo 'third split'"
+        height: 66
+        target: bottom-right
+      - cmd: "echo 'fourth split'"
+        height: 50
+        target: bottom-right

data/examples/simple-six-splits.yml

@@ -0,0 +1,18 @@
+windows:
+  - name: simple-six-splits
+    splits:
+      - cmd: "echo 'first split'"
+      - cmd: "echo 'second split'"
+        width: 50
+      - cmd: "echo 'fourth split'"
+        height: 66
+        target: bottom-right
+      - cmd: "echo 'third split'"
+        height: 66
+        target: bottom-left
+      - cmd: "echo 'sixth split'"
+        height: 50
+        target: bottom-right
+      - cmd: "echo 'fifth split'"
+        height: 50
+        target: bottom-left

data/examples/simple-two-horitonzal-splits.yml

@@ -0,0 +1,6 @@
+windows:
+  - name: simple-two-horizontal-splits
+    splits:
+      - cmd: "echo 'first split'"
+      - cmd: "echo 'second split'"
+        height: 50

data/examples/simple-two-vertical-splits.yml

@@ -0,0 +1,6 @@
+windows:
+  - name: simple-two-vertical-splits
+    splits:
+      - cmd: "echo 'first split'"
+      - cmd: "echo 'second split'"
+        width: 50

data/lib/teamocil.rb

@@ -1,5 +1,5 @@
 module Teamocil
-  VERSION = '0.1.10'
+  VERSION = "0.1.11"
   autoload :Layout, "teamocil/layout"
   autoload :CLI,    "teamocil/cli"
 end

data/lib/teamocil/cli.rb

@@ -24,7 +24,8 @@ module Teamocil
         system("$EDITOR \"#{file}\"")
       else
         bail "There is no file \"#{file}\"" unless File.exists?(file)
-        layout = Teamocil::Layout.new(file, @options)
+        parsed_layout = YAML.load_file(file)
+        layout = Teamocil::Layout.new(parsed_layout, @options)
         layout.to_tmux
       end
     end # }}}

data/lib/teamocil/layout.rb

@@ -2,12 +2,12 @@ module Teamocil
   # This class act as a wrapper around a tmux YAML layout file.
   class Layout
 
-    # Initialize a new layout from a file
+    # Initialize a new layout from a hash
     #
-    # @param file [String] the complete layout file path
-    # @param options [Hash]
-    def initialize(file, options) # {{{
-      @layout = YAML.load_file(file)
+    # @param layout [Hash] the parsed layout
+    # @param options [Hash] some options
+    def initialize(layout, options={}) # {{{
+      @layout = layout
       @options = options
     end # }}}
 
@@ -18,9 +18,12 @@ module Teamocil
     end # }}}
 
     # Generate tmux commands based on the data found in the layout file
+    #
+    # @return [Array] an array of shell commands to send
     def generate_commands # {{{
       output = []
 
+      # Support renaming of current session
       if @layout["session"].nil?
         windows = @layout["windows"]
       else
@@ -37,16 +40,15 @@ module Teamocil
           output << "tmux new-window -n \"#{window["name"]}\""
         end
 
-        # Make sure our filters return arrays
+        # Make sure we have all the keys we need
+        window["options"] ||= {}
         window["filters"] ||= {}
         window["filters"]["before"] ||= []
         window["filters"]["after"] ||= []
-        window["filters"]["before"] = [window["filters"]["before"]] unless window["filters"]["before"].is_a? Array
-        window["filters"]["after"] = [window["filters"]["after"]] unless window["filters"]["after"].is_a? Array
 
         # Create splits
-        window["splits"].each_with_index do |split, index|
-          unless index == 0
+        window["splits"].each_with_index do |split, split_index|
+          unless split_index == 0
             if split.include?("width")
               cmd = "tmux split-window -h -p #{split["width"]}"
             elsif split.include?("height")
@@ -58,24 +60,29 @@ module Teamocil
             output << cmd
           end
 
-          # Support single command splits, but treat it as an array nevertheless
-          split["cmd"] = [split["cmd"]] unless split["cmd"].is_a? Array
-
           # Wrap all commands around filters
-          split["cmd"] = window["filters"]["before"] + split["cmd"] + window["filters"]["after"]
+          split["cmd"] = [window["filters"]["before"]] + [split["cmd"]] + [window["filters"]["after"]]
 
           # If a `root` key exist, start each split in this directory
-          split["cmd"] = ["cd \"#{window["root"]}\""] + split["cmd"] if window.include?("root")
+          split["cmd"].unshift "cd \"#{window["root"]}\"" if window.include?("root")
 
           # Execute each split command
-          split["cmd"].compact.each do |command|
-            output << "tmux send-keys -t #{index} \"#{command}\""
-            output << "tmux send-keys -t #{index} Enter"
+          split["cmd"].flatten.compact.each do |command|
+            output << "tmux send-keys -t #{split_index} \"#{command}\""
+            output << "tmux send-keys -t #{split_index} Enter"
           end
         end
 
+        # Set tmux options
+        window["options"].each_pair do |option, value|
+          value = "on"  if value === true
+          value = "off" if value === false
+          output << "tmux set-window-option #{option} #{value}"
+        end
+
       end
 
+      # Set the focus in the first split
       output << "tmux select-pane -t 0"
     end # }}}
 

data/spec/fixtures/layouts.yml

@@ -0,0 +1,13 @@
+# Simple two windows layout
+two-windows:
+  windows:
+    - name: "foo"
+      splits:
+        - cmd: "echo 'foo'"
+        - cmd: "echo 'foo again'"
+          width: 50
+    - name: "bar"
+      splits:
+        - cmd: "echo 'bar'"
+        - cmd: "echo 'bar again'"
+          width: 50

data/spec/layout_spec.rb

@@ -0,0 +1,13 @@
+require File.join(File.dirname(__FILE__), "spec_helper.rb")
+
+describe Teamocil::Layout do
+  context "initializing" do
+
+    it "create two windows" do # {{{
+      layout = Teamocil::Layout.new(layouts["two-windows"], {})
+      commands = layout.generate_commands
+      commands.grep(/new-window/).length.should be 2
+    end # }}}
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'yaml'
+require 'teamocil'
+
+module Helpers
+
+  def layouts # {{{
+    return @@examples if defined?(@@examples)
+    @@examples = YAML.load_file(File.join(File.dirname(__FILE__), "fixtures/layouts.yml"))
+  end # }}}
+
+end
+
+RSpec.configure do |c|
+  c.include Helpers
+end

data/teamocil.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "teamocil"
+
+spec = Gem::Specification.new do |s|
+  # Metadata
+  s.name         = "teamocil"
+  s.version      = Teamocil::VERSION
+  s.platform     = Gem::Platform::RUBY
+  s.authors      = "Rémi Prévost"
+  s.email        = "remi@exomel.com"
+  s.homepage     = "http://github.com/remiprev/teamocil"
+  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."
+
+  # Manifest
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # Dependencies
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "yard"
+  s.add_development_dependency "maruku"
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: teamocil
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
   - 1
-  - 10
-  version: 0.1.10
+  - 11
+  version: 0.1.11
 platform: ruby
 authors: 
 - "R\xC3\xA9mi Pr\xC3\xA9vost"
@@ -15,9 +15,64 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-08 00:00:00 Z
-dependencies: []
-
+date: 2011-10-20 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: maruku
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: Teamocil helps you set up window and splits layouts for tmux using YAML configuration files.
 email: remi@exomel.com
 executables: 
@@ -27,11 +82,26 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/teamocil/cli.rb
-- lib/teamocil/layout.rb
-- lib/teamocil.rb
+- .gitignore
+- .yardopts
+- Gemfile
+- Gemfile.lock
 - LICENSE
+- README.md
+- Rakefile
 - bin/teamocil
+- examples/simple-four-splits.yml
+- examples/simple-one-and-three-splits.yml
+- examples/simple-six-splits.yml
+- examples/simple-two-horitonzal-splits.yml
+- examples/simple-two-vertical-splits.yml
+- lib/teamocil.rb
+- lib/teamocil/cli.rb
+- lib/teamocil/layout.rb
+- spec/fixtures/layouts.yml
+- spec/layout_spec.rb
+- spec/spec_helper.rb
+- teamocil.gemspec
 homepage: http://github.com/remiprev/teamocil
 licenses: []
 
@@ -65,5 +135,7 @@ rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Easy window and split layouts for tmux
-test_files: []
-
+test_files: 
+- spec/fixtures/layouts.yml
+- spec/layout_spec.rb
+- spec/spec_helper.rb