introduce regular expressions, upgrade to version 2

myTerminal · myTerminal · commit e3103ab4823f · 2019-03-18T00:32:04.000-05:00
diff --git a/README.md b/README.md
@@ -7,10 +7,13 @@
 
 A color-theme looper for Emacs 24.
 
+> Note: Breaking changes in version 2
+
 ![Demo](images/demo.gif)
 
 ## Background
-### (you can skip to Usage)
+
+### (You may directly skip to Usage)
 
 Emacs 24 comes with a set of pre-installed color-themes that can be enabled by a simple command like:
 
@@ -40,21 +43,45 @@ If you have MELPA-Stable, MELPA or Marmalade added as a repository to your Emacs
 
 ## Usage
 
-*Optional:* Set the list of your favorite color themes:
+### Set key-bindings to switch themes like a breeze
+
+    (global-set-key (kbd "C-|") 'theme-looper-enable-next-theme)
+    (global-set-key (kbd "C-\") 'theme-looper-enable-random-theme)
+
+### *Optional:* Set a list of your favorite color themes:
+
+By specifying a particular set of themes
+
+    (theme-looper-set-favorite-themes '(wombat tango-dark wheatgrass))
+
+or using a regular expression
 
-    (theme-looper-set-theme-set '(wombat tango-dark wheatgrass))
+    (theme-looper-set-favorite-themes-regexp "dark")
 
-*Optional:* Set the list of ignored themes:
+### *Optional:* Set a list of ignored themes:
+
+By specifying a particular set of themes
 
     (theme-looper-set-ignored-themes '(cobalt))
 
-*Optional:* Set both, in which case only the favorite themes that are not within the ones to be ignored are used.
+or using a regular expression
 
-Set up your key-bindings:
+    (theme-looper-set-ignored-themes-regexp "green")
 
-    (global-set-key (kbd "C-|") 'theme-looper-enable-next-theme)
-    (global-set-key (kbd "C-\") 'theme-looper-enable-random-theme)
+### *Optional:* Set both
+
+In this case, only the favorite themes that are not within the ones to be ignored are used.
+
+### More
+
+If you want to reset your color-theme preferences, simply use
+
+    (theme-looper-reset-themes-selection)
+
+You can set some script to be run after every theme switch
+
+    (theme-looper-set-post-switch-script 'my-func)
 
-Optional: Set additional customization to be applied after every theme switch:
+## Acknowledgments
 
-    (theme-looper-set-customizations 'my-func)
+Thanks to [protonpopsicle](https://github.com/protonpopsicle), [zombiefungus](https://github.com/zombiefungus) and [romildo](https://github.com/romildo) for their valuable inputs to suggest changes and enhancements.
diff --git a/theme-looper-tests.el b/theme-looper-tests.el
@@ -29,25 +29,25 @@
 (ert-deftest tl-test:setting-favorite-themes ()
   (unwind-protect
       (progn
-	;Should contain all themes as favorite by default
-	(should (equal theme-looper--favorite-themes 
+        ;;Should contain all themes as favorite by default
+	(should (equal theme-looper--favorite-themes
 		       (custom-available-themes)))
-	;Should set the themes provided as favorite
-	(theme-looper-set-theme-set (list 'wombat
-				'tango-dark
-				'wheatgrass))
-	(should (equal theme-looper--favorite-themes 
+        ;;Should set the themes provided as favorite
+	(theme-looper-set-favorite-themes (list 'wombat
+                                                'tango-dark
+                                                'wheatgrass))
+	(should (equal theme-looper--favorite-themes
 		       (list 'wombat
 			     'tango-dark
 			     'wheatgrass))))
-    (setq theme-looper--favorite-themes 
+    (setq theme-looper--favorite-themes
 	  (custom-available-themes))))
 
 (ert-deftest tl-test:disabling-enabled-themes ()
   (let ((current-theme (car custom-enabled-themes)))
     (unwind-protect
 	(progn
-	;Should be able to disable all enabled themes
+          ;;Should be able to disable all enabled themes
 	  (theme-looper--disable-all-themes)
 	  (should (equal custom-enabled-themes
 			 '())))
@@ -58,33 +58,33 @@
   (let ((current-theme (car custom-enabled-themes)))
     (unwind-protect
 	(progn
-	  (theme-looper-set-theme-set (list 'wombat
-				  'tango-dark
-				  'wheatgrass))
-	;Should identify the enabled theme
+	  (theme-looper-set-favorite-themes (list 'wombat
+                                                  'tango-dark
+                                                  'wheatgrass))
+          ;;Should identify the enabled theme
 	  (load-theme 'wombat
                       t)
-	  (should (equal (theme-looper--get-current-theme) 
+	  (should (equal (theme-looper--get-current-theme)
 			 'wombat))
-	;Should identify the next theme position in the list
+          ;;Should identify the next theme position in the list
 	  (should (equal (theme-looper--get-next-theme-index)
 			 1))
-	;Should identify the next theme
+          ;;Should identify the next theme
 	  (should (equal (theme-looper--get-next-theme)
 			 'tango-dark))
-	;Should default to first theme as next theme when
-	;current theme is not in the list
+          ;;Should default to first theme as next theme when
+          ;;current theme is not in the list
 	  (load-theme 'manoj-dark
                       t)
 	  (should (equal (theme-looper--get-next-theme)
 			 'wombat))
-	;Should loop back to the first theme when
-	;current theme is the last in the list
+          ;;Should loop back to the first theme when
+          ;;current theme is the last in the list
 	  (load-theme 'wheatgrass
                       t)
 	  (should (equal (theme-looper--get-next-theme)
 			 'wombat)))
-      (setq theme-looper--favorite-themes 
+      (setq theme-looper--favorite-themes
 	    (custom-available-themes))
       (load-theme current-theme
                   t))))
@@ -93,59 +93,59 @@
   (let ((current-theme (car custom-enabled-themes)))
     (unwind-protect
 	(progn
-	  (theme-looper-set-theme-set (list 'wombat
-				  'tango-dark
-				  'wheatgrass))
-	;Should select first theme when the selected theme in not in the list
+	  (theme-looper-set-favorite-themes (list 'wombat
+                                                  'tango-dark
+                                                  'wheatgrass))
+          ;;Should select first theme when the selected theme in not in the list
 	  (load-theme 'tango
                       t)
 	  (theme-looper-enable-next-theme)
 	  (should (equal custom-enabled-themes
 			 '(wombat)))
-	;Should proceed to the next theme
+          ;;Should proceed to the next theme
 	  (theme-looper-enable-next-theme)
 	  (should (equal custom-enabled-themes
 			 '(tango-dark)))
-	;Should loop back to the first theme when the cycle completes
+          ;;Should loop back to the first theme when the cycle completes
 	  (theme-looper-enable-next-theme)
 	  (theme-looper-enable-next-theme)
 	  (should (equal custom-enabled-themes
 			 '(wombat))))
-      (setq theme-looper--favorite-themes 
+      (setq theme-looper--favorite-themes
 	    (custom-available-themes))
       (load-theme current-theme
                   t))))
 
 (ert-deftest tl-test:adding-customization ()
   (let ((current-theme (car custom-enabled-themes))
-	(current-face-height (face-attribute 'default 
+	(current-face-height (face-attribute 'default
 					     :height)))
     (unwind-protect
 	(progn
-	   (message (concatenate 'string 
-			  "current-face-height: "
-			  (number-to-string current-face-height)))
-	  (theme-looper-set-theme-set (list 'wombat
-				  'tango-dark
-				  'wheatgrass))
-	;Should apply customizations when specified
+          (message (concatenate 'string
+                                "current-face-height: "
+                                (number-to-string current-face-height)))
+	  (theme-looper-set-favorite-themes (list 'wombat
+                                                  'tango-dark
+                                                  'wheatgrass))
+          ;;Should apply customizations when specified
 	  (load-theme 'tango
                       t)
-	  (theme-looper-set-customizations (lambda ()
-				   (set-face-attribute 'default nil 
-						       :height 120)))
+	  (theme-looper-set-post-switch-script (lambda ()
+                                             (set-face-attribute 'default nil
+                                                                 :height 120)))
 	  (theme-looper-enable-next-theme)
-	  (message (concatenate 'string 
-			  "found face-height: "
-			  (number-to-string (face-attribute 'default :height))))
+	  (message (concatenate 'string
+                                "found face-height: "
+                                (number-to-string (face-attribute 'default :height))))
 	  (should (< (abs  (- (face-attribute 'default :height)
 			      120))
 		     2)))
-      (setq theme-looper--favorite-themes 
+      (setq theme-looper--favorite-themes
 	    (custom-available-themes))
       (load-theme current-theme
                   t)
-      (set-face-attribute 'default nil 
+      (set-face-attribute 'default nil
 			  :height current-face-height))))
 
 ;;; theme-looper-tests.el ends here
diff --git a/theme-looper.el b/theme-looper.el
@@ -3,7 +3,7 @@
 ;; This file is not part of Emacs
 
 ;; Author: Mohammed Ismail Ansari <team.terminal@gmail.com>
-;; Version: 1.0
+;; Version: 2.0
 ;; Keywords: convenience, color-themes
 ;; Maintainer: Mohammed Ismail Ansari <team.terminal@gmail.com>
 ;; Created: 2014/03/22
@@ -33,28 +33,40 @@
 ;;
 ;;     (require 'theme-looper)
 ;;
-;; And set a key-binding for cycling thru themes
+;; And set a key-bindings for cycling thru themes
 ;;
 ;;     (global-set-key (kbd "C-|") 'theme-looper-enable-next-theme)
 ;;
 ;; Or you can switch to a random theme
 ;;
 ;;     (global-set-key (kbd "C-\\") 'theme-looper-enable-random-theme)
 ;;
-;; You can also set your list of favorite themes
+;; You can also set a list of your favorite themes
 ;;
-;;     (theme-looper-set-theme-set '(wombat tango-dark wheatgrass))
+;;     (theme-looper-set-favorite-themes '(wombat tango-dark wheatgrass))
 ;;
-;; You can alternatively set the ignored themes
+;; or to use regular expressions
+;;
+;;     (theme-looper-set-favorite-themes-regexp "dark")
+;;
+;; You can alternatively set the themes to be ignored
 ;;
 ;;     (theme-looper-set-ignored-themes '(cobalt))
 ;;
+;; or to use regular expressions
+;;
+;;     (theme-looper-set-ignored-themes-regexp "green")
+;;
 ;; Or you can set both, in which case only the favorite themes that are not
 ;; within the ones to be ignored are used.
 ;;
-;; You can set customization to be applied after every theme switch
+;; If you want to reset your color-theme preferences, simply use
 ;;
-;;     (theme-looper-set-customizations my-func)
+;;     (theme-looper-reset-themes-selection)
+;;
+;; You can set some script to be run after every theme switch
+;;
+;;     (theme-looper-set-post-switch-script my-func)
 ;;
 
 ;;; Commentary:
@@ -82,23 +94,47 @@
     nil)
 
 ;;;###autoload
-(defun theme-looper-set-theme-set (themes)
+(defun theme-looper-set-favorite-themes (themes)
   "Sets the list of color-themes to cycle thru"
   (setq theme-looper--favorite-themes
 	themes))
 
+;;;###autoload
+(defun theme-looper-set-favorite-themes-regexp (regexp)
+  "Sets the list of color-themes to cycle thru, matching a regular expression"
+  (setq theme-looper--favorite-themes
+        (cl-remove-if-not (lambda (theme)
+                            (string-match-p regexp
+                                            (symbol-name theme)))
+                          (custom-available-themes))))
+
 ;;;###autoload
 (defun theme-looper-set-ignored-themes (themes)
   "Sets the list of color-themes to ignore"
   (setq theme-looper--ignored-themes
 	themes))
 
 ;;;###autoload
-(defun theme-looper-set-customizations (func)
-  "Sets customization to be applied after every theme switch"
+(defun theme-looper-set-ignored-themes-regexp (regexp)
+  "Sets the list of color-themes to ignore, matching a regular expression"
+  (setq theme-looper--ignored-themes
+        (cl-remove-if-not (lambda (theme)
+                            (string-match-p regexp
+                                            (symbol-name theme)))
+                          (custom-available-themes))))
+
+;;;###autoload
+(defun theme-looper-set-post-switch-script (func)
+  "Sets script to be run after every theme switch"
   (setq theme-looper--further-customize
         func))
 
+;;;###autoload
+(defun theme-looper-reset-themes-selection ()
+  "Resets themes selection back to default"
+  (theme-looper-set-favorite-themes (custom-available-themes))
+  (theme-looper-set-ignored-themes nil))
+
 (defun theme-looper--get-current-theme ()
   "Determines the currently enabled theme"
   (car custom-enabled-themes))
@@ -163,7 +199,7 @@
                                       (theme-looper--get-looped-themes))))
     (theme-looper-enable-theme theme-looper-next-theme)))
 
-(theme-looper-set-theme-set (custom-available-themes))
+(theme-looper-reset-themes-selection)
 
 (provide 'theme-looper)
 
