Added renumbering option; embed license in source files

Kurtis LoVerde · Kurtis LoVerde · commit b591d2ee20fc · 2016-08-28T14:34:25.000-04:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+/.project
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## Release 1.1 (August 28, 2016)
+
+* Added an option to renumber id and name attributes to ensure they remain contiguous
+
+
 ## Release 1.0 (August 28, 2016)
 
 * First release
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-AddRemoveTextbox v1.0
+AddRemoveTextbox v1.1
 =====================
 
 See LICENSE for this software's licensing terms.
@@ -12,6 +12,7 @@ AddRemoveTextbox is a jQuery plugin which provides for dynamic creation and remo
 * Configurable CSS classes for the 'add' and 'remove' buttons
 * Configurable tooltips for the 'add' and 'remove' buttons
 * Configurable limit on the number of input fields
+* Able to renumber id and name attributes to keep them contiguous (enabled through a configuration option)
 
 
 ## jQuery Compatibility
@@ -80,6 +81,8 @@ See the included HTML file for more in-depth examples.
 | `removeButtonClass` | A CSS class to style the 'Remove' button.  The generated HTML will be a &lt;span&gt;, so it is assumed that you will use CSS to define background image. | removeButton |
 | `removeButtonTooltip` | Hover text for the 'Remove' button | null |
 | `maxFields` | An optional limit on the number of fields which may exist under the applicable ID prefix.  If a value is specified, it must be an integer greater than 1. | null (no limit) |
+| `contiguous` | If `true`, renumber the `id` and `name` attributes upon initialization and when a row is removed.  Renumbering is based on DOM order, not `id` or `name` values, and starts on the value specified by `startingNumber`.  This setting is disabled by default because it can break applications. | false |
+| `startingNumber` | This setting is used only when `contiguous` is set to `true`. | null |
 
 
 ## Thanks
diff --git a/demo/css/demo.css b/demo/css/demo.css
@@ -1,13 +1,34 @@
 /*
- * AddRemoveTextbox v1.0
+ * AddRemoveTextbox v1.1
  * https://www.github.com/kloverde/jquery-AddRemoveTextbox
  *
- *  This software is licensed under the 3-clause BSD license.
+ * Donations:  https://paypal.me/KurtisLoVerde/5
  *
- * Copyright (c) 2016 Kurtis LoVerde
- * All rights reserved
+ * Copyright (c) 2016, Kurtis LoVerde
+ * All rights reserved.
  *
- * Donations:  https://paypal.me/KurtisLoVerde/5
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ *    1. Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *    2. Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *    3. Neither the name of the copyright holder nor the names of its
+ *       contributors may be used to endorse or promote products derived from
+ *       this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 .txtBoxRow {
diff --git a/demo/demo.html b/demo/demo.html
@@ -1,13 +1,36 @@
 <!DOCTYPE html>
 
 <!--
-   AddRemoveTextbox v1.0
+   AddRemoveTextbox v1.1
    https://www.github.com/kloverde/jquery-AddRemoveTextbox
-
-   Copyright (c) 2016 Kurtis LoVerde
-   All rights reserved
-
+  
    Donations:  https://paypal.me/KurtisLoVerde/5
+  
+   Copyright (c) 2016, Kurtis LoVerde
+   All rights reserved.
+  
+   Redistribution and use in source and binary forms, with or without
+   modification, are permitted provided that the following conditions are met:
+  
+      1. Redistributions of source code must retain the above copyright
+         notice, this list of conditions and the following disclaimer.
+      2. Redistributions in binary form must reproduce the above copyright
+         notice, this list of conditions and the following disclaimer in the
+         documentation and/or other materials provided with the distribution.
+      3. Neither the name of the copyright holder nor the names of its
+         contributors may be used to endorse or promote products derived from
+         this software without specific prior written permission.
+  
+   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+   ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+   DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+   FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+   DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+   SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+   CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 -->
 
 <html lang="en-US">
@@ -62,14 +85,15 @@
 
             // Example 4
 
-            $( "#stuff1" ).addRemoveTextbox( {
+            $( "#renumber4" ).addRemoveTextbox( {
                addButtonClass      : "addRemoveButton imgAdd",
                addButtonTooltip    : "Add",
                removeButtonClass   : "addRemoveButton imgRemove",
-               removeButtonTooltip : "Remove"
+               removeButtonTooltip : "Remove",
+               contiguous          : true
             } );
 
-            // Example 5
+            // Example 6
 
             $( "#maxFields1" ).addRemoveTextbox( {
                addButtonClass    : "addRemoveButton imgAdd",
@@ -146,13 +170,40 @@ <h3>Example 4:  Pre-existing fields, IDs out of order and with gaps</h3>
          </div>
       </div>
 
-      <h3>Example 5:  Setting a limit on how many fields can be generated</h3>
+      <h3>Example 5 - Renumbering:  Pre-existing fields, IDs out of order and with gaps</h3>
+      <p>
+         These fields' IDs and names remain contiguous.  Compare what the code says to what
+         your favorite DOM inspector says.  This functionality is disabled by default
+         because it can break applications.  Be sure that your application can handle
+         changing IDs and names before using this.
+      </p>
+
+      <div id="example5">
+         <div class="txtBoxRow">
+            <input type="text" id="renumber3" name="renumber3" value="Hello"/>
+         </div>
+
+         <div class="txtBoxRow">
+            <input type="text" id="renumber8" name="renumber8" value="Konichiwa"/>
+         </div>
+
+         <div class="txtBoxRow">
+            <input type="text" id="renumber6" name="renumber6" value="Bonjour"/>
+         </div>
+
+         <div class="txtBoxRow">
+            <input type="text" id="renumber4" name="renumber4" value="Hola"/>
+         </div>
+      </div>
+
+
+      <h3>Example 6:  Setting a limit on how many fields can be generated</h3>
       <p>
          This is set to allow 3 fields.  You won't be able to add more after that,
          but if you delete one of them, you'll be able to add one again.
       </p>
 
-      <div id="example5">
+      <div id="example6">
          <div class="txtBoxRow">
             <input type="text" id="maxFields1" name="maxFields1"/>
          </div>
diff --git a/jquery.addremovetextbox.js b/jquery.addremovetextbox.js
@@ -1,15 +1,37 @@
 /*
- * AddRemoveTextbox v1.0
+ * AddRemoveTextbox v1.1
  * https://www.github.com/kloverde/jquery-AddRemoveTextbox
  *
- * This software is licensed under the 3-clause BSD license.
+ * Donations:  https://paypal.me/KurtisLoVerde/5
  *
- * Copyright (c) 2016 Kurtis LoVerde
- * All rights reserved
+ * Copyright (c) 2016, Kurtis LoVerde
+ * All rights reserved.
  *
- * Donations:  https://paypal.me/KurtisLoVerde/5
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ *    1. Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *    2. Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *    3. Neither the name of the copyright holder nor the names of its
+ *       contributors may be used to endorse or promote products derived from
+ *       this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+
 (function( $ ) {
    "use strict";
 
@@ -32,7 +54,15 @@
 
          // A limit on the number of fields which may exist under the applicable ID prefix.  Default
          // is null (no limit).  If a value is specified, it must be an integer greater than 1.
-         maxFields           : null
+         maxFields           : null,
+
+         // If true, renumber the id and name attributes upon initialization and when a row is removed.
+         // Renumbering is based on DOM order, not `id` or `name` values, and starts on the value
+         // specified by `startingNumber`.  This setting is disabled by default because it can break applications.
+         contiguous          : false,
+
+         // This setting is used only when 'contiguous' is set to true.
+         startingNumber      : 0
       }, options );
 
       var ID_PREFIX = this.attr( "id" ).replace( /\[?[0-9]*\]?$/, "" );
@@ -59,6 +89,22 @@
          }
       }
 
+      if( settings.contiguous === true ) {
+         if( settings.startingNumber != null ) {
+            var errMsg = "startingNumber (" + settings.startingNumber + ") must be an integer greater than or equal to 0";
+
+            if( isNaN(settings.startingNumber) ) {
+               throwException( errMsg );
+            } else {
+               settings.startingNumber = parseInt( settings.startingNumber );
+
+               if( settings.startingNumber < 0 || settings.startingNumber % 1 !== 0 ) {
+                  throwException( errMsg );
+               }
+            }
+         }
+      }
+
       init( this );
 
       function throwException( msg ) {
@@ -83,6 +129,8 @@
                makeAddButton().appendTo( parentRow );
             }
          } );
+
+         rebuild();
       }
 
       function makeButton( className, title ) {
@@ -214,11 +262,28 @@
             }
 
             rowToRemove.remove();
+            rebuild();
          } else {
             $( escape("#" + inputId) ).val( "" );
          }
       }
 
+      function rebuild() {
+         if( settings.contiguous === true ) {
+            var currNum = settings.startingNumber;
+
+            $( "input[id^=" + ID_PREFIX + "]" ).each( function() {
+               var field = $(this);
+               var newId = IS_ARRAY_NOTATION ? ID_PREFIX + "[" + currNum + "]"
+                                             : ID_PREFIX + currNum;
+               field.attr( "id", newId );
+               field.attr( "name", newId );
+
+               currNum++;
+            } );
+         }
+      }
+
       function escape( selector ) {
          return selector.replace( /(\[|\])/g, "\\$1" );
       }
diff --git a/jquery.addremovetextbox.min.js b/jquery.addremovetextbox.min.js
