teamocil 0.2.2 → 0.3.1

data/.travis.yml

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    teamocil (0.2.2)
+    teamocil (0.3.1)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -2,13 +2,17 @@
 
 Teamocil is a simple tool used to automatically create sessions, windows and splits in [tmux](http://tmux.sourceforge.net/) with YAML files.
 
+[![Build Status](https://secure.travis-ci.org/remiprev/teamocil.png)](http://travis-ci.org/remiprev/teamocil)
+
 ## Usage
 
-    $ gem install teamocil
-    $ mkdir ~/.teamocil
-    $ teamocil --edit sample
-    $ tmux
-    $ teamocil sample
+```bash
+$ gem install teamocil
+$ mkdir ~/.teamocil
+$ teamocil --edit sample
+$ tmux
+$ teamocil sample
+```
 
 ## Options
 
@@ -30,10 +34,12 @@ You can wrap your entire layout file in a `session` and Teamocil will rename the
 
 #### Example
 
-    session:
-      name: my-awesome-session
-      windows:
-       [windows list]
+```yaml
+session:
+  name: "my-awesome-session"
+  windows:
+    [windows list]
+```
 
 ### Windows
 
@@ -49,27 +55,27 @@ If you are not using a top-level `session` key, then the first key of your layou
 
 #### 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]
+```yaml
+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"
+    splits:
+      [splits list]
+  - name: "my-third-window"
+    root: "~/Projects/foo-daemons"
+    splits:
+      [splits list]
+```
 
 ### Splits
 
@@ -84,20 +90,22 @@ Every window must define an array of splits that will be created within it. A ve
 
 #### 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
+```yaml
+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
 
@@ -107,15 +115,16 @@ See more example files in the `examples` directory.
 
 #### 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
+```yaml
+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`
 
@@ -135,19 +144,21 @@ See more example files in the `examples` directory.
 
 #### 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
+```yaml
+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`
 
@@ -169,7 +180,9 @@ See more example files in the `examples` directory.
 
 To get autocompletion when typing `teamocil <Tab>` in a zsh session, add this line to your `~/.zshrc` file:
 
-    compctl -g '~/.teamocil/*(:t:r)' teamocil
+```zsh
+compctl -g '~/.teamocil/*(:t:r)' teamocil
+```
 
 ## Todo list
 

data/lib/teamocil/cli.rb

@@ -5,6 +5,8 @@ module Teamocil
   # This class handles interaction with the `tmux` utility.
   class CLI
 
+    attr_accessor :layout, :layouts
+
     # Initialize a new run of `tmux`
     #
     # @param argv [Hash] the command line parameters hash (usually `ARGV`).
@@ -12,11 +14,18 @@ module Teamocil
     def initialize(argv, env) # {{{
       bail "You must be in a tmux session to use teamocil" unless env["TMUX"]
 
-      parse_options!
+      parse_options! argv
+      layout_path = File.join("#{env["HOME"]}", ".teamocil")
+
+      if @options.include?(:list)
+        @layouts = get_layouts(layout_path)
+        return print_layouts
+      end
+
       if @options.include?(:layout)
-        file = options[:layout]
+        file = @options[:layout]
       else
-        file = ::File.join("#{env["HOME"]}/.teamocil", "#{argv[0]}.yml")
+        file = ::File.join(layout_path, "#{argv[0]}.yml")
       end
 
       if @options[:edit]
@@ -25,14 +34,14 @@ module Teamocil
       else
         bail "There is no file \"#{file}\"" unless File.exists?(file)
         parsed_layout = YAML.load_file(file)
-        layout = Teamocil::Layout.new(parsed_layout, @options)
-        layout.compile!
-        layout.execute_commands(layout.generate_commands)
+        @layout = Teamocil::Layout.new(parsed_layout, @options)
+        @layout.compile!
+        @layout.execute_commands(@layout.generate_commands)
       end
     end # }}}
 
     # Parse the command line options
-    def parse_options! # {{{
+    def parse_options!(args) # {{{
       @options = {}
       opts = ::OptionParser.new do |opts|
         opts.banner = "Usage: teamocil [options] <layout>
@@ -47,19 +56,36 @@ module Teamocil
           @options[:edit] = true
         end
 
-        opts.on("--layout [LAYOUT]", "Use a specific layout file, instead of ~/.teamocil/<layout>.yml") do |layout|
+        opts.on("--layout [LAYOUT]", "Use a specific layout file, instead of `~/.teamocil/<layout>.yml`") do |layout|
           @options[:layout] = layout
         end
 
+        opts.on("--list", "List all available layouts in `~/.teamocil/`") do
+          @options[:list] = true
+        end
+
       end
-      opts.parse!
+      opts.parse! args
+    end # }}}
+
+    # Return an array of available layouts
+    #
+    # @param path [String] the path used to look for layouts
+    def get_layouts(path) # {{{
+      Dir.glob(File.join(path, "*.yml")).map { |file| File.basename(file).gsub(/\..+$/, "") }.sort
+    end # }}}
+
+    # Print each layout on a single line
+    def print_layouts # {{{
+      STDOUT.puts @layouts.join("\n")
+      exit 0
     end # }}}
 
     # Print an error message and exit the utility
     #
     # @param msg [Mixed] something to print before exiting.
     def bail(msg) # {{{
-      puts "[teamocil] #{msg}"
+      STDERR.puts "[teamocil] #{msg}"
       exit 1
     end # }}}
 

data/lib/teamocil/layout.rb

@@ -2,6 +2,7 @@ module Teamocil
 
   # This class act as a wrapper around a tmux YAML layout file
   class Layout
+    attr_reader :session
 
     # This class represents a session within tmux
     class Session

data/lib/teamocil.rb

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

data/spec/cli_spec.rb

@@ -0,0 +1,26 @@
+require File.join(File.dirname(__FILE__), "spec_helper.rb")
+
+describe Teamocil::CLI do
+
+  context "executing" do
+
+    before do # {{{
+      @fake_env = { "TMUX" => 1, "HOME" => File.join(File.dirname(__FILE__), "fixtures") }
+    end # }}}
+
+    it "creates a layout" do # {{{
+      @cli = Teamocil::CLI.new(["sample"], @fake_env)
+      @cli.layout.session.name.should == "sample"
+      @cli.layout.session.windows.length.should == 2
+      @cli.layout.session.windows.first.name.should == "foo"
+      @cli.layout.session.windows.last.name.should == "bar"
+    end # }}}
+
+    it "lists available layouts" do # {{{
+      @cli = Teamocil::CLI.new(["--list"], @fake_env)
+      @cli.layouts.should == ["sample", "sample-2"]
+    end # }}}
+
+  end
+
+end

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

@@ -0,0 +1,10 @@
+session:
+  name: sample-2
+  root: ~
+  windows:
+    - name: "foo"
+      splits:
+      - cmd: "pwd"
+    - name: "bar"
+      splits:
+      - cmd: "pwd"

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

@@ -0,0 +1,10 @@
+session:
+  name: sample
+  root: ~
+  windows:
+    - name: "foo"
+      splits:
+      - cmd: "pwd"
+    - name: "bar"
+      splits:
+      - cmd: "pwd"

data/spec/mock/cli.rb

@@ -0,0 +1,20 @@
+module Teamocil
+  module Mock
+    module CLI
+
+      def self.included(base) # {{{
+        base.class_eval do
+
+          # Do not print anything
+          def print_layouts
+            # Nothing
+          end
+
+        end
+      end # }}}
+
+    end
+  end
+end
+
+Teamocil::CLI.send :include, Teamocil::Mock::CLI

data/spec/mock/layout.rb

@@ -0,0 +1,20 @@
+module Teamocil
+  module Mock
+    module Layout
+
+      def self.included(base) # {{{
+        base.class_eval do
+
+          # Do not execute anything
+          def execute_commands(commands)
+            # Nothing
+          end
+
+        end
+      end # }}}
+
+    end
+  end
+end
+
+Teamocil::Layout.send :include, Teamocil::Mock::Layout

data/spec/spec_helper.rb

@@ -2,6 +2,8 @@ $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
 require 'yaml'
 require 'teamocil'
+require File.join(File.dirname(__FILE__), "./mock/layout.rb")
+require File.join(File.dirname(__FILE__), "./mock/cli.rb")
 
 module Helpers
 

data/teamocil.gemspec

@@ -1,4 +1,5 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
+
 $:.push File.expand_path("../lib", __FILE__)
 require "teamocil"
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: teamocil
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
-  - 2
-  - 2
-  version: 0.2.2
+  - 3
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - "R\xC3\xA9mi Pr\xC3\xA9vost"
@@ -15,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-26 00:00:00 Z
+date: 2012-01-21 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
-  prerelease: false
+  type: :development
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -29,11 +29,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  prerelease: false
   requirement: *id001
 - !ruby/object:Gem::Dependency 
   name: rspec
-  prerelease: false
+  type: :development
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -43,11 +43,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  prerelease: false
   requirement: *id002
 - !ruby/object:Gem::Dependency 
   name: yard
-  prerelease: false
+  type: :development
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -57,11 +57,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  prerelease: false
   requirement: *id003
 - !ruby/object:Gem::Dependency 
   name: maruku
-  prerelease: false
+  type: :development
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -71,7 +71,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  prerelease: false
   requirement: *id004
 description: Teamocil helps you set up window and splits layouts for tmux using YAML configuration files.
 email: remi@exomel.com
@@ -83,6 +83,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .travis.yml
 - .yardopts
 - Gemfile
 - Gemfile.lock
@@ -98,8 +99,13 @@ files:
 - lib/teamocil.rb
 - lib/teamocil/cli.rb
 - lib/teamocil/layout.rb
+- spec/cli_spec.rb
+- spec/fixtures/.teamocil/sample-2.yml
+- spec/fixtures/.teamocil/sample.yml
 - spec/fixtures/layouts.yml
 - spec/layout_spec.rb
+- spec/mock/cli.rb
+- spec/mock/layout.rb
 - spec/spec_helper.rb
 - teamocil.gemspec
 homepage: http://github.com/remiprev/teamocil
@@ -136,6 +142,11 @@ signing_key:
 specification_version: 3
 summary: Easy window and split layouts for tmux
 test_files: 
+- spec/cli_spec.rb
+- spec/fixtures/.teamocil/sample-2.yml
+- spec/fixtures/.teamocil/sample.yml
 - spec/fixtures/layouts.yml
 - spec/layout_spec.rb
+- spec/mock/cli.rb
+- spec/mock/layout.rb
 - spec/spec_helper.rb