teamocil 0.1.9 → 0.1.10

data/bin/teamocil

@@ -1,48 +1,8 @@
 #!/usr/bin/env ruby
 
-def bail(msg); puts msg; exit(1); end
-
 $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
 require 'yaml'
 require 'teamocil'
-require 'optparse'
-require 'fileutils'
-
-bail "You must be in a tmux session to use teamocil" unless ENV["TMUX"]
-
-options = {}
-opts = OptionParser.new do |opts|
-  opts.banner = "Usage: teamocil [options] <layout>
-
-Options:
-  "
-  opts.on("--here", "Set up the first window in the current window") do
-    options[:here] = true
-  end
-
-  opts.on("--edit", "Edit the YAML layout file instead of using it") do
-    options[:edit] = true
-  end
-
-  opts.on("--layout [LAYOUT]", "Use a specific layout file, instead of ~/.teamocil/<layout>.yml") do |layout|
-    options[:layout] = layout
-  end
-
-end
-opts.parse!
-
-if options.include?(:layout)
-  file = options[:layout]
-else
-  file = File.join("#{ENV["HOME"]}/.teamocil", "#{ARGV[0]}.yml")
-end
 
-if options[:edit]
-  FileUtils.touch file unless File.exists?(file)
-  system("$EDITOR \"#{file}\"")
-else
-  bail "There is no file \"#{file}\"" unless File.exists?(file)
-  layout = Teamocil::Layout.new(file, options)
-  layout.to_tmux
-end
+Teamocil::CLI.new(ARGV, ENV)

data/lib/teamocil.rb

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

data/lib/teamocil/cli.rb

@@ -0,0 +1,65 @@
+require 'optparse'
+require 'fileutils'
+
+module Teamocil
+  # This class handles interaction with the `tmux` utility.
+  class CLI
+
+    # Initialize a new run of `tmux`
+    #
+    # @param argv [Hash] the command line parameters hash (usually `ARGV`).
+    # @param env [Hash] the environment variables hash (usually `ENV`).
+    def initialize(argv, env) # {{{
+      bail "You must be in a tmux session to use teamocil" unless env["TMUX"]
+
+      parse_options!
+      if @options.include?(:layout)
+        file = options[:layout]
+      else
+        file = ::File.join("#{env["HOME"]}/.teamocil", "#{argv[0]}.yml")
+      end
+
+      if @options[:edit]
+        ::FileUtils.touch file unless File.exists?(file)
+        system("$EDITOR \"#{file}\"")
+      else
+        bail "There is no file \"#{file}\"" unless File.exists?(file)
+        layout = Teamocil::Layout.new(file, @options)
+        layout.to_tmux
+      end
+    end # }}}
+
+    # Parse the command line options
+    def parse_options! # {{{
+      @options = {}
+      opts = ::OptionParser.new do |opts|
+        opts.banner = "Usage: teamocil [options] <layout>
+
+      Options:
+        "
+        opts.on("--here", "Set up the first window in the current window") do
+          @options[:here] = true
+        end
+
+        opts.on("--edit", "Edit the YAML layout file instead of using it") do
+          @options[:edit] = true
+        end
+
+        opts.on("--layout [LAYOUT]", "Use a specific layout file, instead of ~/.teamocil/<layout>.yml") do |layout|
+          @options[:layout] = layout
+        end
+
+      end
+      opts.parse!
+    end # }}}
+
+    # Print an error message and exit the utility
+    #
+    # @param msg [Mixed] something to print before exiting.
+    def bail(msg) # {{{
+      puts "[teamocil] #{msg}"
+      exit 1
+    end # }}}
+
+  end
+end

data/lib/teamocil/layout.rb

@@ -1,18 +1,23 @@
 module Teamocil
+  # This class act as a wrapper around a tmux YAML layout file.
   class Layout
 
-    attr_accessor :layout, :options
-
+    # Initialize a new layout from a file
+    #
+    # @param file [String] the complete layout file path
+    # @param options [Hash]
     def initialize(file, options) # {{{
       @layout = YAML.load_file(file)
       @options = options
     end # }}}
 
+    # Generate commands and sends them to tmux
     def to_tmux # {{{
       commands = generate_commands
       execute_commands(commands)
     end # }}}
 
+    # Generate tmux commands based on the data found in the layout file
     def generate_commands # {{{
       output = []
 
@@ -25,12 +30,21 @@ module Teamocil
 
       windows.each_with_index do |window, window_index|
 
-        if options.include?(:here) and window_index == 0
+        # Create a new window unless we used the `--here` option
+        if @options.include?(:here) and window_index == 0
           output << "tmux rename-window \"#{window["name"]}\""
         else
           output << "tmux new-window -n \"#{window["name"]}\""
         end
 
+        # Make sure our filters return arrays
+        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
             if split.include?("width")
@@ -47,11 +61,14 @@ module Teamocil
           # 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"]
+
           # If a `root` key exist, start each split in this directory
           split["cmd"] = ["cd \"#{window["root"]}\""] + split["cmd"] if window.include?("root")
 
           # Execute each split command
-          split["cmd"].each do |command|
+          split["cmd"].compact.each do |command|
             output << "tmux send-keys -t #{index} \"#{command}\""
             output << "tmux send-keys -t #{index} Enter"
           end
@@ -62,6 +79,9 @@ module Teamocil
       output << "tmux select-pane -t 0"
     end # }}}
 
+    # Execute each command in the shell
+    #
+    # @param commands [Array] an array of complete commands to send to the shell
     def execute_commands(commands) # {{{
       `#{commands.join("; ")}`
     end # }}}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: teamocil
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 15
   prerelease: 
   segments: 
   - 0
   - 1
-  - 9
-  version: 0.1.9
+  - 10
+  version: 0.1.10
 platform: ruby
 authors: 
 - "R\xC3\xA9mi Pr\xC3\xA9vost"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-25 00:00:00 Z
+date: 2011-10-08 00:00:00 Z
 dependencies: []
 
 description: Teamocil helps you set up window and splits layouts for tmux using YAML configuration files.
@@ -27,9 +27,9 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/teamocil/cli.rb
 - lib/teamocil/layout.rb
 - lib/teamocil.rb
-- README.mkd
 - LICENSE
 - bin/teamocil
 homepage: http://github.com/remiprev/teamocil

data/README.mkd

@@ -1,69 +0,0 @@
-# Teamocil
-
-Teamocil is a tool used to automatically create sessions, windows and splits in `tmux` with Ruby and YAML. Like [tmuxinator](https://github.com/aziz/tmuxinator), but with splits, not just windows.
-
-## Usage
-
-    $ gem install teamocil
-    $ mkdir ~/.teamocil
-    $ touch ~/.teamocil/sample.yml
-    $ 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 example
-
-    # ~/.teamocil/sample.yml
-
-    session:
-      name: sample-session
-      windows:
-        - name: sample-window
-          root: ~/Code/sample/www
-          splits:
-            - cmd:
-              - ls -la
-              - git status
-            - cmd: rails server --port 3000
-              width: 50
-            - cmd: memcached -p 11211 -vv
-              height: 25
-              target: bottom-right
-
-Running `$ teamocil sample` will rename the session to `sample-session` and create a new window named `sample-window` with a layout like this:
-
-    .------------------.------------------.
-    | (0)              | (1)              |
-    |                  |                  |
-    |                  |                  |
-    |                  |                  |
-    |                  |                  |
-    |                  |                  |
-    |                  |------------------|
-    |                  | (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
-
-## Contributors
-
-Feel free to contribute and submit pull requests!
-
-* Samuel Garneau ([garno](https://github.com/garno))
-* Jimmy Bourassa ([jbourassa](https://github.com/jbourassa))
-
-## License
-
-Teamocil is © 2011 Rémi Prévost and may be freely distributed under the [LITL license](http://litl.info/). See the `LICENSE` file.