metanorma-cli 1.16.10 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 826947482a6b6504d9e8b6f0270fbf9c21c7ea4aaf28987fae188a75d9785130
-  data.tar.gz: 70cdc4d3ae532c8119586898cc9b2fe2de7ebe47544131ba72b46be26c9efe67
+  metadata.gz: f002b87450dab7938a159523e3fa09a6ea580d8c42ac529f4bb5b4700f6a9601
+  data.tar.gz: d6bc7ec2d3f6c2e0b2cfd6d2c2548464e30e25ed8361fa5ebaaab7ef501e72b6
 SHA512:
-  metadata.gz: 3566044e7574ecba68e89cde656d0fa1931b970a1898d1d9fe90ce9cf9fbafc1a5d0456f75bafb18392a399ef3c157d599d89f53e4a414c23ec882c3582ea2a3
-  data.tar.gz: 8535140d5d93309cf295523b85fe368ad81e8c967ee65d65194232a78f7593748e1018b2b6de4dd5d429238c77ac6b7ba0cdc85b7cc71eb980ffcb6387f98929
+  metadata.gz: b27546bb7529b629709a7c5c58edb9186207a79906c8386f231fc301fc45e53682b39bd56dc80c2a513c703365d67e4712345da8b46e13ea4f5d9908a5813a79
+  data.tar.gz: 53391d057121fc210138ae3f0816823ced2afe28b84b1dce39f130771cc862d17236fa6e00bd4492ac6a13a784084767003d9ff09ba8958be02f0fdd217b7aea

data/lib/metanorma/cli/command.rb

@@ -8,6 +8,7 @@ require "metanorma/cli/thor_with_config"
 require "metanorma/cli/commands/config"
 require "metanorma/cli/commands/template_repo"
 require "metanorma/cli/commands/site"
+require "metanorma/cli/commands/diff"
 require "mnconvert"
 require_relative "flavor"
 
@@ -15,8 +16,8 @@ module Metanorma
   module Cli
     class Command < ThorWithConfig
       class_option :progress, aliases: "-s", type: :boolean, default: false,
-                              desc: "Show progress for long running tasks" \
-                                    " (like download)"
+                              desc: "Show progress for long running tasks " \
+                                    "(like download)"
 
       desc "new NAME", "Create new Metanorma document"
       option :type, aliases: "-t", required: true, desc: "Document type"
@@ -40,28 +41,28 @@ module Metanorma
       option :wrapper, aliases: "-w", type: :boolean,
                        desc: "Create wrapper folder for HTML output"
       option :asciimath, aliases: "-a", type: :boolean,
-                         desc: "Keep Asciimath in XML output instead of" \
-                               " converting it to MathM"
+                         desc: "Keep Asciimath in XML output instead of " \
+                               "converting it to MathM"
       option :datauriimage, aliases: "-d", type: :boolean,
                             desc: "Encode HTML output images as data URIs"
       option :relaton, aliases: "-R",
-                       desc: "Export Relaton XML for document to nominated" \
-                             " filename"
+                       desc: "Export Relaton XML for document to nominated " \
+                             "filename"
       option :extract, aliases: "-e",
-                       desc: "Export sourcecode fragments from this document" \
-                             " to nominated directory"
+                       desc: "Export sourcecode fragments from this document " \
+                             "to nominated directory"
       option :version, aliases: "-v",
                        desc: "Print version of code (accompanied with -t)"
       option :log_messages, aliases: "-L",
                             desc: "Display available log messages " \
-                            "(accompanied with -t)"
+                                  "(accompanied with -t)"
       option :output_dir, aliases: "-o",
                           desc: "Directory to save compiled files"
       option :strict, aliases: "-S", type: :boolean,
                       desc: "Strict compilation: abort if there are any errors"
       option :agree_to_terms,
              type: :boolean,
-             desc: "Agree / Disagree with all third-party licensing terms "\
+             desc: "Agree / Disagree with all third-party licensing terms " \
                    "presented (WARNING: do know what you are agreeing with!)"
       option :install_fonts, type: :boolean, default: true,
                              desc: "Install required fonts"
@@ -99,14 +100,14 @@ module Metanorma
       option :coverpage, aliases: "-c", desc: "Liquid template"
       option :agree_to_terms,
              type: :boolean,
-             desc: "Agree / Disagree with all third-party licensing terms "\
+             desc: "Agree / Disagree with all third-party licensing terms " \
                    "presented (WARNING: do know what you are agreeing with!)"
       option :install_fonts, type: :boolean, default: true,
                              desc: "Install required fonts"
       option :continue_without_fonts,
              type: :boolean,
              desc: "Continue processing even when fonts are missing"
-      option :strict, aliases: "-S", type: :boolean, \
+      option :strict, aliases: "-S", type: :boolean,
                       desc: "Strict compilation: abort if there are any errors"
 
       def collection(filename = nil)
@@ -151,6 +152,31 @@ module Metanorma
         UI.say e.message
       end
 
+      desc "diff FILE1 FILE2", "Semantic diff of two Metanorma XML documents"
+      option :format, type: :string, default: "text",
+                      desc: "Output format: text or json"
+      option :profile, type: :string,
+                       desc: "canon configuration profile (built-in name " \
+                             "or YAML path; default: metanorma)"
+      option :match_profile, type: :string,
+                             desc: "canon match profile override, e.g. " \
+                                   "strict or spec_friendly"
+      option :show_diffs, type: :string,
+                          desc: "Which differences to show: " \
+                                "all|normative|informative"
+      option :context_lines, type: :numeric,
+                             desc: "Context lines around each difference"
+      option :color, type: :boolean, default: true,
+                     desc: "Colorise the text report"
+      option :input_format, type: :string,
+                            desc: "Input format override: xml|html|json|yaml " \
+                                  "(default: by file extension)"
+
+      def diff(file1, file2)
+        status = Commands::Diff.new(file1, file2, options).run
+        exit(status) unless status.zero?
+      end
+
       desc "version", "Version of the code"
       option :type, aliases: "-t", required: false,
                     desc: "Type of standard to generate"

data/lib/metanorma/cli/commands/diff.rb

@@ -0,0 +1,159 @@
+require "json"
+
+module Metanorma
+  module Cli
+    module Commands
+      # Semantic diff of two Metanorma XML documents, with lutaml/canon
+      # as the diff engine (metanorma-cli#442, iso-10303
+      # drift-tracking). Returns an exit status instead of exiting, so
+      # in-process callers (and specs) stay alive; the Thor command
+      # decides the process exit.
+      class Diff
+        EXIT_EQUIVALENT = 0
+        EXIT_DIFFERENT = 1
+        EXIT_ERROR = 2
+
+        # the canon LIBRARY does not auto-detect input format (its CLI
+        # does, from extensions) — detect here, overridable via
+        # --input-format
+        FORMAT_BY_EXT = {
+          ".xml" => :xml, ".html" => :html, ".htm" => :html,
+          ".json" => :json, ".yaml" => :yaml, ".yml" => :yaml
+        }.freeze
+
+        def initialize(file1, file2, options = {})
+          @file1 = file1
+          @file2 = file2
+          @options = options
+        end
+
+        # @return [Integer] exit status (0 equivalent / 1 different /
+        #   2 error); output goes to the given IO (default $stdout)
+        def run(out = $stdout)
+          return EXIT_ERROR unless files_exist?
+
+          require "canon"
+          format = input_format
+          return reject_format unless format
+
+          configure_canon
+          report(compare_documents(format), out)
+        rescue StandardError => e
+          warn "metanorma diff: #{e.class}: #{e.message}"
+          EXIT_ERROR
+        end
+
+        private
+
+        def files_exist?
+          [@file1, @file2].all? do |f|
+            File.file?(f) ||
+              (warn("metanorma diff: no such file: #{f}") && false)
+          end
+        end
+
+        # The canon "metanorma" configuration profile is the default:
+        # spec-friendly matching, metanorma whitespace element lists,
+        # normative-only display. --profile selects another canon
+        # profile (built-in name or a YAML path).
+        def configure_canon
+          Canon::Config.reset!
+          Canon::Config.instance.profile = @options[:profile] || :metanorma
+        end
+
+        # rubocop:disable Naming/PredicateMethod -- verbose: true makes
+        # equivalent? return a full ComparisonResult, not a boolean
+        def report(result, out)
+          out.puts render(result)
+          result.equivalent? ? EXIT_EQUIVALENT : EXIT_DIFFERENT
+        end
+
+        def reject_format
+          warn "metanorma diff: unsupported input format for " \
+               "#{File.extname(@file1)} — semantic diff handles " \
+               "#{FORMAT_BY_EXT.keys.join(', ')} (or pass --input-format)"
+          EXIT_ERROR
+        end
+
+        def input_format
+          if (f = @options[:input_format])
+            return f.to_sym
+          end
+
+          FORMAT_BY_EXT[File.extname(@file1).downcase]
+        end
+
+        def compare_documents(format)
+          opts = { verbose: true, format: format }
+          if (mp = @options[:match_profile])
+            opts[:match_profile] = mp.to_sym
+          end
+          Canon::Comparison.equivalent?(
+            File.read(@file1, encoding: "UTF-8"),
+            File.read(@file2, encoding: "UTF-8"),
+            opts,
+          )
+        end
+        # rubocop:enable Naming/PredicateMethod
+
+        def render(result)
+          case @options[:format]&.downcase
+          when "json" then render_json(result)
+          else render_text(result)
+          end
+        end
+
+        def render_text(result)
+          return result.diff(**text_diff_opts) unless result.equivalent?
+
+          info = result.informative_differences.size
+          return "Equivalent" if info.zero?
+
+          msg = "Equivalent (#{info} informative difference(s) — " \
+                "rerun with --show-diffs informative to view)"
+          if @options[:show_diffs].to_s == "informative"
+            "#{msg}\n#{result.diff(**text_diff_opts)}"
+          else
+            msg
+          end
+        end
+
+        def text_diff_opts
+          diff_opts = { use_color: color? }
+          if (cl = @options[:context_lines])
+            diff_opts[:context_lines] = cl.to_i
+          end
+          if (sd = @options[:show_diffs])
+            diff_opts[:show_diffs] = sd.to_sym
+          end
+          diff_opts
+        end
+
+        def color?
+          return false if @options[:color] == false
+
+          $stdout.tty?
+        end
+
+        # canon has no machine-readable report; serialise its DiffNode
+        # list ourselves — the shape iso-10303 CI can consume
+        def diff_to_h(diff)
+          { dimension: diff.dimension, reason: diff.reason,
+            path: diff.path, normative: diff.normative?,
+            before: diff.serialized_before, after: diff.serialized_after }
+        end
+
+        def render_json(result)
+          diffs = result.differences.map { |d| diff_to_h(d) }
+          JSON.pretty_generate(
+            files: { a: @file1, b: @file2 },
+            equivalent: result.equivalent?,
+            normative_count: diffs.count { |d| d[:normative] },
+            informative_count: diffs.count { |d| !d[:normative] },
+            differences: diffs,
+          )
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/cli/flavor.rb

@@ -6,7 +6,7 @@ module Metanorma
            metanorma-core metanorma-plugin-glossarist metanorma-plugin-lutaml
            metanorma-taste relaton-cli pubid glossarist fontist
            plurimath expressir xmi lutaml-model emf2svg unitsml
-           vectory ogc-gml oscal suma).freeze
+           vectory ogc-gml oscal suma canon).freeze
 
       EXPORT_CONFIG_FLAVOR_FILES = [
         "metanorma/*/*.adoc",

data/lib/metanorma/cli/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Cli
-    VERSION = "1.16.10".freeze
+    VERSION = "1.17.0".freeze
   end
 end

data/metanorma-cli.gemspec

@@ -26,28 +26,29 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 3.3.0")
 
   spec.add_dependency "metanorma-ietf", "~> 3.7.0"
-  spec.add_dependency "metanorma-iso", "~> 3.4.2"
+  spec.add_dependency "metanorma-iso", "~> 3.5.0"
   spec.add_dependency "mnconvert"
   # spec.add_dependency "thor", "~> 1.0" # inherited from vectory
   # spec.add_dependency "metanorma-gb", "~> 1.5.0"
-  spec.add_dependency "metanorma-bipm", "~> 2.8.0"
-  spec.add_dependency "metanorma-cc", "~> 2.8.0"
-  spec.add_dependency "metanorma-generic", "~> 3.4.0"
-  spec.add_dependency "metanorma-iec", "~> 2.8.0"
-  spec.add_dependency "metanorma-ribose", "~> 2.8.0"
-  spec.add_dependency "metanorma-standoc", "~> 3.4.3"
+  spec.add_dependency "metanorma-bipm", "~> 2.9.0"
+  spec.add_dependency "metanorma-cc", "~> 2.9.0"
+  spec.add_dependency "metanorma-generic", "~> 3.5.0"
+  spec.add_dependency "metanorma-iec", "~> 2.9.0"
+  spec.add_dependency "metanorma-ribose", "~> 2.9.0"
+  spec.add_dependency "metanorma-standoc", "~> 3.5.0"
   # spec.add_dependency 'metanorma-mpfa', "~> 0.9.0"
   spec.add_dependency "git", ">= 3.0"
   spec.add_dependency "lutaml-model"
   spec.add_dependency "metanorma", "~> 2.5.1"
-  spec.add_dependency "metanorma-iho", "~> 1.3.0"
-  spec.add_dependency "metanorma-itu", "~> 2.8.0"
+  spec.add_dependency "metanorma-iho", "~> 1.4.0"
+  spec.add_dependency "metanorma-itu", "~> 2.9.0"
   # spec.add_dependency "metanorma-nist", "~> 2.7.0"
   spec.add_dependency "liquid", "~> 5"
-  spec.add_dependency "metanorma-ieee", "~> 1.6.0"
-  spec.add_dependency "metanorma-jis", "~> 1.1.0"
-  spec.add_dependency "metanorma-ogc", "~> 2.9.0"
-  spec.add_dependency "metanorma-plateau", "~> 1.2.0"
+  spec.add_dependency "metanorma-ieee", "~> 1.7.0"
+  spec.add_dependency "metanorma-jis", "~> 1.2.0"
+  spec.add_dependency "metanorma-ogc", "~> 2.10.0"
+  spec.add_dependency "metanorma-plateau", "~> 1.3.0"
+  spec.add_dependency "canon", ">= 0.2.12"
   spec.add_dependency "relaton-cli", ">= 0.8.2"
   spec.add_dependency "socksify"
   spec.add_dependency "suma", "~> 0.5.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-cli
 version: !ruby/object:Gem::Version
-  version: 1.16.10
+  version: 1.17.0
 platform: ruby
 authors:
 - Ribose Inc.
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.2
+        version: 3.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.2
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: mnconvert
   requirement: !ruby/object:Gem::Requirement
@@ -57,84 +57,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: metanorma-cc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: metanorma-generic
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: metanorma-iec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: metanorma-ribose
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.3
+        version: 3.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.3
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
@@ -183,28 +183,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: metanorma-itu
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: liquid
   requirement: !ruby/object:Gem::Requirement
@@ -225,56 +225,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: metanorma-jis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: metanorma-ogc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: 2.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: 2.10.0
 - !ruby/object:Gem::Dependency
   name: metanorma-plateau
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: canon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.12
 - !ruby/object:Gem::Dependency
   name: relaton-cli
   requirement: !ruby/object:Gem::Requirement
@@ -349,6 +363,7 @@ files:
 - lib/metanorma/cli/collection.rb
 - lib/metanorma/cli/command.rb
 - lib/metanorma/cli/commands/config.rb
+- lib/metanorma/cli/commands/diff.rb
 - lib/metanorma/cli/commands/site.rb
 - lib/metanorma/cli/commands/template_repo.rb
 - lib/metanorma/cli/compiler.rb
@@ -385,7 +400,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.18
 specification_version: 4
 summary: Metanorma is the standard of standards; the metanorma gem allows you to create
   any standard document type supported by Metanorma.