metanorma-plugin-plantuml 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7c85595e30e3155c473b4f44936209c3f95c8ab5cf29d55a2368bad6584c136
-  data.tar.gz: d7e58a9934d9995c9b36c3b86dc543a7c633d0c31fab5dd543707b7f347207c8
+  metadata.gz: 93f98be4977dfd92a2a7b7d33a74d1f27bb9f93eb5a55116da04f64650c0a126
+  data.tar.gz: cfd9bf9c6d5f3e781047481784fcd7350a69ff87a86148cf41a60edf1ef16cdf
 SHA512:
-  metadata.gz: '05039945787b1a1d65f8a37193db39346f2d42ac820dff54d70724fbb09bdbe2808a9ca20477a78e78b1357f65de337c289a075feabf27c9e3ae92264e671865'
-  data.tar.gz: 1cff1673fbed5b3e00a6e05d7642cccce29e6d5f5d2cd62500860fddf089a8fc7046a2c49df41b422804b03eb762bd0bb6ac21d67e8763e6d38583f29df4e0ed
+  metadata.gz: 3a9cbefb6348ff7aacee1c9a2dae7ce0373bd1e015b2b0de184674f9440740e4f04b3a3cf50e7ebf4814b98c10ef0cf91df160974166e6ea04ddf730f8a79888
+  data.tar.gz: fdf26284b53c231dcb4cdafed24c400c18d7c323ad7f4c4506219cfa89395d818072d93c67a8714500ce906b426b583a1b4c2c8579dd6ed5f595c6b52753a1fa

data/.github/workflows/plantuml-version-sync.yml

@@ -8,7 +8,7 @@ on:
     # Allow manual triggering
 
 jobs:
-  check-plantuml-version:
+  update-plantuml:
     runs-on: ubuntu-latest
 
     steps:
@@ -23,91 +23,73 @@ jobs:
           ruby-version: '3.1'
           bundler-cache: true
 
-      - name: Get current PlantUML version
-        id: current-version
+      - name: Check for PlantUML updates
+        id: update
         run: |
-          CURRENT_VERSION=$(ruby -e "require './lib/metanorma/plugin/plantuml/version'; puts Metanorma::Plugin::Plantuml::PLANTUML_JAR_VERSION")
-          echo "version=$CURRENT_VERSION" >> $GITHUB_OUTPUT
-
-      - name: Get latest PlantUML release
-        id: latest-version
-        run: |
-          LATEST_VERSION=$(curl -s https://api.github.com/repos/plantuml/plantuml/releases/latest | jq -r .tag_name | sed 's/^v//')
-          echo "version=$LATEST_VERSION" >> $GITHUB_OUTPUT
-
-      - name: Compare versions
-        id: compare
-        run: |
-          if [ "${{ steps.current-version.outputs.version }}" != "${{ steps.latest-version.outputs.version }}" ]; then
-            echo "needs_update=true" >> $GITHUB_OUTPUT
-            echo "Current version: ${{ steps.current-version.outputs.version }}"
-            echo "Latest version: ${{ steps.latest-version.outputs.version }}"
+          # Run the update task and capture exit code
+          if rake update_plantuml; then
+            echo "update_made=false" >> $GITHUB_OUTPUT
+            echo "No update needed - PlantUML is up to date"
           else
-            echo "needs_update=false" >> $GITHUB_OUTPUT
-            echo "PlantUML version is up to date"
-          fi
-
-      - name: Update version file
-        if: steps.compare.outputs.needs_update == 'true'
-        run: |
-          NEW_VERSION="${{ steps.latest-version.outputs.version }}"
-          sed -i "s/PLANTUML_JAR_VERSION = \".*\"/PLANTUML_JAR_VERSION = \"$NEW_VERSION\"/" lib/metanorma/plugin/plantuml/version.rb
+            EXIT_CODE=$?
+            if [ $EXIT_CODE -eq 1 ]; then
+              echo "update_made=true" >> $GITHUB_OUTPUT
+              echo "Update completed successfully"
 
-      - name: Update gem version
-        if: steps.compare.outputs.needs_update == 'true'
-        run: |
-          # Increment patch version using semantic versioning
-          CURRENT_GEM_VERSION=$(ruby -e "require './lib/metanorma/plugin/plantuml/version'; puts Metanorma::Plugin::Plantuml::VERSION")
-          NEW_GEM_VERSION=$(ruby -e "
-            require 'rubygems'
-            current_version = Gem::Version.new('$CURRENT_GEM_VERSION')
-            segments = current_version.segments
-            segments[2] = (segments[2] || 0) + 1
-            puts segments.join('.')
-          ")
-          sed -i "s/VERSION = \".*\"/VERSION = \"$NEW_GEM_VERSION\"/" lib/metanorma/plugin/plantuml/version.rb
-          echo "Updated gem version from $CURRENT_GEM_VERSION to $NEW_GEM_VERSION"
+              # Get version info for PR
+              PLANTUML_VERSION=$(ruby -e "load 'lib/metanorma/plugin/plantuml/version.rb'; puts Metanorma::Plugin::Plantuml::PLANTUML_JAR_VERSION")
+              GEM_VERSION=$(ruby -e "load 'lib/metanorma/plugin/plantuml/version.rb'; puts Metanorma::Plugin::Plantuml::VERSION")
 
-      - name: Remove old JAR and download new one
-        if: steps.compare.outputs.needs_update == 'true'
-        run: |
-          rm -f data/plantuml.jar
-          bundle exec rake download_jar
-
-      - name: Verify new JAR works
-        if: steps.compare.outputs.needs_update == 'true'
-        run: |
-          if [ -f "data/plantuml.jar" ]; then
-            echo "PlantUML JAR downloaded successfully"
-            java -jar data/plantuml.jar -version || echo "Version check completed"
-          else
-            echo "Failed to download PlantUML JAR"
-            exit 1
+              echo "plantuml_version=$PLANTUML_VERSION" >> $GITHUB_OUTPUT
+              echo "gem_version=$GEM_VERSION" >> $GITHUB_OUTPUT
+            else
+              echo "❌ Update failed with exit code $EXIT_CODE"
+              exit $EXIT_CODE
+            fi
           fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Create Pull Request
-        if: steps.compare.outputs.needs_update == 'true'
+        if: steps.update.outputs.update_made == 'true'
         uses: peter-evans/create-pull-request@v5
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           commit-message: |
-            Update PlantUML to version ${{ steps.latest-version.outputs.version }}
+            Update PlantUML to version ${{ steps.update.outputs.plantuml_version }}
 
-            - Updated PLANTUML_JAR_VERSION to ${{ steps.latest-version.outputs.version }}
-            - Downloaded new PlantUML JAR file
-            - Incremented gem version
-          title: "Update PlantUML to version ${{ steps.latest-version.outputs.version }}"
+            - Updated PLANTUML_JAR_VERSION to ${{ steps.update.outputs.plantuml_version }}
+            - Downloaded and verified new PlantUML JAR file
+            - Incremented gem version to ${{ steps.update.outputs.gem_version }}
+
+            Generated by automated PlantUML update workflow
+          title: "Update PlantUML to version ${{ steps.update.outputs.plantuml_version }}"
           body: |
-            This PR updates PlantUML to the latest version ${{ steps.latest-version.outputs.version }}.
+            This PR updates PlantUML to the latest version **${{ steps.update.outputs.plantuml_version }}**.
+
+            ## Changes Made
+            - ✅ Updated `PLANTUML_JAR_VERSION` to `${{ steps.update.outputs.plantuml_version }}`
+            - ✅ Downloaded and verified new PlantUML JAR file
+            - ✅ Incremented gem version to `${{ steps.update.outputs.gem_version }}`
+            - ✅ Validated JAR functionality with version check and diagram generation
+
+            ## Automated Validation
+            - [x] Found latest valid PlantUML release (excludes pre-releases and native builds)
+            - [x] Confirmed semantic version is newer than current
+            - [x] JAR file downloads successfully
+            - [x] JAR executes and shows correct version
+            - [x] JAR can generate test diagrams
 
-            Changes:
-            - Updated `PLANTUML_JAR_VERSION` in `lib/metanorma/plugin/plantuml/version.rb`
-            - Downloaded new PlantUML JAR to `data/plantuml.jar`
-            - Incremented gem version
+            ---
+            *This update was created automatically by the PlantUML version sync workflow using `rake update_plantuml`.*
 
-            This update was created automatically by the PlantUML version sync workflow.
-          branch: update-plantuml-${{ steps.latest-version.outputs.version }}
+            To update PlantUML manually, run:
+            ```bash
+            rake update_plantuml
+            ```
+          branch: update-plantuml-${{ steps.update.outputs.plantuml_version }}
           base: main
           labels: |
             enhancement
             automated
+            plantuml-update

data/.github/workflows/rake.yml

@@ -13,3 +13,6 @@ jobs:
     uses: metanorma/ci/.github/workflows/generic-rake.yml@main
     secrets:
       pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
+    with:
+      before-setup-ruby: |
+        java -version

data/Gemfile

@@ -18,6 +18,7 @@ gem "debug"
 gem "metanorma"
 gem "metanorma-standoc", github: "metanorma/metanorma-standoc",
                          branch: "main"
+gem "octokit"
 gem "rake"
 gem "rspec"
 gem "rspec-html-matchers"

data/README.adoc

@@ -832,6 +832,8 @@ PlantUML versions:
 | Gem version | PlantUML version | Notes
 
 | 1.0.0       | 1.2025.4        | Latest release with updated architecture
+| 1.0.4       | 1.2025.7        | Latest release
+
 |===
 
 This approach allows the gem to follow standard semantic versioning practices
@@ -839,54 +841,133 @@ while clearly documenting which PlantUML version is bundled with each release.
 
 === Updating PlantUML version
 
-This gem bundles a specific version of PlantUML JAR file. To update to a newer
-version:
+==== General
+
+This gem bundles a specific version of PlantUML JAR file.
+
+There are two ways to update to a newer version.
+
+==== Automatic update (recommended)
+
+The simplest way to update PlantUML is to use the automated update task:
+
+[source,console]
+----
+$ bundle exec rake update_plantuml
+----
+
+This task will:
+
+* Search GitHub for the latest valid PlantUML release (excluding pre-releases and native builds)
+* Compare with the current version and skip if already up to date
+* Update version files automatically (both PlantUML and gem versions)
+* Download and verify the new JAR file
+* Test the JAR functionality to ensure it works correctly
+
+The task uses exit codes to indicate the result:
+
+* Exit code 0: No update needed (already up to date)
+* Exit code 1: Update completed successfully
+* Exit code 2: Update failed due to an error
+
+==== Manual update
+
+For manual updates or to specify a particular version:
 
 . Check the latest PlantUML release at
 https://github.com/plantuml/plantuml/releases
 
-. Update the version in `lib/metanorma/plugin/plantuml/version.rb`:
+. Use the manual version update task:
 +
-[source,ruby]
+[source,console]
 ----
-PLANTUML_JAR_VERSION = "1.2025.4"  # Update to latest version
-VERSION = "1.0.1"                  # Increment patch version
+$ bundle exec rake update_plantuml_version[1.2025.7]
 ----
 
-. Clean the old JAR file:
+. Download the new JAR file:
 +
 [source,console]
 ----
-$ bundle exec rake clean_jar
+$ bundle exec rake clean_jar download_jar
 ----
 
-. Download the new JAR file:
+. Test the functionality:
 +
 [source,console]
 ----
-$ bundle exec rake download_jar
+$ bundle exec rake test_plantuml
 ----
 
-. Run tests to ensure everything works:
-+
+==== Version checking
+
+You can check the current PlantUML and gem versions:
+
 [source,console]
 ----
-$ bundle exec rake spec
+$ bundle exec rake check_plantuml_version
 ----
 
-. Update the gem version by incrementing the patch version (e.g., `1.0.0` →
-`1.0.1`) for PlantUML updates, or increment minor/major versions for gem feature
-updates.
+You can find the latest available PlantUML version:
+
+[source,console]
+----
+$ bundle exec rake find_latest_plantuml
+----
 
 === Available rake tasks
 
+==== PlantUML management tasks
+
+[source,console]
+----
+$ bundle exec rake update_plantuml                    # Update PlantUML to latest version (automatic)
+$ bundle exec rake update_plantuml_version[VERSION]   # Update PlantUML to specific version (manual)
+$ bundle exec rake check_plantuml_version             # Check current PlantUML and gem versions
+$ bundle exec rake find_latest_plantuml               # Find latest valid PlantUML release
+$ bundle exec rake test_plantuml                      # Test PlantUML JAR functionality
+----
+
+==== JAR file management tasks
+
+[source,console]
+----
+$ bundle exec rake download_jar    # Download PlantUML JAR file
+$ bundle exec rake clean_jar       # Remove downloaded JAR file
+----
+
+==== Development tasks
+
 [source,console]
 ----
-$ bundle exec rake download_jar  # Download PlantUML JAR file
-$ bundle exec rake clean_jar     # Remove downloaded JAR file
-$ bundle exec rake spec          # Run tests
+$ bundle exec rake spec            # Run tests
+$ bundle exec rake                 # Default task: download JAR + run tests
 ----
 
+==== Task descriptions
+
+`update_plantuml`:: Automatically finds the latest valid PlantUML release,
+updates version files, downloads the new JAR, and tests functionality. This is
+the recommended way to update PlantUML.
+
+`update_plantuml_version[VERSION]`:: Manually updates the PlantUML version in
+`version.rb` to the specified version and increments the gem version. Use this
+when you need to specify a particular PlantUML version.
+
+`check_plantuml_version`:: Displays the current PlantUML JAR version and gem
+version from `version.rb`.
+
+`find_latest_plantuml`:: Searches GitHub for the latest valid PlantUML release,
+filtering out pre-releases, native builds, and invalid versions. Shows the
+version and release information.
+
+`test_plantuml`:: Tests the downloaded PlantUML JAR by running version checks
+and generating a test diagram to ensure functionality.
+
+`download_jar`:: Downloads the PlantUML JAR file based on the version specified
+in `version.rb`. Creates the `data/` directory if it doesn't exist.
+
+`clean_jar`:: Removes the downloaded PlantUML JAR file from `data/plantuml.jar`.
+
 == Documentation
 
 Please refer to https://www.metanorma.org.

data/Rakefile

@@ -14,8 +14,146 @@ def uri_open(url)
   URI.parse(url).open
 end
 
+def github_client
+  require "octokit"
+  @github_client ||= begin
+    token = ENV['GITHUB_TOKEN'] || `gh auth token 2>/dev/null`.strip
+    token = nil if token.empty?
+    if token
+      Octokit::Client.new(access_token: token)
+    else
+      Octokit::Client.new
+    end
+  end
+end
+
+def find_latest_valid_plantuml_release
+  puts "Searching for latest valid PlantUML release..."
+
+  client = github_client
+  releases = client.releases('plantuml/plantuml')
+
+  # Filter for valid JAR releases
+  valid_releases = releases.reject(&:prerelease).select do |release|
+    tag_name = release.tag_name
+    version = tag_name.sub(/^v/, '')
+    # Must match pattern v\d+\.\d{4}\.\d+ and not contain -native or other suffixes
+    tag_name.match?(/^v\d+\.\d{4}\.\d+$/) &&
+    !tag_name.include?('-native') &&
+    !tag_name.include?('-snapshot') &&
+    release.assets.any? { |asset| asset.name == "plantuml-#{version}.jar" }
+  end
+
+  if valid_releases.empty?
+    raise "No valid PlantUML JAR releases found"
+  end
+
+  latest = valid_releases.first
+  version = latest.tag_name.sub(/^v/, '')
+
+  puts "Found latest valid release: #{latest.tag_name} (#{version})"
+  {
+    version: version,
+    tag_name: latest.tag_name,
+    html_url: latest.html_url,
+    jar_asset: latest.assets.find { |asset| asset.name == "plantuml-#{version}.jar" }
+  }
+rescue Octokit::Error => e
+  puts "GitHub API error: #{e.message}"
+  raise
+rescue StandardError => e
+  puts "Error finding latest release: #{e.message}"
+  raise
+end
+
+def current_plantuml_version
+  Metanorma::Plugin::Plantuml::PLANTUML_JAR_VERSION
+end
+
+def current_gem_version
+  Metanorma::Plugin::Plantuml::VERSION
+end
+
+def update_version_file(new_plantuml_version, new_gem_version)
+  version_file = "lib/metanorma/plugin/plantuml/version.rb"
+  content = File.read(version_file)
+
+  # Update PlantUML version (handle .freeze suffix)
+  original_content = content.dup
+  content.gsub!(/VERSION = ["']([^"']+)["']\.freeze/, %Q(VERSION = "#{new_gem_version}".freeze))
+  content.gsub!(/PLANTUML_JAR_VERSION = ["']([^"']+)["']\.freeze/, %Q(PLANTUML_JAR_VERSION = "#{new_plantuml_version}".freeze))
+
+  if content == original_content
+    puts "⚠️  No changes made to version file. Current content:"
+    puts content
+    raise "Failed to update version file - no substitutions made"
+  end
+
+  File.write(version_file, content)
+
+  # Verify the file was written correctly
+  updated_content = File.read(version_file)
+  unless updated_content.include?(%Q("#{new_plantuml_version}")) && updated_content.include?(%Q("#{new_gem_version}"))
+    puts "❌ File content after update:"
+    puts updated_content
+    raise "Version file update verification failed"
+  end
+
+  puts "✅ Updated version file:"
+  puts "  PlantUML: #{new_plantuml_version}"
+  puts "  Gem: #{new_gem_version}"
+end
+
+def increment_gem_version(current_version)
+  require 'rubygems'
+  version = Gem::Version.new(current_version)
+  segments = version.segments.dup
+  segments[2] = (segments[2] || 0) + 1
+  segments.join('.')
+end
+
+def test_plantuml_jar
+  jar_file = "data/plantuml.jar"
+
+  unless File.exist?(jar_file)
+    raise "PlantUML JAR file not found: #{jar_file}"
+  end
+
+  puts "Testing PlantUML JAR functionality..."
+
+  # Test version command
+  version_output = `java -jar #{jar_file} -version 2>&1`
+  unless $?.success? && version_output.include?("PlantUML")
+    raise "PlantUML version test failed. Output: #{version_output}"
+  end
+  puts "✅ Version test passed"
+
+  # Test diagram generation
+  test_diagram = "test_diagram_#{Time.now.to_i}.puml"
+  test_svg = test_diagram.sub('.puml', '.svg')
+
+  File.write(test_diagram, <<~PUML)
+    @startuml
+    Alice -> Bob: Hello
+    Bob -> Alice: Hi
+    @enduml
+  PUML
+
+  begin
+    generation_output = `java -jar #{jar_file} -tsvg #{test_diagram} 2>&1`
+    unless $?.success? && File.exist?(test_svg)
+      raise "PlantUML diagram generation test failed. Output: #{generation_output}"
+    end
+    puts "✅ Diagram generation test passed"
+  ensure
+    FileUtils.rm_f([test_diagram, test_svg])
+  end
+end
+
 file "data/plantuml.jar" do |file|
-  ver = Metanorma::Plugin::Plantuml::PLANTUML_JAR_VERSION
+  # Read version directly from file to avoid constant redefinition warnings
+  version_content = File.read("lib/metanorma/plugin/plantuml/version.rb")
+  ver = version_content.match(/PLANTUML_JAR_VERSION = ["']([^"']+)["']/)[1]
   url = "https://github.com/plantuml/plantuml/releases/download/v#{ver}/plantuml-#{ver}.jar"
   puts "Downloading PlantUML JAR... #{url}"
 
@@ -36,3 +174,100 @@ task :clean_jar do
   FileUtils.rm_f("data/plantuml.jar")
   puts "Removed data/plantuml.jar"
 end
+
+desc "Find latest valid PlantUML release"
+task :find_latest_plantuml do
+  release_info = find_latest_valid_plantuml_release
+  puts "Latest PlantUML version: #{release_info[:version]}"
+  puts "Release URL: #{release_info[:html_url]}"
+  puts "JAR asset: #{release_info[:jar_asset].name}" if release_info[:jar_asset]
+end
+
+desc "Check current PlantUML version"
+task :check_plantuml_version do
+  puts "Current PlantUML version: #{current_plantuml_version}"
+  puts "Current gem version: #{current_gem_version}"
+end
+
+desc "Test PlantUML JAR functionality"
+task :test_plantuml do
+  test_plantuml_jar
+end
+
+desc "Update PlantUML to latest version"
+task :update_plantuml do
+  puts "Checking for PlantUML updates..."
+
+  current_version = current_plantuml_version
+  current_gem = current_gem_version
+
+  begin
+    release_info = find_latest_valid_plantuml_release
+    latest_version = release_info[:version]
+
+    puts "Current version: #{current_version}"
+    puts "Latest version: #{latest_version}"
+
+    if current_version == latest_version
+      puts "✅ PlantUML is already up to date"
+      exit 0
+    end
+
+    # Check if update is actually newer
+    require 'rubygems'
+    if Gem::Version.new(latest_version) <= Gem::Version.new(current_version)
+      puts "⚠️  Latest version (#{latest_version}) is not newer than current (#{current_version})"
+      exit 0
+    end
+
+    puts "🔄 Updating PlantUML from #{current_version} to #{latest_version}"
+
+    # Update version files
+    new_gem_version = increment_gem_version(current_gem)
+    update_version_file(latest_version, new_gem_version)
+
+    # Clean old JAR and download new one
+    Rake::Task[:clean_jar].invoke
+    Rake::Task[:download_jar].invoke
+
+    # Test new JAR
+    test_plantuml_jar
+
+    puts "🎉 Successfully updated PlantUML!"
+    puts "  PlantUML: #{current_version} → #{latest_version}"
+    puts "  Gem: #{current_gem} → #{new_gem_version}"
+    puts "  Release: #{release_info[:html_url]}"
+
+    exit 1  # Exit with code 1 to indicate changes were made
+
+  rescue StandardError => e
+    puts "❌ Failed to update PlantUML: #{e.message}"
+    exit 2  # Exit with code 2 to indicate error
+  end
+end
+
+desc "Update PlantUML version in version.rb (manual)"
+task :update_plantuml_version, [:plantuml_version] do |t, args|
+  plantuml_version = args[:plantuml_version]
+
+  unless plantuml_version
+    puts "Usage: rake update_plantuml_version[1.2025.7]"
+    exit 1
+  end
+
+  unless plantuml_version.match?(/^\d+\.\d{4}\.\d+$/)
+    puts "Invalid version format. Expected: N.YYYY.NNN (e.g., 1.2025.7)"
+    exit 1
+  end
+
+  current_gem = current_gem_version
+  new_gem_version = increment_gem_version(current_gem)
+
+  update_version_file(plantuml_version, new_gem_version)
+
+  puts "Updated versions:"
+  puts "  PlantUML: #{plantuml_version}"
+  puts "  Gem: #{new_gem_version}"
+  puts ""
+  puts "Don't forget to run: rake clean_jar download_jar"
+end

data/lib/metanorma/plugin/plantuml/version.rb

@@ -1,7 +1,7 @@
 module Metanorma
   module Plugin
     module Plantuml
-      VERSION = "1.0.3".freeze
+      VERSION = "1.0.4".freeze
       PLANTUML_JAR_VERSION = "1.2025.4".freeze
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-plantuml
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-09 00:00:00.000000000 Z
+date: 2025-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor