teamocil 0.4.5 → 1.0

data/lib/teamocil/layout/session.rb

@@ -1,30 +0,0 @@
-module Teamocil
-  class Layout
-    # This class represents a session within tmux
-    class Session
-      attr_reader :options, :windows, :name
-
-      # Initialize a new tmux session
-      #
-      # @param options [Hash] the options, mostly passed by the CLI
-      # @param attrs [Hash] the session data from the layout file
-      def initialize(options, attrs={})
-        raise Teamocil::Error::LayoutError.new("You must specify a `windows` or `session` key for your layout.") unless attrs["windows"]
-        @name = attrs["name"] || "teamocil-session-#{rand(10000) + 1}"
-        @windows = attrs["windows"].each_with_index.map { |window, window_index| Window.new(self, window_index, window) }
-        @options = options
-      end
-
-      # Generate commands to send to tmux
-      #
-      # @return [Array]
-      def generate_commands
-        commands = []
-        commands << "tmux rename-session \"#{@name}\"" unless @name.nil?
-        commands << @windows.map(&:generate_commands)
-        @windows.each { |w| commands << "tmux select-window -t:#{w.name}" && break if w.focus }
-        commands
-      end
-    end
-  end
-end

data/lib/teamocil/layout/window.rb

@@ -1,77 +0,0 @@
-module Teamocil
-  class Layout
-    # This class represents a window within tmux
-    class Window
-      attr_reader :filters, :focus, :root, :panes, :options, :index, :name, :clear, :layout, :with_env_var, :cmd_separator
-
-      # Initialize a new tmux window
-      #
-      # @param session [Session] the session where the window is initialized
-      # @param index [Fixnnum] the window index
-      # @param attrs [Hash] the window data from the layout file
-      def initialize(session, index, attrs={})
-        @name = attrs["name"] || "teamocil-window-#{index+1}"
-        @root = attrs["root"] || "."
-        @with_env_var = attrs["with_env_var"] || (true if attrs["with_env_var"].nil?)
-        @cmd_separator = attrs["cmd_separator"] || "; "
-        @clear = attrs["clear"] == true ? "clear" : nil
-        @options = attrs["options"] || {}
-        @layout = attrs["layout"]
-        @focus = attrs["focus"]
-
-        @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"] ||= []
-        @filters["after"] ||= []
-
-        @index = index
-        @session = session
-      end
-
-      # Generate commands to send to tmux
-      #
-      # @return [Array]
-      def generate_commands
-        commands = []
-
-        if @session.options.include?(:here) and @index == 0
-          commands << "tmux rename-window \"#{@name}\""
-        else
-          commands << "tmux new-window -n \"#{@name}\""
-        end
-
-        pane_commands = @panes.map do |pane|
-          c = pane.generate_commands
-          c << "tmux select-layout \"#{@layout}\"" if @layout
-          c
-        end
-        commands << pane_commands
-
-        @options.each_pair do |option, value|
-          value = "on"  if value === true
-          value = "off" if value === false
-          commands << "tmux set-window-option #{option} #{value}"
-        end
-
-        commands << "tmux select-layout \"#{@layout}\"" if @layout
-        commands << "tmux select-pane -t #{@panes.map(&:focus).index(true) || 0}"
-
-        commands
-      end
-
-      # Return the `pane-base-index` option for the current window
-      #
-      # @return [Fixnum]
-      def pane_base_index
-        @pane_base_index ||= begin
-          global_setting = `tmux show-window-options -g | grep pane-base-index`.split(/\s/).last
-          local_setting = `tmux show-window-options | grep pane-base-index`.split(/\s/).last
-          (local_setting || global_setting || "0").to_i
-        end
-      end
-    end
-  end
-end

data/spec/cli_spec.rb

@@ -1,79 +0,0 @@
-# encoding: utf-8
-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") }
-    end
-
-    context "not in tmux" do
-      it "should allow editing" do
-        FileUtils.stub(:touch)
-        Kernel.should_receive(:system).with("${EDITOR:-vim} #{File.join(@fake_env["HOME"], ".teamocil", "my-layout.yml").inspect}")
-        Teamocil::CLI.new(["--edit", "my-layout"], @fake_env)
-      end
-    end
-
-    context "in tmux" do
-      before :each do
-        Teamocil::CLI.messages = []
-      end
-
-      it "creates a layout from a name" 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 "fails to launch if no layout is provided" do
-        expect { @cli = Teamocil::CLI.new([], @fake_env) }.to raise_error SystemExit
-        Teamocil::CLI.messages.should include("You must supply a layout for teamocil to use. See `teamocil --help` for more options.")
-      end
-
-      it "fails to create a layout from a layout that doesn’t exist" do
-        expect { @cli = Teamocil::CLI.new(["i-do-not-exist"], @fake_env) }.to raise_error SystemExit
-        Teamocil::CLI.messages.should include("There is no file \"#{File.join(File.dirname(__FILE__), "fixtures", ".teamocil", "i-do-not-exist.yml")}\".")
-      end
-
-      it "creates a layout from a specific file" do
-        @cli = Teamocil::CLI.new(["--layout", "./spec/fixtures/.teamocil/sample.yml"], @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 "fails to create a layout from a file that doesn’t exist" do
-        expect { @cli = Teamocil::CLI.new(["--layout", "./spec/fixtures/.teamocil/i-do-not-exist.yml"], @fake_env) }.to raise_error SystemExit
-        Teamocil::CLI.messages.should include("There is no file \"./spec/fixtures/.teamocil/i-do-not-exist.yml\".")
-      end
-
-      it "lists available layouts" do
-        @cli = Teamocil::CLI.new(["--list"], @fake_env)
-        @cli.layouts.should == ["sample", "sample-2"]
-      end
-
-      it "should show the content" do
-        FileUtils.stub(:touch)
-        Kernel.should_receive(:system).with("cat #{File.join(@fake_env["HOME"], ".teamocil", "sample.yml").inspect}")
-        Teamocil::CLI.new(["--show", "sample"], @fake_env)
-      end
-
-      it "looks only in the $TEAMOCIL_PATH environment variable for layouts" do
-        @fake_env = { "TMUX" => 1, "HOME" => File.join(File.dirname(__FILE__), "fixtures"), "TEAMOCIL_PATH" => File.join(File.dirname(__FILE__), "fixtures/.my-fancy-layouts-directory") }
-
-        @cli = Teamocil::CLI.new(["sample-3"], @fake_env)
-        @cli.layout.session.name.should == "sample-3"
-
-        expect { @cli = Teamocil::CLI.new(["sample"], @fake_env) }.to raise_error SystemExit
-        Teamocil::CLI.messages.should include("There is no file \"#{@fake_env["TEAMOCIL_PATH"]}/sample.yml\".")
-      end
-    end
-  end
-end

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

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

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

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

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

@@ -1,10 +0,0 @@
-session:
-  name: sample
-  root: ~
-  windows:
-    - name: <%= "foo" %>
-      panes:
-      - cmd: "pwd"
-    - name: "bar"
-      panes:
-      - cmd: "pwd"

data/spec/fixtures/layouts.yml

@@ -1,76 +0,0 @@
-# Simple two windows layout
-two-windows:
-  windows:
-    - name: "foo"
-      clear: true
-      root: "/foo"
-      focus: true
-      layout: "tiled"
-      panes:
-        - cmd: "echo 'foo'"
-        - cmd: "echo 'foo again'"
-    - name: "bar"
-      root: "/bar"
-      splits:
-        - cmd:
-          - "echo 'bar'"
-          - "echo 'bar in an array'"
-          target: bottom-right
-        - cmd: "echo 'bar again'"
-          focus: true
-          width: 50
-
-# Simple two windows layout with filters
-two-windows-with-filters:
-  windows:
-    - name: "foo"
-      root: "/foo"
-      filters:
-        before:
-          - "echo first before filter"
-          - "echo second before filter"
-        after:
-          - "echo first after filter"
-          - "echo second after filter"
-      panes:
-        - cmd: "echo 'foo'"
-        - cmd: "echo 'foo again'"
-          width: 50
-
-two-windows-with-custom-command-options:
-  windows:
-    - name: "foo"
-      cmd_separator: "\n"
-      with_env_var: false
-      clear: true
-      root: "/foo"
-      layout: "tiled"
-      panes:
-        - cmd: "echo 'foo'"
-        - cmd: "echo 'foo again'"
-    - name: "bar"
-      cmd_separator: " && "
-      with_env_var: true
-      root: "/bar"
-      splits:
-        - cmd:
-          - "echo 'bar'"
-          - "echo 'bar in an array'"
-          target: bottom-right
-        - cmd: "echo 'bar again'"
-          focus: true
-          width: 50
-
-three-windows-within-a-session:
-  session:
-    name: "my awesome session"
-    windows:
-      - name: "first window"
-        panes:
-        - cmd: "echo 'foo'"
-      - name: "second window"
-        panes:
-        - cmd: "echo 'foo'"
-      - name: "third window"
-        panes:
-        - cmd: "echo 'foo'"

data/spec/layout_spec.rb

@@ -1,229 +0,0 @@
-# encoding: utf-8
-require File.join(File.dirname(__FILE__), "spec_helper.rb")
-
-describe Teamocil::Layout do
-  let(:window_pane_base_index) { 0 }
-  before do
-    Teamocil::Layout::Window.any_instance.stub(:pane_base_index).and_return(window_pane_base_index)
-    ENV.stub(:[]).with("SHELL").and_return("/usr/bin/bash")
-  end
-
-  context "compiling" do
-    before 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" }, {})
-        expect { @layout.compile! }.to raise_error Teamocil::Error::LayoutError
-      end
-
-      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 panes" do
-        @layout = Teamocil::Layout.new({ "windows" => [{ "name" => "foo", "panes" => [nil, nil] }] }, {})
-        expect { @layout.compile! }.to raise_error Teamocil::Error::LayoutError
-      end
-    end
-
-    describe "windows" do
-      it "creates windows" do
-        session = @layout.compile!
-        session.windows.each do |window|
-          window.should be_an_instance_of Teamocil::Layout::Window
-        end
-      end
-
-      it "creates windows with names" do
-        session = @layout.compile!
-        session.windows[0].name.should == "foo"
-        session.windows[1].name.should == "bar"
-      end
-
-      it "creates windows with root paths" do
-        session = @layout.compile!
-        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
-
-      it "creates windows with layout option" do
-        session = @layout.compile!
-        session.windows[0].layout.should == "tiled"
-        session.windows[1].layout.should be_nil
-      end
-
-      it "handles focused windows" do
-        session = @layout.compile!
-        session.windows.first.focus.should be_true
-      end
-    end
-
-    describe "panes" do
-      it "creates panes" do
-        session = @layout.compile!
-        session.windows.first.panes.each do |pane|
-          pane.should be_an_instance_of Teamocil::Layout::Pane
-        end
-      end
-
-      it "creates panes with legacy `splits` key" do
-        session = @layout.compile!
-        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.last.panes[0].width.should == nil
-        session.windows.last.panes[1].width.should == 50
-      end
-
-      it "creates panes with commands specified in strings" do
-        session = @layout.compile!
-        session.windows.first.panes[0].cmd.should == "echo 'foo'"
-      end
-
-      it "creates panes with commands specified in an array" do
-        session = @layout.compile!
-        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 panes" do
-        session = @layout.compile!
-        session.windows.last.panes[1].focus.should be_true
-        session.windows.last.panes[0].focus.should be_false
-      end
-    end
-
-    describe "filters" do
-      it "creates windows with before filters" do
-        layout = Teamocil::Layout.new(layouts["two-windows-with-filters"], {})
-        session = layout.compile!
-        session.windows.first.filters["before"].length.should == 2
-        session.windows.first.filters["before"].first.should == "echo first before filter"
-        session.windows.first.filters["before"].last.should == "echo second before filter"
-      end
-
-      it "creates windows with after filters" do
-        layout = Teamocil::Layout.new(layouts["two-windows-with-filters"], {})
-        session = layout.compile!
-        session.windows.first.filters["after"].length.should == 2
-        session.windows.first.filters["after"].first.should == "echo first after filter"
-        session.windows.first.filters["after"].last.should == "echo second after filter"
-      end
-
-      it "should handle blank filters" do
-        session = @layout.compile!
-        session.windows.first.filters.should have_key "after"
-        session.windows.first.filters.should have_key "before"
-        session.windows.first.filters["after"].should be_empty
-        session.windows.first.filters["before"].should be_empty
-      end
-    end
-
-    describe "targets" do
-      it "should handle panes without a target" do
-        session = @layout.compile!
-        session.windows.last.panes.last.target.should == nil
-      end
-
-      it "should handle panes with a target" do
-        session = @layout.compile!
-        session.windows.last.panes.first.target.should == "bottom-right"
-      end
-    end
-
-    describe "sessions" do
-      it "should handle windows within a session" do
-        layout = Teamocil::Layout.new(layouts["three-windows-within-a-session"], {})
-        session = layout.compile!
-        session.windows.length.should == 3
-        session.name.should == "my awesome session"
-      end
-
-      it "should assign a random name if none is provided" do
-        layout = Teamocil::Layout.new(layouts["two-windows"], {})
-        session = layout.compile!
-        session.name.should match /teamocil-session-\d+/
-      end
-    end
-  end
-
-  context "generating commands" do
-    before { @layout = Teamocil::Layout.new(layouts["two-windows"], {}) }
-
-    it "should generate pane commands" do
-      session = @layout.compile!
-      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.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"
-    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
-
-    it "should apply the layout after each pane is created" do
-      session = @layout.compile!
-      commands = session.windows.first.generate_commands
-      commands[1][0].should == ["tmux send-keys -t 0 \"export TEAMOCIL=1; cd \"/foo\"; clear; echo 'foo'\"", "tmux send-keys -t 0 Enter", "tmux select-layout \"tiled\""]
-      commands[1][1].should == ["tmux split-window", "tmux send-keys -t 1 \"export TEAMOCIL=1; cd \"/foo\"; clear; echo 'foo again'\"", "tmux send-keys -t 1 Enter", "tmux select-layout \"tiled\""]
-    end
-
-    it "should use fish syntax when fish shell is default shell" do
-      ENV.stub(:[]).with("SHELL").and_return("/usr/local/bin/fish")
-      session = @layout.compile!
-      commands = session.windows.last.panes[0].generate_commands
-      commands.length.should == 2
-      commands.first.should == "tmux send-keys -t 0 \"set -gx TEAMOCIL 1; cd \"/bar\"; echo 'bar'; echo 'bar in an array'\""
-      commands.last.should == "tmux send-keys -t 0 Enter"
-    end
-
-    context "with custom pane-base-index option" do
-      let(:window_pane_base_index) { 2 }
-
-      it "should generate pane commands" do
-        session = @layout.compile!
-        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"
-      end
-    end
-
-    it "should not export TEAMOCIL = 1 env variable if disabled" do
-      @layout = Teamocil::Layout.new(layouts["two-windows-with-custom-command-options"], {})
-
-      session = @layout.compile!
-      commands = session.windows.first.generate_commands
-      commands[1][0].should == ["tmux send-keys -t 0 \"cd \"/foo\"\nclear\necho 'foo'\"", "tmux send-keys -t 0 Enter", "tmux select-layout \"tiled\""]
-      commands[1][1].should == ["tmux split-window", "tmux send-keys -t 1 \"cd \"/foo\"\nclear\necho 'foo again'\"", "tmux send-keys -t 1 Enter", "tmux select-layout \"tiled\""]
-
-      commands = session.windows[1].generate_commands
-      commands[1][0].should == ["tmux send-keys -t 0 \"export TEAMOCIL=1 && cd \"/bar\" && echo 'bar' && echo 'bar in an array'\"", "tmux send-keys -t 0 Enter"]
-    end
-  end
-end