Merge branch 'release/1.1.0'

Author: pbchase

CHANGELOG.md

@@ -2,6 +2,13 @@
 All notable changes to the REDCap Deployment project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.1.0] - 2017-05-31
+### Added
+- Add documentation for language configuration (marlycormar)
+- Modify deploy_language_to_build_space function to allow either a list or a folder as a language configuration (marlycormar)
+
+### Changed
+- Don't load any database upgrade scripts with a version number higher than the version you are upgrading to (Philip Chase)
 
 ## [1.0.2] - 2017-05-25
 ### Added

README.md

@@ -105,9 +105,9 @@ If you have problems install or using these libraries, you might be well-served
 ### Configure Fabric for the Virtual Machine
 
 The Fabric tools need to be configured for the Vagrant VM before they can be used.
-Copy the file settings/example.vagrant.ini to the name settings/vagrant.ini customize it to your needs.
+Copy the file settings/vagrant.ini.example to the name settings/vagrant.ini customize it to your needs.
 
-    cp settings/example.vagrant.ini settings/vagrant.ini
+    cp settings/vagrant.ini.example settings/vagrant.ini
 
 Customization is not _required_ but it is useful to add patches and language modules.
 
@@ -132,6 +132,12 @@ If the tests fail and the server is offline, you can put it back online with
 
     fab vagrant online
 
+## Language Configuration
+
+REDCap languages can be provided by modifying the _languages_ variable accordingly:
+as a json list, e.g., languages = ["Chinese.6.4.3.ini", "German.ini"], or
+as a file, i.e., languages = <languageFolder>, in which case the language files *.ini must be located inside the specified folder
+
 
 ## Contributions
 

package.py

@@ -128,14 +128,21 @@ def deploy_extension_to_build_space(source_dir="", build_target=""):
 
 
 def deploy_language_to_build_space():
-    target_dir = env.builddir + "/redcap/languages/"
-    for language in json.loads(env.languages):
-        if os.path.exists(language):
-            local("mkdir -p %s" % target_dir)
-            local('cp %s %s' % (language, target_dir))
-        else:
-            abort("the language file %s does not exist" % language)
-
+    source_dir = env.languages
+    target_dir = env.builddir + "/redcap/languages"
+
+    if re.match(r'^\[.+\]$', source_dir) is not None:
+        for language in json.loads(env.languages):
+            if os.path.exists(language):
+                local("mkdir -p %s" % target_dir)
+                local('cp %s %s' % (language, target_dir))
+            else:
+                abort("the language file %s does not exist" % language)
+    elif local('find %s/*.ini -maxdepth 1 -type f | wc -l' % source_dir, capture = True) != '0':
+        if os.path.exists(source_dir) and os.path.exists(target_dir):
+            local('find %s/*.ini -maxdepth 1 -type f -exec rsync {} %s \;' %(source_dir, target_dir))
+    else:
+        print("Warning: The languages where not provided. English will be used by default.")
 
 def apply_patches():
     for repo in json.loads(env.patch_repos):

settings/vagrant.ini.example

@@ -51,7 +51,7 @@ deploy_redcap_cron = True
 # Each repo needs files BASH script named deploy.sh at the root that will install the patch into a unzipped REDCap installation
 patch_repos = [  ]
 
-
-# List REDCap language file names as quoted strings. Separate multiple language files with commas.  e.g.
-#   languages = [ "Chinese.6.4.3.ini", "German.ini" ]
-languages = [  ]
+# REDCap languages can be provided by modifying the 'languages' variable accordingly:
+# as a json list, e.g., languages = ["Chinese.6.4.3.ini", "German.ini"], or
+# as a file, i.e., languages = <language_folder>, in which case the language files *.ini must be located inside the specified folder
+languages = languages

settings/vagrant.ini.uf.example

@@ -51,7 +51,7 @@ deploy_redcap_cron = True
 # Each repo needs files BASH script named deploy.sh at the root that will install the patch into a unzipped REDCap installation
 patch_repos = [ "[email protected]:redcap_security_settings.git" ]
 
-
-# List REDCap language file names as quoted strings. Separate multiple language files with commas.  e.g.
-#   languages = [ "Chinese.6.4.3.ini", "German.ini" ]
-languages = [ "Chinese.6.4.3.ini" ]
+# REDCap languages can be provided by modifying the 'languages' variable accordingly:
+# as a json list, e.g., languages = ["Chinese.6.4.3.ini", "German.ini"], or
+# as a file, i.e., languages = <language_folder>, in which case the language files *.ini must be located inside the specified folder
+languages = languages

upgrade.py

@@ -54,6 +54,7 @@ def apply_incremental_db_changes(old, new):
     files in sequence. The arguments old and new must be version numbers (i.e., 6.11.5)
     """
     old = utility.convert_version_to_int(old)
+    new_as_an_int = utility.convert_version_to_int(new)
     redcap_sql_dir = '/'.join([env.live_pre_path, env.project_path, 'redcap_v' + new, 'Resources/sql'])
     with settings(user=env.deploy_user):
         with hide('output'):
@@ -63,7 +64,7 @@ def apply_incremental_db_changes(old, new):
         match = re.search(r"(upgrade_)(\d+.\d+.\d+)(.)(php|sql)", file)
         version = match.group(2)
         version = utility.convert_version_to_int(version)
-        if version > old:
+        if version > old and version <= new_as_an_int:
             if fnmatch.fnmatch(file, "*.php"):
                 print (file + " is a php file!\n")
                 with settings(user=env.deploy_user):