tmuxinator 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4701d5ffcbc531c162e257f79c3f3399e106ec4
-  data.tar.gz: 94774dea4bbad7cfbc17f16d9428cd85061e2b5d
+  metadata.gz: b82c1fce5acc4afbea3917be671204b8ec18ce24
+  data.tar.gz: '06860d74aa9ccabd291d0f4e996fdfdf803600d9'
 SHA512:
-  metadata.gz: fac94b03868d51bfac62e4205b91b4695a97d686d46759a09df7e33144e415b100b9b72984f7c0fd7d0146a27ac21c630d97729769e137047d0253ecf16afaa7
-  data.tar.gz: d9833164fd80716d76f19269f0eb07d424b57e788a2fe70f6c31c2a7f74130285a1a332e2b1401c2026a9a696afaa76cb76db7fa05e4934a7391912170e00e42
+  metadata.gz: e240783bffcbabaa05f371944a7e6654117b9ca1840e7cb2cdf736171943e740973ce8d38506d67c8cd5a8b2ebab360727f3d67b84587c2241c4850e568118ef
+  data.tar.gz: ca0fc2c809ead67680c77cbb2fff2a43d917ffaa6a89c40ed9ef2c46eef2f517611814c2b385979c18401709158e4695d602bec448d599d70148a0789d916012

data/bin/tmuxinator

@@ -6,7 +6,7 @@ require "tmuxinator"
 
 name = ARGV[0] || nil
 
-if ARGV.length == 0 && Tmuxinator::Config.local?
+if ARGV.empty? && Tmuxinator::Config.local?
   Tmuxinator::Cli.new.local
 elsif name && !Tmuxinator::Cli::COMMANDS.keys.include?(name.to_sym) &&
       Tmuxinator::Config.exists?(name)

data/lib/tmuxinator.rb

@@ -1,14 +1,19 @@
-require "yaml"
 require "erubis"
+require "fileutils"
 require "shellwords"
 require "thor"
 require "thor/version"
+require "xdg"
+require "yaml"
 
 require "tmuxinator/util"
 require "tmuxinator/deprecations"
 require "tmuxinator/wemux_support"
 require "tmuxinator/cli"
 require "tmuxinator/config"
+require "tmuxinator/doctor"
+require "tmuxinator/hooks"
+require "tmuxinator/hooks/project"
 require "tmuxinator/pane"
 require "tmuxinator/project"
 require "tmuxinator/window"
@@ -16,9 +21,3 @@ require "tmuxinator/version"
 
 module Tmuxinator
 end
-
-class Object
-  def blank?
-    respond_to?(:empty?) ? !!empty? : !self
-  end
-end

data/lib/tmuxinator/assets/sample.yml

@@ -9,6 +9,18 @@ root: ~/
 # Runs before everything. Use it to start daemons etc.
 # pre: sudo /etc/rc.d/mysqld start
 
+# Project hooks
+# Runs on project start, always
+# on_project_start: command
+# Run on project start, the first time
+# on_project_first_start: command
+# Run on project start, after the first time
+# on_project_restart: command
+# Run on project exit ( detaching from tmux session )
+# on_project_exit: command
+# Run on project stop
+# on_project_stop: command
+
 # Runs in each window and pane before window/pane specific commands. Useful for setting up interpreter versions.
 # pre_window: rbenv shell 2.0.0-p247
 
@@ -21,7 +33,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
 
-# Specitifes (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 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.

data/lib/tmuxinator/assets/template-stop.erb

@@ -0,0 +1,11 @@
+#!<%= ENV["SHELL"] || "/bin/bash" %>
+
+<%- if tmux_has_session? name -%>
+  cd <%= root || "." %>
+
+  <%= tmux_kill_session_command %>
+  
+  # Run on_project_stop command
+  <%= hook_on_project_stop %>
+
+<%- end -%>

data/lib/tmuxinator/assets/template.erb

@@ -6,11 +6,18 @@ unset RBENV_DIR
 
 <%= tmux %> start-server;
 
+cd <%= root || "." %>
+
+# Run on_project_start command.
+<%= hook_on_project_start %>
+
 <%- if !tmux_has_session? name -%>
-  cd <%= root || "." %>
 
   # Run pre command.
   <%= pre %>
+  
+  # Run on_project_first_start command.
+  <%= hook_on_project_first_start %>
 
   # Create the session and the first window. Manually switch to root
   # directory if required to support tmux < 1.9
@@ -73,6 +80,9 @@ unset RBENV_DIR
 
   <%= tmux %> select-window -t <%= startup_window %>
   <%= tmux %> select-pane -t <%= startup_pane %>
+<%- else -%>
+  # Run on_project_restart command.
+  <%= hook_on_project_restart %>
 <%- end -%>
 
 <%- if attach? -%>
@@ -84,3 +94,7 @@ unset RBENV_DIR
 <%- end -%>
 
 <%= post %>
+<%- unless attach? -%>
+  # Run on_project_exit command.
+  <%= hook_on_project_exit %>
+<%- end -%>

data/lib/tmuxinator/cli.rb

@@ -1,3 +1,5 @@
+require "open3"
+
 module Tmuxinator
   class Cli < Thor
     # By default, Thor returns exit(0) when an error occurs.
@@ -30,7 +32,7 @@ module Tmuxinator
       version: "Display installed tmuxinator version",
       doctor: "Look for problems in your configuration",
       list: "Lists all tmuxinator projects"
-    }
+    }.freeze
 
     package_name "tmuxinator" \
       unless Gem::Version.create(Thor::VERSION) < Gem::Version.create("0.18")
@@ -58,7 +60,7 @@ module Tmuxinator
       end
     end
 
-    desc "new [PROJECT]", COMMANDS[:new]
+    desc "new [PROJECT] [SESSION]", COMMANDS[:new]
     map "open" => :new
     map "edit" => :new
     map "o" => :new
@@ -68,18 +70,76 @@ module Tmuxinator
                           aliases: ["-l"],
                           desc: "Create local project file at ./.tmuxinator.yml"
 
-    def new(name)
-      project_file = find_project_file(name, options[:local])
-      Kernel.system("$EDITOR #{project_file}") || doctor
+    def new(name, session = nil)
+      if session
+        new_project_with_session(name, session)
+      else
+        new_project(name)
+      end
     end
 
     no_commands do
+      def new_project(name)
+        project_file = find_project_file(name, options[:local])
+        Kernel.system("$EDITOR #{project_file}") || doctor
+      end
+
+      def new_project_with_session(name, session)
+        if Tmuxinator::Config.version < 1.6
+          raise "Creating projects from sessions is unsupported\
+            for tmux version 1.5 or lower."
+        end
+
+        windows, _, s0 = Open3.capture3(<<-CMD)
+          tmux list-windows -t #{session}\
+          -F "#W \#{window_layout} \#{window_active} \#{pane_current_path}"
+        CMD
+        panes, _, s1 = Open3.capture3(<<-CMD)
+          tmux list-panes -s -t #{session} -F "#W \#{pane_current_path}"
+        CMD
+        tmux_options, _, s2 = Open3.capture3(<<-CMD)
+          tmux show-options -t #{session}
+        CMD
+        project_root = tmux_options[/^default-path "(.+)"$/, 1]
+
+        unless [s0, s1, s2].all?(&:success?)
+          raise "Session '#{session}' doesn't exist."
+        end
+
+        panes = panes.each_line.map(&:split).group_by(&:first)
+        windows = windows.each_line.map do |line|
+          window_name, layout, active, path = line.split(" ")
+          project_root ||= path if active.to_i == 1
+          [
+            window_name,
+            layout,
+            Array(panes[window_name]).map do |_, pane_path|
+              "cd #{pane_path}"
+            end
+          ]
+        end
+
+        yaml = {
+          "name" => name,
+          "project_root" => project_root,
+          "windows" => windows.map do |window_name, layout, window_panes|
+            {
+              window_name => {
+                "layout" => layout,
+                "panes" => window_panes
+              }
+            }
+          end
+        }
+
+        path = config_path(name, options[:local])
+        File.open(path, "w") do |f|
+          f.write(YAML.dump(yaml))
+        end
+      end
+
       def find_project_file(name, local = false)
-        path = if local
-                 Tmuxinator::Config::LOCAL_DEFAULT
-               else
-                 Tmuxinator::Config.default_project(name)
-               end
+        path = config_path(name, local)
         if File.exist?(path)
           path
         else
@@ -87,6 +147,14 @@ module Tmuxinator
         end
       end
 
+      def config_path(name, local = false)
+        if local
+          Tmuxinator::Config::LOCAL_DEFAULT
+        else
+          Tmuxinator::Config.default_project(name)
+        end
+      end
+
       def generate_project_file(name, path)
         template = Tmuxinator::Config.default? ? :default : :sample
         content = File.read(Tmuxinator::Config.send(template.to_sym))
@@ -127,7 +195,7 @@ module Tmuxinator
       end
 
       def kill_project(project)
-        Kernel.exec(project.tmux_kill_session_command)
+        Kernel.exec(project.kill)
       end
     end
 
@@ -231,7 +299,9 @@ module Tmuxinator
 
     def implode
       if yes?("Are you sure you want to delete all tmuxinator configs?", :red)
-        FileUtils.remove_dir(Tmuxinator::Config.root)
+        Tmuxinator::Config.directories.each do |directory|
+          FileUtils.remove_dir(directory)
+        end
         say "Deleted all tmuxinator projects."
       end
     end
@@ -257,13 +327,13 @@ module Tmuxinator
 
     def doctor
       say "Checking if tmux is installed ==> "
-      yes_no Tmuxinator::Config.installed?
+      yes_no Tmuxinator::Doctor.installed?
 
       say "Checking if $EDITOR is set ==> "
-      yes_no Tmuxinator::Config.editor?
+      yes_no Tmuxinator::Doctor.editor?
 
       say "Checking if $SHELL is set ==> "
-      yes_no Tmuxinator::Config.shell?
+      yes_no Tmuxinator::Doctor.shell?
     end
   end
 end

data/lib/tmuxinator/config.rb

@@ -1,13 +1,35 @@
 module Tmuxinator
   class Config
     LOCAL_DEFAULT = "./.tmuxinator.yml".freeze
-    NO_LOCAL_FILE_MSG = "Project file at ./.tmuxinator.yml doesn't exist."
+    NO_LOCAL_FILE_MSG =
+      "Project file at ./.tmuxinator.yml doesn't exist.".freeze
 
     class << self
-      def root
-        root_dir = File.expand_path("#{ENV['HOME']}/.tmuxinator")
-        Dir.mkdir(root_dir) unless File.directory?(root_dir)
-        root_dir
+      # The directory (created if needed) in which to store new projects
+      def directory
+        return environment if File.directory?(environment)
+        return xdg if File.directory?(xdg)
+        return home if File.directory?(home)
+        # No project directory specified or existant, default to XDG:
+        FileUtils::mkdir_p(xdg)
+        xdg
+      end
+
+      def home
+        ENV["HOME"] + "/.tmuxinator"
+      end
+
+      # Is ~/.config/tmuxinator unless $XDG_CONFIG_DIR is set
+      def xdg
+        XDG["CONFIG"].to_s + "/tmuxinator"
+      end
+
+      # $TMUXINATOR_CONFIG (and create directory) or "".
+      def environment
+        environment = ENV["TMUXINATOR_CONFIG"]
+        return "" if environment.to_s.empty? # variable is unset (nil) or blank
+        FileUtils::mkdir_p(environment) unless File.directory?(environment)
+        environment
       end
 
       def sample
@@ -15,69 +37,78 @@ module Tmuxinator
       end
 
       def default
-        "#{ENV['HOME']}/.tmuxinator/default.yml"
+        "#{directory}/default.yml"
       end
 
       def default?
         exists?("default")
       end
 
-      def installed?
-        Kernel.system("type tmux > /dev/null")
-      end
-
       def version
-        `tmux -V`.split(" ")[1].to_f if installed?
+        `tmux -V`.split(" ")[1].to_f if Tmuxinator::Doctor.installed?
       end
 
       def default_path_option
         version && version < 1.8 ? "default-path" : "-c"
       end
 
-      def editor?
-        !ENV["EDITOR"].nil? && !ENV["EDITOR"].empty?
-      end
-
-      def shell?
-        !ENV["SHELL"].nil? && !ENV["SHELL"].empty?
-      end
-
       def exists?(name)
         File.exist?(project(name))
       end
 
-      def project_in_root(name)
-        projects = Dir.glob("#{root}/**/*.yml")
-        projects.detect { |project| File.basename(project, ".yml") == name }
+      def local?
+        local_project
       end
 
-      def local?
-        project_in_local
+      # Pathname of given project searching only global directories
+      def global_project(name)
+        project_in(environment, name) ||
+          project_in(xdg, name) ||
+          project_in(home, name)
       end
 
-      def project_in_local
+      def local_project
         [LOCAL_DEFAULT].detect { |f| File.exist?(f) }
       end
 
       def default_project(name)
-        "#{root}/#{name}.yml"
+        "#{directory}/#{name}.yml"
       end
 
+      # Pathname of the given project
       def project(name)
-        project_in_root(name) || project_in_local || default_project(name)
+        global_project(name) || local_project || default_project(name)
       end
 
       def template
         asset_path "template.erb"
       end
 
+      def stop_template
+        asset_path "template-stop.erb"
+      end
+
       def wemux_template
         asset_path "wemux_template.erb"
       end
 
+      # Sorted list of all .yml files, including duplicates
       def configs
-        Dir["#{Tmuxinator::Config.root}/**/*.yml"].sort.map do |path|
-          path.gsub("#{Tmuxinator::Config.root}/", "").gsub(".yml", "")
+        directories.map do |directory|
+          Dir["#{directory}/**/*.yml"].map do |path|
+            path.gsub("#{directory}/", "").gsub(".yml", "")
+          end
+        end.flatten.sort
+      end
+
+      # Existant directories which may contain project files
+      # Listed in search order
+      # Used by `implode` and `list` commands
+      def directories
+        if !environment.nil? && !environment.empty?
+          [environment]
+        else
+          [xdg, home].select { |d| File.directory? d }
         end
       end
 
@@ -89,7 +120,7 @@ module Tmuxinator
         project_file = if name.nil?
                          raise NO_LOCAL_FILE_MSG \
                            unless Tmuxinator::Config.local?
-                         project_in_local
+                         local_project
                        else
                          raise "Project #{name} doesn't exist." \
                            unless Tmuxinator::Config.exists?(name)
@@ -98,11 +129,24 @@ module Tmuxinator
         Tmuxinator::Project.load(project_file, options).validate!
       end
 
+      # Deprecated methods: ignore the 1st, use the 2nd
+      alias :root             :directory
+      alias :project_in_root  :global_project
+      alias :project_in_local :local_project
+
       private
 
       def asset_path(asset)
         "#{File.dirname(__FILE__)}/assets/#{asset}"
       end
+
+      # The first pathname of the project named 'name' found while
+      # recursively searching 'directory'
+      def project_in(directory, name)
+        return nil if String(directory).empty?
+        projects = Dir.glob("#{directory}/**/*.yml").sort
+        projects.detect { |project| File.basename(project, ".yml") == name }
+      end
     end
   end
 end