xcop 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cd1d77aa073a33fa549467c9140a9b29acaa7bcb5153063fec23f0e4515dd6c
-  data.tar.gz: ea379a6c817dcd72c7b55115eba1b2e894456db388cc417bbb1de450cb260541
+  metadata.gz: 621974a384c1f03cc98fbadc4faa33c68221c0c003bfdbdabdd6b8f8a5434e01
+  data.tar.gz: ae1523185af93addef82ef161f8d0c807cecfb0f6a9c7597907b31edad19c035
 SHA512:
-  metadata.gz: 5bd10b38f9d7d37bb1ba65b8d72641cfbd64aa9a160f03fd8cd9a136e1c336863380ce8787fdd2a941d5f754a7233cea7c8d3f1b26da4993cb48209d8a051f0f
-  data.tar.gz: 1ccb0d23efd0ea1368ce79f63707e1cdd7e5aae6d924423ccc10e0b97778665c81bbacebd06c955dcf233e64a27b6ddfd90615439dcacd98cd0491c87a00e80d
+  metadata.gz: 83c34c3ce482c004d16ae4b6dee2ca731cfe1791ff219d2667de59d398e2281b7ec73a45fe59bf8f9466bd9ad32cda2e6fd596e47d5753e13c848e198d495e57
+  data.tar.gz: f86b27b0e738e26180d06f04079273d77b48b2f339d339ce11e42b4d968f9e094caaca361544201096ec2501a5702149298b5edc6260c727e5bce362ec33e2eb

data/.github/workflows/actionlint.yml

@@ -20,6 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 ---
+# yamllint disable rule:line-length
 name: actionlint
 'on':
   push:
@@ -36,7 +37,6 @@ jobs:
       - uses: actions/checkout@v4
       - name: Download actionlint
         id: get_actionlint
-        # yamllint disable-line rule:line-length
         run: bash <(curl https://raw.githubusercontent.com/rhysd/actionlint/main/scripts/download-actionlint.bash)
         shell: bash
       - name: Check workflow files

data/.github/workflows/copyrights.yml

@@ -20,6 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 ---
+# yamllint disable rule:line-length
 name: copyrights
 'on':
   push:

data/.github/workflows/pdd.yml

@@ -20,6 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 ---
+# yamllint disable rule:line-length
 name: pdd
 on:
   push:
@@ -30,4 +31,4 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
-      - uses: g4s8/pdd-action@master
+      - uses: volodya-lombrozo/pdd-action@master

data/.github/workflows/rake.yml

@@ -20,6 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 ---
+# yamllint disable rule:line-length
 name: rake
 on:
   push:

data/.github/workflows/xcop.yml

@@ -20,6 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 ---
+# yamllint disable rule:line-length
 name: xcop
 on:
   push:

data/.github/workflows/yamllint.yml

@@ -20,6 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 ---
+# yamllint disable rule:line-length
 name: yamllint
 'on':
   push:

data/README.md

@@ -64,7 +64,6 @@ They all will be _added_ to the list of options you specify. For example,
 as it was suggested in [this blog post](https://www.yegor256.com/2022/07/20/command-line-defaults.html):
 
 ```
---license=LICENSE.txt
 --nocolor
 --quiet
 --include=**/*
@@ -83,7 +82,6 @@ This is what you need there:
 require 'xcop/rake_task'
 desc 'Run XCop on all XML/XSL files in all directories'
 Xcop::RakeTask.new(:xcop) do |task|
-  task.license = 'LICENSE.txt' # no license by default
   task.quiet = true # FALSE by default
   task.includes = ['**/*.xml', '**/*.xsl'] # xml|xsd|xhtml|xsl|html by default
   task.excludes = ['target/**/*'] # empty by default
@@ -114,12 +112,11 @@ jobs:
       - uses: g4s8/xcop-action@master
 ```
 
-To customize license location or files pattern use action inputs `license` and `files`:
+To customize files pattern use `files`:
 
 ```yaml
 - uses: g4s8/xcop-action@master
   with:
-    license: MY_LICENSE.txt
     files: "src/*.xml"
 ```
 
@@ -144,8 +141,6 @@ You can integrate it with the help of
             <configuration>
               <target>
                 <apply executable="xcop" failonerror="true">
-                  <arg value="--license"/>
-                  <arg value="LICENSE.txt"/>
                   <fileset dir=".">
                     <include name="**/*.xml"/>
                     <include name="**/*.xsd"/>
@@ -175,8 +170,6 @@ Something like this should work:
   [...]
   <target name="xcop">
     <apply executable="xcop" failonerror="true">
-      <arg value="--license"/>
-      <arg value="LICENSE.txt"/>
       <fileset dir=".">
         <include name="**/*.xml"/>
         <include name="**/*.xsd"/>

data/bin/xcop

@@ -47,7 +47,7 @@ opts = Slop.parse(args, strict: true, help: true) do |o|
   o.bool '--version', 'Show current version'
   o.bool '--fix', 'Fix all files instead of reporting their problems'
   o.bool '--nocolor', 'Suppress colored output'
-  o.string '--license', 'File name of the boilerplate head license'
+  o.string '--license', 'This option is deprecated'
   o.array '--include', 'Glob pattern(s) to include'
   o.array '--exclude', 'Glob pattern(s) to exclude'
 end
@@ -65,15 +65,6 @@ end
 Encoding.default_external = Encoding::UTF_8
 Encoding.default_internal = Encoding::UTF_8
 
-license = ''
-if opts.license?
-  unless File.exist?(opts[:license])
-    puts "License file is absent: #{opts[:license]}"
-    exit -1
-  end
-  license = File.read(opts[:license])
-end
-
 files = Set.new
 
 if opts[:include]
@@ -91,12 +82,12 @@ if opts[:exclude]
 end
 
 if opts.fix?
-  Xcop::CLI.new(files, license).fix do |f|
+  Xcop::CLI.new(files).fix do |f|
     puts "#{f} fixed" unless opts.quiet?
   end
 else
   begin
-    Xcop::CLI.new(files, license, nocolor: opts.nocolor?).run do |f|
+    Xcop::CLI.new(files, nocolor: opts.nocolor?).run do |f|
       puts "#{f} looks good" unless opts.quiet?
     end
   rescue StandardError => e

data/features/cli.feature

@@ -22,26 +22,6 @@ Feature: Command Line Processing
     Then Stdout contains "test.xml looks good"
     And Exit code is zero
 
-  Scenario: Validating correct XML file with license
-    Given I have a "licensed.xml" file with content:
-    """
-    <?xml version="1.0"?>
-    <!--
-    This is the license,
-    which is very very strict!
-    -->
-    <hello>Hello, world!</hello>
-
-    """
-    And I have a "LICENSE" file with content:
-    """
-    This is the license,
-    which is very very strict!
-    """
-    When I run bin/xcop with "--quiet --license LICENSE licensed.xml"
-    Then Stdout is empty
-    And Exit code is zero
-
   Scenario: Validating incorrect XML file
     Given I have a "abc.xml" file with content:
     """
@@ -51,24 +31,6 @@ Feature: Command Line Processing
     When I run bin/xcop with "abc.xml"
     Then Exit code is not zero
 
-  Scenario: Validating correct XML file with broken license
-    Given I have a "licensed.xml" file with content:
-    """
-    <?xml version="1.0"?>
-    <!--
-    This is the wrong license!
-    -->
-    <hello>Hello, world!</hello>
-
-    """
-    And I have a "LICENSE" file with content:
-    """
-    This is the right license.
-    """
-    When I run bin/xcop with "--license LICENSE licensed.xml"
-    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:
     """
@@ -79,4 +41,3 @@ Feature: Command Line Processing
     Then Exit code is zero
     Then I run bin/xcop with "broken.xml"
     Then Exit code is zero
-

data/lib/xcop/cli.rb

@@ -29,9 +29,8 @@ require_relative 'document'
 # Copyright:: Copyright (c) 2017-2025 Yegor Bugayenko
 # License:: MIT
 class Xcop::CLI
-  def initialize(files, license, nocolor: false)
+  def initialize(files, nocolor: false)
     @files = files
-    @license = license
     @nocolor = nocolor
   end
 
@@ -43,13 +42,6 @@ class Xcop::CLI
         puts diff
         raise "Invalid XML formatting in #{f}"
       end
-      unless @license.empty?
-        ldiff = doc.ldiff(@license)
-        unless ldiff.empty?
-          puts ldiff
-          raise "Broken license in #{f}"
-        end
-      end
       yield(f) if block_given?
     end
   end
@@ -57,7 +49,7 @@ class Xcop::CLI
   # Fix them all.
   def fix
     @files.each do |f|
-      Xcop::Document.new(f).fix(@license)
+      Xcop::Document.new(f).fix
       yield(f) if block_given?
     end
   end

data/lib/xcop/document.rb

@@ -42,24 +42,9 @@ class Xcop::Document
     differ(ideal, now, nocolor: nocolor)
   end
 
-  # Return the difference for the license.
-  def ldiff(license)
-    xml = Nokogiri::XML(File.open(@path), &:noblanks)
-    comment = xml.xpath('/comment()')[0]
-    now = comment.nil? ? '' : comment.text.to_s.strip
-    ideal = license.strip
-    differ(ideal, now)
-  end
-
   # Fixes the document.
-  def fix(license = '')
+  def fix
     xml = Nokogiri::XML(File.open(@path), &:noblanks)
-    unless license.empty?
-      xml.xpath('/comment()').remove
-      xml.children.before(
-        Nokogiri::XML::Comment.new(xml, "\n#{license.strip}\n")
-      )
-    end
     ideal = xml.to_xml(indent: 2)
     File.write(@path, ideal)
   end

data/lib/xcop/rake_task.rb

@@ -27,14 +27,13 @@ require_relative '../xcop/cli'
 # Copyright:: Copyright (c) 2017-2025 Yegor Bugayenko
 # License:: MIT
 class Xcop::RakeTask < Rake::TaskLib
-  attr_accessor :name, :fail_on_error, :excludes, :includes, :license, :quiet
+  attr_accessor :name, :fail_on_error, :excludes, :includes, :quiet
 
   def initialize(*args, &task_block)
     super()
     @name = args.shift || :xcop
     @includes = %w[xml xsd xhtml xsl html].map { |e| "**/*.#{e}" }
     @excludes = []
-    @license = nil
     @quiet = false
     desc 'Run Xcop' unless ::Rake.application.last_description
     task(name, *args) do |_, task_args|
@@ -53,7 +52,7 @@ 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, @license.nil? ? '' : File.read(@license)).run do
+      Xcop::CLI.new(good).run do
         print Rainbow('.').green unless @quiet
       end
     rescue StandardError => e

data/lib/xcop/version.rb

@@ -23,5 +23,5 @@
 # Copyright:: Copyright (c) 2017-2025 Yegor Bugayenko
 # License:: MIT
 module Xcop
-  VERSION = '0.7.2'.freeze
+  VERSION = '0.8.0'.freeze
 end

data/logo.svg

@@ -16,4 +16,4 @@
             </g>
         </g>
     </g>
-</svg>
+</svg>

data/test/test_document.rb

@@ -47,64 +47,12 @@ class TestXcop < Minitest::Test
     end
   end
 
-  def test_license_presence
-    Dir.mktmpdir 'test2' do |dir|
-      f = File.join(dir, 'a.xml')
-      license = " Copyright (c) All Good People\n Don't touch it!\n\n"
-      File.write(
-        f,
-        [
-          '<?xml version="1.0"?>',
-          '<!--',
-          ' Copyright (c) All Good People',
-          ' Don\'t touch it!',
-          '-->',
-          '<hello>Dude!</hello>',
-          ''
-        ].join("\n")
-      )
-      assert_equal(Xcop::Document.new(f).ldiff(license), '')
-      File.delete(f)
-    end
-  end
-
-  def test_license_absence
-    Dir.mktmpdir 'test3' do |dir|
-      f = File.join(dir, 'a.xml')
-      license = "Copyright (c) All Good People\nTouch me!\n\n"
-      File.write(
-        f,
-        [
-          '<?xml version="1.0"?>',
-          '<hello>My dear friend!</hello>',
-          ''
-        ].join("\n")
-      )
-      assert(Xcop::Document.new(f).ldiff(license) != '')
-      File.delete(f)
-    end
-  end
-
   def test_fixes_document
     Dir.mktmpdir 'test3' do |dir|
       f = File.join(dir, 'bad.xml')
-      license = " Copyright (c) Me, Myself, and I\n   Like it?\n\n"
       File.write(f, '<hello>My friend!</hello>')
-      Xcop::Document.new(f).fix(license)
+      Xcop::Document.new(f).fix
       assert_equal(Xcop::Document.new(f).diff, '')
-      assert_equal(Xcop::Document.new(f).ldiff(license), '')
-      File.delete(f)
-    end
-  end
-
-  def test_removes_previous_license
-    Dir.mktmpdir 'test4' do |dir|
-      f = File.join(dir, 'bad.xml')
-      license = "the license to add\n\n\nhey"
-      File.write(f, '<hello>how do you do?</hello>')
-      Xcop::Document.new(f).fix(license)
-      Xcop::Document.new(f).fix(license)
-      assert_equal(Nokogiri::XML(File.read(f)).xpath('/comment()').length, 1)
       File.delete(f)
     end
   end

data/test/test_rake_task.rb

@@ -35,7 +35,6 @@ class TestRakeTask < Minitest::Test
       File.write(f, "<?xml version=\"1.0\"?>\n<x/>\n")
       Xcop::RakeTask.new(:xcop1) do |task|
         task.quiet = true
-        # task.license = 'LICENSE.txt'
       end
       Rake::Task['xcop1'].invoke
       File.delete(f)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xcop
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-02-16 00:00:00.000000000 Z
+date: 2025-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: differ