xcop 0.7.2 → 0.9.0

data/.github/workflows/rake.yml

@@ -1,44 +0,0 @@
-# (The MIT License)
-#
-# Copyright (c) 2017-2025 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 NONINFRINGEMENT. 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.
----
-name: rake
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
-jobs:
-  test:
-    strategy:
-      matrix:
-        os: [ubuntu-24.04, macos-15]
-        ruby: ['2.7', '3.0']
-    runs-on: ${{ matrix.os }}
-    steps:
-      - uses: actions/checkout@v4
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - run: bundle update
-      - run: bundle exec rake

data/.github/workflows/xcop.yml

@@ -1,33 +0,0 @@
-# (The MIT License)
-#
-# Copyright (c) 2017-2025 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 NONINFRINGEMENT. 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.
----
-name: xcop
-on:
-  push:
-  pull_request:
-jobs:
-  xcop:
-    timeout-minutes: 15
-    runs-on: ubuntu-24.04
-    steps:
-      - uses: actions/checkout@v4
-      - uses: g4s8/xcop-action@master

data/.github/workflows/yamllint.yml

@@ -1,37 +0,0 @@
-# (The MIT License)
-#
-# Copyright (c) 2017-2025 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 NONINFRINGEMENT. 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.
----
-name: yamllint
-'on':
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
-jobs:
-  yamllint:
-    timeout-minutes: 15
-    runs-on: ubuntu-24.04
-    steps:
-      - uses: actions/checkout@v4
-      - uses: ibiqlik/action-yamllint@v3

data/.gitignore

@@ -1,7 +0,0 @@
-coverage/
-Gemfile.lock
-.idea/
-*.gem
-.bundle/
-.DS_Store
-rdoc/

data/.pdd

@@ -1,7 +0,0 @@
---source=.
---verbose
---exclude target/**/*
---exclude coverage/**/*
---rule min-words:20
---rule min-estimate:15
---rule max-estimate:90

data/.rubocop.yml

@@ -1,45 +0,0 @@
-# (The MIT License)
-#
-# Copyright (c) 2017-2025 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 NONINFRINGEMENT. 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.
----
-AllCops:
-  Exclude:
-    - 'bin/**/*'
-    - 'assets/**/*'
-  DisplayCopNames: true
-  TargetRubyVersion: 2.2
-  NewCops: enable
-  SuggestExtensions: false
-Metrics/CyclomaticComplexity:
-  Max: 10
-Metrics/MethodLength:
-  Enabled: false
-Layout/MultilineMethodCallIndentation:
-  Enabled: false
-Metrics/AbcSize:
-  Enabled: false
-Metrics/BlockLength:
-  Max: 50
-Layout/EmptyLineAfterGuardClause:
-  Enabled: false
-Style/ClassAndModuleChildren:
-  Enabled: false
-require: []

data/.rultor.yml

@@ -1,45 +0,0 @@
-# (The MIT License)
-#
-# Copyright (c) 2017-2025 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 NONINFRINGEMENT. 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.
----
-assets:
-  rubygems.yml: yegor256/home#assets/rubygems.yml
-install: |
-  pdd -f /dev/null
-  sudo bundle install --no-color "--gemfile=$(pwd)/Gemfile"
-release:
-  pre: false
-  script: |-
-    bundle exec rake
-    rm -rf *.gem
-    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
-    chmod 0600 ../rubygems.yml
-    gem push *.gem --config-file ../rubygems.yml
-merge:
-  script: |-
-    bundle exec rake
-deploy:
-  script: |-
-    echo "There is nothing to deploy"
-    exit -1

data/.simplecov

@@ -1,38 +0,0 @@
-# Copyright (c) 2017-2025 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.
-
-if Gem.win_platform?
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-    SimpleCov::Formatter::HTMLFormatter
-  ]
-  SimpleCov.start do
-    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/'
-    minimum_coverage 80
-  end
-end

data/renovate.json

@@ -1,6 +0,0 @@
-{
-  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-  "extends": [
-    "config:base"
-  ]
-}

data/test/test__helper.rb

@@ -1,29 +0,0 @@
-# Copyright (c) 2017-2025 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.
-
-$stdout.sync = true
-
-require 'simplecov-cobertura'
-SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
-
-require 'minitest/reporters'
-Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new]
-
-require 'minitest/autorun'

data/test/test_document.rb

@@ -1,111 +0,0 @@
-# Copyright (c) 2017-2025 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 'minitest/autorun'
-require 'nokogiri'
-require 'tmpdir'
-require 'slop'
-require_relative '../lib/xcop/document'
-
-# Test for Document class.
-# Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2017-2025 Yegor Bugayenko
-# License:: MIT
-class TestXcop < Minitest::Test
-  def test_basic
-    Dir.mktmpdir 'test1' do |dir|
-      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
-
-  def test_file_without_tail_eol
-    Dir.mktmpdir 'test9' do |dir|
-      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
-
-  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)
-      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
-end

data/test/test_rake_task.rb

@@ -1,59 +0,0 @@
-# Copyright (c) 2017-2025 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 'minitest/autorun'
-require 'tmpdir'
-require 'rake'
-require_relative '../lib/xcop/rake_task'
-
-# Xcop rake task.
-# Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2017-2025 Yegor Bugayenko
-# License:: MIT
-class TestRakeTask < Minitest::Test
-  def test_basic
-    Dir.mktmpdir 'test' do |dir|
-      Dir.chdir(dir)
-      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)
-      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