Combined pull requests (status, BOM handling, sequential ordering, version conflict detection, etc)

.gitignore

@@ -9,4 +9,4 @@ ibderby
 atlassian-ide-plugin.xml
 .classpath
 .project
-.settings
+.settings

README.md

@@ -15,7 +15,7 @@ Install MyBatis Migrations ${project.version} (${implementation.build})
 
   See the reference documentation here http://mybatis.github.io/migrations/
 
-* Windows
+### Windows
 
   [1] Unzip the distribution archive, i.e. mybatis-${project.version}-migrations.zip to the directory you wish
       to install MyBatis Migrations.
@@ -33,7 +33,7 @@ Install MyBatis Migrations ${project.version} (${implementation.build})
   [4] In the same dialog, update/create the Path environment variable in the user variables and prepend the value
       %MIGRATIONS% to add MyBatis Migrations available in the command line.
 
-* Unix-based Operating Systems (Linux, Solaris and Mac OS X)
+### Unix-based Operating Systems (Linux, Solaris and Mac OS X)
 
   [1] Extract the distribution archive, i.e. mybatis-${project.version}-migrations.zip to the directory you wish to
       install MyBatis Migrations. These instructions assume you chose

src/main/java/org/apache/ibatis/migration/Change.java

@@ -70,7 +70,9 @@ public void setFilename(String filename) {
   }
 
   public String toString() {
-    return id + " " + (appliedTimestamp == null ? "   ...pending...   " : appliedTimestamp) + " " + description;
+    String status = appliedTimestamp == null ? "   ...pending...   " : appliedTimestamp;
+    String message = filename == null ? " ...missing script... " : " ";
+    return id + " " + status + message + description;
   }
 
   public boolean equals(Object o) {
@@ -83,14 +85,16 @@ public boolean equals(Object o) {
 
     Change change = (Change) o;
 
-    return (id.equals(change.getId()));
+    return (id.equals(change.getId())) && (description == null ? change.getDescription() == null : description.equals(change.getDescription()));
   }
 
   public int hashCode() {
-    return id.hashCode();
+    return id.hashCode() ^ (description == null ? 0 : description.hashCode());
   }
 
   public int compareTo(Change change) {
-    return id.compareTo(change.getId());
+    return id.compareTo(change.getId()) != 0 ? id.compareTo(change.getId())
+        : (description == null ? (change.getDescription() == null ? 0 : 1)
+            : description.compareTo(change.getDescription()));
   }
 }

src/main/java/org/apache/ibatis/migration/ChangeValidator.java

@@ -0,0 +1,57 @@
+package org.apache.ibatis.migration;
+
+import java.math.BigDecimal;
+import java.util.Properties;
+import java.util.regex.Pattern;
+
+public class ChangeValidator {
+  private static final String CUSTOM_FILE_NAME_FILTER_PROPERTY = "filename_filter";
+
+  /**
+   * @param change to validate
+   * @param properties Environmental configuration
+   * @throws MigrationException
+   */
+  public static void validateChangeForConfiguration(Change change, Properties properties)
+    throws MigrationException {
+  String filename = change.getFilename();
+    String filenameFilter = properties.getProperty(CUSTOM_FILE_NAME_FILTER_PROPERTY);
+    if (filenameFilter != null) {
+      Pattern p = null;
+      try {
+      p = Pattern.compile(filenameFilter, Pattern.CASE_INSENSITIVE);
+      } catch (Exception ex) {
+      throw new MigrationException("Exception parsing the value in your environmental configuration for the filename filter of " + filenameFilter, ex);
+      }
+    if (!p.matcher(filename).find()) {
+      throw new MigrationException("The change filename " + filename +  " does not match the required filename filter of " + filenameFilter);
+    }
+    }
+  }
+
+  /**
+   * @param filename
+   * @param properties Environmental configuration
+   * @return Change
+   */
+  public static Change parseChangeFromFilename(String filename, Properties properties) {
+    try {
+      Change change = new Change();
+      int lastIndexOfDot = filename.lastIndexOf(".");
+      String[] parts = filename.substring(0, lastIndexOfDot).split("_");
+      change.setId(new BigDecimal(parts[0]));
+      StringBuilder builder = new StringBuilder();
+      for (int i = 1; i < parts.length; i++) {
+        if (i > 1) {
+          builder.append(" ");
+        }
+        builder.append(parts[i]);
+      }
+      change.setDescription(builder.toString());
+      change.setFilename(filename);
+      return change;
+    } catch (Exception e) {
+      throw new MigrationException("Error parsing change from filename.  Cause: " + e, e);
+    }
+  }
+}

src/main/java/org/apache/ibatis/migration/CommandLine.java

@@ -122,7 +122,7 @@ private void printUsage() {
     console.printf("  info               Display build version informations.%n");
     console.printf("  init               Creates (if necessary) and initializes a migration path.%n");
     console.printf("  bootstrap          Runs the bootstrap SQL script (see scripts/bootstrap.sql for more).%n");
-    console.printf("  new <description>  Creates a new migration with the provided description.%n");
+    console.printf("  new <desc> [n]     Creates a new migration with the provided description and 'n' version.%n");
     console.printf("  up [n]             Run unapplied migrations, ALL by default, or 'n' specified.%n");
     console.printf(
         "  down [n]           Undoes migrations applied to the database. ONE by default or 'n' specified.%n");

src/main/java/org/apache/ibatis/migration/FileMigrationLoader.java

@@ -18,7 +18,6 @@
 import java.io.File;
 import java.io.IOException;
 import java.io.Reader;
-import java.math.BigDecimal;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -27,6 +26,7 @@
 import org.apache.ibatis.migration.utils.Util;
 
 public class FileMigrationLoader implements MigrationLoader {
+
   private final File scriptsDir;
 
   private final String charset;
@@ -51,35 +51,15 @@ public List<Change> getMigrations() {
       Arrays.sort(filenames);
       for (String filename : filenames) {
         if (filename.endsWith(".sql") && !"bootstrap.sql".equals(filename)) {
-          Change change = parseChangeFromFilename(filename);
+          Change change = ChangeValidator.parseChangeFromFilename(filename, properties);
+          ChangeValidator.validateChangeForConfiguration (change, properties);
           migrations.add(change);
         }
       }
     }
     return migrations;
   }
 
-  private Change parseChangeFromFilename(String filename) {
-    try {
-      Change change = new Change();
-      int lastIndexOfDot = filename.lastIndexOf(".");
-      String[] parts = filename.substring(0, lastIndexOfDot).split("_");
-      change.setId(new BigDecimal(parts[0]));
-      StringBuilder builder = new StringBuilder();
-      for (int i = 1; i < parts.length; i++) {
-        if (i > 1) {
-          builder.append(" ");
-        }
-        builder.append(parts[i]);
-      }
-      change.setDescription(builder.toString());
-      change.setFilename(filename);
-      return change;
-    } catch (Exception e) {
-      throw new MigrationException("Error parsing change from file.  Cause: " + e, e);
-    }
-  }
-
   @Override
   public Reader getScriptReader(Change change, boolean undo) {
     try {
@@ -101,4 +81,5 @@ public Reader getBootstrapReader() {
       throw new MigrationException("Error reading bootstrap.sql", e);
     }
   }
+
 }

src/main/java/org/apache/ibatis/migration/MigrationReader.java

@@ -33,6 +33,8 @@
 import java.util.Set;
 
 public class MigrationReader extends Reader {
+  // FEFF because this is the Unicode char represented by the UTF-8 byte order mark (EF BB BF).
+  public static final String UTF8_BOM = "\uFEFF";
 
   private static final String LINE_SEPARATOR = System.getProperty("line.separator", "\n");
 
@@ -51,7 +53,15 @@ public MigrationReader(InputStream inputStream, String charset, boolean undo, Pr
       StringBuilder undoBuilder = new StringBuilder();
       StringBuilder currentBuilder = doBuilder;
       String line;
+      boolean firstLine = true;
+
       while ((line = reader.readLine()) != null) {
+        if (firstLine) {
+          if ("UTF-8".equalsIgnoreCase(charset) && line.startsWith(UTF8_BOM)) {
+            line = line.substring(1);
+          }
+          firstLine = false;
+        }
         if (line.trim().matches("^--\\s*//.*$")) {
           if (line.contains("@UNDO")) {
             currentBuilder = undoBuilder;

src/main/java/org/apache/ibatis/migration/commands/BaseCommand.java

@@ -15,39 +15,28 @@
  */
 package org.apache.ibatis.migration.commands;
 
-import static org.apache.ibatis.migration.utils.Util.*;
-
-import java.io.File;
-import java.io.FileInputStream;
-import java.io.FileWriter;
-import java.io.IOException;
-import java.io.LineNumberReader;
-import java.io.PrintStream;
-import java.io.PrintWriter;
-import java.net.URL;
-import java.net.URLClassLoader;
-import java.text.SimpleDateFormat;
-import java.util.ArrayList;
-import java.util.Date;
-import java.util.List;
-import java.util.Properties;
-import java.util.TimeZone;
-
 import org.apache.ibatis.datasource.unpooled.UnpooledDataSource;
 import org.apache.ibatis.io.ExternalResources;
 import org.apache.ibatis.io.Resources;
-import org.apache.ibatis.migration.ConnectionProvider;
-import org.apache.ibatis.migration.DataSourceConnectionProvider;
-import org.apache.ibatis.migration.FileMigrationLoader;
-import org.apache.ibatis.migration.MigrationException;
-import org.apache.ibatis.migration.MigrationLoader;
+import org.apache.ibatis.migration.*;
 import org.apache.ibatis.migration.options.DatabaseOperationOption;
 import org.apache.ibatis.migration.options.SelectedOptions;
 import org.apache.ibatis.migration.options.SelectedPaths;
 import org.apache.ibatis.parsing.PropertyParser;
 
+import java.io.*;
+import java.net.URL;
+import java.net.URLClassLoader;
+import java.text.SimpleDateFormat;
+import java.util.*;
+
+import static org.apache.ibatis.migration.utils.Util.file;
+
 public abstract class BaseCommand implements Command {
   private static final String DATE_FORMAT = "yyyyMMddHHmmss";
+  private static final String FILENAME_SEQUENCE_NUMBER_PADDING = "sequence_number_padding";
+
+  private Properties envProperties;
 
   private ClassLoader driverClassLoader;
 
@@ -83,6 +72,48 @@ protected String changelogTable() {
   }
 
   protected String getNextIDAsString() {
+    if (getDatabaseOperationOption().useSequenceNumber()) {
+      return getNextSequenceNumberAsIdString();
+    }
+
+    return getNextTimestampIDAsString();
+  }
+
+  protected String getNextSequenceNumberAsIdString() {
+    // if script directory is empty, use the initial sequence
+    if (paths.getScriptPath().list().length==0) {
+      return getDatabaseOperationOption().getInitialSequence().toString();
+    }
+
+    // else, initialise with the largest seq number from scripts dir and increment by 1
+    File[] sqlFiles = paths.getScriptPath().listFiles();
+
+    Arrays.sort(
+            sqlFiles,
+            new Comparator<File>() {
+              public int compare(File a, File b) {
+                return sequenceNumberOfFile(a.getName()).compareTo(sequenceNumberOfFile(b.getName()));
+              }
+            });
+
+    File lastFile = sqlFiles[sqlFiles.length - 1];
+    Integer nextSeqNumber = sequenceNumberOfFile(lastFile.getName()) + 1;
+    Integer zerosToPadd = Integer.valueOf(environmentProperties().getProperty(FILENAME_SEQUENCE_NUMBER_PADDING, "1"));
+
+    return String.format("%0" + zerosToPadd + "d", nextSeqNumber);
+  }
+
+  private Integer sequenceNumberOfFile(String fileName) {
+    try {
+      return Integer.valueOf(fileName.substring(0, fileName.indexOf("_")));
+    } catch (StringIndexOutOfBoundsException e) {
+    } catch (NumberFormatException e) {}
+
+    // File does not have any numbers. Will ignore this and make this the same as the initial number
+    return getDatabaseOperationOption().getInitialSequence() - 1;
+  }
+
+  protected String getNextTimestampIDAsString() {
     try {
       // Ensure that two subsequent calls are less likely to return the same value.
       Thread.sleep(1000);
@@ -149,24 +180,27 @@ protected File existingEnvironmentFile() {
   }
 
   protected Properties environmentProperties() {
-    FileInputStream fileInputStream = null;
-    try {
-      File file = existingEnvironmentFile();
-      Properties props = new Properties();
-      fileInputStream = new FileInputStream(file);
-      props.load(fileInputStream);
-      return props;
-    } catch (IOException e) {
-      throw new MigrationException("Error loading environment properties.  Cause: " + e, e);
-    } finally {
-      if (fileInputStream != null) {
-        try {
-          fileInputStream.close();
-        } catch (IOException e) {
-          // Nothing to do here
+    if (envProperties == null) {
+      FileInputStream fileInputStream = null;
+      try {
+        File file = existingEnvironmentFile();
+        Properties props = new Properties();
+        fileInputStream = new FileInputStream(file);
+        props.load(fileInputStream);
+        envProperties = props;
+      } catch (IOException e) {
+        throw new MigrationException("Error loading environment properties.  Cause: " + e, e);
+      } finally {
+        if (fileInputStream != null) {
+          try {
+            fileInputStream.close();
+          } catch (IOException e) {
+            // Nothing to do here
+          }
         }
       }
     }
+    return envProperties;
   }
 
   protected int getStepCountParameter(int defaultSteps, String... params) {
@@ -246,6 +280,10 @@ protected DatabaseOperationOption getDatabaseOperationOption() {
     option.setRemoveCRs(Boolean.valueOf(props.getProperty("remove_crs")));
     String delimiterString = props.getProperty("delimiter");
     option.setDelimiter(delimiterString == null ? ";" : delimiterString);
+    option.setUseSequenceNumber(Boolean.valueOf(props.getProperty("use_sequence_number")));
+    if (option.useSequenceNumber()) {
+      option.setInitialSequence(Integer.valueOf(props.getProperty("initial_sequence_number")));
+    }
     return option;
   }
 }