pdd 0.21.0 → 0.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61cbd66550df0bd17c8916fa490a6e85f8c3991475c609a013b73db2e5891f16
-  data.tar.gz: 015351fbd2e277409faf706ccd1a590d5a962e49f6fdfb4c6318e371f658c96a
+  metadata.gz: ef027790e2aa528548fcb97f52632e7740f2a28a9ed7180677bf189ba86b504f
+  data.tar.gz: 2432ac79d70ebb056a6b1338ca52b170e2c7134d14b32d0e8454e34ff86f57ad
 SHA512:
-  metadata.gz: fbb82db1bbb0d5246caa98cc376a7a2ea32aefc217d567191f03fd3dc346d833d55cca141430b6b6f12dec1e5580faa5b83d28da3156b88ef3a0cdfd70fbbdf5
-  data.tar.gz: 81f23444974fd4d1359d9bbf2bd07adc370d05302369be00ee67c210c12c1c3d83648b9dcfd8e454d161781b06cef9430b72a774fa9ddcc3508493cb52540f45
+  metadata.gz: 8c91ee447d2b8aefde998e6516fdd1679c845b3a2360f8325a944e0833fe5818f23c7dfb465b0242dabc9828742849220951cbd8e91fc014e9603c78c83e4be8
+  data.tar.gz: 2910617b72caa5ad9b083fd6e1471fd6dcf8bb9e3ccea0ecf3577c5eaa060e4468f0278798cca1e77ce5ad9b77117486d55e5e3d536308c27931dce9dec0c60d

data/.rubocop.yml

@@ -1,13 +1,13 @@
 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:

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/README.md

@@ -1,4 +1,4 @@
-<img alt="pdd logo" src="https://avatars2.githubusercontent.com/u/24456188" width="64px" height="64px"/>
+<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)
 [![DevOps By Rultor.com](http://www.rultor.com/b/cqfn/pdd)](http://www.rultor.com/p/cqfn/pdd)
@@ -25,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
@@ -39,26 +40,32 @@ $ pdd --help
 
 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?

data/lib/pdd/source.rb

@@ -104,7 +104,8 @@ see https://github.com/cqfn/pdd#how-to-format"
 
     # Fetch puzzle
     def puzzle(lines, match, idx)
-      tail = tail(lines, match[1])
+      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,8 +142,9 @@ against the rules explained here: https://github.com/cqfn/pdd#how-to-format"
     end
 
     # Fetch puzzle tail (all lines after the first one)
-    def tail(lines, prefix)
+    def tail(lines, prefix, start)
       prefix = prefix.rstrip
+      prefix = " #{' ' * start}" if prefix.empty? # fallback to space indentation
       lines
         .take_while { |t| match_markers(t).none? && t.start_with?(prefix) }
         .take_while do |t|

data/lib/pdd/version.rb

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

data/test/test_source.rb

@@ -79,6 +79,30 @@ class TestSource < Minitest::Test
     end
   end
 
+  def test_no_prefix_multiline_puzzle_block
+    Dir.mktmpdir 'test' do |dir|
+      file = File.join(dir, 'a.txt')
+      File.write(
+        file,
+        "
+        <!--
+        \x40todo #01:30min correctly formatted multi-line puzzle, with no
+          comment prefix before todo marker
+        -->
+        "
+      )
+      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')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdd
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.21.1
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-30 00:00:00.000000000 Z
+date: 2022-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -241,6 +241,7 @@ files:
 - ".rubocop.yml"
 - ".rultor.yml"
 - ".simplecov"
+- CITATION.cff
 - Gemfile
 - LICENSE.txt
 - README.md