tmux-ruby 0.0.2

data/lib/tmux/exception/index_in_use.rb

@@ -0,0 +1,9 @@
+module Tmux
+  module Exception
+    class IndexInUse < RuntimeError
+      def initialize(args)
+        super "Index '%s' in session '%s' in use" % [args.last, args.first.identifier]
+      end
+    end
+  end
+end

data/lib/tmux/exception/unknown_command.rb

@@ -0,0 +1,9 @@
+module Tmux
+  module Exception
+    class UnknownCommand < RuntimeError
+      def initialize(command)
+        super("unknown command: #{command}")
+      end
+    end
+  end
+end

data/lib/tmux/exception/unsupported_version.rb

@@ -0,0 +1,15 @@
+module Tmux
+  module Exception
+    # Raised if a version requirement isn't met
+    class UnsupportedVersion < BasicException
+      # @param [String] version The required version
+      def initialize(version = nil)
+        if message
+          version = "Required tmux version: #{version}"
+        end
+
+        super
+      end
+    end
+  end
+end

data/lib/tmux/filterable_hash.rb

@@ -0,0 +1,15 @@
+module Tmux
+  # @api private
+  module FilterableHash
+    # @param [Hash] search
+    # @return [Hash]
+    # @api private
+    def filter(search)
+      self.select { |key, value|
+        value.all? { |v_key, v_value|
+          !search.has_key?(v_key) || v_value == search[v_key]
+        }
+      }
+    end
+  end
+end

data/lib/tmux/options.rb

@@ -0,0 +1,109 @@
+module Tmux
+
+  module Options
+    require "tmux/options/option"
+    require "tmux/options/number_option"
+    require "tmux/options/string_option"
+    require "tmux/options/boolean_option"
+    require "tmux/options/word_array_option"
+    require "tmux/options/char_array_option"
+    require "tmux/options/symbol_option"
+    require "tmux/options/bell_action_option"
+    require "tmux/options/color_option"
+    require "tmux/options/attr_option"
+    require "tmux/options/keymap_option"
+    require "tmux/options/justification_option"
+    require "tmux/options/clock_mode_style_option"
+
+    # Table with option names and their appropriate typecasts.
+    Mapping = {
+      "base-index" => NumberOption,
+      "bell-action" => BellActionOption,
+      "buffer-limit" => NumberOption,
+      "default-command" => StringOption,
+      "default-path" => StringOption,
+      "default-shell" => StringOption,
+      "default-terminal" => StringOption,
+      "detach-on-destroy" => BooleanOption,
+      "display-panes-colour" => ColorOption,
+      "display-panes-active-colour" => ColorOption,
+      "display-panes-time" => NumberOption,
+      "display-time" => NumberOption,
+      "history-limit" => NumberOption,
+      "lock-after-time" => NumberOption,
+      "lock-command" => StringOption,
+      "lock-server" => BooleanOption,
+      "message-attr" => AttrOption,
+      "message-bg" => ColorOption,
+      "message-fg" => ColorOption,
+      "message-limit" => NumberOption,
+      "mouse-select-pane" => BooleanOption,
+      "pane-active-border-bg" => ColorOption,
+      "pane-active-border-fg" => ColorOption,
+      "pane-border-bg" => ColorOption,
+      "pane-border-fg" => ColorOption,
+      "prefix" => SymbolOption, #  C-b # TODO keycombo
+      "repeat-time" => NumberOption,
+      "set-remain-on-exit" => BooleanOption,
+      "set-titles" => BooleanOption,
+      "set-titles-string" => StringOption,
+      "status" => BooleanOption,
+      "status-attr" => AttrOption,
+      "status-bg" => ColorOption,
+      "status-fg" => ColorOption,
+      "status-interval" => NumberOption,
+      "status-justify" => JustificationOption,
+      "status-keys" => KeymapOption,
+      "status-left" => StringOption,
+      "status-left-attr" => AttrOption,
+      "status-left-bg" => ColorOption,
+      "status-left-fg" => ColorOption,
+      "status-left-length" => NumberOption,
+      "status-right" => StringOption,
+      "status-right-attr" => AttrOption,
+      "status-right-bg" => ColorOption,
+      "status-right-fg" => ColorOption,
+      "status-right-length" => NumberOption,
+      "status-utf8" => BooleanOption,
+      "terminal-overrides" => StringOption, #TODO "*88col*:colors=88,*256col*:colors=256"
+      "update-environment" => WordArrayOption,
+      "visual-activity" => BooleanOption,
+      "visual-bell" => BooleanOption,
+      "visual-content" => BooleanOption,
+      "escape-time" => NumberOption,
+      "quiet" => BooleanOption,
+      "aggressive-resize" => BooleanOption,
+      "alternate-screen" => BooleanOption,
+      "automatic-rename" => BooleanOption,
+      "clock-mode-colour" => ColorOption,
+      "clock-mode-style" => ClockModeStyleOption,
+      "force-height" => NumberOption,
+      "force-width" => NumberOption,
+      "main-pane-height" => NumberOption,
+      "main-pane-width" => NumberOption,
+      "mode-attr" => AttrOption,
+      "mode-bg" => ColorOption,
+      "mode-fg" => ColorOption,
+      "mode-keys" => KeymapOption,
+      "mode-mouse" => BooleanOption,
+      "monitor-activity" => BooleanOption,
+      "monitor-content" => StringOption,
+      "remain-on-exit" => BooleanOption,
+      "synchronize-panes" => BooleanOption,
+      "utf8" => BooleanOption,
+      "window-status-alert-attr" => AttrOption,
+      "window-status-alert-bg" => ColorOption,
+      "window-status-alert-fg" => ColorOption,
+      "window-status-attr" => AttrOption,
+      "window-status-bg" => ColorOption,
+      "window-status-current-attr" => AttrOption,
+      "window-status-current-bg" => ColorOption,
+      "window-status-current-fg" => ColorOption,
+      "window-status-current-format" => StringOption,
+      "window-status-fg" => ColorOption,
+      "window-status-format" => StringOption,
+      "word-separators" => CharArrayOption,
+      "xterm-keys" => BooleanOption,
+    }
+  end
+end

data/lib/tmux/options/attr_option.rb

@@ -0,0 +1,10 @@
+require "tmux/options/symbol_option"
+module Tmux
+  module Options
+    # @todo maintain list of valid attributes
+    # @api private
+    # @see Option
+    class AttrOption < SymbolOption
+    end
+  end
+end

data/lib/tmux/options/bell_action_option.rb

@@ -0,0 +1,19 @@
+require "tmux/options/symbol_option"
+module Tmux
+  module Options
+    # @api private
+    # @see Option
+    class BellActionOption < SymbolOption
+      class << self
+        # @param (see Option.to_tmux)
+        # @return (see Option.to_tmux)
+        # @see Option.to_tmux
+        # @api private
+        def to_tmux(value)
+          raise ArgumentError unless [:any, :none, :current, :default].include?(value)
+          super
+        end
+      end
+    end
+  end
+end

data/lib/tmux/options/boolean_option.rb

@@ -0,0 +1,26 @@
+require "tmux/options/option"
+module Tmux
+  module Options
+    # @api private
+    # @see Option
+    class BooleanOption < Option
+      class << self
+        # @param (see Option.from_tmux)
+        # @return [Boolean]
+        # @api private
+        # @see Option.from_tmux
+        def from_tmux(value)
+          super || value == "on"
+        end
+
+        # @param (see Option.to_tmux)
+        # @return (see Option.to_tmux)
+        # @see Option.to_tmux
+        # @api private
+        def to_tmux(value)
+          super || value ? "on" : "off"
+        end
+      end
+    end
+  end
+end

data/lib/tmux/options/char_array_option.rb

@@ -0,0 +1,26 @@
+require "tmux/options/option"
+module Tmux
+  module Options
+    # @api private
+    # @see Option
+    class CharArrayOption < Option
+      class << self
+        # @param (see Option.from_tmux)
+        # @return [Array<String>, Symbol]
+        # @api private
+        # @see Option.from_tmux
+        def from_tmux(value)
+          super || StringOption.from_tmux(value).split("")
+        end
+
+        # @param (see Option.to_tmux)
+        # @return (see Option.to_tmux)
+        # @see Option.to_tmux
+        # @api private
+        def to_tmux(value)
+          super || value.join("")
+        end
+      end
+    end
+  end
+end

data/lib/tmux/options/clock_mode_style_option.rb

@@ -0,0 +1,27 @@
+require "tmux/options/symbol_option"
+module Tmux
+  module Options
+    # @api private
+    # @see Option
+    class ClockModeStyleOption < SymbolOption
+      class << self
+        # @param (see Option.from_tmux)
+        # @return [Symbol]
+        # @api private
+        # @see Option.from_tmux
+        def from_tmux(value)
+          super || {12 => :twelve, 24 => :twenty_four}[value]
+        end
+
+        # @param [Symbol<:twelve, :twenty_four>] value
+        # @return (see Option.to_tmux)
+        # @see Option.to_tmux
+        # @api private
+        def to_tmux(value)
+          raise ArgumentError unless [:twelve, :twenty_four].include?(value)
+          super
+        end
+      end
+    end
+  end
+end

data/lib/tmux/options/color_option.rb

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+require "tmux/options/symbol_option"
+module Tmux
+  module Options
+    # @api private
+    # @see Option
+    class ColorOption < SymbolOption
+      class << self
+        # @param [Symbol<:black, :red, :green, :yellow, :blue, :magenta, :cyan, :white, :colour0 – colour255, :default>] value
+        # @return (see Option.to_tmux)
+        # @see Option.to_tmux
+        # @api private
+        def to_tmux(value)
+          if ![:black, :red, :green, :yellow, :blue, :magenta, :cyan, :white, :default].include?(value) &&
+              value !~ /^colour\d+$/
+            raise ArgumentError
+          end
+          super
+        end
+      end
+    end
+  end
+end

data/lib/tmux/options/justification_option.rb

@@ -0,0 +1,19 @@
+require "tmux/options/symbol_option"
+module Tmux
+  module Options
+    # @api private
+    # @see Option
+    class JustificationOption < SymbolOption
+      class << self
+        # @param [Symbol<:left, :right, :centre, :default>] value
+        # @return (see Option.to_tmux)
+        # @see Option.to_tmux
+        # @api private
+        def to_tmux(value)
+          raise ArgumentError unless [:left, :right, :centre, :default].include?(value)
+          super
+        end
+      end
+    end
+  end
+end

data/lib/tmux/options/keymap_option.rb

@@ -0,0 +1,19 @@
+require "tmux/options/symbol_option"
+module Tmux
+  module Options
+    # @api private
+    # @see Option
+    class KeymapOption < SymbolOption
+      class << self
+        # @param [Symbol<:emacs, :vi, :default>] value
+        # @return (see Option.to_tmux)
+        # @see Option.to_tmux
+        # @api private
+        def to_tmux(value)
+          raise ArgumentError unless [:emacs, :vi, :default].include?(value)
+          super
+        end
+      end
+    end
+  end
+end

data/lib/tmux/options/number_option.rb

@@ -0,0 +1,26 @@
+require "tmux/options/option"
+module Tmux
+  module Options
+    # @api private
+    # @see Option
+    class NumberOption < Option
+      class << self
+        # @param (see Option.from_tmux)
+        # @return [Number, Symbol]
+        # @api private
+        # @see Option.from_tmux
+        def from_tmux(value)
+          super || value.to_i
+        end
+
+        # @param (see Option.to_tmux)
+        # @return (see Option.to_tmux)
+        # @see Option.to_tmux
+        # @api private
+        def to_tmux(value)
+          super || value.to_s
+        end
+      end
+    end
+  end
+end

data/lib/tmux/options/option.rb

@@ -0,0 +1,38 @@
+module Tmux
+  module Options
+    # This class is the base for all typecasting in ruby-tmux. It will
+    # handle `default` and `none`. All other conversions have to be
+    # done by classes inheriting from this one. You should never have
+    # to instantiate or work with any of those classes yourself.
+    #
+    # @api private
+    # @abstract
+    class Option
+      class << self
+        # Takes an option value from tmux and converts it to an appropriate Ruby object.
+        #
+        # @param [String] value the value to cast
+        # @return [Object, Symbol] Either the specific Ruby object, or either `:default` or `:none`
+        # @api private
+        # @see Subclasses
+        def from_tmux(value)
+          if [:default, :none].include?(value)
+            return value.to_sym
+          end
+        end
+
+        # Converts a Ruby object to a value for tmux.
+        #
+        # @param [Object] value the value to cast
+        # @return [String]
+        # @api private
+        # @see Subclasses
+        def to_tmux(value)
+          if [:default, :none].include?(value)
+            return value.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tmux/options/string_option.rb

@@ -0,0 +1,26 @@
+require "tmux/options/option"
+module Tmux
+  module Options
+    # @api private
+    # @see Option
+    class StringOption < Option
+      class << self
+        # @param (see Option.from_tmux)
+        # @return [String, Symbol]
+        # @api private
+        # @see Option.from_tmux
+        def from_tmux(value)
+          super || value.gsub(/^"|"$/, "")
+        end
+
+        # @param (see Option.to_tmux)
+        # @return (see Option.to_tmux)
+        # @see Option.to_tmux
+        # @api private
+        def to_tmux(value)
+          super || value.inspect.gsub(/^"|"$/, "")
+        end
+      end
+    end
+  end
+end

data/lib/tmux/options/symbol_option.rb

@@ -0,0 +1,26 @@
+require "tmux/options/option"
+module Tmux
+  module Options
+    # @api private
+    # @see Option
+    class SymbolOption < Option
+      class << self
+        # @param (see Option.from_tmux)
+        # @return [Symbol]
+        # @api private
+        # @see Option.from_tmux
+        def from_tmux(value)
+          super || value.to_sym
+        end
+
+        # @param (see Option.to_tmux)
+        # @return (see Option.to_tmux)
+        # @see Option.to_tmux
+        # @api private
+        def to_tmux(value)
+          super || value.to_s
+        end
+      end
+    end
+  end
+end