From 7e2702164e28576dfa64c0c9bbc83dc7dcb30ba7 Mon Sep 17 00:00:00 2001

From: Martin Babinsky <mbabinsk@redhat.com>

Date: Thu, 22 Jun 2017 15:00:00 +0200

Subject: [PATCH] advise: add an infrastructure for formatting Bash compound

 statements

A series of context managers simplify formatting of common compound

statements such as `if`, `else if`, `else` blocks.

https://pagure.io/freeipa/issue/7036

Reviewed-By: Florence Blanc-Renaud <frenaud@redhat.com>

Reviewed-By: Alexander Bokovoy <abokovoy@redhat.com>

---

 ipaserver/advise/base.py | 73 ++++++++++++++++++++++++++++++++++++++++++++++++

 1 file changed, 73 insertions(+)

diff --git a/ipaserver/advise/base.py b/ipaserver/advise/base.py

index c320b002c83198cbb0fd73a5c158df07dd309242..940d87ed4c1804326a46e2866381364e6f4f3f3e 100644

--- a/ipaserver/advise/base.py

+++ b/ipaserver/advise/base.py

@@ -128,6 +128,79 @@ class _IndentationTracker(object):

         self._recompute_indentation_level()

+class CompoundStatement(object):

+    """

+    Wrapper around indented blocks of Bash statements.

+

+    Override `begin_statement` and `end_statement` methods to issue

+    opening/closing commands using the passed in _AdviceOutput instance

+    """

+

+    def __init__(self, advice_output):

+        self.advice_output = advice_output

+

+    def __enter__(self):

+        self.begin_statement()

+        self.advice_output.indent()

+

+    def begin_statement(self):

+        pass

+

+    def __exit__(self, exc_type, exc_value, traceback):

+        self.advice_output.dedent()

+        self.end_statement()

+

+    def end_statement(self):

+        pass

+

+

+class IfBranch(CompoundStatement):

+    """

+    Base wrapper around `if` branch. The closing statement is empty so it

+    leaves trailing block that can be closed off or continued by else branches

+    """

+    def __init__(self, advice_output, conditional):

+        super(IfBranch, self).__init__(advice_output)

+        self.conditional = conditional

+

+    def begin_statement(self):

+        self.advice_output.command('if {}'.format(self.conditional))

+        self.advice_output.command('then')

+

+

+class ElseIfBranch(CompoundStatement):

+    """

+    Wrapper for `else if <CONDITIONAL>`

+    """

+    def __init__(self, advice_output, alternative_conditional):

+        super(ElseIfBranch, self).__init__(advice_output)

+        self.alternative_conditional = alternative_conditional

+

+    def begin_statement(self):

+        command = 'else if {}'.format(self.alternative_conditional)

+

+        self.advice_output.command(command)

+

+

+class ElseBranch(CompoundStatement):

+    """

+    Wrapper for final `else` block

+    """

+    def begin_statement(self):

+        self.advice_output.command('else')

+

+    def end_statement(self):

+        self.advice_output.command('fi')

+

+

+class UnbranchedIfStatement(IfBranch):

+    """

+    Plain `if` without branches

+    """

+    def end_statement(self):

+        self.advice_output.command('fi')

+

+

 class _AdviceOutput(object):

     def __init__(self):

-- 

2.9.4