refactor: ♻️ break up some long functions

now more manageable for future use and also easier to read/infer

Author: djdembeck

Contents/Code/__init__.py

@@ -488,9 +488,7 @@ def call_item_api(self, helper):
 
     def compile_metadata(self, helper):
         # Date.
-        if helper.date is not None:
-            if not helper.metadata.originally_available_at or helper.force:
-                helper.metadata.originally_available_at = helper.date
+        helper.set_date()
         tagger = TagTool(helper, Prefs)
         # Genres.
         tagger.add_genres()
@@ -505,39 +503,16 @@ def compile_metadata(self, helper):
             tagger.add_authors_to_moods()
         # Series.
         tagger.add_series_to_moods()
-
-        # If the `simplify_title` option is selected, don't append subtitle
-        # and remove extra endings on the title
-        if Prefs['simplify_title']:
-            album_title = helper.simplify_title()
-        elif helper.subtitle:
-            album_title = helper.title + ': ' + helper.subtitle
-        else:
-            album_title = helper.title
         # Title.
-        if not helper.metadata.title or helper.force:
-            helper.metadata.title = album_title
+        helper.set_title()
         # Sort Title.
-        # Add series/volume to sort title where possible.
-        series_with_volume = ''
-        if helper.series and helper.volume:
-            series_with_volume = helper.series + ', ' + helper.volume
-        # Only include subtitle in sort if not in a series
-        if not helper.volume:
-            helper.title = album_title
-        if not helper.metadata.title_sort or helper.force:
-            helper.metadata.title_sort = ' - '.join(
-                filter(
-                    None, [(series_with_volume), helper.title]
-                )
-            )
+        helper.set_sort_title()
         # Studio.
-        if not helper.metadata.studio or helper.force:
-            helper.metadata.studio = helper.studio
+        helper.set_studio()
         # Summary.
-        if not helper.metadata.summary or helper.force:
-            helper.metadata.summary = helper.synopsis
+        helper.set_summary()
         # Thumb.
+        # Kept here because of Proxy
         if helper.thumb:
             if helper.thumb not in helper.metadata.posters or helper.force:
                 helper.metadata.posters[helper.thumb] = Proxy.Media(
@@ -546,10 +521,9 @@ def compile_metadata(self, helper):
                 # Re-prioritize the poster to the first position
                 helper.metadata.posters.validate_keys([helper.thumb])
         # Rating.
-        # We always want to refresh the rating
-        if helper.rating:
-            helper.metadata.rating = float(helper.rating) * 2
+        helper.set_rating()
 
+        # Log the resulting metadata
         helper.log_update_metadata()
 
     def getDateFromString(self, string):

Contents/Code/search_tools.py

@@ -485,34 +485,11 @@ def sum_scores(self, numberlist):
             lambda x, y: x + y, numberlist, 0
         )
 
-    def score_result(self):
-        # Array to hold score points for processing
-        all_scores = []
-
-        # Album name score
-        if self.title:
-            title_score = self.score_album(self.title)
-            if title_score:
-                all_scores.append(title_score)
-        # Author name score
-        if self.authors_concat:
-            author_score = self.score_author(self.authors_concat)
-            if author_score:
-                all_scores.append(author_score)
-        # Library language score
-        if self.language:
-            lang_score = self.score_language(self.language)
-            if lang_score:
-                all_scores.append(lang_score)
-
-        # Subtract difference from initial score
-        # Subtract index to use Audible relevance as weight
-        score = self.INITIAL_SCORE - self.sum_scores(all_scores) - self.index
-
-        log.info("Result #" + str(self.index + 1))
-        # Log basic metadata
+    def score_create_result(self, score):
         data_to_log = []
         plex_score_dict = {}
+
+        # Go through all the keys for the result and log as we go
         if self.asin:
             plex_score_dict['id'] = self.asin
             data_to_log.append({'ASIN is': self.asin})
@@ -536,8 +513,38 @@ def score_result(self):
             data_to_log.append({'Title is': self.title})
         if self.year:
             plex_score_dict['year'] = self.year
-
+        
         log.metadata(data_to_log, log_level="info")
+        return plex_score_dict
+
+    def score_result(self):
+        # Array to hold score points for processing
+        all_scores = []
+
+        # Album name score
+        if self.title:
+            title_score = self.score_album(self.title)
+            if title_score:
+                all_scores.append(title_score)
+        # Author name score
+        if self.authors_concat:
+            author_score = self.score_author(self.authors_concat)
+            if author_score:
+                all_scores.append(author_score)
+        # Library language score
+        if self.language:
+            lang_score = self.score_language(self.language)
+            if lang_score:
+                all_scores.append(lang_score)
+
+        # Subtract difference from initial score
+        # Subtract index to use Audible relevance as weight
+        score = self.INITIAL_SCORE - self.sum_scores(all_scores) - self.index
+
+        log.info("Result #" + str(self.index + 1))
+
+        # Create result dict
+        plex_score_dict = self.score_create_result(score)
 
         if score >= self.IGNORE_SCORE:
             self.info.append(plex_score_dict)

Contents/Code/update_tools.py

@@ -124,6 +124,69 @@ def log_update_metadata(self):
 
 
 class AlbumUpdateTool(UpdateTool):
+    def set_date(self):
+        """
+            Sets the date.
+        """
+        if self.date is not None:
+            if not self.metadata.originally_available_at or self.force:
+                self.metadata.originally_available_at = self.date
+
+    def set_rating(self):
+        """
+            Sets the rating.
+        """
+        # We always want to refresh the rating
+        if self.rating:
+            self.metadata.rating = float(self.rating) * 2
+
+    def set_summary(self):
+        """
+            Sets the summary.
+        """
+        if not self.metadata.summary or self.force:
+            self.metadata.summary = self.synopsis
+
+    def set_studio(self):
+        """
+            Sets the studio.
+        """
+        if not self.metadata.studio or self.force:
+            self.metadata.studio = self.studio
+
+    def set_sort_title(self):
+        """
+            Sets the sort title.
+        """
+        # Add series/volume to sort title where possible.
+        series_with_volume = ''
+        if self.series and self.volume:
+            series_with_volume = self.series + ', ' + self.volume
+        # Only include subtitle in sort if not in a series
+        if not self.volume:
+            self.title = self.metadata.title
+        if not self.metadata.title_sort or self.force:
+            self.metadata.title_sort = ' - '.join(
+                filter(
+                    None, [(series_with_volume), self.title]
+                )
+            )
+
+    def set_title(self):
+        """
+            Sets the title.
+        """
+        # If the `simplify_title` option is selected, don't append subtitle
+        # and remove extra endings on the title
+        if self.prefs['simplify_title']:
+            album_title = self.simplify_title()
+        elif self.subtitle:
+            album_title = self.title + ': ' + self.subtitle
+        else:
+            album_title = self.title
+        if not self.metadata.title or self.force:
+            self.metadata.title = album_title
+
     def parse_api_response(self, response):
         """
             Parses keys from API into helper variables if they exist.