tmuxinator 0.6.11 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38f09af10a658caa15c32d1abe77373cc9e2d960
-  data.tar.gz: 8a17b9b5cf0de202edb22ead61cd148462e4a8fd
+  metadata.gz: 079c5def07857f7b54737cd711899a7c529fee96
+  data.tar.gz: 461725febed6618763f593eec2952cbce8866368
 SHA512:
-  metadata.gz: 7fba40c695a6406361c67fc0275a2706577bce38b86e1b37d4a6311fac8957d9212aba70ca93c3b52150e7ec77a45cf52b2da030781f82fe2fa8c57dec694440
-  data.tar.gz: 6e39fbf6bcb98e0e7deac36693b931c1f1ff0fc024e7a6f0425bdb0c5345e2b59965511923ed8b37a0b2530604803dfc76a690d0da8463ed26e1201dc26b5db5
+  metadata.gz: f4860c8924f4feb57ae84f2d122a78b9680ff08b83e3e446c70c6464ced07b4e81be1e80e347a20e660d1c386f33d3a393caa585813a1d3eb78648c94c4173ec
+  data.tar.gz: 6b05f2ad6143fd9cd4aa15318dd8e9e9dc816a7e080cb414e468977d7a0bf7d3583f58fd36fd7e981d6ebb103f7c3690b130062980beadbc37bf6728e0bfe946

data/bin/mux

@@ -4,16 +4,13 @@ $: << File.expand_path("../../lib/", __FILE__)
 require "thor"
 require "tmuxinator"
 
-if ARGV.length == 1
-  name = ARGV[0]
+name = ARGV[0] || nil
 
-  if Tmuxinator::Cli::COMMANDS.keys.include?(name.to_sym)
-    Tmuxinator::Cli.start
-  elsif Tmuxinator::Config.exists?(name)
-    Tmuxinator::Cli.new.start(name)
-  else
-    Tmuxinator::Cli.start
-  end
+if ARGV.length == 0 && Tmuxinator::Config.local?
+  Tmuxinator::Cli.new.local
+elsif name && !Tmuxinator::Cli::COMMANDS.keys.include?(name.to_sym) &&
+      Tmuxinator::Config.exists?(name)
+  Tmuxinator::Cli.new.start(name, *ARGV.drop(1))
 else
   Tmuxinator::Cli.start
 end

data/bin/tmuxinator

@@ -4,16 +4,13 @@ $: << File.expand_path("../../lib/", __FILE__)
 require "thor"
 require "tmuxinator"
 
-if ARGV.length == 1
-  name = ARGV[0]
+name = ARGV[0] || nil
 
-  if Tmuxinator::Cli::COMMANDS.keys.include?(name.to_sym)
-    Tmuxinator::Cli.start
-  elsif Tmuxinator::Config.exists?(name)
-    Tmuxinator::Cli.new.start(name)
-  else
-    Tmuxinator::Cli.start
-  end
+if ARGV.length == 0 && Tmuxinator::Config.local?
+  Tmuxinator::Cli.new.local
+elsif name && !Tmuxinator::Cli::COMMANDS.keys.include?(name.to_sym) &&
+      Tmuxinator::Config.exists?(name)
+  Tmuxinator::Cli.new.start(name, *ARGV.drop(1))
 else
   Tmuxinator::Cli.start
 end

data/lib/tmuxinator/assets/template.erb

@@ -14,7 +14,7 @@ if [ "$?" -eq 1 ]; then
 
   # Create the session and the first window. Manually switch to root
   # directory if required to support tmux < 1.9
-  TMUX= <%= tmux %> new-session -d -s <%= name %> -n <%= windows.first.name %>
+  TMUX= <%= tmux_new_session_command %>
   <% if windows.first.root? %>
   <%= windows.first.tmux_window_command_prefix %> <%= "cd #{windows.first.root}".shellescape %> C-m
   <% end %>
@@ -71,11 +71,11 @@ if [ "$?" -eq 1 ]; then
 fi
 
 <%- if attach? -%>
-if [ -z "$TMUX" ]; then
-  <%= tmux %> -u attach-session -t <%= name %>
-else
-  <%= tmux %> -u switch-client -t <%= name %>
-fi
+  if [ -z "$TMUX" ]; then
+    <%= tmux %> -u attach-session -t <%= name %>
+  else
+    <%= tmux %> -u switch-client -t <%= name %>
+  fi
 <%- end -%>
 
 <%= post %>

data/lib/tmuxinator/assets/wemux_template.erb

@@ -8,7 +8,7 @@ if [ "$?" -eq 127 ]; then
   <%= pre %>
 
   # Create the session and the first window.
-  TMUX= <%= tmux %> new-session -d -s <%= name %> -n <%= windows.first.name %>
+  TMUX= <%= tmux_new_session_command %>
 
   # Set the default path.
   <%- if root? -%>

data/lib/tmuxinator/cli.rb

@@ -1,5 +1,11 @@
 module Tmuxinator
   class Cli < Thor
+    # By default, Thor returns exit(0) when an error occurs.
+    # Please see: https://github.com/tmuxinator/tmuxinator/issues/192
+    def self.exit_on_failure?
+      true
+    end
+
     include Tmuxinator::Util
 
     COMMANDS = {
@@ -7,9 +13,16 @@ module Tmuxinator
       completions: "Used for shell completion",
       new: "Create a new project file and open it in your editor",
       open: "Alias of new",
-      start: "Start a tmux session using a project's tmuxinator config, with an optional [ALIAS] for project reuse",
+      start: <<-DESC,
+        Start a tmux session using a project's tmuxinator config,
+        with an optional [ALIAS] for project reuse
+      DESC
+      local: "Start a tmux session using ./.tmuxinator.yml",
       debug: "Output the shell commands that are generated by tmuxinator",
-      copy: "Copy an existing project to a new project and open it in your editor",
+      copy: <<-DESC,
+        Copy an existing project to a new project and open it in
+        your editor
+      DESC
       delete: "Deletes given project",
       implode: "Deletes all tmuxinator projects",
       version: "Display installed tmuxinator version",
@@ -17,18 +30,19 @@ module Tmuxinator
       list: "Lists all tmuxinator projects"
     }
 
-    package_name "tmuxinator" unless Gem::Version.create(Thor::VERSION) < Gem::Version.create("0.18")
+    package_name "tmuxinator" \
+      unless Gem::Version.create(Thor::VERSION) < Gem::Version.create("0.18")
 
     desc "commands", COMMANDS[:commands]
 
     def commands(shell = nil)
       out = if shell == "zsh"
-        COMMANDS.map do |command, desc|
-          "#{command}:#{desc}"
-        end.join("\n")
-      else
-        COMMANDS.keys.join("\n")
-      end
+              COMMANDS.map do |command, desc|
+                "#{command}:#{desc}"
+              end.join("\n")
+            else
+              COMMANDS.keys.join("\n")
+            end
 
       puts out
     end
@@ -48,39 +62,100 @@ module Tmuxinator
     map "o" => :new
     map "e" => :new
     map "n" => :new
+    method_option :local, type: :boolean,
+                          aliases: ["-l"],
+                          desc: "Create local project file at ./.tmuxinator.yml"
 
     def new(name)
-      config = Tmuxinator::Config.project(name)
-
-      unless Tmuxinator::Config.exists?(name)
-        template = Tmuxinator::Config.default? ? Tmuxinator::Config.default : Tmuxinator::Config.sample
-        erb  = Erubis::Eruby.new(File.read(template)).result(binding)
-        File.open(config, "w") { |f| f.write(erb) }
+      project_file = if options[:local]
+                       Tmuxinator::Config::LOCAL_DEFAULT
+                     else
+                       Tmuxinator::Config.default_project(name)
+                     end
+      unless Tmuxinator::Config.exists?(project_file)
+        template = Tmuxinator::Config.default? ? :default : :sample
+        content = File.read(Tmuxinator::Config.send(template.to_sym))
+        erb = Erubis::Eruby.new(content).result(binding)
+        File.open(project_file, "w") { |f| f.write(erb) }
       end
 
-      Kernel.system("$EDITOR #{config}") || doctor
+      Kernel.system("$EDITOR #{project_file}") || doctor
     end
 
-    desc "start [PROJECT] [SESSION_NAME]", COMMANDS[:start]
-    map "s" => :start
+    no_commands do
+      def create_project(project_options = {})
+        attach_opt = project_options[:attach]
+        attach = !attach_opt.nil? && attach_opt ? true : false
+        detach = !attach_opt.nil? && !attach_opt ? true : false
+
+        options = {
+          force_attach: attach,
+          force_detach: detach,
+          name: project_options[:name],
+          custom_name: project_options[:custom_name],
+          args: project_options[:args]
+        }
+
+        begin
+          Tmuxinator::Config.validate(options)
+        rescue => e
+          exit! e.message
+        end
+      end
 
-    def start(name, custom_name  = nil)
-      project = Tmuxinator::Config.validate(name, custom_name )
+      def render_project(project)
+        if project.deprecations.any?
+          project.deprecations.each { |deprecation| say deprecation, :red }
+          puts
+          print "Press ENTER to continue."
+          STDIN.getc
+        end
 
-      if project.deprecations.any?
-        project.deprecations.each { |deprecation| say deprecation, :red }
-        puts
-        print "Press ENTER to continue."
-        STDIN.getc
+        Kernel.exec(project.render)
       end
+    end
 
-      Kernel.exec(project.render)
+    desc "start [PROJECT] [ARGS]", COMMANDS[:start]
+    map "s" => :start
+    method_option :attach, type: :boolean,
+                           aliases: "-a",
+                           desc: "Attach to tmux session after creation."
+    method_option :name, aliases: "-n",
+                         desc: "Give the session a different name"
+
+    def start(name, *args)
+      params = {
+        name: name,
+        custom_name: options[:name],
+        attach: options[:attach],
+        args: args
+      }
+      project = create_project(params)
+      render_project(project)
     end
 
-    desc "debug [PROJECT]", COMMANDS[:debug]
+    desc "local", COMMANDS[:local]
+    map "." => :local
+
+    def local
+      render_project(create_project(attach: options[:attach]))
+    end
 
-    def debug(name, custom_name  = nil)
-      project = Tmuxinator::Config.validate(name, custom_name )
+    method_option :attach, type: :boolean,
+                           aliases: "-a",
+                           desc: "Attach to tmux session after creation."
+    method_option :name, aliases: "-n",
+                         desc: "Give the session a different name"
+    desc "debug [PROJECT] [ARGS]", COMMANDS[:debug]
+
+    def debug(name, *args)
+      params = {
+        name: name,
+        custom_name: options[:name],
+        attach: options[:attach],
+        args: args
+      }
+      project = create_project(params)
       puts project.render
     end
 
@@ -92,9 +167,12 @@ module Tmuxinator
       existing_config_path = Tmuxinator::Config.project(existing)
       new_config_path = Tmuxinator::Config.project(new)
 
-      exit!("Project #{existing} doesn't exist!") unless Tmuxinator::Config.exists?(existing)
+      exit!("Project #{existing} doesn't exist!") \
+        unless Tmuxinator::Config.exists?(existing)
 
-      if !Tmuxinator::Config.exists?(new) or yes?("#{new} already exists, would you like to overwrite it?", :red)
+      new_exists = Tmuxinator::Config.exists?(new)
+      question = "#{new} already exists, would you like to overwrite it?"
+      if !new_exists || yes?(question, :red)
         say "Overwriting #{new}" if Tmuxinator::Config.exists?(new)
         FileUtils.copy_file(existing_config_path, new_config_path)
       end
@@ -108,7 +186,7 @@ module Tmuxinator
 
     def delete(project)
       if Tmuxinator::Config.exists?(project)
-        config =  "#{Tmuxinator::Config.root}/#{project}.yml"
+        config = "#{Tmuxinator::Config.root}/#{project}.yml"
 
         if yes?("Are you sure you want to delete #{project}?(y/n)", :red)
           FileUtils.rm(config)
@@ -156,7 +234,7 @@ module Tmuxinator
       yes_no Tmuxinator::Config.editor?
 
       say "Checking if $SHELL is set ==> "
-      yes_no  Tmuxinator::Config.shell?
+      yes_no Tmuxinator::Config.shell?
     end
   end
 end

data/lib/tmuxinator/config.rb

@@ -1,17 +1,21 @@
 module Tmuxinator
   class Config
+    LOCAL_DEFAULT = "./.tmuxinator.yml".freeze
+    NO_LOCAL_FILE_MSG = "Project file at ./.tmuxinator.yml doesn't exist."
+
     class << self
       def root
-        Dir.mkdir("#{ENV["HOME"]}/.tmuxinator") unless File.directory?(File.expand_path("~/.tmuxinator"))
-        "#{ENV["HOME"]}/.tmuxinator"
+        root_dir = File.expand_path("~/.tmuxinator")
+        Dir.mkdir("#{ENV['HOME']}/.tmuxinator") unless File.directory?(root_dir)
+        "#{ENV['HOME']}/.tmuxinator"
       end
 
       def sample
-        "#{File.dirname(__FILE__)}/assets/sample.yml"
+        asset_path "sample.yml"
       end
 
       def default
-        "#{ENV["HOME"]}/.tmuxinator/default.yml"
+        "#{ENV['HOME']}/.tmuxinator/default.yml"
       end
 
       def default?
@@ -42,18 +46,33 @@ module Tmuxinator
         File.exists?(project(name))
       end
 
-      def project(name)
+      def project_in_root(name)
         projects = Dir.glob("#{root}/**/*.yml")
-        project_file = projects.detect { |project| File.basename(project, ".yml") == name }
-        project_file || "#{root}/#{name}.yml"
+        projects.detect { |project| File.basename(project, ".yml") == name }
+      end
+
+      def local?
+        project_in_local
+      end
+
+      def project_in_local
+        [LOCAL_DEFAULT].detect { |f| File.exists?(f) }
+      end
+
+      def default_project(name)
+        "#{root}/#{name}.yml"
+      end
+
+      def project(name)
+        project_in_root(name) || project_in_local || default_project(name)
       end
 
       def template
-        "#{File.dirname(__FILE__)}/assets/template.erb"
+        asset_path "template.erb"
       end
 
       def wemux_template
-        "#{File.dirname(__FILE__)}/assets/wemux_template.erb"
+        asset_path "wemux_template.erb"
       end
 
       def configs
@@ -62,34 +81,27 @@ module Tmuxinator
         end
       end
 
-      def validate(name, custom_name = nil)
-        unless Tmuxinator::Config.exists?(name)
-          puts "Project #{name} doesn't exist."
-          exit!
-        end
-
-        config_path = Tmuxinator::Config.project(name)
-
-        yaml = begin
-          YAML.load(Erubis::Eruby.new(File.read(config_path)).result(binding))
-        rescue SyntaxError, StandardError
-          puts "Failed to parse config file. Please check your formatting."
-          exit!
-        end
-
-        project = Tmuxinator::Project.new(yaml, custom_name)
-
-        unless project.windows?
-          puts "Your project file should include some windows."
-          exit!
-        end
+      def validate(options = {})
+        name = options[:name]
+        options[:force_attach] ||= false
+        options[:force_detach] ||= false
+
+        project_file = if name.nil?
+                         raise NO_LOCAL_FILE_MSG \
+                           unless Tmuxinator::Config.local?
+                         project_in_local
+                       else
+                         raise "Project #{name} doesn't exist." \
+                           unless Tmuxinator::Config.exists?(name)
+                         Tmuxinator::Config.project(name)
+                       end
+        Tmuxinator::Project.load(project_file, options).validate!
+      end
 
-        unless project.name?
-          puts "Your project file didn't specify a 'project_name'"
-          exit!
-        end
+      private
 
-        project
+      def asset_path(asset)
+        "#{File.dirname(__FILE__)}/assets/#{asset}"
       end
     end
   end

data/lib/tmuxinator/pane.rb

@@ -10,27 +10,43 @@ module Tmuxinator
     end
 
     def tmux_window_and_pane_target
-      "#{project.name}:#{tab.index + project.base_index}.#{index + project.base_index}"
+      x = tab.index + project.base_index
+      y = index + project.base_index
+      "#{project.name}:#{x}.#{y}"
     end
 
     def tmux_pre_command
       return unless tab.pre
 
-      "#{project.tmux} send-keys -t #{tmux_window_and_pane_target} #{tab.pre.shellescape} C-m"
+      t = tmux_window_and_pane_target
+      e = tab.pre.shellescape
+      "#{project.tmux} send-keys -t #{t} #{e} C-m"
     end
 
     def tmux_pre_window_command
       return unless project.pre_window
 
-      "#{project.tmux} send-keys -t #{tmux_window_and_pane_target} #{project.pre_window.shellescape} C-m"
+      t = tmux_window_and_pane_target
+      e = project.pre_window.shellescape
+      "#{project.tmux} send-keys -t #{t} #{e} C-m"
     end
 
     def tmux_main_command(command)
-      command ? "#{project.tmux} send-keys -t #{project.name}:#{tab.index + project.base_index}.#{index + tab.project.base_index} #{command.shellescape} C-m" : ""
+      if command
+        x = tab.index + project.base_index
+        y = index + tab.project.base_index
+        e = command.shellescape
+        n = project.name
+        "#{project.tmux} send-keys -t #{n}:#{x}.#{y} #{e} C-m"
+      else
+        ""
+      end
     end
 
     def tmux_split_command
-      path = tab.root? ? "#{Tmuxinator::Config.default_path_option} #{tab.root}" : nil
+      path = if tab.root?
+               "#{Tmuxinator::Config.default_path_option} #{tab.root}"
+             end
       "#{project.tmux} splitw #{path} -t #{tab.tmux_window_target}"
     end