tmuxinator 0.11.2 → 0.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cdcb7955b473280b53c285478cc53101e1879c2aae780b38b06a920662a98e2
-  data.tar.gz: 2a9a7c13e4c62a53bdda0424287091f41e32066e5fc12e830b13a6e5fa6c5ca5
+  metadata.gz: 67d2add167813b344a5424b97ac84bb6b726165d52a071bacc1864ddbbd06eae
+  data.tar.gz: 8c48ba6566bf06b8168b83b87144fb47c7b879d88f419cd45bb113a4231c7615
 SHA512:
-  metadata.gz: cd0d3a92543c61cc04aefb49fa51b7d4b9134db4f9a5f48d2654b5a5807d35cec8db3506243fa1608706e3266e6a9db0067a791c54969621bc2ebabad6926a45
-  data.tar.gz: 373b41ba0664625cb2f1f36d483068bb959b1c71a6411d731358b153f8dc79dbc918b44dcb23b6511bd1c9957544fd19587c035b3319a2a956465cf5f7e0d054
+  metadata.gz: 9440f1aad417be22cb857a9b5854fec445bd46b4ef9540bb70b70550ff43f335ecef26b4b9ffb6d126124790589df5a39b676fcc41d43ffa229c68d0e3f6122c
+  data.tar.gz: 6150cea906e82d4f7038cb5ec383930c5e1d293801c92e807c97b0f2468448849fa451c988d32880ecec2812062581bf0306711b56ed9fecd7743c88bc615e80

data/bin/tmuxinator

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

data/lib/tmuxinator/assets/sample.yml

@@ -1,4 +1,4 @@
-# ~/.tmuxinator/<%= name %>.yml
+# <%= path %>
 
 name: <%= name %>
 root: ~/

data/lib/tmuxinator/cli.rb

@@ -34,6 +34,17 @@ module Tmuxinator
       list: "Lists all tmuxinator projects"
     }.freeze
 
+    # For future reference: due to how tmuxinator currently consumes
+    # command-line arguments (see ::bootstrap, below), invocations of Thor's
+    # base commands (i.e. 'help', etc) can be instead routed to #start (rather
+    # than to ::start).  In order to prevent this, the THOR_COMMANDS and
+    # RESERVED_COMMANDS constants have been introduced. The former enumerates
+    # any/all Thor commands we want to insure get passed through to Thor.start.
+    # The latter is the superset of the Thor commands and any tmuxinator
+    # commands, defined in COMMANDS, above.
+    THOR_COMMANDS = %w[-v help].freeze
+    RESERVED_COMMANDS = (COMMANDS.keys + THOR_COMMANDS).map(&:to_s).freeze
+
     package_name "tmuxinator" \
       unless Gem::Version.create(Thor::VERSION) < Gem::Version.create("0.18")
 
@@ -344,5 +355,25 @@ module Tmuxinator
       say "Checking if $SHELL is set ==> "
       yes_no Tmuxinator::Doctor.shell?
     end
+
+    # This method was defined as something of a workaround...  Previously
+    # the conditional contained within was in the executable (i.e.
+    # bin/tmuxinator).  It has been moved here so as to be testable. A couple
+    # of notes:
+    # - ::start (defined in Thor::Base) expects the first argument to be an
+    # array or ARGV, not a varargs.  Perhaps ::bootstrap should as well?
+    # - ::start has a different purpose from #start and hence a different
+    # signature
+    def self.bootstrap(args = [])
+      name = args[0] || nil
+      if args.empty? && Tmuxinator::Config.local?
+        Tmuxinator::Cli.new.local
+      elsif name && !Tmuxinator::Cli::RESERVED_COMMANDS.include?(name) &&
+            Tmuxinator::Config.exists?(name: name)
+        Tmuxinator::Cli.new.start(name, *args.drop(1))
+      else
+        Tmuxinator::Cli.start(args)
+      end
+    end
   end
 end

data/lib/tmuxinator/version.rb

@@ -1,3 +1,3 @@
 module Tmuxinator
-  VERSION = "0.11.2".freeze
+  VERSION = "0.11.3".freeze
 end

data/spec/lib/tmuxinator/cli_spec.rb

@@ -1,6 +1,28 @@
 require "spec_helper"
 
 describe Tmuxinator::Cli do
+  shared_context :local_project_setup do
+    let(:local_project_config) { ".tmuxinator.yml" }
+    let(:content_fixture) { "../../fixtures/sample.yml" }
+    let(:content_relpath) { File.join(File.dirname(__FILE__), content_fixture) }
+    let(:content_path) { File.expand_path(content_relpath) }
+    let(:content) { File.read(content_path) }
+    let(:working_dir) { FileUtils.pwd }
+    let(:local_project_relpath) { File.join(working_dir, local_project_config) }
+    let(:local_project_path) { File.expand_path(local_project_relpath) }
+
+    before do
+      File.new(local_project_path, "w").tap do |f|
+        f.write content
+      end.close
+      expect(File.exists?(local_project_path)).to be_truthy
+      expect(File.read(local_project_path)).to eq content
+    end
+
+    after do
+      File.delete(local_project_path)
+    end
+  end
   let(:cli) { Tmuxinator::Cli }
 
   before do
@@ -18,6 +40,128 @@ describe Tmuxinator::Cli do
     end
   end
 
+  context "base thor functionality" do
+    shared_examples_for :base_thor_functionality do
+      it "supports -v" do
+        out, err = capture_io { cli.bootstrap(["-v"]) }
+        expect(err).to eq ""
+        expect(out).to include(Tmuxinator::VERSION)
+      end
+
+      it "supports help" do
+        out, err = capture_io { cli.bootstrap(["help"]) }
+        expect(err).to eq ""
+        expect(out).to include("tmuxinator commands:")
+      end
+    end
+
+    it_should_behave_like :base_thor_functionality
+
+    context "with a local project config" do
+      include_context :local_project_setup
+
+      it_should_behave_like :base_thor_functionality
+    end
+  end
+
+  describe "::bootstrap" do
+    subject { cli.bootstrap(args) }
+    let(:args) { [] }
+
+    shared_examples_for :bootstrap_with_arguments do
+      let(:args) { [arg1] }
+
+      context "and the first arg is a tmuxinator command" do
+        let(:arg1) { "list" }
+
+        it "should call ::start" do
+          expect(cli).to receive(:start).with(args)
+          subject
+        end
+      end
+
+      context "and the first arg is" do
+        let(:arg1) { "sample" }
+
+        context "a tmuxinator project name" do
+          before do
+            expect(Tmuxinator::Config).to \
+              receive(:exists?).with(name: arg1) { true }
+          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)
+            subject
+          end
+        end
+
+        context "a thor command" do
+          context "(-v)" do
+            let(:arg1) { "-v" }
+
+            it "should call ::start" do
+              expect(cli).to receive(:start).with(args)
+              subject
+            end
+          end
+
+          context "(help)" do
+            let(:arg1) { "help" }
+
+            it "should call ::start" do
+              expect(cli).to receive(:start).with(args)
+              subject
+            end
+          end
+        end
+
+        context "something else" do
+          before do
+            expect(Tmuxinator::Config).to \
+              receive(:exists?).with(name: arg1) { false }
+          end
+
+          it "should call ::start" do
+            expect(cli).to receive(:start).with(args)
+            subject
+          end
+        end
+      end
+    end
+
+    context "and there is a local project config" do
+      include_context :local_project_setup
+
+      context "when no args are supplied" do
+        it "should call #local" do
+          instance = instance_double(cli)
+          expect(cli).to receive(:new).and_return(instance)
+          expect(instance).to receive(:local)
+          subject
+        end
+      end
+
+      context "when one or more args are supplied" do
+        it_should_behave_like :bootstrap_with_arguments
+      end
+    end
+
+    context "and there is no local project config" do
+      context "when no args are supplied" do
+        it "should call ::start" do
+          expect(cli).to receive(:start).with([])
+          subject
+        end
+      end
+
+      context "when one or more args are supplied" do
+        it_should_behave_like :bootstrap_with_arguments
+      end
+    end
+  end
+
   describe "#completions" do
     before do
       ARGV.replace(["completions", "start"])
@@ -638,21 +782,26 @@ describe Tmuxinator::Cli do
   end
 
   describe "#generate_project_file" do
-    let(:name) { "foobar" }
-    let(:path) { Tmuxinator::Config.default_project(name) }
+    let(:name) { "foobar-#{Time.now.to_i}" }
 
-    before do
-      expect(File).not_to exist(path), "expected file at #{path} not to exist"
-    end
-
-    after(:each) do
-      FileUtils.remove_file(path) if File.exist?(path)
+    it "should always generate a project file" do
+      Dir.mktmpdir do |dir|
+        path = "#{dir}/#{name}.yml"
+        expect(File).not_to exist(path), "expected file at #{path} not to exist"
+        new_path = Tmuxinator::Cli.new.generate_project_file(name, path)
+        expect(new_path).to eq path
+        expect(File).to exist new_path
+      end
     end
 
-    it "should always generate a project file" do
-      new_path = Tmuxinator::Cli.new.generate_project_file(name, path)
-      expect(new_path).to eq path
-      expect(File).to exist new_path
+    it "should generate a project file using the correct project file path" do
+      file = StringIO.new
+      allow(File).to receive(:open) { |&block| block.yield file }
+      Dir.mktmpdir do |dir|
+        path = "#{dir}/#{name}.yml"
+        _ = Tmuxinator::Cli.new.generate_project_file(name, path)
+        expect(file.string).to match %r{\A# #{path}$}
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tmuxinator
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.11.3
 platform: ruby
 authors:
 - Allen Bargi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-09 00:00:00.000000000 Z
+date: 2018-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis