mirror of
https://github.com/chubin/cheat.sh.git
synced 2026-06-20 21:26:44 +02:00
Igor Chubin
96 lines
2.6 KiB
Python
96 lines
2.6 KiB
Python
"""
|
|
Implementation of the adapter for the native cheat.sh cheat sheets repository,
|
|
cheat.sheets. The cheat sheets repository is hierarchically structured: cheat
|
|
sheets covering programming languages are are located in subdirectories.
|
|
"""
|
|
|
|
# pylint: disable=relative-import
|
|
|
|
import os
|
|
import glob
|
|
|
|
from git_adapter import GitRepositoryAdapter
|
|
|
|
def _remove_initial_underscore(filename):
|
|
if filename.startswith('_'):
|
|
filename = filename[1:]
|
|
return filename
|
|
|
|
class CheatSheets(GitRepositoryAdapter):
|
|
|
|
"""
|
|
Adapter for the cheat.sheets cheat sheets.
|
|
"""
|
|
|
|
_adapter_name = "cheat.sheets"
|
|
_output_format = "code"
|
|
_repository_url = "https://github.com/chubin/cheat.sheets"
|
|
_cheatsheet_files_prefix = "sheets/"
|
|
|
|
def _get_list(self, prefix=None):
|
|
"""
|
|
Return all files on the first and the second level,
|
|
excluding directories and hidden files
|
|
"""
|
|
|
|
hidden_files = ["_info.yaml"]
|
|
answer = []
|
|
for mask in ['*', '*/*']:
|
|
template = os.path.join(
|
|
self.local_repository_location(),
|
|
self._cheatsheet_files_prefix,
|
|
mask)
|
|
|
|
answer += [
|
|
os.path.basename(f_name)
|
|
for f_name in glob.glob(template)
|
|
if not os.path.isdir(f_name) and f_name not in hidden_files]
|
|
|
|
return sorted(answer)
|
|
|
|
class CheatSheetsDir(CheatSheets):
|
|
|
|
"""
|
|
Adapter for the cheat sheets directories.
|
|
Provides pages named according to subdirectories:
|
|
_dir => dir/
|
|
|
|
(currently only _get_list() is used; _get_page is shadowed
|
|
by the CheatSheets adapter)
|
|
"""
|
|
|
|
_adapter_name = "cheat.sheets dir"
|
|
_output_format = "text"
|
|
|
|
def _get_list(self, prefix=None):
|
|
|
|
template = os.path.join(
|
|
self.local_repository_location(),
|
|
self._cheatsheet_files_prefix,
|
|
'*')
|
|
|
|
answer = sorted([
|
|
_remove_initial_underscore(os.path.basename(f_name)) + "/"
|
|
for f_name in glob.glob(template)
|
|
if os.path.isdir(f_name)])
|
|
|
|
return answer
|
|
|
|
def _get_page(self, topic, request_options=None):
|
|
"""
|
|
Content of the `topic` dir is the list of the pages in the dir
|
|
"""
|
|
|
|
template = os.path.join(
|
|
self.local_repository_location(),
|
|
self._cheatsheet_files_prefix,
|
|
topic.rstrip('/'),
|
|
'*')
|
|
|
|
answer = sorted([
|
|
os.path.basename(f_name) for f_name in glob.glob(template)])
|
|
return "\n".join(answer) + "\n"
|
|
|
|
def is_found(self, topic):
|
|
return CheatSheets.is_found(self, topic.rstrip('/'))
|