parsanol 1.3.91 → 1.3.92

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2876669149be4d6b90a15246708d4a40ef6bb75d0d2991b53485cff21abd768e
-  data.tar.gz: 1750418bf4195336601f90f0bc67bf8dd669069440def4be0ceba728f7a0ef47
+  metadata.gz: 11b0c549ac99782284291222059dfe02d3281a83a8fe854967cee08266846bbd
+  data.tar.gz: 06f587dfe6a5cfe5981ac12c432729560dcdd8501a2fa91936c28be9fb0c401f
 SHA512:
-  metadata.gz: 6ba314ff5ac132d5bb04470b024e8df3b45e1736ae64a5a5ddfa743a96fbd6971211cf9e0a2fa31be1a6d24ed9b5a612ee685f6d3ad11e5e97b9adb6875c356a
-  data.tar.gz: f50c7d6d2e8dcb09588127755fdc12a60917406b3ee2be068f8309138a8d36f4c92175e661915484872aa3b989c51e306b741a30e2e11073866d992df68251ab
+  metadata.gz: a8d385dae7c5100df8012111dd75da2e2bed6ba93689849ec505259c65ab69f3c41eeb37112c5ec8e4ba44feca7503985d04fe494295ff0844f1a3bf4bd4605b
+  data.tar.gz: af78fe7842a3c7b25b3ad17718e95c2d5dbcea3a2fb23f8b26d63d55ca095188f75c911459eafb8866fcf7545c11853f8680ff4898db85cbaed4f57e85763f1d

data/Cargo.lock

@@ -307,9 +307,9 @@ checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
 
 [[package]]
 name = "parsanol"
-version = "0.18.2"
+version = "0.18.6"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b059d18a92c61ba7c7c6241bb446196729dadf618e6e34c0b79935f0292d7a27"
+checksum = "621395999299ffdf8757b0004bf68eee4ee499051d608f756c223508981e1f44"
 dependencies = [
  "ahash",
  "getrandom 0.3.4",
@@ -326,9 +326,9 @@ dependencies = [
 
 [[package]]
 name = "parsanol-derive"
-version = "0.18.2"
+version = "0.18.6"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "4b9a6de83c376137ccce01cb8890427a8879b34b6ac4832cc0413c5624923001"
+checksum = "48597b847c17492e8ee96d842f9784538fe2b523ada73bf0f0976a60287d5a71"
 dependencies = [
  "proc-macro2",
  "quote",

data/lib/parsanol/parg/artifact.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "digest"
 require "json"
 require "yaml"
 
@@ -11,20 +12,21 @@ module Parsanol
     # consume; the embedded PARG source lets a Ruby runtime recompile the atom
     # tree locally without any other dependency.
     class Artifact
-      attr_reader :envelope, :path, :tables_dir
+      attr_reader :envelope, :path, :tables_dir, :imports_dir
 
-      def self.load(path, tables_dir: nil)
+      def self.load(path, tables_dir: nil, imports_dir: nil)
         envelope = JSON.parse(PARG.read_utf8(path))
-        new(envelope, path, tables_dir || File.dirname(path))
+        new(envelope, path, tables_dir || File.dirname(path),
+            imports_dir: imports_dir)
       end
 
-      def self.from_json(text, tables_dir: nil)
-        new(JSON.parse(text), nil, tables_dir)
+      def self.from_json(text, tables_dir: nil, imports_dir: nil)
+        new(JSON.parse(text), nil, tables_dir, imports_dir: imports_dir)
       end
 
       SUPPORTED_SHAPE = "parsanol-tree/v2"
 
-      def initialize(envelope, path, tables_dir)
+      def initialize(envelope, path, tables_dir, imports_dir: nil)
         unless envelope["shape"] == SUPPORTED_SHAPE
           raise ArtifactError,
                 "unsupported artifact shape #{envelope['shape'].inspect} " \
@@ -38,12 +40,30 @@ module Parsanol
         @envelope = envelope
         @path = path
         @tables_dir = tables_dir
+        # parsanol-ruby#208: `use`-importing grammars need the imported
+        # sources when the pure-Ruby path recompiles the embedded source;
+        # in-memory artifacts (path nil) pass the directory explicitly.
+        @imports_dir = imports_dir
         verify_checksum!
         @compiler = nil
       end
 
       def version = envelope["version"]
 
+      # Freshness (parsanol-ruby#209): what source revision and compiler
+      # produced this artifact. `source_hash` is the SHA-256 of the .parg
+      # text at compile time; nil on artifacts baked before the field
+      # existed, so `fresh_against?` answers false rather than guessing.
+      def source_hash = envelope["source_hash"]
+
+      def compiler_version = envelope["compiler_version"]
+
+      def fresh_against?(source_text)
+        return false if source_hash.nil?
+
+        source_hash == Digest::SHA256.hexdigest(source_text.to_s)
+      end
+
       def entries = envelope["entries"].keys
 
       def entry(name)
@@ -263,8 +283,10 @@ module Parsanol
           # without this the pure-Ruby path fails on artifacts whose
           # native atom graphs inline everything. The imported sources
           # sit beside the artifact (vendors ship them together).
-          imports_dir = path && File.directory?(File.dirname(path)) ? File.dirname(path) : nil
-          Imports.merge!(document, [imports_dir].compact) if imports_dir
+          dirs = [path ? File.dirname(path) : nil, @imports_dir]
+            .compact
+            .select { |dir| File.directory?(dir) }
+          Imports.merge!(document, dirs) unless dirs.empty?
           Compiler.new(document, @tables_dir)
         end
       end

data/lib/parsanol/parg/cli.rb

@@ -22,6 +22,10 @@ module Parsanol
           test    <file.parg|artifact.json>   run the grammar's test section
           parse   <file> [--entry E] INPUT  parse one input; prints the tree
                                             and the bound captures
+          check   --source x.parg --artifact y.json
+                                            verify the artifact was compiled
+                                            from that source (source hash +
+                                            compiler version); exit 1 stale
           repl    <file> [--entry E]        interactive parse loop (blank
                                             line quits, :quit exits)
           doc     <file> [rule]             print rule documentation
@@ -53,6 +57,7 @@ module Parsanol
         when "test" then test
         when "schema" then schema
         when "parse" then parse
+        when "check" then check
         when "repl" then repl
         when "doc" then doc
         when "lsp" then Lsp.new.run && 0
@@ -88,6 +93,33 @@ module Parsanol
         0
       end
 
+      # Freshness (parsanol-ruby#209): verify an artifact was compiled
+      # from the given source. The stale-shipped-artifact incident class
+      # (an old artifact silently taking precedence over the corrected
+      # grammar) is undetectable without the recorded source hash.
+      # Exit 0 fresh, 1 stale or unrecorded.
+      def check
+        source = flag_value("--source")
+        artifact_path = flag_value("--artifact")
+        unless source && artifact_path && File.file?(source) && File.file?(artifact_path)
+          warn USAGE
+          return 1
+        end
+        artifact = Artifact.load(artifact_path)
+        if artifact.source_hash.nil?
+          puts "STALE?  #{artifact_path}: no source hash recorded (pre-freshness artifact)"
+          return 1
+        end
+        if artifact.fresh_against?(PARG.read_utf8(source))
+          puts "FRESH   #{artifact_path} == #{source} (compiler #{artifact.compiler_version})"
+          0
+        else
+          puts "STALE   #{artifact_path} does not match #{source} " \
+               "(built from #{artifact.source_hash[0, 12]}… by #{artifact.compiler_version})"
+          1
+        end
+      end
+
       def test
         target = @argv.shift
         if File.directory?(target)
@@ -200,11 +232,13 @@ module Parsanol
 
       def artifact_for(file)
         if file.end_with?(".json")
-          Parsanol::PARG::Artifact.load(file, tables_dir: @tables_dir || default_tables_dir(file))
+          Parsanol::PARG::Artifact.load(file, tables_dir: @tables_dir || default_tables_dir(file),
+                                              imports_dir: File.dirname(file))
         else
           artifact = compile_source(file)
           Parsanol::PARG::Artifact.from_json(JSON.generate(artifact.envelope),
-                                             tables_dir: @tables_dir || default_tables_dir(file))
+                                             tables_dir: @tables_dir || default_tables_dir(file),
+                                             imports_dir: File.dirname(file))
         end
       end
 

data/lib/parsanol/parg/compiler.rb

@@ -758,6 +758,12 @@ module Parsanol
           end,
           "docs" => @document.docs,
           "source" => @document.source,
+          # Freshness (parsanol-ruby#209): what the artifact was compiled
+          # from and with, so loaders can detect a stale artifact and fall
+          # back to a reference implementation instead of failing obscurely
+          # at parse time. Checksummed like the rest of the envelope.
+          "source_hash" => Digest::SHA256.hexdigest(@document.source.to_s),
+          "compiler_version" => Parsanol::VERSION,
         }
         if @document.skip_declaration
           # parsanol-ruby#134: declared trivia rule. Injection is baked

data/lib/parsanol/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Parsanol
-  VERSION = "1.3.91"
+  VERSION = "1.3.92"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parsanol
 version: !ruby/object:Gem::Version
-  version: 1.3.91
+  version: 1.3.92
 platform: ruby
 authors:
 - Ribose Inc.