teamocil 0.4.5 → 1.0

data/lib/teamocil/tmux/pane.rb

@@ -0,0 +1,15 @@
+module Teamocil
+  class Pane < ClosedStruct.new(:index, :root, :commands, :focus)
+    def as_tmux
+      [].tap do |tmux|
+        tmux << Command::SplitWindow.new(root: root) unless first?
+        tmux << Command::SendKeysToPane.new(index: index, keys: commands.join('; '))
+        tmux << Command::SendKeysToPane.new(index: index, keys: 'Enter')
+      end
+    end
+
+    def first?
+      index == 1
+    end
+  end
+end

data/lib/teamocil/tmux/session.rb

@@ -0,0 +1,28 @@
+module Teamocil
+  class Session < ClosedStruct.new(:name, :windows)
+    def initialize(object)
+      super
+
+      # Sessions need a name
+      self.name = "teamocil-session-#{rand(1_000_000)}" unless name
+
+      self.windows = windows.each_with_index.map do |window, index|
+        # Windows need to know their position
+        window.merge! index: index + 1
+
+        Window.new(window)
+      end
+    end
+
+    def as_tmux
+      [].tap do |tmux|
+        tmux << Command::RenameSession.new(name: name)
+        tmux << windows.map(&:as_tmux)
+
+        # Set the focus on the right window or do nothing
+        focused_window = windows.find(&:focus)
+        tmux << Command::SelectWindow.new(index: focused_window.index) if focused_window
+      end
+    end
+  end
+end

data/lib/teamocil/tmux/window.rb

@@ -0,0 +1,47 @@
+module Teamocil
+  class Window < ClosedStruct.new(:index, :root, :focus, :layout, :name, :panes)
+    def initialize(object)
+      super
+
+      self.panes ||= splits
+      self.panes = panes.each_with_index.map do |pane, index|
+        # Support single command instead of `commands` key in Hash
+        pane = { commands: [pane] } if pane.is_a?(String)
+
+        # Panes need to know their position
+        pane.merge! index: index + 1
+
+        # Panes need know the window root directory
+        pane.merge! root: root
+
+        Pane.new(pane)
+      end
+    end
+
+    def first?
+      index == 1
+    end
+
+    def as_tmux
+      [].tap do |tmux|
+        # Rename the current window or create a new one
+        if Teamocil.options[:here] && first?
+          tmux << Command::RenameWindow.new(name: name)
+        else
+          tmux << Command::NewWindow.new(name: name, root: root)
+        end
+
+        # Execute all panes commands
+        tmux << panes.map(&:as_tmux)
+
+        # Select the window layout
+        tmux << Command::SelectLayout.new(layout: layout)
+
+        # Set the focus on the right pane or the first one
+        focused_pane = panes.find(&:focus)
+        focused_index = focused_pane ? focused_pane.index : 0
+        tmux << Command::SelectPane.new(index: focused_index)
+      end
+    end
+  end
+end

data/lib/teamocil/utils/closed_struct.rb

@@ -0,0 +1,16 @@
+module Teamocil
+  class ClosedStruct < Struct
+    def initialize(*args)
+      args = [{}] unless args.any?
+
+      args.first.each_pair do |key, value|
+        # Make sure we only set values to defined arguments
+        if members.map { |x| x.intern }.include?(key.to_sym)
+          send "#{key}=", value
+        else
+          raise ArgumentError, "#{self.class.name} doesn’t support the `#{key}` keyword, only #{members.join(', ')}"
+        end
+      end
+    end
+  end
+end

data/lib/teamocil/utils/option_parser.rb

@@ -0,0 +1,56 @@
+module Teamocil
+  class OptionParser
+    def initialize(arguments:)
+      @arguments = arguments
+      @parsed_options = {}
+    end
+
+    def parsed_options
+      @parsed_options.tap do
+        parser.parse!(@arguments)
+      end
+    end
+
+    # rubocop:disable MethodLength
+    def parser
+      ::OptionParser.new do |parser|
+        parser.banner = 'Usage: teamocil [options] <layout>'
+        parser.separator ''
+        parser.separator 'Specific options:'
+
+        # Global options
+        parser.on('--list', 'List all available layouts in `~/.teamocil/`') do
+          @parsed_options[:list] = true
+        end
+
+        # Single layout options
+        parser.on('--here', 'Set up the first layout window in the current tmux window') do
+          @parsed_options[:here] = true
+        end
+
+        parser.on('--layout [layout]', 'Use a specific layout file, instead of `~/.teamocil/<layout>.yml`') do |layout|
+          @parsed_options[:layout] = layout
+        end
+
+        parser.on('--edit', 'Edit the YAML layout file instead of using it') do
+          @parsed_options[:edit] = true
+        end
+
+        parser.on('--show', 'Show the content of the layout file instead of executing it') do
+          @parsed_options[:show] = true
+        end
+
+        # Debug options
+        parser.on('--debug', 'Show the commands Teamocil will execute instead of actually executing them') do
+          @parsed_options[:debug] = true
+        end
+
+        parser.on('--version', '-v', 'Show Teamocil’s version number') do
+          Teamocil.puts(VERSION)
+          exit
+        end
+      end
+    end
+    # rubocop:enable all
+  end
+end

data/lib/teamocil/version.rb

@@ -1,3 +1,3 @@
 module Teamocil
-  VERSION = "0.4.5"
+  VERSION = '1.0'
 end

data/teamocil.gemspec

@@ -1,29 +1,28 @@
 # encoding: utf-8
 
-$:.push File.expand_path("../lib", __FILE__)
-require "teamocil/version"
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'teamocil/version'
 
-spec = Gem::Specification.new do |s|
+Gem::Specification.new do |s|
   # Metadata
-  s.name         = "teamocil"
+  s.name         = 'teamocil'
   s.version      = Teamocil::VERSION
   s.platform     = Gem::Platform::RUBY
-  s.authors      = "Rémi Prévost"
-  s.email        = "remi@exomel.com"
-  s.homepage     = "http://remiprev.github.com/teamocil"
-  s.license      = "MIT"
-  s.summary      = "Easy session, window and pane layouts for tmux"
-  s.description  = "Teamocil helps you set up window and pane layouts for tmux using YAML configuration files."
+  s.authors      = 'Rémi Prévost'
+  s.email        = 'remi@exomel.com'
+  s.homepage     = 'http://remiprev.github.com/teamocil'
+  s.license      = 'MIT'
+  s.summary      = 'Easy session, window and pane layouts for tmux'
+  s.description  = 'Teamocil helps you set up window and pane layouts for tmux using YAML configuration files.'
 
   # Manifest
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
 
   # Dependencies
-  s.add_development_dependency "rake"
-  s.add_development_dependency "rspec", '~> 2.13'
-  s.add_development_dependency "yard"
-  s.add_development_dependency "maruku"
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'phare', '~> 0.6'
+  s.add_development_dependency 'rubocop', '~> 0.24'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teamocil
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: '1.0'
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-18 00:00:00.000000000 Z
+date: 2014-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -25,47 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: phare
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.13'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.13'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: maruku
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.24'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.24'
 description: Teamocil helps you set up window and pane layouts for tmux using YAML
   configuration files.
 email: remi@exomel.com
@@ -75,34 +61,31 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
-- LICENSE
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/teamocil
-- examples/four-splits.yml
-- examples/one-and-three-splits.yml
-- examples/six-splits.yml
-- examples/two-horizontal-splits.yml
-- examples/two-vertical-splits.yml
 - lib/teamocil.rb
 - lib/teamocil/cli.rb
-- lib/teamocil/error.rb
+- lib/teamocil/command/new_window.rb
+- lib/teamocil/command/rename_session.rb
+- lib/teamocil/command/rename_window.rb
+- lib/teamocil/command/select_layout.rb
+- lib/teamocil/command/select_pane.rb
+- lib/teamocil/command/select_window.rb
+- lib/teamocil/command/send_keys.rb
+- lib/teamocil/command/send_keys_to_pane.rb
+- lib/teamocil/command/split_window.rb
 - lib/teamocil/layout.rb
-- lib/teamocil/layout/pane.rb
-- lib/teamocil/layout/session.rb
-- lib/teamocil/layout/window.rb
+- lib/teamocil/tmux/pane.rb
+- lib/teamocil/tmux/session.rb
+- lib/teamocil/tmux/window.rb
+- lib/teamocil/utils/closed_struct.rb
+- lib/teamocil/utils/option_parser.rb
 - lib/teamocil/version.rb
-- spec/cli_spec.rb
-- spec/fixtures/.my-fancy-layouts-directory/sample-3.yml
-- spec/fixtures/.teamocil/sample-2.yml
-- spec/fixtures/.teamocil/sample.yml
-- spec/fixtures/layouts.yml
-- spec/layout_spec.rb
-- spec/mock/cli.rb
-- spec/mock/layout.rb
-- spec/spec_helper.rb
 - teamocil.gemspec
 homepage: http://remiprev.github.com/teamocil
 licenses:
@@ -128,14 +111,4 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Easy session, window and pane layouts for tmux
-test_files:
-- spec/cli_spec.rb
-- spec/fixtures/.my-fancy-layouts-directory/sample-3.yml
-- spec/fixtures/.teamocil/sample-2.yml
-- spec/fixtures/.teamocil/sample.yml
-- spec/fixtures/layouts.yml
-- spec/layout_spec.rb
-- spec/mock/cli.rb
-- spec/mock/layout.rb
-- spec/spec_helper.rb
-has_rdoc: 
+test_files: []

data/examples/four-splits.yml

@@ -1,8 +0,0 @@
-windows:
-  - name: simple-four-panes
-    layout: tiled
-    panes:
-      - cmd: echo 'first pane'
-      - cmd: echo 'second pane'
-      - cmd: echo 'fourth pane'
-      - cmd: echo 'third pane'

data/examples/one-and-three-splits.yml

@@ -1,8 +0,0 @@
-windows:
-  - name: simple-one-and-three-panes
-    layout: main-vertical
-    panes:
-      - cmd: echo 'first pane'
-      - cmd: echo 'second pane'
-      - cmd: echo 'third pane'
-      - cmd: echo 'fourth pane'

data/examples/six-splits.yml

@@ -1,10 +0,0 @@
-windows:
-  - name: simple-six-panes
-    layout: tiled
-    panes:
-      - cmd: echo 'first pane'
-      - cmd: echo 'second pane'
-      - cmd: echo 'fourth pane'
-      - cmd: echo 'third pane'
-      - cmd: echo 'sixth pane'
-      - cmd: echo 'fifth pane'

data/examples/two-horizontal-splits.yml

@@ -1,6 +0,0 @@
-windows:
-  - name: simple-two-vertical-panes
-    layout: even-horizontal
-    panes:
-      - cmd: echo 'first pane'
-      - cmd: echo 'second pane'

data/examples/two-vertical-splits.yml

@@ -1,6 +0,0 @@
-windows:
-  - name: simple-two-horizontal-panes
-    layout: even-vertical
-    panes:
-      - cmd: echo 'first pane'
-      - cmd: echo 'second pane'

data/lib/teamocil/error.rb

@@ -1,6 +0,0 @@
-module Teamocil
-  module Error
-    class StandardError < ::StandardError; end
-    class LayoutError < StandardError; end
-  end
-end

data/lib/teamocil/layout/pane.rb

@@ -1,66 +0,0 @@
-module Teamocil
-  class Layout
-    # This class represents a pane within a tmux window
-    class Pane
-      attr_reader :width, :height, :cmd, :index, :target, :focus
-
-      # Initialize a new tmux pane
-      #
-      # @param session [Session] the window where the pane is initialized
-      # @param index [Fixnnum] the pane index
-      # @param attrs [Hash] the pane data from the layout file
-      def initialize(window, index, attrs={})
-        raise Teamocil::Error::LayoutError.new("You cannot have empty panes") if attrs.nil?
-        @height = attrs["height"]
-        @width = attrs["width"]
-        @cmd = attrs["cmd"]
-        @target = attrs["target"]
-        @focus = attrs["focus"] || false
-
-        @window = window
-        @index = index
-      end
-
-      # Generate commands to send to tmux
-      #
-      # @return [Array]
-      def generate_commands
-        commands = []
-
-        # Is it a vertical or horizontal pane
-        init_command = ""
-        unless @index == @window.pane_base_index
-          if !@width.nil?
-            init_command = "tmux split-window -h -p #{@width}"
-          elsif !@height.nil?
-            init_command = "tmux split-window -p #{@height}"
-          else
-            init_command = "tmux split-window"
-          end
-          init_command << " -t #{@target}" unless @target.nil?
-          commands << init_command
-        end
-
-        # Wrap all commands around filters
-        @cmd = [@window.filters["before"]] + [@window.clear] + [@cmd] + [@window.filters["after"]]
-
-        # If a `root` key exist, start each pane in this directory
-        @cmd.unshift "cd \"#{@window.root}\"" unless @window.root.nil?
-
-        # Set the TEAMOCIL environment variable
-        # depending on the shell set in ENV
-        if ENV['SHELL'].scan(/fish/).empty?
-          @cmd.unshift "export TEAMOCIL=1" if @window.with_env_var
-        else
-          @cmd.unshift "set -gx TEAMOCIL 1"
-        end
-
-        # Execute each pane command
-        commands << "tmux send-keys -t #{@index} \"#{@cmd.flatten.compact.join(@window.cmd_separator)}\""
-        commands << "tmux send-keys -t #{@index} Enter"
-
-        commands
-      end
-    end
-  end
-end