added smooth_scroll

Author: sudormrfbin

CHANGELOG.md

@@ -1,6 +1,15 @@
 CHANGELOG
 =========
 
+v0.7.0
+------
+
+- [ ] Vi keybindings
+- [x] Added option for smooth scroll
+- [ ] Batch tag files(more than one file at a time)
+- [ ] Preferences are now saved when updating the app
+- [x] Validators for smooth_scroll and preview_format
+
 v0.6.2
 ------
 

clid.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: clid
-Version: 0.6.3
+Version: 0.6.2
 Summary: Command line app based on ncurses to edit ID3 tags of mp3 files
 Home-page: https://github.com/GokulSoumya/clid
 Author: Gokul

clid/config.ini

@@ -1,2 +1,3 @@
 music_dir = ~/Music
+smooth_scroll = true
 preview_format = %a - %l - %n. %t 

clid/database.py

@@ -107,18 +107,18 @@ class SettingsDataBase(object):
                 used to refer to parent form(pref.PreferencesView)
             disp_strings(list):
                 list of formatted strings which will be used to display settings in the window
-            when_changed(dict):
-                dict of str:function; str is a setting; function to be executed when corresponding
-                setting is changed
     """
     def __init__(self):
         self.parent = None   # set by parent; see docstring
-        self.settings = dict()   # also set by parent
+        self.settings = None   # also set by parent
         self.disp_strings = []
-        self.when_changed = {
-            'music_dir': self.music_dir,
-            'preview_format': self.preview_format
-        }
+        self.when_changed = None
+
+    def set_attrs(self, parent, settings, when_changed):
+        """Set attributes that can only be set after a particular external operation"""
+        self.parent = parent
+        self.settings = settings
+        self.when_changed = when_changed
 
     def make_strings(self):
         """Make a list of strings which will be used to display the settings
@@ -141,7 +141,7 @@ def change_setting(self, key, new):
                 validators.VALIDATORS[key](new)
                 self.settings[key] = new
                 self.settings.write()
-                self.when_changed[key]()
+                self.when_changed.when_changed[key]()
             except validators.ValidationError as error:
                 # self.parent.wCommand.print_message(str(error), 'WARNING')
                 npyscreen.notify_confirm(message=str(error), title='Error', editw=1)
@@ -151,15 +151,38 @@ def change_setting(self, key, new):
                 title='Error', editw=1
             )
 
+
+class WhenChanged(object):
+    """Class with functions to be executed when an option is changed.
+       This is class is used by SettingsDataBase
+
+       Attributes:
+            settings(configobj.ConfigObj):
+                For accessing settings
+            main_form(npy.FormMuttActiveTraditionl):
+                Actually the main form with the files view
+            when_changed(dict):
+                dict of str:function; str is a setting; function to be executed when corresponding
+                setting is changed
+    """
+    def __init__(self, main_form, settings):
+        self.settings = settings
+        self.main_form = main_form
+        self.when_changed = {
+            'music_dir': self.music_dir,
+            'smooth_scroll': self.smooth_scroll,
+            'preview_format': self.preview_format
+        }
+
     def music_dir(self):
-        """To be executed when `music_dir` option is changed"""
-        main_form = self.parent.parentApp.getForm("MAIN")
-        main_form.value.load_files_and_set_values()
-        main_form.load_files()
+        self.main_form.value.load_files_and_set_values()
+        self.main_form.load_files()
 
     def preview_format(self):
-        """To be executed when `preview_format` option is changed"""
-        main_form = self.parent.parentApp.getForm("MAIN")
-        main_form.value.meta_cache = dict()
-        main_form.value.load_preview_format()
-        main_form.wMain.set_status(main_form.wMain.get_selected())   # change current file's preview into new format
+        self.main_form.value.meta_cache = dict()
+        self.main_form.value.load_preview_format()
+        self.main_form.wMain.set_status(self.main_form.wMain.get_selected())   # change current file's preview into new format
+
+    def smooth_scroll(self):
+        smooth = self.settings['smooth_scroll']
+        self.main_form.wMain.slow_scroll = True if smooth == 'true' else False

clid/main.py

@@ -60,6 +60,11 @@ class ClidMultiline(npy.MultiLine):
             self.parent.value refers to database.Mp3DataBase -> class
     """
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        smooth = self.parent.parentApp.settings['smooth_scroll']   # is smooth scroll enabled ?
+        self.slow_scroll = True if smooth == 'true' else False
+
     def set_status(self, filename):
         """Set the the value of self.parent.wStatus2 with metadata of file under cursor."""
         self.parent.wStatus2.value = self.parent.value.parse_meta_for_status(filename=filename)
@@ -94,7 +99,7 @@ def h_revert_escape(self, char):
     def h_switch_to_settings(self, char):
         self.parent.parentApp.switchForm("SETTINGS")
 
-    
+
     # NOTE: The if blocks with self.cursor_line is mainly to prevent the app from
     #       crashing Eg: when there is nothing to display(empty folder)
 

clid/pref.py

@@ -40,8 +40,10 @@ class PreferencesView(npy.FormMuttActiveTraditional):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.set_value(database.SettingsDataBase())
-        self.value.parent = self
-        self.value.settings = self.parentApp.settings
+        settings = self.parentApp.settings
+        when_changed = database.WhenChanged(main_form=self.parentApp.getForm("MAIN"),
+                                            settings=settings)
+        self.value.set_attrs(parent=self, settings=settings, when_changed=when_changed)
         self.value.make_strings()
         self.load_pref()
 

clid/validators.py

@@ -15,10 +15,8 @@ class ValidationError(Exception):
 
 def music_dir(test):
     """Checks whether `test` exists and is a directory.
-
        Args:
             test(str): path to be tested.
-
        Raises:
             ValidationError: if `test` doesn't exist or is not directory
     """
@@ -29,9 +27,29 @@ def music_dir(test):
 
 
 def preview_format(test):
-    pass
+    """Checks whether is a valid which can be used as a preview format
+       Args:
+            test(str): str to be tested
+       Raises:
+       ValidationError
+    """
+    valid_specs_list = _const.FORMAT.keys()
+    specs_list = _const.FORMAT_PAT.findall(test)
+
+    for spec in specs_list:
+        if spec not in valid_specs_list:
+            raise ValidationError('"' + spec + '"' + ' is not a valid format specifier')
+
+
+def smooth_scroll(test):
+    """Checks whether test is either 'true' or 'false'"""
+    if not(test == 'true' or test == 'false'):
+        raise ValidationError('Sorry, but I can\'t make sense of ' + '"' +  test + '"' + '; \
+        acceptable values for smooth_scroll are "true" or "false"')
+
 
 VALIDATORS = {
     'music_dir': music_dir,
-    'preview_format': preview_format
+    'preview_format': preview_format,
+    'smooth_scroll': smooth_scroll
 }