pdd 0.20.7 → 0.21.1

data/pdd.gemspec

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2021 Yegor Bugayenko
+# Copyright (c) 2014-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,17 +20,18 @@
 
 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/pdd/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')
+    s.required_rubygems_version =
+      Gem::Requirement.new('>= 0')
   end
   s.rubygems_version = '2.3'
-  s.required_ruby_version = '>= 2.3'
+  s.required_ruby_version = '~> 2.3'
   s.name = 'pdd'
   s.version = PDD::VERSION
   s.license = 'MIT'
@@ -46,6 +47,7 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
   s.add_runtime_dependency 'nokogiri', '~> 1.10'
   s.add_runtime_dependency 'rainbow', '~> 3.0'
+  s.add_runtime_dependency 'ruby-filemagic', '~> 0.7.2'
   s.add_runtime_dependency 'slop', '~> 4.6'
   s.add_development_dependency 'aruba', '~> 0.14.1'
   s.add_development_dependency 'codecov', '0.2.12'
@@ -56,5 +58,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec-rails', '3.1.0'
   s.add_development_dependency 'rubocop', '0.52.1'
   s.add_development_dependency 'rubocop-rspec', '1.15.1'
+  s.add_development_dependency 'slop', '4.9.1'
   s.add_development_dependency 'xcop', '0.5.8'
 end

data/test/test__helper.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2021 Yegor Bugayenko
+# Copyright (c) 2014-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

data/test/test_duplicates.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2021 Yegor Bugayenko
+# Copyright (c) 2014-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
@@ -24,7 +24,7 @@ require_relative '../lib/pdd/rule/duplicates'
 
 # PDD::Rule::MaxDuplicates class test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2014-2021 Yegor Bugayenko
+# Copyright:: Copyright (c) 2014-2022 Yegor Bugayenko
 # License:: MIT
 class TestMaxDuplicates < Minitest::Test
   def test_max_duplicates

data/test/test_estimates.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2021 Yegor Bugayenko
+# Copyright (c) 2014-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
@@ -24,7 +24,7 @@ require_relative '../lib/pdd/rule/estimates'
 
 # PDD::Rule::Estimate module tests.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2014-2021 Yegor Bugayenko
+# Copyright:: Copyright (c) 2014-2022 Yegor Bugayenko
 # License:: MIT
 class TestEstimates < Minitest::Test
   def test_min

data/test/test_pdd.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2021 Yegor Bugayenko
+# Copyright (c) 2014-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
@@ -26,7 +26,7 @@ require_relative '../lib/pdd'
 
 # PDD main module test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2014-2021 Yegor Bugayenko
+# Copyright:: Copyright (c) 2014-2022 Yegor Bugayenko
 # License:: MIT
 class TestPDD < Minitest::Test
   def test_basic
@@ -75,6 +75,7 @@ class TestPDD < Minitest::Test
         git add -f .
         git commit --quiet -am 'first version'
       ")
+
       matches(
         Nokogiri::XML(PDD::Base.new(opts).xml),
         [

data/test/test_rake_task.rb

@@ -5,11 +5,14 @@ require_relative '../lib/pdd/rake_task'
 
 # Test for RakeTask
 class TestRakeTask < Minitest::Test
-  def test_base
-    PDD::RakeTask.new(:pdd1)
-    error = assert_raises SystemExit do
+  def test_basic
+    Dir.mktmpdir 'test' do |dir|
+      file = File.join(dir, 'a.txt')
+      File.write(file, "\x40todo #55 hello!")
+      PDD::RakeTask.new(:pdd1) do |task|
+        task.quiet = true
+      end
       Rake::Task['pdd1'].invoke
     end
-    assert_equal('NOT IMPLEMENTED', error.message)
   end
 end

data/test/test_roles.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2021 Yegor Bugayenko
+# Copyright (c) 2014-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
@@ -24,7 +24,7 @@ require_relative '../lib/pdd/rule/roles'
 
 # PDD::Rule::Role module tests.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2014-2021 Yegor Bugayenko
+# Copyright:: Copyright (c) 2014-2022 Yegor Bugayenko
 # License:: MIT
 class TestRoles < Minitest::Test
   def test_incorrect_role

data/test/test_source.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2021 Yegor Bugayenko
+# Copyright (c) 2014-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,7 +25,7 @@ require_relative '../lib/pdd/sources'
 
 # Source test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2014-2021 Yegor Bugayenko
+# Copyright:: Copyright (c) 2014-2022 Yegor Bugayenko
 # License:: MIT
 class TestSource < Minitest::Test
   def test_parsing
@@ -46,8 +46,9 @@ class TestSource < Minitest::Test
         list = source.puzzles
         assert_equal 2, list.size
         puzzle = list.first
-        assert_equal '2-3', puzzle.props[:lines]
-        assert_equal 'привет, how are you doing?', puzzle.props[:body]
+        assert_equal '2-4', puzzle.props[:lines]
+        assert_equal 'привет, how are you doing? -something else', \
+                     puzzle.props[:body]
         assert_equal '44', puzzle.props[:ticket]
         assert puzzle.props[:author].nil?
         assert puzzle.props[:email].nil?
@@ -78,20 +79,52 @@ class TestSource < Minitest::Test
     end
   end
 
-  def test_failing_on_invalid_puzzle
+  def test_no_prefix_multiline_puzzle_block
     Dir.mktmpdir 'test' do |dir|
       file = File.join(dir, 'a.txt')
       File.write(
         file,
         "
-        * \x40todo #44 this is an incorrectly formatted puzzle,
-        * with a second line without a leading space
+        <!--
+        \x40todo #01:30min correctly formatted multi-line puzzle, with no
+          comment prefix before todo marker
+        -->
         "
       )
-      error = assert_raises PDD::Error do
-        stub_source_find_github_user(file, 'hey', &:puzzles)
+      stub_source_find_github_user(file, 'hey') do |source|
+        PDD.opts = nil
+        assert_equal 1, source.puzzles.size
+        puzzle = source.puzzles.last
+        assert_equal '3-4', puzzle.props[:lines]
+        assert_equal 'correctly formatted multi-line puzzle, with no ' \
+                     'comment prefix before todo marker', puzzle.props[:body]
+        assert_equal '01', puzzle.props[:ticket]
+      end
+    end
+  end
+
+  def test_multiple_puzzles_single_comment_block
+    Dir.mktmpdir 'test' do |dir|
+      file = File.join(dir, 'a.txt')
+      File.write(
+        file,
+        "
+        /*
+         * \x40todo #1 First one with
+         * a few lines
+         * \x40todo #1 Second one also
+         * with a few lines
+         */
+        "
+      )
+      stub_source_find_github_user(file, 'hey') do |source|
+        PDD.opts = nil
+        assert_equal 2, source.puzzles.size
+        puzzle = source.puzzles.last
+        assert_equal '5-6', puzzle.props[:lines]
+        assert_equal 'Second one also with a few lines', puzzle.props[:body]
+        assert_equal '1', puzzle.props[:ticket]
       end
-      assert !error.message.index('Space expected').nil?
     end
   end
 
@@ -101,10 +134,10 @@ class TestSource < Minitest::Test
       File.write(
         file,
         "
-        * \x40todo #44 this is an incorrectly formatted puzzle,
+        * \x40todo #44 this is a correctly formatted puzzle,
         * with a second line without a leading space
         Another badly formatted puzzle
-        * \x40todo this puzzle misses ticket name/number
+        * \x40todo this bad puzzle misses ticket name/number
         Something else
         * \x40todo #123 This puzzle is correctly formatted
         "
@@ -113,15 +146,35 @@ class TestSource < Minitest::Test
       stub_source_find_github_user(file, 'hey') do |source|
         list = source.puzzles
         PDD.opts = nil
-        assert_equal 1, list.size
+        assert_equal 2, list.size
         puzzle = list.first
-        assert_equal '7-7', puzzle.props[:lines]
-        assert_equal 'This puzzle is correctly formatted', puzzle.props[:body]
-        assert_equal '123', puzzle.props[:ticket]
+        assert_equal '2-3', puzzle.props[:lines]
+        assert_equal 'this is a correctly formatted puzzle, with a second ' \
+                     'line without a leading space', puzzle.props[:body]
+        assert_equal '44', puzzle.props[:ticket]
       end
     end
   end
 
+  def test_succeed_utf8_encoded_body
+    Dir.mktmpdir 'test' do |dir|
+      file = File.join(dir, 'a.txt')
+      File.write(
+        file,
+        "
+        * \x40todo #44 Привет, мир, мне кофе
+        *  вторая линия
+        "
+      )
+      list = PDD::VerboseSource.new(file, PDD::Source.new(file, 'hey')).puzzles
+      assert_equal 1, list.size
+      puzzle = list.first
+      assert_equal '2-3', puzzle.props[:lines]
+      assert_equal 'Привет, мир, мне кофе вторая линия', puzzle.props[:body]
+      assert_equal '44', puzzle.props[:ticket]
+    end
+  end
+
   def test_failing_on_incomplete_puzzle
     Dir.mktmpdir 't5' do |dir|
       file = File.join(dir, 'ff.txt')
@@ -141,7 +194,7 @@ class TestSource < Minitest::Test
   def test_failing_on_broken_unicode
     Dir.mktmpdir 'test' do |dir|
       file = File.join(dir, 'xx.txt')
-      File.write(file, ' * \x40todo #44 this is a broken unicode: ' + 0x92.chr)
+      File.write(file, " * \\x40todo #44 this is a broken unicode: #{0x92.chr}")
       assert_raises PDD::Error do
         stub_source_find_github_user(file, 'xx', &:puzzles)
       end
@@ -209,6 +262,7 @@ class TestSource < Minitest::Test
         git add a.txt
         git commit --quiet -am 'first version'
       ")
+
       stub_source_find_github_user(File.join(dir, 'a.txt')) do |source|
         list = source.puzzles
         assert_equal 1, list.size
@@ -237,6 +291,7 @@ class TestSource < Minitest::Test
         git add a.txt
         git commit --quiet -am 'first version'
       ")
+
       stub_source_find_github_user(File.join(dir, 'a.txt')) do |source|
         list = source.puzzles
         assert_equal 1, list.size
@@ -264,6 +319,7 @@ class TestSource < Minitest::Test
         git add a.txt
         git commit --quiet -am 'first version'
       ")
+
       stub_source_find_github_user(File.join(dir, 'a.txt')) do |source|
         list = source.puzzles
         assert_equal 1, list.size
@@ -286,6 +342,7 @@ class TestSource < Minitest::Test
         git commit --quiet -am 'first version'
         echo '\x40todo #1 this is a puzzle uncommitted' > a.txt
       ")
+
       stub_source_find_github_user(File.join(dir, 'a.txt')) do |source|
         list = source.puzzles
         assert_equal 1, list.size

data/test/test_source_todo.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2021 Yegor Bugayenko
+# Copyright (c) 2014-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
@@ -53,7 +53,7 @@ class TestSourceTodo < Minitest::Test
   def test_todo_parsing
     check_valid_puzzle(
       "
-      // TODO #45 task description
+      // @todo #45 task description
       ",
       '2-2',
       'task description',
@@ -64,7 +64,7 @@ class TestSourceTodo < Minitest::Test
   def test_todo_parsing_multi_line
     check_valid_puzzle(
       "
-      // TODO #45 task description
+      // @todo #45 task description
       //  second line
       ",
       '2-3',
@@ -73,6 +73,18 @@ class TestSourceTodo < Minitest::Test
     )
   end
 
+  def test_todo_utf8_encoded_body
+    check_valid_puzzle(
+      "
+      // TODO #45 Привет, мир, мне кофе
+      //  вторая линия
+      ",
+      '2-3',
+      'Привет, мир, мне кофе вторая линия',
+      '45'
+    )
+  end
+
   def test_todo_colon_parsing
     check_valid_puzzle(
       "
@@ -109,24 +121,6 @@ class TestSourceTodo < Minitest::Test
     )
   end
 
-  def test_todo_failing_no_space_on_second_line
-    check_invalid_puzzle(
-      "
-      * TODO #45 this puzzle
-      * has not space on second line",
-      'Space expected'
-    )
-  end
-
-  def test_todo_colon_failing_no_space_on_second_line
-    check_invalid_puzzle(
-      "
-      * TODO: #45 this puzzle
-      * has not space on second line",
-      'Space expected'
-    )
-  end
-
   def test_todo_failing_no_ticket
     check_invalid_puzzle(
       "

data/test/test_sources.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2021 Yegor Bugayenko
+# Copyright (c) 2014-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
@@ -26,7 +26,7 @@ require_relative '../lib/pdd/sources'
 
 # Sources test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2014-2021 Yegor Bugayenko
+# Copyright:: Copyright (c) 2014-2022 Yegor Bugayenko
 # License:: MIT
 class TestSources < Minitest::Test
   def test_iterator
@@ -37,7 +37,6 @@ class TestSources < Minitest::Test
   end
 
   def test_ignores_binary_files
-    skip if Gem.win_platform?
     in_temp([]) do |dir|
       [
         'README.md',
@@ -92,14 +91,16 @@ class TestSources < Minitest::Test
   def test_includes_by_pattern
     in_temp(['a/first.txt', 'b/c/d/second.txt']) do |dir|
       list = PDD::Sources.new(dir).include('b/c/d/second.txt').fetch
-      assert_equal 1, list.size
+      assert_equal 2, list.size
     end
   end
 
   def test_includes_recursively
     in_temp(['a/first.txt', 'b/c/second.txt', 'b/c/d/third.txt']) do |dir|
-      list = PDD::Sources.new(dir).include('**/*').fetch
-      assert_equal 0, list.size
+      sources = PDD::Sources.new(dir).exclude('b/c/**')
+      sources.include('b/c/d/third.txt')
+      list = sources.fetch
+      assert_equal 2, list.size
     end
   end
 

data/test/test_text.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2021 Yegor Bugayenko
+# Copyright (c) 2014-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
@@ -24,7 +24,7 @@ require_relative '../lib/pdd/rule/text'
 
 # PDD::Rule::Text module tests.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2014-2021 Yegor Bugayenko
+# Copyright:: Copyright (c) 2014-2022 Yegor Bugayenko
 # License:: MIT
 class TestText < Minitest::Test
   def test_min_words

data/utils/glob.rb

@@ -0,0 +1,65 @@
+# Copyright (c) 2014-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.
+
+# Utility glob class
+class Glob
+  NO_LEADING_DOT = '(?=[^\.])'.freeze
+
+  def initialize(glob_string)
+    @glob_string = glob_string
+  end
+
+  # rubocop:disable Metrics/CyclomaticComplexity
+  def to_regexp
+    chars = @glob_string.gsub(%r{(\*\*\/\*)|(\*\*)}, '*').split('')
+    in_curlies = 0, escaping = false
+    chars.map do |char|
+      if escaping
+        escaping = false
+        return char
+      end
+      case char
+      when '*'
+        '.*'
+      when '?'
+        '.'
+      when '.'
+        '\\.'
+      when '{'
+        in_curlies += 1
+        '('
+      when '}'
+        if in_curlies.positive?
+          in_curlies -= 1
+          return ')'
+        end
+        return char
+      when ','
+        in_curlies.positive? ? '|' : char
+      when '\\'
+        escaping = true
+        '\\'
+      else
+        char
+      end
+    end.join
+  end
+  # rubocop:enable Metrics/CyclomaticComplexity
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdd
 version: !ruby/object:Gem::Version
-  version: 0.20.7
+  version: 0.21.1
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-24 00:00:00.000000000 Z
+date: 2022-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-filemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +192,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.15.1
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.9.1
 - !ruby/object:Gem::Dependency
   name: xcop
   requirement: !ruby/object:Gem::Requirement
@@ -205,17 +233,19 @@ files:
 - ".gitattributes"
 - ".github/ISSUE_TEMPLATE.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/codecov.yml"
+- ".github/workflows/rake.yml"
 - ".gitignore"
+- ".overcommit.yml"
 - ".pdd"
 - ".rubocop.yml"
 - ".rultor.yml"
 - ".simplecov"
-- ".travis.yml"
+- CITATION.cff
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- appveyor.yml
 - assets/puzzles.xsd
 - assets/puzzles.xsl
 - bin/pdd
@@ -258,6 +288,7 @@ files:
 - test_assets/cambria.woff
 - test_assets/elegant-objects.png
 - test_assets/favicon.ico
+- utils/glob.rb
 homepage: http://github.com/cqfn/pdd
 licenses:
 - MIT
@@ -269,7 +300,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement

data/.travis.yml

@@ -1,13 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.0
-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 -> pdd.gemspec
-  - C:\Ruby200\lib\ruby\gems\2.0.0 -> pdd.gemspec