tmuxinator 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15e0d5df60a8ef8a65cae1958913c16aed4cd5d563573f7589283f210d40139b
-  data.tar.gz: af34c5d6d4f609255b55f7dd662c9193cec07235abb9eb1695722c01e494fcdf
+  metadata.gz: 619a96d44867a826eedbf13ac8330ef27cb44dbd74810cc4229d83e5ea35c9e0
+  data.tar.gz: 4de7af75ee47dd790ba37e5715e52fd7e2a3097b3ab7755d21d7c53c53e99407
 SHA512:
-  metadata.gz: 177be80a0ae306774cb96ec56d1943cc6e3b5459a9398911be92cf1d7310f71f8191ce8c3ef6745a855574353de20b34eb551221f60f5c9ed53c28e2e94ca10c
-  data.tar.gz: 18b6fbac38dbee55ccbeeb5318b216ca7cb52c1119ac5517369f4b938ad574b5084a73a66a85b6aadc53fff3435705b3412c2c56054fdfe0cd8ccade6494733e
+  metadata.gz: 67d77b09a4632cdace3306ae7d76a13e605debbbc8fb52fc5217ded9ff6a90c6c36e1f66788c1d652feab82f2b03c4c1150bf67a3df5143b08db6a8139eaf3bd
+  data.tar.gz: 634a7911404b858c551b1cb00fe1eff80e377818bd128b9d210bf2359113246698427e0662e307a59c842d8e41d1d145bcee19ff5a90a0c35f06e5217a66a907

data/completion/tmuxinator.bash

@@ -1,5 +1,3 @@
-#!/usr/bin/env bash
-
 _tmuxinator() {
     COMPREPLY=()
     local word

data/lib/tmuxinator/assets/sample.yml

@@ -32,7 +32,7 @@ root: ~/
 # Pass command line options to tmux. Useful for specifying a different tmux.conf.
 # tmux_options: -f ~/.tmux.mac.conf
 
-# Change the command to call tmux.  This can be used by derivatives/wrappers like byobu.
+# Change the command to call tmux. This can be used by derivatives/wrappers like byobu.
 # tmux_command: byobu
 
 # Specifies (by name or index) which window will be selected on project startup. If not set, the first window is used.

data/lib/tmuxinator/assets/template.erb

@@ -15,7 +15,7 @@ cd <%= root || "." %>
 
   # Run pre command.
   <%= pre %>
-  
+
   # Run on_project_first_start command.
   <%= hook_on_project_first_start %>
 
@@ -53,6 +53,9 @@ cd <%= root || "." %>
       <% end %>
     <% else %>
       <% window.panes.each do |pane| %>
+        <% unless Tmuxinator::Config.version < 2.6 %>
+  <%= pane.tmux_set_title %>
+        <% end %>
         <% if pane.project.pre_window %>
   <%= pane.tmux_pre_window_command %>
         <% end %>
@@ -94,6 +97,6 @@ cd <%= root || "." %>
 <%- end -%>
 
 <%= post %>
-    
+
 # Run on_project_exit command.
 <%= hook_on_project_exit %>

data/lib/tmuxinator/cli.rb

@@ -264,14 +264,23 @@ module Tmuxinator
       render_project(project)
     end
 
-    desc "stop [PROJECT]", COMMANDS[:stop]
+    desc "stop [PROJECT] [ARGS]", COMMANDS[:stop]
     map "st" => :stop
+    method_option "project-config", aliases: "-p",
+                                    desc: "Path to project config file"
     method_option "suppress-tmux-version-warning",
                   desc: "Don't show a warning for unsupported tmux versions"
 
-    def stop(name)
+    def stop(name = nil)
+      # project-config takes precedence over a named project in the case that
+      # both are provided.
+      if options["project-config"]
+        name = nil
+      end
+
       params = {
-        name: name
+        name: name,
+        project_config: options["project-config"]
       }
       show_version_warning if version_warning?(
         options["suppress-tmux-version-warning"]

data/lib/tmuxinator/config.rb

@@ -12,7 +12,7 @@ module Tmuxinator
         return environment if environment?
         return xdg if xdg?
         return home if home?
-        # No project directory specified or existant, default to XDG:
+        # No project directory specified or existent, default to XDG:
         FileUtils::mkdir_p(xdg)
         xdg
       end
@@ -127,7 +127,7 @@ module Tmuxinator
         end.flatten.sort
       end
 
-      # Existant directories which may contain project files
+      # Existent directories which may contain project files
       # Listed in search order
       # Used by `implode` and `list` commands
       def directories

data/lib/tmuxinator/pane.rb

@@ -1,12 +1,13 @@
 module Tmuxinator
   class Pane
-    attr_reader :commands, :project, :index, :tab
+    attr_reader :commands, :project, :index, :tab, :title
 
-    def initialize(index, project, tab, *commands)
+    def initialize(index, project, tab, *commands, title: nil)
       @commands = commands
       @index = index
       @project = project
       @tab = tab
+      @title = title
     end
 
     def tmux_window_and_pane_target
@@ -29,6 +30,12 @@ module Tmuxinator
       end
     end
 
+    def tmux_set_title
+      unless title.nil?
+        _set_title(title)
+      end
+    end
+
     def name
       project.name
     end
@@ -61,5 +68,10 @@ module Tmuxinator
     def _send_keys(t, e)
       "#{project.tmux} send-keys -t #{t} #{e} C-m"
     end
+
+    def _set_title(title)
+      target = tmux_window_and_pane_target
+      "#{project.tmux} select-pane -t #{target} -T #{title}"
+    end
   end
 end

data/lib/tmuxinator/tmux_version.rb

@@ -1,6 +1,7 @@
 module Tmuxinator
   module TmuxVersion
     SUPPORTED_TMUX_VERSIONS = [
+      "3.4",
       "3.3a",
       3.3,
       "3.2a",

data/lib/tmuxinator/version.rb

@@ -1,3 +1,3 @@
 module Tmuxinator
-  VERSION = "3.1.0".freeze
+  VERSION = "3.1.1".freeze
 end

data/lib/tmuxinator/window.rb

@@ -50,16 +50,16 @@ module Tmuxinator
       return if panes_yml.nil?
 
       Array(panes_yml).map.with_index do |pane_yml, index|
-        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)
+        commands, title = case pane_yml
+                          when Hash
+                            [pane_yml.values.first, pane_yml.keys.first]
+                          when Array
+                            [pane_yml, nil]
+                          else
+                            [pane_yml, nil]
+                          end
+
+        Tmuxinator::Pane.new(index, project, self, *commands, title: title)
       end.flatten
     end
 

data/spec/lib/tmuxinator/cli_spec.rb

@@ -303,14 +303,24 @@ describe Tmuxinator::Cli do
 
   describe "#stop" do
     before do
-      ARGV.replace(["stop", "foo"])
       allow(Tmuxinator::Config).to receive_messages(validate: project)
       allow(Tmuxinator::Config).to receive_messages(version: 1.9)
       allow(Kernel).to receive(:exec)
     end
 
     context "with project name" do
-      it "stop the project" do
+      it "stops the project" do
+        ARGV.replace(["stop", "foo"])
+        expect(Kernel).to receive(:exec)
+        out, err = capture_io { cli.start }
+        expect(err).to eq ""
+        expect(out).to eq ""
+      end
+    end
+
+    context "without project name" do
+      it "stops the project using .tmuxinator.yml" do
+        ARGV.replace(["stop"])
         expect(Kernel).to receive(:exec)
         out, err = capture_io { cli.start }
         expect(err).to eq ""
@@ -321,6 +331,45 @@ describe Tmuxinator::Cli do
     include_examples :unsupported_version_message, :stop, :foo
   end
 
+  describe "#stop(with project config file)" do
+    before do
+      allow(Tmuxinator::Config).to receive(:validate).and_call_original
+      allow(Tmuxinator::Config).to receive_messages(version: 1.9)
+      allow(Kernel).to receive(:exec)
+    end
+
+    it "stops the project" do
+      ARGV.replace(["stop", "--project-config=#{project_config}"])
+      expect(Tmuxinator::Config).to receive_messages(validate: project)
+      expect(Kernel).to receive(:exec)
+      out, err = capture_io { cli.start }
+      expect(err).to eq ""
+      expect(out).to eq ""
+    end
+
+    it "does not stop the project if given a bogus project config file" do
+      ARGV.replace(["stop", "--project-config=bogus.yml"])
+      expect(Kernel).not_to receive(:exec)
+      expect { capture_io { cli.start } }.to raise_error(SystemExit)
+    end
+
+    it "does not set the project name" do
+      ARGV.replace(["stop", "--project-config=#{project_config}"])
+      expect(Tmuxinator::Config).
+        to(receive(:validate).
+           with(hash_including(name: nil)))
+      capture_io { cli.start }
+    end
+
+    it "does not set the project name even when set" do
+      ARGV.replace(["stop", "bar", "--project-config=#{project_config}"])
+      expect(Tmuxinator::Config).
+        to(receive(:validate).
+           with(hash_including(name: nil)))
+      capture_io { cli.start }
+    end
+  end
+
   describe "#local" do
     before do
       allow(Tmuxinator::Config).to receive_messages(validate: project)
@@ -650,7 +699,7 @@ describe Tmuxinator::Cli do
       end
 
       it "does not render the project if given a bogus project config file" do
-        ARGV.replace(["start", "--project-config=bogus.yml"])
+        ARGV.replace(["debug", "--project-config=bogus.yml"])
         expect { capture_io { cli.start } }.to raise_error(SystemExit)
       end
     end

data/spec/lib/tmuxinator/config_spec.rb

@@ -52,7 +52,7 @@ describe Tmuxinator::Config do
         allow(described_class).to receive(:home?).and_return false
 
         Dir.mktmpdir do |dir|
-          config_parent = "#{dir}/non_existant_parent/s"
+          config_parent = "#{dir}/non_existent_parent/s"
           allow(XDG).to receive(:[]).with("CONFIG").and_return config_parent
           expect(described_class.directory).
             to eq "#{config_parent}/tmuxinator"
@@ -62,7 +62,7 @@ describe Tmuxinator::Config do
     end
   end
 
-  describe "#enviroment" do
+  describe "#environment" do
     context "environment variable $TMUXINATOR_CONFIG is not empty" do
       it "is $TMUXINATOR_CONFIG" do
         allow(ENV).to receive(:[]).with("TMUXINATOR_CONFIG").

data/spec/lib/tmuxinator/pane_spec.rb

@@ -3,19 +3,20 @@ require "spec_helper"
 describe Tmuxinator::Pane do
   let(:klass) { described_class }
   let(:instance) { klass.new(index, project, window, *commands) }
-  # let(:index) { "vim" }
-  # let(:project) { 0 }
-  # let(:tab) { nil }
-  # let(:commands) { nil }
+  let(:instance_with_title) do
+    klass.new(index, project, window, *commands, title: title)
+  end
   let(:index) { 0 }
   let(:project) { double }
   let(:window) { double }
   let(:commands) { ["vim", "bash"] }
+  let(:title) { "test" }
 
   before do
     allow(project).to receive(:name).and_return "foo"
     allow(project).to receive(:base_index).and_return 0
     allow(project).to receive(:pane_base_index).and_return 1
+    allow(project).to receive(:tmux).and_return "tmux"
 
     allow(window).to receive(:project).and_return project
     allow(window).to receive(:index).and_return 0
@@ -28,4 +29,18 @@ describe Tmuxinator::Pane do
   end
 
   it { expect(subject.tmux_window_and_pane_target).to eql "foo:0.1" }
+
+  it "does not set pane title" do
+    expect(subject.tmux_set_title).to be_nil
+  end
+
+  context "when title is provided" do
+    subject { instance_with_title }
+
+    it "sets pane title" do
+      expect(subject.tmux_set_title).to eql(
+        "tmux select-pane -t foo:0.1 -T test"
+      )
+    end
+  end
 end

data/spec/lib/tmuxinator/window_spec.rb

@@ -127,6 +127,26 @@ describe Tmuxinator::Window do
       end
     end
 
+    context "titled panes" do
+      let(:panes) do
+        [
+          { "editor" => ["vim"] },
+          { "run" => ["cmd1", "cmd2"] },
+          "top"
+        ]
+      end
+
+      it "creates panes with titles" do
+        expect(window.panes).to match(
+          [
+            a_pane.with(index: 0, title: "editor").and_commands("vim"),
+            a_pane.with(index: 1, title: "run").and_commands("cmd1", "cmd2"),
+            a_pane.with(index: 2, title: nil).and_commands("top")
+          ]
+        )
+      end
+    end
+
     context "nested collections" do
       let(:command1) { "cd /tmp/" }
       let(:command2) { "ls" }

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: tmuxinator
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Allen Bargi
 - Christopher Chow
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2024-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -302,8 +302,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.8.23
 requirements: []
-rubygems_version: 3.3.15
-signing_key:
+rubygems_version: 3.2.33
+signing_key: 
 specification_version: 4
 summary: Create and manage complex tmux sessions easily.
 test_files: