Merge pull request #75 from naddison36/feat/storage

Fixed finding inherited contracts for storage diagrams
naddison36 · Jul 25, 2022 · 5105bc8 · 5105bc8
2 parents b2f3a80 + 6296c04
commit 5105bc8
Show file tree

Hide file tree

Showing 9 changed files with 26 additions and 15 deletions.
diff --git a/examples/inheritanceDiamond.png b/examples/inheritanceDiamond.png
diff --git a/examples/storage/README.md b/examples/storage/README.md
@@ -36,3 +36,20 @@ This is a contrived example where structs depend on other structs [fileLevel.sol
 
 ![FileLevel](./FileLevel-storage.png)
 
+## Contract Inheritance
+
+The following example shows the storage slots with contract inheritance. This includes diamond inheritance, imports from other files and import aliases.
+
+![Inheritance Class Diagram](../inheritanceDiamond.png)
+
+```
+sol2uml class -c -f png -o examples/inheritanceDiamond.png ./src/contracts/inheritance
+```
+
+The storage slots for contract `D` in [inheritance/common.sol](../../src/contracts/inheritance/common.sol).
+
+![Inheritance](./inheritanceStorage.png)
+
+```
+storage -v -c D -o examples/storage/inheritanceStorage.svg ./src/contracts/inheritance
+```
diff --git a/examples/storage/TestStorage.png b/examples/storage/TestStorage.png
diff --git a/examples/storage/inheritanceStorage.png b/examples/storage/inheritanceStorage.png
diff --git a/lib/converterClasses2Storage.js b/lib/converterClasses2Storage.js
diff --git a/lib/sol2uml.js b/lib/sol2uml.js
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "sol2uml",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Unified Modeling Language (UML) class diagram generator for Solidity contracts",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",

diff --git a/src/ts/converterClasses2Storage.ts b/src/ts/converterClasses2Storage.ts
@@ -1,4 +1,5 @@
 import { Attribute, AttributeType, ClassStereotype, UmlClass } from './umlClass'
+import { findAssociatedClass } from './associations'
 
 export enum StorageType {
     Contract,
@@ -83,12 +84,10 @@ const parseStorage = (
     )
     // Recursively parse each new inherited contract
     newInheritedContracts.forEach((parent) => {
-        const parentClass = umlClasses.find(
-            (umlClass) => umlClass.name === parent.targetUmlClassName
-        )
+        const parentClass = findAssociatedClass(parent, umlClass, umlClasses)
         if (!parentClass)
             throw Error(
-                `Failed to find parent contract ${parent.targetUmlClassName} of ${umlClass.name}`
+                `Failed to find parent contract ${parent.targetUmlClassName} of ${umlClass.absolutePath}`
             )
         // recursively parse inherited contract
         parseStorage(

diff --git a/src/ts/sol2uml.ts b/src/ts/sol2uml.ts
@@ -184,14 +184,9 @@ program
                 combinedOptions
             )
 
-            const filteredUmlClasses = classesConnectedToBaseContracts(
-                umlClasses,
-                [combinedOptions.contractName || contractName]
-            )
-
             const storageObjects = convertClasses2StorageObjects(
                 combinedOptions.contractName || contractName,
-                filteredUmlClasses
+                umlClasses
             )
             if (isAddress(fileFolderAddress)) {
                 // The first object is the contract