Skip to content

Commit acab32d

Browse files
bdeboebdeboe
authored
Merge pull request #35 from bdeboe/master
minor fixes for #33 and #34, plus semi-automation for the `gulp` build step see readme for details
2 parents 17cb3a7 + 2535877 commit acab32d

File tree

10 files changed

+156
-31
lines changed

10 files changed

+156
-31
lines changed

‎.dockerignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
build-for-zpm/*
2+
readme.md

‎Dockerfile-build-npm‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
FROM ubuntu:latest
2+
ARG NODE_VERSION=10
3+
4+
# install curl
5+
RUN apt update && apt install curl -y
6+
7+
# install nvm
8+
RUN curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
9+
10+
# set env
11+
ENV NVM_DIR=/root/.nvm
12+
13+
# install node
14+
RUN bash -c "source $NVM_DIR/nvm.sh && nvm install ${NODE_VERSION} && nvm use ${NODE_VERSION}"
15+
16+
# copy code
17+
WORKDIR /opt/irisapp
18+
COPY src ./src
19+
COPY gulpfile.js .
20+
COPY package.json .
21+
22+
# build npm
23+
RUN bash -c "source $NVM_DIR/nvm.sh && npm install && npm run gulp"
24+
25+
26+
# set ENTRYPOINT for reloading nvm-environment
27+
ENTRYPOINT ["bash", "-c", "source $NVM_DIR/nvm.sh && exec \"$@\"", "--"]
28+
29+
# set cmd to bash
30+
CMD ["/bin/bash"]

‎build-for-zpm/ClassExplorer/ClassView.cls‎

Lines changed: 42 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,16 @@ ClassMethod fillClassData(oData As %ZEN.proxyObject, className As %String, level
112112
if (oData.restrictPackage) && ('..inPackage(oData.basePackageName, package)) quit oClass
113113
set oClass.Super = ..correctInheritance(oData, classDefinition, package) // now expand super names
114114

115+
// prebuild a list of properties that are part of an FK
116+
kill propToFK
117+
for i = 1:1:classDefinition.ForeignKeys.Count() {
118+
set fk = classDefinition.ForeignKeys.GetAt(i)
119+
for j = 1:1:$l(fk.Properties,",") {
120+
set prop = $piece(fk.Properties,",")
121+
set propToFK(prop) = fk
122+
}
123+
}
124+
115125
set oClass.properties = oProperties
116126
set count = classDefinition.Properties.Count()
117127
set props = ##class(%Dictionary.ClassDefinition).%OpenId("%Dictionary.PropertyDefinition")
@@ -127,14 +137,26 @@ ClassMethod fillClassData(oData As %ZEN.proxyObject, className As %String, level
127137
// Skip private properties that InterSystems may add in any future versions
128138
}
129139
}
130-
if (..classExists(package _ "." _ p.Type)) {
131-
set oProp.Type = package _ "." _ p.Type
132-
do ..fillClassData(oData, package _ "." _ p.Type, level, currLevel)
133-
} elseif (..classExists(..extendClassFromType(p.Type))) {
134-
set oProp.Type = ..extendClassFromType(p.Type)
135-
do ..fillClassData(oData, ..extendClassFromType(p.Type), level, currLevel)
140+
141+
set pType = p.Type
142+
143+
// check if this property has an outgoing FK reference
144+
if $d(propToFK(p.Name), fk) {
145+
// if so, override target type and class relationship traits
146+
set pType = fk.ReferencedClass,
147+
oProp.Relationship = 1,
148+
oProp.Cardinality = "one",
149+
oProp.Inverse = "[foreign key]"
150+
}
151+
152+
if (..classExists(package _ "." _ pType)) {
153+
set oProp.Type = package _ "." _ pType
154+
do ..fillClassData(oData, package _ "." _ pType, level, currLevel)
155+
} elseif (..classExists(..extendClassFromType(pType))) {
156+
set oProp.Type = ..extendClassFromType(pType)
157+
do ..fillClassData(oData, ..extendClassFromType(pType), level, currLevel)
136158
} else {
137-
set oProp.Type = ..extendClassFromType(p.Type)
159+
set oProp.Type = ..extendClassFromType(pType)
138160
}
139161
}
140162

@@ -321,14 +343,25 @@ ClassMethod getBaseOData(packageName As %String, baseNamespace As %String, saved
321343

322344
set ns = $namespace
323345
zn baseNamespace
324-
if $get(^ClassExplorer("savedView", ns_":"_savedName)) '= "" {
325-
set oData.savedView = $get(^ClassExplorer("savedView", ns_":"_savedName))
346+
set shortName = ..shortenSavedName(ns_":"_savedName)
347+
if $get(^ClassExplorer("savedView", shortName)) '= "" {
348+
set oData.savedView = $get(^ClassExplorer("savedView", shortName))
326349
}
327350
zn ns
328351

329352
quit oData
330353
}
331354

355+
/// Shorten the saved name to avoid SUBSCRIPT errors when saving into ^ClassExplorer
356+
ClassMethod shortenSavedName(savedName as %String) As %String [ Internal ]
357+
{
358+
// this is not watertight, but should be sufficient for this use case
359+
if $l(savedName)>100 {
360+
return $e(savedName, 1, 100) _ $zcrc(savedName, 7)
361+
}
362+
return savedName
363+
}
364+
332365
/// Returns if class with given name exists.
333366
ClassMethod classExists(className As %String) As %Boolean
334367
{

‎build-for-zpm/ClassExplorer/Router.cls‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ ClassMethod SaveView() As %Status
4242
{
4343
set name = %request.Get("name")
4444
set content = %request.Content.Read($$$MaxStringLength) // ~ 7mb
45-
set ^ClassExplorer("savedView", name) = content
45+
set ^ClassExplorer("savedView", ##class(ClassExplorer.ClassView).shortenSavedName(name)) = content
4646
write "{""OK"":true}"
4747
return $$$OK
4848
}
@@ -51,7 +51,7 @@ ClassMethod SaveView() As %Status
5151
ClassMethod ResetView() As %Status
5252
{
5353
set name = %request.Get("name")
54-
kill ^ClassExplorer("savedView", name)
54+
kill ^ClassExplorer("savedView", ##class(ClassExplorer.ClassView).shortenSavedName(name))
5555
write "{""OK"":true}"
5656
return $$$OK
5757
}

‎build-for-zpm/ClassExplorer/StaticContent.cls‎

Lines changed: 6 additions & 6 deletions
Large diffs are not rendered by default.

‎module.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
<Document name="classexplorer.ZPM">
44
<Module>
55
<Name>classexplorer</Name>
6-
<Version>1.21.4</Version>
6+
<Version>1.21.5</Version>
77
<Description>UML Class Diagram Builder for InterSystems Data Platforms</Description>
88
<Packaging>module</Packaging>
99
<SourcesRoot>build-for-zpm</SourcesRoot>
1010
<Resource Name="ClassExplorer.PKG"/>
11-
<CSPApplication
11+
<WebApplication
1212
Url="/ClassExplorer"
1313
DispatchClass="ClassExplorer.Router"
1414
MatchRoles=":{$dbrole}"

‎readme.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ application.
4646

4747
## Development
4848

49+
### Local
50+
4951
To build project, you need [NodeJS](https://nodejs.org) platform to be installed. Then, clone source
5052
code and run <code>npm install</code> from the root of the project. This will install all necessary
5153
modules from NPM for the project.
@@ -61,6 +63,19 @@ One can import/export the built source to the local Cache/URIS instance (see `im
6163

6264
This will bring `ClassExplorer-v*.*.*.xml` to the `build` directory, which you can then package with `npm run zip`.
6365

66+
### Using docker
67+
68+
:warning: The following is a rather naive way of building the web app for ZPM packaging using an [nvm docker script](https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-in-docker), starting the image as a daemon, and then manually copying the files back out.
69+
70+
```Shell
71+
docker build -f ./Dockerfile-build-npm -t build-npm .
72+
docker run --rm -d --name build-npm build-npm /bin/bash -c 'while true; do sleep 30; done'
73+
docker cp build-npm:/opt/irisapp/build/cls/ClassExplorer.ClassView.cls ./build-for-zpm/ClassExplorer/ClassView.cls
74+
docker cp build-npm:/opt/irisapp/build/cls/ClassExplorer.Router.cls ./build-for-zpm/ClassExplorer/Router.cls
75+
docker cp build-npm:/opt/irisapp/build/cls/ClassExplorer.StaticContent.cls ./build-for-zpm/ClassExplorer/StaticContent.cls
76+
docker stop build-npm
77+
```
78+
6479
### ZPM
6580

6681
[ZPM](https://github.com/intersystems-community/zpm) is the package manager for InterSystems products. Currently,

‎src/cls/ClassExplorer/ClassView.cls‎

Lines changed: 42 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,16 @@ ClassMethod fillClassData(oData As %ZEN.proxyObject, className As %String, level
112112
if (oData.restrictPackage) && ('..inPackage(oData.basePackageName, package)) quit oClass
113113
set oClass.Super = ..correctInheritance(oData, classDefinition, package) // now expand super names
114114

115+
// prebuild a list of properties that are part of an FK
116+
kill propToFK
117+
for i = 1:1:classDefinition.ForeignKeys.Count() {
118+
set fk = classDefinition.ForeignKeys.GetAt(i)
119+
for j = 1:1:$l(fk.Properties,",") {
120+
set prop = $piece(fk.Properties,",")
121+
set propToFK(prop) = fk
122+
}
123+
}
124+
115125
set oClass.properties = oProperties
116126
set count = classDefinition.Properties.Count()
117127
set props = ##class(%Dictionary.ClassDefinition).%OpenId("%Dictionary.PropertyDefinition")
@@ -127,14 +137,26 @@ ClassMethod fillClassData(oData As %ZEN.proxyObject, className As %String, level
127137
// Skip private properties that InterSystems may add in any future versions
128138
}
129139
}
130-
if (..classExists(package _ "." _ p.Type)) {
131-
set oProp.Type = package _ "." _ p.Type
132-
do ..fillClassData(oData, package _ "." _ p.Type, level, currLevel)
133-
} elseif (..classExists(..extendClassFromType(p.Type))) {
134-
set oProp.Type = ..extendClassFromType(p.Type)
135-
do ..fillClassData(oData, ..extendClassFromType(p.Type), level, currLevel)
140+
141+
set pType = p.Type
142+
143+
// check if this property has an outgoing FK reference
144+
if $d(propToFK(p.Name), fk) {
145+
// if so, override target type and class relationship traits
146+
set pType = fk.ReferencedClass,
147+
oProp.Relationship = 1,
148+
oProp.Cardinality = "one",
149+
oProp.Inverse = "[foreign key]"
150+
}
151+
152+
if (..classExists(package _ "." _ pType)) {
153+
set oProp.Type = package _ "." _ pType
154+
do ..fillClassData(oData, package _ "." _ pType, level, currLevel)
155+
} elseif (..classExists(..extendClassFromType(pType))) {
156+
set oProp.Type = ..extendClassFromType(pType)
157+
do ..fillClassData(oData, ..extendClassFromType(pType), level, currLevel)
136158
} else {
137-
set oProp.Type = ..extendClassFromType(p.Type)
159+
set oProp.Type = ..extendClassFromType(pType)
138160
}
139161
}
140162

@@ -321,14 +343,25 @@ ClassMethod getBaseOData(packageName As %String, baseNamespace As %String, saved
321343

322344
set ns = $namespace
323345
zn baseNamespace
324-
if $get(^ClassExplorer("savedView", ns_":"_savedName)) '= "" {
325-
set oData.savedView = $get(^ClassExplorer("savedView", ns_":"_savedName))
346+
set shortName = ..shortenSavedName(ns_":"_savedName)
347+
if $get(^ClassExplorer("savedView", shortName)) '= "" {
348+
set oData.savedView = $get(^ClassExplorer("savedView", shortName))
326349
}
327350
zn ns
328351

329352
quit oData
330353
}
331354

355+
/// Shorten the saved name to avoid SUBSCRIPT errors when saving into ^ClassExplorer
356+
ClassMethod shortenSavedName(savedName as %String) As %String [ Internal ]
357+
{
358+
// this is not watertight, but should be sufficient for this use case
359+
if $l(savedName)>100 {
360+
return $e(savedName, 1, 100) _ $zcrc(savedName, 7)
361+
}
362+
return savedName
363+
}
364+
332365
/// Returns if class with given name exists.
333366
ClassMethod classExists(className As %String) As %Boolean
334367
{

‎src/cls/ClassExplorer/Router.cls‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ ClassMethod SaveView() As %Status
4242
{
4343
set name = %request.Get("name")
4444
set content = %request.Content.Read($$$MaxStringLength) // ~ 7mb
45-
set ^ClassExplorer("savedView", name) = content
45+
set ^ClassExplorer("savedView", ##class(ClassExplorer.ClassView).shortenSavedName(name)) = content
4646
write "{""OK"":true}"
4747
return $$$OK
4848
}
@@ -51,7 +51,7 @@ ClassMethod SaveView() As %Status
5151
ClassMethod ResetView() As %Status
5252
{
5353
set name = %request.Get("name")
54-
kill ^ClassExplorer("savedView", name)
54+
kill ^ClassExplorer("savedView", ##class(ClassExplorer.ClassView).shortenSavedName(name))
5555
write "{""OK"":true}"
5656
return $$$OK
5757
}

‎src/web/js/Source.js‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,19 @@
11
var Source = function (cacheUMLExplorer) {
22

3+
// need to figure out path prefix when not at /ClassExplorer
4+
var prefix = '';
5+
try {
6+
var path = window.location.pathname.split('/');
7+
for (var i = 1; i < path.length; i++) {
8+
if (path[i]=='ClassExplorer') break;
9+
prefix += '/'+path[i];
10+
}
11+
} catch (ex) {
12+
// shrug it off
13+
}
14+
315
this.URL = window.location.protocol + "//" + window.location.hostname + ":" +
4-
57772/*build.replace:window.location.port*/ + "/ClassExplorer";
16+
57772/*build.replace:window.location.port*/ + prefix + "/ClassExplorer";
517

618
this.cue = cacheUMLExplorer;
719

0 commit comments

Comments
 (0)