Merge branch 'release/3.3.1'

Author: pbchase

CHANGELOG.md

@@ -2,6 +2,10 @@
 All notable changes to the Form Render Skip Logic module will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [3.3.1] - 2018-08-13
+### Changed
+- Refactor 2.x - 3.x migration in order to use External Modules API functions. (Tiago Bember Simeao)
+
 
 ## [3.3.0] - 2018-08-09
 ### Added

ExternalModule.php

@@ -9,7 +9,6 @@
 use Calculate;
 use ExternalModules\AbstractExternalModule;
 use ExternalModules\ExternalModules;
-use FormRenderSkipLogic\Migration\Migration;
 use Form;
 use LogicTester;
 use Piping;
@@ -19,8 +18,6 @@
 use RCView;
 use REDCap;
 
-require_once dirname(__FILE__) . '/Migration.php';
-
 /**
  * ExternalModule class for REDCap Form Render Skip Logic.
  */
@@ -102,14 +99,59 @@ function redcap_save_record($project_id, $record = null, $instrument, $event_id,
      * @inheritdoc
      */
     function redcap_module_system_change_version($version, $old_version) {
-        $this->migrateSettings();
-    }
+        if (strpos($old_version, 'v2.') !== 0 || $version[0] != 'v' || !is_numeric($version[1]) || $version[1] < 3) {
+            return;
+        }
 
-    /**
-     * @inheritdoc
-     */
-    function redcap_module_system_enable($version) {
-        $this->migrateSettings();
+        // Migrating settings from version 2.x to 3.x.
+        foreach (ExternalModules::getEnabledProjects($this->PREFIX) as $project) {
+            $pid = $project['project_id'];
+
+            if ($this->getProjectSetting('control_field', $pid) === null || $this->getProjectSetting('control_fields', $pid) !== null) {
+                // Skip if there is no config from v2 available or if there is
+                // already config from v3.
+                continue;
+            }
+
+            $conds = array_combine(
+                $this->getProjectSetting('instrument_name', $pid),
+                $this->getProjectSetting('control_field_value', $pid)
+            );
+
+            $bl = array();
+            foreach ($conds as $form => $value) {
+                if (!isset($bl[$value])) {
+                    $bl[$value] = array();
+                }
+
+                $bl[$value][] = $form;
+            }
+
+            $target_forms = array();
+            foreach ($bl as $forms) {
+                $target_forms[] = array_values($forms);
+            }
+
+            $count = count($bl);
+            $settings = array(
+                'control_fields' => array('true'),
+                'control_mode' => array('default'),
+                'control_piping' => array(null),
+                'control_default_value' => array(null),
+                'control_event_id' => $this->getProjectSetting('event_name', $pid),
+                'control_field_key' => $this->getProjectSetting('field_name', $pid),
+                'branching_logic' => array(array_fill(0, $count, 'true')),
+                'condition_value' => array(array_map('strval', array_keys($bl))),
+                'condition_operator' => array(array_fill(0, $count, null)),
+                'target_events_select' => array(array_fill(0, $count, false)),
+                'target_events' => array(array_fill(0, $count, array(null))),
+                'target_forms' => array($target_forms),
+            );
+
+            foreach ($settings as $key => $value) {
+                $this->setProjectSetting($key, $value, $pid);
+            }
+        }
     }
 
     /**
@@ -563,19 +605,4 @@ function _calculateCondition($a, $b, $op = '=') {
 
         return $a === $b;
     }
-
-    /**
-     * migrates stored module settings from v2.x.x to v3.x.x if needed.
-     */
-    function migrateSettings() {
-        $migrate = new Migration($this->PREFIX);
-
-        //migrate settings only if version 2 settings exist and version 3 settings
-        //do not exist.
-        if ($migrate->checkIfVersionSettingsExist("v2.0.0") && !$migrate->checkIfVersionSettingsExist("v3.0.0")) {
-            $old_setting = $migrate->getV2Settings();
-            $new_setting = $migrate->convertV2SettingsToV3Settings($old_setting);
-            $migrate->storeV3Settings($new_setting);
-        }
-    }
 }

Migration.php

@@ -57,4 +57,9 @@ If you want to make sure no filled forms will be affected by FRSL rules, check "
 
 ## Upgrading From Version 2.x - 3.x
 
-Note that version 3.0.0 introduced a breaking change in the configuration. When you upgrade to version 3.x all of your old configurations in 2.x will be converted into the 3.x configuration scheme. This migration only occurs the first time you upgrade from 2.x to 3.x . Thereafter, if you decided to switch back and forth between the two versions, your configurations will not transfer. This is to ensure that all of your old 2.x configurations will still be available to you if you decide to go back to version 2.x .
+Note that version 3.0.0 introduced a breaking change in the configuration. When you upgrade to version 3.x all of your old configurations in 2.x will be converted into the 3.x configuration scheme. Thereafter, if you decided to switch back and forth between the two versions, your configurations will not transfer. This is to ensure that all of your old 2.x configurations will still be available to you if you decide to go back to version 2.x.
+
+#### Important
+This migration only occurs the first time you upgrade from 2.x to 3.x - and only for the projects that already have FRSL enabled.
+
+![Settings migration](img/migration.png)

README.md

@@ -8,8 +8,7 @@
         "redcap_data_entry_form_top",
         "redcap_survey_page_top",
         "redcap_save_record",
-        "redcap_module_system_change_version",
-        "redcap_module_system_enable"
+        "redcap_module_system_change_version"
     ],
     "authors": [
         {