pdd 0.20.6 → 0.21.0

data/features/catches_broken_puzzles.feature

@@ -11,45 +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 "puzzle at line #6"
-
-  Scenario: Throwing exception on another broken puzzle
-    Given I have a "Sample.java" file with content:
-    """
-    public class Main {
-      /**
-       * @todo #13 This puzzle has an incorrect format
-       *    because its second line starts with too many spaces
-       */
-      public void main(String[] args) {
-        // later
-      }
-    }
-    """
-    When I run pdd it fails with "Too many leading spaces"
-
-  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"
+    When I run pdd it fails with "Sample.java:6"

data/features/cli.feature

@@ -26,7 +26,7 @@ Feature: Command Line Processing
     """
     When I run bin/pdd with "-v -s . -f out.xml"
     Then Exit code is zero
-    And Stdout contains "Reading ."
+    And Stdout contains "Reading from root dir ."
     And XML file "out.xml" matches "/puzzles[count(puzzle)=1]"
     And XML file "out.xml" matches "//puzzle[starts-with(body,'Привет, Let')]"
 

data/features/html_output.feature

@@ -18,5 +18,5 @@ Feature: HTML output
     """
     When I run bin/pdd with "-v -s . -f out.html --format=html"
     Then Exit code is zero
-    And Stdout contains "Reading ."
+    And Stdout contains "Reading from root dir ."
     And XML file "out.html" matches "/html/body"

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/rake.feature

@@ -1,19 +1,21 @@
 Feature: Rake Task
-  Scenario: For now we failed if run rake task
+  As a source code writer I want to be able to
+  run PDD from Rakefile
+  Scenario: PDD can be used in Rakefile
     Given It is Unix
-    And a file named "Rakefile" with:
+    And I have a "Rakefile" file with content:
     """
     require 'pdd/rake_task'
-    PDD::RakeTask.new
+    PDD::RakeTask.new(:pdd) do |task|
+      task.includes = ['a.txt']
+    end
     """
-    When I run the following commands with `bash`:
-    """bash
-    rake pdd
+    And I have a "a.txt" file with content:
     """
-    Then the exit status should be 1
-    And the stderr should contain:
+    \x40todo #55 hello!
     """
-    NOT IMPLEMENTED
-    """
-    When I remove a file named "Rakefile" with full force
-    Then a file named "Rakefile" does not exist
+
+    When I run bash with "rake pdd"
+    Then Exit code is zero
+
+

data/features/step_definitions/steps.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2020 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
@@ -64,9 +64,9 @@ When(/^I run pdd it fails with "([^"]*)"$/) do |txt|
   begin
     PDD::Base.new(@opts).xml
     passed = true
-  rescue PDD::Error => ex
-    unless ex.message.include?(txt)
-      raise "PDD failed but exception doesn't contain \"#{txt}\": #{ex.message}"
+  rescue PDD::Error => e
+    unless e.message.include?(txt)
+      raise "PDD failed but exception doesn't contain \"#{txt}\": #{e.message}"
     end
   end
   raise "PDD didn't fail" if passed
@@ -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
@@ -90,11 +88,10 @@ end
 
 Then(/^XML file "([^"]+)" matches "([^"]+)"$/) do |file, xpath|
   raise "File #{file} doesn't exit" unless File.exist?(file)
+
   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-2020 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/features/uses_config.feature

@@ -16,6 +16,6 @@ Feature: Using .pdd config file
     """
     When I run bin/pdd with ""
     Then Exit code is zero
-    And Stdout contains "Reading ."
+    And Stdout contains "Reading from root dir ."
     And XML file "out.xml" matches "/puzzles[count(puzzle)=1]"
 

data/lib/pdd/puzzle.rb

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

@@ -1,30 +1,29 @@
 require 'rake'
 require 'rake/tasklib'
+require 'minitest/autorun'
+require 'nokogiri'
+require 'tmpdir'
+require 'slop'
+require 'pdd'
 
 # PDD Rake task
 module PDD
   # Rake task
   class RakeTask < Rake::TaskLib
-    attr_accessor :name
+    attr_accessor :name, :fail_on_error, :includes, :license, :quiet
+
     def initialize(*args, &task_block)
-      # @todo #125:30m Needs to have more parameters to run this task.
-      #  For now, we just have a single parameter - the name.
-      #  Needs more parameters like the xcop rake task has.
       @name = args.shift || :pdd
+      @includes = []
+      @excludes = []
+      @license = nil
+      @quiet = false
       desc 'Run PDD' unless ::Rake.application.last_description
       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
-
-    def run
-      # @todo #125:30m need to implement this method.
-      #  For now, it's just a task,
-      #  that accepts one parameter and throws a system error.
-      abort('NOT IMPLEMENTED')
-    end
   end
 end

data/lib/pdd/rule/duplicates.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2020 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
@@ -35,6 +35,7 @@ module PDD
           .group_by { |p| p.xpath('body/text()').to_s }
           .map do |_, puzzles|
             next nil if puzzles.count <= @max
+
             "there are #{puzzles.count} duplicate(s) of the same puzzle: " +
               puzzles.map do |p|
                 "#{p.xpath('file/text()')}:#{p.xpath('lines/text()')}"

data/lib/pdd/rule/estimates.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2020 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-2020 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
@@ -34,6 +34,7 @@ module PDD
           @xml.xpath('//puzzle').map do |p|
             role = p.xpath('role/text()').to_s
             next nil if @roles.include?(role)
+
             "puzzle #{p.xpath('file/text()')}:#{p.xpath('lines/text()')}" +
               if role.empty?
                 " doesn't define any role"\

data/lib/pdd/rule/text.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2020 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
@@ -34,6 +34,7 @@ module PDD
           @xml.xpath('//puzzle').map do |p|
             words = p.xpath('body/text()').to_s.split.size
             next nil if words >= @min
+
             "Puzzle #{p.xpath('file/text()')}:#{p.xpath('lines/text()')}"\
             " has a very short description of just #{words} words while"\
             " a minimum of #{@min} is required"

data/lib/pdd/source.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2020 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,6 +26,7 @@ require_relative '../pdd'
 require_relative '../pdd/puzzle'
 
 module PDD
+  MARKERS = ["\x40todo", 'TODO:?'].freeze
   # Source.
   class Source
     # Ctor.
@@ -36,21 +37,47 @@ module PDD
       @path = path
     end
 
+    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.
     def puzzles
-      PDD.log.info "Reading #{@path}..."
+      PDD.log.info "Reading #{@path} ..."
       puzzles = []
       lines = File.readlines(@file, encoding: 'UTF-8')
       lines.each_with_index do |line, idx|
         begin
-          check_rules(line)
-          ["\x40todo", 'TODO:?'].each do |pfx|
-            %r{(.*(?:^|\s))#{pfx}\s+#([\w\-\.:/]+)\s+(.+)}.match(line) do |m|
-              puzzles << puzzle(lines.drop(idx + 1), m, idx)
-            end
+          match_markers(line).each do |m|
+            puzzles << puzzle(lines.drop(idx + 1), m, idx)
           end
         rescue Error, ArgumentError => ex
-          raise Error, "puzzle at line ##{idx + 1}; #{ex.message}"
+          message = "#{@path}:#{idx + 1} #{ex.message}"
+          raise Error, message unless PDD.opts && PDD.opts['skip-errors']
+          PDD.log.warn message
         end
       end
       puzzles
@@ -60,46 +87,25 @@ module PDD
 
     def get_no_leading_space_error(todo)
       "#{todo} must have a leading space to become \
-a puzzle, as this page explains: https://github.com/yegor256/pdd#how-to-format"
+a puzzle, as this page explains: https://github.com/cqfn/pdd#how-to-format"
     end
 
     def get_no_puzzle_marker_error(todo)
       "#{todo} found, but puzzle can't be parsed, \
 most probably because #{todo} is not followed by a puzzle marker, \
-as this page explains: https://github.com/yegor256/pdd#how-to-format"
+as this page explains: https://github.com/cqfn/pdd#how-to-format"
     end
 
     def get_space_after_hash_error(todo)
       "#{todo} found, but there is an unexpected space \
 after the hash sign, it should not be there, \
-see https://github.com/yegor256/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
+see https://github.com/cqfn/pdd#how-to-format"
     end
 
     # Fetch puzzle
     def puzzle(lines, match, idx)
-      tail = tail(lines, match[1], idx)
-      body = (match[3] + ' ' + tail.join(' ')).gsub(/\s+/, ' ').strip
+      tail = tail(lines, match[1])
+      body = "#{match[3]} #{tail.join(' ')}".gsub(/\s+/, ' ').strip
       body = body.chomp('*/-->').strip
       marker = marker(match[2])
       Puzzle.new(
@@ -114,11 +120,11 @@ see https://github.com/yegor256/pdd#how-to-format"
 
     # Parse a marker.
     def marker(text)
-      re = %r{([\w\-\.]+)(?::(\d+)(?:(m|h)[a-z]*)?)?(?:/([A-Z]+))?}
+      re = %r{([\w\-.]+)(?::(\d+)(?:(m|h)[a-z]*)?)?(?:/([A-Z]+))?}
       match = re.match(text)
       if match.nil?
         raise "Invalid puzzle marker \"#{text}\", most probably formatted \
-against the rules explained here: https://github.com/yegor256/pdd#how-to-format"
+against the rules explained here: https://github.com/cqfn/pdd#how-to-format"
       end
       {
         ticket: match[1],
@@ -135,24 +141,17 @@ against the rules explained here: https://github.com/yegor256/pdd#how-to-format"
     end
 
     # Fetch puzzle tail (all lines after the first one)
-    def tail(lines, prefix, start)
+    def tail(lines, prefix)
+      prefix = prefix.rstrip
       lines
-        .take_while { |t| t.start_with?(prefix) }
-        .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
-        .each_with_index do |t, i|
-          next if t !~ /^\s{2,}/
-          raise Error, "Too many leading spaces \
-at #{start + i + 2}:#{prefix.length}; \
-make sure all lines that include the puzzle body start \
-at position ##{prefix.length + 1}."
+        .take_while { |t| match_markers(t).none? && t.start_with?(prefix) }
+        .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[1, t.length] }
+        .map { |t| t[prefix.length, t.length] }
+        .map { |t| t.start_with?(' ') ? t[1, t.length] : t }
     end
 
     # @todo #75:30min Let's make it possible to fetch Subversion data
@@ -167,28 +166,29 @@ at position ##{prefix.length + 1}."
       if `#{git} rev-parse --is-inside-work-tree 2>/dev/null`.strip == 'true'
         cmd = "#{git} blame -L #{pos},#{pos} --porcelain #{name}"
         add_github_login(Hash[
-          `#{cmd}`.split("\n").map do |line|
-            if line =~ /^author /
-              [:author, line.sub(/^author /, '')]
-            elsif line =~ /^author-mail [^@]+@[^\.]+\..+/
-              [:email, line.sub(/^author-mail <(.+)>$/, '\1')]
-            elsif line =~ /^author-time /
-              [
-                :time,
-                Time.at(
-                  line.sub(/^author-time ([0-9]+)$/, '\1').to_i
-                ).utc.iso8601
-              ]
-            end
-          end.compact
-        ])
+                           `#{cmd}`.split("\n").map do |line|
+                             case line
+                             when /^author /
+                               [:author, line.sub(/^author /, '')]
+                             when /^author-mail [^@]+@[^.]+\..+/
+                               [:email, line.sub(/^author-mail <(.+)>$/, '\1')]
+                             when /^author-time /
+                               [
+                                 :time,
+                                 Time.at(
+                                   line.sub(/^author-time ([0-9]+)$/, '\1').to_i
+                                 ).utc.iso8601
+                               ]
+                             end
+                           end.compact
+                         ])
       else
         {}
       end
     end
 
     def add_github_login(info)
-      login = find_github_login(info[:email])
+      login = find_github_login(info)
       info[:author] = "@#{login}" unless login.empty?
       info
     end
@@ -203,15 +203,26 @@ at position ##{prefix.length + 1}."
       JSON.parse res.body
     end
 
-    def find_github_user(email)
-      base_uri = 'https://api.github.com/search/users'
-      query = base_uri + "?q=#{email}+in:email&perpage=1"
+    def find_github_user(info)
+      email, author = info.values_at(:email, :author)
+      # if email is not defined, changes have not been committed
+      return if email.nil?
+
+      base_uri = 'https://api.github.com/search/users?per_page=1'
+      query = base_uri + "&q=#{email}+in:email"
       json = get_json query
+      # find user by name instead since users can make github email private
+      unless json['total_count'].positive?
+        return if author.nil?
+
+        query = base_uri + "&q=#{author}+in:fullname"
+        json = get_json query
+      end
       json['items'].first
     end
 
-    def find_github_login(email)
-      user = find_github_user email
+    def find_github_login(info)
+      user = find_github_user info
       user['login']
     rescue StandardError
       ''
@@ -231,8 +242,8 @@ at position ##{prefix.length + 1}."
     # Fetch all puzzles.
     def puzzles
       @source.puzzles
-    rescue Error => ex
-      raise Error, "#{@file}; #{ex.message}"
+    rescue Error => e
+      raise Error, "#{@file}; #{e.message}"
     end
   end
 end