Merge branch 'master' of https://github.com/chubin/cheat.sh

Author: chubin

README.md

@@ -482,9 +482,9 @@ Features supported by cheat.sh plugins for different editors:
 |-------------------|-----|-------|---|------|----|
 |Command queries    |✓    |✓      |✓  |✓     |✓   |
 |Queries from buffer|     |       |✓  |✓     |    |
-|Toggle comments    |     |       |✓  |      |    |
-|Prev/next answer   |     |       |✓  |      |    |
-|Multiple answers   |     |✓      |   |      |    |
+|Toggle comments    |     |       |✓  |      |✓   |
+|Prev/next answer   |     |       |✓  |      |✓   |
+|Multiple answers   |     |✓      |   |      |✓   |
 |Warnings as queries|     |       |✓  |      |    |
 |Queries history    |     |       |✓  |✓     |    |
 |Session id         |     |       |✓  |      |    |

bin/srv.py

@@ -247,7 +247,11 @@ def answer(topic=None):
             return "429 %s\n" % not_allowed, 429
 
     html_is_needed = is_html_needed(user_agent) and not is_result_a_script(topic)
-    result, found = cheat_wrapper(topic, request_options=options, html=html_is_needed)
+    if html_is_needed:
+        output_format='html'
+    else:
+        output_format='ansi'
+    result, found = cheat_wrapper(topic, request_options=options, output_format=output_format)
     if 'Please come back in several hours' in result and html_is_needed:
         return MALFORMED_RESPONSE_HTML_PAGE
 

lib/adapter/adapter.py

@@ -1,19 +1,68 @@
 import abc
 
 class Adapter(object):
+
+    _adapter_name = None
+    _output_format = 'code'
+    _cache_needed = False
+
     def __init__(self):
-        self._list = self._get_list()
+        self._list = {None: self._get_list()}
 
     @abc.abstractmethod
-    def _get_list(self):
+    def _get_list(self, prefix=None):
         return []
 
-    def get_list(self):
-        return self._list
+    def get_list(self, prefix=None):
+        """
+        Return available pages for `prefix`
+        """
+
+        if prefix in self._list:
+            return self._list[prefix]
+
+        self._list[prefix] = set(self._get_list(prefix=prefix))
+        return self._list[prefix]
 
     def is_found(self, topic):
-        return topic in self._list
+        """
+        check if `topic` is available
+        CAUTION: only root is checked
+        """
+        return topic in self._list[None]
+
+    def is_cache_needed(self):
+        """
+        Return True if answers should be cached.
+        Return False if answers should not be cached.
+        """
+        return self._cache_needed
 
     @abc.abstractmethod
-    def get_page(self, topic, request_options=None):
+    def _get_page(self, topic, request_options=None):
+        """
+        Return page for `topic`
+        """
         pass
+
+    def _get_output_format(self, topic):
+        if '/' in topic:
+            subquery = topic.split('/')[-1]
+        else:
+            subquery = topic
+
+        if subquery in [':list']:
+            return 'text'
+        return self._output_format
+
+    def get_page_dict(self, topic, request_options=None):
+        """
+        Return page dict for `topic`
+        """
+        answer_dict = {
+            'topic': topic,
+            'topic_type': self._adapter_name,
+            'answer': self._get_page(topic, request_options=request_options),
+            'format': self._get_output_format(topic),
+            }
+        return answer_dict

lib/adapter/cheat_sheets.py

@@ -5,6 +5,8 @@
 sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
 from globals import PATH_CHEAT_SHEETS
 
+from adapter import Adapter
+
 def _remove_initial_underscore(filename):
     if filename.startswith('_'):
         filename = filename[1:]
@@ -31,41 +33,51 @@ def _get_answers_and_dirs():
     answers = [os.path.split(topic)[1] for topic in topics if not _isdir(topic)]
     return answers, answer_dirs
 
-def _update_cheat_sheets_topics():
-    answers = _get_answer_files_from_folder()
-    cheatsheet_answers, cheatsheet_dirs = _get_answers_and_dirs()
-    return answers+cheatsheet_answers, cheatsheet_dirs
-
-def get_list():
-    return _update_cheat_sheets_topics()[0]
-
-def get_dirs_list():
-    return _update_cheat_sheets_topics()[1]
-
-_CHEAT_SHEETS_LIST = get_list()
-def is_found(topic):
-    return topic in _CHEAT_SHEETS_LIST
-
-_CHEAT_SHEETS_DIRS = get_dirs_list()
-def is_dir_found(topic):
-    return topic in _CHEAT_SHEETS_DIRS
-
-def get_page(topic, request_options=None):
-    """
-    Get the cheat sheet topic from the own repository (cheat.sheets).
-    It's possible that topic directory starts with omitted underscore
-    """
-    filename = PATH_CHEAT_SHEETS + "%s" % topic
-    if not os.path.exists(filename):
-        filename = PATH_CHEAT_SHEETS + "_%s" % topic
-    if os.path.isdir(filename):
-        return ""
-    else:
+class CheatSheets(Adapter):
+
+    _adapter_name = "cheat.sheets"
+    _output_format = "code"
+
+    def __init__(self):
+        self._answers = []
+        self._cheatsheet_answers = []
+        self._cheatsheet_dirs = []
+        Adapter.__init__(self)
+
+    def _update_cheat_sheets_topics(self):
+        self._answers = _get_answer_files_from_folder()
+        self._cheatsheet_answers, self._cheatsheet_dirs = _get_answers_and_dirs()
+        return self._answers + self._cheatsheet_answers, self._cheatsheet_dirs
+
+    def _get_list(self, prefix=None):
+        return self._update_cheat_sheets_topics()[0]
+
+    def _get_page(self, topic, request_options=None):
+        """
+        Get the cheat sheet topic from the own repository (cheat.sheets).
+        It's possible that topic directory starts with omitted underscore
+        """
+        filename = PATH_CHEAT_SHEETS + "%s" % topic
+        if not os.path.exists(filename):
+            filename = PATH_CHEAT_SHEETS + "_%s" % topic
+        if os.path.isdir(filename):
+            return ""
         return open(filename, "r").read().decode('utf-8')
 
-def get_dir(topic, request_options=None):
-    answer = []
-    for f_name in glob.glob(PATH_CHEAT_SHEETS + "%s/*" % topic.rstrip('/')):
-        answer.append(os.path.basename(f_name))
-    topics = sorted(answer)
-    return "\n".join(topics) + "\n"
+class CheatSheetsDir(CheatSheets):
+
+    _adapter_name = "cheat.sheets dir"
+    _output_format = "text"
+
+    def _get_list(self, prefix=None):
+        return self._update_cheat_sheets_topics()[1]
+
+    def _get_page(self, topic, request_options=None):
+        answer = []
+        for f_name in glob.glob(PATH_CHEAT_SHEETS + "%s/*" % topic.rstrip('/')):
+            answer.append(os.path.basename(f_name))
+        topics = sorted(answer)
+        return "\n".join(topics) + "\n"
+
+    def is_found(self, topic):
+        return CheatSheets.is_found(self, topic.rstrip('/'))

lib/adapter/cmd.py

@@ -15,11 +15,16 @@ def _get_filenames(path):
     return [os.path.split(topic)[1] for topic in glob.glob(path)]
 
 class Tldr(Adapter):
-    def _get_list(self):
+
+    _adapter_name = "tldr"
+    _output_format = "code"
+    _cache_needed = True
+
+    def _get_list(self, prefix=None):
         return [filename[:-3]
                 for filename in _get_filenames(PATH_TLDR_PAGES) if filename.endswith('.md')]
 
-    def get_page(self, topic, request_options=None):
+    def _get_page(self, topic, request_options=None):
         cmd = ["tldr", topic]
         proc = Popen(cmd, stdout=PIPE, stderr=PIPE)
         answer = proc.communicate()[0]
@@ -40,32 +45,44 @@ def get_page(self, topic, request_options=None):
         return answer.decode('utf-8')
 
 class Cheat(Adapter):
-    def _get_list(self):
+
+    _adapter_name = "cheat"
+    _output_format = "code"
+    _cache_needed = True
+
+    def _get_list(self, prefix=None):
         return _get_filenames(PATH_CHEAT_PAGES)
 
-    def get_page(self, topic, request_options=None):
+    def _get_page(self, topic, request_options=None):
         cmd = ["/usr/local/bin/cheat", topic]
-        print(cmd)
         proc = Popen(cmd, stdout=PIPE, stderr=PIPE)
         answer = proc.communicate()[0].decode('utf-8')
-        print("answer=%s"% answer)
         return answer
 
 class Fosdem(Adapter):
-    def _get_list(self):
+
+    _adapter_name = "fosdem"
+    _output_format = "ansi"
+
+    def _get_list(self, prefix=None):
         return ['fosdem']
 
-    def get_page(self, topic, request_options=None):
+    def _get_page(self, topic, request_options=None):
         cmd = ["sudo", "/usr/local/bin/current-fosdem-slide"]
         proc = Popen(cmd, stdout=PIPE, stderr=PIPE)
         answer = proc.communicate()[0].decode('utf-8')
         return answer
 
 class Translation(Adapter):
-    def _get_list(self):
+
+    _adapter_name = "translation"
+    _output_format = "text"
+    _cache_needed = True
+
+    def _get_list(self, prefix=None):
         return []
 
-    def get_page(self, topic, request_options=None):
+    def _get_page(self, topic, request_options=None):
         from_, topic = topic.split('/', 1)
         to_ = request_options.get('lang', 'en')
         if '-' in from_:

lib/adapter/internal.py

@@ -7,7 +7,8 @@
 
 sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
 from globals import MYDIR, COLOR_STYLES
-from colorize_internal import colorize_internal
+from adapter import Adapter
+from fmt.internal import colorize_internal
 
 _INTERNAL_TOPICS = [
     ":cht.sh",
@@ -33,9 +34,13 @@
     ':intro',
 ]
 
-class InternalPages(object):
+class InternalPages(Adapter):
+
+    _adapter_name = 'internal'
+    _output_format = 'ansi'
 
     def __init__(self, get_topic_type=None, get_topics_list=None):
+        Adapter.__init__(self)
         self.get_topic_type = get_topic_type
         self.get_topics_list = get_topics_list
 
@@ -50,9 +55,8 @@ def _get_stat(self):
             answer += "%s %s\n" % (key, val)
         return answer
 
-
     @staticmethod
-    def get_list():
+    def get_list(prefix=None):
         return _INTERNAL_TOPICS
 
     def _get_list_answer(self, topic, request_options=None):
@@ -70,7 +74,7 @@ def _get_list_answer(self, topic, request_options=None):
 
         return answer
 
-    def get_page(self, topic, request_options=None):
+    def _get_page(self, topic, request_options=None):
         if topic.endswith('/:list') or topic.lstrip('/') == ':list':
             return self._get_list_answer(topic)
 
@@ -87,19 +91,25 @@ def get_page(self, topic, request_options=None):
         return answer
 
     def is_found(self, topic):
-        return topic in self.get_list()
+        return (
+            topic in self.get_list()
+            or topic.endswith('/:list')
+        )
 
 class UnknownPages(InternalPages):
 
+    _adapter_name = 'unknown'
+    _output_format = 'text'
+
     @staticmethod
-    def get_list():
+    def get_list(prefix=None):
         return []
 
     @staticmethod
     def is_found(topic):
-        return False
+        return True
 
-    def get_page(self, topic, request_options=None):
+    def _get_page(self, topic, request_options=None):
         topics_list = self.get_topics_list()
         if topic.startswith(':'):
             topics_list = [x for x in topics_list if x.startswith(':')]
@@ -114,3 +124,16 @@ def get_page(self, topic, request_options=None):
 
 %s
     """ % possible_topics_text
+
+class Search(Adapter):
+
+    _adapter_name = 'search'
+    _output_format = 'text'
+    _cache_needed = False
+
+    @staticmethod
+    def get_list(prefix=None):
+        return []
+
+    def is_found(topic):
+        return True

lib/adapter/latenz.py

@@ -1,16 +1,21 @@
 import sys
 import os
 sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
-
 from globals import PATH_LATENZ
+from adapter import Adapter
+
+class Latenz(Adapter):
+
+    _adapter_name = "late.nz"
+    _output_format = "ansi"
 
-def get_answer(topic, request_options=None):
-    sys.path.append(PATH_LATENZ)
-    import latencies
-    return latencies.render()
+    def _get_page(self, topic, request_options=None):
+        sys.path.append(PATH_LATENZ)
+        import latencies
+        return latencies.render()
 
-def get_list():
-    return ['latencies']
+    def _get_list(self, prefix=None):
+        return ['latencies']
 
-def is_found(topic):
-    return topic.lower() in ['latencies', 'late.nz', 'latency']
+    def is_found(self, topic):
+        return topic.lower() in ['latencies', 'late.nz', 'latency']