xcop 0.11.1 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 682e51f3798d3495937a198b772be9a23be624990096e179575318285873761c
-  data.tar.gz: 9f4002c4337e4a2f90bea041a43c6eed471049694a78220855b02b31a1bd672c
+  metadata.gz: eb96da46dd45869ca97de4ff90e49d286b85ce1a36e0a3ce9fefac7626788007
+  data.tar.gz: 9f4e402e0a8cf397494c07dcacf9f5523d18c48872c5bdefe9d7977f1b3f765e
 SHA512:
-  metadata.gz: 13b1cb456fb7d0aabd5e5d1222af05ff1ac4c50c080e31c63a7085c48a4ad248c421fe2736dee02e2bcb574e74dc4634a77e30637ac37a7f441212a4ed4d8b20
-  data.tar.gz: 7a8d17f560e2b635eab9b63319d4c7bdcd34cd658ae22a45c102269575486ca4704952f17ba7320cd5fbc170cd322a2e06e0e3157983bf3c70314de88bc7a5b0
+  metadata.gz: b482311a5a738c1d1ea16fbea987866c8962fe09b62e7c216b89b4895ec4b70133a8d9e32a036734466c722fee090eb45441f8a6f2729b8a993388d1768a0b57
+  data.tar.gz: 3cd551264e7b205d947e15c19f0291b7567789d497bd0af183cf1a3975d6eb2d306b6523fd25fa3cb4cf8ec34e150165f7209829e082bcfdab8b68dfec0db0fa

data/bin/xcop

@@ -76,8 +76,12 @@ if opts.fix?
   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

@@ -54,6 +54,15 @@ Feature: Command Line Processing
     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/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,6 +18,15 @@ 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)
@@ -52,14 +61,6 @@ class Xcop::Document
 
   private
 
-  # 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 cannot be safely reformatted. See #173.
-  def wellformed?
-    Nokogiri::XML(File.read(@path)).errors.none?(&:fatal?)
-  end
-
   # The canonical, well-formatted version of the document.
   def ideal
     xml = Nokogiri::XML(File.read(@path), &:noblanks)

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.1'.freeze
+  VERSION = '0.11.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xcop
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.11.2
 platform: ruby
 authors:
 - Yegor Bugayenko