teamocil 0.4.5 → 1.0

data/Rakefile

@@ -1,28 +1,13 @@
-require "bundler"
-Bundler.require(:development)
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-task :default => :spec
-
-desc "Run all specs"
-RSpec::Core::RakeTask.new(:spec) do |task|
-  task.pattern = "spec/**/*_spec.rb"
-  task.rspec_opts = "--colour --format=documentation"
-end
-
-desc "Generate YARD Documentation"
-YARD::Rake::YardocTask.new do |task|
-  task.options = [
-    "-o", File.expand_path("../doc", __FILE__),
-    "--readme=README.md",
-    "--markup=markdown",
-    "--markup-provider=maruku",
-    "--no-private",
-    "--no-cache",
-    "--protected",
-    "--title=Teamocil",
-  ]
-  task.files   = ["lib/**/*.rb"]
+require 'bundler'
+require 'rake'
+require 'bundler/gem_tasks'
+
+desc 'Start an IRB session with the gem'
+task :console do
+  $LOAD_PATH.unshift File.expand_path('..', __FILE__)
+  require 'teamocil'
+  require 'irb'
+
+  ARGV.clear
+  IRB.start
 end

data/bin/teamocil

@@ -1,8 +1,7 @@
 #!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w(.. lib))
 
-$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
-
-require 'yaml'
 require 'teamocil'
 
-Teamocil::CLI.new(ARGV, ENV)
+runner = Teamocil::CLI.new(arguments: ARGV, environment: ENV)
+runner.run!

data/lib/teamocil.rb

@@ -1,7 +1,54 @@
-require "teamocil/version"
-require "teamocil/layout"
-require "teamocil/cli"
-require "teamocil/error"
+require 'yaml'
+require 'optparse'
+
+# Version
+require 'teamocil/version'
+
+# Utils
+require 'teamocil/utils/closed_struct'
+require 'teamocil/utils/option_parser'
+
+# Teamocil
+require 'teamocil/layout'
+require 'teamocil/cli'
+
+# Command classes
+require 'teamocil/command/new_window'
+require 'teamocil/command/rename_session'
+require 'teamocil/command/rename_window'
+require 'teamocil/command/select_layout'
+require 'teamocil/command/select_pane'
+require 'teamocil/command/select_window'
+require 'teamocil/command/send_keys'
+require 'teamocil/command/send_keys_to_pane'
+require 'teamocil/command/split_window'
+
+# Tmux classes
+require 'teamocil/tmux/session'
+require 'teamocil/tmux/window'
+require 'teamocil/tmux/pane'
 
 module Teamocil
+  class << self
+    attr_reader :options
+  end
+
+  def self.bail(*args)
+    print '[teamocil error] '
+    puts(*args)
+    exit
+  end
+
+  def self.puts(*args)
+    STDOUT.puts(*args)
+  end
+
+  def self.system(*args)
+    Kernel.system(*args)
+  end
+
+  def self.parse_options!(arguments:)
+    parser = OptionParser.new(arguments: arguments)
+    @options = parser.parsed_options
+  end
 end

data/lib/teamocil/cli.rb

@@ -1,105 +1,38 @@
-require 'optparse'
-require 'fileutils'
-require 'erb'
-
 module Teamocil
-  # This class handles interaction with the `tmux` utility.
-  class CLI
-    attr_accessor :layout, :layouts
-
-    # Initialize a new run of `tmux`
-    #
-    # @param argv [Hash] the command line parameters hash (usually `ARGV`).
-    # @param env [Hash] the environment variables hash (usually `ENV`).
-    def initialize(argv, env)
-      parse_options! argv
-      layout_path = env["TEAMOCIL_PATH"] || File.join("#{env["HOME"]}", ".teamocil")
+  class CLI < ClosedStruct.new(:arguments, :environment)
+    DIRECTORY = '$HOME/.teamocil'
 
-      if @options.include?(:list)
-        @layouts = get_layouts(layout_path)
-        return print_layouts
-      end
-
-      if @options[:layout].nil? && argv[0].nil?
-        bail "You must supply a layout for teamocil to use. See `teamocil --help` for more options."
-      end
+    def run!
+      Teamocil.parse_options!(arguments: arguments)
 
-      file = @options[:layout] || ::File.join(layout_path, "#{argv[0]}.yml")
+      # List available layouts
+      return Layout.print_available_layouts(directory: root) if Teamocil.options[:list]
 
-      if @options[:edit]
-        ::FileUtils.touch file unless File.exists?(file)
-        Kernel.system("${EDITOR:-vim} \"#{file}\"")
-      elsif @options[:show]
-        ::FileUtils.touch file unless File.exists?(file)
-        Kernel.system("cat \"#{file}\"")
-      else
-        bail "There is no file \"#{file}\"." unless File.exists?(file)
-        bail "You must be in a tmux session to use teamocil." unless env["TMUX"]
+      # Fetch the Layout object
+      layout = Layout.new(path: layout_file_path)
 
-        yaml = ERB.new(File.read(file)).result
+      # Open layout file in $EDITOR
+      return layout.edit! if Teamocil.options[:edit]
 
-        @layout = Teamocil::Layout.new(YAML.load(yaml), @options)
+      # Output the layout raw content
+      return layout.show! if Teamocil.options[:show]
 
-        begin
-          @layout.compile!
-        rescue Teamocil::Error::LayoutError => e
-          bail e.message
-        end
-        @layout.execute_commands(@layout.generate_commands)
-      end
+      # Nothing? Let’s execute this layout!
+      layout.execute!
     end
 
-    # Parse the command line options
-    def parse_options!(args)
-      @options = {}
-      opts = ::OptionParser.new do |opts|
-        opts.banner = "Usage: teamocil [options] <layout>
-
-      Options:
-        "
-        opts.on("--here", "Set up the first window in the current window") do
-          @options[:here] = true
-        end
-
-        opts.on("--edit", "Edit the YAML layout file instead of using it") do
-          @options[:edit] = true
-        end
-
-        opts.on("--layout [LAYOUT]", "Use a specific layout file, instead of `~/.teamocil/<layout>.yml`") do |layout|
-          @options[:layout] = layout
-        end
+  private
 
-        opts.on("--list", "List all available layouts in `~/.teamocil/`") do
-          @options[:list] = true
-        end
-
-        opts.on("--show", "Show the content of the layout file instead of executing it") do
-          @options[:show] = true
-        end
-
-      end
-      opts.parse! args
-    end
-
-    # Return an array of available layouts
-    #
-    # @param path [String] the path used to look for layouts
-    def get_layouts(path)
-      Dir.glob(File.join(path, "*.yml")).map { |file| File.basename(file).gsub(/\..+$/, "") }.sort
+    def root
+      DIRECTORY.sub('$HOME', environment['HOME'])
     end
 
-    # Print each layout on a single line
-    def print_layouts
-      STDOUT.puts @layouts.join("\n")
-      exit 0
-    end
-
-    # Print an error message and exit the utility
-    #
-    # @param msg [Mixed] something to print before exiting.
-    def bail(msg)
-      STDERR.puts "[teamocil] #{msg}"
-      exit 1
+    def layout_file_path
+      if layout = Teamocil.options[:layout]
+        layout
+      else
+        File.join(root, "#{arguments.first}.yml")
+      end
     end
   end
 end

data/lib/teamocil/command/new_window.rb

@@ -0,0 +1,16 @@
+module Teamocil
+  module Command
+    class NewWindow < ClosedStruct.new(:name, :root)
+      def to_s
+        "new-window #{options.join(' ')}"
+      end
+
+      def options
+        [].tap do |options|
+          options << "-n '#{name}'" if name
+          options << "-c '#{root}'" if root
+        end
+      end
+    end
+  end
+end

data/lib/teamocil/command/rename_session.rb

@@ -0,0 +1,9 @@
+module Teamocil
+  module Command
+    class RenameSession < ClosedStruct.new(:name)
+      def to_s
+        "rename-session '#{name}'"
+      end
+    end
+  end
+end

data/lib/teamocil/command/rename_window.rb

@@ -0,0 +1,9 @@
+module Teamocil
+  module Command
+    class RenameWindow < ClosedStruct.new(:name)
+      def to_s
+        "rename-window '#{name}'"
+      end
+    end
+  end
+end

data/lib/teamocil/command/select_layout.rb

@@ -0,0 +1,9 @@
+module Teamocil
+  module Command
+    class SelectLayout < ClosedStruct.new(:layout)
+      def to_s
+        "select-layout '#{layout}'"
+      end
+    end
+  end
+end

data/lib/teamocil/command/select_pane.rb

@@ -0,0 +1,9 @@
+module Teamocil
+  module Command
+    class SelectPane < ClosedStruct.new(:index)
+      def to_s
+        "select-pane -t #{index}"
+      end
+    end
+  end
+end

data/lib/teamocil/command/select_window.rb

@@ -0,0 +1,9 @@
+module Teamocil
+  module Command
+    class SelectWindow < ClosedStruct.new(:index)
+      def to_s
+        "select-window -t #{index}"
+      end
+    end
+  end
+end

data/lib/teamocil/command/send_keys.rb

@@ -0,0 +1,9 @@
+module Teamocil
+  module Command
+    class SendKeys < ClosedStruct.new(:keys)
+      def to_s
+        "send-keys '#{keys}'"
+      end
+    end
+  end
+end

data/lib/teamocil/command/send_keys_to_pane.rb

@@ -0,0 +1,9 @@
+module Teamocil
+  module Command
+    class SendKeysToPane < ClosedStruct.new(:index, :keys)
+      def to_s
+        "send-keys -t #{index} '#{keys}'"
+      end
+    end
+  end
+end

data/lib/teamocil/command/split_window.rb

@@ -0,0 +1,15 @@
+module Teamocil
+  module Command
+    class SplitWindow < ClosedStruct.new(:root)
+      def to_s
+        "split-window #{options.join(' ')}"
+      end
+
+      def options
+        [].tap do |options|
+          options << "-c '#{root}'" if root
+        end
+      end
+    end
+  end
+end

data/lib/teamocil/layout.rb

@@ -1,44 +1,66 @@
-require "teamocil/layout/session"
-require "teamocil/layout/window"
-require "teamocil/layout/pane"
-
 module Teamocil
-  # This class act as a wrapper around a tmux YAML layout file
-  class Layout
-    attr_reader :session
-
-    # Initialize a new layout from a hash
-    #
-    # @param layout [Hash] the parsed layout
-    # @param options [Hash] some options
-    def initialize(layout, options={})
-      @layout = layout
-      @options = options
-    end
-
-    # Generate tmux commands based on the data found in the layout file
-    #
-    # @return [Array] an array of shell commands to send
-    def generate_commands
-      @session.generate_commands
-    end
-
-    # Compile the layout into objects
-    #
-    # @return [Session]
-    def compile!
-      if @layout["session"].nil?
-        @session = Session.new @options, "windows" => @layout["windows"]
+  class Layout < ClosedStruct.new(:path, :options)
+    def execute!
+      if Teamocil.options[:debug]
+        Teamocil.puts(shell_commands.join("\n"))
+      else
+        Teamocil.system(shell_commands.join('; '))
+      end
+    end
+
+    def show!
+      Teamocil.puts(raw_content)
+    end
+
+    def edit!
+      Teamocil.system("$EDITOR #{path}")
+    end
+
+    def self.print_available_layouts(directory:)
+      files = Dir.glob(File.join(directory, '*.yml'))
+
+      files.map! do |file|
+        extname = File.extname(file)
+        File.basename(file).gsub(extname, '')
+      end
+
+      # Always return files in alphabetical order, even if `Dir.glob` almost
+      # always does it
+      files.sort!
+
+      Teamocil.puts(files)
+    end
+
+  private
+
+    def shell_commands
+      commands = parsed_layout.as_tmux
+      commands.flatten.map { |command| "tmux #{command}" }
+    end
+
+    def parsed_layout
+      begin
+        yaml_content = YAML.load(raw_content)
+      rescue
+        Teamocil.bail("There was a YAML error when parsing `#{path}`")
+      end
+
+      if valid?
+        Session.new(yaml_content)
       else
-        @session = Session.new @options, @layout["session"]
+        Teamocil.bail("The layout at `#{path}` is not valid.")
       end
     end
 
-    # Execute each command in the shell
-    #
-    # @param commands [Array] an array of complete commands to send to the shell
-    def execute_commands(commands)
-      `#{commands.join("; ")}`
+    def valid?
+      # TODO: Actually validate if the layout is valid
+      true
+    end
+
+    def raw_content
+      File.read(path)
+    rescue
+      Teamocil.bail("Cannot find a layout at `#{path}`")
     end
   end
 end