fhirpath-rb 0.1.1

data/rakelib/parser.rake

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+# Builds the native FHIRPath parser extension (see lib/fhirpath/parser/FHIRPath.g4) using the
+# antlr4-native gem. Generated/vendored sources are gitignored; run `rake parser:setup compile`
+# once (and again after editing the grammar) before running specs.
+namespace :parser do
+  root_dir = File.expand_path("..", __dir__)
+  ext_dir = File.join(root_dir, "ext/fhir_path_parser")
+  grammar_file = File.join(root_dir, "lib/fhirpath/parser/FHIRPath.g4")
+  runtime_dir = File.join(ext_dir, "antlr4-upstream")
+  interop_file = File.join(ext_dir, "fhir_path_parser.cpp")
+
+  desc "Clone the ANTLR4 C++ runtime version matching antlr4-native's bundled ANTLR jar"
+  task :vendor_runtime do
+    require "antlr4-native"
+
+    if Dir.exist?(runtime_dir)
+      puts "#{runtime_dir} already present, skipping clone"
+    else
+      version = Antlr4Native::Generator::ANTLR_VERSION
+      sh "git clone --depth 1 --branch #{version} " \
+         "https://github.com/antlr/antlr4 #{runtime_dir}"
+    end
+  end
+
+  desc "Generate the ANTLR4 parser sources from FHIRPath.g4"
+  task generate: :vendor_runtime do
+    require "antlr4-native"
+
+    generator = Antlr4Native::Generator.new(
+      grammar_files: [grammar_file],
+      output_dir: File.join(root_dir, "ext"),
+      parser_root_method: "expression"
+    )
+    generator.generate
+
+    # generator.generate overwrites the interop file every run, so the patches below have to
+    # be re-applied here rather than committed to the generated file.
+    source = File.read(interop_file)
+
+    # ContextProxy::wrapParseTree (generated) dispatches on antlrcpp::is<T>, i.e. dynamic_cast,
+    # checking context types in the order they were first seen in the parser source. Since a
+    # labeled alternative's context (e.g. AdditiveExpressionContext) is a C++ subclass of its
+    # rule's base context (ExpressionContext), and the base class is emitted first, dynamic_cast
+    # to the *base* type succeeds first and every labeled node gets wrapped as the generic base
+    # proxy — the specific label is lost. RTTI on the raw ParseTree pointer gives us the real
+    # most-derived type name regardless of which proxy class wrapped it, since getText()/
+    # getChildren() live on the common ContextProxy base either way.
+    source = source.sub(
+      "#include <iostream>",
+      "#include <iostream>\n#include <cxxabi.h>\n#include <cstdlib>"
+    )
+
+    source = source.sub(
+      "  bool doubleEquals(Object other) {",
+      "#{<<~CPP.chomp}\n\n  bool doubleEquals(Object other) {"
+        std::string getTypeName() {
+          if (orig == nullptr) return "";
+
+          int status = 0;
+          char *demangled = abi::__cxa_demangle(typeid(*orig).name(), nullptr, nullptr, &status);
+          std::string result = (status == 0 && demangled != nullptr)
+            ? std::string(demangled)
+            : std::string(typeid(*orig).name());
+
+          if (demangled != nullptr) {
+            free(demangled);
+          }
+
+          return result;
+        }
+      CPP
+    )
+
+    source = source.sub(
+      '.define_method("==", &ContextProxy::doubleEquals);',
+      ".define_method(\"==\", &ContextProxy::doubleEquals)\n" \
+      '    .define_method("type_name", &ContextProxy::getTypeName);'
+    )
+
+    error_listener_class = <<~CPP
+      class CountingErrorListener : public BaseErrorListener {
+      public:
+        size_t *counter = nullptr;
+
+        void syntaxError(Recognizer *recognizer, Token *offendingSymbol, size_t line,
+                          size_t charPositionInLine, const std::string &msg,
+                          std::exception_ptr e) override {
+          if (counter != nullptr) {
+            (*counter)++;
+          }
+        }
+      };
+
+    CPP
+    source = source.sub("class ParserProxy {", "#{error_listener_class}class ParserProxy {")
+
+    source = source.sub(
+      "public:\n  static ParserProxy* parse(string code) {",
+      "public:\n  size_t syntaxErrorCount() { return errorCount; }\n\n" \
+      "  static ParserProxy* parse(string code) {"
+    )
+
+    source = source.sub(
+      /(#{Regexp.escape("FHIRPathParser* parser;")})/,
+      "\\1\n  CountingErrorListener errorListener;\n  size_t errorCount = 0;"
+    )
+
+    source = source.sub(
+      "parser -> parser = new FHIRPathParser(parser -> tokens);",
+      <<~CPP.chomp
+        parser -> parser = new FHIRPathParser(parser -> tokens);
+
+            parser -> errorListener.counter = &parser -> errorCount;
+            parser -> lexer -> removeErrorListeners();
+            parser -> lexer -> addErrorListener(&parser -> errorListener);
+            parser -> parser -> removeErrorListeners();
+            parser -> parser -> addErrorListener(&parser -> errorListener);
+      CPP
+    )
+
+    source = source.sub(
+      '.define_method("visit", &ParserProxy::visit);',
+      ".define_method(\"visit\", &ParserProxy::visit)\n" \
+      '    .define_method("syntax_error_count", &ParserProxy::syntaxErrorCount);'
+    )
+
+    File.write(interop_file, source)
+  end
+
+  desc "Vendor the ANTLR4 C++ runtime and generate the parser sources"
+  task setup: :generate
+
+  desc "Compile the native FHIRPath parser extension"
+  task :compile do
+    require "etc"
+
+    Dir.chdir(ext_dir) do
+      ruby "extconf.rb"
+      sh "make -j #{Etc.nprocessors}"
+    end
+  end
+end
+
+desc "Compile native extensions (see rake parser:setup to (re)generate their sources first)"
+task compile: "parser:compile"

data/sig/fhirpath.rbs

@@ -0,0 +1,14 @@
+module Fhirpath
+  VERSION: String
+
+  class Error < StandardError
+  end
+
+  def self.evaluate: (FHIR::Model | Array[FHIR::Model] resource, untyped path, ?untyped context, ?Module? model, ?untyped options) -> Array[untyped]
+
+  def self.compile: [SRC < FHIR::Model, DST] (untyped path, ?Module? model, ?untyped options) -> ^(SRC resource, ?untyped context) -> Array[DST]
+
+  def self.compile_as_array: [SRC < FHIR::Model, DST] (String expression, Class input_type, Class output_type, ?Module? model) -> ^(SRC resource, ?untyped context) -> Array[DST]
+
+  def self.compile_as_first: [SRC < FHIR::Model, DST] (String expression, Class input_type, Class output_type, ?Module? model) -> ^(SRC resource, ?untyped context) -> DST?
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: fhirpath-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- beda.software
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fhir_models
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: rice
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: A Ruby port of fhirpath-py (https://github.com/beda-software/fhirpath-py),
+  implementing the FHIRPath expression language (https://hl7.org/fhirpath/).
+email:
+- ilya@beda.software
+executables: []
+extensions:
+- ext/fhir_path_parser/extconf.rb
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CLAUDE.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/fhir_path_parser/extconf.rb
+- lib/fhirpath.rb
+- lib/fhirpath/engine.rb
+- lib/fhirpath/engine/evaluators.rb
+- lib/fhirpath/engine/evaluators/expressions.rb
+- lib/fhirpath/engine/evaluators/literals.rb
+- lib/fhirpath/engine/evaluators/member_invocation.rb
+- lib/fhirpath/engine/invocations.rb
+- lib/fhirpath/engine/invocations/aggregate.rb
+- lib/fhirpath/engine/invocations/collections.rb
+- lib/fhirpath/engine/invocations/combining.rb
+- lib/fhirpath/engine/invocations/datetime.rb
+- lib/fhirpath/engine/invocations/equality.rb
+- lib/fhirpath/engine/invocations/equivalence.rb
+- lib/fhirpath/engine/invocations/existence.rb
+- lib/fhirpath/engine/invocations/filtering.rb
+- lib/fhirpath/engine/invocations/inequality.rb
+- lib/fhirpath/engine/invocations/logic.rb
+- lib/fhirpath/engine/invocations/math.rb
+- lib/fhirpath/engine/invocations/math_functions.rb
+- lib/fhirpath/engine/invocations/misc.rb
+- lib/fhirpath/engine/invocations/misc_converts_to.rb
+- lib/fhirpath/engine/invocations/navigation.rb
+- lib/fhirpath/engine/invocations/registry_strings_and_math.rb
+- lib/fhirpath/engine/invocations/strings.rb
+- lib/fhirpath/engine/invocations/strings_encoding.rb
+- lib/fhirpath/engine/invocations/subsetting.rb
+- lib/fhirpath/engine/invocations/types.rb
+- lib/fhirpath/engine/nodes/fp_date_time.rb
+- lib/fhirpath/engine/nodes/fp_date_time_arithmetic.rb
+- lib/fhirpath/engine/nodes/fp_quantity.rb
+- lib/fhirpath/engine/nodes/fp_quantity_deep_equal.rb
+- lib/fhirpath/engine/nodes/fp_time.rb
+- lib/fhirpath/engine/nodes/fp_time_arithmetic.rb
+- lib/fhirpath/engine/nodes/resource_node.rb
+- lib/fhirpath/engine/nodes/type_info.rb
+- lib/fhirpath/engine/param_resolution.rb
+- lib/fhirpath/engine/util.rb
+- lib/fhirpath/models.rb
+- lib/fhirpath/models/dstu2/choiceTypePaths.json
+- lib/fhirpath/models/dstu2/path2Type.json
+- lib/fhirpath/models/dstu2/pathsDefinedElsewhere.json
+- lib/fhirpath/models/dstu2/type2Parent.json
+- lib/fhirpath/models/r4/choiceTypePaths.json
+- lib/fhirpath/models/r4/path2Type.json
+- lib/fhirpath/models/r4/pathsDefinedElsewhere.json
+- lib/fhirpath/models/r4/type2Parent.json
+- lib/fhirpath/models/r5/choiceTypePaths.json
+- lib/fhirpath/models/r5/path2Type.json
+- lib/fhirpath/models/r5/pathsDefinedElsewhere.json
+- lib/fhirpath/models/r5/type2Parent.json
+- lib/fhirpath/models/stu3/choiceTypePaths.json
+- lib/fhirpath/models/stu3/path2Type.json
+- lib/fhirpath/models/stu3/pathsDefinedElsewhere.json
+- lib/fhirpath/models/stu3/type2Parent.json
+- lib/fhirpath/parser.rb
+- lib/fhirpath/parser/FHIRPath.g4
+- lib/fhirpath/parser/ast_builder.rb
+- lib/fhirpath/version.rb
+- rakelib/parser.rake
+- sig/fhirpath.rbs
+homepage: https://github.com/beda-software/fhirpath-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/beda-software/fhirpath-ruby
+  source_code_uri: https://github.com/beda-software/fhirpath-ruby
+  changelog_uri: https://github.com/beda-software/fhirpath-ruby/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: FHIRPath implementation in Ruby
+test_files: []