hspylib-clitt 0.9.27__py3-none-any.whl → 0.9.29__py3-none-any.whl

clitt/addons/setman/setman_repository.py

@@ -0,0 +1,68 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+   @project: HsPyLib-Clitt
+   @package: clitt.addons.setman
+      @file: setman_repository.py
+   @created: Mon, 5 Jun 2023
+    @author: <B>H</B>ugo <B>S</B>aporetti <B>J</B>unior"
+      @site: https://github.com/yorevs/hspylib
+   @license: MIT - Please refer to <https://opensource.org/licenses/MIT>
+
+   Copyright 2023, HsPyLib team
+"""
+from typing import List, Optional, Set
+
+from datasource.identity import Identity
+from datasource.sqlite.sqlite_repository import SQLiteRepository
+
+from clitt.addons.setman.setman_entry import SetmanEntry
+from clitt.addons.setman.setman_enums import SettingsType
+
+
+class SetmanRepository(SQLiteRepository[SetmanEntry]):
+    """Provide CRUD operations for the Vault application."""
+
+    @property
+    def database(self) -> str:
+        return self._config.database
+
+    def find_by_name(self, name: str, fields: Set[str] = None) -> Optional[SetmanEntry]:
+        """TODO"""
+        fields = "*" if not fields else ", ".join(fields)
+        sql = f"SELECT {fields} FROM {self.table_name()} WHERE name = ? ORDER BY name"
+        result = next((e for e in self.execute(sql, name=name)[1]), None)
+
+        return self.to_entity_type(result) if result else None
+
+    def search(self, name: str, stype: SettingsType, fields: Set[str] = None) -> List[SetmanEntry]:
+        """TODO"""
+        fields = "*" if not fields else ", ".join(fields)
+        search_name = f"%{name}%" if name != '%' else name
+        if stype:
+            sql = f"SELECT {fields} FROM {self.table_name()} WHERE name LIKE ? AND stype = ? ORDER BY name"
+            result = self.execute(sql, name=search_name, stype=stype.val)[1] or []
+        else:
+            sql = f"SELECT {fields} FROM {self.table_name()} WHERE name LIKE ? ORDER BY name"
+            result = self.execute(sql, name=search_name)[1] or []
+
+        return list(map(self.to_entity_type, result))
+
+    def truncate(self, table_name: str) -> None:
+        """TODO"""
+        self.execute(f'DELETE FROM "{table_name}"')
+
+    def table_name(self) -> str:
+        return "SETTINGS"
+
+    def to_entity_type(self, entity_dict: dict | tuple) -> SetmanEntry:
+        if isinstance(entity_dict, dict):
+            return SetmanEntry(Identity(SetmanEntry.SetmanId(entity_dict["uuid"])), **entity_dict)
+        return SetmanEntry(
+            Identity(SetmanEntry.SetmanId(entity_dict[0])),
+            entity_dict[1],
+            entity_dict[2],
+            SettingsType.of_value(entity_dict[3]),
+            entity_dict[4],
+        )

clitt/addons/setman/setman_service.py

@@ -0,0 +1,67 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+   @project: HsPyLib-Clitt
+   @package: clitt.addons.setman
+      @file: setman_service.py
+   @created: Mon, 5 Jun 2023
+    @author: <B>H</B>ugo <B>S</B>aporetti <B>J</B>unior"
+      @site: https://github.com/yorevs/hspylib
+   @license: MIT - Please refer to <https://opensource.org/licenses/MIT>
+
+   Copyright 2023, HsPyLib team
+"""
+from textwrap import dedent
+from typing import List, Optional
+
+from datasource.crud_service import CrudService
+
+from clitt.addons.setman.setman_config import SetmanConfig
+from clitt.addons.setman.setman_entry import SetmanEntry
+from clitt.addons.setman.setman_enums import SettingsType
+from clitt.addons.setman.setman_repository import SetmanRepository
+
+
+class SetmanService(CrudService[SetmanRepository, SetmanEntry]):
+    """Provides a CRUD service for the Setman application."""
+
+    def __init__(self, setman_config: SetmanConfig):
+        super().__init__(SetmanRepository(setman_config))
+
+    def get(self, name: str) -> Optional[SetmanEntry]:
+        """Get a setman entry using the specified name.
+        :param name: the setman entry name to find.
+        """
+        return self.repository.find_by_name(name)
+
+    def search(self, name: str, stype: SettingsType = None) -> List[SetmanEntry]:
+        """Get a setman entry using the specified name.
+        :param name: the setman entry name to find.
+        :param stype: the settings type to filter.
+        """
+        return self.repository.search(name, stype)
+
+    def truncate_settings_db(self) -> None:
+        """Truncate the settings table."""
+        self.repository.truncate("SETTINGS")
+
+    def create_settings_db(self) -> None:
+        """Create a brand new setman database file."""
+        self.repository.execute(
+            dedent(
+                """
+        CREATE TABLE IF NOT EXISTS "SETTINGS"
+        (
+            uuid         TEXT       not null,
+            name         TEXT       not null,
+            value        TEXT       not null,
+            stype        TEXT       not null,
+            modified     TEXT       not null,
+
+            CONSTRAINT UUID_pk PRIMARY KEY (uuid),
+            CONSTRAINT NAME_uk UNIQUE (name)
+        )
+        """
+            )
+        )

clitt/addons/widman/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.27
+# hspylib-clitt v0.9.29
 #
 # Package: main.clitt.addons.widman
 """Package initialization."""
@@ -11,4 +11,4 @@ __all__ = [
   'widgets', 
   'widman'
 ]
-__version__ = '0.9.27'
+__version__ = '0.9.29'

clitt/addons/widman/widget.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """
-   @project: HsPyLib
+   @project: HsPyLib-Clitt
    @package: clitt.addons.widman
       @file: widget.py
    @created: Fri, 29 Jul 2022

clitt/addons/widman/widget_entry.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """
-   @project: HsPyLib
+   @project: HsPyLib-Clitt
    @package: clitt.addons.widman
       @file: widget_entry.py
    @created: Fri, 04 Jun 2021

clitt/addons/widman/widgets/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.27
+# hspylib-clitt v0.9.29
 #
 # Package: main.clitt.addons.widman.widgets
 """Package initialization."""
@@ -11,4 +11,4 @@ __all__ = [
   'widget_send_msg', 
   'widget_time_calc'
 ]
-__version__ = '0.9.27'
+__version__ = '0.9.29'

clitt/addons/widman/widgets/widget_free.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """
-   @project: HsPyLib
+   @project: HsPyLib-Clitt
    @package: clitt.addons.widman.widgets
       @file: widget_free.py
    @created: Thu, 20 May 2021

clitt/addons/widman/widgets/widget_punch.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """
-   @project: HsPyLib
+   @project: HsPyLib-Clitt
    @package: clitt.addons.widman.widgets
       @file: widget_punch.py
    @created: Thu, 20 Sep 2022

clitt/addons/widman/widgets/widget_send_msg.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """
-   @project: HsPyLib
+   @project: HsPyLib-Clitt
    @package: clitt.addons.widman.widgets
       @file: widget_send_msg.py
    @created: Thu, 26 Aug 2017

clitt/addons/widman/widgets/widget_time_calc.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """
-   @project: HsPyLib
+   @project: HsPyLib-Clitt
    @package: clitt.addons.widman.widgets
       @file: widget_time_calc.py
    @created: Thu, 20 May 2021

clitt/addons/widman/widman.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """
-   @project: HsPyLib
+   @project: HsPyLib-Clitt
    @package: clitt.addons.widman
       @file: widman.py
    @created: Thu, 20 May 2021

clitt/core/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.27
+# hspylib-clitt v0.9.29
 #
 # Package: main.clitt.core
 """Package initialization."""
@@ -9,4 +9,4 @@ __all__ = [
   'icons', 
   'tui'
 ]
-__version__ = '0.9.27'
+__version__ = '0.9.29'

clitt/core/icons/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.27
+# hspylib-clitt v0.9.29
 #
 # Package: main.clitt.core.icons
 """Package initialization."""
@@ -9,4 +9,4 @@ __all__ = [
   'emojis', 
   'font_awesome'
 ]
-__version__ = '0.9.27'
+__version__ = '0.9.29'

clitt/core/icons/emojis/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.27
+# hspylib-clitt v0.9.29
 #
 # Package: main.clitt.core.icons.emojis
 """Package initialization."""
@@ -9,4 +9,4 @@ __all__ = [
   'emojis', 
   'face_smiling'
 ]
-__version__ = '0.9.27'
+__version__ = '0.9.29'

clitt/core/icons/emojis/emojis.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """
-   @project: HsPyLib
+   @project: HsPyLib-Clitt
    @package: clitt.core.icons.emojis
       @file: emojis.py
    @created: Tue, 4 May 2021

clitt/core/icons/emojis/face_smiling.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """
-   @project: HsPyLib
+   @project: HsPyLib-Clitt
    @package: clitt.core.icons.emojis
       @file: face_smiling.py
    @created: Tue, 4 May 2021

clitt/core/icons/font_awesome/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.27
+# hspylib-clitt v0.9.29
 #
 # Package: main.clitt.core.icons.font_awesome
 """Package initialization."""
@@ -14,4 +14,4 @@ __all__ = [
   'nav_icons', 
   'widget_icons'
 ]
-__version__ = '0.9.27'
+__version__ = '0.9.29'

clitt/core/icons/font_awesome/app_icons.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """
-   @project: HsPyLib
+   @project: HsPyLib-Clitt
    @package: clitt.core.icons.font_awesome
       @file: app_icons.py
    @created: Tue, 4 May 2021

clitt/core/icons/font_awesome/awesome.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """
-   @project: HsPyLib
+   @project: HsPyLib-Clitt
    @package: clitt.core.icons.font_awesome
       @file: awesome.py
    @created: Tue, 4 May 2021

clitt/core/icons/font_awesome/control_icons.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """
-   @project: HsPyLib
+   @project: HsPyLib-Clitt
    @package: clitt.core.icons.font_awesome
       @file: control_icons.py
    @created: Tue, 4 May 2021

clitt/core/icons/font_awesome/dashboard_icons.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """
-   @project: HsPyLib
+   @project: HsPyLib-Clitt
    @package: clitt.core.icons.font_awesome
       @file: dashboard_icons.py
    @created: Tue, 4 May 2021

clitt/core/icons/font_awesome/form_icons.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """
-   @project: HsPyLib
+   @project: HsPyLib-Clitt
    @package: clitt.core.icons.font_awesome
       @file: form_icons.py
    @created: Tue, 4 May 2021

clitt/core/icons/font_awesome/nav_icons.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """
-   @project: HsPyLib
+   @project: HsPyLib-Clitt
    @package: clitt.core.icons.font_awesome
       @file: app_icons.py
    @created: Tue, 4 May 2021

clitt/core/icons/font_awesome/widget_icons.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """
-   @project: HsPyLib
+   @project: HsPyLib-Clitt
    @package: clitt.core.icons.font_awesome
       @file: widget_icons.py
    @created: Thu, 20 May 2021

clitt/core/tui/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.27
+# hspylib-clitt v0.9.29
 #
 # Package: main.clitt.core.tui
 """Package initialization."""
@@ -16,4 +16,4 @@ __all__ = [
   'tui_component', 
   'tui_preferences'
 ]
-__version__ = '0.9.27'
+__version__ = '0.9.29'

clitt/core/tui/mchoose/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.27
+# hspylib-clitt v0.9.29
 #
 # Package: main.clitt.core.tui.mchoose
 """Package initialization."""
@@ -9,4 +9,4 @@ __all__ = [
   'mchoose', 
   'menu_choose'
 ]
-__version__ = '0.9.27'
+__version__ = '0.9.29'

clitt/core/tui/mchoose/menu_choose.py

@@ -81,7 +81,7 @@ class MenuChoose(TUIComponent):
             option_line = str(self.items[idx])
             erase_line()
             # Print the selector if the index is currently selected
-            selector = self._draw_line_color(idx == self.sel_index)
+            selector = self._draw_cursor_line(idx == self.sel_index)
             mark = self.prefs.marked if self.sel_options[idx] == 1 else self.prefs.unmarked
             # fmt: off
             line_fmt = (

clitt/core/tui/mdashboard/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.27
+# hspylib-clitt v0.9.29
 #
 # Package: main.clitt.core.tui.mdashboard
 """Package initialization."""
@@ -10,4 +10,4 @@ __all__ = [
   'dashboard_item', 
   'mdashboard'
 ]
-__version__ = '0.9.27'
+__version__ = '0.9.29'

clitt/core/tui/menu/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.27
+# hspylib-clitt v0.9.29
 #
 # Package: main.clitt.core.tui.menu
 """Package initialization."""
@@ -14,4 +14,4 @@ __all__ = [
   'tui_menu_utils', 
   'tui_menu_view'
 ]
-__version__ = '0.9.27'
+__version__ = '0.9.29'

clitt/core/tui/menu/tui_menu_item.py

@@ -84,7 +84,7 @@ class TUIMenuItem(TUIMenu):
                 option_line = str(self._items[idx])
                 erase_line()
                 # Print the selector if the index is currently selected
-                selector = self._draw_line_color(is_selected=(idx == self._sel_index), has_bg_color=False)
+                selector = self._draw_cursor_line(is_selected=(idx == self._sel_index), has_bg_color=False)
                 # fmt: off
                 line_fmt = (
                     "  {:>" + f"{len(str(length))}" + "}  "

clitt/core/tui/minput/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.27
+# hspylib-clitt v0.9.29
 #
 # Package: main.clitt.core.tui.minput
 """Package initialization."""
@@ -15,4 +15,4 @@ __all__ = [
   'minput', 
   'minput_utils'
 ]
-__version__ = '0.9.27'
+__version__ = '0.9.29'

clitt/core/tui/minput/minput.py

@@ -44,18 +44,3 @@ def minput(
                 f_out.write(f"{snakecase(name, screaming=True)}={quote(value)}" + os.linesep)
 
     return result
-
-
-if __name__ == '__main__':
-    it = [
-        'Age || numbers | 1 / 3 ||',
-        'Password | password || 8 ||',
-        'Access ||| 5 | r | Admin',
-        'Role | select || 3 / 5 || <one>,two,three ',
-        'Phone | masked | masked | 5 / 50 || ;(##) #####-#### ',
-        'Accept Conditions | checkbox ||||'
-    ]
-    form_fields = MenuInput.builder() \
-        .from_tokenized(it) \
-        .build()
-    minput(form_fields, "Fill the form below", "/tmp/out.txt")

clitt/core/tui/mselect/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.27
+# hspylib-clitt v0.9.29
 #
 # Package: main.clitt.core.tui.mselect
 """Package initialization."""
@@ -9,4 +9,4 @@ __all__ = [
   'menu_select', 
   'mselect'
 ]
-__version__ = '0.9.27'
+__version__ = '0.9.29'

clitt/core/tui/mselect/menu_select.py

@@ -40,7 +40,7 @@ class MenuSelect(TUIComponent):
         self.max_line_length = max(len(str(item)) for item in items)
 
     def execute(self) -> Optional[T]:
-        """TODO"""
+        """Execute the component's main flow."""
 
         if (length := len(self.items)) == 0:
             return None
@@ -64,7 +64,7 @@ class MenuSelect(TUIComponent):
         return self.items[self.sel_index] if keypress == Keyboard.VK_ENTER else None
 
     def _render(self) -> None:
-        """TODO"""
+        """Renders the TUI component."""
 
         length = len(self.items)
         _, columns = screen_size()
@@ -78,7 +78,7 @@ class MenuSelect(TUIComponent):
             option_line = str(self.items[idx])
             erase_line()
             # Print the selector if the index is currently selected
-            selector = self._draw_line_color(idx == self.sel_index)
+            selector = self._draw_cursor_line(idx == self.sel_index)
             # fmt: off
             line_fmt = (
                 "  {:>" + f"{len(str(length))}" + "}  "

clitt/core/tui/table/__init__.py

@@ -1,6 +1,6 @@
 # _*_ coding: utf-8 _*_
 #
-# hspylib-clitt v0.9.27
+# hspylib-clitt v0.9.29
 #
 # Package: main.clitt.core.tui.table
 """Package initialization."""
@@ -8,4 +8,4 @@
 __all__ = [
   'table_renderer'
 ]
-__version__ = '0.9.27'
+__version__ = '0.9.29'

clitt/core/tui/tui_application.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """
-   @project: HsPyLib
+   @project: HsPyLib-Clitt
    @package: clitt.core.tui
       @file: tui_application.py
    @created: Tue, 4 May 2021

clitt/core/tui/tui_component.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """
-   @project: HsPyLib
+   @project: HsPyLib-Clitt
    @package: clitt.core.tui
       @file: tui_component.py
    @created: Tue, 4 May 2021
@@ -29,7 +29,7 @@ class TUIComponent(Generic[T], ABC):
 
     @staticmethod
     def _draw_line(line_fmt: str, max_columns: int, *args: Any) -> None:
-        """TODO
+        """Draws a formatted component line respecting the specified max_columns.
         :param line_fmt: the line format.
         :param max_columns: the maximum length of the line. If the text is greater than this limit, it will be elided.
         :param args: the arguments for the format.
@@ -50,8 +50,8 @@ class TUIComponent(Generic[T], ABC):
     def execute(self) -> Optional[T | List[T]]:
         """Execute the main component flow."""
 
-    def _draw_line_color(self, is_selected: bool = False, has_bg_color: bool = True) -> Awesome:
-        """TODO
+    def _draw_cursor_line(self, is_selected: bool = False, has_bg_color: bool = True) -> Awesome:
+        """Draws and highlight the selected component line.
         :param is_selected: whether to set a selected foreground color or not.
         :param has_bg_color: whether to set a background or not.
         """
@@ -68,7 +68,7 @@ class TUIComponent(Generic[T], ABC):
 
     @abstractmethod
     def _render(self) -> None:
-        """Method to render the component."""
+        """Renders the TUI component."""
 
     @abstractmethod
     def _navbar(self, **kwargs) -> str:

clitt/core/tui/tui_preferences.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """
-   @project: HsPyLib
+   @project: HsPyLib-Clitt
    @package: clitt.core.tui
       @file: tui_preferences.py
    @created: Tue, 4 May 2021

{hspylib_clitt-0.9.27.dist-info → hspylib_clitt-0.9.29.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hspylib-clitt
-Version: 0.9.27
+Version: 0.9.29
 Summary: HsPyLib - CLI Terminal Tools
 Home-page: https://github.com/yorevs/hspylib
 Author: Hugo Saporetti Junior
@@ -31,7 +31,7 @@ Requires-Dist: hspylib
 ## Create professional CLI applications
 
 [![License](https://badgen.net/badge/license/MIT/gray)](LICENSE.md)
-[![Release](https://badgen.net/badge/release/v0.9.27/gray)](CHANGELOG.md#unreleased)
+[![Release](https://badgen.net/badge/release/v0.9.29/gray)](CHANGELOG.md#unreleased)
 [![PyPi](https://badgen.net/badge/icon/python?icon=pypi&label)](https://pypi.org/project/hspylib-cfman)
 [![GitHub](https://badgen.net/badge/icon/github?icon=github&label)](https://github.com/yorevs/hspylib)
 [![Gitter](https://badgen.net/badge/icon/gitter?icon=gitter&label)](https://gitter.im/hspylib/community)