pdd 0.20.8 → 0.21.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3ff37e6f0ac2629e0b31888df2b56f7024512b04b07bd58c29a0525186a40f0
-  data.tar.gz: 61076844123f2eda0b32734b2c917ed6eb033956177197626219bda878add5b5
+  metadata.gz: c76649118dbe4b4884f07d453b611ca05da5845e753357fcb98cd0e6e8324b64
+  data.tar.gz: 4b85d7b84b62f8d695d2e8b95a92bc03cb87d5e6acbef283723ac353a43c42cd
 SHA512:
-  metadata.gz: e9b46c3238588062c781b1b3705cf343d1ca0e70481b2546ffc407b9a5be6534d45b3c8d0d4ebaab0ac39630ebfc6652feb8c69a8dd8d787bf33eae1a9cb0935
-  data.tar.gz: 790b7d73f1b7ea5d2666864b238dfdde211572186d3d84c29a6d6448936b54ef87a567473b83fccfad83ec945ad6f9677a739b0730fde5199618dc79f6cc9ead
+  metadata.gz: 1a54147d056c4593c20142e9c45497308bc57c0ec34a63e84fc0f025e1722ed406102f9383196cec51a084baffe17d2de4174060c93173328605089410a48dff
+  data.tar.gz: 4270c5b9ec6e8b63ca371b2c6c5905b13394d5078943f1c66b8c8ec9ccc30ae25026efd375f3fd2d5bd8c2a1fd29080c86755935d5c91bc6d47baceda89e6edd

data/.github/workflows/codecov.yml

@@ -0,0 +1,20 @@
+---
+name: codecov
+on:
+  push:
+    branches:
+      - master
+jobs:
+  codecov:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - run: bundle update
+      - run: bundle exec rake
+      - uses: codecov/codecov-action@v1
+        with:
+          file: coverage/.resultset.json
+          fail_ci_if_error: true

data/.github/workflows/rake.yml

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

data/.pdd

@@ -1,8 +1,5 @@
 --source=.
 --verbose
---skip-errors
---skip-gitignore
---include lib/pdd/sources.rb
 --exclude .idea/**/*
 --exclude .bundle/**/*
 --exclude target/**/*
@@ -25,3 +22,4 @@
 --rule min-words:20
 --rule min-estimate:15
 --rule max-estimate:90
+

data/.rubocop.yml

@@ -1,15 +1,17 @@
 AllCops:
   Exclude:
-    - 'assets/**/*'
+    - "assets/**/*"
   DisplayCopNames: true
   TargetRubyVersion: 2.3
 
 Layout/EndOfLine:
   EnforcedStyle: lf
 Metrics/ClassLength:
-  Max: 300
+  Max: 360
+Metrics/LineLength:
+  Max: 90
 Metrics/MethodLength:
-  Max: 30
+  Max: 35
 Metrics/AbcSize:
   Max: 40
 Style/MultilineBlockChain:

data/.rultor.yml

@@ -1,32 +1,25 @@
+docker:
+  image: yegor256/rultor-image:1.9.0
 assets:
   rubygems.yml: yegor256/home#assets/rubygems.yml
-  s3cfg: yegor256/home#assets/s3cfg
 install: |
-  export GEM_HOME=~/.ruby
-  export GEM_PATH=$GEM_HOME:$GEM_PATH
-  sudo gem install pdd -v 0.20.5
-  sudo gem install xcop -v 0.6
-  bundle install
+  pdd -f /dev/null
+  sudo bundle install --no-color "--gemfile=$(pwd)/Gemfile"
 release:
   script: |-
-    pdd -f /dev/null
-    LC_ALL=US-ASCII bundle exec rake
+    [[ "${tag}" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]] || exit -1
+    bundle exec rake
     rm -rf *.gem
-    sed -i "s/1\.0\.snapshot/${tag}/g" lib/pdd/version.rb
+    sed -i "s/0\.0\.0/${tag}/g" lib/pdd/version.rb
     git add lib/pdd/version.rb
     git commit -m "version set to ${tag}"
     gem build pdd.gemspec
     chmod 0600 ../rubygems.yml
     gem push *.gem --config-file ../rubygems.yml
-    pdd --source=$(pwd) --verbose --file=pdd.xml -e=test/** -e=features/** -e=coverage/**/* -e=README.md
-    s3cmd --no-progress put pdd.xml --config=../s3cfg s3://pdd.teamed.io/pdd.xml
-    s3cmd --no-progress put assets/puzzles.xsd --acl-public --config=../s3cfg s3://pdd-xsd.teamed.io/${tag}.xsd
-    s3cmd --no-progress put assets/puzzles.xsl --acl-public --config=../s3cfg s3://pdd-xsl.teamed.io/${tag}.xsl
 merge:
   script: |-
-    pdd -f /dev/null
     LC_ALL=US-ASCII bundle exec rake
 deploy:
   script: |-
-    echo 'Nothing to deploy'
+    echo "There is nothing to deploy"
     exit -1

data/.simplecov

@@ -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

data/CITATION.cff

@@ -0,0 +1,25 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Bugayenko"
+  given-names: "Yegor"
+  orcid: "https://orcid.org/0000-0001-6370-0678"
+- family-names: "Bakare"
+  given-names: "Ayomide"
+- family-names: "Cheverda"
+  given-names: "Arina"
+- family-names: "Farina"
+  given-names: "Mirko"
+- family-names: "Kruglov"
+  given-names: "Artem"
+- family-names: "Plaksin"
+  given-names: "Yaroslav"
+- family-names: "Succi"
+  given-names: "Giancarlo"
+- family-names: "Pedrycz"
+  given-names: "Witold"
+title: "Automatically Prioritizing and Assigning Tasks from Code Repositories in Puzzle Driven Development"
+version: 0.21.0
+doi: 10.1145/3524842.3528512
+date-released: 2022-05-09
+url: "https://github.com/cqfn/pdd"

data/Gemfile

@@ -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

data/LICENSE.txt

@@ -1,6 +1,6 @@
 (The MIT License)
 
-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

data/README.md

@@ -1,16 +1,12 @@
-<img src="https://avatars2.githubusercontent.com/u/24456188" width="64px" height="64px"/>
-
-[![Donate via Zerocracy](https://www.0crat.com/contrib-badge/C3T46CUJJ.svg)](https://www.0crat.com/contrib/C3T46CUJJ)
+<img alt="pdd logo" src="https://avatars2.githubusercontent.com/u/24456188" width="92px" height="92px"/>
 
 [![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)
-[![Managed by Zerocracy](https://www.0crat.com/badge/C3T46CUJJ.svg)](https://www.0crat.com/p/C3T46CUJJ)
 [![DevOps By Rultor.com](http://www.rultor.com/b/cqfn/pdd)](http://www.rultor.com/p/cqfn/pdd)
 [![We recommend RubyMine](https://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)
 
-[![Build Status](https://travis-ci.org/cqfn/pdd.svg)](https://travis-ci.org/cqfn/pdd)
-[![Build status](https://ci.appveyor.com/api/projects/status/b59sdhuu0gcku15b?svg=true)](https://ci.appveyor.com/project/cqfn/pdd)
 [![PDD status](http://www.0pdd.com/svg?name=cqfn/pdd)](http://www.0pdd.com/p?name=cqfn/pdd)
-[![Test Coverage](https://img.shields.io/codecov/c/github/cqfn/pdd.svg)](https://codecov.io/github/cqfn/pdd?branch=master)
+[![codecov](https://codecov.io/gh/cqfn/pdd/branch/master/graph/badge.svg)](https://codecov.io/gh/cqfn/pdd)
+![Lines of code](https://img.shields.io/tokei/lines/github/cqfn/pdd)
 [![Hits-of-Code](https://hitsofcode.com/github/cqfn/pdd)](https://hitsofcode.com/view/github/cqfn/pdd)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/cqfn/pdd/blob/master/LICENSE.txt)
 
@@ -29,7 +25,8 @@ Read
 [_PDD in Action_](http://www.yegor256.com/2017/04/05/pdd-in-action.html)
 and watch [this webinar](https://www.youtube.com/watch?v=nsYGC2aUwfQ).
 
-Install it first:
+You should have [Ruby installed](https://www.ruby-lang.org/en/documentation/installation/).
+Then, install our gem:
 
 ```bash
 $ gem install pdd
@@ -41,29 +38,34 @@ Run it locally and read its output:
 $ pdd --help
 ```
 
-### File and Directory Selection
 You can exclude & include certain number of files from the search via these options:
 
-`` --exclude=glob ``
+```
+$ pdd --exclude=glob
+```
 
 You can skip any file(s) with a name suffix that matches the pattern glob, using wildcard matching; 
 a name suffix is either the whole path and name, or reg expr, for example:
 
 ```bash
-pdd --exclude=src/**/*.java --exclude=target/**/*
-pdd --exclude=src/**/*.java # exclude .java files in src/
-pdd --exclude=src/**/* # exclude all files in src/
+$ pdd --exclude=src/**/*.java --exclude=target/**/*
+$ pdd --exclude=src/**/*.java # exclude .java files in src/
+$ pdd --exclude=src/**/* # exclude all files in src/
 ```
 
-`` --include=glob ``
+You can include too:
+
+```
+$ pdd --include=glob
+```
 
 Search only files whose name matches glob, using wildcard matching as described under ``--exclude``. 
 If contradictory ``--include`` and ``--exclude`` options are given, the last matching one wins. 
 If no ``--include`` or ``--exclude`` options are given, all files from working directory are included, example:
-аомтрптм
+
 ```bash
-pdd --include=src/**/*.py # include only .py files in src/
-pdd --include=src/**/* # include all files in src/
+$ pdd --include=src/**/*.py # include only .py files in src/
+$ pdd --include=src/**/* # include all files in src/
 ```
 
 ## How to Format?
@@ -78,8 +80,9 @@ to the leading space in every consecutive line):
 [related code]
 ```
 
-\[\] - Replace with apropriate data (see text enclosed in brackets)
-<> - Omitable (enclosed data can be left out)
+`[]` - Replace with apropriate data (see text enclosed in brackets)
+
+`<>` - Omitable (enclosed data can be left out)
 
 Example:
 
@@ -101,6 +104,9 @@ The specified markers will be included in the issues body
 along with some predefined text. If your comment is longer
 than 40 characters, it will be truncated in the title.
 
+Note: if you create several puzzle duplicates (same text after puzzle keyword),
+pdd will fail to parse puzzles and produce an error with duplicates list.
+
 There are 3 supported keywords, one of which must precede the mandatory
 puzzle marker. They are `@todo`, `TODO` and `TODO:`.
 
@@ -212,7 +218,7 @@ your pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2
 [Bundler](https://bundler.io/) installed. Then:
 
 ```
-$ bundle install --path .bundle
+$ bundle install
 $ bundle exec rake
 ```
 

data/Rakefile

@@ -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

data/assets/puzzles.xsd

@@ -2,7 +2,7 @@
 <!--
 (The MIT License)
 
-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

data/assets/puzzles.xsl

@@ -2,7 +2,7 @@
 <!--
 (The MIT License)
 
-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

data/bin/pdd

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# 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
@@ -31,6 +31,8 @@ require_relative '../lib/pdd'
 require_relative '../lib/pdd/version'
 require_relative '../lib/pdd/source'
 
+Rainbow.enabled = ENV['PDD_ENV'] == 'development'
+
 begin
   args = []
   if File.exist?('.pdd')

data/features/catches_broken_puzzles.feature

@@ -11,30 +11,12 @@ Feature: Catches Broken Puzzles
        * Some other documentation
        * text that is not relevant to
        * the puzzle below.
-       * @todo #13 This puzzle has an incorrect format
-       * because it doesn't start with a space on
-       * the second and the third lines
+       * @todo This puzzle has an incorrect format
+       * because it doesn't have a ticket number
        */
       public void main(String[] args) {
         // later
       }
     }
     """
-    When I run pdd it fails with "Space expected"
     When I run pdd it fails with "Sample.java:6"
-
-  Scenario: Throwing exception on yet another broken puzzle
-    Given I have a "Sample.java" file with content:
-    """
-    public class Main {
-      //
-      // @todo #13 This puzzle has an incorrect format
-      // because there is no space character in the
-      // second and third lines
-      //
-      public void main(String[] args) {
-        // later
-      }
-    }
-    """
-    When I run pdd it fails with "Space expected"

data/features/cli.feature

@@ -43,8 +43,8 @@ Feature: Command Line Processing
     """
     ~~
     ~~ @todo #44 First
-    ~~  and second
-    ~~
+    ~~  and
+    ~~ second
     """
     When I run bin/pdd with "> out.xml"
     Then Exit code is zero

data/features/parsing.feature

@@ -25,6 +25,32 @@ Feature: Parsing
     And XML matches "//puzzle[role='DEV']"
     And XML matches "//puzzle[estimate='0']"
 
+  Scenario: Simple puzzle within comment block
+    Given I have a "test/a/b/Sample.java" file with content:
+    """
+    public class Main {
+      /**
+       * Some other documentation
+       * text that is not relevant to
+       * the puzzle below.
+       * @todo #13 This puzzle has a correct format
+       * It doesn't start with a space on
+       * the second and the third lines
+       */
+      public void main(String[] args) {
+        // later
+      }
+    }
+    """
+    When I run pdd
+    Then XML matches "/puzzles[count(puzzle)=1]"
+    And XML matches "//puzzle[file='test/a/b/Sample.java']"
+    And XML matches "//puzzle[ticket='13']"
+    And XML matches "//puzzle[lines='6-8']"
+    And XML matches "//puzzle[starts-with(body,'This')]"
+    And XML matches "//puzzle[role='DEV']"
+    And XML matches "//puzzle[estimate='0']"
+
   Scenario: Multiple puzzles in one file
     Given I have a "test/a/b/c/Sample.java" file with content:
     """
@@ -34,6 +60,9 @@ Feature: Parsing
        * @todo #ABC-67:15min And this one ever later
        * @todo #F-78-3:2h/DEV This is for a developer
        *  who will join us later
+       * @todo #44 This puzzle has a correct format
+       * even though it doesn't start with a space on
+       * the second and the third lines
        */
       public void main(String[] args) {
         // later
@@ -41,10 +70,11 @@ Feature: Parsing
     }
     """
     When I run pdd
-    Then XML matches "/puzzles[count(puzzle)=3]"
+    Then XML matches "/puzzles[count(puzzle)=4]"
     And XML matches "//puzzle[ticket='13' and lines='3-3']"
     And XML matches "//puzzle[ticket='13' and body='This one later']"
     And XML matches "//puzzle[ticket='ABC-67' and lines='4-4']"
     And XML matches "//puzzle[ticket='F-78-3' and lines='5-6']"
     And XML matches "//puzzle[ticket='ABC-67' and estimate='15']"
     And XML matches "//puzzle[ticket='F-78-3' and estimate='120']"
+    And XML matches "//puzzle[ticket='44' and lines='7-9']"

data/features/step_definitions/steps.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
@@ -79,9 +79,7 @@ When(%r{^I run bin/pdd 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
@@ -93,9 +91,7 @@ Then(/^XML file "([^"]+)" matches "([^"]+)"$/) do |file, xpath|
 
   xml = Nokogiri::XML.parse(File.read(file))
   xml.remove_namespaces!
-  if xml.xpath(xpath).empty?
-    raise "XML file #{file} doesn't match \"#{xpath}\":\n#{xml}"
-  end
+  raise "XML file #{file} doesn't match \"#{xpath}\":\n#{xml}" if xml.xpath(xpath).empty?
 end
 
 Then(/^Exit code is zero$/) do

data/features/support/env.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

data/lib/pdd/puzzle.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

data/lib/pdd/rake_task.rb

@@ -22,18 +22,8 @@ module PDD
       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
-
-    def run
-      # @todo #125:30m need to implement this method.
-      #  For now, it's just a task,
-      #  that prints a simple Running pdd... message to user
-      puts 'Running pdd...' unless @quiet
-    end
   end
 end

data/lib/pdd/rule/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

data/lib/pdd/rule/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

data/lib/pdd/rule/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

data/lib/pdd/rule/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

data/lib/pdd/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
@@ -37,10 +37,31 @@ module PDD
       @path = path
     end
 
-    def match_markers(line)
-      MARKERS.map do |mkr|
-        %r{(.*(?:^|\s))#{mkr}\s+#([\w\-.:/]+)\s+(.+)}.match(line)
-      end.compact
+    def match_markers(l)
+      if l.downcase.include? 'todo'
+        /[^\s]\x40todo/.match(l) do |_|
+          raise Error, get_no_leading_space_error("\x40todo")
+        end
+        /\x40todo(?!\s+#)/.match(l) do |_|
+          raise Error, get_no_puzzle_marker_error("\x40todo")
+        end
+        /\x40todo\s+#\s/.match(l) do |_|
+          raise Error, get_space_after_hash_error("\x40todo")
+        end
+        /[^\s]TODO:?/.match(l) do |_|
+          raise Error, get_no_leading_space_error('TODO')
+        end
+        /TODO(?!:?\s+#)/.match(l) do |_|
+          raise Error, get_no_puzzle_marker_error('TODO')
+        end
+        /TODO:?\s+#\s/.match(l) do |_|
+          raise Error, get_space_after_hash_error('TODO')
+        end
+        a = [%r{(.*(?:^|\s))(?:\x40todo|TODO:|TODO)\s+#([\w\-.:/]+)\s+(.+)}.match(l)]
+        a.compact
+      else
+        []
+      end
     end
 
     # Fetch all puzzles.
@@ -50,7 +71,6 @@ module PDD
       lines = File.readlines(@file, encoding: 'UTF-8')
       lines.each_with_index do |line, idx|
         begin
-          check_rules(line)
           match_markers(line).each do |m|
             puzzles << puzzle(lines.drop(idx + 1), m, idx)
           end
@@ -82,30 +102,10 @@ after the hash sign, it should not be there, \
 see https://github.com/cqfn/pdd#how-to-format"
     end
 
-    def check_rules(line)
-      /[^\s]\x40todo/.match(line) do |_|
-        raise Error, get_no_leading_space_error("\x40todo")
-      end
-      /\x40todo(?!\s+#)/.match(line) do |_|
-        raise Error, get_no_puzzle_marker_error("\x40todo")
-      end
-      /\x40todo\s+#\s/.match(line) do |_|
-        raise Error, get_space_after_hash_error("\x40todo")
-      end
-      /[^\s]TODO:?/.match(line) do |_|
-        raise Error, get_no_leading_space_error('TODO')
-      end
-      /TODO(?!:?\s+#)/.match(line) do |_|
-        raise Error, get_no_puzzle_marker_error('TODO')
-      end
-      /TODO:?\s+#\s/.match(line) do |_|
-        raise Error, get_space_after_hash_error('TODO')
-      end
-    end
-
     # Fetch puzzle
     def puzzle(lines, match, idx)
-      tail = tail(lines, match[1], idx)
+      col_idx = match[0].length - match[0].lstrip.length
+      tail = tail(lines, match[1], col_idx)
       body = "#{match[3]} #{tail.join(' ')}".gsub(/\s+/, ' ').strip
       body = body.chomp('*/-->').strip
       marker = marker(match[2])
@@ -141,20 +141,30 @@ against the rules explained here: https://github.com/cqfn/pdd#how-to-format"
       min
     end
 
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # @todo #209:30min temporarily disabled cyclomatic complexity for the method.
+    #  below. Please fix soon.
+    #
     # Fetch puzzle tail (all lines after the first one)
     def tail(lines, prefix, start)
+      prefix = prefix.rstrip
+      prefix = " #{' ' * start}" if prefix.empty? # fallback to space indentation
+      line = lines[0][prefix.length + 1, lines[0].length] if lines[0]
+      is_indented = line&.start_with?(' ')
       lines
         .take_while { |t| match_markers(t).none? && t.start_with?(prefix) }
+        .take_while do |t|
+          !is_indented || t[prefix.length + 1, t.length].start_with?(' ')
+        end
+        .take_while do |t|
+          # account for carriage return in line endings
+          t_len = t.length - 1
+          t_len <= prefix.length || t_len > prefix.length + 2
+        end
         .map { |t| t[prefix.length, t.length] }
-        .take_while { |t| t =~ /^[ a-zA-Z0-9]/ }
-        .each_with_index do |t, i|
-        next if t.start_with?(' ')
-
-        raise Error, "Space expected at #{start + i + 2}:#{prefix.length}; \
-make sure all lines in the puzzle body have a single leading space."
-      end
-        .map { |t| t[1, t.length] }
+        .map { |t| t.start_with?(' ') ? t[1, t.length] : t }
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
 
     # @todo #75:30min Let's make it possible to fetch Subversion data
     #  in a similar way as we are doing with Git. We should also just

data/lib/pdd/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
@@ -19,8 +19,8 @@
 # SOFTWARE.
 
 require 'rainbow'
-require 'shellwords'
 require 'English'
+require 'filemagic'
 require_relative 'source'
 require_relative '../../utils/glob'
 
@@ -77,20 +77,20 @@ module PDD
 
     private
 
-    # @todo #98:30min Change the implementation of this method
-    #  to also work in Windows machines. Investigate the possibility
-    #  of use a gem for this. After that, remove the skip of the test
-    #  `test_ignores_binary_files` in `test_sources.rb`.
     def binary?(file)
-      return false if Gem.win_platform?
-
-      `grep -qI '.' #{Shellwords.escape(file)}`
-      if $CHILD_STATUS.success?
+      if text_file?(file)
         false
       else
         PDD.log.info "#{file} is a binary file (#{File.size(file)} bytes)"
         true
       end
     end
+
+    def text_file?(file)
+      fm = FileMagic.new(FileMagic::MAGIC_MIME)
+      fm.file(file) =~ %r{^text/}
+    ensure
+      fm.close
+    end
   end
 end

data/lib/pdd/version.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
@@ -20,8 +20,8 @@
 
 # PDD main module.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2014-2021 Yegor Bugayenko
+# Copyright:: Copyright (c) 2014-2022 Yegor Bugayenko
 # License:: MIT
 module PDD
-  VERSION = '0.20.8'.freeze
+  VERSION = '0.21.2'.freeze
 end

data/lib/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
@@ -30,7 +30,7 @@ require_relative 'pdd/rule/roles'
 
 # PDD main module.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2014-2021 Yegor Bugayenko
+# Copyright:: Copyright (c) 2014-2022 Yegor Bugayenko
 # License:: MIT
 module PDD
   # If it breaks.

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
@@ -47,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'

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

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

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
@@ -22,10 +22,11 @@ require 'minitest/autorun'
 require 'tmpdir'
 require_relative '../lib/pdd'
 require_relative '../lib/pdd/sources'
+require_relative 'test__helper'
 
 # 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
@@ -47,7 +48,8 @@ class TestSource < Minitest::Test
         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 'привет, how are you doing?', \
+                     puzzle.props[:body]
         assert_equal '44', puzzle.props[:ticket]
         assert puzzle.props[:author].nil?
         assert puzzle.props[:email].nil?
@@ -78,20 +80,74 @@ 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_space_indented_multiline_puzzle_block
+    Dir.mktmpdir 'test' do |dir|
+      file = File.join(dir, 'a.txt')
+      File.write(
+        file,
+        "
+         # \x40todo #99:30min hello
+         #  good bye
+         # hello again
+        "
+      )
+      stub_source_find_github_user(file, 'hey') do |source|
+        PDD.opts = nil
+        assert_equal 1, source.puzzles.size
+        puzzle = source.puzzles.last
+        assert_equal '2-3', puzzle.props[:lines]
+        assert_equal 'hello good bye', puzzle.props[:body]
+        assert_equal '99', 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 +157,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,11 +169,12 @@ 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

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',
@@ -121,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',

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

@@ -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
@@ -27,7 +27,6 @@ class Glob
   end
 
   # rubocop:disable Metrics/CyclomaticComplexity
-  # rubocop:disable Metrics/MethodLength
   def to_regexp
     chars = @glob_string.gsub(%r{(\*\*\/\*)|(\*\*)}, '*').split('')
     in_curlies = 0, escaping = false
@@ -63,5 +62,4 @@ class Glob
     end.join
   end
   # rubocop:enable Metrics/CyclomaticComplexity
-  # rubocop:enable Metrics/MethodLength
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdd
 version: !ruby/object:Gem::Version
-  version: 0.20.8
+  version: 0.21.2
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-17 00:00:00.000000000 Z
+date: 2022-07-12 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
@@ -219,18 +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

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