eolang 0.6.0 → 0.8.0

package/README.md

@@ -1,6 +1,13 @@
-<img alt="logo" src="https://www.objectionary.com/cactus.svg" height="100px" />
+<img alt="logo" src="https://www.objectionary.com/cactus.svg" height="92px" />
+
+[![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)
+[![We recommend IntelliJ IDEA](https://www.elegantobjects.org/intellij-idea.svg)](https://www.jetbrains.com/idea/)
 
 [![grunt](https://github.com/objectionary/eoc/actions/workflows/grunt.yml/badge.svg)](https://github.com/objectionary/eoc/actions/workflows/grunt.yml)
+[![PDD status](http://www.0pdd.com/svg?name=objectionary/eoc)](http://www.0pdd.com/p?name=objectionary/eoc)
+[![Hits-of-Code](https://hitsofcode.com/github/objectionary/eoc)](https://hitsofcode.com/view/github/objectionary/eoc)
+![Lines of code](https://img.shields.io/tokei/lines/github/objectionary/eoc)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/objectionary/eoc/blob/master/LICENSE.txt)
 
 First, you install [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
 and [Java SE](https://www.oracle.com/java/technologies/downloads/).
@@ -33,17 +40,17 @@ That's it.
 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)):
 
-  * `register` finds necessary EO files and registers the in a CSV
-  * `assemble` parses EO files into XMIR, optimizes them, pulls foreign EO objects
-  * `transpile` converts XMIR to target programming language
-  * `compile` converts target language to binaries
+  * `register` finds necessary EO files and registers them in a JSON catalog
+  * `assemble` parses EO files into XMIR, optimizes them, and pulls foreign EO objects
+  * `transpile` converts XMIR to target programming language (Java by default)
+  * `compile` converts target language sources 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
+  * `dataize` dataizes a single object from the executable binary
+  * `test` dataizes all visible unit tests
 
 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
+  * `audit` inspects all required packages and reports their status
   * `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>
@@ -64,4 +71,4 @@ If you want to run a single test:
 $ npm test -- test/test_mvnw.js
 ```
 
-Then, make a pull request.
+Make your changes and then [make](https://www.yegor256.com/2014/04/15/github-guidelines.html) a pull request.

package/itest/story.eo

@@ -24,6 +24,7 @@
   QQ.txt.sprintf > @
     "Hello, Mr. #%d!\n"
     as-int.
-      times.
-        random
-        100.0
+      QQ.math.number
+        times.
+          QQ.math.random
+          100.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eolang",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "author": "Yegor Bugayenko <yegor256@gmail.com> (https://www.yegor256.com/)",
   "license": "MIT",
   "repository": "objectionary/eoc",

package/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:base"
+  ]
+}

package/src/commands/clean.js

@@ -24,6 +24,7 @@
 
 const fs = require('fs');
 const path = require('path');
+const os = require('os');
 
 /**
  * Deletes all temporary files.
@@ -32,5 +33,12 @@ const path = require('path');
 module.exports = function(opts) {
   const home = path.resolve(opts.target);
   fs.rmSync(home, {recursive: true, force: true});
-  console.debug('The directory %s deleted', home);
+  console.info('The directory %s deleted', home);
+  if (opts.cached) {
+    const eo = path.join(os.homedir(), '.eo');
+    if (fs.existsSync(eo)) {
+      fs.rmSync(eo, {recursive: true});
+      console.info('The directory ~/.eo was deleted');
+    }
+  }
 };

package/src/commands/dataize.js

@@ -28,15 +28,17 @@ const path = require('path');
 /**
  * Runs the single executable binary.
  * @param {String} obj - Name of object to dataize
+ * @param {Array} args - Arguments
  * @param {Hash} opts - All options
  */
-module.exports = function(obj, opts) {
+module.exports = function(obj, args, opts) {
   spawn(
     `java`,
     [
       '-Dfile.encoding=UTF-8',
       '-jar', path.resolve(opts.target, 'eoc.jar'),
       obj,
+      ...args,
     ],
     {stdio: 'inherit'}
   );

package/src/commands/gmi.js

@@ -0,0 +1,45 @@
+/*
+ * 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 mvnwSync = require('../mvnw');
+const parserVersion = require('../parser-version');
+
+/**
+ * Generate GMI files from XMIR.
+ * @param {Hash} opts - All options
+ */
+module.exports = function(opts) {
+  mvnwSync([
+    'eo:gmi',
+    '-Deo.version=' + (opts.parserVersion ? opts.parserVersion : parserVersion()),
+    opts.verbose ? '' : '--quiet',
+    opts.gmi_xml ? '' : '-Deo.generateGmiXmlFiles',
+    opts.gmi_xembly ? '' : '-Deo.generateXemblyFiles',
+    opts.gmi_graph ? '' : '-Deo.generateGraphFiles',
+    opts.gmi_dot ? '' : '-Deo.generateDotFiles',
+    `-Deo.targetDir=${path.resolve(opts.target)}`,
+  ]);
+  console.info('GMI files generated in %s', path.resolve(opts.target));
+};

package/src/commands/transpile.js

@@ -23,6 +23,7 @@
  */
 
 const mvnwSync = require('../mvnw');
+const fs = require('fs');
 const path = require('path');
 const parserVersion = require('../parser-version');
 
@@ -32,6 +33,10 @@ const parserVersion = require('../parser-version');
  */
 module.exports = function(opts) {
   const sources = path.resolve(opts.target, 'generated-sources');
+  if (fs.existsSync(sources)) {
+    fs.rmSync(sources, {recursive: true, force: true});
+    console.info('Previously existed Java sources deleted in %s', sources);
+  }
   mvnwSync([
     'eo:transpile',
     '-Deo.version=' + (opts.parserVersion ? opts.parserVersion : parserVersion()),

package/src/eoc.js

@@ -28,6 +28,7 @@ const tinted = require('./tinted-console');
 const audit = require('./commands/audit');
 const clean = require('./commands/clean');
 const assemble = require('./commands/assemble');
+const gmi = require('./commands/gmi');
 const register = require('./commands/register');
 const transpile = require('./commands/transpile');
 const compile = require('./commands/compile');
@@ -44,7 +45,7 @@ if (process.argv.includes('--verbose')) {
 
 program
   .name('eoc')
-  .description('EO command-line toolkit')
+  .description('EO command-line toolkit (' + require('./version') + ')')
   .version(require('./version'));
 
 program
@@ -58,21 +59,26 @@ program
   .option('--verbose', 'print debug messages and full output of child processes');
 
 program.command('audit')
-  .description('inspects all packages and reports their status')
+  .description('inspect all packages and report their status')
   .action((str, opts) => {
     audit(program.opts());
   });
 
 program.command('foreign')
-  .description('inspects and prints the list of foreign objects')
+  .description('inspect and print the list of foreign objects')
   .action((str, opts) => {
     foreign(program.opts());
   });
 
-program.command('clean')
+program
+  .command('clean')
+  .option('--cached', 'delete ~/.eo directory')
   .description('delete all temporary files')
   .action((str, opts) => {
-    clean(program.opts());
+    clean({
+        cached: str.cached,
+        ...program.opts(),
+    });
   });
 
 program.command('register')
@@ -90,8 +96,22 @@ program.command('assemble')
     assemble(program.opts());
   });
 
+program.command('gmi')
+  .description('generate GMI files from XMIR')
+  .option('--gmi-xml', 'generate .gmi.xml files')
+  .option('--gmi-xembly', 'generate .gmi.xe files')
+  .option('--gmi-graph', 'generate .gmi.graph files')
+  .option('--gmi-dot', 'generate .gmi.dot files')
+  .action((str, opts) => {
+    if (program.opts().alone == undefined) {
+      register(program.opts());
+      assemble(program.opts());
+    }
+    gmi(program.opts());
+  });
+
 program.command('transpile')
-  .description('converts EO files into target language')
+  .description('convert EO files into target language')
   .action((str, opts) => {
     if (program.opts().alone == undefined) {
       register(program.opts());
@@ -101,7 +121,7 @@ program.command('transpile')
   });
 
 program.command('compile')
-  .description('compiles target language sources into binaries')
+  .description('compile target language sources into binaries')
   .action((str, opts) => {
     if (program.opts().alone == undefined) {
       register(program.opts());
@@ -133,7 +153,7 @@ program.command('dataize')
       compile(program.opts());
       link(program.opts());
     }
-    dataize(program.args[1], program.opts());
+    dataize(program.args[1], program.args.slice(2), program.opts());
   });
 
 program.command('test')

package/src/version.js

@@ -22,4 +22,4 @@
  * SOFTWARE.
  */
 
-module.exports = '0.6.0';
+module.exports = '0.8.0';