tmuxinator 0.5.0 → 0.6.0

data/lib/tmuxinator/config.rb

@@ -0,0 +1,92 @@
+require "pry"
+module Tmuxinator
+  class Config
+    class << self
+      def root
+        Dir.mkdir("#{ENV["HOME"]}/.tmuxinator") unless File.directory?(File.expand_path("~/.tmuxinator"))
+        "#{ENV["HOME"]}/.tmuxinator"
+      end
+
+      def sample
+        "#{File.dirname(__FILE__)}/assets/sample.yml"
+      end
+
+      def default
+        "#{ENV["HOME"]}/.tmuxinator/default.yml"
+      end
+
+      def default?
+        exists?(default)
+      end
+
+      def installed?
+        Kernel.system("which tmux > /dev/null")
+      end
+
+      def editor?
+        !ENV["EDITOR"].nil? && !ENV["EDITOR"].empty?
+      end
+
+      def shell?
+        !ENV["SHELL"].nil? && !ENV["SHELL"].empty?
+      end
+
+      def exists?(name)
+        unless project(name).nil?
+          File.exists?(project(name))
+        else
+          false
+        end
+      end
+
+      def project(name)
+        projects = Dir.glob("#{root}/**/*.yml")
+        projects.select { |project| project =~ /#{name}.yml/ }.first
+      end
+
+      def template
+        "#{File.dirname(__FILE__)}/assets/template.erb"
+      end
+
+      def configs
+        Dir["#{Tmuxinator::Config.root}/*.yml"].sort.map do |path|
+          path.gsub("#{Tmuxinator::Config.root}/", "").gsub(".yml", "")
+        end
+      end
+
+      def validate(name)
+        unless Tmuxinator::Config.exists?(name)
+          puts "Project #{name} doesn't exist."
+          exit!
+        end
+
+        config_path = Tmuxinator::Config.project(name)
+
+        yaml = begin
+          YAML.load(File.read(config_path))
+        rescue SyntaxError, StandardError
+          puts "Failed to parse config file. Please check your formatting."
+          exit!
+        end
+
+        project = Tmuxinator::Project.new(yaml)
+
+        unless project.windows?
+          puts "Your project file should include some windows."
+          exit!
+        end
+
+        unless project.root?
+          puts "Your project file didn't specify a 'project_root'"
+          exit!
+        end
+
+        unless project.name?
+          puts "Your project file didn't specify a 'project_name'"
+        end
+
+        project
+      end
+    end
+  end
+end

data/lib/tmuxinator/deprecations.rb

@@ -0,0 +1,19 @@
+module Tmuxinator
+  module Deprecations
+    def rvm?
+      yaml["rvm"].present?
+    end
+
+    def rbenv?
+      yaml["rbenv"].present?
+    end
+
+    def pre_tab?
+      yaml["pre_tab"].present?
+    end
+
+    def cli_args?
+      yaml["cli_args"].present?
+    end
+  end
+end

data/lib/tmuxinator/pane.rb

@@ -0,0 +1,36 @@
+module Tmuxinator
+  class Pane
+    attr_reader :command, :project, :index, :project, :tab
+
+    def initialize(command, index, project, tab)
+      @command = command
+      @index = index
+      @project = project
+      @tab = tab
+    end
+
+    def tmux_window_and_pane_target
+      "#{project.name}:#{tab.index + project.base_index}.#{index + project.base_index}"
+    end
+
+    def tmux_pre_command
+      tab.pre.present? ? "#{project.tmux} send-keys -t #{tmux_window_and_pane_target} #{tab.pre.shellescape} C-m" : ""
+    end
+
+    def tmux_pre_window_command
+      project.pre_window.present? ? "#{project.tmux} send-keys -t #{tmux_window_and_pane_target} #{project.pre_window.shellescape} C-m" : ""
+    end
+
+    def tmux_main_command
+      command.present? ? "#{project.tmux} send-keys -t #{project.name}:#{tab.index + project.base_index}.#{index + tab.project.base_index} #{command.shellescape} C-m" : ""
+    end
+
+    def tmux_split_command
+      "#{project.tmux} splitw -t #{tab.tmux_window_target}"
+    end
+
+    def last?
+      index == tab.panes.length - 1
+    end
+  end
+end

data/lib/tmuxinator/project.rb

@@ -0,0 +1,142 @@
+module Tmuxinator
+  class Project
+    include Tmuxinator::Util
+    include Tmuxinator::Deprecations
+
+    attr_reader :yaml
+
+    def initialize(yaml)
+      @yaml = yaml
+    end
+
+    def render
+      template = File.read(Tmuxinator::Config.template)
+      Erubis::Eruby.new(template).result(binding)
+    end
+
+    def windows
+      windows_yml =
+        if yaml["tabs"].present?
+          yaml["tabs"]
+        else
+          yaml["windows"]
+        end
+
+      @windows ||= windows_yml.map.with_index do |window_yml, index|
+        Tmuxinator::Window.new(window_yml, index, self)
+      end
+    end
+
+    def root
+      if yaml["project_root"].present?
+        yaml["project_root"]
+      else
+        yaml["root"]
+      end
+    end
+
+    def name
+      if yaml["project_name"].present?
+        yaml["project_name"].shellescape
+      else
+        yaml["name"].shellescape
+      end
+    end
+
+    def pre
+      yaml["pre"]
+    end
+
+    def pre_window
+      if rbenv?
+        "rbenv shell #{yaml["rbenv"]}"
+      elsif rvm?
+        "rvm use #{yaml["rvm"]}"
+      elsif pre_tab?
+        yaml["pre_tab"]
+      else
+        yaml["pre_window"]
+      end
+    end
+
+    def tmux
+      "tmux#{tmux_options}#{socket}"
+    end
+
+    def socket
+      if socket_path.present?
+        " -S #{socket_path}"
+      elsif socket_name.present?
+        " -L #{socket_name}"
+      else
+        nil
+      end
+    end
+
+    def socket_name
+      yaml["socket_name"]
+    end
+
+    def socket_path
+      yaml["socket_path"]
+    end
+
+    def tmux_options
+      if cli_args?
+        " #{yaml["cli_args"].strip}"
+      elsif tmux_options?
+        " #{yaml["tmux_options"].strip}"
+      else
+        ""
+      end
+    end
+
+    def base_index
+      `tmux start-server\\\; show-window-options -g | grep pane-base-index`.split(/\s/).last.to_i
+    end
+
+    def tmux_options?
+      yaml["tmux_options"].present?
+    end
+
+    def windows?
+      windows.any?
+    end
+
+    def root?
+      root.present?
+    end
+
+    def name?
+      name.present?
+    end
+
+    def window(i)
+      "#{name}:#{i}"
+    end
+
+    def send_pane_command(cmd, window_index, pane_index)
+      if cmd.blank?
+        ""
+      else
+        "#{tmux} send-keys -t #{window(window_index)} #{cmd.shellescape} C-m"
+      end
+    end
+
+    def send_keys(cmd, window_index)
+      if cmd.blank?
+       ""
+      else
+        "#{tmux} send-keys -t #{window(window_index)} #{cmd.shellescape} C-m"
+      end
+    end
+
+    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 window option and will not be supported in 0.8.0." if yaml["tabs"].present?
+      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"].present?
+      deprecations
+    end
+  end
+end

data/lib/tmuxinator/util.rb

@@ -0,0 +1,14 @@
+module Tmuxinator
+  module Util
+    include Thor::Actions
+
+    def exit!(msg)
+      puts msg
+      Kernel.exit(1)
+    end
+
+    def yes_no(condition)
+      condition ? say("Yes", :green) : say("No", :red)
+    end
+  end
+end

data/lib/tmuxinator/version.rb

@@ -0,0 +1,3 @@
+module Tmuxinator
+  VERSION = "0.6.0"
+end

data/lib/tmuxinator/window.rb

@@ -0,0 +1,76 @@
+module Tmuxinator
+  class Window
+    attr_reader :name, :panes, :layout, :command, :index, :project
+
+    def initialize(window_yaml, index, project)
+      @name = window_yaml.keys.first.present? ? window_yaml.keys.first.shellescape : nil
+      @panes = []
+      @layout = nil
+      @pre = nil
+      @command = nil
+      @project = project
+      @index = index
+
+      value = window_yaml.values.first
+
+      if value.is_a?(Hash)
+        @layout = value["layout"].present? ? value["layout"].shellescape : nil
+        @pre = value["pre"] if value["pre"].present?
+
+        @panes = build_panes(value["panes"])
+      else
+        @command = value
+      end
+    end
+
+    def build_panes(pane_yml)
+      if pane_yml.is_a?(Array)
+        pane_yml.map.with_index do |pane_cmd, index|
+          Tmuxinator::Pane.new(pane_cmd, index, project, self)
+        end
+      else
+        Tmuxinator::Pane.new(pane_yml, index, project, self)
+      end
+    end
+
+    def pre
+      if @pre.present?
+        if @pre.is_a?(Array)
+          @pre.join(" && ")
+        elsif @pre.is_a?(String)
+          @pre
+        end
+      else
+        ""
+      end
+    end
+
+    def panes?
+      panes.any?
+    end
+
+    def tmux_window_target
+      "#{project.name}:#{index + project.base_index}"
+    end
+
+    def tmux_pre_window_command
+      project.pre_window.present? ? "#{project.tmux} send-keys -t #{tmux_window_target} #{project.pre_window.shellescape} C-m" : ""
+    end
+
+    def tmux_main_command
+      command.present? ? "#{project.tmux} send-keys -t #{project.name}:#{index + project.base_index} #{command.shellescape} C-m" : ""
+    end
+
+    def tmux_new_window_command
+      "#{project.tmux} new-window -t #{tmux_window_target} -n #{name}"
+    end
+
+    def tmux_layout_command
+      "#{project.tmux} select-layout -t #{tmux_window_target} #{layout}"
+    end
+
+    def tmux_select_first_pane
+      "#{project.tmux} select-pane -t #{tmux_window_target}.#{panes.first.index + project.base_index}"
+    end
+  end
+end

data/spec/factories/projects.rb

@@ -0,0 +1,17 @@
+FactoryGirl.define do
+  factory :project, :class => Tmuxinator::Project do
+    ignore do
+      file { YAML.load(File.read("#{File.expand_path("spec/fixtures/sample.yml")}")) }
+    end
+
+    initialize_with { Tmuxinator::Project.new(file) }
+  end
+
+  factory :project_with_deprecations, :class => Tmuxinator::Project do
+    ignore do
+      file { YAML.load(File.read("#{File.expand_path("spec/fixtures/sample.deprecations.yml")}")) }
+    end
+
+    initialize_with { Tmuxinator::Project.new(file) }
+  end
+end

data/spec/fixtures/sample.deprecations.yml

@@ -0,0 +1,35 @@
+# ~/.tmuxinator/sample.deprecations.yml
+# you can make as many tabs as you wish...
+
+project_name: sample
+project_root: ~/test
+socket_name: foo # Remove to use default socket
+pre: sudo /etc/rc.d/mysqld start # Runs before everything
+rbenv: 2.0.0-p247
+cli_args: -v -2 # Pass arguments to tmux
+tabs:
+  - 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
+  - shell: git pull
+  - 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