Merge pull request #86 from 0xProject/feat/parse-imports-single-quotes

Feat: Add ability to parse single quote imports

Author: kliao

sol-compiler/src/utils/compiler.ts

@@ -92,21 +92,22 @@ export function getNormalizedErrMsg(errMsg: string): string {
 }
 
 /**
- * Parses the contract source code and extracts the dendencies
+ * Parses the contract source code and extracts the dependencies
  * @param  source Contract source code
- * @return List of dependendencies
+ * @return List of dependencies
  */
 export function parseDependencies(contractSource: ContractSource): string[] {
     // TODO: Use a proper parser
     const source = contractSource.source;
     const sourceWithoutComments = stripComments(source);
     const IMPORT_REGEX = /(import\s)/;
-    const DEPENDENCY_PATH_REGEX = /"([^"]+)"/; // Source: https://github.com/BlockChainCompany/soljitsu/blob/master/lib/shared.js
     const dependencies: string[] = [];
     const lines = sourceWithoutComments.split('\n');
     _.forEach(lines, line => {
         if (line.match(IMPORT_REGEX) !== null) {
-            const dependencyMatch = line.match(DEPENDENCY_PATH_REGEX);
+            const dependencyMatch =
+                line.match(constants.DEPENDENCY_PATH_REGEX_DOUBLE_QUOTES) ??
+                line.match(constants.DEPENDENCY_PATH_REGEX_SINGLE_QUOTES);
             if (dependencyMatch !== null) {
                 let dependencyPath = dependencyMatch[1];
                 if (dependencyPath.startsWith('.')) {
@@ -350,7 +351,9 @@ function recursivelyGatherDependencySources(
     const lastPathSeparatorPos = contractPath.lastIndexOf('/');
     const contractFolder = lastPathSeparatorPos === -1 ? '' : contractPath.slice(0, lastPathSeparatorPos + 1);
     for (const importStatementMatch of importStatementMatches) {
-        const importPathMatches = importStatementMatch.match(/\"([^\"]*)\"/);
+        const importPathMatches =
+            importStatementMatch.match(constants.DEPENDENCY_PATH_REGEX_DOUBLE_QUOTES) ??
+            importStatementMatch.match(constants.DEPENDENCY_PATH_REGEX_SINGLE_QUOTES);
         if (importPathMatches === null || importPathMatches.length === 0) {
             continue;
         }

sol-compiler/src/utils/constants.ts

@@ -66,4 +66,6 @@ export const constants = {
         '0.1.2': 'soljson-v0.1.2+commit.d0d36e3.js',
         '0.1.1': 'soljson-v0.1.1+commit.6ff4cd6.js',
     },
+    DEPENDENCY_PATH_REGEX_DOUBLE_QUOTES: /"([^"]+)"/,
+    DEPENDENCY_PATH_REGEX_SINGLE_QUOTES: /'([^']+)'/,
 };

sol-compiler/test/compiler_utils_test.ts

@@ -73,6 +73,18 @@ describe('Compiler utils', () => {
                 'zeppelin-solidity/contracts/token/ERC20/ERC20.sol',
             ]);
         });
+        it('correctly parses single quote dependencies', async () => {
+            const path = `${__dirname}/fixtures/contracts/SingleQuoteImports.sol`;
+            const source = await fsWrapper.readFileAsync(path, {
+                encoding: 'utf8',
+            });
+            const dependencies = parseDependencies({ source, path, absolutePath: path });
+            const expectedDependencies = ['SomeDependency.sol'];
+            _.each(expectedDependencies, expectedDepdency => {
+                const foundDependency = _.find(dependencies, dependency => _.endsWith(dependency, expectedDepdency));
+                expect(foundDependency, `${expectedDepdency} not found`).to.not.be.undefined();
+            });
+        });
         // TODO: For now that doesn't work. This will work after we switch to a grammar-based parser
         it.skip('correctly parses commented out dependencies', async () => {
             const path = '';

sol-compiler/test/fixtures/contracts/SingleQuoteImports.sol

@@ -0,0 +1,7 @@
+pragma solidity >0.7.0;
+
+import './SomeDependency.sol';
+
+library SomeLibrary {
+    
+}