xcop 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb09ff0d1d4f8ff28d3f2f0ccaedc6b1e018a082
-  data.tar.gz: b8351decbe16e2cc8db540cf3962477f782aaf5c
+  metadata.gz: c3b67fdc37db666afbd54a7c894889412530d1fb
+  data.tar.gz: b5c833f2a4a439ed751a84862577d3cd0f955e36
 SHA512:
-  metadata.gz: 64508f23d0fbf7b091d06fc8a54c63f6111b1e92a1a9acfc41b5222006c0d2f026895590c4f675511d87b0171fdb5d73badff31c5238859b83806875536d3d28
-  data.tar.gz: 4cd03d9ffc5584605d87a66a75ee60bdded4fde0c24746ef009413d5bd51fe327b18862cf17d1162e32567a4cf69a4587e897f63ca8f528cb5ad18ab4fc0ba8a
+  metadata.gz: 903d1596af3e61c7eea9c33a6c0d4df519f7781a8c9013f01ce03a8c1e698c6d31e861da5b4662ccede4472618d1e4c3f1dc83e96c3e8d5673db8104b5896bfa
+  data.tar.gz: 2ba85e0319b65ac9f6c03583ea7573dde044686baa941f7eb0447febc19257da11570fd7617efe902e005a489b9981a68108083718c7d7693c0a3e77a56b4e4b

data/.simplecov

@@ -35,6 +35,6 @@ else
   SimpleCov.start do
     add_filter "/test/"
     add_filter "/features/"
-    minimum_coverage 90
+    minimum_coverage 80
   end
 end

data/bin/xcop

@@ -32,6 +32,7 @@ opts = Slop.parse(ARGV, strict: true, help: true) do |o|
   o.banner = "Usage (#{Xcop::VERSION}): xcop [options] [files...]"
   o.bool '-h', '--help', 'Show these instructions'
   o.bool '--version', 'Show current version'
+  o.bool '--fix', 'Fix all files instead of reporting their problems'
   o.string '--license', 'File name of the boilerplate head license'
 end
 
@@ -50,9 +51,13 @@ Encoding.default_internal = Encoding::UTF_8
 
 license = opts.license? ? File.read(opts[:license]) : ''
 
-begin
-  Xcop::CLI.new(opts.arguments, license).run
-rescue StandardError => e
-  puts e.message
-  exit -1
+if opts.fix?
+  Xcop::CLI.new(opts.arguments, license).fix
+else
+  begin
+    Xcop::CLI.new(opts.arguments, license).run
+  rescue StandardError => e
+    puts e.message
+    exit -1
+  end
 end

data/features/cli.feature

@@ -71,3 +71,14 @@ Feature: Command Line Processing
     And Stdout contains "Broken license"
     And Exit code is not zero
 
+  Scenario: Fixing incorrect XML file
+    Given I have a "broken.xml" file with content:
+    """
+    <a><b>something</b>
+    </a>
+    """
+    When I run bin/xcop with "--fix broken.xml"
+    Then Exit code is zero
+    Then I run bin/xcop with "broken.xml"
+    Then Exit code is zero
+

data/lib/xcop.rb

@@ -55,6 +55,15 @@ module Xcop
         print "OK\n"
       end
     end
+
+    # Fix them all.
+    def fix
+      @files.each do |f|
+        print "Fixing #{f}... "
+        Document.new(f).fix(@license)
+        print "done\n"
+      end
+    end
   end
 
   # One document.
@@ -78,15 +87,23 @@ module Xcop
     # Return the difference for the license.
     def ldiff(license)
       xml = Nokogiri::XML(File.open(@path), &:noblanks)
-      now = xml.xpath('/comment()')[0].to_s
-      ideal = [
-        '<!--',
-        *license.strip.split(/\n/).map(&:strip),
-        '-->'
-      ].join("\n")
+      now = xml.xpath('/comment()')[0].text.to_s.strip
+      ideal = license.strip
       Differ.format = :color
       return Differ.diff_by_line(ideal, now).to_s unless now == ideal
       ''
     end
+
+    # Fixes the document.
+    def fix(license = '')
+      xml = Nokogiri::XML(File.open(@path), &:noblanks)
+      unless license.empty?
+        xml.children.before(
+          Nokogiri::XML::Comment.new(xml, license.strip)
+        )
+      end
+      ideal = xml.to_xml(indent: 2)
+      File.write(@path, ideal)
+    end
   end
 end

data/lib/xcop/version.rb

@@ -25,5 +25,5 @@
 # Copyright:: Copyright (c) 2017 Yegor Bugayenko
 # License:: MIT
 module Xcop
-  VERSION = '0.4'.freeze
+  VERSION = '0.5'.freeze
 end

data/test/test_xcop.rb

@@ -58,4 +58,15 @@ class TestXcop < Minitest::Test
       assert_equal(Xcop::Document.new(f).ldiff(license), '')
     end
   end
+
+  def test_fixes_document
+    Dir.mktmpdir 'test3' do |dir|
+      f = File.join(dir, 'bad.xml')
+      license = "Copyright (c) Me, Myself, and I\nLike it?\n\n"
+      File.write(f, '<hello>My friend!</hello>')
+      Xcop::Document.new(f).fix(license)
+      assert_equal(Xcop::Document.new(f).diff, '')
+      assert_equal(Xcop::Document.new(f).ldiff(license), '')
+    end
+  end
 end

metadata

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