pdd 0.21.3 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1f5d5ae8d72ca3e758c6757c3a18daacf4f24f841561ab0dc75ba5b0e14893a
-  data.tar.gz: 5325be41bd8e0b42a67fb235172a87dbd1f00492dd8311ec684806f5710c2465
+  metadata.gz: 1c97d7f2451c60abeae2fa0374b8578c852b6c2e42a78568c5fff8c7b5c3acc1
+  data.tar.gz: 5353eec5dea5875dc31a7655e694fc41c3585ff176f849db8122b777ee38a25a
 SHA512:
-  metadata.gz: a09ef466837dd362e530c354ab21ee5e7c26b349cefaebc4ebfb8d47e8c81a12d0ea0252244133e596847a34837238eeeb2478ad956f9eb81dcf09535f31b167
-  data.tar.gz: cf8f5a5748f822b69e46a08bd344370f2918127ec9e69050550907a6f5aa5efd8fd34405d5c6e203ef71080e4897d95d8e831e5a62bd0339cbcca2b1ff5e2c43
+  metadata.gz: ecded4d1f191fb5ab36eb237add8d46ca48430371a8c6ab9758a159ebfc796ac276a7327c4f9b33a3186ebd104c95e0255af12def22ccbcfaf0e3239decb67d7
+  data.tar.gz: 0fe7422e26da6f53561a3e51c597cb779f39f39828b9af55f8b2cd0fc8b1b359c919a0b82f3d39f26d487f5ac31a50020494f5fc1048cedf7b64545096847b22

data/.github/workflows/pdd.yml

@@ -0,0 +1,15 @@
+---
+name: pdd
+"on":
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  pdd:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - uses: g4s8/pdd-action@master

data/.github/workflows/xcop.yml

@@ -0,0 +1,15 @@
+---
+name: xcop
+"on":
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  xcop:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - uses: g4s8/xcop-action@master

data/.pdd

@@ -9,6 +9,7 @@
 --exclude features/cli.feature
 --exclude features/parsing.feature
 --exclude features/catches_broken_puzzles.feature
+--exclude features/remove.feature
 --exclude features/uses_config.feature
 --exclude features/html_output.feature
 --exclude features/avoiding_duplicates.feature

data/bin/pdd

@@ -50,6 +50,7 @@ begin
       o.bool '-h', '--help', 'Show these instructions'
       o.bool '-v', '--verbose', 'Enable verbose mode (a lot of logging)'
       o.bool '-q', '--quiet', 'Enable quiet mode (almost no logging)'
+      o.bool '--remove', 'Remove all found puzzles from the source code'
       o.bool '--skip-gitignore', 'Don\'t look into .gitignore for excludes'
       o.bool '--skip-errors', 'Suppress error as warning and skip badly
                       formatted puzzles'
@@ -89,31 +90,52 @@ https://github.com/cqfn/pdd/blob/master/README.md"
     body = File.read(cfg)
     extra = body.split(/\s+/).map(&:strip)
     opts['skip-gitignore'] = extra
-    puts "Found #{body.split(/\n/).length} lines in #{File.absolute_path(cfg)}"
+    PDD.log.info "Found #{body.split(/\n/).length} lines in #{File.absolute_path(cfg)}"
   end
 
   Encoding.default_external = Encoding::UTF_8
   Encoding.default_internal = Encoding::UTF_8
   file = opts.file? ? File.new(opts[:file], 'w') : $stdout
-  output = PDD::Base.new(opts).xml
+  xml = PDD::Base.new(opts).xml
+  output = xml
   if opts[:format]
     if opts[:format] == 'html'
       xslt = File.join(
         File.dirname(File.dirname(__FILE__)),
         'assets', 'puzzles.xsl'
       )
-      output = Nokogiri::XSLT(File.read(xslt)).transform(Nokogiri::XML(output))
+      output = Nokogiri::XSLT(File.read(xslt)).transform(Nokogiri::XML(xml))
     elsif opts[:format] != 'xml'
       raise 'Invalid format, use html or xml'
     end
   end
   file << output
+  if opts.remove?
+    home = opts[:source] || Dir.pwd
+    PDD.log.info "Removing puzzles from #{home}..."
+    files = {}
+    Nokogiri::XML(xml).xpath('/puzzles/puzzle').each do |p|
+      file = p.xpath('file/text()').to_s
+      files[file] = [] if files[file].nil?
+      files[file] << p.xpath('lines/text()').to_s.split('-').map(&:to_i)
+    end
+    files.each do |src, all|
+      f = File.join(home, src)
+      File.write(
+        f,
+        File.readlines(f).reject.each_with_index do |_t, i|
+          all.any? { |pair| i + 1 >= pair[0] && i + 1 <= pair[1] }
+        end.join
+      )
+      PDD.log.info "#{all.count} puzzles removed from #{src}"
+    end
+  end
 rescue SystemExit => e
   puts e.message unless e.success?
   PDD.log.info "Exit code is #{e.status}"
   exit(e.status)
 rescue PDD::Error => e
-  puts "#{Rainbow('ERROR').red}: #{e.message}
+  PDD.log.error "#{Rainbow('ERROR').red}: #{e.message}
 If you can't understand the cause of this issue or you don't know \
 how to fix it, please submit a GitHub issue, we will try to help you: \
 https://github.com/cqfn/pdd/issues. This tool is still in its beta \
@@ -122,7 +144,7 @@ more documentation: https://github.com/cqfn/pdd/blob/master/README.md."
   PDD.log.info 'Exit code is 1'
   exit(1)
 rescue StandardError => e
-  puts "#{Rainbow('ERROR').red} (#{e.class.name}): #{e.message}"
+  PDD.log.error "#{Rainbow('ERROR').red} (#{e.class.name}): #{e.message}"
   PDD.log.info 'Exit code is 255'
   exit(255)
 end

data/features/remove.feature

@@ -0,0 +1,15 @@
+Feature: Removing Puzzles
+  As a source code writer I want to be able to
+  remove PDD puzzles from source code
+
+  Scenario: Removing puzzles from code
+    Given I have a "a/test.txt" file with content:
+    """
+    Hello,
+    # @todo #42 Bye!
+    #  Bye!
+    The End.
+    """
+    When I run bin/pdd with "-v --remove -f /dev/null"
+    Then Exit code is zero
+    And Stdout contains "1 puzzles removed from a/test.txt"

data/features/step_definitions/steps.rb

@@ -79,6 +79,7 @@ When(%r{^I run bin/pdd with "([^"]*)"$}) do |arg|
 end
 
 Then(/^Stdout contains "([^"]*)"$/) do |txt|
+  raise 'STDOUT is empty!' if @stdout.empty?
   raise "STDOUT doesn't contain '#{txt}':\n#{@stdout}" unless @stdout.include?(txt)
 end
 

data/lib/pdd/version.rb

@@ -23,5 +23,5 @@
 # Copyright:: Copyright (c) 2014-2022 Yegor Bugayenko
 # License:: MIT
 module PDD
-  VERSION = '0.21.3'.freeze
+  VERSION = '0.22.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdd
 version: !ruby/object:Gem::Version
-  version: 0.21.3
+  version: 0.22.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-01 00:00:00.000000000 Z
+date: 2022-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -231,10 +231,10 @@ extra_rdoc_files:
 files:
 - ".0pdd.yml"
 - ".gitattributes"
-- ".github/ISSUE_TEMPLATE.md"
-- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/workflows/codecov.yml"
+- ".github/workflows/pdd.yml"
 - ".github/workflows/rake.yml"
+- ".github/workflows/xcop.yml"
 - ".gitignore"
 - ".overcommit.yml"
 - ".pdd"
@@ -258,6 +258,7 @@ files:
 - features/html_output.feature
 - features/parsing.feature
 - features/rake.feature
+- features/remove.feature
 - features/step_definitions/steps.rb
 - features/support/env.rb
 - features/unicode.feature

data/.github/ISSUE_TEMPLATE.md

@@ -1,12 +0,0 @@
-Make sure the title of the issue explains the problem you are having. Also, the description of the issue must clearly explain what is broken, not what you want us to implement. Go through this checklist and make sure you answer "YES" to all points:
-
-  - You have all pre-requisites listed in README.md installed
-  - You are sure that you are not reporting a duplicate (search all issues)
-  - You say "is broken" or "doesn't work" in the title
-  - You tell us what you are trying to do
-  - You explain the results you are getting
-  - You suggest an alternative result you would like to see
-
-This article will help you understand what we are looking for: http://www.yegor256.com/2014/11/24/principles-of-bug-tracking.html
-
-Thank you for your contribution!

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,11 +0,0 @@
-Many thanks for your contribution, we truly appreciate it. We will appreciate it even more, if you make sure that you can say "YES" to each point in this short checklist:
-
-  - You made a small amount of changes (less than 100 lines, less than 10 files)
-  - You made changes related to only one bug (create separate PRs for separate problems)
-  - You are ready to defend your changes (there will be a code review)
-  - You don't touch what you don't understand
-  - You ran the build locally and it passed
-
-This article will help you understand what we are looking for: http://www.yegor256.com/2015/02/09/serious-code-reviewer.html
-
-Thank you for your contribution!