pdd 0.20.3 → 0.20.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 923491c89e00bd204e14a12c1c3d2f792c44c14b
-  data.tar.gz: 70ed765544c00e134373e5db4a4801afd4c5de53
+SHA256:
+  metadata.gz: cc5c52ddb7620147399b0ed8cec3d13900d1d36e695c42021cf2e887b4b80d7c
+  data.tar.gz: 6da8a3a29675c6359e427d2c16048f32a032fcc25247447ce110ac3e649b147b
 SHA512:
-  metadata.gz: a4b425410f882fcf7400ede903ba3b9d6ed983d96dc91c58e6d70c0d911202f37db1b40657b7115a50e5afd081917882ca54df65656f020f792f91c33ce8aea5
-  data.tar.gz: 3c02e5936c0538054a83a408b0f9083d8f45fbeabe0712f99c368b7455d3d5a31571a043623342ec85275353c6b37df136af2c5313dbbc102ea13fee4c347520
+  metadata.gz: e986672fe0a226d5577bd35d296f9d55685d0d77384e516d535b5cdd672a43c8e4d33a9167b6cf9e0397738b4dc7967a904324f5e77c6c48413bc4663d2e61c3
+  data.tar.gz: c0086dc48c63539c09ea70bcea1d7fba64c1eb48fc51a6a2ffa65740e0333a38b6bb93b7dfe634b0e4e99d173539b19054922d2cbfebc78a88dc32a42f41bb36

data/.rultor.yml

@@ -2,6 +2,8 @@ assets:
   rubygems.yml: zerocracy/home#assets/rubygems.yml
   s3cfg: zerocracy/home#assets/s3cfg
 install: |
+  export GEM_HOME=~/.ruby
+  export GEM_PATH=$GEM_HOME:$GEM_PATH
   sudo gem install pdd
   sudo gem install xcop
 release:

data/README.md

@@ -1,5 +1,7 @@
 <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)
+
 [![EO principles respected here](http://www.elegantobjects.org/badge.svg)](http://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/yegor256/pdd)](http://www.rultor.com/p/yegor256/pdd)
@@ -13,6 +15,7 @@
 [![Dependency Status](https://gemnasium.com/yegor256/pdd.svg)](https://gemnasium.com/yegor256/pdd)
 [![Maintainability](https://api.codeclimate.com/v1/badges/c8e46256fdd8ddc817e5/maintainability)](https://codeclimate.com/github/yegor256/pdd/maintainability)
 [![Test Coverage](https://img.shields.io/codecov/c/github/yegor256/pdd.svg)](https://codecov.io/github/yegor256/pdd?branch=master)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/yegor256/pdd/master/frames)
 
 ## What This is for?
 
@@ -53,6 +56,16 @@ pdd --exclude=src/**/* # exclude all files in src/
 Every puzzle has to be formatted like this (pay attention
 to the leading space in every consecutive line):
 
+```java
+/**
+ * @todo #[issue#]<:[time]></[role]> <[description]>
+ */
+[related code]
+```
+\[\] - Replace with apropriate data (see text enclosed in brackets)
+<>   - Omitable (enclosed data can be left out)
+
+Example:
 ```java
 /**
  * @todo #234:15m/DEV This is something to do later
@@ -168,9 +181,19 @@ The most interesting parts of each puzzle are:
 
   * `lines` is where the puzzle is found, inside the file.
 
-## How to contribute?
+# How to contribute
+
+Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
+Make sure you build is green before you contribute
+your pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2.3+ and
+[Bundler](https://bundler.io/) installed. Then:
+
+```
+$ bundle update
+$ rake
+```
 
-Just submit a pull request. Make sure `rake` passes.
+If it's clean and you don't see any error messages, submit your pull request.
 
 This is how you run the tool locally to test how it works:
 

data/bin/pdd

@@ -100,7 +100,7 @@ rescue SystemExit => ex
   PDD.log.info "Exit code is #{ex.status}"
   exit(ex.status)
 rescue PDD::Error => ex
-  puts "#{Rainbow('ERROR').red}: #{ex.message}. \
+  puts "#{Rainbow('ERROR').red}: #{ex.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/yegor256/pdd/issues. This tool is still in its beta \

data/lib/pdd/source.rb

@@ -19,6 +19,8 @@
 # SOFTWARE.
 
 require 'digest/md5'
+require 'net/http'
+require 'json'
 require 'shellwords'
 require_relative '../pdd'
 require_relative '../pdd/puzzle'
@@ -41,23 +43,13 @@ module PDD
       lines = File.readlines(@file, encoding: 'UTF-8')
       lines.each_with_index do |line, idx|
         begin
-          /[^\s]\x40todo/.match(line) do |_|
-            raise Error, "\x40todo must have a leading space to become \
-a puzzle, as this page explains: https://github.com/yegor256/pdd#how-to-format"
-          end
-          /\x40todo(?!\s+#)/.match(line) do |_|
-            raise Error, "\x40todo found, but puzzle can't be parsed, \
-most probably because \x40todo is not followed by a puzzle marker, \
-as this page explains: https://github.com/yegor256/pdd#how-to-format"
-          end
-          /\x40todo\s+#\s/.match(line) do |_|
-            raise Error, "\x40todo 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
+          check_rules(line)
           %r{(.*(?:^|\s))\x40todo\s+#([\w\-\.:/]+)\s+(.+)}.match(line) do |m|
             puzzles << puzzle(lines.drop(idx + 1), m, idx)
           end
+          %r{(.*(?:^|\s))TODO:?\s+#([\w\-\.:/]+)\s+(.+)}.match(line) do |m|
+            puzzles << puzzle(lines.drop(idx + 1), m, idx)
+          end
         rescue Error, ArgumentError => ex
           raise Error, "puzzle at line ##{idx + 1}; #{ex.message}"
         end
@@ -67,10 +59,49 @@ see https://github.com/yegor256/pdd#how-to-format"
 
     private
 
+    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"
+    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"
+    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
+    end
+
     # Fetch puzzle
     def puzzle(lines, match, idx)
       tail = tail(lines, match[1], idx)
       body = (match[3] + ' ' + tail.join(' ')).gsub(/\s+/, ' ').strip
+      body = body.chomp('*/-->').strip
       marker = marker(match[2])
       Puzzle.new(
         marker.merge(
@@ -136,7 +167,7 @@ at position ##{prefix.length + 1}."
       git = "cd #{dir} && git"
       if `#{git} rev-parse --is-inside-work-tree 2>/dev/null`.strip == 'true'
         cmd = "#{git} blame -L #{pos},#{pos} --porcelain #{name}"
-        Hash[
+        add_github_login(Hash[
           `#{cmd}`.split("\n").map do |line|
             if line =~ /^author /
               [:author, line.sub(/^author /, '')]
@@ -151,11 +182,41 @@ at position ##{prefix.length + 1}."
               ]
             end
           end.compact
-        ]
+        ])
       else
         {}
       end
     end
+
+    def add_github_login(info)
+      login = find_github_login(info[:email])
+      info[:author] = "@#{login}" unless login.empty?
+      info
+    end
+
+    def get_json(query)
+      uri = URI.parse(query)
+      http = Net::HTTP.new(uri.hostname, uri.port)
+      http.use_ssl = uri.scheme == 'https'
+      req = Net::HTTP::Get.new(uri.request_uri)
+      req.set_content_type('application/json')
+      res = http.request(req)
+      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"
+      json = get_json query
+      json['items'].first
+    end
+
+    def find_github_login(email)
+      user = find_github_user email
+      user['login']
+    rescue StandardError
+      ''
+    end
   end
 
   # Verbose Source.

data/lib/pdd/sources.rb

@@ -57,13 +57,17 @@ module PDD
 
     private
 
-    def binary?(f)
+    # @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(f)}`
+      `grep -qI '.' #{Shellwords.escape(file)}`
       if $CHILD_STATUS.success?
         false
       else
-        PDD.log.info "#{f} is a binary file (#{File.size(f)} bytes)"
+        PDD.log.info "#{file} is a binary file (#{File.size(file)} bytes)"
         true
       end
     end

data/lib/pdd/version.rb

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

data/test/test_source.rb

@@ -28,16 +28,14 @@ require_relative '../lib/pdd/sources'
 # Copyright:: Copyright (c) 2014-2018 Yegor Bugayenko
 # License:: MIT
 class TestSource < Minitest::Test
-  # @todo #85:30min Make this test pass on AppVeyor.
   def test_parsing
-    skip('Skipped because it fails on AppVeyor')
     Dir.mktmpdir 'test' do |dir|
       file = File.join(dir, 'a.txt')
       File.write(
         file,
         "
         * \x40todo #44 привет,
-        *  how are you\t\r\tdoing?
+        *  how are you\t\tdoing?
         * -something else
         Something else
         ~~ \x40todo #ABC-3 this is another puzzle
@@ -90,7 +88,6 @@ class TestSource < Minitest::Test
   end
 
   def test_failing_on_broken_unicode
-    skip if Gem.win_platform?
     Dir.mktmpdir 'test' do |dir|
       file = File.join(dir, 'xx.txt')
       File.write(file, ' * \x40todo #44 this is a broken unicode: ' + 0x92.chr)
@@ -101,7 +98,6 @@ class TestSource < Minitest::Test
   end
 
   def test_failing_on_invalid_puzzle_without_hash_sign
-    skip('doesnt work now')
     Dir.mktmpdir 'test' do |dir|
       file = File.join(dir, 'a.txt')
       File.write(
@@ -113,7 +109,7 @@ class TestSource < Minitest::Test
       error = assert_raises PDD::Error do
         PDD::VerboseSource.new(file, PDD::Source.new(file, 'hey')).puzzles
       end
-      assert !error.message.index('Incorrect format').nil?
+      assert !error.message.index('is not followed by a puzzle marker').nil?
     end
   end
 
@@ -198,4 +194,39 @@ class TestSource < Minitest::Test
       assert_match(/\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z/, puzzle.props[:time])
     end
   end
+
+  def test_uses_github_login
+    skip if Gem.win_platform?
+    Dir.mktmpdir 'test' do |dir|
+      raise unless system("
+        cd '#{dir}'
+        git init --quiet .
+        git config user.email yegor256@gmail.com
+        git config user.name test
+        echo '\x40todo #1 this is the puzzle' > a.txt
+        git add a.txt
+        git commit --quiet -am 'first version'
+      ")
+      list = PDD::Source.new(File.join(dir, 'a.txt'), '').puzzles
+      assert_equal 1, list.size
+      puzzle = list.first
+      assert_equal '@yegor256', puzzle.props[:author]
+    end
+  end
+
+  def test_skips_thymeleaf_close_tag
+    Dir.mktmpdir 'test' do |dir|
+      file = File.join(dir, 'a.txt')
+      File.write(
+        file,
+        '<!--/* @todo #123 puzzle info */-->'
+      )
+      list = PDD::VerboseSource.new(file, PDD::Source.new(file, 'hey')).puzzles
+      assert_equal 1, list.size
+      puzzle = list.first
+      assert_equal '1-1', puzzle.props[:lines]
+      assert_equal 'puzzle info', puzzle.props[:body]
+      assert_equal '123', puzzle.props[:ticket]
+    end
+  end
 end

data/test/test_source_todo.rb

@@ -0,0 +1,168 @@
+# Copyright (c) 2014-2018 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.
+
+require 'minitest/autorun'
+require 'tmpdir'
+require_relative '../lib/pdd'
+require_relative '../lib/pdd/sources'
+
+class TestSourceTodo < Minitest::Test
+  def check_valid_puzzle(text, lines, body, ticket)
+    Dir.mktmpdir 'test' do |dir|
+      file = File.join(dir, 'a.txt')
+      File.write(file, text)
+      list = PDD::VerboseSource.new(file, PDD::Source.new(file, 'hey')).puzzles
+      assert_equal 1, list.size
+      puzzle = list.first
+      assert_equal lines, puzzle.props[:lines]
+      assert_equal body, puzzle.props[:body]
+      assert_equal ticket, puzzle.props[:ticket]
+    end
+  end
+
+  def check_invalid_puzzle(text, error_msg)
+    Dir.mktmpdir 'test' do |dir|
+      file = File.join(dir, 'a.txt')
+      File.write(file, text)
+      error = assert_raises PDD::Error do
+        PDD::VerboseSource.new(file, PDD::Source.new(file, 'hey')).puzzles
+      end
+      assert !error.message.index(error_msg).nil?
+    end
+  end
+
+  def test_todo_parsing
+    check_valid_puzzle(
+      "
+      // TODO #45 task description
+      ",
+      '2-2',
+      'task description',
+      '45'
+    )
+  end
+
+  def test_todo_parsing_multi_line
+    check_valid_puzzle(
+      "
+      // TODO #45 task description
+      //  second line
+      ",
+      '2-3',
+      'task description second line',
+      '45'
+    )
+  end
+
+  def test_todo_colon_parsing
+    check_valid_puzzle(
+      "
+      // TODO: #45 task description
+      ",
+      '2-2',
+      'task description',
+      '45'
+    )
+  end
+
+  def test_todo_colon_parsing_multi_line
+    check_valid_puzzle(
+      "
+      // TODO: #45 task description
+      //  second line
+      ",
+      '2-3',
+      'task description second line',
+      '45'
+    )
+  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(
+      "
+      * TODO this puzzle misses ticket name/number
+      ",
+      'TODO is not followed by'
+    )
+  end
+
+  def test_todo_colon_failing_no_ticket
+    check_invalid_puzzle(
+      "
+      * TODO: this puzzle misses ticket name/number
+      ",
+      'TODO is not followed by'
+    )
+  end
+
+  def test_todo_failing_space_after_hash
+    check_invalid_puzzle(
+      "
+      * TODO # 45 this puzzle has space after hash
+      ",
+      'TODO found, but there is an unexpected space after the hash sign'
+    )
+  end
+
+  def test_todo_colon_failing_space_after_hash
+    check_invalid_puzzle(
+      "
+      * TODO: # 45 this puzzle has space after hash
+      ",
+      'TODO found, but there is an unexpected space after the hash sign'
+    )
+  end
+
+  def test_todo_failing_no_space_before
+    check_invalid_puzzle(
+      "
+      *TODO #45 this puzzle has no space before todo
+      ",
+      'TODO must have a leading space'
+    )
+  end
+
+  def test_todo_colon_failing_no_space_before
+    check_invalid_puzzle(
+      "
+      *TODO: #45 this puzzle has no space before todo
+      ",
+      'TODO must have a leading space'
+    )
+  end
+end

data/test/test_sources.rb

@@ -82,6 +82,13 @@ class TestSources < Minitest::Test
     end
   end
 
+  def test_excludes_recursively
+    in_temp(['a/first.txt', 'b/c/second.txt', 'b/c/d/third.txt']) do |dir|
+      list = PDD::Sources.new(dir).exclude('**/*').fetch
+      assert_equal 0, list.size
+    end
+  end
+
   def test_fails_with_verbose_output
     in_temp do |dir|
       File.write(File.join(dir, 'z1.txt'), "\x40todobroken\n")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdd
 version: !ruby/object:Gem::Version
-  version: 0.20.3
+  version: 0.20.4
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-05 00:00:00.000000000 Z
+date: 2018-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -233,6 +233,7 @@ files:
 - test/test_pdd.rb
 - test/test_roles.rb
 - test/test_source.rb
+- test/test_source_todo.rb
 - test/test_sources.rb
 - test/test_text.rb
 - test_assets/aladdin.jpg
@@ -261,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 2
 summary: Puzzle Driven Development collector
@@ -283,5 +284,6 @@ test_files:
 - test/test_pdd.rb
 - test/test_roles.rb
 - test/test_source.rb
+- test/test_source_todo.rb
 - test/test_sources.rb
 - test/test_text.rb