#302 Cleanup of dependencies and so docco post Finos move. (#313)

finos · Nov 14, 2022 · 8cf2b6a · 8cf2b6a
1 parent 3b45469
commit 8cf2b6a
Show file tree

Hide file tree

Showing 10 changed files with 130 additions and 105 deletions.
diff --git a/README.md b/README.md
@@ -35,6 +35,14 @@ this should be the same as Linux & macos just with windows adjusted paths
 ```
 
 ## Installation - Client
+
+Please note, while we are in the process of making the ag-grid dependencies optional you will 
+need to run this command from the vuu/vuu-ui directory. 
+
+```sh
+yarn add -W ag-grid-community ag-grid-enterprise ag-grid-react
+```
+Then this: 
 ```sh
 #in vuu repo (not vuu child directory in repo)
 cd vuu-ui
@@ -46,7 +54,6 @@ cd packages/electron
 yarn start
 ```
 
-
 ## Usage example
 
 ```

diff --git a/docs/getting_started/developing.md b/docs/getting_started/developing.md
@@ -1,6 +1,6 @@
 # Developing Vuu
 
-## Developing the server
+## Prerequisites
 
 1) Install IntelliJ Community Edition (latest version, tested with 2021.3)
 2) Install SDKMan from the [website](https://sdkman.io/) or using your own mechanism
@@ -10,11 +10,6 @@
 6) You should get one root module vuu-parent in a project list, select this
 7) When the project opens you should have 2 sub-modules (vuu and toolbox) 
 
-## Running the Vuu Server Simulation Module
-
-1) Go to the SimulMain.scala, right click and run (add these into JVM args -Xmx10G -Xms5G)
-2) Go to the SwingClientMain.scala, right click and run
-
 ## Developing the client
 
 If you are comfortable running the server in an IDE, you can follow the instructions above. If not
@@ -25,25 +20,58 @@ You can install command line maven via any means you please, but sdkman makes it
 sdk install maven
 ```
 
-```bash
-#after checking out the code, in project root dir
-mvn clean compile
-#then into the vuu subfolder
+## Installation - Server - Command Line
+
+### Prerequisites
+
+See the [Docs](https://vuu.finos.org/docs/getting_started/developing) for Java versions and install dependencies you need to have.
+
+OS X & Linux:
+
+```sh
+#In your favourite code directory...
+git clone https://github.com/finos/vuu.git
+#cd into the repository
+cd vuu
+#run the maven compile step
+mvn compile
+#cd into vuu, child in repo
 cd vuu
-#run SimulMain using maven exec:exec plugin
+#The server should now be started on your machine with Simulation module
 mvn exec:exec
 ```
 
+Windows:
 
+```sh
+this should be the same as Linux & MacOS just with Windows adjusted paths
+```
+
+## Running the Vuu Server Simulation Module from IDE
+
+1) Go to the SimulMain.scala, right click and run (add these into JVM args -Xmx10G -Xms5G)
+2) Go to the SwingClientMain.scala, right click and run
 
-1) install node.js version 14+ and yarn
-2) In a terminal, change directory into the ./vuu-ui folder
-3) yarn install
-4) type> ```yarn```
-5) build the ui library packages
-6) type> ```yarn build```
-7) build the sample application
-8) type> ```yarn build:app```
+## Installation - Client
+
+Please note, while we are in the process of making the ag-grid dependencies optional you will
+need to run this command from the vuu/vuu-ui directory.
+
+```sh
+#Please note these are licenced software components, they will be made optional shortly in Vuu
+yarn add -W ag-grid-community ag-grid-enterprise ag-grid-react
+```
+Then this:
+```sh
+#in vuu repo (not vuu child directory in repo)
+cd vuu-ui
+yarn
+yarn build
+yarn buid:app
+cd packages/electron
+#this should open an electron window pointing at https://localhost:8443/index.html
+yarn start
+```
 
 
 You should know be able to use a local browser to see the Vuu demo app. [localhost:8443](https://localhost:8443/index.html) 

diff --git a/docs/team.mdx b/docs/team.mdx
@@ -5,6 +5,8 @@ title: {project name} Team
 ---
 
 This is the {project name} team:
-1. bla
-2. bla
-3. bla
+1. Chris Stevenson, UBS, Lead Contributor
+2. Steve Heron, UBS, Lead Contributor
+3. Allan Jakobsen, UBS, Product Owner
+4. Michael Banham, UBS, Contributor
+5. Marina Bambang, UBS, Product Owner
diff --git a/pom.xml b/pom.xml
@@ -66,8 +66,8 @@
         <metrics.version>4.2.5</metrics.version>
         <curator.version>3.1.0</curator.version>
         <scalatest.version>3.2.9</scalatest.version>
-        <scala.logging>3.9.4</scala.logging>
-        <jackson.version>2.14.0-rc3</jackson.version>
+        <scala.logging>3.9.5</scala.logging>
+        <jackson.version>2.14.0</jackson.version>
         <aeron.version>1.17.0</aeron.version>
         <antlr.version>4.11.1</antlr.version>
         <netty.version>4.1.82.Final</netty.version>
@@ -115,6 +115,46 @@
             </exclusions>
         </dependency>
 
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-classic</artifactId>
+            <version>${logback.version}</version>
+        </dependency>
+
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-core</artifactId>
+            <version>${logback.version}</version>
+        </dependency>
+
+        <dependency>
+            <groupId>com.typesafe.scala-logging</groupId>
+            <artifactId>scala-logging_2.13</artifactId>
+            <version>${scala.logging}</version>
+            <exclusions>
+                <exclusion>
+                    <groupId>org.scala-lang</groupId>
+                    <artifactId>scala-library</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>org.scala-lang</groupId>
+                    <artifactId>scala-reflect</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
+
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>log4j-over-slf4j</artifactId>
+            <version>1.7.32</version>
+        </dependency>
+
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+            <version>1.7.32</version>
+        </dependency>
+
         <dependency>
             <groupId>org.scalatest</groupId>
             <artifactId>scalatest_2.13</artifactId>

diff --git a/toolbox/pom.xml b/toolbox/pom.xml
@@ -26,7 +26,6 @@
             <scope>test</scope>
         </dependency>
 
-
         <dependency>
             <groupId>io.dropwizard.metrics</groupId>
             <artifactId>metrics-core</artifactId>
@@ -45,72 +44,6 @@
             <version>2.10.13</version>
         </dependency>
 
-        <!--dependency>
-            <groupId>io.netty</groupId>
-            <artifactId>netty-all</artifactId>
-            <version>${netty.version}</version>
-        </dependency-->
-
-        <!--dependency>
-            <groupId>io.vertx</groupId>
-            <artifactId>vertx-core</artifactId>
-            <version>${vertx.version}</version>
-        </dependency>
-
-        <dependency>
-            <groupId>io.vertx</groupId>
-            <artifactId>vertx-web</artifactId>
-            <version>${vertx.version}</version>
-        </dependency-->
-
-        <!--dependency>
-            <groupId>org.swinglabs</groupId>
-            <artifactId>swingx</artifactId>
-            <version>1.6.1</version>
-        </dependency-->
-
-        <dependency>
-            <groupId>ch.qos.logback</groupId>
-            <artifactId>logback-classic</artifactId>
-            <version>${logback.version}</version>
-        </dependency>
-
-        <dependency>
-            <groupId>ch.qos.logback</groupId>
-            <artifactId>logback-core</artifactId>
-            <version>${logback.version}</version>
-        </dependency>
-
-        <dependency>
-            <groupId>com.typesafe.scala-logging</groupId>
-            <artifactId>scala-logging_2.13</artifactId>
-            <version>${scala.logging}</version>
-            <exclusions>
-                <exclusion>
-                    <groupId>org.scala-lang</groupId>
-                    <artifactId>scala-library</artifactId>
-                </exclusion>
-            </exclusions>
-        </dependency>
-
-        <dependency>
-            <groupId>org.slf4j</groupId>
-            <artifactId>log4j-over-slf4j</artifactId>
-            <version>1.7.32</version>
-        </dependency>
-
-        <dependency>
-            <groupId>org.slf4j</groupId>
-            <artifactId>slf4j-api</artifactId>
-            <version>1.7.32</version>
-        </dependency>
-
-        <dependency>
-            <groupId>org.antlr</groupId>
-            <artifactId>antlr4</artifactId>
-            <version>${antlr.version}</version>
-        </dependency>
-
     </dependencies>
 
     <profiles>

diff --git a/toolbox/src/main/scala/org/finos/toolbox/collection/array/NiaveImmutableArray.scala b/toolbox/src/main/scala/org/finos/toolbox/collection/array/NiaveImmutableArray.scala
@@ -20,16 +20,13 @@ class NiaiveImmutableArray[T :ClassTag](val array: Array[T] = Array.empty) exten
   }
 
   override def equals(obj: scala.Any): Boolean = {
-    if(obj.isInstanceOf[NiaiveImmutableArray[T]]){
-
-      val toCheck = obj.asInstanceOf[NiaiveImmutableArray[T]].array
-
-      val isEq = toCheck == array
-
-      isEq
-
-    } else{
-      false
+    obj match {
+      case value: NiaiveImmutableArray[_] =>
+        val toCheck = value.array
+        val isEq = toCheck == array
+        isEq
+      case _ =>
+        false
     }
   }
 

diff --git a/vuu-ui/package.json b/vuu-ui/package.json
@@ -35,6 +35,9 @@
     "@types/react": "^17.0.2",
     "@types/react-dom": "^17.0.2",
     "@typescript-eslint/parser": "^5.41.0",
+    "ag-grid-community": "^28.2.1",
+    "ag-grid-enterprise": "^28.2.1",
+    "ag-grid-react": "^28.2.1",
     "classnames": "^2.3.1",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",

diff --git a/vuu/pom.xml b/vuu/pom.xml
@@ -42,6 +42,11 @@
             <version>${scala.version}</version>
         </dependency>
 
+        <dependency>
+            <groupId>org.scala-lang</groupId>
+            <artifactId>scala-reflect</artifactId>
+            <version>${scala.version}</version>
+        </dependency>
 
         <dependency>
             <groupId>junit</groupId>
@@ -55,6 +60,16 @@
             <artifactId>scalatest_2.13</artifactId>
             <version>${scalatest.version}</version>
             <scope>test</scope>
+            <exclusions>
+                <exclusion>
+                    <groupId>org.scala-lang</groupId>
+                    <artifactId>scala-library</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>org.scala-lang</groupId>
+                    <artifactId>scala-reflect</artifactId>
+                </exclusion>
+            </exclusions>
         </dependency>
 
 

diff --git a/vuu/src/main/resources/runconfigurations/SimulMain.run.xml b/vuu/src/main/resources/runconfigurations/SimulMain.run.xml
@@ -2,7 +2,7 @@
   <configuration default="false" name="SimulMain" type="Application" factoryName="Application" folderName="runConfigs">
     <option name="ALTERNATIVE_JRE_PATH" value="16" />
     <option name="MAIN_CLASS_NAME" value="org.finos.vuu.SimulMain" />
-    <module name="vuu (1)" />
+    <module name="vuu" />
     <option name="PROGRAM_PARAMETERS" value="-Xmx20G -Xlog:gc*=debug:stdout " />
     <option name="VM_PARAMETERS" value="-Dlogback.configurationFile=logback-socket.xml" />
     <extension name="coverage">

diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -34,7 +34,7 @@ module.exports = {
         { to: "docs/roadmap", label: "Roadmap", position: "right" },
         { to: "docs/team", label: "Team", position: "right" },
         {
-          href: "https://github.com/finos/",
+          href: "https://github.com/finos/vuu",
           label: "GitHub",
           position: "right",
         },
@@ -74,7 +74,7 @@ module.exports = {
           items: [
             {
               label: "FINOS Website",
-              to: "https://regulationinnovation.org/air-events/",
+              to: "https://www.finos.org",
             },
             {
               label: "Community Handbook",