Merge pull request #3959 from h1alexbel/3934

feat(#3934): `spdx` meta instead of `<license/>` node
objectionary · Feb 27, 2025 · 8c2d901 · 8c2d901 · 0pdd · Feb 27, 2025
2 parents 1e48c05 + b85834a
commit 8c2d901
Show file tree

Hide file tree

Showing 123 changed files with 237 additions and 420 deletions.
diff --git a/REUSE.toml b/REUSE.toml
@@ -32,7 +32,7 @@ path = [
     "Gemfile.lock",
     "eo-maven-plugin/src/main/resources/org/eolang/maven/latex/latex-template.txt",
     "eo-maven-plugin/src/test/resources/org/eolang/maven/commits/tags.txt",
-    "eo-runtime/src/main/resources/org/eolang/version.txt",
+    "eo-runtime/src/main/resources/org/eolang/version.txt"
 ]
 precedence = "override"
 SPDX-FileCopyrightText = "Copyright (c) 2016-2025 Objectionary.com"

diff --git a/eo-maven-plugin/pom.xml b/eo-maven-plugin/pom.xml
@@ -23,7 +23,7 @@
     <dependency>
       <groupId>org.eolang</groupId>
       <artifactId>lints</artifactId>
-      <version>0.0.38</version>
+      <version>0.0.39</version>
     </dependency>
     <dependency>
       <groupId>org.glassfish</groupId>

diff --git a/eo-maven-plugin/src/main/java/org/eolang/maven/LintMojo.java b/eo-maven-plugin/src/main/java/org/eolang/maven/LintMojo.java
@@ -257,10 +257,16 @@ private static String summary(final ConcurrentHashMap<Severity, Integer> counts)
      * @param xmir The XML before linting
      * @param counts Counts of errors, warnings, and critical
      * @return XML after linting
+     * @todo #3934:35min Remove .without() from Program to enable `unknown-metas`
+     *  and `unsorted-metas` lints. Currently we disabled them since lints does not
+     *  support `+spdx` meta yet. Once <a href="https://github.com/objectionary/lints/issues/354">this</a>
+     *  issue will be resolved, we should enable all lints.
      */
     private static XML linted(final XML xmir, final ConcurrentHashMap<Severity, Integer> counts) {
         final Directives dirs = new Directives();
-        final Collection<Defect> defects = new Program(xmir).defects();
+        final Collection<Defect> defects = new Program(xmir).without(
+            "unknown-metas", "unsorted-metas"
+        ).defects();
         if (!defects.isEmpty()) {
             dirs.xpath("/program").addIf("errors").strict(1);
             LintMojo.embed(xmir, defects);

diff --git a/eo-maven-plugin/src/test/resources/org/eolang/maven/mess.eo b/eo-maven-plugin/src/test/resources/org/eolang/maven/mess.eo
@@ -1,6 +1,5 @@
-# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
-# SPDX-License-Identifier: MIT
-
++spdx SPDX-FileCopyrightText Copyright (c) 2016-2025 Objectionary.com
++spdx SPDX-License-Identifier: MIT
 +alias org.eolang.io.stdout
 +architect [email protected]
 +home https://github.com/objectionary/eo

diff --git a/eo-parser/src/main/antlr4/org/eolang/parser/Eo.g4 b/eo-parser/src/main/antlr4/org/eolang/parser/Eo.g4
@@ -8,18 +8,13 @@ tokens { TAB, UNTAB }
 
 // Entry point
 program
-    : license? metas? objects EOF
+    : metas? objects EOF
     ;
 
 // Double EOL
 eop : EOL EOL
     ;
 
-// Licence
-license
-    : (COMMENTARY EOL)* COMMENTARY eop
-    ;
-
 // Metas
 metas
     : (META EOL)* META eop

diff --git a/eo-parser/src/main/java/org/eolang/parser/XeEoListener.java b/eo-parser/src/main/java/org/eolang/parser/XeEoListener.java
@@ -16,8 +16,6 @@
 import org.antlr.v4.runtime.tree.ErrorNode;
 import org.antlr.v4.runtime.tree.TerminalNode;
 import org.apache.commons.text.StringEscapeUtils;
-import org.cactoos.iterable.Mapped;
-import org.cactoos.text.Joined;
 import org.xembly.Directive;
 import org.xembly.Directives;
 
@@ -104,24 +102,6 @@ public void exitEop(final EoParser.EopContext ctx) {
         // Nothing here
     }
 
-    @Override
-    public void enterLicense(final EoParser.LicenseContext ctx) {
-        this.dirs.addIf("license").set(
-            new Joined(
-                "\n",
-                new Mapped<>(
-                    cmt -> cmt.getText().substring(1).trim(),
-                    ctx.COMMENTARY()
-                )
-            )
-        ).up();
-    }
-
-    @Override
-    public void exitLicense(final EoParser.LicenseContext ctx) {
-        // Nothing here
-    }
-
     @Override
     public void enterMetas(final EoParser.MetasContext ctx) {
         this.dirs.addIf("metas");

diff --git a/eo-parser/src/main/resources/XMIR.xsd b/eo-parser/src/main/resources/XMIR.xsd
@@ -9,7 +9,7 @@
     <xs:documentation>
       Every XMIR document is essentially an XML document that
       contains objects found in a EOLANG program together with
-      supplementary information, such as metas, license, and so on.
+      supplementary information, such as metas, and so on.
       The schema is used to validate the XMIR documents, which are
       generated by the EO parser. The schema defines the structure
       of the XMIR document, including the elements and attributes
@@ -252,21 +252,6 @@
       <xs:extension base="non-empty"/>
     </xs:simpleContent>
   </xs:complexType>
-  <xs:complexType name="license">
-    <xs:annotation>
-      <xs:appinfo>The entire license found in the source code</xs:appinfo>
-      <xs:documentation>
-        The element contains the entire text of the license found in the source code. This information is crucial for
-        understanding the legal terms under which the code can be used, modified, and distributed. By including the full
-        license text, developers and users can easily reference the licensing terms without needing to look up the
-        original source. This practice helps ensure compliance with the license and provides transparency regarding the
-        legal framework governing the code.
-      </xs:documentation>
-    </xs:annotation>
-    <xs:simpleContent>
-      <xs:extension base="non-empty"/>
-    </xs:simpleContent>
-  </xs:complexType>
   <xs:simpleType name="sheet">
     <xs:annotation>
       <xs:appinfo>The XSL stylesheet that was applied to the XMIR</xs:appinfo>
@@ -375,7 +360,6 @@
           </xs:sequence>
         </xs:complexType>
       </xs:element>
-      <xs:element name="license" type="license" minOccurs="0"/>
       <xs:element name="metas" minOccurs="0">
         <xs:complexType>
           <xs:sequence>

diff --git a/eo-parser/src/test/resources/org/eolang/parser/eo-syntax/full-syntax.yaml b/eo-parser/src/test/resources/org/eolang/parser/eo-syntax/full-syntax.yaml
@@ -4,7 +4,6 @@
 sheets: [ ]
 asserts:
   - /program[not(errors)]
-  - /program/license[text()!='']
   - /program/metas[count(meta)=4]
   - /program/metas/meta[head='foo' and tail='']
   - //o[@base='Q.org.eolang.true']
@@ -18,10 +17,6 @@ asserts:
   - //o[@atom and @name='atom' and count(o)=2 and o[@name='a']]
   - //o[@atom='org.eolang.number']
 input: |
-  # The purpose of this test case is to make
-  # sure all possible syntax scenarios can
-  # be parsed by the ANTLR
-
   +alias org.example.foo
   +alias Test Test
   +bar Some text

diff --git a/eo-parser/src/test/resources/org/eolang/parser/eo-syntax/leap-year.yaml b/eo-parser/src/test/resources/org/eolang/parser/eo-syntax/leap-year.yaml
@@ -7,11 +7,6 @@ asserts:
   - /program/objects[count(o)=1]
   - //o[@base='.and']
 input: |
-  # This program is from the EOLANG original paper
-  # and must produce a working command line tool
-  #
-  # License is MIT
-
   +alias org.eolang.io.stdin
   +alias org.eolang.io.stdout
   +alias org.eolang.txt.scanner

diff --git a/eo-parser/src/test/resources/org/eolang/parser/factorial.eo b/eo-parser/src/test/resources/org/eolang/parser/factorial.eo
@@ -1,6 +1,7 @@
-# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
-# SPDX-License-Identifier: MIT
++spdx SPDX-FileCopyrightText Copyright (c) 2016-2025 Objectionary.com
++spdx SPDX-License-Identifier: MIT
 
+# F.
 [n] > f
   if. > @
     n.lt 1

diff --git a/eo-parser/src/test/resources/org/eolang/parser/fibonacci.eo b/eo-parser/src/test/resources/org/eolang/parser/fibonacci.eo
@@ -1,6 +1,5 @@
-# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
-# SPDX-License-Identifier: MIT
-
++spdx SPDX-FileCopyrightText Copyright (c) 2016-2025 Objectionary.com
++spdx SPDX-License-Identifier: MIT
 +meta This is just a test META
 +meta2 And yet another one
 

diff --git a/eo-parser/src/test/resources/org/eolang/parser/phi-packs/bool-tests.yaml b/eo-parser/src/test/resources/org/eolang/parser/phi-packs/bool-tests.yaml
@@ -2,28 +2,6 @@
 # SPDX-License-Identifier: MIT
 ---
 input: |
-  # The MIT License (MIT)
-  #
-  # Copyright (c) 2016-2025 Objectionary.com
-  #
-  # 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.
-
   +architect [email protected]
   +home https://github.com/objectionary/eo
   +tests

diff --git a/eo-parser/src/test/resources/org/eolang/parser/print-packs/yaml/idiomatic.yaml b/eo-parser/src/test/resources/org/eolang/parser/print-packs/yaml/idiomatic.yaml
@@ -2,9 +2,6 @@
 # SPDX-License-Identifier: MIT
 ---
 origin: |
-  # This is the license part
-  # of the program
-
   +meta1
   +meta2 short
   +meta2 long tail
@@ -33,9 +30,6 @@ origin: |
             "hello, 大家!"
 
 printed: |
-  # This is the license part
-  # of the program
-
   +meta1
   +meta2 short
   +meta2 long tail

diff --git a/eo-runtime/src/main/eo/org/eolang/bytes.eo b/eo-runtime/src/main/eo/org/eolang/bytes.eo
@@ -1,6 +1,5 @@
-# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
-# SPDX-License-Identifier: MIT
-
++spdx SPDX-FileCopyrightText Copyright (c) 2016-2025 Objectionary.com
++spdx SPDX-License-Identifier: MIT
 +alias org.eolang.txt.sprintf
 +architect [email protected]
 +home https://github.com/objectionary/eo

diff --git a/eo-runtime/src/main/eo/org/eolang/cti.eo b/eo-runtime/src/main/eo/org/eolang/cti.eo
@@ -1,6 +1,5 @@
-# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
-# SPDX-License-Identifier: MIT
-
++spdx SPDX-FileCopyrightText Copyright (c) 2016-2025 Objectionary.com
++spdx SPDX-License-Identifier: MIT
 +architect [email protected]
 +home https://github.com/objectionary/eo
 +package org.eolang

diff --git a/eo-runtime/src/main/eo/org/eolang/dataized.eo b/eo-runtime/src/main/eo/org/eolang/dataized.eo
@@ -1,6 +1,5 @@
-# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
-# SPDX-License-Identifier: MIT
-
++spdx SPDX-FileCopyrightText Copyright (c) 2016-2025 Objectionary.com
++spdx SPDX-License-Identifier: MIT
 +architect [email protected]
 +home https://github.com/objectionary/eo
 +package org.eolang

diff --git a/eo-runtime/src/main/eo/org/eolang/error.eo b/eo-runtime/src/main/eo/org/eolang/error.eo
@@ -1,6 +1,5 @@
-# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
-# SPDX-License-Identifier: MIT
-
++spdx SPDX-FileCopyrightText Copyright (c) 2016-2025 Objectionary.com
++spdx SPDX-License-Identifier: MIT
 +architect [email protected]
 +home https://github.com/objectionary/eo
 +package org.eolang

diff --git a/eo-runtime/src/main/eo/org/eolang/false.eo b/eo-runtime/src/main/eo/org/eolang/false.eo
@@ -1,6 +1,5 @@
-# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
-# SPDX-License-Identifier: MIT
-
++spdx SPDX-FileCopyrightText Copyright (c) 2016-2025 Objectionary.com
++spdx SPDX-License-Identifier: MIT
 +architect [email protected]
 +home https://github.com/objectionary/eo
 +package org.eolang

diff --git a/eo-runtime/src/main/eo/org/eolang/fs/dir.eo b/eo-runtime/src/main/eo/org/eolang/fs/dir.eo
@@ -1,6 +1,5 @@
-# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
-# SPDX-License-Identifier: MIT
-
++spdx SPDX-FileCopyrightText Copyright (c) 2016-2025 Objectionary.com
++spdx SPDX-License-Identifier: MIT
 +alias org.eolang.txt.sprintf
 +architect [email protected]
 +home https://github.com/objectionary/eo

diff --git a/eo-runtime/src/main/eo/org/eolang/fs/file.eo b/eo-runtime/src/main/eo/org/eolang/fs/file.eo
@@ -1,6 +1,5 @@
-# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
-# SPDX-License-Identifier: MIT
-
++spdx SPDX-FileCopyrightText Copyright (c) 2016-2025 Objectionary.com
++spdx SPDX-License-Identifier: MIT
 +alias org.eolang.txt.sprintf
 +architect [email protected]
 +home https://github.com/objectionary/eo

diff --git a/eo-runtime/src/main/eo/org/eolang/fs/path.eo b/eo-runtime/src/main/eo/org/eolang/fs/path.eo
@@ -1,6 +1,5 @@
-# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
-# SPDX-License-Identifier: MIT
-
++spdx SPDX-FileCopyrightText Copyright (c) 2016-2025 Objectionary.com
++spdx SPDX-License-Identifier: MIT
 +alias org.eolang.fs.dir
 +alias org.eolang.fs.file
 +alias org.eolang.sys.os

diff --git a/eo-runtime/src/main/eo/org/eolang/fs/tmpdir.eo b/eo-runtime/src/main/eo/org/eolang/fs/tmpdir.eo
@@ -1,6 +1,5 @@
-# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
-# SPDX-License-Identifier: MIT
-
++spdx SPDX-FileCopyrightText Copyright (c) 2016-2025 Objectionary.com
++spdx SPDX-License-Identifier: MIT
 +alias org.eolang.fs.dir
 +alias org.eolang.fs.file
 +alias org.eolang.sys.getenv

diff --git a/eo-runtime/src/main/eo/org/eolang/go.eo b/eo-runtime/src/main/eo/org/eolang/go.eo
@@ -1,6 +1,5 @@
-# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
-# SPDX-License-Identifier: MIT
-
++spdx SPDX-FileCopyrightText Copyright (c) 2016-2025 Objectionary.com
++spdx SPDX-License-Identifier: MIT
 +architect [email protected]
 +home https://github.com/objectionary/eo
 +package org.eolang

diff --git a/eo-runtime/src/main/eo/org/eolang/i16.eo b/eo-runtime/src/main/eo/org/eolang/i16.eo
@@ -1,6 +1,5 @@
-# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
-# SPDX-License-Identifier: MIT
-
++spdx SPDX-FileCopyrightText Copyright (c) 2016-2025 Objectionary.com
++spdx SPDX-License-Identifier: MIT
 +alias org.eolang.txt.sprintf
 +architect [email protected]
 +home https://github.com/objectionary/eo

diff --git a/eo-runtime/src/main/eo/org/eolang/i32.eo b/eo-runtime/src/main/eo/org/eolang/i32.eo
@@ -1,6 +1,5 @@
-# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
-# SPDX-License-Identifier: MIT
-
++spdx SPDX-FileCopyrightText Copyright (c) 2016-2025 Objectionary.com
++spdx SPDX-License-Identifier: MIT
 +alias org.eolang.txt.sprintf
 +architect [email protected]
 +home https://github.com/objectionary/eo

diff --git a/eo-runtime/src/main/eo/org/eolang/i64.eo b/eo-runtime/src/main/eo/org/eolang/i64.eo
@@ -1,6 +1,5 @@
-# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
-# SPDX-License-Identifier: MIT
-
++spdx SPDX-FileCopyrightText Copyright (c) 2016-2025 Objectionary.com
++spdx SPDX-License-Identifier: MIT
 +alias org.eolang.txt.sprintf
 +architect [email protected]
 +home https://github.com/objectionary/eo

diff --git a/eo-runtime/src/main/eo/org/eolang/io/bytes-as-input.eo b/eo-runtime/src/main/eo/org/eolang/io/bytes-as-input.eo
@@ -1,6 +1,5 @@
-# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
-# SPDX-License-Identifier: MIT
-
++spdx SPDX-FileCopyrightText Copyright (c) 2016-2025 Objectionary.com
++spdx SPDX-License-Identifier: MIT
 +architect [email protected]
 +home https://github.com/objectionary/eo
 +package org.eolang.io

diff --git a/eo-runtime/src/main/eo/org/eolang/io/console.eo b/eo-runtime/src/main/eo/org/eolang/io/console.eo
@@ -1,6 +1,5 @@
-# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
-# SPDX-License-Identifier: MIT
-
++spdx SPDX-FileCopyrightText Copyright (c) 2016-2025 Objectionary.com
++spdx SPDX-License-Identifier: MIT
 +alias org.eolang.sys.os
 +alias org.eolang.sys.posix
 +alias org.eolang.sys.win32

diff --git a/eo-runtime/src/main/eo/org/eolang/io/dead-input.eo b/eo-runtime/src/main/eo/org/eolang/io/dead-input.eo
@@ -1,6 +1,5 @@
-# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
-# SPDX-License-Identifier: MIT
-
++spdx SPDX-FileCopyrightText Copyright (c) 2016-2025 Objectionary.com
++spdx SPDX-License-Identifier: MIT
 +architect [email protected]
 +home https://github.com/objectionary/eo
 +package org.eolang.io

diff --git a/eo-runtime/src/main/eo/org/eolang/io/dead-output.eo b/eo-runtime/src/main/eo/org/eolang/io/dead-output.eo
@@ -1,6 +1,5 @@
-# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
-# SPDX-License-Identifier: MIT
-
++spdx SPDX-FileCopyrightText Copyright (c) 2016-2025 Objectionary.com
++spdx SPDX-License-Identifier: MIT
 +architect [email protected]
 +home https://github.com/objectionary/eo
 +package org.eolang.io

diff --git a/eo-runtime/src/main/eo/org/eolang/io/input-length.eo b/eo-runtime/src/main/eo/org/eolang/io/input-length.eo
@@ -1,6 +1,5 @@
-# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
-# SPDX-License-Identifier: MIT
-
++spdx SPDX-FileCopyrightText Copyright (c) 2016-2025 Objectionary.com
++spdx SPDX-License-Identifier: MIT
 +architect [email protected]
 +home https://github.com/objectionary/eo
 +package org.eolang.io