Added customValues option to specify custom cron entries.

Author: shawnchin

cron/jquery-cron.js

@@ -92,6 +92,7 @@
             hideOnMouseOut : true
         },
         url_set : undefined,
+        customValues : undefined,
         onChange: undefined // callback function each time value changes
     };
 
@@ -156,20 +157,24 @@
     };
 
     var combinations = {
-        "minute" : /^(\*\s){4}\*$/,               // "* * * * *"
-        "hour"   : /^\d{1,2}\s(\*\s){3}\*$/,      // "? * * * *"
-        "day"    : /^(\d{1,2}\s){2}(\*\s){2}\*$/, // "? ? * * *"
+        "minute" : /^(\*\s){4}\*$/,                    // "* * * * *"
+        "hour"   : /^\d{1,2}\s(\*\s){3}\*$/,           // "? * * * *"
+        "day"    : /^(\d{1,2}\s){2}(\*\s){2}\*$/,      // "? ? * * *"
         "week"   : /^(\d{1,2}\s){2}(\*\s){2}\d{1,2}$/, // "? ? * * ?"
-        "month"  : /^(\d{1,2}\s){3}\*\s\*$/, // "? ? ? * *"
-        "year"   : /^(\d{1,2}\s){4}\*$/ // "? ? ? ? *"
+        "month"  : /^(\d{1,2}\s){3}\*\s\*$/,           // "? ? ? * *"
+        "year"   : /^(\d{1,2}\s){4}\*$/                // "? ? ? ? *"
     };
-
+    
     // ------------------ internal functions ---------------
     function defined(obj) {
         if (typeof obj == "undefined") { return false; }
         else { return true; }
     }
 
+    function undefinedOrObject(obj) {
+        return (!defined(obj) || typeof obj == "object")
+    }
+    
     function getCronType(cron_str) {
         // check format of initial cron value
         var valid_cron = /^((\d{1,2}|\*)\s){4}(\d{1,2}|\*)$/
@@ -203,14 +208,18 @@
 
     function hasError(c, o) {
         if (!defined(getCronType(o.initial))) { return true; }
+        if (!undefinedOrObject(o.customValues)) { return true; }
         return false;
     }
 
     function getCurrentValue(c) {
         var b = c.data("block");
         var min = hour = day = month = dow = "*";
-
-        switch (b["period"].find("select").val()) {
+        var selectedPeriod = b["period"].find("select").val();
+        switch (selectedPeriod) {
+            case "minute":
+                break;
+                
             case "hour":
                 min = b["mins"].find("select").val();
                 break;
@@ -238,6 +247,10 @@
                 day  = b["dom"].find("select").val();
                 month = b["month"].find("select").val();
                 break;
+
+            default:
+                // we assume this only happens when customValues is set
+                return selectedPeriod;
         }
         return [min, hour, day, month, dow].join(" ");
     }
@@ -264,10 +277,15 @@
 
             // ---- define select boxes in the right order -----
 
-            var block = []
+            var block = [], custom_periods = "", cv = o.customValues;
+            if (defined(cv)) { // prepend custom values if specified
+                for (var key in cv) {
+                    custom_periods += "<option value='" + cv[key] + "'>" + key + "</option>\n";
+                }
+            }
             block["period"] = $("<span class='cron-period'>"
-                    + "Every <select name='cron-period'>" + str_opt_period 
-                    + "</select> </span>")
+                    + "Every <select name='cron-period'>" + custom_periods 
+                    + str_opt_period + "</select> </span>")
                 .appendTo(this)                               
                 .find("select")
                     .bind("change.cron", event_handlers.periodChanged)
@@ -395,12 +413,15 @@
     var event_handlers = {
         periodChanged : function() {
             var root = $(this).data("root");
-            var block = root.data("block");
-            var b = toDisplay[$(this).val()];
-            
-            root.find("span.cron-block").hide(); // first, hide all blocks            
-            for (var i = 0; i < b.length; i++) {
-                block[b[i]].show();
+            var block = root.data("block"),
+                opt = root.data("options");
+            var period = $(this).val();
+            root.find("span.cron-block").hide(); // first, hide all blocks
+            if (toDisplay.hasOwnProperty(period)) { // not custom value
+                var b = toDisplay[$(this).val()];
+                for (var i = 0; i < b.length; i++) {
+                    block[b[i]].show();
+                }
             }
         },
 

index.html

@@ -41,6 +41,16 @@
                 openSpeed: "slow"
             }
         });
+        $('#example3').cron({
+            initial: "42 3 * * 5",
+            onChange: function() {
+                $('#example3-val').text($(this).cron("value"));
+            },
+            customValues: {
+                "5 Minutes" : "*/5 * * * *",
+                "2 Hours on Weekends" : "0 */2 * * 5,6"
+            }
+        });
     });
     </script>
 </head>
@@ -66,7 +76,13 @@ <h2 id='intro'>Introduction</h2>
     </div>
 
     <p>
-    There is much room for improvements, and we welcome contributions 
+    In addition, the <a href='#option-customvalues'><tt>customValues</tt></a>
+    option can be used to provide a list of canned cron entries. This allow users to
+    cater for common use cases as well as enable more complex cron entries.
+    </p>
+    
+    <p>
+    There is much room for improvements and we welcome contributions
     and bug fixes. Feel free to fork <a href='https://github.com/shawnchin/jquery-cron'>the project</a> 
     and send us pull requests!
     </p>
@@ -255,6 +271,43 @@ <h3 id='option-each-element'>Customising individual select boxes</h3>
 </pre>
 
     </p>
+
+    <h3 id='option-customvalues'>Adding custom values</h3>
+    <p>
+    Additional entries can be included in the period selection using the <tt>customValues</tt>
+    option. This allows you to specify more complex cron entries that is not currently expressible
+    using the current setup.
+    </p>
+    <p>
+    For example, the following adds two additional entries to the selection:
+        <pre>
+$('#selector').cron({
+    customValues: {
+        "5 Minutes" : "*/5 * * * *",
+        "2 Hours on Weekends" : "0 */2 * * 5,6"
+    }
+});
+</pre>
+    </p>
+
+    <div class='example'>
+        <div id='example3'></div>
+        <p>Generated cron entry: <span class='example-text' id='example3-val'></span></p>
+    </div>
+
+    <p>
+    <b>Caveats:</b>
+    <ul>
+        <li>
+            At present, cron entries specified in <tt>customValues</tt> are not validated.
+            It is down to the implementer to ensure that provided values are as required.
+        </li>
+        <li>
+            The <a href='#method-value'><tt>value</tt></a> method can be used to retrieve
+            custom cron values. However, it cannot be used to set custom values.
+        </li>
+    </ul>
+    </p>
     <h2>Methods</h2>
     <h3 id='method-value'>value</h3>
     <p>