suplemon-editor 0.3.0__tar.gz → 0.3.2__tar.gz

{suplemon_editor-0.3.0/suplemon_editor.egg-info → suplemon_editor-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: suplemon-editor
-Version: 0.3.0
+Version: 0.3.2
 Summary: Console text editor with multi cursor support. Maintained fork of Suplemon.
 Home-page: https://github.com/leancode/suplemon/
 Author: Richard Lewis
@@ -114,7 +114,7 @@ kept in small, self contained commits so they can be offered back.
  * Find, Find next and Find all (Ctrl + F, Ctrl + D, Ctrl + A)
  * Custom keyboard shortcuts (and easy-to-use defaults)
  * Mouse support
- * Restores cursor and scroll positions when reopenning files
+ * Restores cursor and scroll positions when reopening files
  * Extensions (easy to write your own)
  * Lots more...
 
@@ -183,6 +183,28 @@ externally managed (PEP 668) and will refuse `sudo pip install` outright.
     suplemon [filename:row:col]... # Open one or more files at a specific row or column (optional)
 
 
+### Editing a root-owned file
+
+`sudo suplemon /etc/hosts` will say `command not found`. That is sudo, not
+Suplemon: sudo replaces `$PATH` with its own `secure_path`, which never
+includes `~/.local/bin`, so it cannot see the launcher. Give it the full
+path instead:
+
+    sudo ~/.local/bin/suplemon /etc/hosts
+
+That works because the launcher hard-codes an absolute path to the source
+tree. `$HOME` is root's under sudo, so a launcher written in terms of
+`$HOME` would look for the interpreter in the wrong place.
+
+If you do this often, either add `~/.local/bin` to `secure_path` in
+`visudo`, or use `sudoedit`, which copies the file to a temporary location,
+opens it as you rather than as root, and copies it back:
+
+    SUDO_EDITOR=~/.local/bin/suplemon sudoedit /etc/hosts
+
+`sudoedit` is the safer of the two: the editor never runs as root.
+
+
 ### Notes
  - **Python 3.8 or higher.** Python 2 is not supported.
  - *The master branch is considered stable.*

{suplemon_editor-0.3.0 → suplemon_editor-0.3.2}/README.md

@@ -73,7 +73,7 @@ kept in small, self contained commits so they can be offered back.
  * Find, Find next and Find all (Ctrl + F, Ctrl + D, Ctrl + A)
  * Custom keyboard shortcuts (and easy-to-use defaults)
  * Mouse support
- * Restores cursor and scroll positions when reopenning files
+ * Restores cursor and scroll positions when reopening files
  * Extensions (easy to write your own)
  * Lots more...
 
@@ -142,6 +142,28 @@ externally managed (PEP 668) and will refuse `sudo pip install` outright.
     suplemon [filename:row:col]... # Open one or more files at a specific row or column (optional)
 
 
+### Editing a root-owned file
+
+`sudo suplemon /etc/hosts` will say `command not found`. That is sudo, not
+Suplemon: sudo replaces `$PATH` with its own `secure_path`, which never
+includes `~/.local/bin`, so it cannot see the launcher. Give it the full
+path instead:
+
+    sudo ~/.local/bin/suplemon /etc/hosts
+
+That works because the launcher hard-codes an absolute path to the source
+tree. `$HOME` is root's under sudo, so a launcher written in terms of
+`$HOME` would look for the interpreter in the wrong place.
+
+If you do this often, either add `~/.local/bin` to `secure_path` in
+`visudo`, or use `sudoedit`, which copies the file to a temporary location,
+opens it as you rather than as root, and copies it back:
+
+    SUDO_EDITOR=~/.local/bin/suplemon sudoedit /etc/hosts
+
+`sudoedit` is the safer of the two: the editor never runs as root.
+
+
 ### Notes
  - **Python 3.8 or higher.** Python 2 is not supported.
  - *The master branch is considered stable.*

{suplemon_editor-0.3.0 → suplemon_editor-0.3.2}/suplemon/cursor.py

@@ -115,7 +115,7 @@ class Cursor:
         return False
 
     def __ne__(self, item):
-        """Check cursor for unequality."""
+        """Check cursor for inequality."""
         if isinstance(item, Cursor):
             if item.x != self.x or item.y != self.x:
                 return False

{suplemon_editor-0.3.0 → suplemon_editor-0.3.2}/suplemon/help.py

@@ -41,11 +41,11 @@ putting more cursors down.
    > three lines.
 
  * Ctrl + D
-   > Add a cursor at the next occurance of the word the cursor is on.
+   > Add a cursor at the next occurrence of the word the cursor is on.
    > Press it repeatedly to gather up matches one at a time.
 
  * Ctrl + A
-   > Add a cursor at every occurance of the last search term at once.
+   > Add a cursor at every occurrence of the last search term at once.
    > Search with Ctrl + F or Ctrl + D first to set the term.
 
  * ESC
@@ -104,10 +104,10 @@ the complete reference.
    > Search for a string or regular expression (configurable)
 
  * Ctrl + D
-   > Search for next occurance or find the word the cursor is on. Adds a new cursor at each new occurance.
+   > Search for next occurrence or find the word the cursor is on. Adds a new cursor at each new occurrence.
 
  * Ctrl + A
-   > Add a cursor at every occurance of the last search term. Search with
+   > Add a cursor at every occurrence of the last search term. Search with
    > Ctrl + F or Ctrl + D first, otherwise there is no term to look for.
 
  * Ctrl + T

{suplemon_editor-0.3.0 → suplemon_editor-0.3.2}/suplemon/helpers.py

@@ -32,7 +32,7 @@ def get_error_info():
 
 
 def get_string_between(start, stop, s):
-    """Search string for a substring between two delimeters. False if not found."""
+    """Search string for a substring between two delimiters. False if not found."""
     i1 = s.find(start)
     if i1 == -1:
         return False

{suplemon_editor-0.3.0 → suplemon_editor-0.3.2}/suplemon/lexer.py

@@ -15,6 +15,9 @@ class Lexer:
             pygments.token.Generic.Strong:             "string",
             pygments.token.Generic.Subheading:         "string",
             pygments.token.Generic.Deleted:            "invalid",
+            pygments.token.Generic.Heading:            "entity.name",
+            pygments.token.Generic.Emph:               "italic",
+            pygments.token.Generic.Inserted:           "string",
             pygments.token.Punctuation:                "punctuation",
             pygments.token.Operator:                   "keyword",
             pygments.token.Operator.Word:              "keyword.control",
@@ -56,8 +59,28 @@ class Lexer:
             pygments.token.Error:                      "invalid",
         }
 
+    def scope_for_token(self, token):
+        """Return the theme scope for a pygments token.
+
+        Pygments tokens are hierarchical: Token.Literal.String.Single is a
+        child of Token.Literal.String. Mapping only exact matches left every
+        subtype the map doesn't name unstyled, which is why single quoted
+        Python strings, C preprocessor lines and all leading whitespace came
+        out unhighlighted. Walk up to the nearest mapped ancestor, which is
+        how pygments' own formatters resolve a style.
+
+        :param token: Pygments token type.
+        :return: Theme scope name, or "global" if nothing matches.
+        """
+        while token is not None:
+            if token in self.token_map:
+                return self.token_map[token]
+            token = token.parent
+        self.logger.debug("No token_map entry for '{0}'.".format(token))
+        return "global"
+
     def lex(self, code, lex):
-        """Return tokenified code.
+        """Return tokenized code.
 
         Return a list of tuples (scope, word) where word is the word to be
         printed and scope the scope name representing the context.
@@ -79,10 +102,7 @@ class Lexer:
             token = word[0]
             scope = "global"
 
-            if token in self.token_map.keys():
-                scope = self.token_map[token]
-            else:
-                self.logger.warning("Token '{0}' for word '{1}' not found in token_map.".format(token, word[1]))
+            scope = self.scope_for_token(token)
 
             scopes.append((scope, word[1]))
         return scopes

{suplemon_editor-0.3.0 → suplemon_editor-0.3.2}/suplemon/main.py

@@ -18,7 +18,7 @@ from .logger import logger
 from .config import Config
 from .editor import Editor
 
-__version__ = "0.3.0"
+__version__ = "0.3.2"
 
 
 class App:

{suplemon_editor-0.3.0 → suplemon_editor-0.3.2}/suplemon/module_loader.py

@@ -80,7 +80,7 @@ class ModuleLoader:
         names = sorted(self.get_module_names())
         for name in names:
             name, module = self.load_single(name)
-            # Skip modules that can't be run expicitly
+            # Skip modules that can't be run explicitly
             if module["class"].run.__module__ == "suplemon.suplemon_module":
                 continue
             # Skip undocumented modules

{suplemon_editor-0.3.0 → suplemon_editor-0.3.2}/suplemon/modules/autodocstring.py

@@ -70,7 +70,7 @@ class AutoDocstring(Module):
     def get_docstring_indent(self, line_data):
         """Get indent amount for docstring.
 
-        Gets the indentation of the function definiton line, and
+        Gets the indentation of the function definition line, and
         adds +1 to account for the function body.
 
         :param line_data: The line of the function definition.
@@ -124,7 +124,7 @@ class AutoDocstring(Module):
 
         :param editor: Editor instance to get lines from.
         :param line_number: Line number of the function definition.
-        :return: Boolean indicating wether the function something.
+        :return: Boolean indicating whether the function something.
         """
         for i in range(line_number+1, len(editor.lines)):
             line = editor.get_line(i)

{suplemon_editor-0.3.0 → suplemon_editor-0.3.2}/suplemon/modules/linter.py

@@ -14,7 +14,7 @@ class Linter(Module):
     def init(self):
         self.init_logging(__name__)
 
-        # TODO: Run linting in a seperate thread to avoid
+        # TODO: Run linting in a separate thread to avoid
         # blocking the UI when the app is loading
 
         # Lint all files after app is loaded

{suplemon_editor-0.3.0 → suplemon_editor-0.3.2}/suplemon/prompt.py

@@ -147,7 +147,7 @@ class PromptFiltered(Prompt):
 
     def handle_input(self, event):
         """Handle special bindings for the prompt."""
-        # The cancel and accept keys are kept for concistency
+        # The cancel and accept keys are kept for consistency
         if event.key_name in ["ctrl+c", "escape"]:
             self.on_cancel()
             return False
@@ -304,7 +304,7 @@ class PromptFile(PromptAutocmp):
                 # This might happen if the cwd has been
                 # removed after starting suplemon.
                 return []
-        # In case we don't have sufficent permissions
+        # In case we don't have sufficient permissions
         try:
             contents = os.listdir(path)
         except OSError:

{suplemon_editor-0.3.0 → suplemon_editor-0.3.2}/suplemon/suplemon_module.py

@@ -66,7 +66,7 @@ class Storage:
         self.data = data
 
     def set_automatic(self, auto):
-        """Set wether the data should be stored automatically when changed."""
+        """Set whether the data should be stored automatically when changed."""
         self.automatic = auto
 
     def store(self):

{suplemon_editor-0.3.0 → suplemon_editor-0.3.2}/suplemon/viewer.py

@@ -380,7 +380,7 @@ class BaseViewer:
         #    because it can get sliced. Sliced lines won't always get
         #    completely highlighted (partial words). Syntax highlighting
         #    should be done first and then only render visible words.
-        # 2) Additionaly highlighing should be done for all lines at once
+        # 2) Additionally highlighting should be done for all lines at once
         #    and tokens should be cached in line instances. That way we can
         #    support multi line comment syntax etc. It should also perform
         #    better, since we only need to re-highlight lines when they change.
@@ -400,7 +400,7 @@ class BaseViewer:
                     bg = int(settings.get("background") or -1)
                     curses.init_pair(pair, fg, bg)
                 curs_color = curses.color_pair(pair)
-                # Only add tab indicators to the inital whitespace
+                # Only add tab indicators to the initial whitespace
                 if first_token and self.config["show_tab_indicators"]:
                     text = self.add_tab_indicators(text)
                 self.window.addstr(y, x_offset, text, curs_color)
@@ -520,14 +520,14 @@ class BaseViewer:
     ###########################################################################
 
     def scroll_up(self):
-        """Scroll view up if neccesary."""
+        """Scroll view up if necessary."""
         cursor = self.get_first_cursor()
         if cursor.y - self.y_scroll < 0:
             # Scroll up
             self.y_scroll = cursor.y
 
     def scroll_down(self):
-        """Scroll view up if neccesary."""
+        """Scroll view up if necessary."""
         cursor = self.get_last_cursor()
         size = self.get_size()
         if cursor.y - self.y_scroll >= size[1]:
@@ -839,7 +839,7 @@ class BaseViewer:
                 # On the current line begin from the last cursor x pos
                 x_offset = last_cursor.x
 
-            # Find all occurances of search string
+            # Find all occurrences of search string
             s = str(line[x_offset:])  # Data to search in
             if y < len(self.lines)-1:  # Make line breaks findable (add them to all except last line)
                 s = s + "\n"
@@ -873,7 +873,7 @@ class BaseViewer:
             return False
         else:
             # If we only have one cursor, and it's not
-            # where the first occurance is, just remove it
+            # where the first occurrence is, just remove it
             if len(self.cursors) == 1 and self.cursors[0].tuple() != new_cursors[0].tuple():
                 self.cursors = []
         self.last_find = what   # Only store string if it's really found
@@ -888,7 +888,7 @@ class BaseViewer:
         self.store_action_state("find")  # Store undo point
 
     def find_next(self):
-        """Find next occurance."""
+        """Find next occurrence."""
         what = self.last_find
         if what == "":
             cursor = self.get_cursor()
@@ -907,7 +907,7 @@ class BaseViewer:
         self.find(what)
 
     def find_all(self):
-        """Find all occurances."""
+        """Find all occurrences."""
         self.find(self.last_find, True)
 
 

{suplemon_editor-0.3.0 → suplemon_editor-0.3.2/suplemon_editor.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: suplemon-editor
-Version: 0.3.0
+Version: 0.3.2
 Summary: Console text editor with multi cursor support. Maintained fork of Suplemon.
 Home-page: https://github.com/leancode/suplemon/
 Author: Richard Lewis
@@ -114,7 +114,7 @@ kept in small, self contained commits so they can be offered back.
  * Find, Find next and Find all (Ctrl + F, Ctrl + D, Ctrl + A)
  * Custom keyboard shortcuts (and easy-to-use defaults)
  * Mouse support
- * Restores cursor and scroll positions when reopenning files
+ * Restores cursor and scroll positions when reopening files
  * Extensions (easy to write your own)
  * Lots more...
 
@@ -183,6 +183,28 @@ externally managed (PEP 668) and will refuse `sudo pip install` outright.
     suplemon [filename:row:col]... # Open one or more files at a specific row or column (optional)
 
 
+### Editing a root-owned file
+
+`sudo suplemon /etc/hosts` will say `command not found`. That is sudo, not
+Suplemon: sudo replaces `$PATH` with its own `secure_path`, which never
+includes `~/.local/bin`, so it cannot see the launcher. Give it the full
+path instead:
+
+    sudo ~/.local/bin/suplemon /etc/hosts
+
+That works because the launcher hard-codes an absolute path to the source
+tree. `$HOME` is root's under sudo, so a launcher written in terms of
+`$HOME` would look for the interpreter in the wrong place.
+
+If you do this often, either add `~/.local/bin` to `secure_path` in
+`visudo`, or use `sudoedit`, which copies the file to a temporary location,
+opens it as you rather than as root, and copies it back:
+
+    SUDO_EDITOR=~/.local/bin/suplemon sudoedit /etc/hosts
+
+`sudoedit` is the safer of the two: the editor never runs as root.
+
+
 ### Notes
  - **Python 3.8 or higher.** Python 2 is not supported.
  - *The master branch is considered stable.*