tmuxinator 0.6.11 → 0.7.0

data/spec/lib/tmuxinator/project_spec.rb

@@ -2,10 +2,27 @@ require "spec_helper"
 
 describe Tmuxinator::Project do
   let(:project) { FactoryGirl.build(:project) }
-  let(:project_with_custom_name) { FactoryGirl.build(:project_with_custom_name) }
-  let(:project_with_deprecations) { FactoryGirl.build(:project_with_deprecations) }
+  let(:project_with_custom_name) do
+    FactoryGirl.build(:project_with_custom_name)
+  end
+  let(:project_with_number_as_name) do
+    FactoryGirl.build(:project_with_number_as_name)
+  end
+  let(:project_with_deprecations) do
+    FactoryGirl.build(:project_with_deprecations)
+  end
+  let(:project_with_force_attach) do
+    FactoryGirl.build(:project_with_force_attach)
+  end
+  let(:project_with_force_detach) do
+    FactoryGirl.build(:project_with_force_detach)
+  end
+
   let(:wemux_project) { FactoryGirl.build(:wemux_project) }
   let(:noname_project) { FactoryGirl.build(:noname_project) }
+  let(:nameless_window_project) do
+    FactoryGirl.build(:nameless_window_project)
+  end
 
   describe "#initialize" do
     context "valid yaml" do
@@ -65,7 +82,7 @@ describe Tmuxinator::Project do
 
     context "without root" do
       it "doesn't throw an error" do
-        expect{noname_project.root}.to_not raise_error
+        expect { noname_project.root }.to_not raise_error
       end
     end
   end
@@ -91,7 +108,14 @@ describe Tmuxinator::Project do
 
     context "without name" do
       it "displays error message" do
-        expect{noname_project.name}.to_not raise_error
+        expect { noname_project.name }.to_not raise_error
+      end
+    end
+
+    context "as number" do
+      it "will gracefully handle a name given as a number" do
+        rendered = project_with_number_as_name
+        expect(rendered.name.to_i).to_not equal 0
       end
     end
   end
@@ -104,8 +128,9 @@ describe Tmuxinator::Project do
     context "with deprecations" do
       context "rbenv option is present" do
         before do
-          allow(project).to receive_messages(:rbenv? => true)
-          allow(project).to receive_message_chain(:yaml, :[]).and_return("2.0.0-p247")
+          allow(project).to receive_messages(rbenv?: true)
+          allow(project).to \
+            receive_message_chain(:yaml, :[]).and_return("2.0.0-p247")
         end
 
         it "still gets the correct pre_window command" do
@@ -115,8 +140,9 @@ describe Tmuxinator::Project do
 
       context "rvm option is present" do
         before do
-          allow(project).to receive_messages(:rbenv? => false)
-          allow(project).to receive_message_chain(:yaml, :[]).and_return("ruby-2.0.0-p247")
+          allow(project).to receive_messages(rbenv?: false)
+          allow(project).to \
+            receive_message_chain(:yaml, :[]).and_return("ruby-2.0.0-p247")
         end
 
         it "still gets the correct pre_window command" do
@@ -126,8 +152,8 @@ describe Tmuxinator::Project do
 
       context "pre_tab is present" do
         before do
-          allow(project).to receive_messages(:rbenv? => false)
-          allow(project).to receive_messages(:pre_tab? => true)
+          allow(project).to receive_messages(rbenv?: false)
+          allow(project).to receive_messages(pre_tab?: true)
         end
 
         it "still gets the correct pre_window command" do
@@ -140,7 +166,7 @@ describe Tmuxinator::Project do
   describe "#socket" do
     context "socket path is present" do
       before do
-        allow(project).to receive_messages(:socket_path => "/tmp")
+        allow(project).to receive_messages(socket_path: "/tmp")
       end
 
       it "gets the socket path" do
@@ -170,7 +196,7 @@ describe Tmuxinator::Project do
   describe "#tmux_options" do
     context "no tmux options" do
       before do
-        allow(project).to receive_messages(:tmux_options? => false)
+        allow(project).to receive_messages(tmux_options?: false)
       end
 
       it "returns nothing" do
@@ -180,18 +206,20 @@ describe Tmuxinator::Project do
 
     context "with deprecations" do
       before do
-        allow(project_with_deprecations).to receive_messages(:cli_args? => true)
+        allow(project_with_deprecations).to receive_messages(cli_args?: true)
       end
 
       it "still gets the tmux options" do
-        expect(project_with_deprecations.tmux_options).to eq " -f ~/.tmux.mac.conf"
+        expect(project_with_deprecations.tmux_options).to \
+          eq " -f ~/.tmux.mac.conf"
       end
     end
   end
 
   describe "#get_pane_base_index" do
     it "extracts the pane_base_index from tmux_options" do
-      allow(project).to receive_messages(show_tmux_options: tmux_config(pane_base_index: 3))
+      allow(project).to \
+        receive_messages(show_tmux_options: tmux_config(pane_base_index: 3))
 
       expect(project.get_pane_base_index).to eq("3")
     end
@@ -199,7 +227,8 @@ describe Tmuxinator::Project do
 
   describe "#get_base_index" do
     it "extracts the base index from options" do
-      allow(project).to receive_messages(show_tmux_options: tmux_config(base_index: 1))
+      allow(project).to \
+        receive_messages(show_tmux_options: tmux_config(base_index: 1))
 
       expect(project.get_base_index).to eq("1")
     end
@@ -208,8 +237,8 @@ describe Tmuxinator::Project do
   describe "#base_index" do
     context "pane base index present" do
       before do
-        allow(project).to receive_messages(:get_pane_base_index => "1")
-        allow(project).to receive_messages(:get_base_index => "1")
+        allow(project).to receive_messages(get_pane_base_index: "1")
+        allow(project).to receive_messages(get_base_index: "1")
       end
 
       it "gets the pane base index" do
@@ -219,8 +248,8 @@ describe Tmuxinator::Project do
 
     context "pane base index no present" do
       before do
-        allow(project).to receive_messages(:get_pane_base_index => nil)
-        allow(project).to receive_messages(:get_base_index => "0")
+        allow(project).to receive_messages(get_pane_base_index: nil)
+        allow(project).to receive_messages(get_base_index: "0")
       end
 
       it "gets the base index" do
@@ -234,15 +263,15 @@ describe Tmuxinator::Project do
       it "gets the startup window from project config" do
         project.yaml["startup_window"] = "logs"
 
-	expect(project.startup_window).to eq("logs")
+        expect(project.startup_window).to eq("logs")
       end
     end
 
     context "startup window not specified" do
       it "returns base index instead" do
-        allow(project).to receive_messages(:base_index => 8)
+        allow(project).to receive_messages(base_index: 8)
 
-	expect(project.startup_window).to eq 8
+        expect(project.startup_window).to eq 8
       end
     end
   end
@@ -286,7 +315,8 @@ describe Tmuxinator::Project do
 
     context "command for window is not empty" do
       it "returns the tmux command" do
-        expect(project.send_keys("vim", 1)).to eq "tmux -f ~/.tmux.mac.conf -L foo send-keys -t sample:1 vim C-m"
+        expect(project.send_keys("vim", 1)).to \
+          eq "tmux -f ~/.tmux.mac.conf -L foo send-keys -t sample:1 vim C-m"
       end
     end
   end
@@ -300,7 +330,8 @@ describe Tmuxinator::Project do
 
     context "command for pane is not empty" do
       it "returns the tmux command" do
-        expect(project.send_pane_command("vim", 1, 0)).to eq "tmux -f ~/.tmux.mac.conf -L foo send-keys -t sample:1 vim C-m"
+        expect(project.send_pane_command("vim", 1, 0)).to \
+          eq "tmux -f ~/.tmux.mac.conf -L foo send-keys -t sample:1 vim C-m"
       end
     end
   end
@@ -323,7 +354,11 @@ describe Tmuxinator::Project do
     let(:window) { project.windows.keep_if { |w| w.name == "shell" }.first }
 
     it "splits commands into an array" do
-      expect(window.commands).to eq(["tmux -f ~/.tmux.mac.conf -L foo send-keys -t sample:1 git\\ pull C-m", "tmux -f ~/.tmux.mac.conf -L foo send-keys -t sample:1 git\\ merge C-m"])
+      commands = [
+        "tmux -f ~/.tmux.mac.conf -L foo send-keys -t sample:1 git\\ pull C-m",
+        "tmux -f ~/.tmux.mac.conf -L foo send-keys -t sample:1 git\\ merge C-m"
+      ]
+      expect(window.commands).to eq(commands)
     end
   end
 
@@ -339,16 +374,125 @@ describe Tmuxinator::Project do
     end
 
     context "pre in yaml is Array" do
-      before {
+      before do
         project.yaml["pre"] = [
           "mysql.server start",
           "memcached -d"
         ]
-      }
+      end
 
       it "joins array using ;" do
         expect(pre).to eq("mysql.server start; memcached -d")
       end
     end
   end
+
+  describe "#attach?" do
+    context "attach is true in yaml" do
+      before { project.yaml["attach"] = true }
+
+      it "returns true" do
+        expect(project.attach?).to be_truthy
+      end
+    end
+
+    context "attach is not defined in yaml" do
+      it "returns true" do
+        expect(project.attach?).to be_truthy
+      end
+    end
+
+    context "attach is false in yaml" do
+      before { project.yaml["attach"] = false }
+      it "returns false" do
+        expect(project.attach?).to be_falsey
+      end
+    end
+
+    context "attach is true in yaml, but command line forces detach" do
+      before { project_with_force_attach.yaml["attach"] = true }
+
+      it "returns false" do
+        expect(project_with_force_detach.attach?).to be_falsey
+      end
+    end
+
+    context "attach is false in yaml, but command line forces attach" do
+      before { project_with_force_detach.yaml["attach"] = false }
+
+      it "returns true" do
+        expect(project_with_force_attach.attach?).to be_truthy
+      end
+    end
+  end
+
+  describe "tmux_new_session_command" do
+    let(:command) { "#{executable} new-session -d -s #{session} -n #{window}" }
+    let(:executable) { project.tmux }
+    let(:session) { project.name }
+    let(:window) { project.windows.first.name }
+
+    context "when first window has a name" do
+      it "returns command to start a new detatched session" do
+        expect(project.tmux_new_session_command).to eq command
+      end
+    end
+
+    context "when first window is nameless" do
+      let(:project) { nameless_window_project }
+      let(:command) { "#{project.tmux} new-session -d -s #{project.name} " }
+
+      it "returns command to for new detatched session without a window name" do
+        expect(project.tmux_new_session_command).to eq command
+      end
+    end
+  end
+
+  describe "::load" do
+    let(:path) { File.expand_path("../../../fixtures/sample.yml", __FILE__) }
+    let(:options) { {} }
+
+    it "should raise if the project file doesn't parse" do
+      bad_yaml = <<-Y
+      name: "foo"
+        subkey:
+      Y
+      expect(File).to receive(:read).with(path) { bad_yaml }
+      expect do
+        described_class.load(path, options)
+      end.to raise_error RuntimeError, %r{Failed.to.parse.config.file}
+    end
+
+    it "should return an instance of the class if the file loads" do
+      expect(described_class.load(path, options)).to be_a Tmuxinator::Project
+    end
+  end
+
+  describe "::parse_settings" do
+    let(:args) { ["one", "two=three"] }
+
+    it "returns settings in a hash" do
+      expect(described_class.parse_settings(args)["two"]).to eq("three")
+    end
+
+    it "removes settings from args" do
+      described_class.parse_settings(args)
+      expect(args).to eq(["one"])
+    end
+  end
+
+  describe "#validate!" do
+    it "should raise if there are no windows defined" do
+      nowindows_project = FactoryGirl.build(:nowindows_project)
+      expect do
+        nowindows_project.validate!
+      end.to raise_error RuntimeError, %r{should.include.some.windows}
+    end
+
+    it "should raise if there is not a project name" do
+      expect do
+        noname_project.validate!
+      end.to raise_error RuntimeError, %r{didn't.specify.a.'project_name'}
+    end
+  end
 end

data/spec/lib/tmuxinator/util_spec.rb

@@ -2,5 +2,4 @@ require "spec_helper"
 
 describe Tmuxinator::Util do
   let(:util) { Object.new.extend(Tmuxinator::Util) }
-
 end

data/spec/lib/tmuxinator/wemux_support_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+describe Tmuxinator::WemuxSupport do
+  let(:klass) { Class.new { include Tmuxinator::WemuxSupport } }
+  let(:instance) { klass.new }
+
+  it { expect(instance).to respond_to :wemux? }
+  it { expect(instance).to respond_to :load_wemux_overrides }
+
+  describe "#load_wemux_overrides" do
+    before { instance.load_wemux_overrides }
+
+    it "adds a render method" do
+      expect(instance).to respond_to :render
+    end
+
+    it "adds a name method" do
+      expect(instance).to respond_to :name
+    end
+
+    it "adds a tmux method" do
+      expect(instance).to respond_to :tmux
+    end
+  end
+
+  describe "#render" do
+    before { instance.load_wemux_overrides }
+
+    it "renders the template" do
+      expect(File).to receive(:read).at_least(:once) { "wemux ls 2>/dev/null" }
+
+      expect(instance.render).to match %r{wemux.ls.2>\/dev\/null}
+    end
+  end
+
+  describe "#name" do
+    before { instance.load_wemux_overrides }
+
+    it { expect(instance.name).to eq "wemux" }
+  end
+
+  describe "#tmux" do
+    before { instance.load_wemux_overrides }
+
+    it { expect(instance.tmux).to eq "wemux" }
+  end
+end

data/spec/lib/tmuxinator/window_spec.rb

@@ -3,10 +3,14 @@ require "spec_helper"
 describe Tmuxinator::Window do
   let(:project) { double }
   let(:panes) { ["vim", nil, "top"] }
+  let(:window_name) { "editor" }
   let(:yaml) do
     {
-      "editor" => {
-        "pre" => ["echo 'I get run in each pane.  Before each pane command!'", nil],
+      window_name => {
+        "pre" => [
+          "echo 'I get run in each pane.  Before each pane command!'",
+          nil
+        ],
         "layout" => "main-vertical",
         "panes" => panes
       }
@@ -17,7 +21,10 @@ describe Tmuxinator::Window do
       "editor" => {
         "root" => "/project/override",
         "root?" => true,
-        "pre" => ["echo 'I get run in each pane.  Before each pane command!'", nil],
+        "pre" => [
+          "echo 'I get run in each pane.  Before each pane command!'",
+          nil
+        ],
         "layout" => "main-vertical",
         "panes" => panes
       }
@@ -29,12 +36,12 @@ describe Tmuxinator::Window do
 
   before do
     allow(project).to receive_messages(
-       :tmux => "tmux",
-       :name => "test",
-       :base_index => 1,
-       :root => "/project/tmuxinator",
-       :root? => true
-     )
+      tmux: "tmux",
+      name: "test",
+      base_index: 1,
+      root: "/project/tmuxinator",
+      root?: true
+    )
   end
 
   describe "#initialize" do
@@ -61,7 +68,7 @@ describe Tmuxinator::Window do
     let(:pane) { double(:pane) }
 
     before do
-      allow(Tmuxinator::Pane).to receive_messages :new => pane
+      allow(Tmuxinator::Pane).to receive_messages new: pane
     end
 
     context "with a three element Array" do
@@ -133,7 +140,10 @@ describe Tmuxinator::Window do
       end
 
       it "returns the flattened command" do
-        expect(window.commands).to eq ["tmux send-keys -t test:1 git\\ fetch C-m", "tmux send-keys -t test:1 git\\ status C-m"]
+        expect(window.commands).to eq [
+          "tmux send-keys -t test:1 git\\ fetch C-m",
+          "tmux send-keys -t test:1 git\\ status C-m"
+        ]
       end
     end
 
@@ -158,27 +168,78 @@ describe Tmuxinator::Window do
     end
   end
 
+  describe "#name_options" do
+    context "with a name" do
+      let(:window_name) { "editor" }
+
+      it "specifies name with tmux name option" do
+        expect(window.tmux_window_name_option).to eq "-n #{window_name}"
+      end
+    end
+
+    context "without a name" do
+      let(:window_name) { nil }
+
+      it "specifies no tmux name option" do
+        expect(window.tmux_window_name_option).to be_empty
+      end
+    end
+  end
+
   describe "#tmux_new_window_command" do
     let(:project) { double(:project) }
     let(:window) { Tmuxinator::Window.new(yaml, 0, project) }
+    let(:root?) { true }
+    let(:root) { "/project/tmuxinator" }
 
     before do
       allow(project).to receive_messages(
-        :name => "",
-        :tmux => "tmux",
-        :root => "/project/tmuxinator",
-        :root? => true,
-        :base_index => 1
+        name: "test",
+        tmux: "tmux",
+        root: root,
+        root?: root?,
+        base_index: 1
       )
     end
 
-    context "tmux 1.6 and below" do
-      before do
-        allow(Tmuxinator::Config).to receive_messages(:version => 1.6)
+    let(:tmux_part) { project.tmux }
+    let(:window_part) { "new-window" }
+    let(:name_part) { window.tmux_window_name_option }
+    let(:target_part) { "-t #{window.tmux_window_target}" }
+    let(:path_part) { "#{path_option} #{project.root}" }
+
+    let(:path_option) { "-c" }
+    let(:full_command) do
+      "#{tmux_part} #{window_part} #{path_part} #{target_part} #{name_part}"
+    end
+
+    before do
+      allow(Tmuxinator::Config).to receive(:default_path_option) { path_option }
+    end
+
+    it "contstructs window command with path, target, and name options" do
+      expect(window.tmux_new_window_command).to eq full_command
+    end
+
+    context "root not set" do
+      let(:root?) { false }
+      let(:root) { nil }
+
+      let(:path_part) { nil }
+
+      it "has an extra space instead of path_part" do
+        expect(window.tmux_new_window_command).to eq full_command
+      end
+    end
+
+    context "name not set" do
+      let(:window_name) { nil }
+      let(:full_command) do
+        "#{tmux_part} #{window_part} #{path_part} #{target_part} "
       end
 
-      it "specifies root path by passing default-path to tmux" do
-        expect(window.tmux_new_window_command).to include("default-path /project/tmuxinator")
+      it "does not set name option" do
+        expect(window.tmux_new_window_command).to eq full_command
       end
     end
   end