tmuxinator 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c09e2f806d313c2af1fbe0e9b4f14aca895b9ec0
-  data.tar.gz: 26480bf9d165619207b7341fe42495bfb3c353a7
+  metadata.gz: d4701d5ffcbc531c162e257f79c3f3399e106ec4
+  data.tar.gz: 94774dea4bbad7cfbc17f16d9428cd85061e2b5d
 SHA512:
-  metadata.gz: d45f97fc34f6ec6fc6b94e58dd0c8933fb41e3bfd3f39575f20d08cb076f1220e46585bb63a005b86a67002eea5a9a73f658e61d423f6436ef0039e981f8fded
-  data.tar.gz: e7de0f6e7ff0c4e4a3ae60b93e00e21b44f3809a59d9bc13ee09b3cf576f6719a5c90c86678d14e52c1175f10327ddbaf093bfa9f0ada9a988028f3d527e1f88
+  metadata.gz: fac94b03868d51bfac62e4205b91b4695a97d686d46759a09df7e33144e415b100b9b72984f7c0fd7d0146a27ac21c630d97729769e137047d0253ecf16afaa7
+  data.tar.gz: d9833164fd80716d76f19269f0eb07d424b57e788a2fe70f6c31c2a7f74130285a1a332e2b1401c2026a9a696afaa76cb76db7fa05e4934a7391912170e00e42

data/completion/mux.fish

@@ -1 +1 @@
-tmuxinator.fish
+completion/tmuxinator.fish

data/completion/tmuxinator.bash

@@ -22,3 +22,4 @@ _tmuxinator() {
 }
 
 complete -F _tmuxinator tmuxinator mux
+alias mux="tmuxinator"

data/completion/tmuxinator.fish

@@ -20,3 +20,5 @@ complete -f -c $__fish_tmuxinator_program_cmd -n '__fish_tmuxinator_using_comman
 complete -f -c $__fish_tmuxinator_program_cmd -n '__fish_tmuxinator_using_command open'      -a "(__fish_tmuxinator_program completions open)"
 complete -f -c $__fish_tmuxinator_program_cmd -n '__fish_tmuxinator_using_command copy'      -a "(__fish_tmuxinator_program completions copy)"
 complete -f -c $__fish_tmuxinator_program_cmd -n '__fish_tmuxinator_using_command delete'    -a "(__fish_tmuxinator_program completions delete)"
+
+abbr --add mux "tmuxinator"

data/completion/tmuxinator.zsh

@@ -18,6 +18,7 @@ _tmuxinator() {
 }
 
 compdef _tmuxinator tmuxinator mux
+alias mux="tmuxinator"
 
 # Local Variables:
 # mode: Shell-Script

data/lib/tmuxinator/assets/sample.yml

@@ -19,7 +19,10 @@ root: ~/
 # tmux_command: byobu
 
 # Specifies (by name or index) which window will be selected on project startup. If not set, the first window is used.
-# startup_window: logs
+# startup_window: editor
+
+# Specitifes (by index) which pane of the specified window will be selected on project startup. If not set, the first pane is used.
+# startup_pane: 1
 
 # Controls whether the tmux session should be attached to automatically. Defaults to true.
 # attach: false
@@ -30,6 +33,9 @@ root: ~/
 windows:
   - editor:
       layout: main-vertical
+      # Synchronize all panes of this window, can be enabled before or after the pane commands run.
+      # 'before' represents legacy functionality and will be deprecated in a future release, in favour of 'after'
+      # synchronize: after
       panes:
         - vim
         - guard

data/lib/tmuxinator/assets/template.erb

@@ -34,6 +34,9 @@ unset RBENV_DIR
   <% windows.each do |window| %>
 
   # Window "<%= window.name %>"
+    <% if window.synchronize_before? %>
+  <%= window.tmux_synchronize_panes %>
+    <% end %>
     <% unless window.panes? %>
       <% if window.project.pre_window %>
   <%= window.tmux_pre_window_command %>
@@ -49,12 +52,8 @@ unset RBENV_DIR
         <% if pane.tab.pre %>
   <%= pane.tmux_pre_command %>
         <% end %>
-        <% if pane.multiple_commands? %>
-          <% pane.commands.each do |command| %>
+        <% pane.commands.each do |command| %>
   <%= pane.tmux_main_command(command) %>
-          <% end %>
-        <% else %>
-  <%= pane.tmux_main_command(commands.first) %>
         <% end %>
 
         <% unless pane.last? %>
@@ -66,9 +65,14 @@ unset RBENV_DIR
   <%= window.tmux_layout_command %>
   <%= window.tmux_select_first_pane %>
     <% end %>
+
+    <% if window.synchronize_after? %>
+  <%= window.tmux_synchronize_panes %>
+    <% end %>
   <% end %>
 
   <%= tmux %> select-window -t <%= startup_window %>
+  <%= tmux %> select-pane -t <%= startup_pane %>
 <%- end -%>
 
 <%- if attach? -%>

data/lib/tmuxinator/assets/wemux_template.erb

@@ -23,6 +23,9 @@ if [ "$?" -eq 127 ]; then
   <%- windows.each do |window| -%>
 
   # Window "<%= window.name %>"
+    <% if window.synchronize_before? %>
+  <%= window.tmux_synchronize_panes %>
+    <% end %>
     <%- unless window.panes? -%>
   <%= window.tmux_pre_window_command %>
     <%- window.commands.each do |command| -%>
@@ -32,12 +35,8 @@ if [ "$?" -eq 127 ]; then
       <%- window.panes.each do |pane| -%>
   <%= pane.tmux_pre_window_command %>
   <%= pane.tmux_pre_command %>
-    <%- if pane.multiple_commands? %>
-          <%- pane.commands.each do |command| -%>
+        <%- pane.commands.each do |command| -%>
   <%= pane.tmux_main_command(command) %>
-          <%- end -%>
-        <%- else -%>
-  <%= pane.tmux_main_command(commands.first) %>
         <%- end -%>
 
       <%- unless pane.last? -%>
@@ -48,9 +47,14 @@ if [ "$?" -eq 127 ]; then
 
   <%= window.tmux_select_first_pane %>
     <%- end -%>
+
+    <%- if window.synchronize_after? -%>
+  <%= window.tmux_synchronize_panes %>
+    <%- end %>
   <%- end -%>
 
   <%= tmux %> select-window -t <%= startup_window %>
+  <%= tmux %> select-pane -t <%= startup_pane %>
 fi
 
 wemux attach

data/lib/tmuxinator/cli.rb

@@ -12,20 +12,19 @@ module Tmuxinator
       commands: "Lists commands available in tmuxinator",
       completions: "Used for shell completion",
       new: "Create a new project file and open it in your editor",
+      edit: "Alias of new",
       open: "Alias of new",
-      start: <<-DESC,
+      start: %w{
         Start a tmux session using a project's tmuxinator config,
         with an optional [ALIAS] for project reuse
-      DESC
-      stop: <<-DESC,
-        Stop a tmux session using a project's tmuxinator config.
-      DESC
+      }.join(" "),
+      stop: "Stop a tmux session using a project's tmuxinator config",
       local: "Start a tmux session using ./.tmuxinator.yml",
       debug: "Output the shell commands that are generated by tmuxinator",
-      copy: <<-DESC,
-        Copy an existing project to a new project and open it in
-        your editor
-      DESC
+      copy: %w{
+        Copy an existing project to a new project and
+        open it in your editor
+      }.join(" "),
       delete: "Deletes given project",
       implode: "Deletes all tmuxinator projects",
       version: "Display installed tmuxinator version",
@@ -53,7 +52,7 @@ module Tmuxinator
     desc "completions [arg1 arg2]", COMMANDS[:completions]
 
     def completions(arg)
-      if %w(start stop open copy delete).include?(arg)
+      if %w(start stop edit open copy delete).include?(arg)
         configs = Tmuxinator::Config.configs
         say configs.join("\n")
       end
@@ -81,7 +80,7 @@ module Tmuxinator
                else
                  Tmuxinator::Config.default_project(name)
                end
-        if File.exists?(path)
+        if File.exist?(path)
           path
         else
           generate_project_file(name, path)

data/lib/tmuxinator/config.rb

@@ -5,9 +5,9 @@ module Tmuxinator
 
     class << self
       def root
-        root_dir = File.expand_path("~/.tmuxinator")
-        Dir.mkdir("#{ENV['HOME']}/.tmuxinator") unless File.directory?(root_dir)
-        "#{ENV['HOME']}/.tmuxinator"
+        root_dir = File.expand_path("#{ENV['HOME']}/.tmuxinator")
+        Dir.mkdir(root_dir) unless File.directory?(root_dir)
+        root_dir
       end
 
       def sample
@@ -43,7 +43,7 @@ module Tmuxinator
       end
 
       def exists?(name)
-        File.exists?(project(name))
+        File.exist?(project(name))
       end
 
       def project_in_root(name)
@@ -56,7 +56,7 @@ module Tmuxinator
       end
 
       def project_in_local
-        [LOCAL_DEFAULT].detect { |f| File.exists?(f) }
+        [LOCAL_DEFAULT].detect { |f| File.exist?(f) }
       end
 
       def default_project(name)

data/lib/tmuxinator/pane.rb

@@ -53,9 +53,5 @@ module Tmuxinator
     def last?
       index == tab.panes.length - 1
     end
-
-    def multiple_commands?
-      commands && commands.length > 0
-    end
   end
 end

data/lib/tmuxinator/project.rb

@@ -16,6 +16,15 @@ module Tmuxinator
     DEPRECATION: The cli_args option has been replaced by the tmux_options
     option and will not be supported in 0.8.0.
     M
+    SYNC_DEP_MSG = <<-M
+    DEPRECATION: The synchronize option's current default behaviour is to
+    enable pane synchronization before running commands. In a future release,
+    the default syncronization option will be `after`, i.e. synchronization of
+    panes will occur after the commands described in each of the panes
+    have run. At that time, the current behavior will need to be explicitly
+    enabled, using the `synchronize: before` option.  To use this behaviour
+    now, use the 'synchronize: after' option.
+    M
 
     attr_reader :yaml
     attr_reader :force_attach
@@ -148,8 +157,11 @@ module Tmuxinator
     end
 
     def tmux_has_session?(name)
-      sessions = `#{tmux_command} ls`
-
+      # Redirect stderr to /dev/null in order to prevent "failed to connect
+      # to server: Connection refused" error message and non-zero exit status
+      # if no tmux sessions exist.
+      # Please see issues #402 and #414.
+      sessions = `#{tmux_command} ls 2> /dev/null`
       !!sessions.match("^#{name}:")
     end
 
@@ -183,10 +195,18 @@ module Tmuxinator
       get_pane_base_index ? get_pane_base_index.to_i : get_base_index.to_i
     end
 
+    def pane_base_index
+      get_pane_base_index.to_i
+    end
+
     def startup_window
       yaml["startup_window"] || base_index
     end
 
+    def startup_pane
+      yaml["startup_pane"] || pane_base_index
+    end
+
     def tmux_options?
       yaml["tmux_options"]
     end
@@ -228,6 +248,7 @@ module Tmuxinator
       deprecations << RBENVRVM_DEP_MSG if yaml["rbenv"] || yaml["rvm"]
       deprecations << TABS_DEP_MSG if yaml["tabs"]
       deprecations << CLIARGS_DEP_MSG if yaml["cli_args"]
+      deprecations << SYNC_DEP_MSG if legacy_synchronize?
       deprecations
     end
 
@@ -271,5 +292,19 @@ module Tmuxinator
 
       options_hash
     end
+
+    def legacy_synchronize?
+      (synchronize_options & [true, "before"]).any?
+    end
+
+    def synchronize_options
+      window_options.map do |option|
+        option["synchronize"] if option.is_a?(Hash)
+      end
+    end
+
+    def window_options
+      yaml["windows"].map(&:values).flatten
+    end
   end
 end

data/lib/tmuxinator/version.rb

@@ -1,3 +1,3 @@
 module Tmuxinator
-  VERSION = "0.8.1"
+  VERSION = "0.9.0"
 end

data/lib/tmuxinator/window.rb

@@ -2,7 +2,7 @@ module Tmuxinator
   class Window
     include Tmuxinator::Util
 
-    attr_reader :name, :root, :panes, :layout, :commands, :index, :project
+    attr_reader :name, :root, :panes, :layout, :commands, :index, :project, :synchronize
 
     def initialize(window_yaml, index, project)
       @name = if !window_yaml.keys.first.nil?
@@ -10,6 +10,7 @@ module Tmuxinator
               end
       @root = nil
       @panes = []
+      @synchronize = false
       @layout = nil
       @pre = nil
       @project = project
@@ -18,6 +19,7 @@ module Tmuxinator
       value = window_yaml.values.first
 
       if value.is_a?(Hash)
+        @synchronize = value["synchronize"] || false
         @layout = value["layout"] ? value["layout"].shellescape : nil
         @pre = value["pre"] if value["pre"]
         @root = if value["root"]
@@ -27,20 +29,23 @@ module Tmuxinator
                 end
 
         @panes = build_panes(value["panes"])
-      else
-        @commands = build_commands(tmux_window_command_prefix, value)
       end
+
+      @commands = build_commands(tmux_window_command_prefix, value)
     end
 
     def build_panes(panes_yml)
       Array(panes_yml).map.with_index do |pane_yml, index|
-        if pane_yml.is_a?(Hash)
-          pane_yml.map do |_name, commands|
-            Tmuxinator::Pane.new(index, project, self, *commands)
-          end
-        else
-          Tmuxinator::Pane.new(index, project, self, pane_yml)
-        end
+        commands =  case pane_yml
+                    when Hash
+                      pane_yml.values.first
+                    when Array
+                      pane_yml
+                    else
+                      pane_yml
+                    end
+
+        Tmuxinator::Pane.new(index, project, self, *commands)
       end.flatten
     end
 
@@ -99,6 +104,10 @@ module Tmuxinator
       "#{project.tmux} select-layout -t #{tmux_window_target} tiled"
     end
 
+    def tmux_synchronize_panes
+      "#{project.tmux} set-window-option -t #{tmux_window_target} synchronize-panes on"
+    end
+
     def tmux_layout_command
       "#{project.tmux} select-layout -t #{tmux_window_target} #{layout}"
     end
@@ -106,5 +115,13 @@ module Tmuxinator
     def tmux_select_first_pane
       "#{project.tmux} select-pane -t #{tmux_window_target}.#{panes.first.index + project.base_index}"
     end
+
+    def synchronize_before?
+      synchronize == true || synchronize == "before"
+    end
+
+    def synchronize_after?
+      synchronize == "after"
+    end
   end
 end

data/spec/factories/projects.rb

@@ -73,6 +73,14 @@ FactoryGirl.define do
     initialize_with { Tmuxinator::Project.new(file) }
   end
 
+  factory :noroot_project, class: Tmuxinator::Project do
+    transient do
+      file { yaml_load("spec/fixtures/noroot.yml") }
+    end
+
+    initialize_with { Tmuxinator::Project.new(file) }
+  end
+
   factory :nowindows_project, class: Tmuxinator::Project do
     transient do
       file { yaml_load("spec/fixtures/nowindows.yml") }

data/spec/fixtures/noroot.yml

@@ -0,0 +1,5 @@
+# ~/.tmuxinator/noroot.yml
+# you can make as many tabs as you wish...
+
+windows:
+  - test: echo foo

data/spec/fixtures/sample.deprecations.yml

@@ -32,3 +32,6 @@ tabs:
   - console: bundle exec rails c
   - capistrano:
   - server: ssh user@example.com
+windows:
+  - sample:
+    - synchronize: true

data/spec/lib/tmuxinator/cli_spec.rb

@@ -40,6 +40,7 @@ describe Tmuxinator::Cli do
       expected = %w(commands
                     completions
                     new
+                    edit
                     open
                     start
                     stop
@@ -181,7 +182,7 @@ describe Tmuxinator::Cli do
 
       before do
         # make sure that no project file exists initially
-        FileUtils.remove_file(path) if File.exists?(path)
+        FileUtils.remove_file(path) if File.exist?(path)
         expect(File).not_to exist(path)
 
         # now generate a project file
@@ -221,7 +222,7 @@ describe Tmuxinator::Cli do
 
       context "existing project doesn't exist" do
         before do
-          expect(File).to receive_messages(exists?: false)
+          expect(File).to receive_messages(exist?: false)
         end
 
         it "creates a new tmuxinator project file" do
@@ -234,8 +235,8 @@ describe Tmuxinator::Cli do
         let(:root_path) { "#{ENV['HOME']}\/\.tmuxinator\/#{name}\.yml" }
 
         before do
-          allow(File).to receive(:exists?).with(anything).and_return(false)
-          expect(File).to receive(:exists?).with(root_path).and_return(true)
+          allow(File).to receive(:exist?).with(anything).and_return(false)
+          expect(File).to receive(:exist?).with(root_path).and_return(true)
         end
 
         it "just opens the file" do
@@ -252,7 +253,7 @@ describe Tmuxinator::Cli do
 
       context "existing project doesn't exist" do
         before do
-          allow(File).to receive(:exists?).at_least(:once) do
+          allow(File).to receive(:exist?).at_least(:once) do
             false
           end
         end
@@ -266,7 +267,7 @@ describe Tmuxinator::Cli do
       context "files exists" do
         let(:path) { Tmuxinator::Config::LOCAL_DEFAULT }
         before do
-          expect(File).to receive(:exists?).with(path) { true }
+          expect(File).to receive(:exist?).with(path) { true }
         end
 
         it "just opens the file" do
@@ -489,7 +490,7 @@ describe Tmuxinator::Cli do
     let(:path) { Tmuxinator::Config.default_project(name) }
 
     after(:each) do
-      FileUtils.remove_file(path) if File.exists?(path)
+      FileUtils.remove_file(path) if File.exist?(path)
     end
 
     context "when the project file does not already exist" do
@@ -537,7 +538,7 @@ describe Tmuxinator::Cli do
     end
 
     after(:each) do
-      FileUtils.remove_file(path) if File.exists?(path)
+      FileUtils.remove_file(path) if File.exist?(path)
     end
 
     it "should always generate a project file" do

data/spec/lib/tmuxinator/config_spec.rb

@@ -48,8 +48,8 @@ describe Tmuxinator::Config do
 
     context "when the file exists" do
       before do
-        allow(File).to receive(:exists?).with(local_default) { false }
-        allow(File).to receive(:exists?).with(proj_default) { true }
+        allow(File).to receive(:exist?).with(local_default) { false }
+        allow(File).to receive(:exist?).with(proj_default) { true }
       end
 
       it "returns true" do
@@ -59,8 +59,8 @@ describe Tmuxinator::Config do
 
     context "when the file doesn't exist" do
       before do
-        allow(File).to receive(:exists?).with(local_default) { false }
-        allow(File).to receive(:exists?).with(proj_default) { false }
+        allow(File).to receive(:exist?).with(local_default) { false }
+        allow(File).to receive(:exist?).with(proj_default) { false }
       end
 
       it "returns true" do
@@ -147,7 +147,7 @@ describe Tmuxinator::Config do
 
   describe "#exists?" do
     before do
-      allow(File).to receive_messages(exists?: true)
+      allow(File).to receive_messages(exist?: true)
       allow(Tmuxinator::Config).to receive_messages(project: "")
     end
 
@@ -181,7 +181,7 @@ describe Tmuxinator::Config do
   describe "#local?" do
     it "checks if the given project exists" do
       path = Tmuxinator::Config::LOCAL_DEFAULT
-      expect(File).to receive(:exists?).with(path) { true }
+      expect(File).to receive(:exist?).with(path) { true }
       expect(Tmuxinator::Config.local?).to be_truthy
     end
   end
@@ -191,7 +191,7 @@ describe Tmuxinator::Config do
 
     context "with a project yml" do
       it "gets the project as path to the yml file" do
-        expect(File).to receive(:exists?).with(default) { true }
+        expect(File).to receive(:exist?).with(default) { true }
         expect(Tmuxinator::Config.project_in_local).to eq default
       end
     end
@@ -220,7 +220,7 @@ describe Tmuxinator::Config do
 
     context "with a local project, but no project in root" do
       it "gets the project as path to the yml file" do
-        expect(File).to receive(:exists?).with(default) { true }
+        expect(File).to receive(:exist?).with(default) { true }
         expect(Tmuxinator::Config.project("sample")).to eq "./.tmuxinator.yml"
       end
     end
@@ -253,7 +253,7 @@ describe Tmuxinator::Config do
 
     context "when no project name is provided" do
       it "should raise if the local project file doesn't exist" do
-        expect(File).to receive(:exists?).with(default) { false }
+        expect(File).to receive(:exist?).with(default) { false }
         expect do
           Tmuxinator::Config.validate
         end.to raise_error RuntimeError, %r{Project.+doesn't.exist}
@@ -262,7 +262,7 @@ describe Tmuxinator::Config do
       it "should load and validate the project" do
         content = File.read(File.join(path, "sample.yml"))
 
-        expect(File).to receive(:exists?).with(default).at_least(:once) { true }
+        expect(File).to receive(:exist?).with(default).at_least(:once) { true }
         expect(File).to receive(:read).with(default).and_return(content)
 
         expect(Tmuxinator::Config.validate).to be_a Tmuxinator::Project

data/spec/lib/tmuxinator/project_spec.rb

@@ -23,6 +23,7 @@ describe Tmuxinator::Project do
 
   let(:wemux_project) { FactoryGirl.build(:wemux_project) }
   let(:noname_project) { FactoryGirl.build(:noname_project) }
+  let(:noroot_project) { FactoryGirl.build(:noroot_project) }
   let(:nameless_window_project) do
     FactoryGirl.build(:nameless_window_project)
   end
@@ -57,24 +58,40 @@ describe Tmuxinator::Project do
   end
 
   describe "#tmux_has_session?" do
-    before do
-      cmd = "#{project.tmux_command} ls"
-      resp = ""\
-        "foo: 1 window (created Sun May 25 10:12:00 1986) [50x50] (detached)\n"\
-        "bar: 1 window (created Sat Sept 01 00:00:00 1990) [50x50] (detached)"
-      call_tmux_ls = receive(:`).with(cmd).at_least(:once).and_return(resp)
+    context "no active sessions" do
+      before do
+        cmd = "#{project.tmux_command} ls 2> /dev/null"
+        resp = ""
+        call_tmux_ls = receive(:`).with(cmd).at_least(:once).and_return(resp)
 
-      expect(project).to call_tmux_ls
-    end
+        expect(project).to call_tmux_ls
+      end
 
-    it "should return true only when `tmux ls` has the named session" do
-      expect(project.tmux_has_session?("foo")).to be true
-      expect(project.tmux_has_session?("bar")).to be true
-      expect(project.tmux_has_session?("quux")).to be false
+      it "should return false if no sessions are found" do
+        expect(project.tmux_has_session?("no server running")).to be false
+      end
     end
 
-    it "should return false if a partial (prefix) match is found" do
-      expect(project.tmux_has_session?("foobar")).to be false
+    context "active sessions" do
+      before do
+        cmd = "#{project.tmux_command} ls 2> /dev/null"
+        resp = ""\
+          "foo: 1 window (created Sun May 25 10:12:00 1986) [0x0] (detached)\n"\
+          "bar: 1 window (created Sat Sept 01 00:00:00 1990) [0x0] (detached)"
+        call_tmux_ls = receive(:`).with(cmd).at_least(:once).and_return(resp)
+
+        expect(project).to call_tmux_ls
+      end
+
+      it "should return true only when `tmux ls` has the named session" do
+        expect(project.tmux_has_session?("foo")).to be true
+        expect(project.tmux_has_session?("bar")).to be true
+        expect(project.tmux_has_session?("quux")).to be false
+      end
+
+      it "should return false if a partial (prefix) match is found" do
+        expect(project.tmux_has_session?("foobar")).to be false
+      end
     end
   end
 
@@ -107,7 +124,7 @@ describe Tmuxinator::Project do
 
     context "without root" do
       it "doesn't throw an error" do
-        expect { noname_project.root }.to_not raise_error
+        expect { noroot_project.root }.to_not raise_error
       end
     end
   end
@@ -310,6 +327,24 @@ describe Tmuxinator::Project do
     end
   end
 
+  describe "#startup_pane" do
+    context "startup pane specified" do
+      it "get the startup pane index from project config" do
+        project.yaml["startup_pane"] = 1
+
+        expect(project.startup_pane).to eq(1)
+      end
+    end
+
+    context "startup pane not specified" do
+      it "returns the base pane instead" do
+        allow(project).to receive_messages(pane_base_index: 4)
+
+        expect(project.startup_pane).to eq(4)
+      end
+    end
+  end
+
   describe "#window" do
     it "gets the window and index for tmux" do
       expect(project.window(1)).to eq "sample:1"

data/spec/lib/tmuxinator/window_spec.rb

@@ -4,6 +4,7 @@ describe Tmuxinator::Window do
   let(:project) { double }
   let(:panes) { ["vim", nil, "top"] }
   let(:window_name) { "editor" }
+  let(:synchronize) { false }
   let(:yaml) do
     {
       window_name => {
@@ -11,6 +12,7 @@ describe Tmuxinator::Window do
           "echo 'I get run in each pane.  Before each pane command!'",
           nil
         ],
+        "synchronize" => synchronize,
         "layout" => "main-vertical",
         "panes" => panes
       }
@@ -34,6 +36,25 @@ describe Tmuxinator::Window do
   let(:window) { Tmuxinator::Window.new(yaml, 0, project) }
   let(:window_root) { Tmuxinator::Window.new(yaml_root, 0, project) }
 
+  shared_context "window command context" do
+    let(:project) { double(:project) }
+    let(:window) { Tmuxinator::Window.new(yaml, 0, project) }
+    let(:root?) { true }
+    let(:root) { "/project/tmuxinator" }
+
+    before do
+      allow(project).to receive_messages(
+        name: "test",
+        tmux: "tmux",
+        root: root,
+        root?: root?,
+        base_index: 1
+      )
+    end
+
+    let(:tmux_part) { project.tmux }
+  end
+
   before do
     allow(project).to receive_messages(
       tmux: "tmux",
@@ -65,14 +86,8 @@ describe Tmuxinator::Window do
   end
 
   describe "#panes" do
-    let(:pane) { double(:pane) }
-
-    before do
-      allow(Tmuxinator::Pane).to receive_messages new: pane
-    end
-
     context "with a three element Array" do
-      let(:panes) { ["vim", nil, "top"] }
+      let(:panes) { ["vim", "ls", "top"] }
 
       it "creates three panes" do
         expect(Tmuxinator::Pane).to receive(:new).exactly(3).times
@@ -80,35 +95,63 @@ describe Tmuxinator::Window do
       end
 
       it "returns three panes" do
-        expect(window.panes).to eql [pane, pane, pane]
+        expect(window.panes).to all be_a_pane.with(
+          project: project, tab: window
+        )
+
+        expect(window.panes).to match([
+          a_pane.with(index: 0).and_commands("vim"),
+          a_pane.with(index: 1).and_commands("ls"),
+          a_pane.with(index: 2).and_commands("top")
+        ])
       end
     end
 
     context "with a String" do
       let(:panes) { "vim" }
 
-      it "creates one pane" do
-        expect(Tmuxinator::Pane).to receive(:new).once
-        window.panes
-      end
-
       it "returns one pane in an Array" do
-        expect(window.panes).to eql [pane]
+        expect(window.panes.first).to be_a_pane.
+          with(index: 0).and_commands("vim")
       end
     end
 
     context "with nil" do
       let(:panes) { nil }
 
-      it "doesn't create any panes" do
-        expect(Tmuxinator::Pane).to_not receive(:new)
-        window.panes
-      end
-
       it "returns an empty Array" do
         expect(window.panes).to be_empty
       end
     end
+
+    context "nested collections" do
+      let(:command1) { "cd /tmp/" }
+      let(:command2) { "ls" }
+
+      let(:panes) { ["vim", nested_collection] }
+
+      context "with nested hash" do
+        let(:nested_collection) { { pane2: [command1, command2] } }
+
+        it "returns two panes in an Array" do
+          expect(window.panes).to match [
+            a_pane.with(index: 0).and_commands("vim"),
+            a_pane.with(index: 1).and_commands(command1, command2)
+          ]
+        end
+      end
+
+      context "with nested array" do
+        let(:nested_collection) { [command1, command2] }
+
+        it "returns two panes in an Array" do
+          expect(window.panes).to match [
+            a_pane.with(index: 0).and_commands("vim"),
+            a_pane.with(index: 1).and_commands(command1, command2)
+          ]
+        end
+      end
+    end
   end
 
   describe "#pre" do
@@ -166,6 +209,16 @@ describe Tmuxinator::Window do
         expect(window.commands).to be_empty
       end
     end
+
+    context "command is a hash" do
+      before do
+        yaml["editor"] = { "layout" => "main-horizontal", "panes" => [nil] }
+      end
+
+      it "returns an empty array" do
+        expect(window.commands).to be_empty
+      end
+    end
   end
 
   describe "#name_options" do
@@ -186,23 +239,94 @@ describe Tmuxinator::Window do
     end
   end
 
-  describe "#tmux_new_window_command" do
-    let(:project) { double(:project) }
-    let(:window) { Tmuxinator::Window.new(yaml, 0, project) }
-    let(:root?) { true }
-    let(:root) { "/project/tmuxinator" }
+  describe "#synchronize_before?" do
+    subject { window.synchronize_before? }
 
-    before do
-      allow(project).to receive_messages(
-        name: "test",
-        tmux: "tmux",
-        root: root,
-        root?: root?,
-        base_index: 1
-      )
+    context "synchronize is 'before'" do
+      let(:synchronize) { "before" }
+
+      it { is_expected.to be true }
     end
 
-    let(:tmux_part) { project.tmux }
+    context "synchronize is true" do
+      let(:synchronize) { true }
+
+      it { is_expected.to be true }
+    end
+
+    context "synchronize is 'after'" do
+      let(:synchronize) { "after" }
+
+      it { is_expected.to be false }
+    end
+
+    context "synchronization disabled" do
+      let(:synchronize) { false }
+
+      it { is_expected.to be false }
+    end
+
+    context "synchronization not specified" do
+      it { is_expected.to be false }
+    end
+  end
+
+  describe "#synchronize_after?" do
+    subject { window.synchronize_after? }
+
+    context "synchronization is 'after'" do
+      let(:synchronize) { "after" }
+
+      it { is_expected.to be true }
+    end
+
+    context "synchronization is true" do
+      let(:synchronize) { true }
+
+      it { is_expected.to be false }
+    end
+
+    context "synchronization is 'before'" do
+      let(:synchronize) { "before" }
+
+      it { is_expected.to be false }
+    end
+
+    context "synchronization disabled" do
+      let(:synchronize) { false }
+
+      it { is_expected.to be false }
+    end
+
+    context "synchronization not specified" do
+      it { is_expected.to be false }
+    end
+  end
+
+  describe "#tmux_synchronize_panes" do
+    include_context "window command context"
+
+    let(:window_option_set_part) { "set-window-option" }
+    let(:target_part) { "-t #{window.tmux_window_target}" }
+    let(:synchronize_panes_part) { "synchronize-panes" }
+
+    context "synchronization enabled" do
+      let(:synchronize) { true }
+      let(:enabled) { "on" }
+
+      let(:full_command) do
+        "#{tmux_part} #{window_option_set_part} #{target_part} #{synchronize_panes_part} #{enabled}"
+      end
+
+      it "should set the synchronize-panes window option on" do
+        expect(window.tmux_synchronize_panes).to eq full_command
+      end
+    end
+  end
+
+  describe "#tmux_new_window_command" do
+    include_context "window command context"
+
     let(:window_part) { "new-window" }
     let(:name_part) { window.tmux_window_name_option }
     let(:target_part) { "-t #{window.tmux_window_target}" }

data/spec/matchers/pane_matcher.rb

@@ -0,0 +1,44 @@
+RSpec::Matchers.alias_matcher :be_a_pane, :a_pane
+RSpec::Matchers.define :a_pane do
+  attr_reader :commands
+
+  match do
+    result = is_pane
+
+    result && attributes_match if @expected_attrs
+    result &&= commands_match if commands
+
+    result
+  end
+
+  failure_message do |actual|
+    return "Expected #{actual} to be a Tmuxinator::Pane" unless is_pane
+
+    msg = "Actual pane does not match expected"
+    msg << "\n  Expected #{@commands} but has #{actual.commands}" if @commands
+    msg << "\n  Expected pane to have #{@expected_attrs}" if @expected_attrs
+  end
+
+  chain :with do |attrs|
+    @expected_attrs = attrs
+  end
+
+  chain :with_commands do |*expected|
+    @commands = expected
+  end
+  alias_method :and_commands, :with_commands
+
+  private
+
+  def attributes_match
+    expect(@actual).to have_attributes(@expected_attrs)
+  end
+
+  def commands_match
+    @actual.commands == commands
+  end
+
+  def is_pane
+    @actual.is_a? Tmuxinator::Pane
+  end
+end

data/spec/spec_helper.rb

@@ -16,6 +16,9 @@ require "factory_girl"
 
 FactoryGirl.find_definitions
 
+# Custom Matchers
+require_relative "matchers/pane_matcher"
+
 RSpec.configure do |config|
   config.order = "random"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tmuxinator
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Allen Bargi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-19 00:00:00.000000000 Z
+date: 2016-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -64,12 +64,10 @@ email:
 - allen.bargi@gmail.com
 - chris@chowie.net
 executables:
-- mux
 - tmuxinator
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/mux
 - bin/tmuxinator
 - completion/mux.fish
 - completion/tmuxinator.bash
@@ -92,6 +90,7 @@ files:
 - spec/fixtures/detach.yml
 - spec/fixtures/nameless_window.yml
 - spec/fixtures/noname.yml
+- spec/fixtures/noroot.yml
 - spec/fixtures/nowindows.yml
 - spec/fixtures/sample.deprecations.yml
 - spec/fixtures/sample.yml
@@ -105,6 +104,7 @@ files:
 - spec/lib/tmuxinator/util_spec.rb
 - spec/lib/tmuxinator/wemux_support_spec.rb
 - spec/lib/tmuxinator/window_spec.rb
+- spec/matchers/pane_matcher.rb
 - spec/spec_helper.rb
 homepage: https://github.com/tmuxinator/tmuxinator
 licenses:
@@ -131,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.8.23
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Create and manage complex tmux sessions easily.
@@ -140,6 +140,7 @@ test_files:
 - spec/fixtures/detach.yml
 - spec/fixtures/nameless_window.yml
 - spec/fixtures/noname.yml
+- spec/fixtures/noroot.yml
 - spec/fixtures/nowindows.yml
 - spec/fixtures/sample.deprecations.yml
 - spec/fixtures/sample.yml
@@ -153,4 +154,5 @@ test_files:
 - spec/lib/tmuxinator/util_spec.rb
 - spec/lib/tmuxinator/wemux_support_spec.rb
 - spec/lib/tmuxinator/window_spec.rb
+- spec/matchers/pane_matcher.rb
 - spec/spec_helper.rb

data/bin/mux

@@ -1 +0,0 @@
-tmuxinator