xcop 0.11.0 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a0ba2b99c4feae8645eadd69e10c5c0f7c8de8d4340156e0da8a4d6d8786149
-  data.tar.gz: bc7fec4a7cdf91bcdf90347b971f02c909cf0ff29b9fe1e2199855b27ab58cc8
+  metadata.gz: eb96da46dd45869ca97de4ff90e49d286b85ce1a36e0a3ce9fefac7626788007
+  data.tar.gz: 9f4e402e0a8cf397494c07dcacf9f5523d18c48872c5bdefe9d7977f1b3f765e
 SHA512:
-  metadata.gz: 817b6d81d029e5206a86ec914be5c1023bae23b1b31a7f6f4c3712e75ee45ca1220f35e10f91f85af3310b51fb00013d79e9846f41f45f2b0b45d1018f755cf3
-  data.tar.gz: 0d78d15db07ec2cdb7009e45408721ff3fc66d2bd8ade2ed566689ebc7bedbdf26ea428b0adef6256f1e71d5c74c74d0b301487eac189a68386c21699f9e36b3
+  metadata.gz: b482311a5a738c1d1ea16fbea987866c8962fe09b62e7c216b89b4895ec4b70133a8d9e32a036734466c722fee090eb45441f8a6f2729b8a993388d1768a0b57
+  data.tar.gz: 3cd551264e7b205d947e15c19f0291b7567789d497bd0af183cf1a3975d6eb2d306b6523fd25fa3cb4cf8ec34e150165f7209829e082bcfdab8b68dfec0db0fa

data/Gemfile.lock

@@ -91,7 +91,7 @@ GEM
       racc (~> 1.4)
     nokogiri (1.19.3-x86_64-linux-musl)
       racc (~> 1.4)
-    parallel (1.28.0)
+    parallel (2.1.0)
     parser (3.3.12.0)
       ast (~> 2.4.1)
       racc

data/REUSE.toml

@@ -8,6 +8,7 @@ path = [
     ".gitattributes",
     ".gitignore",
     ".pdd",
+    "fixtures/**",
     "**.json",
     "**.md",
     "**.png",

data/bin/xcop

@@ -68,12 +68,20 @@ end
 
 if opts.fix?
   Xcop::CLI.new(files).fix do |f, status|
-    puts "#{f} #{status}" unless opts.quiet?
+    if status == :malformed
+      puts "#{f} is not a well-formed XML, cannot fix it"
+    elsif !opts.quiet?
+      puts "#{f} #{status}"
+    end
   end
 else
   begin
-    Xcop::CLI.new(files, nocolor: opts.nocolor?).run do |f|
-      puts "#{f} looks good" unless opts.quiet?
+    Xcop::CLI.new(files, nocolor: opts.nocolor?).run do |f, status|
+      if status == :malformed
+        puts "#{f} is not a well-formed XML, skipping it"
+      elsif !opts.quiet?
+        puts "#{f} looks good"
+      end
     end
   rescue StandardError => e
     puts e.message

data/features/cli.feature

@@ -44,6 +44,25 @@ Feature: Command Line Processing
     Then I run bin/xcop with "broken.xml"
     Then Exit code is zero
 
+  Scenario: Refusing to fix a non-well-formed XML file
+    Given I have a "garbage.xml" file with content:
+    """
+    this is not XML
+    """
+    When I run bin/xcop with "--fix garbage.xml"
+    Then Stdout contains "is not a well-formed XML"
+    And Exit code is zero
+    And The file "garbage.xml" contains "this is not XML"
+
+  Scenario: Skipping a plain text file while checking
+    Given I have a "foo.txt" file with content:
+    """
+    not xml at all
+    """
+    When I run bin/xcop with "foo.txt"
+    Then Stdout contains "is not a well-formed XML, skipping it"
+    And Exit code is zero
+
   Scenario: Validating all files in the current directory by default
     Given I have a "auto.xml" file with content:
     """

data/features/step_definitions/steps.rb

@@ -38,6 +38,11 @@ Then(/^Stdout contains "([^"]*)"$/) do |txt|
   raise(StandardError, "STDOUT doesn't contain '#{txt}':\n#{@stdout}") unless @stdout.include?(txt)
 end
 
+Then(/^The file "([^"]*)" contains "([^"]*)"$/) do |file, txt|
+  body = File.read(file)
+  raise(StandardError, "File '#{file}' doesn't contain '#{txt}':\n#{body}") unless body.include?(txt)
+end
+
 Then(/^Stdout is empty$/) do
   raise(StandardError, "STDOUT is not empty:\n#{@stdout}") unless @stdout == ''
 end

data/fixtures/idempotent/attributes.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0"?>
+<config debug="true" level="5">
+  <item name="alpha" value="1"/>
+  <item name="beta" value="2"/>
+</config>

data/fixtures/idempotent/cdata.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0"?>
+<script><![CDATA[if (a < b) { return; }]]></script>

data/fixtures/idempotent/comment-multi-line.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0"?>
+<a>
+  <!--
+  line1
+  line2
+  -->
+</a>

data/fixtures/idempotent/comment-single-line.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0"?>
+<a>
+  <!-- text -->
+</a>

data/fixtures/idempotent/deep-nesting.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<a>
+  <b>
+    <c>
+      <d>deep</d>
+    </c>
+  </b>
+</a>

data/fixtures/idempotent/empty-elements.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<gallery>
+  <image src="a.png"/>
+  <image src="b.png"/>
+  <break/>
+</gallery>

data/fixtures/idempotent/entities.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0"?>
+<text>a &lt; b &amp; c &gt; d</text>

data/fixtures/idempotent/maven-pom.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+</project>

data/fixtures/idempotent/mixed-content.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0"?>
+<p>Hello <b>bold</b> world</p>

data/fixtures/idempotent/namespace-used.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0"?>
+<root xmlns:x="urn:x">
+  <x:child>value</x:child>
+</root>

data/fixtures/idempotent/nested.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<root>
+  <parent>
+    <child>text</child>
+  </parent>
+</root>

data/fixtures/idempotent/non-xml.txt

@@ -0,0 +1 @@
+hello world

data/fixtures/idempotent/simple.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0"?>
+<hello>Hello, world!</hello>

data/fixtures/idempotent/xslt-xpath-namespace.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0"?>
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" version="2.0">
+  <xsl:variable name="n" as="xs:integer" select="1"/>
+</xsl:stylesheet>

data/lib/xcop/cli.rb

@@ -24,9 +24,16 @@ class Xcop::CLI
     EXTENSIONS.flat_map { |ext| Dir.glob(File.join(dir, '**', "*.#{ext}")) }.sort
   end
 
+  # Check them all. The block, when given, receives the file path and a
+  # status symbol that is +:good+ when the file is clean and
+  # +:malformed+ when the file is not XML at all and was skipped.
   def run
     @files.each do |f|
       doc = Xcop::Document.new(f)
+      unless doc.wellformed?
+        yield(f, :malformed) if block_given?
+        next
+      end
       diff = doc.diff(nocolor: @nocolor)
       unless diff.empty?
         puts(diff)
@@ -37,7 +44,7 @@ class Xcop::CLI
         puts(errors.join("\n"))
         raise(StandardError, "XSD validation failed in #{f}")
       end
-      yield(f) if block_given?
+      yield(f, :good) if block_given?
     end
   end
 

data/lib/xcop/document.rb

@@ -18,15 +18,26 @@ class Xcop::Document
     @path = path
   end
 
+  # Is the document well-formed XML? Nokogiri parses in recover mode
+  # and never raises, so a broken file yields a rootless document that
+  # +to_xml+ renders as an empty declaration; a fatal parse error is
+  # the signal that the file is not XML and thus can neither be
+  # reformatted nor sensibly compared to its ideal. See #173 and #175.
+  def wellformed?
+    Nokogiri::XML(File.read(@path)).errors.none?(&:fatal?)
+  end
+
   # Return the difference, if any (empty string if everything is clean).
   def diff(nocolor: false)
     differ(ideal, File.read(@path), nocolor: nocolor)
   end
 
   # Fixes the document, returning +:fixed+ when the file content
-  # changed on disk and +:untouched+ when the file was already
-  # canonical.
+  # changed on disk, +:untouched+ when the file was already canonical,
+  # and +:malformed+ when the file is not well-formed XML and thus
+  # left on disk exactly as it was.
   def fix
+    return :malformed unless wellformed?
     canonical = ideal
     return :untouched if canonical == File.read(@path)
     File.write(@path, canonical)

data/lib/xcop/rake_task.rb

@@ -35,8 +35,8 @@ class Xcop::RakeTask < Rake::TaskLib
     good = Dir.glob(@includes).reject { |f| bad.include?(f) }
     puts("Inspecting #{pluralize(good.length, 'file')}...") unless @quiet
     begin
-      Xcop::CLI.new(good).run do
-        print(Rainbow('.').green) unless @quiet
+      Xcop::CLI.new(good).run do |_f, status|
+        print(status == :malformed ? Rainbow('?').yellow : Rainbow('.').green) unless @quiet
       end
     rescue StandardError => e
       puts(e.message)

data/lib/xcop/version.rb

@@ -6,5 +6,5 @@
 # Copyright:: Copyright (c) 2017-2026 Yegor Bugayenko
 # License:: MIT
 module Xcop
-  VERSION = '0.11.0'.freeze
+  VERSION = '0.11.2'.freeze
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: xcop
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.2
 platform: ruby
 authors:
 - Yegor Bugayenko
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-07-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: differ
@@ -72,8 +71,8 @@ executables:
 - xcop
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE.txt
+- README.md
 files:
 - Gemfile
 - Gemfile.lock
@@ -90,6 +89,20 @@ files:
 - features/rake.feature
 - features/step_definitions/steps.rb
 - features/support/env.rb
+- fixtures/idempotent/attributes.xml
+- fixtures/idempotent/cdata.xml
+- fixtures/idempotent/comment-multi-line.xml
+- fixtures/idempotent/comment-single-line.xml
+- fixtures/idempotent/deep-nesting.xml
+- fixtures/idempotent/empty-elements.xml
+- fixtures/idempotent/entities.xml
+- fixtures/idempotent/maven-pom.xml
+- fixtures/idempotent/mixed-content.xml
+- fixtures/idempotent/namespace-used.xml
+- fixtures/idempotent/nested.xml
+- fixtures/idempotent/non-xml.txt
+- fixtures/idempotent/simple.xml
+- fixtures/idempotent/xslt-xpath-namespace.xml
 - lib/xcop/cli.rb
 - lib/xcop/document.rb
 - lib/xcop/rake_task.rb
@@ -101,7 +114,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -117,8 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: XML Formatting Static Validator
 test_files: []