xml-c14n 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a10b7e87a5eaf960d92413dc09369e52df01b7eaff5a8d145f02ec8fcd149b4
-  data.tar.gz: 042c3487e90653c953c302bd520602471cf014bfab46397fdae2388833b3b6f7
+  metadata.gz: db7534268066a77ae26796e4968ffd0c597918f84e7ba9e28c030d7fcb40e944
+  data.tar.gz: 5df2c8751d1e510dc03256b75d7bbb4377f872f8ec4697464682dbf8f4af25bb
 SHA512:
-  metadata.gz: 2fb5e43a2d87558701aba2cc0557b397cddc8ba17a5ad6359e0c4ea01e0241fd05a92d72c597c081edee9fed1ffec28bc75268cd2af6ac142796d73a98ad54f5
-  data.tar.gz: 95b30ab0c49f269a58020bffa656d465b5b3d5b25afebf3b88287856a2ddf75c653175fa263fe14b4312acda4b335fee9397366bd553b54345169dd94d54dd64
+  metadata.gz: ba62dceb49d17fab2de11b0362f2497cb0465495e82d0a1ee66d612780e0ab92596ae444da2bb0d15261d47db0288b13b34c87bdda2f0864b6055c355989568a
+  data.tar.gz: 7e9bb5d2f596573efe588ec43d6632451b15b2f7314111ccb247f81dcb79d18e08058704e454ada56dd3062481b0c88ac983c25e1574905f80edd782ace49af1

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+
+# local repo-specific modifications
+# ...
+
+AllCops:
+  TargetRubyVersion: 2.7

data/README.adoc

@@ -1,4 +1,4 @@
-= XML pretty-print / canonicalizer
+= XML pretty-print / canonicalizer / RSpec comparator
 
 == Purpose
 
@@ -7,6 +7,9 @@ to pretty-print and provide a canonicalized form of XML
 (https://www.w3.org/TR/xml-c14n11/[W3C Canonicalized XML]) suitable
 for signing and comparison.
 
+This gem also provides the RSpec matcher `be_analogous_with` for comparing XML
+content. The matcher used is from the
+https://github.com/vkononov/compare-xml[`compare-xml`] gem.
 
 == Usage
 
@@ -34,6 +37,13 @@ it "canonicalizes #{File.basename(f)}" do
 
   expect(output).to eq(input)
 end
+
+it "checks if analogous with #{File.basename(f)}" do
+  input = Xml::C14n.format(File.read(xml_raw))
+  output = Xml::C14n.format(File.read(xml_c14n))
+
+  expect(output).to be_analogous_with(input)
+end
 ----
 
 

data/lib/xml/c14n/rspec_matchers.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "xml-c14n" unless defined?(::Xml::C14n)
+require "compare-xml"
+
+begin
+  require "rspec/expectations"
+rescue LoadError
+end
+
+module Xml
+  module C14n
+    module RSpecMatchers
+      class AnalogousMatcher
+        def initialize(expected)
+          @expected = expected
+          @result = nil
+        end
+
+        def matches?(target)
+          @target = target
+
+          @result = CompareXML.equivalent?(
+            Nokogiri::XML(@target),
+            Nokogiri::XML(@expected),
+            { collapse_whitespace: true,
+              ignore_attr_order: true,
+              verbose: true },
+          )
+
+          @result.empty?
+        end
+
+        def failure_message
+          index = 0
+          @result.map do |hash|
+            index += 1
+            "DIFF #{index}: expected node: #{hash[:node1]}\n" \
+                   "        actual node  : #{hash[:node2]}\n" \
+                   "        diff from    : #{hash[:diff1]}\n" \
+                   "        diff to      : #{hash[:diff2]}\n"
+          end.join("\n")
+        end
+
+        def failure_message_when_negated
+          ["expected:", @target.to_s, "not be analogous with:",
+           @expected.to_s].join("\n")
+        end
+
+        def diffable
+          true
+        end
+      end
+
+      def be_analogous_with(expected)
+        AnalogousMatcher.new(expected)
+      end
+
+      if defined?(::RSpec)
+        RSpec.configure do |config|
+          config.include(Xml::C14n::RSpecMatchers)
+        end
+      end
+    end
+  end
+end

data/lib/xml/c14n/version.rb

@@ -2,6 +2,6 @@
 
 module Xml
   module C14n
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

data/lib/xml/c14n.rb

@@ -3,13 +3,17 @@
 require_relative "c14n/version"
 require "nokogiri"
 
+require_relative "c14n/rspec_matchers" if defined?(::RSpec)
+
 module Xml
+  # C14n stands for canonicalization
   module C14n
+    # Source of XSLT
+    # https://emmanueloga.wordpress.com/2009/09/29/pretty-printing-xhtml-with-nokogiri-and-xslt/
     NOKOGIRI_C14N_XSL = <<~XSL
       <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
         <xsl:output method="xml" encoding="ISO-8859-1"/>
         <xsl:param name="indent-increment" select="'   '"/>
-
         <xsl:template name="newline">
           <xsl:text disable-output-escaping="yes">
       </xsl:text>
@@ -35,38 +39,29 @@ module Xml
           <xsl:param name="indent" select="''"/>
           <xsl:call-template name="newline"/>
           <xsl:value-of select="$indent"/>
-            <xsl:choose>
-             <xsl:when test="count(child::*) > 0">
+          <xsl:choose>
+            <xsl:when test="count(child::*) > 0">
               <xsl:copy>
-               <xsl:copy-of select="@*"/>
-               <xsl:apply-templates select="*|text()">
-                 <xsl:with-param name="indent" select="concat ($indent, $indent-increment)"/>
-               </xsl:apply-templates>
-               <xsl:call-template name="newline"/>
-               <xsl:value-of select="$indent"/>
+              <xsl:copy-of select="@*"/>
+              <xsl:apply-templates select="*|text()">
+                <xsl:with-param name="indent" select="concat ($indent, $indent-increment)"/>
+              </xsl:apply-templates>
+              <xsl:call-template name="newline"/>
+              <xsl:value-of select="$indent"/>
               </xsl:copy>
-             </xsl:when>
-             <xsl:otherwise>
+            </xsl:when>
+            <xsl:otherwise>
               <xsl:copy-of select="."/>
-             </xsl:otherwise>
-           </xsl:choose>
+            </xsl:otherwise>
+          </xsl:choose>
         </xsl:template>
       </xsl:stylesheet>
     XSL
-    # NOKOGIRI_C14N_XSL = <<~XSL
-    #   <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
-    #     <xsl:output method="xml" encoding="UTF-8" indent="yes"/>
-    #     <xsl:strip-space elements="*"/>
-    #     <xsl:template match="/">
-    #       <xsl:copy-of select="."/>
-    #     </xsl:template>
-    #   </xsl:stylesheet>
-    # XSL
 
     def self.format(xml)
       Nokogiri::XSLT(NOKOGIRI_C14N_XSL)
-              .transform(Nokogiri::XML(xml, &:noblanks))
-              .to_xml(indent: 2, pretty: true, encoding: "UTF-8")
+        .transform(Nokogiri::XML(xml, &:noblanks))
+        .to_xml(indent: 2, pretty: true, encoding: "UTF-8")
     end
 
     class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xml-c14n
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ribose Inc.
@@ -10,6 +10,20 @@ bindir: exe
 cert_chain: []
 date: 2024-05-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: compare-xml
+  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: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Library for XML canonicalization
 email:
 - open.source@ribose.com
@@ -74,11 +102,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - README.adoc
 - Rakefile
 - lib/xml-c14n.rb
 - lib/xml/c14n.rb
+- lib/xml/c14n/rspec_matchers.rb
 - lib/xml/c14n/version.rb
 - sig/xml/c14n.rbs
 homepage: https://github.com/metanorma/xml-c14n