tmuxinator 3.3.8 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52752c91945099b9d08880c8dc405cd68a68497a9be91c3fda3cb6647730fc51
-  data.tar.gz: 2f05391d0c2fd4a2bddc49740744a8102e67a88dd80fe7cd68ec1d123f678f01
+  metadata.gz: 322e55351978533f2dcca159c0f3cdd068baa6ff6a74105c26ef4ff788ecd033
+  data.tar.gz: 64aa7c6fb70e76019575e090e6f56b43be3b88e64e6efb3f7a91a94f0ba96963
 SHA512:
-  metadata.gz: befa8c88430163f9912bcea81c4dbcbefb6d29d05ce38c9f7799b17d065cc47b70abd08fe7056aa1d3d291152d5c8fedccbe3e458bcb1697b225720b03a44ad8
-  data.tar.gz: 6b966f0247e33fde76cb856fd4ebaa3840e7da66ef39e4e48f6d710ffe9d6cc7c60beb493e7f573d9d52b48c9213cca6723a3f602dfbfa8f9811c4d629e94503
+  metadata.gz: 78c824a5705cc25a9cb7bb013053006c2cdf943b5b158e1431e44b5fe6ddd75db31efca58c6ec5c693f919c2d1b21f4fba7728ed7e260f6452849f4de5d3e5bb
+  data.tar.gz: 5530202ccef42f13efce8b6082d1af63d80365896251f018f118437746e01278bf8080634a7996e86c67e1ab8280c7d6be8f4f36e0ca0ea717ccda2b9d0cfabc

data/lib/tmuxinator/assets/sample.yml

@@ -38,7 +38,7 @@ root: ~/
 # Specifies (by name or index) which window will be selected on project startup. If not set, the first window is used.
 # startup_window: editor
 
-# Specifies (by index) which pane of the specified window will be selected on project startup. If not set, the first pane is used.
+# Specifies (by index) which pane of the startup 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.
@@ -47,11 +47,17 @@ root: ~/
 windows:
   - editor:
       layout: main-vertical
+      panes:
+        - editor: vim
+        - guard
+      # Focus a pane in this window by name or index. Indices are based off zero and automatically adjusted to your pane-base-index.
+      # This affects the window's selected pane during setup; `startup_window` and `startup_pane`
+      # still control the final window/pane selected when the project starts.
+      # focused_pane: editor
+
       # 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
   - server: bundle exec rails s
   - logs: tail -f log/development.log

data/lib/tmuxinator/assets/template.erb

@@ -1,5 +1,6 @@
 #!<%= ENV["SHELL"] || "/bin/bash" %>
 
+
 <%- if !append? -%>
   # Clear rbenv variables before starting tmux
   unset RBENV_VERSION
@@ -85,7 +86,7 @@ cd <%= root || "." %>
       <% end %>
 
   <%= window.tmux_layout_command %>
-  <%= window.tmux_select_first_pane %>
+  <%= window.tmux_focus_pane_command %>
     <% end %>
 
     <% if window.synchronize_after? %>
@@ -94,7 +95,7 @@ cd <%= root || "." %>
   <% end %>
 
   <%= tmux %> select-window -t <%= startup_window %>
-  <%= tmux %> select-pane -t <%= startup_pane %>
+  <%= tmux_startup_pane_command %>
 <%- else -%>
   # Run on_project_restart command.
   <%= hook_on_project_restart %>

data/lib/tmuxinator/assets/wemux_template.erb

@@ -45,7 +45,7 @@ if [ "$?" -eq 127 ]; then
   <%= window.tmux_layout_command %>
     <%- end -%>
 
-  <%= window.tmux_select_first_pane %>
+  <%= window.tmux_focus_pane_command %>
     <%- end -%>
 
     <%- if window.synchronize_after? -%>
@@ -54,7 +54,7 @@ if [ "$?" -eq 127 ]; then
   <%- end -%>
 
   <%= tmux %> select-window -t <%= startup_window %>
-  <%= tmux %> select-pane -t <%= startup_pane %>
+  <%= tmux_startup_pane_command %>
 fi
 
 wemux attach

data/lib/tmuxinator/cli.rb

@@ -22,13 +22,13 @@ module Tmuxinator
       debug: "Output the shell commands that are generated by tmuxinator",
       delete: "Deletes given project",
       doctor: "Look for problems in your configuration",
-      edit: "Alias of new",
+      edit: "Edit an existing project file in your editor",
       help: "Shows help for a specific command",
       implode: "Deletes all tmuxinator projects",
       local: "Start a tmux session using ./.tmuxinator.y[a]ml",
       list: "Lists all tmuxinator projects",
       new: "Create a new project file and open it in your editor",
-      open: "Alias of new",
+      open: "Create or open a project file in your editor",
       start: %w{
         Start a tmux session using a project's name (with an optional [ALIAS]
         for project reuse) or a path to a project config file (via the -p flag)
@@ -76,14 +76,10 @@ module Tmuxinator
     end
 
     desc "new [PROJECT] [SESSION]", COMMANDS[:new]
-    map "open" => :new
-    map "edit" => :new
-    map "o" => :new
-    map "e" => :new
     map "n" => :new
     method_option :local, type: :boolean,
                           aliases: ["-l"],
-                          desc: "Create local project file at ./.tmuxinator.yml"
+                          desc: "Use local project file at ./.tmuxinator.yml"
     method_option :help, type: :boolean,
                          aliases: ["-h"],
                          desc: "Display usage information"
@@ -101,6 +97,49 @@ module Tmuxinator
       end
     end
 
+    desc "open [PROJECT]", COMMANDS[:open]
+    map "o" => :open
+    method_option :local, type: :boolean,
+                          aliases: ["-l"],
+                          desc: "Use local project file at ./.tmuxinator.yml"
+    method_option :help, type: :boolean,
+                         aliases: ["-h"],
+                         desc: "Display usage information"
+
+    def open(name = nil)
+      if options[:help] || name.nil?
+        invoke :help, ["open"]
+        return
+      end
+
+      new_project(name)
+    end
+
+    desc "edit [PROJECT]", COMMANDS[:edit]
+    map "e" => :edit
+    method_option :local, type: :boolean,
+                          aliases: ["-l"],
+                          desc: "Use local project file at ./.tmuxinator.yml"
+    method_option :help, type: :boolean,
+                         aliases: ["-h"],
+                         desc: "Display usage information"
+
+    def edit(name = nil)
+      if options[:help] || (name.nil? && !options[:local])
+        invoke :help, ["edit"]
+        return
+      end
+
+      path = config_path(name, local: options[:local])
+      if File.exist?(path)
+        Kernel.system("$EDITOR #{path}") || doctor
+      elsif options[:local] && name.nil?
+        exit! Tmuxinator::Config::NO_LOCAL_FILE_MSG
+      else
+        exit! "Project #{name} doesn't exist!"
+      end
+    end
+
     no_commands do
       def new_project(name)
         project_file = find_project_file(name, local: options[:local])

data/lib/tmuxinator/project.rb

@@ -155,7 +155,7 @@ module Tmuxinator
           custom_name || yaml["project_name"] || yaml["name"]
         end
 
-      blank?(name) ? nil : name.to_s.shellescape
+      blank?(name) ? nil : name.to_s.tr(".:", "__").shellescape
     end
 
     def append?
@@ -200,6 +200,10 @@ module Tmuxinator
       yaml["tmux_command"] || "tmux"
     end
 
+    def tmux_startup_pane_command
+      "#{tmux} select-pane -t #{startup_pane}"
+    end
+
     def tmux_has_session?(name)
       return false unless name
 
@@ -263,7 +267,14 @@ module Tmuxinator
     end
 
     def startup_pane
-      "#{startup_window}.#{yaml['startup_pane'] || pane_base_index}"
+      pane =
+        if blank?(yaml["startup_pane"])
+          pane_base_index
+        else
+          yaml["startup_pane"]
+        end
+
+      "#{startup_window}.#{pane}"
     end
 
     def tmux_options?

data/lib/tmuxinator/tmux_version.rb

@@ -3,6 +3,7 @@
 module Tmuxinator
   module TmuxVersion
     SUPPORTED_TMUX_VERSIONS = [
+      "3.6b",
       "3.6a",
       3.6,
       "3.5a",

data/lib/tmuxinator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tmuxinator
-  VERSION = "3.3.8"
+  VERSION = "3.4.0"
 end

data/lib/tmuxinator/window.rb

@@ -17,7 +17,7 @@ module Tmuxinator
     end
 
     def panes
-      build_panes(yaml["panes"]) || []
+      @panes ||= build_panes(yaml["panes"]) || []
     end
 
     def _hashed?
@@ -126,6 +126,10 @@ module Tmuxinator
       "#{project.tmux} select-layout -t #{tmux_window_target} tiled"
     end
 
+    def tmux_focus_pane_command
+      "#{project.tmux} select-pane -t #{focused_pane}"
+    end
+
     def tmux_synchronize_panes
       "#{project.tmux} set-window-option -t #{tmux_window_target} synchronize-panes on"
     end
@@ -134,10 +138,6 @@ module Tmuxinator
       "#{project.tmux} select-layout -t #{tmux_window_target} #{layout}"
     end
 
-    def tmux_select_first_pane
-      "#{project.tmux} select-pane -t #{tmux_window_target}.#{panes.first.index + project.pane_base_index}"
-    end
-
     def synchronize_before?
       [true, "before"].include?(synchronize)
     end
@@ -145,5 +145,39 @@ module Tmuxinator
     def synchronize_after?
       synchronize == "after"
     end
+
+    private
+
+    def focused_pane
+      "#{tmux_window_target}.#{tmux_pane_index}"
+    end
+
+    def tmux_pane_index
+      # Adjust for tmux pane base index
+      pane_index + project.pane_base_index
+    end
+
+    def pane_index
+      focused_pane_config = yaml["focused_pane"]
+      # Select the first pane if the user hasn't set focused_pane
+      return 0 unless focused_pane_config
+
+      # The user may provide the focused pane index.
+      if integer?(focused_pane_config)
+        idx = Integer(focused_pane_config)
+        return idx if idx >= 0 && panes[idx]
+
+        return 0
+      end
+
+      # If no pane with the given name is found fall back to the first pane
+      panes.index { |pane| pane.title == focused_pane_config.to_s.shellescape } || 0
+    end
+
+    def integer?(str)
+      !!Integer(str)
+    rescue StandardError
+      false
+    end
   end
 end

data/spec/fixtures/interface/basic.yml

@@ -0,0 +1,14 @@
+name: basic
+root: /workspace/basic
+tmux_options: -L interface
+pre_window: bundle exec ruby -v
+windows:
+  - editor:
+      root: app
+      panes:
+        - bundle exec vim
+        - bundle exec rake test
+  - shell:
+      root: .
+      panes:
+        - bin/setup

data/spec/fixtures/interface/pane_titles.yml

@@ -0,0 +1,11 @@
+name: pane-titles
+root: /workspace/pane-titles
+tmux_options: -L interface
+enable_pane_titles: true
+pane_title_position: bottom
+pane_title_format: "[ #T ]"
+windows:
+  - editor:
+      panes:
+        - editor: bundle exec vim
+        - logs: tail -f log/test.log

data/spec/fixtures/interface/session_name.yml

@@ -0,0 +1,5 @@
+name: home.arpa:lab
+windows:
+  - main:
+      panes:
+        - echo ok

data/spec/interface/debug_snapshot_spec.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe "tmuxinator debug snapshots" do
+  let(:cli) { Tmuxinator::Cli }
+  let(:snapshot_root) { File.expand_path("../snapshots/debug", __dir__) }
+
+  around do |example|
+    original_argv = ARGV.dup
+    example.run
+    ARGV.replace(original_argv)
+  end
+
+  before do
+    allow_any_instance_of(Tmuxinator::Project).
+      to receive(:extract_tmux_config).
+      and_return({ "base-index" => "0", "pane-base-index" => "0" })
+    allow_any_instance_of(Tmuxinator::Project).
+      to receive(:tmux_has_session?).
+      and_return(false)
+    allow(ENV).to receive(:[]).and_call_original
+    allow(ENV).to receive(:[]).with("SHELL").and_return("/bin/bash")
+  end
+
+  {
+    "1.6" => 1.6,
+    "1.8" => 1.8,
+    "2.6" => 2.6,
+  }.each do |version_label, version|
+    {
+      "basic" => "spec/fixtures/interface/basic.yml",
+      "pane_titles" => "spec/fixtures/interface/pane_titles.yml",
+    }.each do |fixture_name, fixture_path|
+      it "matches #{fixture_name} output for tmux #{version_label}" do
+        allow(Tmuxinator::Config).to receive(:version).and_return(version)
+
+        ARGV.replace(["debug", "--project-config=#{fixture_path}"])
+        output, _err = capture_io { cli.start }
+
+        snapshot_path = File.join(
+          snapshot_root,
+          version_label,
+          "#{fixture_name}.sh"
+        )
+
+        expect(output).to eq("#{File.read(snapshot_path)}\n")
+      end
+    end
+  end
+
+  it "normalizes tmux session targets for project names with separators" do
+    allow(Tmuxinator::Config).to receive(:version).and_return(2.6)
+
+    ARGV.replace([
+                   "debug",
+                   "--project-config=spec/fixtures/interface/session_name.yml"
+                 ])
+    output, _err = capture_io { cli.start }
+
+    snapshot_path = File.join(snapshot_root, "2.6", "session_name.sh")
+
+    expect(output).to eq("#{File.read(snapshot_path)}\n")
+  end
+end

data/spec/lib/tmuxinator/cli_spec.rb

@@ -517,6 +517,16 @@ describe Tmuxinator::Cli do
     let(:name) { "test" }
     let(:path) { Tmuxinator::Config.default_project(name) }
 
+    context "with --help flag" do
+      it "shows help instead of editing a project" do
+        ARGV.replace(["edit", "--help"])
+        out, _err = capture_io { cli.start }
+        expect(out).to include("edit [PROJECT]")
+        expect(out).to include("Use local project file at ./.tmuxinator.yml")
+        expect(out).to include("Options:")
+      end
+    end
+
     context "when the project file _does_ already exist" do
       let(:extra) { "  - extra: echo 'foobar'" }
 
@@ -545,6 +555,84 @@ describe Tmuxinator::Cli do
         expect(File.read(path)).to match %r{#{extra}}
       end
     end
+
+    context "when the project file does not already exist" do
+      let(:path) { File.join(Dir.tmpdir, "#{name}.yml") }
+
+      before do
+        allow(Tmuxinator::Config).to receive(:default_project).and_call_original
+        allow(Tmuxinator::Config).to receive(:default_project).
+          with(name).and_return(path)
+        ARGV.replace(["edit", name])
+        allow(File).to receive(:exist?).with(anything).and_call_original
+        allow(File).to receive(:exist?).with(path).and_return(false)
+      end
+
+      it "exits instead of generating a project file" do
+        expect { cli.start }.to raise_error(SystemExit)
+        expect(File).not_to exist(path)
+      end
+    end
+  end
+
+  describe "#open" do
+    let(:file) { StringIO.new }
+    let(:name) { "test" }
+    let(:path) { Tmuxinator::Config.default_project(name) }
+
+    context "with --help flag" do
+      it "shows help instead of opening a project" do
+        ARGV.replace(["open", "--help"])
+        out, _err = capture_io { cli.start }
+        expect(out).to include("open [PROJECT]")
+        expect(out).to include("Use local project file at ./.tmuxinator.yml")
+        expect(out).to include("Options:")
+      end
+    end
+
+    context "when the project file does not already exist" do
+      before do
+        ARGV.replace(["open", name])
+        allow(File).to receive(:open) { |&block| block.yield file }
+        allow(File).to receive(:exist?).with(anything).and_return(false)
+      end
+
+      it "creates and opens a tmuxinator project file" do
+        expect(Kernel).to receive(:system).with(%r{#{path}})
+
+        capture_io { cli.start }
+
+        expect(file.string).to_not be_empty
+      end
+    end
+
+    context "when the project file already exists" do
+      let(:extra) { "  - extra: echo 'foobar'" }
+      let(:path) { File.join(Dir.tmpdir, "#{name}.yml") }
+
+      before do
+        allow(Tmuxinator::Config).to receive(:default_project).and_call_original
+        allow(Tmuxinator::Config).to receive(:default_project).
+          with(name).and_return(path)
+        FileUtils.remove_file(path) if File.exist?(path)
+        expect(described_class.new.generate_project_file(name, path)).to eq path
+
+        File.open(path, "w") do |f|
+          f.write(extra)
+          f.flush
+        end
+
+        ARGV.replace(["open", name])
+      end
+
+      it "opens the existing project file without replacing it" do
+        expect(Kernel).to receive(:system).with(%r{#{path}})
+
+        capture_io { cli.start }
+
+        expect(File.read(path)).to match %r{#{extra}}
+      end
+    end
   end
 
   describe "#new" do
@@ -560,6 +648,7 @@ describe Tmuxinator::Cli do
         ARGV.replace(["new", "--help"])
         out, _err = capture_io { cli.start }
         expect(out).to include("new [PROJECT]")
+        expect(out).to include("Use local project file at ./.tmuxinator.yml")
         expect(out).to include("Options:")
       end
     end
@@ -628,27 +717,34 @@ describe Tmuxinator::Cli do
 
     # this command variant only works for tmux version 1.6 and up.
     context "from a session" do
-      context "with tmux >= 1.6", if: Tmuxinator::Config.version >= 1.6 do
+      context "with tmux >= 1.6" do
+        let(:success_status) { instance_double(Process::Status, success?: true) }
+        let(:failure_status) { instance_double(Process::Status, success?: false) }
+
         before do
-          # Necessary to make `Doctor.installed?` work in specs
-          allow(Tmuxinator::Doctor).to receive(:installed?).and_return(true)
+          allow(Tmuxinator::Config).to receive(:version).and_return(1.6)
         end
 
         context "session exists" do
-          before(:all) do
-            # Can't add variables through `let` in `before :all`.
-            @session = "for-testing-tmuxinator"
-            # Pass the -d option, so that the session is not attached.
-            Kernel.system "tmux new-session -d -s #{@session}"
-          end
-
           before do
-            ARGV.replace ["new", name, @session]
-          end
-
-          after(:all) do
-            puts @session
-            Kernel.system "tmux kill-session -t #{@session}"
+            ARGV.replace ["new", name, "existing-session"]
+            allow(Open3).to receive(:capture3).and_return(
+              [
+                "editor tiled 1 /workspace/app\n",
+                "",
+                success_status,
+              ],
+              [
+                "editor /workspace/app\n",
+                "",
+                success_status,
+              ],
+              [
+                "default-path \"/workspace/app\"\n",
+                "",
+                success_status,
+              ]
+            )
           end
 
           it "creates a project file" do
@@ -662,6 +758,11 @@ describe Tmuxinator::Cli do
         context "session doesn't exist" do
           before do
             ARGV.replace ["new", name, "sessiondoesnotexist"]
+            allow(Open3).to receive(:capture3).and_return(
+              ["", "", failure_status],
+              ["", "", failure_status],
+              ["", "", failure_status]
+            )
           end
 
           it "fails" do

data/spec/lib/tmuxinator/config_spec.rb

@@ -205,6 +205,7 @@ describe Tmuxinator::Config do
       "v3.5" => 3.5,
       "v3.6" => 3.6,
       "v3.6a" => 3.6,
+      "v3.6b" => 3.6,
       "v3.12.0" => 3.12,
       "v3.12.5" => 3.12
     }.freeze