expressir 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de9e0d0c1c24fa441fcf5b1f9fc1baeb034c4c37abc984b1416b96f37d7d80d8
-  data.tar.gz: 92bf31490bc79c314aa31e006931c28893bcdf0fbd0df0097b417662458ba48b
+  metadata.gz: 52184ecaf1717a9bbf98cadf3272b5ee049168537ba20ba92d583938839caa6e
+  data.tar.gz: 91afae8ad0efc945fa19918ed04c5e0e4ee7b6101405a7e35faa9c6644cd8433
 SHA512:
-  metadata.gz: 61a5927f36841a123fd06395ba12ca0e201534332b5f88d9206b8299bf92668c370eb80b7063fbe0b2465ffb47b60bebfc76f14e25e3418cc8fb6150596762a6
-  data.tar.gz: 54dec20a6099a8f99425d50bc15cf3fea8233e26fe959c711359f1ec74039ca614ed102c8697e0d0fe9dcb13f675bc7ff53f84d5af82d8132f7c72f73fd996ea
+  metadata.gz: d5736ecb7b76cded1ac2d823ad29bd05dd7a8b4ea9dc62365655ee9fc3837aead01fb0190ea173723ce26d162f82cb563398e2d2e296304a44ff6968231a0015
+  data.tar.gz: b2c4bb82aa4f867ceba0e1781bc6902ac456c98616aebb00efb60b9b7063cb718afadbb723fb5d90dd3c4e4b1a69fe79100816f041397665d42874df1ad117e9

data/.github/workflows/codeql.yml

@@ -0,0 +1,47 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  schedule:
+    - cron: '0 23 * * 3'
+  workflow_dispatch:
+
+concurrency:
+  group: '${{ github.workflow }}-${{ github.job }}-${{ github.head_ref || github.ref_name }}'
+  cancel-in-progress: true
+
+env:
+  BUNDLER_VER: 2.4.22
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install Ruby
+        uses: ruby/setup-ruby@master
+        with:
+          ruby-version: 3.1
+          bundler: ${{ env.BUNDLER_VER }}
+          bundler-cache: false
+
+      - name: Bundle
+        run: bundle install --jobs 4 --retry 3
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: "ruby, cpp"
+
+      - name: Build native extension
+        run: bundle exec rake compile
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

data/.github/workflows/rake.yml

@@ -8,6 +8,7 @@ on:
       - '**.adoc'
       - '**.md'
       - .github/workflows/release.yml
+      - .github/workflows/codeql.yml
   pull_request:
   workflow_dispatch:
 
@@ -77,11 +78,11 @@ jobs:
         run: bundle install --jobs 4 --retry 3
 
       - name: Process cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         id: cache
         with:
           path: lib/expressir/express/express_parser.*
-          key: v4-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('ext/express-parser/extconf.rb', 'ext/express-parser/antlrgen/**', 'ext/express-parser/express_parser.cpp', '.git/modules/ext/express-parser/antlr4-upstream/HEAD') }}
+          key: v4-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('ext/express_parser/extconf.rb', 'ext/express_parser/antlrgen/**', 'ext/express_parser/express_parser.cpp', '.git/modules/ext/express_parser/antlr4-upstream/HEAD') }}
 
       - name: Build native extension
         if: steps.cache.outputs.cache-hit != 'true'
@@ -115,7 +116,7 @@ jobs:
         run: gem build expressir.gemspec
 
       - name: Package gem without native extension
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: pkg-ruby
           path: expressir-*.gem
@@ -154,7 +155,7 @@ jobs:
         run: bundle exec rake gem:${{ matrix.platform }}
 
       - name: Package gem with native extension
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: pkg-${{ matrix.platform }}
           path: pkg/*.gem
@@ -185,7 +186,7 @@ jobs:
         run: bundle install --jobs 4 --retry 3
 
       - name: Download packaged gem
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
          name: pkg-ruby
          path: pkg
@@ -222,7 +223,7 @@ jobs:
         run: bundle install --jobs 4 --retry 3
 
       - name: Download packaged gem
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
          name: pkg-darwin
          path: pkg
@@ -260,7 +261,7 @@ jobs:
         run: bundle install --jobs 4 --retry 3
 
       - name: Download packaged gem
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
          name: pkg-linux-gnu
          path: pkg
@@ -298,7 +299,7 @@ jobs:
         run: bundle install --jobs 4 --retry 3
 
       - name: Download packaged gem
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
          name: pkg-windows
          path: pkg

data/.github/workflows/release.yml

@@ -15,6 +15,9 @@ concurrency:
   group: '${{ github.workflow }}-${{ github.job }}-${{ github.head_ref || github.ref_name }}'
   cancel-in-progress: true
 
+env:
+  BUNDLER_VER: 2.4.22
+
 jobs:
   bump:
     runs-on: ubuntu-latest
@@ -62,13 +65,13 @@ jobs:
           gem build expressir.gemspec | grep -o 'Version: .*' | awk '{print $2}' > version
 
       - if: matrix.platform == 'linux-gnu'
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: pkg-ruby
           path: expressir-*.gem
 
       - if: matrix.platform == 'linux-gnu'
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: version
           path: version
@@ -84,7 +87,7 @@ jobs:
       # build gem WITH pre-built native extension
       - run: bundle exec rake gem:${{ matrix.platform }}
 
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: pkg-${{ matrix.platform }}
           path: pkg/*.gem
@@ -93,22 +96,22 @@ jobs:
     runs-on: ubuntu-latest
     needs: pack
     steps:
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: pkg-ruby
           path: pkg
 
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: pkg-linux-gnu
           path: pkg
 
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: pkg-windows
           path: pkg
 
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: pkg-darwin
           path: pkg
@@ -130,7 +133,7 @@ jobs:
           chmod 0600 ~/.gem/credentials
           gem signin
           for gem in pkg/*.gem; do gem push $gem -V; done
-          sleep(5)
+          sleep 5
 
   verify:
     name: Verify published gem on ${{ matrix.os }}
@@ -149,7 +152,7 @@ jobs:
           bundler: ${{ env.BUNDLER_VER }}
 
       - name: Download version
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
          name: version
 
@@ -170,7 +173,7 @@ jobs:
         run: apk --no-cache add bash build-base git ruby-dev gcc g++ automake
 
       - name: Download version
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
          name: version
 

data/.github/workflows/stress.yml

@@ -0,0 +1,53 @@
+name: stress
+
+on:
+  workflow_dispatch:
+
+concurrency:
+  group: '${{ github.workflow }}-${{ github.job }}-${{ github.head_ref || github.ref_name }}'
+  cancel-in-progress: true
+
+env:
+  BUNDLER_VER: 2.4.22
+  GC_STRESS: true
+
+jobs:
+  rake:
+    name: test on ruby-${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '3.2', '3.1', '3.0', '2.7' ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Setup packages
+        if: startsWith(matrix.os, 'macos')
+        run: brew install autoconf automake libtool
+
+      - name: Install Ruby
+        uses: ruby/setup-ruby@master
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler: ${{ env.BUNDLER_VER }}
+          # Rice gem has issues with bundler cache
+          # more info https://github.com/lutaml/expressir/runs/2097658383?check_suite_focus=true#step:7:2126
+          # but it is not the only issue
+          bundler-cache: false
+
+      - name: Bundle
+        run: bundle install --jobs 4 --retry 3
+
+      - name: Build native extension
+        run: bundle exec rake compile
+
+      - name: Run tests
+        run: |
+          bundle exec rake
+          cat .rspec_status

data/.gitignore

@@ -14,7 +14,7 @@
 /lib/expressir/express/*/express_parser.bundle
 /lib/expressir/express/*/express_parser.so
 /spec/syntax/*-pretty.exp
-/ext/express-parser/rice-embed
+/ext/express_parser/rice-embed
 
 # rspec failure tracking
 .rspec_status

data/.gitmodules

@@ -1,5 +1,5 @@
-[submodule "ext/express-parser/antlr4-upstream"]
-	path = ext/express-parser/antlr4-upstream
+[submodule "ext/express_parser/antlr4-upstream"]
+	path = ext/express_parser/antlr4-upstream
 	url = https://github.com/antlr/antlr4
 [submodule "ext/express-grammar"]
 	path = ext/express-grammar

data/exe/generate-parser

@@ -18,7 +18,7 @@ generator = Antlr4Native::Generator.new(
 generator.generate
 
 # fix issues with generated parser
-parser_source_file = File.join("ext", "express-parser", "express_parser.cpp")
+parser_source_file = File.join("ext", "express_parser", "express_parser.cpp")
 parser_source_lines = File.read(parser_source_file).split("\n")
 
 # - add ParserProxy tokens method, simple compensation for missing exposed BufferedTokenStream

data/expressir.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.files         = `git ls-files`.split("\n")\
-    + Dir.glob("ext/express-parser/antlr4-upstream/runtime/Cpp/runtime/**/*")
+    + Dir.glob("ext/express_parser/antlr4-upstream/runtime/Cpp/runtime/**/*")
 
   spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
 
@@ -28,11 +28,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.executables   = %w[expressir]
 
-  spec.extensions = File.join(*%w(ext express-parser extconf.rb))
+  spec.extensions = File.join(*%w(ext express_parser extconf.rb))
 
-  spec.add_runtime_dependency "rice", "~> 4.1"
+  spec.add_runtime_dependency "rice", "~> 4.2"
   spec.add_runtime_dependency "thor", "~> 1.0"
-  spec.add_development_dependency "antlr4-native", "~> 2.1.0"
+  spec.add_development_dependency "antlr4-native", "~> 2.2"
   spec.add_development_dependency "asciidoctor", "~> 2.0.13"
   spec.add_development_dependency "bundler", "~> 2.3"
   spec.add_development_dependency "byebug", "~> 11.1"

data/ext/express_parser/antlr4-upstream/runtime/Cpp/runtime/CMakeLists.txt

@@ -0,0 +1,191 @@
+option(ANTLR_BUILD_CPP_TESTS "Build C++ tests." ON)
+option(TRACE_ATN "Trace ATN simulation" OFF)
+option(ANTLR_BUILD_SHARED "Build the shared library of the ANTLR runtime" ON)
+option(ANTLR_BUILD_STATIC "Build the static library of the ANTLR runtime" ON)
+
+if (NOT ANTLR_BUILD_SHARED AND NOT ANTLR_BUILD_STATIC)
+  message(FATAL_ERROR "Options ANTLR_BUILD_SHARED and ANTLR_BUILD_STATIC can't both be OFF")
+endif()
+
+include_directories(
+  ${PROJECT_SOURCE_DIR}/runtime/src
+  ${PROJECT_SOURCE_DIR}/runtime/src/atn
+  ${PROJECT_SOURCE_DIR}/runtime/src/dfa
+  ${PROJECT_SOURCE_DIR}/runtime/src/internal
+  ${PROJECT_SOURCE_DIR}/runtime/src/misc
+  ${PROJECT_SOURCE_DIR}/runtime/src/support
+  ${PROJECT_SOURCE_DIR}/runtime/src/tree
+  ${PROJECT_SOURCE_DIR}/runtime/src/tree/pattern
+  ${PROJECT_SOURCE_DIR}/runtime/src/tree/xpath
+)
+
+
+file(GLOB libantlrcpp_SRC
+  "${PROJECT_SOURCE_DIR}/runtime/src/*.cpp"
+  "${PROJECT_SOURCE_DIR}/runtime/src/atn/*.cpp"
+  "${PROJECT_SOURCE_DIR}/runtime/src/dfa/*.cpp"
+  "${PROJECT_SOURCE_DIR}/runtime/src/internal/*.cpp"
+  "${PROJECT_SOURCE_DIR}/runtime/src/misc/*.cpp"
+  "${PROJECT_SOURCE_DIR}/runtime/src/support/*.cpp"
+  "${PROJECT_SOURCE_DIR}/runtime/src/tree/*.cpp"
+  "${PROJECT_SOURCE_DIR}/runtime/src/tree/pattern/*.cpp"
+  "${PROJECT_SOURCE_DIR}/runtime/src/tree/xpath/*.cpp"
+)
+
+if (ANTLR_BUILD_SHARED)
+  add_library(antlr4_shared SHARED ${libantlrcpp_SRC})
+endif()
+if (ANTLR_BUILD_STATIC)
+  add_library(antlr4_static STATIC ${libantlrcpp_SRC})
+endif()
+
+if (CMAKE_HOST_UNIX)
+  # Make sure to link against threads (pthreads) library in order to be able to
+  # make use of std::call_once in the code without producing runtime errors
+  # (see also https://github.com/antlr/antlr4/issues/3708 and/or https://stackoverflow.com/q/51584960).
+  find_package(Threads REQUIRED)
+
+  if (TARGET antlr4_shared)
+    target_link_libraries(antlr4_shared Threads::Threads)
+  endif()
+  if (TARGET antlr4_static)
+    target_link_libraries(antlr4_static Threads::Threads)
+  endif()
+endif()
+
+IF(TRACE_ATN)
+    ADD_DEFINITIONS(-DTRACE_ATN_SIM=1)
+ENDIF(TRACE_ATN)
+
+if (ANTLR_BUILD_CPP_TESTS)
+  include(FetchContent)
+
+  FetchContent_Declare(
+    googletest
+    URL https://github.com/google/googletest/archive/e2239ee6043f73722e7aa812a459f54a28552929.zip
+  )
+
+  if(WITH_STATIC_CRT)
+    set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+  endif()
+
+  FetchContent_MakeAvailable(googletest)
+
+  file(GLOB libantlrcpp_TESTS
+    "${PROJECT_SOURCE_DIR}/runtime/tests/*.cpp"
+  )
+
+  add_executable(
+    antlr4_tests
+    ${libantlrcpp_TESTS}
+  )
+
+  target_link_libraries(
+    antlr4_tests
+	$<IF:$<TARGET_EXISTS:antlr4_static>,antlr4_static,antlr4_shared>
+    gtest_main
+  )
+
+  include(GoogleTest)
+
+  gtest_discover_tests(antlr4_tests)
+endif()
+
+if(APPLE)
+  if (TARGET antlr4_shared)
+    target_link_libraries(antlr4_shared ${COREFOUNDATION_LIBRARY})
+  endif()
+  if (TARGET antlr4_static)
+    target_link_libraries(antlr4_static ${COREFOUNDATION_LIBRARY})
+  endif()
+endif()
+
+if(CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
+  set(disabled_compile_warnings "/wd4251")
+else()
+  set(disabled_compile_warnings "-Wno-overloaded-virtual")
+endif()
+
+
+if(CMAKE_CXX_COMPILER_ID MATCHES "Clang")
+  set(disabled_compile_warnings "${disabled_compile_warnings} -Wno-dollar-in-identifier-extension -Wno-four-char-constants")
+elseif(CMAKE_CXX_COMPILER_ID MATCHES "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES "Intel")
+  set(disabled_compile_warnings "${disabled_compile_warnings} -Wno-multichar")
+endif()
+
+set(extra_share_compile_flags "")
+set(extra_static_compile_flags "")
+set(static_lib_suffix "")
+
+if (WIN32)
+  set(static_lib_suffix "-static")
+  if (TARGET antlr4_shared)
+    target_compile_definitions(antlr4_shared PUBLIC ANTLR4CPP_EXPORTS)
+  endif()
+  if (TARGET antlr4_static)
+    target_compile_definitions(antlr4_static PUBLIC ANTLR4CPP_STATIC)
+  endif()
+  if(CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
+    set(extra_share_compile_flags "-MP /wd4251")
+    set(extra_static_compile_flags "-MP")
+  endif()
+endif()
+
+if (TARGET antlr4_shared)
+  set_target_properties(antlr4_shared
+                        PROPERTIES VERSION   ${ANTLR_VERSION}
+                                   SOVERSION ${ANTLR_VERSION}
+                                   OUTPUT_NAME antlr4-runtime
+                                   COMPILE_FLAGS "${disabled_compile_warnings} ${extra_share_compile_flags}")
+endif()
+
+if (TARGET antlr4_static)
+  set_target_properties(antlr4_static
+                        PROPERTIES VERSION   ${ANTLR_VERSION}
+                                   SOVERSION ${ANTLR_VERSION}
+                                   OUTPUT_NAME "antlr4-runtime${static_lib_suffix}"
+                                   COMPILE_PDB_NAME "antlr4-runtime${static_lib_suffix}"
+                                   COMPILE_FLAGS "${disabled_compile_warnings} ${extra_static_compile_flags}")
+endif()
+
+if (ANTLR_BUILD_CPP_TESTS)
+  # Copy the generated binaries to dist folder (required by test suite)
+  if (TARGET antlr4_shared)
+  add_custom_command(
+      TARGET antlr4_shared
+      POST_BUILD
+      COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/dist
+      COMMAND ${CMAKE_COMMAND} -E copy_if_different $<TARGET_FILE:antlr4_shared> ${CMAKE_HOME_DIRECTORY}/dist
+      COMMAND ${CMAKE_COMMAND} -E copy_if_different $<TARGET_LINKER_FILE:antlr4_shared> ${CMAKE_HOME_DIRECTORY}/dist)
+  endif()
+  
+  if (TARGET antlr4_static)
+    add_custom_command(
+      TARGET antlr4_static
+      POST_BUILD
+      COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/dist
+      COMMAND ${CMAKE_COMMAND} -E copy_if_different $<TARGET_FILE:antlr4_static> ${CMAKE_HOME_DIRECTORY}/dist)
+  endif()
+endif()
+
+if (TARGET antlr4_shared)
+  install(TARGETS antlr4_shared
+          EXPORT antlr4-targets
+          ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+          LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+          RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
+endif()
+
+if (TARGET antlr4_static)
+  install(TARGETS antlr4_static
+          EXPORT antlr4-targets
+          ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+          LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+          RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
+endif()
+
+install(DIRECTORY "${PROJECT_SOURCE_DIR}/runtime/src/"
+        DESTINATION "include/antlr4-runtime"
+        COMPONENT dev
+        FILES_MATCHING PATTERN "*.h"
+        )