tmuxinator 0.6.11 → 0.7.0

data/lib/tmuxinator/project.rb

@@ -4,11 +4,75 @@ module Tmuxinator
     include Tmuxinator::Deprecations
     include Tmuxinator::WemuxSupport
 
-    attr_reader :yaml, :custom_name
+    RBENVRVM_DEP_MSG = <<-M
+    DEPRECATION: rbenv/rvm-specific options have been replaced by the
+    pre_tab option and will not be supported in 0.8.0.
+    M
+    TABS_DEP_MSG = <<-M
+    DEPRECATION: The tabs option has been replaced by the windows option
+    and will not be supported in 0.8.0.
+    M
+    CLIARGS_DEP_MSG = <<-M
+    DEPRECATION: The cli_args option has been replaced by the tmux_options
+    option and will not be supported in 0.8.0.
+    M
+
+    attr_reader :yaml
+    attr_reader :force_attach
+    attr_reader :force_detach
+    attr_reader :custom_name
+
+    def self.load(path, options = {})
+      yaml = begin
+        raw_content = File.read(path)
+
+        args = options[:args] || []
+        @settings = parse_settings(args)
+        @args = args
+
+        content = Erubis::Eruby.new(raw_content).result(binding)
+        YAML.load(content)
+      rescue SyntaxError, StandardError
+        raise "Failed to parse config file. Please check your formatting."
+      end
+
+      new(yaml, options)
+    end
+
+    def self.parse_settings(args)
+      settings = args.select { |x| x.match(/.*=.*/) }
+      args.reject! { |x| x.match(/.*=.*/) }
+
+      settings.map! do |setting|
+        parts = setting.split("=")
+        [parts[0], parts[1]]
+      end
+
+      Hash[settings]
+    end
+
+    def validate!
+      raise "Your project file should include some windows." \
+        unless self.windows?
+      raise "Your project file didn't specify a 'project_name'" \
+        unless self.name?
+      self
+    end
+
+    def initialize(yaml, options = {})
+      options[:force_attach] = false if options[:force_attach].nil?
+      options[:force_detach] = false if options[:force_detach].nil?
 
-    def initialize(yaml, custom_name = nil)
       @yaml = yaml
-      @custom_name = custom_name
+
+      @custom_name = options[:custom_name]
+
+      @force_attach = options[:force_attach]
+      @force_detach = options[:force_detach]
+
+      raise "Cannot force_attach and force_detach at the same time" \
+        if @force_attach && @force_detach
+
       load_wemux_overrides if wemux?
     end
 
@@ -20,7 +84,7 @@ module Tmuxinator
     def windows
       windows_yml = yaml["tabs"] || yaml["windows"]
 
-      @windows ||= windows_yml.map.with_index do |window_yml, index|
+      @windows ||= (windows_yml || {}).map.with_index do |window_yml, index|
         Tmuxinator::Window.new(window_yml, index, self)
       end
     end
@@ -32,7 +96,7 @@ module Tmuxinator
 
     def name
       name = custom_name || yaml["project_name"] || yaml["name"]
-      name.blank? ? nil : name.shellescape
+      name.blank? ? nil : name.to_s.shellescape
     end
 
     def pre
@@ -44,11 +108,21 @@ module Tmuxinator
       end
     end
 
+    def attach?
+      if yaml["attach"].nil?
+        yaml_attach = true
+      else
+        yaml_attach = yaml["attach"]
+      end
+      attach = force_attach || !force_detach && yaml_attach
+      attach
+    end
+
     def pre_window
       if rbenv?
-        "rbenv shell #{yaml["rbenv"]}"
+        "rbenv shell #{yaml['rbenv']}"
       elsif rvm?
-        "rvm use #{yaml["rvm"]}"
+        "rvm use #{yaml['rvm']}"
       elsif pre_tab?
         yaml["pre_tab"]
       else
@@ -56,14 +130,6 @@ module Tmuxinator
       end
     end
 
-    def attach
-      attach = true
-      if !yaml["attach"].nil?
-        attach = yaml["attach"]
-      end
-      attach
-    end
-
     def post
       post_config = yaml["post"]
       if post_config.is_a?(Array)
@@ -86,8 +152,6 @@ module Tmuxinator
         " -S #{socket_path}"
       elsif socket_name
         " -L #{socket_name}"
-      else
-        nil
       end
     end
 
@@ -101,9 +165,9 @@ module Tmuxinator
 
     def tmux_options
       if cli_args?
-        " #{yaml["cli_args"].to_s.strip}"
+        " #{yaml['cli_args'].to_s.strip}"
       elsif tmux_options?
-        " #{yaml["tmux_options"].to_s.strip}"
+        " #{yaml['tmux_options'].to_s.strip}"
       else
         ""
       end
@@ -133,15 +197,11 @@ module Tmuxinator
       !name.nil?
     end
 
-    def attach?
-      !!attach
-    end
-
     def window(i)
       "#{name}:#{i}"
     end
 
-    def send_pane_command(cmd, window_index, pane_index)
+    def send_pane_command(cmd, window_index, _pane_index)
       if cmd.empty?
         ""
       else
@@ -151,7 +211,7 @@ module Tmuxinator
 
     def send_keys(cmd, window_index)
       if cmd.empty?
-       ""
+        ""
       else
         "#{tmux} send-keys -t #{window(window_index)} #{cmd.shellescape} C-m"
       end
@@ -159,9 +219,9 @@ module Tmuxinator
 
     def deprecations
       deprecations = []
-      deprecations << "DEPRECATION: rbenv/rvm specific options have been replaced by the pre_tab option and will not be supported in 0.8.0." if yaml["rbenv"] || yaml["rvm"]
-      deprecations << "DEPRECATION: The tabs option has been replaced by the windows option and will not be supported in 0.8.0." if yaml["tabs"]
-      deprecations << "DEPRECATION: The cli_args option has been replaced by the tmux_options option and will not be supported in 0.8.0." if yaml["cli_args"]
+      deprecations << RBENVRVM_DEP_MSG if yaml["rbenv"] || yaml["rvm"]
+      deprecations << TABS_DEP_MSG if yaml["tabs"]
+      deprecations << CLIARGS_DEP_MSG if yaml["cli_args"]
       deprecations
     end
 
@@ -177,6 +237,11 @@ module Tmuxinator
       "#{tmux} start-server\\; show-option -g"
     end
 
+    def tmux_new_session_command
+      window = windows.first.tmux_window_name_option
+      "#{tmux} new-session -d -s #{name} #{window}"
+    end
+
     private
 
     def tmux_config
@@ -187,7 +252,7 @@ module Tmuxinator
       options_hash = {}
 
       options_string = `#{show_tmux_options}`
-      options_string.encode!("UTF-8", :invalid => :replace)
+      options_string.encode!("UTF-8", invalid: :replace)
       options_string.split("\n").map do |entry|
         key, value = entry.split("\s")
         options_hash[key] = value

data/lib/tmuxinator/version.rb

@@ -1,3 +1,3 @@
 module Tmuxinator
-  VERSION = "0.6.11"
+  VERSION = "0.7.0"
 end

data/lib/tmuxinator/wemux_support.rb

@@ -5,17 +5,17 @@ module Tmuxinator
     end
 
     def load_wemux_overrides
-      self.instance_eval do
-        def render
+      class_eval do
+        define_method :render do
           template = File.read(Tmuxinator::Config.wemux_template)
           Erubis::Eruby.new(template).result(binding)
         end
 
-        def name
+        define_method :name do
           "wemux"
         end
 
-        def tmux
+        define_method :tmux do
           "wemux"
         end
       end

data/lib/tmuxinator/window.rb

@@ -5,7 +5,9 @@ module Tmuxinator
     attr_reader :name, :root, :panes, :layout, :commands, :index, :project
 
     def initialize(window_yaml, index, project)
-      @name = !window_yaml.keys.first.nil? ? window_yaml.keys.first.shellescape : nil
+      @name = if !window_yaml.keys.first.nil?
+                window_yaml.keys.first.shellescape
+              end
       @root = nil
       @panes = []
       @layout = nil
@@ -18,7 +20,11 @@ module Tmuxinator
       if value.is_a?(Hash)
         @layout = value["layout"] ? value["layout"].shellescape : nil
         @pre = value["pre"] if value["pre"]
-        @root = value["root"] ? File.expand_path(value["root"]).shellescape : project.root? ? project.root : nil
+        @root = if value["root"]
+                  File.expand_path(value["root"]).shellescape
+                elsif project.root?
+                  project.root
+                end
 
         @panes = build_panes(value["panes"])
       else
@@ -29,7 +35,7 @@ module Tmuxinator
     def build_panes(panes_yml)
       Array(panes_yml).map.with_index do |pane_yml, index|
         if pane_yml.is_a?(Hash)
-          pane_yml.map do |name, commands|
+          pane_yml.map do |_name, commands|
             Tmuxinator::Pane.new(index, project, self, *commands)
           end
         else
@@ -38,7 +44,7 @@ module Tmuxinator
       end.flatten
     end
 
-    def build_commands(prefix, command_yml)
+    def build_commands(_prefix, command_yml)
       if command_yml.is_a?(Array)
         command_yml.map do |command|
           "#{tmux_window_command_prefix} #{command.shellescape} C-m" if command
@@ -80,9 +86,13 @@ module Tmuxinator
       "#{project.tmux} send-keys -t #{project.name}:#{index + project.base_index}"
     end
 
+    def tmux_window_name_option
+      name ? "-n #{name}" : ""
+    end
+
     def tmux_new_window_command
       path = root? ? "#{Tmuxinator::Config.default_path_option} #{root}" : nil
-      "#{project.tmux} new-window #{path} -t #{tmux_window_target} -n #{name}"
+      "#{project.tmux} new-window #{path} -t #{tmux_window_target} #{tmux_window_name_option}"
     end
 
     def tmux_layout_command

data/spec/factories/projects.rb

@@ -1,39 +1,81 @@
+def yaml_load(file)
+  YAML.load(File.read(File.expand_path(file)))
+end
 FactoryGirl.define do
-  factory :project, :class => Tmuxinator::Project do
+  factory :project, class: Tmuxinator::Project do
+    transient do
+      file { yaml_load("spec/fixtures/sample.yml") }
+    end
+
+    initialize_with { Tmuxinator::Project.new(file) }
+  end
+
+  factory :project_with_force_attach, class: Tmuxinator::Project do
+    transient do
+      file { yaml_load("spec/fixtures/detach.yml") }
+    end
+
+    initialize_with { Tmuxinator::Project.new(file, force_attach: true) }
+  end
+
+  factory :project_with_force_detach, class: Tmuxinator::Project do
+    transient do
+      file { yaml_load("spec/fixtures/detach.yml") }
+    end
+    initialize_with { Tmuxinator::Project.new(file, force_detach: true) }
+  end
+
+  factory :project_with_custom_name, class: Tmuxinator::Project do
+    transient do
+      file { yaml_load("spec/fixtures/sample.yml") }
+    end
+
+    initialize_with { Tmuxinator::Project.new(file, custom_name: "custom") }
+  end
+
+  factory :project_with_number_as_name, class: Tmuxinator::Project do
     transient do
-      file { YAML.load(File.read("#{File.expand_path("spec/fixtures/sample.yml")}")) }
+      file { yaml_load("spec/fixtures/sample_number_as_name.yml") }
     end
 
     initialize_with { Tmuxinator::Project.new(file) }
   end
 
-  factory :project_with_custom_name, :class => Tmuxinator::Project do
+  factory :project_with_deprecations, class: Tmuxinator::Project do
     transient do
-      file { YAML.load(File.read("#{File.expand_path("spec/fixtures/sample.yml")}")) }
+      file { yaml_load("spec/fixtures/sample.deprecations.yml") }
     end
 
-    initialize_with { Tmuxinator::Project.new(file, "custom") }
+    initialize_with { Tmuxinator::Project.new(file) }
+  end
+
+  factory :wemux_project, class: Tmuxinator::Project do
+    transient do
+      file { yaml_load("spec/fixtures/sample_wemux.yml") }
+    end
+
+    initialize_with { Tmuxinator::Project.new(file) }
   end
 
-  factory :project_with_deprecations, :class => Tmuxinator::Project do
+  factory :noname_project, class: Tmuxinator::Project do
     transient do
-      file { YAML.load(File.read("#{File.expand_path("spec/fixtures/sample.deprecations.yml")}")) }
+      file { yaml_load("spec/fixtures/noname.yml") }
     end
 
     initialize_with { Tmuxinator::Project.new(file) }
   end
 
-  factory :wemux_project, :class => Tmuxinator::Project do
+  factory :nowindows_project, class: Tmuxinator::Project do
     transient do
-      file { YAML.load(File.read("#{File.expand_path("spec/fixtures/sample_wemux.yml")}")) }
+      file { yaml_load("spec/fixtures/nowindows.yml") }
     end
 
     initialize_with { Tmuxinator::Project.new(file) }
   end
 
-  factory :noname_project, :class => Tmuxinator::Project do
+  factory :nameless_window_project, class: Tmuxinator::Project do
     transient do
-      file { YAML.load(File.read("#{File.expand_path("spec/fixtures/noname.yml")}")) }
+      file { yaml_load("spec/fixtures/nameless_window.yml") }
     end
 
     initialize_with { Tmuxinator::Project.new(file) }

data/spec/fixtures/detach.yml

@@ -0,0 +1,41 @@
+# ~/.tmuxinator/sample.yml
+# you can make as many tabs as you wish...
+
+name: sample
+root: ~/test
+socket_name: foo # Remove to use default socket
+pre: sudo /etc/rc.d/mysqld start # Runs before everything
+pre_window: rbenv shell 2.0.0-p247 # Runs in each tab and pane
+tmux_options: -f ~/.tmux.mac.conf # Pass arguments to tmux
+attach: false
+windows:
+  - editor:
+      pre:
+        - echo "I get run in each pane, before each pane command!"
+        -
+      layout: main-vertical
+      panes:
+        - vim
+        - #empty, will just run plain bash
+        - top
+        - pane_with_multiple_commands:
+            - ssh server
+            - echo "Hello"
+  - shell:
+    - git pull
+    - git merge
+  - guard:
+      layout: tiled
+      pre:
+        - echo "I get run in each pane."
+        - echo "Before each pane command!"
+      panes:
+        -
+        - #empty, will just run plain bash
+        -
+  - database: bundle exec rails db
+  - server: bundle exec rails s
+  - logs: tail -f log/development.log
+  - console: bundle exec rails c
+  - capistrano:
+  - server: ssh user@example.com

data/spec/fixtures/nameless_window.yml

@@ -0,0 +1,5 @@
+name: nameless_window
+root: ~/
+windows:
+  - ~: echo "this is a window with no name"
+  - other: echo "this window has a name"

data/spec/fixtures/nowindows.yml

@@ -0,0 +1,3 @@
+name: no_windows
+root: ~/
+

data/spec/fixtures/sample.yml

@@ -7,6 +7,7 @@ socket_name: foo # Remove to use default socket
 pre: sudo /etc/rc.d/mysqld start # Runs before everything
 pre_window: rbenv shell 2.0.0-p247 # Runs in each tab and pane
 tmux_options: -f ~/.tmux.mac.conf # Pass arguments to tmux
+tmux_detached: false
 windows:
   - editor:
       pre: