pdd 0.18 → 0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99bde0870af357f7eba5e562cf4e80367fd5022a
-  data.tar.gz: 0fc0b88a2e83a2eccb98ed6a5089b469a6d549b7
+  metadata.gz: 1a7bf56d2eab1e277c1c717c7c3a9741a085aa1c
+  data.tar.gz: 2c0e8a6c70b10a1166ccc01cc2a9723aa888a330
 SHA512:
-  metadata.gz: 69b16a076410aec375c78acb4bb01332718edc630541b50c64da84bb92151d9205dddbbce3fe97ef708122fed0d5b832ecf07e1fcef3eb7b6ae61be0f351e146
-  data.tar.gz: 1685a80e5bf84944218a5211b41f905a7bdccbd8112bf877515518dd79b6ef8f28275f2b6519e86ae52d04428b4a9199369f51b2e8f4d736dedb7ea5b9990982
+  metadata.gz: ddc3c2b798ae5f3b1173deaa010de1ae0c9d09abddec69f632cc130b29fe9377cd2007ba01f23186cfb26bfd2b75372b325575714f010f7fc41794e149ba3e69
+  data.tar.gz: e7724224e1651202321fbc76eec17fa79ce1fdc964198f4f10376695611d1c7a6321c58b6048f439f19dcbf9bd67923ca61464e331b06a7e78c25c23c1e1d798

data/.gitattributes

@@ -5,3 +5,7 @@
 * text=auto eol=lf
 *.java ident
 *.xml ident
+*.jpg binary
+*.png binary
+*.pdf binary
+*.woff binary

data/.rultor.yml

@@ -2,8 +2,6 @@ assets:
   rubygems.yml: zerocracy/home#assets/rubygems.yml
   s3cfg: zerocracy/home#assets/s3cfg
 install: |
-  sudo apt-get update
-  sudo apt-get install -y --fix-missing libmagic1 libmagic-dev
   sudo gem install pdd
   sudo gem install xcop
 release:

data/README.md

@@ -1,6 +1,6 @@
 <img src="https://avatars2.githubusercontent.com/u/24456188" width="64px" height="64px"/>
 
-[![Managed by Zerocracy](http://www.zerocracy.com/badge.svg)](http://www.zerocracy.com)
+[![Managed by Zerocracy](http://www.0crat.com/badge/C3T46CUJJ.svg)](http://www.0crat.com/p/C3T46CUJJ)
 [![DevOps By Rultor.com](http://www.rultor.com/b/yegor256/pdd)](http://www.rultor.com/p/yegor256/pdd)
 [![We recommend RubyMine](http://img.teamed.io/rubymine-recommend.svg)](https://www.jetbrains.com/ruby/)
 
@@ -62,17 +62,38 @@ void sendEmail() {
 }
 ```
 
-It starts with `@todo`, followed by a space and a puzzle marker.
-Possible formats of puzzle markers:
+If you use it in combination with [0pdd](http://www.0pdd.com),
+after processing this text, the issue titled
+"File.java:10-13: This is something to do later in one of ..." will be created.
+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.
+
+It starts with `@todo`, followed by a space and a mandatory puzzle **marker**.
+Possible formats of puzzle markers (it doesn't matter what the
+line starts with and where it is located,
+as long as you have that `@todo` right in front
+of the mandatory marker):
 
 ```
-#224
-#TEST-13
-#55:45min
-#67/DES
-#678:40m/DEV
+// @todo #224
+/* @todo #TEST-13 */
+# @todo #55:45min
+@todo #67/DES
+;; @todo #678:40m/DEV
 ```
 
+Here `DES` and `DEV` are the roles of people who must fix that puzzles;
+`45min` and `40m` is the amount of time the puzzle should take;
+`224`, `TEST-13`, `55`, `67`, and `678` are the IDs of the tickets these
+puzzles are coming from.
+
+Markers are absolutely necessary for all puzzles, because they allow
+us to build a hierarchical dependency tree of all puzzles, like
+[this one](http://www.0pdd.com/p?name=yegor256/takes),
+for example. Technically, of course, you can abuse the system
+and put a dummy `#1` marker everywhere.
+
 ## How to Configure Rules?
 
 You can specify post-parsing rules for your puzzles, in command line,
@@ -111,7 +132,7 @@ See, how it is done in [yegor256/0pdd](https://github.com/yegor256/0pdd/blob/mas
 
 Just submit a pull request. Make sure `rake` passes.
 
-This is how you run it locally to test how it works:
+This is how you run the tool locally to test how it works:
 
 ```bash
 $ ./bin/pdd --help

data/bin/pdd

@@ -44,13 +44,15 @@ begin
       o.bool '-h', '--help', 'Show these instructions'
       o.bool '-v', '--verbose', 'Enable verbose mode (a lot of logging)'
       o.bool '-q', '--quiet', 'Enable quiet mode (almost no logging)'
+      o.bool '--skip-gitignore', 'Don\'t look into .gitignore for excludes'
       o.bool '-i', '--version', 'Show current version' do
         puts PDD::VERSION
         exit
       end
       o.string '-s', '--source', 'Source directory to parse ("." by default)'
       o.string '-f', '--file', 'File to save XML into'
-      o.array '-e', '--exclude', 'Glob pattern to exclude, e.g. "**/*.jpg"'
+      o.array '-e', '--exclude', 'Glob pattern to exclude, e.g. "**/*.jpg"',
+        default: []
       o.string '-t', '--format', 'Format of the report (xml|html)'
       o.array(
         '-r', '--rule', 'Rule to apply (can be used many times)',
@@ -72,6 +74,10 @@ https://github.com/yegor256/pdd/blob/master/README.md"
     raise '-f is mandatory when using -v, try --help for more information'
   end
 
+  if opts['skip-gitignore']
+    raise 'For --skip-gitignore see https://github.com/yegor256/pdd/issues/80'
+  end
+
   Encoding.default_external = Encoding::UTF_8
   Encoding.default_internal = Encoding::UTF_8
   file = opts.file? ? File.new(opts[:file], 'w') : STDOUT

data/features/cli.feature

@@ -63,6 +63,26 @@ Feature: Command Line Processing
     Then Exit code is zero
     And XML file "out.xml" matches "/puzzles[count(puzzle)=0]"
 
+  Scenario: Excluding unnecessary files from gitignore
+    Given this step says to skip
+    And I have a "a/b/c/test.txt" file with content:
+    """
+    ~~ @todo #44 some puzzle to be excluded
+    """
+    And I have a "f/g/h/hello.md" file with content:
+    """
+    ~~ @todo #44 some puzzle to be excluded as well
+    """
+    And I have a ".gitignore" file with content:
+    """
+    # This is the list of patterns
+    a/**/*
+    !/f
+    """
+    When I run bin/pdd with "> out.xml"
+    Then Exit code is zero
+    And XML file "out.xml" matches "/puzzles[count(puzzle)=1]"
+
   Scenario: Rejects unknown options
     Given I have a "test.txt" file with content:
     """

data/features/step_definitions/steps.rb

@@ -41,9 +41,13 @@ After do
   FileUtils.rm_rf(@dir) if File.exist?(@dir)
 end
 
+Given(/skip/) do
+  skip_this_scenario
+end
+
 Given(/^I have a "([^"]*)" file with content:$/) do |file, text|
   FileUtils.mkdir_p(File.dirname(file)) unless File.exist?(file)
-  File.open(file, 'w') do |f|
+  File.open(file, 'w:ASCII-8BIT') do |f|
     f.write(text.gsub(/\\xFF/, 0xFF.chr))
   end
 end

data/lib/pdd/source.rb

@@ -36,24 +36,26 @@ module PDD
     # Fetch all puzzles.
     def puzzles
       PDD.log.info "Reading #{@path}..."
-      re = %r{(.*(?:^|\s))@todo\s+#([\w\-\.:/]+)\s+(.+)}
       puzzles = []
       lines = File.readlines(@file)
       lines.each_with_index do |line, idx|
         begin
-          re.match(line) do |match|
+          /[^\s]@todo/.match(line) do |_|
+            raise Error, '@todo must have a leading space to become a puzzle,
+as this page explains: https://github.com/yegor256/pdd#how-to-format'
+          end
+          /@todo(?!\s+#)/.match(line) do |_|
+            raise Error, "@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
+          %r{(.*(?:^|\s))@todo\s+#([\w\-\.:/]+)\s+(.+)}.match(line) do |match|
             puzzles << puzzle(lines.drop(idx + 1), match, idx)
           end
         rescue Error, ArgumentError => ex
           raise Error, "puzzle at line ##{idx + 1}; #{ex.message}"
         end
       end
-      lines.each_with_index do |line, idx|
-        next unless line =~ /.*(^|\s)@todo\s+[^#]/
-        raise Error, "@todo found, but puzzle can't be parsed in line ##{idx}, \
-most probably because TODO is not followed by a puzzle marker, as this page \
-explains: https://github.com/yegor256/pdd#how-to-format"
-      end
       puzzles
     end
 
@@ -117,6 +119,10 @@ at position ##{prefix.length + 1}."
         .map { |t| t[1, t.length] }
     end
 
+    # @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
+    #  skip it if it's not SVN.
+
     # Git information at the line
     def git(pos)
       dir = Shellwords.escape(File.dirname(@file))

data/lib/pdd/version.rb

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

data/pdd.gemspec

@@ -44,13 +44,13 @@ Gem::Specification.new do |s|
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
-  s.add_runtime_dependency 'nokogiri', '~>1.7'
-  s.add_runtime_dependency 'slop', '~>4.4'
+  s.add_runtime_dependency 'nokogiri', '~>1.8'
+  s.add_runtime_dependency 'slop', '~>4.6'
   s.add_runtime_dependency 'rainbow', '~>2.2'
   s.add_development_dependency 'rake', '12.0.0'
   s.add_development_dependency 'codecov', '0.1.10'
   s.add_development_dependency 'rdoc', '4.2.0'
-  s.add_development_dependency 'cucumber', '1.3.17'
+  s.add_development_dependency 'cucumber', '3.1.0'
   s.add_development_dependency 'minitest', '5.5.0'
   s.add_development_dependency 'rubocop', '0.48.1'
   s.add_development_dependency 'rubocop-rspec', '1.15.1'

data/test/test_source.rb

@@ -83,7 +83,7 @@ class TestSource < Minitest::Test
       error = assert_raises PDD::Error do
         PDD::VerboseSource.new(file, PDD::Source.new(file, 'ff')).puzzles
       end
-      assert !error.to_s.index('can\'t be parsed').nil?
+      assert !error.to_s.index('@todo is not followed by a puzzle marker').nil?
     end
   end
 
@@ -115,6 +115,22 @@ class TestSource < Minitest::Test
     end
   end
 
+  def test_failing_on_puzzle_without_leading_space
+    Dir.mktmpdir 'test' do |dir|
+      file = File.join(dir, 'hey.txt')
+      File.write(
+        file,
+        '
+        *@todo #999 this is an incorrectly formatted puzzle!
+        '
+      )
+      error = assert_raises PDD::Error do
+        PDD::VerboseSource.new(file, PDD::Source.new(file, 'x')).puzzles
+      end
+      assert !error.message.index('@todo must have a leading space').nil?
+    end
+  end
+
   def test_reads_git_author
     skip if Gem.win_platform?
     Dir.mktmpdir 'test' do |dir|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdd
 version: !ruby/object:Gem::Version
-  version: '0.18'
+  version: 0.18.1
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-02 00:00:00.000000000 Z
+date: 2017-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '4.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '4.6'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.17
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.17
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -188,7 +188,6 @@ extra_rdoc_files:
 - LICENSE.txt
 files:
 - ".0pdd.yml"
-- ".coveralls.yml"
 - ".gitattributes"
 - ".gitignore"
 - ".pdd"
@@ -200,7 +199,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- TEAM.md
 - appveyor.yml
 - assets/puzzles.xsd
 - assets/puzzles.xsl

data/.coveralls.yml

@@ -1,2 +0,0 @@
-service_name: travis-pro
-repo_token: cZjWSm2veNxj30lzlfMLKXdLQ1XCkKk9H

data/TEAM.md

@@ -1,17 +0,0 @@
-## Team
-
-The following members are in the project team:
-
-Role | Members
----|---
-PM | @davvd
-CR | 
-DEV | 
-IMP | 
-ARC | 
-DES | 
-PO | @yegor256
-ITR | 
-QA | 
-SA | 
-HLP |