Add ability to specify session/global options

.travis.yml

@@ -14,6 +14,9 @@ env:
   - TMUX_VERSION=2.0
   - TMUX_VERSION=1.8
   - TMUX_VERSION=1.9a
+matrix:
+  allow_failures:
+  - env: TMUX_VERSION=master
 before_install:
   - export PIP_USE_MIRRORS=true
   - pip install --upgrade pytest  # https://github.com/travis-ci/travis-ci/issues/4873

CHANGES

@@ -4,6 +4,11 @@ Changelog
 
 Here you can find the recent changes to tmuxp
 
+- :feature:`65` Ability to specify ``options`` and ``global_options`` via
+  configuration. Also you can specify environment variables via that.
+
+  Include tests.
+
 - :release:`1.1.1 <2016-06-02>`
 - :bug:`167 backported` fix attaching multiple sessions
 - :bug:`165 backported` fix typo in error output, thanks @fpietka

doc/examples.rst

@@ -166,13 +166,15 @@ Environment variable replacing
 ------------------------------
 
 tmuxp will replace environment variables wrapped in curly brackets
-for the following variables:
+for values of these settings:
 
 - ``start_directory``
 - ``before_script``
 - ``session_name``
 - ``window_name``
 - ``shell_command_before``
+- ``global_options``
+- ``options`` in session scope and window scope
 
 tmuxp replaces these variables before-hand with variables in the
 terminal ``tmuxp`` invokes in.
@@ -278,19 +280,25 @@ JSON
 .. literalinclude:: ../examples/window-index.json
     :language: json
 
-Automatic Rename
+Set tmux options
 ----------------
 
+Works with global (server-wide) options, session options
+and window options.
+
+Including ``automatic-rename``, ``default-shell``,
+``default-command``, etc.
+
 YAML
 ~~~~
 
-.. literalinclude:: ../examples/automatic-rename.yaml
+.. literalinclude:: ../examples/options.yaml
     :language: yaml
 
 JSON
 ~~~~
 
-.. literalinclude:: ../examples/automatic-rename.json
+.. literalinclude:: ../examples/options.json
     :language: json
 
 Main pane height

examples/env-variables.json

@@ -1,5 +1,5 @@
 {
-  "before_script": "${MY_ENV_VAR}/test3.sh",
+  "before_script": "${MY_ENV_VAR}/test3.sh", 
   "windows": [
     {
       "panes": [
@@ -8,24 +8,26 @@
             "tail -F /var/log/syslog"
           ]
         }
-      ],
-      "start_directory": "/var/log",
+      ], 
+      "start_directory": "/var/log", 
       "window_name": "editor"
-    },
+    }, 
     {
       "panes": [
         {
           "shell_command": [
-            "htop",
+            "htop", 
             "ls $PWD"
           ]
         }
       ], 
-      "window_name": "logging for {USER}",
-      "automatic_rename": true
+      "window_name": "logging for ${USER}", 
+      "options": {
+        "automatic-rename": true
+      }
     }
-  ],
-  "shell_command_before": "echo ${PWD}",
-  "start_directory": "${PWD}/test",
+  ], 
+  "shell_command_before": "echo ${PWD}", 
+  "start_directory": "${PWD}/test", 
   "session_name": "session - ${USER} (${MY_ENV_VAR})"
-}
+}

examples/env-variables.yaml

@@ -9,7 +9,8 @@ windows:
     - tail -F /var/log/syslog
   start_directory: /var/log
 - window_name: logging for ${USER}
-  automatic_rename: true
+  options:
+    automatic-rename: true
   panes:
   - shell_command:
     - htop

examples/automatic-rename.json → examples/options.json

@@ -26,5 +26,12 @@
     }
   ], 
   "session_name": "test window options", 
-  "start_directory": "~"
+  "start_directory": "~", 
+  "global_options": {
+    "default-shell": "/bin/sh", 
+    "default-command": "/bin/sh"
+  }, 
+  "options": {
+    "main-pane-height": "${MAIN_PANE_HEIGHT}"
+  }
 }

examples/automatic-rename.yaml → examples/options.yaml

@@ -1,5 +1,10 @@
 session_name: test window options
 start_directory: '~'
+global_options:
+  default-shell: /bin/sh
+  default-command: /bin/sh
+options:
+  main-pane-height: ${MAIN_PANE_HEIGHT}  # works with en variables
 windows:
 - layout: main-horizontal
   options:

requirements/base.txt

@@ -1,4 +1,4 @@
 kaptan>=0.5.7
-libtmux==0.4.1
+libtmux==0.5
 click==6.6
 colorama

tests/fixtures/config/expand1.py

@@ -32,7 +32,7 @@
         },
         {
             'start_directory': '/var/log',
-            'options': {'automatic_rename': True, },
+            'options': {'automatic-rename': True, },
             'panes': [
                 {
                     'shell_command': 'htop'
@@ -95,7 +95,7 @@
         },
         {
             'start_directory': '/var/log',
-            'options': {'automatic_rename': True},
+            'options': {'automatic-rename': True},
             'panes': [
                 {'shell_command': ['htop']},
                 {'shell_command': ['vim']}

tests/fixtures/config/shell_command_before.py

@@ -40,7 +40,7 @@
             ]
         },
         {
-            'options': {'automatic_rename': True, },
+            'options': {'automatic-rename': True, },
             'panes': [
                 {'shell_command': ['htop']}
             ]
@@ -92,7 +92,7 @@
             ]
         },
         {
-            'options': {'automatic_rename': True, },
+            'options': {'automatic-rename': True, },
             'panes': [
                 {'shell_command': ['htop']}
             ]
@@ -155,7 +155,7 @@
         },
         {
             'start_directory': '/',
-            'options': {'automatic_rename': True, },
+            'options': {'automatic-rename': True, },
             'panes': [
                 {
                     'shell_command': ['htop']

tests/fixtures/workspacebuilder/env_var_options.yaml

@@ -0,0 +1,13 @@
+session_name: test env vars for options
+start_directory: '~'
+global_options:
+  visual-silence: ${VISUAL_SILENCE}
+options:
+  repeat-time: 738
+windows:
+- window_name: moo
+  layout: main-horizontal
+  options:
+    main-pane-height: ${MAIN_PANE_HEIGHT}
+  panes:
+  - pane

tests/fixtures/workspacebuilder/global_options.yaml

@@ -0,0 +1,12 @@
+session_name: test global options
+start_directory: '~'
+global_options:
+  repeat-time: 493
+  status-position: 'top'
+windows:
+- layout: main-horizontal
+  panes:
+  - pane
+  - pane
+  - pane
+  window_name: moo

tests/fixtures/workspacebuilder/pane_ordering.yaml

@@ -2,7 +2,7 @@ session_name: sampleconfig
 start_directory: {HOME}
 windows:
 - options:
-  - automatic_rename: on
+    automatic-rename: on
   layout: tiled
   panes:
   - cd /usr/bin

tests/fixtures/workspacebuilder/session_options.yaml

@@ -0,0 +1,12 @@
+session_name: test session options
+start_directory: '~'
+options:
+  default-shell: /bin/sh
+  default-command: /bin/sh
+windows:
+- layout: main-horizontal
+  panes:
+  - pane
+  - pane
+  - pane
+  window_name: moo

tests/test_config.py

@@ -9,7 +9,6 @@
 import kaptan
 import pytest
 
-from libtmux.test import EnvironmentVarGuard
 from tmuxp import config, exc
 
 from . import example_dir
@@ -129,7 +128,7 @@ def test_config_expand2():
             ]
         },
         {
-            'options': {'automatic_rename': True, },
+            'options': {'automatic-rename': True, },
             'panes': [
                 {'shell_command': ['htop']}
             ]
@@ -158,7 +157,7 @@ def test_config_expand2():
         },
         {
             'options': {
-                'automatic_rename': True,
+                'automatic-rename': True,
             },
             'panes': [
                 'htop'
@@ -213,7 +212,7 @@ def test_inline_config():
         },
         {
             'options': {
-                'automatic_rename': True,
+                'automatic-rename': True,
             },
             'panes': [
                 {
@@ -257,7 +256,7 @@ def test_inline_config():
             ]
         },
         {
-            'options': {'automatic_rename': True, },
+            'options': {'automatic-rename': True, },
             'panes': [
                 {
                     'shell_command': ['htop'],
@@ -363,7 +362,7 @@ def test_no_session_name():
       - tail -F /var/log/syslog
       start_directory: /var/log
     - window_name: logging
-      automatic_rename: true
+      automatic-rename: true
       panes:
       - shell_command:
       - htop
@@ -399,7 +398,7 @@ def test_no_window_name():
       shell_command:
       - tail -F /var/log/syslog
       start_directory: /var/log
-    - automatic_rename: true
+    - automatic-rename: true
       panes:
       - shell_command:
       - htop
@@ -413,22 +412,26 @@ def test_no_window_name():
         assert excinfo.matches('missing "window_name"')
 
 
-def test_replaces_start_directory():
+def test_replaces_env_variables(monkeypatch):
     env_key = "TESTHEY92"
-    env_value = "HEYO1"
+    env_val = "HEYO1"
     yaml_config = """
     start_directory: {TEST_VAR}/test
     shell_command_before: {TEST_VAR}/test2
     before_script: {TEST_VAR}/test3
     session_name: hi - {TEST_VAR}
+    options:
+        default-command: {TEST_VAR}/lol
+    global_options:
+        default-shell: {TEST_VAR}/moo
     windows:
     - window_name: editor
       panes:
       - shell_command:
       - tail -F /var/log/syslog
       start_directory: /var/log
     - window_name: logging @ {TEST_VAR}
-      automatic_rename: true
+      automatic-rename: true
       panes:
       - shell_command:
       - htop
@@ -438,12 +441,12 @@ def test_replaces_start_directory():
 
     sconfig = load_yaml(yaml_config)
 
-    with EnvironmentVarGuard() as env:
-        env.set(env_key, env_value)
-        sconfig = config.expand(sconfig)
-        assert "%s/test" % env_value == sconfig['start_directory']
-        assert "%s/test2" % env_value in sconfig['shell_command_before']
-        assert "%s/test3" % env_value == sconfig['before_script']
-        assert "hi - %s" % env_value == sconfig['session_name']
-        assert "logging @ %s" % env_value == \
-            sconfig['windows'][1]['window_name']
+    monkeypatch.setenv(env_key, env_val)
+    sconfig = config.expand(sconfig)
+    assert "%s/test" % env_val == sconfig['start_directory']
+    assert "%s/test2" % env_val in sconfig['shell_command_before']
+    assert "%s/test3" % env_val == sconfig['before_script']
+    assert "hi - %s" % env_val == sconfig['session_name']
+    assert "%s/moo" % env_val == sconfig['global_options']['default-shell']
+    assert "%s/lol" % env_val == sconfig['options']['default-command']
+    assert "logging @ %s" % env_val == sconfig['windows'][1]['window_name']