xcop 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e36ceb8094cf5d0a19aea136e067aefead3f8d2d5d0be89ee04621bf377ea9f
-  data.tar.gz: 0ada0467d87ee9bd8eee76b455093d8eaf651d5297db98ba0c06a8f9cbdacd35
+  metadata.gz: 94e8fcd3843e72e2e95cc964a20acd22527734574d2da826e58b0b51fd50ead1
+  data.tar.gz: f454cfb06eecd4700b92c86c815bc4207d7554c455db2fba2d17a46f6c5cbc49
 SHA512:
-  metadata.gz: 95e7400cf83b268b35464cb701e8eda47e3f1db96d6d7dbb881a3d1cde7776dd6d5888334cd7c5f26f5727868e56638c06c6f9fe8da39a8a3f59156e33d9b338
-  data.tar.gz: b5535146d433e5bb9d37967f523e8851b6dfebf1486e6b4d0cdf41a4db72e0caefc821587bd0d9c791f0c46f4b1c76af1481a8470d411398d177ba51e0b26ca2
+  metadata.gz: 644e0b11601e49a0c8b1faf884d44d6d588d314c34e232497c9e690df6330769e3a20c0ffd975b83f9d08949599ca6c7420e0987505ddcf97b5cbdf5ff836921
+  data.tar.gz: 8ffdfd91e26107945987fd0914fa1debc15ab628e7020819b52d421ed21b14ca6c4a77cf12d18f614fe297d4002d2fdb7053bb94f7778a829421d3feffdad112

data/.github/workflows/rake.yml

@@ -0,0 +1,23 @@
+---
+name: rake
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: ['2.7', '3.0']
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle update
+      - run: bundle exec rake

data/.rubocop.yml

@@ -4,14 +4,20 @@ AllCops:
     - 'assets/**/*'
   DisplayCopNames: true
   TargetRubyVersion: 2.2
+  NewCops: enable
+  SuggestExtensions: false
 
 Metrics/CyclomaticComplexity:
   Max: 10
 Metrics/MethodLength:
   Enabled: false
-Style/MultilineMethodCallIndentation:
+Layout/MultilineMethodCallIndentation:
   Enabled: false
 Metrics/AbcSize:
   Enabled: false
 Metrics/BlockLength:
   Max: 50
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false

data/.rultor.yml

@@ -1,17 +1,13 @@
 assets:
   rubygems.yml: yegor256/home#assets/rubygems.yml
 install: |
-  export GEM_HOME=~/.ruby
-  export GEM_PATH=$GEM_HOME:$GEM_PATH
-  sudo apt-get -y update
-  sudo gem install pdd -v 0.20.5
-  bundle install
+  pdd -f /dev/null
+  sudo bundle install --no-color "--gemfile=$(pwd)/Gemfile"
 release:
   script: |-
     bundle exec rake
-    pdd -f /dev/null
     rm -rf *.gem
-    sed -i "s/1\.0\.snapshot/${tag}/g" lib/xcop/version.rb
+    sed -i "s/0\.0\.0/${tag}/g" lib/xcop/version.rb
     git add lib/xcop/version.rb
     git commit -m "version set to ${tag}"
     gem build xcop.gemspec
@@ -20,7 +16,6 @@ release:
 merge:
   script: |-
     bundle exec rake
-    pdd -f /dev/null
 deploy:
   script: |-
     echo "There is nothing to deploy"

data/.simplecov

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2021 Yegor Bugayenko
+# Copyright (c) 2017-2022 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -18,21 +18,21 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-if Gem.win_platform? then
+if Gem.win_platform?
   SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
     SimpleCov::Formatter::HTMLFormatter
   ]
   SimpleCov.start do
-    add_filter "/test/"
-    add_filter "/features/"
+    add_filter '/test/'
+    add_filter '/features/'
   end
 else
   SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
     [SimpleCov::Formatter::HTMLFormatter]
   )
   SimpleCov.start do
-    add_filter "/test/"
-    add_filter "/features/"
+    add_filter '/test/'
+    add_filter '/features/'
     minimum_coverage 80
   end
 end

data/Gemfile

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2021 Yegor Bugayenko
+# Copyright (c) 2017-2022 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/LICENSE.txt

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2017-2021 Yegor Bugayenko
+Copyright (c) 2017-2022 Yegor Bugayenko
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the 'Software'), to deal

data/README.md

@@ -1,30 +1,31 @@
-<img src="/logo.svg" width="64px"/>
+<img alt="XCOP logo" src="/logo.svg" width="64px"/>
 
 [![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)
 [![Managed by Zerocracy](https://www.0crat.com/badge/C3RFVLU72.svg)](https://www.0crat.com/p/C3RFVLU72)
 [![DevOps By Rultor.com](http://www.rultor.com/b/yegor256/xcop)](http://www.rultor.com/p/yegor256/xcop)
 [![We recommend RubyMine](https://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)
 
-[![Build Status](https://travis-ci.org/yegor256/xcop.svg)](https://travis-ci.org/yegor256/xcop)
-[![Build status](https://ci.appveyor.com/api/projects/status/orvfo2qgmd1d7a2i?svg=true)](https://ci.appveyor.com/project/yegor256/xcop)
+[![rake](https://github.com/yegor256/xcop/actions/workflows/rake.yml/badge.svg)](https://github.com/yegor256/xcop/actions/workflows/rake.yml)
 [![PDD status](http://www.0pdd.com/svg?name=yegor256/xcop)](http://www.0pdd.com/p?name=yegor256/xcop)
 [![Gem Version](https://badge.fury.io/rb/xcop.svg)](http://badge.fury.io/rb/xcop)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/xcop/blob/master/LICENSE.txt)
 
 [![Maintainability](https://api.codeclimate.com/v1/badges/396ec0584e0a84adc723/maintainability)](https://codeclimate.com/github/yegor256/xcop/maintainability)
 [![Test Coverage](https://img.shields.io/codecov/c/github/yegor256/xcop.svg)](https://codecov.io/github/yegor256/xcop?branch=master)
+![Lines of code](https://img.shields.io/tokei/lines/github/yegor256/xcop)
 [![Hits-of-Code](https://hitsofcode.com/github/yegor256/xcop)](https://hitsofcode.com/view/github/yegor256/xcop)
 
 This command line tool validates your XML files for proper formatting.
 If they are not formatted correctly, it prints the difference and
-returns with an error. You can use it two ways: 1) to fail your build
-if any X-like files (XML, XSD, XSL, XHTML) are not formatted correctly,
-and 2) to format them correctly.
+exits with an error. You can use it two ways: 1) to fail your build
+if any XML-ish files (for example, XML, XSD, XSL, or XHTML) are not formatted correctly,
+and 2) to format them correctly using `--fix` option.
 
-Read this blog post of mine first:
+Read this blog post first:
 [_XCOP—XML Style Checker_](https://www.yegor256.com/2017/08/29/xcop.html).
 
-Install it first (read below if you can't install it):
+Make sure you have [Ruby installed](https://www.ruby-lang.org/en/documentation/installation/)
+and then install the tool:
 
 ```bash
 $ gem install xcop
@@ -57,6 +58,24 @@ To fix all files in the directory you can do
 $ xcop --fix $(find . -name '*.xml')
 ```
 
+## Defaults
+
+You can put command line options into `.xcop` file in the directory
+where you start `xcop`. Each option should take a single line in the file.
+They all will be _added_ to the list of options you specify. For example:
+
+```
+--license LICENSE.txt
+--nocolor
+--quiet
+--include **/*
+--exclude **/*.xsl
+--exclude **/*.html
+```
+
+You can also create `~/.xcop` file (in your personal home directory), which
+will also be read and _added_ to the command line options.
+
 ## How to use in `Rakefile`?
 
 This is what you need there:
@@ -75,6 +94,7 @@ end
 ## How to use as GitHub action?
 
 Create new workflow file in repository under `.github/workflows/xcop.yml`:
+
 ```yaml
 ---
 name: XCOP
@@ -94,7 +114,9 @@ jobs:
       - uses: actions/checkout@v2
       - uses: g4s8/xcop-action@master
 ```
+
 To customize license location or files pattern use action inputs `license` and `files`:
+
 ```yaml
 - uses: g4s8/xcop-action@master
   with:

data/Rakefile

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2021 Yegor Bugayenko
+# Copyright (c) 2017-2022 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -56,6 +56,7 @@ desc 'Run RuboCop on all directories'
 RuboCop::RakeTask.new(:rubocop) do |task|
   task.fail_on_error = true
   task.requires << 'rubocop-rspec'
+  task.options = ['--display-cop-names']
 end
 
 require 'cucumber/rake/task'

data/bin/xcop

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# Copyright (c) 2017-2021 Yegor Bugayenko
+# Copyright (c) 2017-2022 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -23,21 +23,24 @@ STDOUT.sync = true
 
 require 'slop'
 require 'nokogiri'
-require_relative '../lib/xcop'
+require 'set'
+require_relative '../lib/xcop/cli'
 require_relative '../lib/xcop/version'
 
 if Gem::Version.new(Nokogiri::VERSION) < Gem::Version.new('1.8')
   puts "Nokogiri version #{Nokogiri::VERSION} is too old, 1.8+ is required"
 end
 
-file_cfg = []
-if File.exist?('.xcop')
-  file_cfg += File.open('.xcop').read.gsub(/\s+/, " ").strip.split(/\s/)
+def config(path)
+  f = File.expand_path(path)
+  args = []
+  args += File.readlines(f).map(&:strip) if File.exist?(f)
+  args
 end
 
-merged = ARGV + file_cfg
+args = config('~/.xcop') + config('.xcop') + ARGV
 
-opts = Slop.parse(merged, strict: true, help: true) do |o|
+opts = Slop.parse(args, strict: true, help: true) do |o|
   o.banner = "Usage (#{Xcop::VERSION}): xcop [options] [files...]"
   o.bool '-h', '--help', 'Show these instructions'
   o.bool '-q', '--quiet', 'Don\'t print anything if there are no errors'
@@ -45,6 +48,8 @@ opts = Slop.parse(merged, strict: true, help: true) do |o|
   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.array '--include', 'Glob pattern(s) to include'
+  o.array '--exclude', 'Glob pattern(s) to exclude'
 end
 
 if opts.help?
@@ -60,15 +65,38 @@ end
 Encoding.default_external = Encoding::UTF_8
 Encoding.default_internal = Encoding::UTF_8
 
-license = opts.license? ? File.read(opts[:license]) : ''
+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]
+  opts[:include].each do |glob|
+    files += Dir.glob(glob).map { |f| File.expand_path(f) }
+  end
+end
+
+files += opts.arguments.map { |f| File.expand_path(f) }
+
+if opts[:exclude]
+  opts[:exclude].each do |glob|
+    files -= Dir.glob(glob).map { |f| File.expand_path(f) }
+  end
+end
 
 if opts.fix?
-  Xcop::CLI.new(opts.arguments, license).fix do |f|
+  Xcop::CLI.new(files, license).fix do |f|
     puts "#{f} fixed" unless opts.quiet?
   end
 else
   begin
-    Xcop::CLI.new(opts.arguments, license, opts.nocolor?).run do |f|
+    Xcop::CLI.new(files, license, nocolor: opts.nocolor?).run do |f|
       puts "#{f} looks good" unless opts.quiet?
     end
   rescue StandardError => e

data/features/step_definitions/steps.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2021 Yegor Bugayenko
+# Copyright (c) 2017-2022 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -22,7 +22,6 @@ require 'nokogiri'
 require 'tmpdir'
 require 'slop'
 require 'English'
-require_relative '../../lib/xcop'
 
 Before do
   @cwd = Dir.pwd
@@ -42,9 +41,7 @@ end
 
 Given(/^I have a "([^"]*)" file with content:$/) do |file, text|
   FileUtils.mkdir_p(File.dirname(file)) unless File.exist?(file)
-  File.open(file, 'w') do |f|
-    f.write(text.gsub(/\\xFF/, 0xFF.chr))
-  end
+  File.write(file, text.gsub(/\\xFF/, 0xFF.chr))
 end
 
 When(%r{^I run bin/xcop with "([^"]*)"$}) do |arg|
@@ -54,9 +51,7 @@ When(%r{^I run bin/xcop with "([^"]*)"$}) do |arg|
 end
 
 Then(/^Stdout contains "([^"]*)"$/) do |txt|
-  unless @stdout.include?(txt)
-    raise "STDOUT doesn't contain '#{txt}':\n#{@stdout}"
-  end
+  raise "STDOUT doesn't contain '#{txt}':\n#{@stdout}" unless @stdout.include?(txt)
 end
 
 Then(/^Stdout is empty$/) do

data/features/support/env.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2021 Yegor Bugayenko
+# Copyright (c) 2017-2022 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -19,4 +19,3 @@
 # SOFTWARE.
 
 require 'simplecov'
-require_relative '../../lib/xcop'

data/lib/xcop/cli.rb

@@ -0,0 +1,64 @@
+# Copyright (c) 2017-2022 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'nokogiri'
+require 'differ'
+require 'rainbow'
+require_relative 'version'
+require_relative 'document'
+
+# Command line interface.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2017-2022 Yegor Bugayenko
+# License:: MIT
+class Xcop::CLI
+  def initialize(files, license, nocolor: false)
+    @files = files
+    @license = license
+    @nocolor = nocolor
+  end
+
+  def run
+    @files.each do |f|
+      doc = Xcop::Document.new(f)
+      diff = doc.diff(nocolor: @nocolor)
+      unless diff.empty?
+        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
+
+  # Fix them all.
+  def fix
+    @files.each do |f|
+      Xcop::Document.new(f).fix(@license)
+      yield(f) if block_given?
+    end
+  end
+end

data/lib/xcop/document.rb

@@ -0,0 +1,82 @@
+# Copyright (c) 2017-2022 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'nokogiri'
+require 'differ'
+require 'rainbow'
+require_relative 'version'
+
+# One document.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2017-2022 Yegor Bugayenko
+# License:: MIT
+class Xcop::Document
+  # Ctor.
+  # +path+:: Path of it
+  def initialize(path)
+    @path = path
+  end
+
+  # Return the difference, if any (empty string if everything is clean).
+  def diff(nocolor: false)
+    xml = Nokogiri::XML(File.open(@path), &:noblanks)
+    ideal = xml.to_xml(indent: 2)
+    now = File.read(@path)
+    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 = '')
+    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
+
+  private
+
+  def differ(ideal, fact, nocolor: false)
+    return '' if ideal == fact
+    if nocolor
+      Differ.diff_by_line(ideal, fact).to_s
+    else
+      Differ.format = :color
+      Differ.diff_by_line(schars(ideal), schars(fact)).to_s
+    end
+  end
+
+  def schars(text)
+    text.gsub(/\n/, "\\n\n")
+  end
+end

data/lib/xcop/rake_task.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2021 Yegor Bugayenko
+# Copyright (c) 2017-2022 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -20,59 +20,51 @@
 
 require 'rake'
 require 'rake/tasklib'
-require_relative '../xcop'
+require_relative '../xcop/cli'
 
 # Xcop rake task.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2017-2021 Yegor Bugayenko
+# Copyright:: Copyright (c) 2017-2022 Yegor Bugayenko
 # License:: MIT
-module Xcop
-  # Rake task.
-  class RakeTask < Rake::TaskLib
-    attr_accessor :name
-    attr_accessor :fail_on_error
-    attr_accessor :excludes
-    attr_accessor :includes
-    attr_accessor :license
-    attr_accessor :quiet
+class Xcop::RakeTask < Rake::TaskLib
+  attr_accessor :name, :fail_on_error, :excludes, :includes, :license, :quiet
 
-    def initialize(*args, &task_block)
-      @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|
-        RakeFileUtils.send(:verbose, true) do
-          yield(*[self, task_args].slice(0, task_block.arity)) if block_given?
-          run
-        end
+  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|
+      RakeFileUtils.send(:verbose, true) do
+        yield(*[self, task_args].slice(0, task_block.arity)) if block_given?
+        run
       end
     end
+  end
 
-    private
+  private
 
-    def run
-      require 'xcop'
-      puts 'Running xcop...' unless @quiet
-      bad = Dir.glob(@excludes)
-      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
-          print Rainbow('.').green unless @quiet
-        end
-      rescue StandardError => e
-        abort(e.message)
+  def run
+    puts 'Running xcop...' unless @quiet
+    bad = Dir.glob(@excludes)
+    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
+        print Rainbow('.').green unless @quiet
       end
-      return if @quiet
-      puts "\n#{pluralize(good.length, 'file')} checked, \
-everything looks #{Rainbow('pretty').green}"
+    rescue StandardError => e
+      abort(e.message)
     end
+    return if @quiet
+    puts "\n#{pluralize(good.length, 'file')} checked, \
+everything looks #{Rainbow('pretty').green}"
+  end
 
-    def pluralize(num, text)
-      "#{num} #{num == 1 ? text : text + 's'}"
-    end
+  def pluralize(num, text)
+    "#{num} #{num == 1 ? text : "#{text}s"}"
   end
 end

data/lib/xcop/version.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2021 Yegor Bugayenko
+# Copyright (c) 2017-2022 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -20,8 +20,8 @@
 
 # Xcop main module.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2017-2021 Yegor Bugayenko
+# Copyright:: Copyright (c) 2017-2022 Yegor Bugayenko
 # License:: MIT
 module Xcop
-  VERSION = '0.6.3'.freeze
+  VERSION = '0.7.0'.freeze
 end

data/test/test__helper.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2021 Yegor Bugayenko
+# Copyright (c) 2017-2022 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -18,7 +18,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-STDOUT.sync = true
+$stdout.sync = true
 
 require 'simplecov'
 SimpleCov.start
@@ -28,4 +28,3 @@ if ENV['CI'] == 'true'
 end
 
 require 'minitest/autorun'
-require_relative '../lib/xcop'

data/test/{test_xcop.rb → test_document.rb}

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2021 Yegor Bugayenko
+# Copyright (c) 2017-2022 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -22,11 +22,11 @@ require 'minitest/autorun'
 require 'nokogiri'
 require 'tmpdir'
 require 'slop'
-require_relative '../lib/xcop'
+require_relative '../lib/xcop/document'
 
-# Xcop main module test.
+# Test for Document class.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2017-2021 Yegor Bugayenko
+# Copyright:: Copyright (c) 2017-2022 Yegor Bugayenko
 # License:: MIT
 class TestXcop < Minitest::Test
   def test_basic
@@ -34,6 +34,7 @@ class TestXcop < Minitest::Test
       f = File.join(dir, 'a.xml')
       File.write(f, "<?xml version=\"1.0\"?>\n<hello>Dude!</hello>\n")
       assert_equal(Xcop::Document.new(f).diff, '')
+      File.delete(f)
     end
   end
 
@@ -42,6 +43,7 @@ class TestXcop < Minitest::Test
       f = File.join(dir, 'no-eol.xml')
       File.write(f, "<?xml version=\"1.0\"?>\n<x/>")
       assert(Xcop::Document.new(f).diff != '')
+      File.delete(f)
     end
   end
 
@@ -62,6 +64,7 @@ class TestXcop < Minitest::Test
         ].join("\n")
       )
       assert_equal(Xcop::Document.new(f).ldiff(license), '')
+      File.delete(f)
     end
   end
 
@@ -78,6 +81,7 @@ class TestXcop < Minitest::Test
         ].join("\n")
       )
       assert(Xcop::Document.new(f).ldiff(license) != '')
+      File.delete(f)
     end
   end
 
@@ -89,6 +93,7 @@ class TestXcop < Minitest::Test
       Xcop::Document.new(f).fix(license)
       assert_equal(Xcop::Document.new(f).diff, '')
       assert_equal(Xcop::Document.new(f).ldiff(license), '')
+      File.delete(f)
     end
   end
 
@@ -100,6 +105,7 @@ class TestXcop < Minitest::Test
       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
 end

data/test/test_rake_task.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2021 Yegor Bugayenko
+# Copyright (c) 2017-2022 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -25,31 +25,35 @@ require_relative '../lib/xcop/rake_task'
 
 # Xcop rake task.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2017-2021 Yegor Bugayenko
+# Copyright:: Copyright (c) 2017-2022 Yegor Bugayenko
 # License:: MIT
 class TestRakeTask < Minitest::Test
   def test_basic
     Dir.mktmpdir 'test' do |dir|
       Dir.chdir(dir)
-      File.write('a.xml', "<?xml version=\"1.0\"?>\n<x/>\n")
+      f = File.join(dir, 'a.xml')
+      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)
     end
   end
 
   def test_with_broken_xml
     Dir.mktmpdir 'test' do |dir|
       Dir.chdir(dir)
-      File.write('broken.xml', "<z><a><b></b></a>\n\n</z>")
+      f = File.join(dir, 'broken.xml')
+      File.write(f, "<z><a><b></b></a>\n\n</z>")
       Xcop::RakeTask.new(:xcop2) do |task|
         task.excludes = ['test/**/*']
       end
       assert_raises SystemExit do
         Rake::Task['xcop2'].invoke
       end
+      File.delete(f)
     end
   end
 end

data/xcop.gemspec

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2021 Yegor Bugayenko
+# Copyright (c) 2017-2022 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -20,20 +20,19 @@
 
 require 'English'
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require_relative 'lib/xcop/version'
 
 Gem::Specification.new do |s|
   s.specification_version = 2 if s.respond_to? :specification_version=
-  if s.respond_to? :required_rubygems_version=
-    s.required_rubygems_version = Gem::Requirement.new('>= 0')
-  end
+  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
   s.rubygems_version = '2.2'
   s.required_ruby_version = '>= 2.2'
   s.name = 'xcop'
   s.version = Xcop::VERSION
   s.license = 'MIT'
+  s.metadata = { 'rubygems_mfa_required' => 'true' }
   s.summary = 'XML Formatting Static Validator'
   s.description = 'Validates XML-like documents for proper formatting'
   s.authors = ['Yegor Bugayenko']
@@ -41,18 +40,17 @@ Gem::Specification.new do |s|
   s.homepage = 'http://github.com/yegor256/xcop'
   s.files = `git ls-files`.split($RS)
   s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.test_files = s.files.grep(%r{^(test|spec|features)/})
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
   s.add_runtime_dependency 'differ', '~>0.1.2'
   s.add_runtime_dependency 'nokogiri', '~>1.10'
   s.add_runtime_dependency 'rainbow', '~>3.0'
   s.add_runtime_dependency 'slop', '~>4.4'
-  s.add_development_dependency 'codecov', '0.2.12'
-  s.add_development_dependency 'cucumber', '5.2.0'
-  s.add_development_dependency 'minitest', '5.14.2'
-  s.add_development_dependency 'rake', '13.0.1'
-  s.add_development_dependency 'rdoc', '6.2.1'
-  s.add_development_dependency 'rubocop', '0.52.0'
-  s.add_development_dependency 'rubocop-rspec', '1.5.1'
+  s.add_development_dependency 'codecov', '0.6.0'
+  s.add_development_dependency 'cucumber', '8.0.0'
+  s.add_development_dependency 'minitest', '5.15.0'
+  s.add_development_dependency 'rake', '13.0.6'
+  s.add_development_dependency 'rdoc', '6.4.0'
+  s.add_development_dependency 'rubocop', '1.30.1'
+  s.add_development_dependency 'rubocop-rspec', '2.11.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xcop
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-12 00:00:00.000000000 Z
+date: 2022-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: differ
@@ -72,98 +72,98 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.12
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.12
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 8.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.14.2
+        version: 5.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.14.2
+        version: 5.15.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.2.1
+        version: 6.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.2.1
+        version: 6.4.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.52.0
+        version: 1.30.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.52.0
+        version: 1.30.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 2.11.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 2.11.1
 description: Validates XML-like documents for proper formatting
 email: yegor256@gmail.com
 executables:
@@ -177,17 +177,16 @@ files:
 - ".gitattributes"
 - ".github/ISSUE_TEMPLATE.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/rake.yml"
 - ".gitignore"
 - ".pdd"
 - ".rubocop.yml"
 - ".rultor.yml"
 - ".simplecov"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- appveyor.yml
 - bin/xcop
 - cucumber.yml
 - features/cli.feature
@@ -195,18 +194,20 @@ files:
 - features/rake.feature
 - features/step_definitions/steps.rb
 - features/support/env.rb
-- lib/xcop.rb
+- lib/xcop/cli.rb
+- lib/xcop/document.rb
 - lib/xcop/rake_task.rb
 - lib/xcop/version.rb
 - logo.svg
 - test/test__helper.rb
+- test/test_document.rb
 - test/test_rake_task.rb
-- test/test_xcop.rb
 - xcop.gemspec
 homepage: http://github.com/yegor256/xcop
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"
@@ -227,12 +228,4 @@ rubygems_version: 3.1.2
 signing_key: 
 specification_version: 2
 summary: XML Formatting Static Validator
-test_files:
-- features/cli.feature
-- features/gem_package.feature
-- features/rake.feature
-- features/step_definitions/steps.rb
-- features/support/env.rb
-- test/test__helper.rb
-- test/test_rake_task.rb
-- test/test_xcop.rb
+test_files: []

data/.travis.yml

@@ -1,13 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.2
-cache: bundler
-branches:
-  only:
-    - master
-install:
-  - travis_retry bundle update
-script:
-  - bundle exec rake
-after_success:
-  - "bash <(curl -s https://codecov.io/bash)"

data/appveyor.yml

@@ -1,21 +0,0 @@
-version: '{build}'
-skip_tags: true
-clone_depth: 10
-branches:
-  only:
-    - master
-  except:
-    - gh-pages
-os: Windows Server 2012
-install:
-  - cmd: SET PATH=C:\Ruby23-x64\bin;%PATH%
-  - cmd: ruby --version
-  - cmd: git --version
-build_script:
-  - bundle update
-  - bundle install
-test_script:
-  - rake
-cache:
-  - C:\Ruby200\bin -> xcop.gemspec
-  - C:\Ruby200\lib\ruby\gems\2.0.0 -> xcop.gemspec

data/lib/xcop.rb

@@ -1,121 +0,0 @@
-# Copyright (c) 2017-2021 Yegor Bugayenko
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the 'Software'), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
-require 'nokogiri'
-require 'differ'
-require 'rainbow'
-require_relative 'xcop/version'
-
-# Xcop main module.
-# Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2017-2021 Yegor Bugayenko
-# License:: MIT
-module Xcop
-  # Command line interface.
-  class CLI
-    def initialize(files, license, nocolor = false)
-      @files = files
-      @license = license
-      @nocolor = nocolor
-    end
-
-    def run
-      @files.each do |f|
-        doc = Document.new(f)
-        diff = doc.diff(@nocolor)
-        unless diff.empty?
-          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
-
-    # Fix them all.
-    def fix
-      @files.each do |f|
-        Document.new(f).fix(@license)
-        yield(f) if block_given?
-      end
-    end
-  end
-
-  # One document.
-  class Document
-    # Ctor.
-    # +path+:: Path of it
-    def initialize(path)
-      @path = path
-    end
-
-    # Return the difference, if any (empty string if everything is clean).
-    def diff(nocolor = false)
-      xml = Nokogiri::XML(File.open(@path), &:noblanks)
-      ideal = xml.to_xml(indent: 2)
-      now = File.read(@path)
-      differ(ideal, now, 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 = '')
-      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
-
-    private
-
-    def differ(ideal, fact, nocolor = false)
-      return '' if ideal == fact
-      if nocolor
-        Differ.diff_by_line(ideal, fact).to_s
-      else
-        Differ.format = :color
-        Differ.diff_by_line(schars(ideal), schars(fact)).to_s
-      end
-    end
-
-    def schars(text)
-      text.gsub(/\n/, "\\n\n")
-    end
-  end
-end