Adopting code for Caché 2017.1+ (system methods removal)

Author: nikitaeverywhere

README.md

@@ -91,6 +91,6 @@ Then you can just use one command `import` to deploy the project from source to
 
 After setting `import.bat` up, **just by one command** `import` you get the next:
 
-1. Project is built by gulp;
+1. Project is built by Gulp;
 2. VisualEditor package is imported into Caché;
 3. The XML file containing ready-to-deploy package is exported to `build` directory. 

import.bat

@@ -2,13 +2,13 @@
 :: exporting the XML the project. Replace the path below to your Caché installation and build & import application to
 :: Caché using only one command.
 
-:: Latest NodeJS & Caché 2016.1+ IS REQUIRED TO PROCEED
+:: Latest NodeJS & Caché 2017.1+ IS REQUIRED TO PROCEED
 @echo off
 
 :: CHANGE THIS PATH TO YOUR CACHÉ INSTALLATION PATH ON WINDOWS (folder that contains bin, CSP, mgr and other folders)
 set CACHE_DIR=C:\Program Files\InterSystems\Ensemble
 :: NAMESPACE TO IMPORT PACKAGE TO
-set NAMESPACE=SAMPLES
+set NAMESPACE=USER
 
 :: Build and import application to Caché
 echo Building the project...

package.json

@@ -2,7 +2,7 @@
   "name": "cache-visual-editor",
   "printableName": "Cache Visual Editor",
   "packageName": "VisualEditor",
-  "version": "0.9.11",
+  "version": "0.10.0",
   "gaID": "UA-83005064-4",
   "description": "Visual class editor for InterSystems Caché",
   "main": "index.js",
@@ -25,7 +25,7 @@
     "gulp-htmlmin": "^1.3.0",
     "gulp-preprocess": "^2.0.0",
     "gulp-rename": "^1.2.2",
-    "gulp-sass": "^2.2.0",
+    "gulp-sass": "^3.1.0",
     "gulp-uglify": "^1.5.3",
     "rimraf": "^2.5.2",
     "vinyl-buffer": "^1.0.0",

source/cache/REST/Editor.cls

@@ -11,19 +11,19 @@ XData UrlMap
 }
 
 /// Saves keywords of class members and a class itself.
-ClassMethod SaveKeywords(memberKind As %String, definitionObj, assignObj As %Object) As %String [ Private ]
+ClassMethod SaveKeywords(memberKind As %String, definitionObj, assignObj As %DynamicObject) As %String [ Private ]
 {
     set errors = ""
     #define logError(%e) if (%e '= "") { set errors = errors _ %e _ $Char(10) }
     set propDefinition =
         ##class(%Dictionary.ClassDefinition).%OpenId("%Dictionary."_memberKind_"Definition").Properties
 
-    set iterator = assignObj.$getIterator()
-    while (iterator.$getNext(.pName, .data)) {
+    set iterator = assignObj.%GetIterator()
+    while (iterator.%GetNext(.pName, .data)) {
         if (pName = "$add") { continue }
         set propPos = propDefinition.FindObjectId("%Dictionary."_memberKind_"Definition||"_pName)
         if (propPos > 0) {
-            set val = assignObj.$get(pName)
+            set val = assignObj.%Get(pName)
             if ($IsObject(val)) { continue }
             if ($$$classIsStream(propDefinition.GetAt(propPos).Type)) {
 	            #dim stream As %Stream.TmpCharacter = $PROPERTY(definitionObj, pName)
@@ -42,7 +42,7 @@ ClassMethod SaveKeywords(memberKind As %String, definitionObj, assignObj As %Obj
 }
 
 /// Saves properties of class properties.
-ClassMethod SaveClassMember(memberKind As %String, classDef As %Dictionary.ClassDefinition, prps As %Object) As %String [ Private ]
+ClassMethod SaveClassMember(memberKind As %String, classDef As %Dictionary.ClassDefinition, prps As %DynamicObject) As %String [ Private ]
 {
     set errors = ""
 
@@ -52,10 +52,10 @@ ClassMethod SaveClassMember(memberKind As %String, classDef As %Dictionary.Class
 
     #define logError(%e) if (%e '= "") { set errors = errors _ %e _ $Char(10) }
 
-    set iterator = prps.$getIterator()
-    while (iterator.$getNext(.memberName, .props)) {
+    set iterator = prps.%GetIterator()
+    while (iterator.%GetNext(.memberName, .props)) {
 
-        if (props.$get("$add") '= "") {
+        if (props.%Get("$add") '= "") {
             set pDef = $System.OBJ.New("%Dictionary."_memberKind_"Definition")
             set pDef.parent = classDef
         } else {
@@ -66,7 +66,7 @@ ClassMethod SaveClassMember(memberKind As %String, classDef As %Dictionary.Class
             continue
         }
 
-        if (props.$get("$delete") '= "") {
+        if (props.%Get("$delete") '= "") {
             set error = $System.Status.GetErrorText(pDef.%Delete(pDef.%Oid()))
             continue
         }
@@ -95,10 +95,10 @@ ClassMethod Save() As %Status
 
     #define logError(%e) if (%e '= "") { set response.error = response.error _ %e _ $Char(10) }
 
-    set iterator = classes.$getIterator()
-    while (iterator.$getNext(.className, .classData)) {
+    set iterator = classes.%GetIterator()
+    while (iterator.%GetNext(.className, .classData)) {
 
-        if (classData.$get("$add") '= "") {
+        if (classData.%Get("$add") '= "") {
             set classDef = ##class(%Dictionary.ClassDefinition).%New()
             set classDef.Name = className
         } else {
@@ -109,18 +109,18 @@ ClassMethod Save() As %Status
             continue
         }
 
-        if (classData.$get("$delete") '= "") {
+        if (classData.%Get("$delete") '= "") {
             $$$logError($System.Status.GetErrorText(classDef.%Delete(classDef.%Oid())))
             set response.modified = response.modified + 1
             continue
         }
 
-        $$$logError(..SaveClassMember("Parameter", classDef, classData.$get("Parameters")))
-        $$$logError(..SaveClassMember("Property", classDef, classData.$get("Properties")))
-        $$$logError(..SaveClassMember("Index", classDef, classData.$get("Indices")))
-        $$$logError(..SaveClassMember("Method", classDef, classData.$get("Methods")))
-        $$$logError(..SaveClassMember("Query", classDef, classData.$get("Queries")))
-        $$$logError(..SaveClassMember("XData", classDef, classData.$get("XDatas")))
+        $$$logError(..SaveClassMember("Parameter", classDef, classData.%Get("Parameters")))
+        $$$logError(..SaveClassMember("Property", classDef, classData.%Get("Properties")))
+        $$$logError(..SaveClassMember("Index", classDef, classData.%Get("Indices")))
+        $$$logError(..SaveClassMember("Method", classDef, classData.%Get("Methods")))
+        $$$logError(..SaveClassMember("Query", classDef, classData.%Get("Queries")))
+        $$$logError(..SaveClassMember("XData", classDef, classData.%Get("XDatas")))
         $$$logError(..SaveKeywords("Class", classDef, classData))
 
         $$$logError($System.Status.GetErrorText(classDef.%Save()))
@@ -132,14 +132,14 @@ ClassMethod Save() As %Status
             continue
         }
 
-        do response.modified.$set(className, {
-            "success": 1,
-            "class": ##class(VisualEditor.REST.Informer).GetClassData(className)
+        do response.modified.%Set(className, {
+            "success": (1),
+            "class": (##class(VisualEditor.REST.Informer).GetClassData(className))
         })
 
     }
 
-    write response.$toJSON()
+    write response.%ToJSON()
 
     return $$$OK
 }
@@ -157,7 +157,7 @@ ClassMethod OnPreDispatch() As %Status
 		set content = content _ $ZCVT(%request.Content.Read($$$MaxStringLength), "I", "UTF8")
     }
 
-    set %request.Content = ##class(%AbstractObject).$fromJSON(content)
+    set %request.Content = {}.%FromJSON(content)
 
     return $$$OK
 }

source/cache/REST/Informer.cls

@@ -11,7 +11,7 @@ XData UrlMap
 }
 
 /// Returns all available namespaces for the current instance.
-ClassMethod getAllNamespacesList() As %Object
+ClassMethod getAllNamespacesList() As %DynamicObject
 {
     set namespaces = {}
     set result = ##class(%ResultSet).%New("%SYS.Namespace:List")
@@ -20,7 +20,7 @@ ClassMethod getAllNamespacesList() As %Object
         set ns = {}
         set ns.remote = result.Get("Remote")
         set ns.status = result.Get("Status")
-        do namespaces.$set(result.Get("Nsp"), ns)
+        do namespaces.%Set(result.Get("Nsp"), ns)
     }
     return namespaces
 }
@@ -31,12 +31,12 @@ ClassMethod Init() As %Status
     set data = {}
     set data.namespace = $Namespace
     set data.namespaces = ..getAllNamespacesList()
-    write data.$toJSON()
+    write data.%ToJSON()
     return $$$OK
 }
 
 /// Returns the object containing member data.
-ClassMethod GetMemberData(class As %Dictionary.ClassDefinition, memberName As %String) As %Object [ Private ]
+ClassMethod GetMemberData(class As %Dictionary.ClassDefinition, memberName As %String) As %DynamicObject [ Private ]
 {
     set obj = {}
     set props = ##class(%Dictionary.ClassDefinition).%OpenId("%Dictionary."_memberName_"Definition")
@@ -49,50 +49,50 @@ ClassMethod GetMemberData(class As %Dictionary.ClassDefinition, memberName As %S
             set pname = props.Properties.GetAt(j).Name
             set val = $PROPERTY(p, pname)
             if ('$IsObject(val)) {
-                do op.$set(pname, val)
+                do op.%Set(pname, val)
             } elseif ($$$classIsStream($ClassName(val))) {
                 set v = val.Read()
                 while ('val.AtEnd) {
                     set v = v _ val.Read()
                 }
-                do op.$set(pname, v)
+                do op.%Set(pname, v)
             }
         }
-        do obj.$set(p.Name, op)
+        do obj.%Set(p.Name, op)
     }
     return obj
 }
 
 /// This method returns all available data about the class.
-ClassMethod GetClassData(className As %String) As %Object
+ClassMethod GetClassData(className As %String) As %DynamicObject
 {
     set class = ##class(%Dictionary.ClassDefinition).%OpenId(className)
     set cClass = ##class(%Dictionary.CompiledClass).%OpenId(className)
     set oClass = {}
     if (class = "") { return oClass }
 
-    do oClass.$set("_type", "class")
-    do oClass.$set("_fullName", className)
-    do oClass.$set("_name", $PIECE(className, ".", *))
-    do oClass.$set("_isDataType", class.ClientDataTypeIsDefined())
-    do oClass.$set("_isOdbcType", class.OdbcTypeIsDefined())
-    do oClass.$set("_isSoapBindingStyle", class.SoapBindingStyleIsDefined())
-    do oClass.$set("_isSoapBodyUse", class.SoapBodyUseIsDefined())
-    do oClass.$set("_isSqlCategory", class.SqlCategoryIsDefined())
+    do oClass.%Set("_type", "class")
+    do oClass.%Set("_fullName", className)
+    do oClass.%Set("_name", $PIECE(className, ".", *))
+    do oClass.%Set("_isDataType", class.ClientDataTypeIsDefined())
+    do oClass.%Set("_isOdbcType", class.OdbcTypeIsDefined())
+    do oClass.%Set("_isSoapBindingStyle", class.SoapBindingStyleIsDefined())
+    do oClass.%Set("_isSoapBodyUse", class.SoapBodyUseIsDefined())
+    do oClass.%Set("_isSqlCategory", class.SqlCategoryIsDefined())
 
     set props = ##class(%Dictionary.ClassDefinition).%OpenId("%Dictionary.ClassDefinition")
     for j=1:1:props.Properties.Count() {
         set pname = props.Properties.GetAt(j).Name
         if ((pname '= "parent") && ('props.Properties.GetAt(j).Private) && ('$IsObject($PROPERTY(class, pname)))) {
-             do oClass.$set(pname, $PROPERTY(class, pname))
+             do oClass.%Set(pname, $PROPERTY(class, pname))
         }
     }
     if (oClass.TimeChanged) { set oClass.TimeChanged = $zdatetime(oClass.TimeChanged) }
     if (oClass.TimeCreated) { set oClass.TimeCreated = $zdatetime(oClass.TimeCreated) }
     if ((cClass '= "") && (cClass.ClassType '= "")) {
-        do oClass.$set("_compiledClassType", cClass.ClassType)
+        do oClass.%Set("_compiledClassType", cClass.ClassType)
     } else {
-        do oClass.$set("_compiledClassType", "registered") // default
+        do oClass.%Set("_compiledClassType", "registered") // default
     }
 
     set oClass.Parameters = ..GetMemberData(class, "Parameter")
@@ -129,21 +129,21 @@ ClassMethod List() As %Status
             if ($data(folders(folderName))) { continue }
             set folders(folderName) = 1
             set oFolder = {}
-            do oFolder.$set("_type", "package")
-            do oFolder.$set("_fullName", baseLevel _ folderName)
-            do oFolder.$set("_name", folderName)
-            do data.$set(folderName, oFolder)
+            do oFolder.%Set("_type", "package")
+            do oFolder.%Set("_fullName", baseLevel _ folderName)
+            do oFolder.%Set("_name", folderName)
+            do data.%Set(folderName, oFolder)
         } elseif ($LENGTH(clsName, ".") = $LENGTH(baseLevel, ".")) {
             set className = $PIECE(clsName, ".", $LENGTH(baseLevel, "."))
             set oClass = ..GetClassData(clsName)
-            do data.$set(className, oClass)
+            do data.%Set(className, oClass)
         } else {
             continue
         }
     }
 
     write "" // fixes the strange $toJSON() issue: it does not output content properly without this string
-    do data.$toJSON()
+    do data.%ToJSON()
 
     return $$$OK
 }