eolang 0.3.0 → 0.5.0

package/CITATION.cff

@@ -0,0 +1,11 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Bugayenko"
+  given-names: "Yegor"
+  orcid: "https://orcid.org/0000-0001-6370-0678"
+title: "EOLANG and 𝜑-calculus"
+version: 0.23.0
+doi: 10.48550/arXiv.2111.13384
+date-released: 2022-05-09
+url: "https://github.com/objectionary/eoc"

package/README.md

@@ -28,6 +28,8 @@ $ eoc dataize hello
 
 That's it.
 
+## Commands
+
 You can also do many other things with `eoc` commands
 (the flow is explained in [this blog post](https://www.yegor256.com/2021/10/21/objectionary.html)):
 
@@ -37,15 +39,17 @@ You can also do many other things with `eoc` commands
   * `compile` converts target language to binaries
   * `link` puts all binaries together into a single executable binary
   * `dataize` executes the binary and dataize a single object
+  * `test` executes all visible unit tests
 
-There are also commands that help manipulate with XMIR and EO sources:
+There are also commands that help manipulate with XMIR and EO sources (some of them are not implemented as of yet):
 
   * `audit` inspects all packages and report their status
-  * `translate` converts Java/C++/Python/etc. program to EO program
-  * `demu` removes `cage` and `memory` objects
-  * `dejump` removes `goto` objects
-  * `infer` suggests object names where it's possible to infer them
-  * `flatten` moves inner objects to upper level
+  * `foreign` inspects all objects found in the program after `assemble` step
+  * <del>`translate` converts Java/C++/Python/etc. program to EO program</del>
+  * <del>`demu` removes `cage` and `memory` objects</del>
+  * <del>`dejump` removes `goto` objects</del>
+  * <del>`infer` suggests object names where it's possible to infer them</del>
+  * <del>`flatten` moves inner objects to upper level</del>
 
 This command line toolkit simply integrates other tools available in
 [@objectionary](https://github.com/objectionary) GitHub organization.

package/itest/README.md

@@ -1,10 +1,10 @@
 [![grunt](https://github.com/objectionary/eoc/actions/workflows/itest.yml/badge.svg)](https://github.com/objectionary/eoc/actions/workflows/itest.yml)
 
-There is a simple integration here. Just run this to make sure
+There is a simple integration test here. Just run this to make sure
 it works:
 
 ```
-$ ../src/eoc.js dataize foo.program
+$ ../src/eoc.js dataize program
 ```
 
 Then, you can execute the unit tests too:

package/mvnw/pom.xml

@@ -27,6 +27,10 @@ SOFTWARE.
   <groupId>org.eolang</groupId>
   <artifactId>eoc</artifactId>
   <version>1.0-SNAPSHOT</version>
+  <properties>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+  </properties>
   <dependencies>
     <dependency>
       <groupId>org.junit.jupiter</groupId>
@@ -52,6 +56,8 @@ SOFTWARE.
         <version>${eo.version}</version>
         <configuration>
           <excludeSources>.eoc/**</excludeSources>
+          <foreign>${project.build.directory}/eo-foreign.json</foreign>
+          <foreignFormat>json</foreignFormat>
         </configuration>
       </plugin>
       <plugin>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eolang",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "author": "Yegor Bugayenko <yegor256@gmail.com> (https://www.yegor256.com/)",
   "license": "MIT",
   "repository": "objectionary/eoc",
@@ -21,6 +21,7 @@
     "eoc": "./src/eoc.js"
   },
   "dependencies": {
+    "colors": "1.4.0",
     "commander": "9.2.0",
     "fast-xml-parser": "4.0.0",
     "xmlhttprequest": "1.8.0"

package/src/commands/assemble.js

@@ -1,4 +1,3 @@
-#! /usr/bin/env node
 /*
  * The MIT License (MIT)
  *
@@ -33,11 +32,12 @@ const mvnwSync = require('../mvnw');
 module.exports = function assemble(opts) {
   mvnwSync([
     'eo:assemble',
+    opts.verbose ? '' : '--quiet',
+    opts.trackOptimizationSteps ? '-Deo.trackOptimizationSteps' : '',
     `-Deo.targetDir=${path.resolve(opts.target)}`,
     `-Deo.outputDir=${path.resolve(opts.target, 'classes')}`,
-    `-Deo.foreign=${path.resolve(opts.target, 'eo-foreign.csv')}`,
-    `-Deo.foreignFormat=csv`,
     `-Deo.placed=${path.resolve(opts.target, 'eo-placed.csv')}`,
     `-Deo.placedFormat=csv`,
   ]);
+  console.info('EO program assembled in %s', path.resolve(opts.target));
 };

package/src/commands/audit.js

@@ -1,4 +1,3 @@
-#! /usr/bin/env node
 /*
  * The MIT License (MIT)
  *

package/src/commands/clean.js

@@ -1,4 +1,3 @@
-#! /usr/bin/env node
 /*
  * The MIT License (MIT)
  *
@@ -33,4 +32,5 @@ const path = require('path');
 module.exports = function clean(opts) {
   const home = path.resolve(opts.target);
   fs.rmSync(home, {recursive: true, force: true});
+  console.debug('The directory %s deleted', home);
 };

package/src/commands/compile.js

@@ -1,4 +1,3 @@
-#! /usr/bin/env node
 /*
  * The MIT License (MIT)
  *
@@ -31,11 +30,14 @@ const path = require('path');
  * @param {Hash} opts - All options
  */
 module.exports = function compile(opts) {
+  const target = path.resolve(opts.target);
   mvnwSync([
     'compiler:compile',
+    opts.verbose ? '' : '--quiet',
     `-Dmaven.compiler.source=1.8`,
     `-Dmaven.compiler.target=1.8`,
-    `-Deo.targetDir=${path.resolve(opts.target)}`,
+    `-Deo.targetDir=${target}`,
     `-Deo.generatedDir=${path.resolve(opts.target, 'generated-sources')}`,
   ]);
+  console.info('Java .class files compiled into %s', target);
 };

package/src/commands/dataize.js

@@ -1,4 +1,3 @@
-#! /usr/bin/env node
 /*
  * The MIT License (MIT)
  *
@@ -34,7 +33,11 @@ const path = require('path');
 module.exports = function dataize(obj, opts) {
   spawn(
     `java`,
-    ['-jar', path.resolve(opts.target, 'eoc.jar'), obj],
+    [
+      '-Dfile.encoding=UTF-8',
+      '-jar', path.resolve(opts.target, 'eoc.jar'),
+      obj,
+    ],
     {stdio: 'inherit'}
   );
 };

package/src/commands/foreign.js

@@ -0,0 +1,39 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2022 Yegor Bugayenko
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+const path = require('path');
+const fs = require('fs');
+
+/**
+ * Inspects and prints the list of foreign objects.
+ * @param {Hash} opts - All options
+ */
+module.exports = function foreign(opts) {
+  const file = path.resolve(opts.target, 'eo-foreign.json');
+  const all = JSON.parse(fs.readFileSync(file, 'utf8'));
+  console.info('There are %d objects in %s:', all.length, file);
+  all.forEach((obj) => {
+    console.info('  %s', obj['id']);
+  });
+};

package/src/commands/link.js

@@ -1,4 +1,3 @@
-#! /usr/bin/env node
 /*
  * The MIT License (MIT)
  *
@@ -33,6 +32,8 @@ const path = require('path');
 module.exports = function link(opts) {
   mvnwSync([
     'jar:jar',
+    opts.verbose ? '' : '--quiet',
     `-Deo.targetDir=${path.resolve(opts.target)}`,
   ]);
+  console.info('Executable JAR created at %s', path.resolve(opts.target, 'eoc.jar'));
 };

package/src/commands/register.js

@@ -1,4 +1,3 @@
-#! /usr/bin/env node
 /*
  * The MIT License (MIT)
  *
@@ -31,11 +30,12 @@ const path = require('path');
  * @param {Hash} opts - All options
  */
 module.exports = function register(opts) {
+  const foreign = path.resolve(opts.target, 'eo-foreign.json');
   mvnwSync([
     'eo:register',
+    opts.verbose ? '' : '--quiet',
     `-Deo.targetDir=${path.resolve(opts.target)}`,
     `-Deo.sourcesDir=${path.resolve(opts.sources)}`,
-    `-Deo.foreign=${path.resolve(opts.target, 'eo-foreign.csv')}`,
-    `-Deo.foreignFormat=csv`,
   ]);
+  console.info('EO objects registered in %s', foreign);
 };

package/src/commands/test.js

@@ -1,4 +1,3 @@
-#! /usr/bin/env node
 /*
  * The MIT License (MIT)
  *

package/src/commands/transpile.js

@@ -1,4 +1,3 @@
-#! /usr/bin/env node
 /*
  * The MIT License (MIT)
  *
@@ -31,11 +30,12 @@ const path = require('path');
  * @param {Hash} opts - All options
  */
 module.exports = function transpile(opts) {
+  const sources = path.resolve(opts.target, 'generated-sources');
   mvnwSync([
     'eo:transpile',
+    opts.verbose ? '' : '--quiet',
     `-Deo.targetDir=${path.resolve(opts.target)}`,
-    `-Deo.generatedDir=${path.resolve(opts.target, 'generated-sources')}`,
-    `-Deo.foreign=${path.resolve(opts.target, 'eo-foreign.csv')}`,
-    `-Deo.foreignFormat=csv`,
+    `-Deo.generatedDir=${sources}`,
   ]);
+  console.info('Java sources generated in %s', sources);
 };

package/src/eoc.js

@@ -23,9 +23,8 @@
  * SOFTWARE.
  */
 
-const {Command} = require('commander');
-const program = new Command();
-
+const {program} = require('commander');
+const tinted = require('./tinted-console');
 const audit = require('./commands/audit');
 const clean = require('./commands/clean');
 const assemble = require('./commands/assemble');
@@ -34,8 +33,15 @@ const transpile = require('./commands/transpile');
 const compile = require('./commands/compile');
 const link = require('./commands/link');
 const dataize = require('./commands/dataize');
+const foreign = require('./commands/foreign');
 const test = require('./commands/test');
 
+if (process.argv.includes('--verbose')) {
+  tinted.enable('debug');
+  console.debug('Debug output is turned ON');
+  console.info('INFO');
+}
+
 program
   .name('eoc')
   .description('EO command-line toolkit')
@@ -44,7 +50,10 @@ program
 program
   .option('-s, --sources <path>', 'directory with .EO sources', '.')
   .option('-t, --target <path>', 'directory with all generated files', '.eoc')
-  .option('--alone', 'just run a single command without dependencies');
+  .option('--alone', 'just run a single command without dependencies')
+  .option('--no-color', 'disable colorization of console messages')
+  .option('--track-optimization-steps', 'save intermediate XMIR files')
+  .option('--verbose', 'print debug messages and full output of child processes');
 
 program.command('audit')
   .description('inspects all packages and reports their status')
@@ -52,6 +61,12 @@ program.command('audit')
     audit(program.opts());
   });
 
+program.command('foreign')
+  .description('inspects and prints the list of foreign objects')
+  .action((str, opts) => {
+    foreign(program.opts());
+  });
+
 program.command('clean')
   .description('delete all temporary files')
   .action((str, opts) => {
@@ -135,6 +150,7 @@ program.command('test')
 try {
   program.parse(process.argv);
 } catch (e) {
-  console.log('eoc failed: "' + e.message + '"');
+  console.error(e.message);
+  console.debug(e.stack);
   process.exit(1);
 }

package/src/mvnw.js

@@ -1,4 +1,3 @@
-#! /usr/bin/env node
 /*
  * The MIT License (MIT)
  *
@@ -46,9 +45,9 @@ function latest() {
     }
     const xml = new XMLParser().parse(xhr.responseText);
     version = xml.metadata.versioning.release;
-    console.log('The latest version of ' + repo + ' at ' + url + ' is ' + version);
+    console.debug('The latest version of %s at %s is %s', repo, url, version);
   }
-  console.log('Current version of ' + repo + ' is ' + version);
+  console.debug('Current version of %s is %s', repo, version);
   return version;
 }
 
@@ -58,8 +57,10 @@ function latest() {
  */
 module.exports = function mvnwSync(args) {
   const home = path.resolve(__dirname, '../mvnw');
-  const bin = path.resolve(home, 'mvnw');
-  const params = args.concat([
+  const bin = path.resolve(home, 'mvnw') + (process.platform == 'win32' ? '.cmd' : '');
+  const params = args.filter(function(t) {
+    return t != '';
+  }).concat([
     '-Deo.version=' + latest(),
     '--errors',
     '--batch-mode',
@@ -67,8 +68,22 @@ module.exports = function mvnwSync(args) {
     '--fail-fast',
   ]);
   const cmd = bin + ' ' + params.join(' ');
-  console.log('+ ' + cmd);
-  const result = spawnSync(bin, params, {cwd: home, stdio: 'inherit'});
+  console.debug('+ %s', cmd);
+  const result = spawnSync(
+    bin,
+    process.platform == 'win32' ? params.map((p) => `"${p}"`) : params,
+    {
+      cwd: home,
+      stdio: 'inherit',
+      shell: (
+        process.platform == 'win32'
+        ?
+        'C:\\Windows\\SysWOW64\\WindowsPowerShell\\v1.0\\powershell.exe'
+        :
+        undefined
+      ),
+    }
+  );
   if (result.status != 0) {
     throw new Error('The command "' + cmd + '" exited with #' + result.status + ' code');
   }

package/src/tinted-console.js

@@ -0,0 +1,73 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2022 Yegor Bugayenko
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+const safe = require('colors/safe');
+const util = require('node:util');
+
+const levels = {
+  'trace': false,
+  'debug': false,
+  'info': true,
+  'warn': true,
+  'error': true,
+};
+
+const colors = {
+  'trace': 'gray',
+  'debug': 'gray',
+  'info': 'white',
+  'warn': 'orange',
+  'error': 'red',
+};
+
+for (const level in levels) {
+  if (levels.hasOwnProperty(level)) {
+    const lvl = level;
+    const before = console[lvl];
+    console[level] = function(...args) {
+      if (!levels[lvl]) {
+        return;
+      }
+      before.call(
+        before,
+        safe[colors[lvl]](util.format(...args))
+      );
+    };
+  }
+}
+
+/**
+ * Enable this particular logging level.
+ * @param {String} level - The level to enable
+ */
+module.exports.enable = function enable(level) {
+  for (const key in levels) {
+    if (levels.hasOwnProperty(level)) {
+      levels[key] = true;
+      if (key === level) {
+        break;
+      }
+    }
+  }
+};

package/src/version.js

@@ -1,4 +1,3 @@
-#! /usr/bin/env node
 /*
  * The MIT License (MIT)
  *
@@ -23,4 +22,4 @@
  * SOFTWARE.
  */
 
-module.exports = '0.3.0';
+module.exports = '0.5.0';