eolang 0.2.2 → 0.4.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

@@ -16,14 +16,14 @@ in the current directory:
 
 ```
 [args...] > hello
-  Q.org.eolang.io.stdout > @
+  QQ.io.stdout > @
     "Hello, world!\n"
 ```
 
 Then, you run it:
 
 ```
-$ eoc run hello
+$ eoc dataize hello
 ```
 
 That's it.
@@ -37,15 +37,16 @@ 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
+  * <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.
@@ -60,4 +61,4 @@ If you want to run a single test:
 $ npm test -- test/test_mvnw.js
 ```
 
-Then, make a pull request.
+Then, make a pull request.

package/itest/README.md

@@ -0,0 +1,16 @@
+[![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 test here. Just run this to make sure
+it works:
+
+```
+$ ../src/eoc.js dataize program
+```
+
+Then, you can execute the unit tests too:
+
+```
+$ ../src/eoc.js test
+```
+
+If doesn't work, submit an issue.

package/itest/program.eo

@@ -0,0 +1,27 @@
+# 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.
+
++alias story
+
+[args...] > program
+  QQ.io.stdout > @
+    story

package/itest/story-test.eo

@@ -0,0 +1,31 @@
+# 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.
+
++junit
++alias org.eolang.hamcrest.assert-that
++alias story
+
+[] > story-is-long-enough
+  assert-that > @
+    story.length
+    $.is
+      $.greater-than 1

package/itest/story.eo

@@ -0,0 +1,29 @@
+# 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.
+
+[] > story
+  QQ.txt.sprintf > @
+    "Hello, Mr. #%d!\n"
+    as-int.
+      times.
+        random
+        100.0

package/mvnw/pom.xml

@@ -27,11 +27,24 @@ SOFTWARE.
   <groupId>org.eolang</groupId>
   <artifactId>eoc</artifactId>
   <version>1.0-SNAPSHOT</version>
+  <dependencies>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-api</artifactId>
+      <version>5.6.2</version>
+    </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-engine</artifactId>
+      <version>5.6.2</version>
+    </dependency>
+  </dependencies>
   <build>
     <finalName>eoc</finalName>
     <sourceDirectory>${eo.generatedDir}</sourceDirectory>
     <directory>${eo.targetDir}</directory>
     <outputDirectory>${eo.targetDir}/classes</outputDirectory>
+    <testOutputDirectory>${eo.targetDir}/classes</testOutputDirectory>
     <plugins>
       <plugin>
         <groupId>org.eolang</groupId>
@@ -60,6 +73,13 @@ SOFTWARE.
           </archive>
         </configuration>
       </plugin>
+      <plugin>
+        <artifactId>maven-surefire-plugin</artifactId>
+        <version>3.0.0-M7</version>
+        <configuration>
+          <failIfNoTests>true</failIfNoTests>
+        </configuration>
+      </plugin>
     </plugins>
   </build>
 </project>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eolang",
-  "version": "0.2.2",
+  "version": "0.4.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

@@ -33,6 +33,7 @@ const mvnwSync = require('../mvnw');
 module.exports = function assemble(opts) {
   mvnwSync([
     'eo:assemble',
+    opts.verbose ? '' : '--quiet',
     `-Deo.targetDir=${path.resolve(opts.target)}`,
     `-Deo.outputDir=${path.resolve(opts.target, 'classes')}`,
     `-Deo.foreign=${path.resolve(opts.target, 'eo-foreign.csv')}`,
@@ -40,4 +41,5 @@ module.exports = function assemble(opts) {
     `-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/clean.js

@@ -33,4 +33,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

@@ -31,11 +31,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/link.js

@@ -33,6 +33,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

@@ -31,11 +31,14 @@ const path = require('path');
  * @param {Hash} opts - All options
  */
 module.exports = function register(opts) {
+  const foreign = path.resolve(opts.target, 'eo-foreign.csv');
   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.foreign=${foreign}`,
     `-Deo.foreignFormat=csv`,
   ]);
+  console.info('EO objects registered in %s', foreign);
 };

package/src/commands/test.js

@@ -0,0 +1,38 @@
+#! /usr/bin/env node
+/*
+ * 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 mvnwSync = require('../mvnw');
+const path = require('path');
+
+/**
+ * Command to run all available unit tests.
+ * @param {Hash} opts - All options
+ */
+module.exports = function test(opts) {
+  mvnwSync([
+    'surefire:test',
+    `-Deo.targetDir=${path.resolve(opts.target)}`,
+  ]);
+};

package/src/commands/transpile.js

@@ -31,11 +31,14 @@ 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.generatedDir=${sources}`,
     `-Deo.foreign=${path.resolve(opts.target, 'eo-foreign.csv')}`,
     `-Deo.foreignFormat=csv`,
   ]);
+  console.info('Java sources generated in %s', sources);
 };

package/src/eoc.js

@@ -23,8 +23,23 @@
  * 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');
+const register = require('./commands/register');
+const transpile = require('./commands/transpile');
+const compile = require('./commands/compile');
+const link = require('./commands/link');
+const dataize = require('./commands/dataize');
+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')
@@ -33,79 +48,100 @@ program
 
 program
   .option('-s, --sources <path>', 'directory with .EO sources', '.')
-  .option('-t, --target <path>', 'directory with all generated files', '.eoc');
+  .option('-t, --target <path>', 'directory with all generated files', '.eoc')
+  .option('--alone', 'just run a single command without dependencies')
+  .option('--verbose', 'print debug messages and full output of child processes');
 
 program.command('audit')
   .description('inspects all packages and reports their status')
-  .action((str, options) => {
-    const audit = require('./commands/audit');
+  .action((str, opts) => {
     audit(program.opts());
   });
 
 program.command('clean')
   .description('delete all temporary files')
-  .action((str, options) => {
-    const clean = require('./commands/clean');
+  .action((str, opts) => {
     clean(program.opts());
   });
 
 program.command('register')
   .description('register all visible EO source files')
-  .action((str, options) => {
-    const register = require('./commands/register');
+  .action((str, opts) => {
     register(program.opts());
   });
 
 program.command('assemble')
   .description('parse EO files into XMIR and join them with required dependencies')
-  .action((str, options) => {
-    const assemble = require('./commands/assemble');
+  .action((str, opts) => {
+    if (program.opts().alone == undefined) {
+      register(program.opts());
+    }
     assemble(program.opts());
   });
 
 program.command('transpile')
   .description('converts EO files into target language')
-  .action((str, options) => {
-    const transpile = require('./commands/transpile');
+  .action((str, opts) => {
+    if (program.opts().alone == undefined) {
+      register(program.opts());
+      assemble(program.opts());
+    }
     transpile(program.opts());
   });
 
 program.command('compile')
   .description('compiles target language sources into binaries')
-  .action((str, options) => {
-    const compile = require('./commands/compile');
+  .action((str, opts) => {
+    if (program.opts().alone == undefined) {
+      register(program.opts());
+      assemble(program.opts());
+      transpile(program.opts());
+    }
     compile(program.opts());
   });
 
 program.command('link')
   .description('link together all binaries into a single executable binary')
-  .action((str, options) => {
-    const link = require('./commands/link');
+  .action((str, opts) => {
+    if (program.opts().alone == undefined) {
+      register(program.opts());
+      assemble(program.opts());
+      transpile(program.opts());
+      compile(program.opts());
+    }
     link(program.opts());
   });
 
 program.command('dataize')
   .description('run the single executable binary and dataize an object')
-  .action((str, options) => {
-    const dataize = require('./commands/dataize');
+  .action((str, opts) => {
+    if (program.opts().alone == undefined) {
+      register(program.opts());
+      assemble(program.opts());
+      transpile(program.opts());
+      compile(program.opts());
+      link(program.opts());
+    }
     dataize(program.args[1], program.opts());
   });
 
-program.command('run')
-  .description('register, assemble, transpile, compile, link, and dataize an object')
-  .action((str, options) => {
-    const register = require('./commands/register');
-    register(program.opts());
-    const assemble = require('./commands/assemble');
-    assemble(program.opts());
-    const transpile = require('./commands/transpile');
-    transpile(program.opts());
-    const compile = require('./commands/compile');
-    compile(program.opts());
-    const link = require('./commands/link');
-    link(program.opts());
-    const dataize = require('./commands/dataize');
-    dataize(program.args[1], program.opts());
+program.command('test')
+  .description('run all visible unit tests')
+  .action((str, opts) => {
+    if (program.opts().alone == undefined) {
+      register(program.opts());
+      assemble(program.opts());
+      transpile(program.opts());
+      compile(program.opts());
+      link(program.opts());
+    }
+    test(program.opts());
   });
 
-program.parse();
+try {
+  program.parse(process.argv);
+} catch (e) {
+  console.error(e.message);
+  console.debug(e.stack);
+  process.exit(1);
+}

package/src/mvnw.js

@@ -46,9 +46,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;
 }
 
@@ -59,7 +59,9 @@ function latest() {
 module.exports = function mvnwSync(args) {
   const home = path.resolve(__dirname, '../mvnw');
   const bin = path.resolve(home, 'mvnw');
-  const params = args.concat([
+  const params = args.filter(function(t) {
+    return t != '';
+  }).concat([
     '-Deo.version=' + latest(),
     '--errors',
     '--batch-mode',
@@ -67,9 +69,9 @@ module.exports = function mvnwSync(args) {
     '--fail-fast',
   ]);
   const cmd = bin + ' ' + params.join(' ');
-  console.log('+ ' + cmd);
+  console.debug('+ %s', cmd);
   const result = spawnSync(bin, params, {cwd: home, stdio: 'inherit'});
   if (result.status != 0) {
-    throw new Error('Exit code: ' + result.status);
+    throw new Error('The command "' + cmd + '" exited with #' + result.status + ' code');
   }
 };

package/src/tinted-console.js

@@ -0,0 +1,74 @@
+#! /usr/bin/env node
+/*
+ * 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

@@ -23,4 +23,4 @@
  * SOFTWARE.
  */
 
-module.exports = '0.2.2';
+module.exports = '0.4.0';