Merge pull request #4031 from headius/split-maven-artifacts

Split maven artifacts into component libraries

Author: kddnewton

.github/dependabot.yml

@@ -9,7 +9,7 @@ updates:
         patterns:
           - "*"
   - package-ecosystem: 'maven'
-    directory: '/java-wasm'
+    directory: '/java/wasm'
     schedule:
       interval: 'weekly'
     groups:

.github/workflows/documentation.yml

@@ -36,8 +36,7 @@ jobs:
     - name: Check C coverage
       run: doxygen Doxyfile
     - name: Check Java coverage
-      run: javadoc -Xdoclint:all,-missing -d ../doc/java -subpackages *
-      working-directory: java
+      run: javadoc -Xdoclint:all,-missing -d doc/java -sourcepath java/api/target/generated-sources/java/:java/api/src/main/java org.ruby_lang.prism
     - name: Generate Rust documentation
       run: |
         bundle exec rake cargo:build

.github/workflows/github-pages.yml

@@ -52,7 +52,7 @@ jobs:
         run: doxygen Doxyfile
       - name: Build with JavaDoc
         run: javadoc -Xdoclint:all,-missing -d ../doc/java -subpackages *
-        working-directory: java
+        working-directory: java/api
       - name: Build with rustdoc
         run: |
           bundle exec rake cargo:build

.github/workflows/java-wasm-bindings.yml

@@ -8,7 +8,7 @@ on:
       - "src/"
       - "*akefile*"
       - "java/"
-      - "java-wasm/"
+      - "java/wasm/"
     branches:
       - main
       - ruby-4.0
@@ -44,11 +44,15 @@ jobs:
           java-version: '21'
           cache: maven
 
-      - name: Run the tests
-        run: mvn -B install
-        working-directory: java-wasm
+      - name: Build the Java artifacts
+        run: mvn -ntp install
+        working-directory: java
+
+      - name: Run the tests from the WASM module
+        run: mvn -ntp test
+        working-directory: java
 
       - uses: actions/upload-artifact@v7
         with:
           name: prism.wasm
-          path: java-wasm/src/test/resources/prism.wasm
+          path: java/wasm/src/test/resources/prism.wasm

.gitignore

@@ -42,7 +42,7 @@ out.svg
 /java/org/ruby_lang/prism/AbstractNodeVisitor.java
 /java/org/ruby_lang/prism/Loader.java
 /java/org/ruby_lang/prism/Nodes.java
-/java-wasm/src/test/resources/prism.wasm
+/java/wasm/src/test/resources/prism.wasm
 /lib/prism/compiler.rb
 /lib/prism/dispatcher.rb
 /lib/prism/dot_visitor.rb

Makefile

@@ -31,7 +31,7 @@ all: shared static
 shared: build/libprism.$(SOEXT)
 static: build/libprism.a
 wasm: javascript/src/prism.wasm
-java-wasm: java-wasm/src/test/resources/prism.wasm
+java-wasm: java/wasm/src/test/resources/prism.wasm
 
 build/libprism.$(SOEXT): $(SHARED_OBJECTS)
 	$(ECHO) "linking $@ with $(CC)"
@@ -51,7 +51,7 @@ javascript/src/prism.wasm: Makefile $(SOURCES) $(HEADERS)
 		-Oz -g0 -flto -fdata-sections -ffunction-sections \
 		-o $@ $(SOURCES)
 
-java-wasm/src/test/resources/prism.wasm: Makefile $(SOURCES) $(HEADERS)
+java/wasm/src/test/resources/prism.wasm: Makefile $(SOURCES) $(HEADERS)
 	$(ECHO) "building $@"
 	$(Q) $(MAKEDIRS) $(@D)
 	$(Q) $(WASI_SDK_PATH)/bin/clang \

README.md

@@ -29,8 +29,10 @@ The repository contains the infrastructure for both a shared library (libprism)
 ├── include
 │   ├── prism             header files for the shared library
 │   └── prism.h           main header file for the shared library
-├── java                  Java bindings for the shared library
-├── java-wasm             Java WASM bindings for the shared library
+├── java
+|   ├── api               Java API for Prism
+|   ├── native            Java native bindings for the shared library
+|   └── wasm              Java WASM bindings for the shared library
 ├── javascript            JavaScript WASM bindings for the shared library
 ├── lib
 │   ├── prism             Ruby library files

Rakefile

@@ -43,7 +43,7 @@ elsif RUBY_ENGINE == "jruby"
   # This compiles java to make sure any templating changes produces valid code.
   Rake::JavaExtensionTask.new(:compile) do |ext|
     ext.name = "prism"
-    ext.ext_dir = "java"
+    ext.ext_dir = "java/api"
     ext.lib_dir = "tmp"
     ext.release = "21"
     ext.gem_spec = Gem::Specification.load("prism.gemspec")
@@ -54,7 +54,7 @@ end
 CLOBBER.concat(Prism::Template::TEMPLATES)
 CLOBBER.concat(["build"])
 CLOBBER << "lib/prism/prism.#{RbConfig::CONFIG["DLEXT"]}"
-CLOBBER << "java-wasm/src/main/resources/prism.wasm"
+CLOBBER << "java/wasm/src/main/resources/prism.wasm"
 
 Prism::Template::TEMPLATES.each do |filepath|
   desc "Generate #{filepath}"

docs/configuration.md

@@ -8,9 +8,9 @@ A lot of code in prism's repository is templated from a single configuration fil
 * `include/prism/node_new.h` - for defining the functions that create the nodes in C
 * `javascript/src/deserialize.js` - for defining how to deserialize the nodes in JavaScript
 * `javascript/src/nodes.js` - for defining the nodes in JavaScript
-* `java/org/ruby_lang/prism/AbstractNodeVisitor.java` - for defining the visitor interface for the nodes in Java
-* `java/org/ruby_lang/prism/Loader.java` - for defining how to deserialize the nodes in Java
-* `java/org/ruby_lang/prism/Nodes.java` - for defining the nodes in Java
+* `java/api/target/generated-sources/java/org/ruby_lang/prism/AbstractNodeVisitor.java` - for defining the visitor interface for the nodes in Java
+* `java/api/target/generated-sources/java/org/ruby_lang/prism/Loader.java` - for defining how to deserialize the nodes in Java
+* `java/api/target/generated-sources/java/org/ruby_lang/prism/Nodes.java` - for defining the nodes in Java
 * `lib/prism/compiler.rb` - for defining the compiler for the nodes in Ruby
 * `lib/prism/dispatcher.rb` - for defining the dispatch visitors for the nodes in Ruby
 * `lib/prism/dot_visitor.rb` - for defining the dot visitor for the nodes in Ruby