tmuxinator 3.3.2 → 3.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdf76e1aba70cccc6acf0166890b8b040879783a37c8d0ceec71253014e791f9
-  data.tar.gz: 5640fb566bc3bdd5559de9f973173a7a5c191e59325152b8f1e25a396720f0f3
+  metadata.gz: 0cb65a3fb5e0efb97b014caaf4bd1592508b5ee6502ed97b4088c66504750b46
+  data.tar.gz: 617eb45c7c9f093c2dc25ebe266ba620cc1a27d85970ceef0fa0eb4eeb4d73d0
 SHA512:
-  metadata.gz: ce504b0cd0ab29d9536676b00fd1e8e8efd2f0aa248265f95ab0092df9038f44bb9b64abad28e4b57e48d05a7a81edb0ad52a4531ca33a0669ee7911682f2b0e
-  data.tar.gz: b19d2a5072cf93013fa91ee6849412b8d6988e8ba12e1298ca134abaed59eb840853f93df004c09f1adb5d62ac1cffbca0ae3a91b3661af4a892770e42c57f09
+  metadata.gz: 71a996aab90fa249664b58ae6c7b70bbb1f2d49fa9dbc93437b836813155ac119e5643504cfc8291f0fca2854b826c363d2466f0e294585d46d7a73c26dc23db
+  data.tar.gz: 596e41873c37d199fd954c0078f026996dad916f5f9dc8b394f670cbadda44e3a8e371f3c7e7e855f36c83f9b4b0055d57e1d80856365853865e60ee55c6e431

data/lib/tmuxinator/assets/template.erb

@@ -1,17 +1,19 @@
 #!<%= ENV["SHELL"] || "/bin/bash" %>
 
-# Clear rbenv variables before starting tmux
-unset RBENV_VERSION
-unset RBENV_DIR
+<%- if !append? -%>
+  # Clear rbenv variables before starting tmux
+  unset RBENV_VERSION
+  unset RBENV_DIR
 
-<%= tmux %> start-server;
+  <%= tmux %> start-server;
+<%- end -%>
 
 cd <%= root || "." %>
 
 # Run on_project_start command.
 <%= hook_on_project_start %>
 
-<%- if !tmux_has_session? name -%>
+<%- if append? || !tmux_has_session?(name) -%>
 
   # Run pre command.
   <%= pre %>
@@ -98,7 +100,7 @@ cd <%= root || "." %>
   <%= hook_on_project_restart %>
 <%- end -%>
 
-<%- if attach? -%>
+<%- if attach? && !append? -%>
   if [ -z "$TMUX" ]; then
     <%= tmux %> -u attach-session -t <%= name %>
   else

data/lib/tmuxinator/cli.rb

@@ -176,28 +176,22 @@ module Tmuxinator
       end
 
       def create_project(project_options = {})
-        # Strings provided to --attach are coerced into booleans by Thor.
-        # "f" and "false" will result in `:attach` being `false` and any other
-        # string or the empty flag will result in `:attach` being `true`.
-        # If the flag is not present, `:attach` will be `nil`.
-        attach = detach = false
-        attach = true if project_options[:attach] == true
-        detach = true if project_options[:attach] == false
-
-        options = {
+        Tmuxinator::Config.validate(project_create_options(project_options))
+      rescue StandardError => e
+        exit! e.message
+      end
+
+      def project_create_options(project_options)
+        {
           args: project_options[:args],
           custom_name: project_options[:custom_name],
-          force_attach: attach,
-          force_detach: detach,
+          force_attach: project_options[:attach] == true,
+          force_detach: project_options[:attach] == false,
           name: project_options[:name],
-          project_config: project_options[:project_config]
+          project_config: project_options[:project_config],
+          append: project_options[:append],
+          no_pre_window: project_options[:no_pre_window],
         }
-
-        begin
-          Tmuxinator::Config.validate(options)
-        rescue StandardError => e
-          exit! e.message
-        end
       end
 
       def render_project(project)
@@ -227,6 +221,25 @@ module Tmuxinator
       def kill_project(project)
         Kernel.exec(project.kill)
       end
+
+      def start_params(name = nil, *args)
+        # project-config takes precedence over a named project in the case that
+        # both are provided.
+        if options["project-config"]
+          args.unshift name if name
+          name = nil
+        end
+
+        {
+          args: args,
+          attach: options[:attach],
+          custom_name: options[:name],
+          name: name,
+          project_config: options["project-config"],
+          append: options["append"],
+          no_pre_window: options["no-pre-window"],
+        }
+      end
     end
 
     desc "start [PROJECT] [ARGS]", COMMANDS[:start]
@@ -240,22 +253,13 @@ module Tmuxinator
                                     desc: "Path to project config file"
     method_option "suppress-tmux-version-warning",
                   desc: "Don't show a warning for unsupported tmux versions"
-
+    method_option :append, type: :boolean,
+                           desc: "Appends the project windows and panes in " \
+                                 "the current session"
+    method_option "no-pre-window", type: :boolean, default: false,
+                                   desc: "Skip pre_window commands"
     def start(name = nil, *args)
-      # project-config takes precedence over a named project in the case that
-      # both are provided.
-      if options["project-config"]
-        args.unshift name if name
-        name = nil
-      end
-
-      params = {
-        args: args,
-        attach: options[:attach],
-        custom_name: options[:name],
-        name: name,
-        project_config: options["project-config"]
-      }
+      params = start_params(name, *args)
 
       show_version_warning if version_warning?(
         options["suppress-tmux-version-warning"]
@@ -312,24 +316,16 @@ module Tmuxinator
                          desc: "Give the session a different name"
     method_option "project-config", aliases: "-p",
                                     desc: "Path to project config file"
-
+    method_option :append, type: :boolean,
+                           desc: "Appends the project windows and panes in " \
+                                 "the current session"
+    method_option "no-pre-window", type: :boolean, default: false,
+                                   desc: "Skip pre_window commands"
     def debug(name = nil, *args)
-      # project-config takes precedence over a named project in the case that
-      # both are provided.
-      if options["project-config"]
-        args.unshift name if name
-        name = nil
-      end
-
-      params = {
-        args: args,
-        attach: options[:attach],
-        custom_name: options[:name],
-        name: name,
-        project_config: options["project-config"]
-      }
+      params = start_params(name, *args)
 
       project = create_project(params)
+
       say project.render
     end
 
@@ -391,13 +387,17 @@ module Tmuxinator
     method_option :newline, type: :boolean,
                             aliases: ["-n"],
                             desc: "Force output to be one entry per line."
+    method_option :active, type: :boolean,
+                           aliases: ["-a"],
+                           desc: "Filter output by active project sessions."
 
     def list
       say "tmuxinator projects:"
+      configs = Tmuxinator::Config.configs(active: options[:active])
       if options[:newline]
-        say Tmuxinator::Config.configs.join("\n")
+        say configs.join("\n")
       else
-        print_in_columns Tmuxinator::Config.configs
+        print_in_columns configs
       end
     end
 
@@ -435,7 +435,7 @@ module Tmuxinator
         Tmuxinator::Cli.new.local
       elsif name && !Tmuxinator::Cli::RESERVED_COMMANDS.include?(name) &&
             Tmuxinator::Config.exist?(name: name)
-        Tmuxinator::Cli.new.start(name, *args.drop(1))
+        Tmuxinator::Cli.start([:start, *args])
       else
         Tmuxinator::Cli.start(args)
       end

data/lib/tmuxinator/config.rb

@@ -126,13 +126,33 @@ module Tmuxinator
         asset_path "wemux_template.erb"
       end
 
-      # Sorted list of all .yml files, including duplicates
-      def configs
-        directories.map do |directory|
+      # List of all active tmux sessions
+      def active_sessions
+        `tmux list-sessions -F "#S"`.split("\n")
+      end
+
+      # Sorted list of all project .yml file basenames, including duplicates
+      #
+      # @param active filter configs by active project sessions
+      # @return [Array<String>] list of project names
+      def configs(active: nil)
+        configs = config_file_basenames
+
+        if active == true
+          configs &= active_sessions
+        elsif active == false
+          configs -= active_sessions
+        end
+
+        configs
+      end
+
+      def config_file_basenames
+        directories.flat_map do |directory|
           Dir["#{directory}/**/*.yml"].map do |path|
             path.gsub("#{directory}/", "").gsub(".yml", "")
           end
-        end.flatten.sort
+        end.sort
       end
 
       # Existent directories which may contain project files

data/lib/tmuxinator/project.rb

@@ -40,6 +40,7 @@ module Tmuxinator
     attr_reader :force_attach
     attr_reader :force_detach
     attr_reader :custom_name
+    attr_reader :no_pre_window
 
     def self.load(path, options = {})
       yaml = begin
@@ -83,15 +84,29 @@ module Tmuxinator
 
       @yaml = yaml
 
-      @custom_name = options[:custom_name]
+      set_instance_variables_from_options(options)
+
+      validate_options
+
+      extend Tmuxinator::WemuxSupport if wemux?
+    end
 
+    def set_instance_variables_from_options(options)
+      @custom_name = options[:custom_name]
       @force_attach = options[:force_attach]
       @force_detach = options[:force_detach]
+      @append = options[:append]
+      @no_pre_window = options[:no_pre_window]
+    end
 
-      raise "Cannot force_attach and force_detach at the same time" \
-        if @force_attach && @force_detach
+    def validate_options
+      if @force_attach && @force_detach
+        raise "Cannot force_attach and force_detach at the same time"
+      end
 
-      extend Tmuxinator::WemuxSupport if wemux?
+      if append? && !tmux_has_session?(name)
+        raise "Cannot append to a session that does not exist"
+      end
     end
 
     def render
@@ -120,11 +135,25 @@ module Tmuxinator
       blank?(root) ? nil : File.expand_path(root).shellescape
     end
 
+    def current_session_name
+      `[[ -n "${TMUX+set}" ]] && tmux display-message -p "#S"`.strip
+    end
+
     def name
-      name = custom_name || yaml["project_name"] || yaml["name"]
+      name =
+        if append?
+          current_session_name
+        else
+          custom_name || yaml["project_name"] || yaml["name"]
+        end
+
       blank?(name) ? nil : name.to_s.shellescape
     end
 
+    def append?
+      @append
+    end
+
     def pre
       pre_config = yaml["pre"]
       parsed_parameters(pre_config)
@@ -141,6 +170,8 @@ module Tmuxinator
     end
 
     def pre_window
+      return if no_pre_window
+
       params = if rbenv?
                  "rbenv shell #{yaml['rbenv']}"
                elsif rvm?
@@ -167,6 +198,8 @@ module Tmuxinator
     end
 
     def tmux_has_session?(name)
+      return false unless name
+
       # 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.
@@ -208,7 +241,13 @@ module Tmuxinator
       end
     end
 
+    def last_window_index
+      `tmux list-windows -F '#I'`.split.last.to_i
+    end
+
     def base_index
+      return last_window_index + 1 if append?
+
       get_base_index.to_i
     end
 
@@ -241,7 +280,7 @@ module Tmuxinator
     end
 
     def window(index)
-      "#{name}:#{index}"
+      append? ? ":#{index}" : "#{name}:#{index}"
     end
 
     def send_pane_command(cmd, window_index, _pane_index)
@@ -329,6 +368,8 @@ module Tmuxinator
     end
 
     def tmux_new_session_command
+      return if append?
+
       window = windows.first.tmux_window_name_option
       "#{tmux} new-session -d -s #{name} #{window}"
     end

data/lib/tmuxinator/version.rb

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

data/spec/factories/projects.rb

@@ -115,4 +115,12 @@ FactoryBot.define do
 
     initialize_with { Tmuxinator::Project.load(file) }
   end
+
+  factory :project_with_append, class: Tmuxinator::Project do
+    transient do
+      file { "spec/fixtures/sample.yml" }
+    end
+
+    initialize_with { Tmuxinator::Project.load(file, append: true) }
+  end
 end

data/spec/lib/tmuxinator/cli_spec.rb

@@ -99,11 +99,18 @@ describe Tmuxinator::Cli do
           end
 
           it "should call #start" do
-            instance = instance_double(cli)
-            expect(cli).to receive(:new).and_return(instance)
-            expect(instance).to receive(:start).with(*args)
+            expect(cli).to receive(:start).with([:start, *args])
             subject
           end
+
+          context "and the append option is passed" do
+            let(:args) { ["sample", "--append"] }
+
+            it "should call #start" do
+              expect(cli).to receive(:start).with([:start, *args])
+              subject
+            end
+          end
         end
 
         context "a thor command" do
@@ -845,6 +852,14 @@ describe Tmuxinator::Cli do
       end
     end
 
+    context "set --active flag " do
+      ARGV.replace(["list", "--active"])
+
+      it "is a valid option" do
+        expect { capture_io { cli.start } }.to_not raise_error
+      end
+    end
+
     context "no arguments are given" do
       ARGV.replace(["list"])
 

data/spec/lib/tmuxinator/config_spec.rb

@@ -281,6 +281,26 @@ describe Tmuxinator::Config do
         to eq ["both", "both", "dup/local-dup", "home", "local-dup", "xdg"]
     end
 
+    it "gets a sorted list of all active projects" do
+      allow(described_class).to receive(:environment?).and_return false
+      allow(described_class).
+        to receive(:active_sessions).
+        and_return ["both", "home"]
+
+      expect(described_class.configs(active: true)).
+        to eq ["both", "home"]
+    end
+
+    it "gets a sorted list excluding active projects" do
+      allow(described_class).to receive(:environment?).and_return false
+      allow(described_class).
+        to receive(:active_sessions).
+        and_return ["both", "home"]
+
+      expect(described_class.configs(active: false)).
+        to eq ["dup/local-dup", "local-dup", "xdg"]
+    end
+
     it "lists only projects in $TMUXINATOR_CONFIG when set" do
       allow(ENV).to receive(:[]).with("TMUXINATOR_CONFIG").
         and_return "#{fixtures_dir}/TMUXINATOR_CONFIG"

data/spec/lib/tmuxinator/project_spec.rb

@@ -37,6 +37,10 @@ describe Tmuxinator::Project do
     FactoryBot.build(:project_with_alias)
   end
 
+  let(:project_with_append) do
+    FactoryBot.build(:project_with_append)
+  end
+
   it "should include Hooks" do
     expect(project).to be_kind_of(Tmuxinator::Hooks::Project)
   end
@@ -46,6 +50,21 @@ describe Tmuxinator::Project do
       it "creates an instance" do
         expect(project).to be_a(Tmuxinator::Project)
       end
+
+      it "validates append outside a current session" do
+        Tmuxinator::Project.any_instance.stub(tmux_has_session?: false)
+        expect { project_with_append }.to(
+          raise_error(
+            RuntimeError,
+            "Cannot append to a session that does not exist"
+          )
+        )
+      end
+
+      it "validates append within a current session" do
+        Tmuxinator::Project.any_instance.stub(tmux_has_session?: true)
+        expect { project_with_append }.to_not raise_error
+      end
     end
   end
 
@@ -262,6 +281,16 @@ describe Tmuxinator::Project do
         end
       end
     end
+
+    context "no_pre_window option is true" do
+      before do
+        allow(project).to receive_messages(no_pre_window: true)
+      end
+
+      it "returns nil" do
+        expect(pre_window).to be_nil
+      end
+    end
   end
 
   describe "#socket" do
@@ -368,6 +397,17 @@ describe Tmuxinator::Project do
         expect(project.base_index).to eq 0
       end
     end
+
+    context "with append set" do
+      before do
+        Tmuxinator::Project.any_instance.stub(tmux_has_session?: true)
+        project_with_append.stub(last_window_index: 3)
+      end
+
+      it "defaults to the next window index" do
+        expect(project_with_append.base_index).to eq 4
+      end
+    end
   end
 
   describe "#startup_window" do
@@ -410,6 +450,13 @@ describe Tmuxinator::Project do
     it "gets the window and index for tmux" do
       expect(project.window(1)).to eq "sample:1"
     end
+
+    context "with append set" do
+      it "excludes the session name" do
+        Tmuxinator::Project.any_instance.stub(tmux_has_session?: true)
+        expect(project_with_append.window(1)).to eq ":1"
+      end
+    end
   end
 
   describe "#name?" do
@@ -576,6 +623,13 @@ describe Tmuxinator::Project do
         expect(project.tmux_new_session_command).to eq command
       end
     end
+
+    context "with append set" do
+      it "returns nothing" do
+        Tmuxinator::Project.any_instance.stub(tmux_has_session?: true)
+        expect(project_with_append.tmux_new_session_command).to be_nil
+      end
+    end
   end
 
   describe "tmux_kill_session_command" do

data/spec/spec_helper.rb

@@ -1,16 +1,21 @@
 # frozen_string_literal: true
 
-require "coveralls"
 require "pry"
 require "simplecov"
 require "xdg"
 
-formatters = [
-  SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter
-]
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(formatters)
 SimpleCov.start do
+  if ENV["CI"]
+    formatter SimpleCov::Formatter::SimpleFormatter
+  else
+    formatter SimpleCov::Formatter::MultiFormatter.new(
+      [
+        SimpleCov::Formatter::HTMLFormatter,
+        SimpleCov::Formatter::SimpleFormatter,
+      ]
+    )
+  end
+
   add_filter "vendor/cache"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tmuxinator
 version: !ruby/object:Gem::Version
-  version: 3.3.2
+  version: 3.3.4
 platform: ruby
 authors:
 - Allen Bargi
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-24 00:00:00.000000000 Z
+date: 2025-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubi
@@ -87,20 +87,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
@@ -288,7 +274,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.8.23
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Create and manage complex tmux sessions easily.