pdd 0.17.9 → 0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13b8f74b0fadd780f0b33023410df1b44cc83f8f
-  data.tar.gz: 9ec0aa1148ee8bbeee5b75d9fe678dc3269c74b8
+  metadata.gz: 99bde0870af357f7eba5e562cf4e80367fd5022a
+  data.tar.gz: 0fc0b88a2e83a2eccb98ed6a5089b469a6d549b7
 SHA512:
-  metadata.gz: 1f9fa206b2bf86935642f2660393049b53be4432804d34b0dfe0b9ab75cbc0421fe61b9ad698cb4113bf43bfea83b85f894161ede93229bd0837a64a68d92607
-  data.tar.gz: 93f4bdb7f8f793e66be89d256af0307734d04cf782aad05f9e446866117f4c23407359f68a11d36ca3d0c07d0cae4dd4c72823af1853f7274f1ac2169f32b8b2
+  metadata.gz: 69b16a076410aec375c78acb4bb01332718edc630541b50c64da84bb92151d9205dddbbce3fe97ef708122fed0d5b832ecf07e1fcef3eb7b6ae61be0f351e146
+  data.tar.gz: 1685a80e5bf84944218a5211b41f905a7bdccbd8112bf877515518dd79b6ef8f28275f2b6519e86ae52d04428b4a9199369f51b2e8f4d736dedb7ea5b9990982

data/.rubocop.yml

@@ -1,6 +1,16 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'assets/**/*'
+  DisplayCopNames: true
+
 MethodLength:
   Max: 30
 Style/ClassLength:
   Max: 150
 Metrics/AbcSize:
   Max: 37
+Style/MultilineBlockChain:
+  Enabled: false
+Metrics/BlockLength:
+  Max: 50

data/.rultor.yml

@@ -5,6 +5,7 @@ install: |
   sudo apt-get update
   sudo apt-get install -y --fix-missing libmagic1 libmagic-dev
   sudo gem install pdd
+  sudo gem install xcop
 release:
   script: |-
     env

data/.simplecov

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -20,8 +18,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require 'coveralls'
-
 if Gem.win_platform? then
   SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
     SimpleCov::Formatter::HTMLFormatter
@@ -31,10 +27,9 @@ if Gem.win_platform? then
     add_filter "/features/"
   end
 else
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-    SimpleCov::Formatter::HTMLFormatter,
-    Coveralls::SimpleCov::Formatter
-  ]
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
+    SimpleCov::Formatter::HTMLFormatter
+  )
   SimpleCov.start do
     add_filter "/test/"
     add_filter "/features/"

data/Gemfile

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/README.md

@@ -1,6 +1,6 @@
 <img src="https://avatars2.githubusercontent.com/u/24456188" width="64px" height="64px"/>
 
-[![Made By Teamed.io](http://img.teamed.io/btn.svg)](http://www.teamed.io)
+[![Managed by Zerocracy](http://www.zerocracy.com/badge.svg)](http://www.zerocracy.com)
 [![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/)
 
@@ -99,9 +99,44 @@ Here is a list of rules available now:
 
   * `min-words:5` blocks puzzles with descriptions shorter than five words.
 
-  * `max-duplicates:1` blocks more than one duplicate of any puzzle
-  (this rule is used by default).
+  * `max-duplicates:1` blocks more than one duplicate of any puzzle.
+  This rule is used by default and you can't configure it at the moment,
+  it must always be set to `1`.
 
 You can put all command line options into `.pdd` file. The options from the
 file will be used first. Command line options may be added on top of them.
 See, how it is done in [yegor256/0pdd](https://github.com/yegor256/0pdd/blob/master/.pdd).
+
+## How to contribute?
+
+Just submit a pull request. Make sure `rake` passes.
+
+This is how you run it locally to test how it works:
+
+```bash
+$ ./bin/pdd --help
+```
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2016-2017 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 NONINFRINGEMENT. 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.

data/Rakefile

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -33,7 +31,7 @@ def version
   Gem::Specification.load(Dir['*.gemspec'].first).version
 end
 
-task default: [:clean, :test, :features, :rubocop, :copyright]
+task default: %i[clean test features rubocop xcop copyright]
 
 require 'rake/testtask'
 desc 'Run all unit tests'
@@ -60,8 +58,17 @@ RuboCop::RakeTask.new(:rubocop) do |task|
   task.requires << 'rubocop-rspec'
 end
 
+require 'xcop/rake_task'
+desc 'Validate all XML/XSL/XSD/HTML files for formatting'
+Xcop::RakeTask.new :xcop do |task|
+  task.license = 'LICENSE.txt'
+  task.includes = ['**/*.xml', '**/*.xsl', '**/*.xsd', '**/*.html']
+  task.excludes = ['target/**/*', 'coverage/**/*']
+end
+
 require 'cucumber/rake/task'
-Cucumber::Rake::Task.new(:features) do
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = 'features --format progress'
   Rake::Cleaner.cleanup_files(['coverage'])
 end
 Cucumber::Rake::Task.new(:'features:html') do |t|

data/assets/puzzles.xsd

@@ -1,25 +1,27 @@
 <?xml version="1.0"?>
 <!--
- * Copyright (c) 2014-2017 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.
- -->
+(The MIT License)
+
+Copyright (c) 2014-2017 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 NONINFRINGEMENT. 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.
+-->
 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:complexType name="puzzle">
     <xs:all>
@@ -92,14 +94,14 @@
   <xs:element name="puzzles">
     <xs:complexType>
       <xs:sequence>
-        <xs:element name="puzzle" type="puzzle" minOccurs="0" maxOccurs="unbounded" />
+        <xs:element name="puzzle" type="puzzle" minOccurs="0" maxOccurs="unbounded"/>
       </xs:sequence>
       <xs:attribute name="version" use="required" type="xs:string"/>
       <xs:attribute name="date" use="required" type="xs:dateTime"/>
     </xs:complexType>
     <xs:unique name="puzzleBody">
-      <xs:selector xpath="./puzzle" />
-      <xs:field xpath="body" />
+      <xs:selector xpath="./puzzle"/>
+      <xs:field xpath="body"/>
     </xs:unique>
   </xs:element>
 </xs:schema>

data/assets/puzzles.xsl

@@ -1,27 +1,28 @@
 <?xml version="1.0"?>
 <!--
- * Copyright (c) 2014-2017 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.
- -->
-<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
-  version="1.0" xmlns="http://www.w3.org/1999/xhtml">
+(The MIT License)
+
+Copyright (c) 2014-2017 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 NONINFRINGEMENT. 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.
+-->
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml" version="1.0">
   <xsl:template match="/">
     <xsl:text disable-output-escaping="yes">&lt;!DOCTYPE html&gt;</xsl:text>
     <html lang="en">
@@ -30,7 +31,9 @@
         <meta name="description" content="PDD puzzles"/>
         <meta name="keywords" content="puzzle driven development"/>
         <meta name="author" content="teamed.io"/>
-        <title><xsl:text>PDD Summary Report</xsl:text></title>
+        <title>
+          <xsl:text>PDD Summary Report</xsl:text>
+        </title>
         <style type="text/css">
           body {
           background-color: #e6e1ce;
@@ -67,11 +70,21 @@
             </colgroup>
             <thead>
               <tr>
-                <th><xsl:text>id</xsl:text></th>
-                <th><xsl:text>ticket</xsl:text></th>
-                <th><xsl:text>body</xsl:text></th>
-                <th><xsl:text>estimate</xsl:text></th>
-                <th><xsl:text>role</xsl:text></th>
+                <th>
+                  <xsl:text>id</xsl:text>
+                </th>
+                <th>
+                  <xsl:text>ticket</xsl:text>
+                </th>
+                <th>
+                  <xsl:text>body</xsl:text>
+                </th>
+                <th>
+                  <xsl:text>estimate</xsl:text>
+                </th>
+                <th>
+                  <xsl:text>role</xsl:text>
+                </th>
               </tr>
             </thead>
             <tbody>
@@ -84,8 +97,12 @@
   </xsl:template>
   <xsl:template match="puzzle">
     <tr>
-      <td><xsl:value-of select="id"/></td>
-      <td><xsl:value-of select="ticket"/></td>
+      <td>
+        <xsl:value-of select="id"/>
+      </td>
+      <td>
+        <xsl:value-of select="ticket"/>
+      </td>
       <td>
         <code>
           <xsl:value-of select="file"/>
@@ -95,8 +112,12 @@
         <br/>
         <xsl:value-of select="body"/>
       </td>
-      <td><xsl:value-of select="estimate"/></td>
-      <td><xsl:value-of select="role"/></td>
+      <td>
+        <xsl:value-of select="estimate"/>
+      </td>
+      <td>
+        <xsl:value-of select="role"/>
+      </td>
     </tr>
   </xsl:template>
 </xsl:stylesheet>

data/bin/pdd

@@ -1,6 +1,4 @@
 #!/usr/bin/env ruby
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -25,51 +23,80 @@ STDOUT.sync = true
 
 require 'slop'
 require 'nokogiri'
+require 'rainbow'
 require_relative '../lib/pdd'
 require_relative '../lib/pdd/version'
 
-args = []
-args += File.read('.pdd').split(/\s+/).map(&:strip) if File.exist?('.pdd')
-args += ARGV
-
-opts = Slop.parse(args, strict: true, help: true) do |o|
-  o.banner = "Usage (#{PDD::VERSION}): pdd [options]"
-  o.bool '-h', '--help', 'Show these instructions'
-  o.bool '-v', '--verbose', 'Enable verbose mode'
-  o.bool '-q', '--quiet', 'Enable quiet mode'
-  o.bool '--version', 'Show current version'
-  o.string '-s', '--source', 'Source directory to parse'
-  o.string '-f', '--file', 'File to save XML into'
-  o.array '-e', '--exclude', 'Glob pattern to exclude'
-  o.string '-t', '--format', 'Format to use (xml|html)'
-  o.array '-r', '--rule', 'Rule to apply', delimiter: ';'
-end
+begin
+  args = []
+  if File.exist?('.pdd')
+    cfg = File.new('.pdd')
+    body = File.read(cfg)
+    extra = body.split(/\s+/).map(&:strip)
+    args += extra
+    puts "Found #{body.split(/\n/).length} lines in #{File.absolute_path(cfg)}"
+  end
+  args += ARGV
 
-raise '-f is mandatory when using -v' if opts.verbose? && !opts.file?
+  begin
+    opts = Slop.parse(args, strict: true, help: true) do |o|
+      o.banner = "Usage (#{PDD::VERSION}): pdd [options]"
+      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 '-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.string '-t', '--format', 'Format of the report (xml|html)'
+      o.array(
+        '-r', '--rule', 'Rule to apply (can be used many times)',
+        delimiter: ';'
+      )
+    end
+  rescue Slop::Error => ex
+    raise StandardError, "#{ex.message}, try --help"
+  end
 
-if opts.help?
-  puts opts
-  exit
-end
+  if opts.help?
+    puts opts
+    puts "This is our README to learn more: \
+https://github.com/yegor256/pdd/blob/master/README.md"
+    exit
+  end
 
-if opts.version?
-  puts PDD::VERSION
-  exit
-end
+  if opts.verbose? && !opts.file?
+    raise '-f is mandatory when using -v, try --help for more information'
+  end
 
-Encoding.default_external = Encoding::UTF_8
-Encoding.default_internal = Encoding::UTF_8
-file = opts.file? ? File.new(opts[:file], 'w') : STDOUT
-output = PDD::Base.new(opts).xml
-if opts[:format]
-  if opts[:format] == 'html'
-    xslt = File.join(
-      File.dirname(File.dirname(__FILE__)),
-      'assets', 'puzzles.xsl'
-    )
-    output = Nokogiri::XSLT(File.read(xslt)).transform(Nokogiri::XML(output))
-  elsif opts[:format] != 'xml'
-    raise 'invalid format, use html or xml'
+  Encoding.default_external = Encoding::UTF_8
+  Encoding.default_internal = Encoding::UTF_8
+  file = opts.file? ? File.new(opts[:file], 'w') : STDOUT
+  output = PDD::Base.new(opts).xml
+  if opts[:format]
+    if opts[:format] == 'html'
+      xslt = File.join(
+        File.dirname(File.dirname(__FILE__)),
+        'assets', 'puzzles.xsl'
+      )
+      output = Nokogiri::XSLT(File.read(xslt)).transform(Nokogiri::XML(output))
+    elsif opts[:format] != 'xml'
+      raise 'Invalid format, use html or xml'
+    end
   end
+  file << output
+rescue SystemExit => ex
+  puts ex.message unless ex.success?
+  exit(ex.status)
+rescue StandardError => ex
+  puts "#{Rainbow('ERROR').red}: #{ex.message}"
+  puts "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 \
+version and we will appreciate your feedback. Here is where you can find \
+more documentation: https://github.com/yegor256/pdd/blob/master/README.md."
+  exit(-1)
 end
-file << output

data/features/catches_broken_puzzles.feature

@@ -21,7 +21,7 @@ Feature: Catches Broken Puzzles
     }
     """
     When I run pdd it fails with "Space expected"
-    When I run pdd it fails with "in line #6"
+    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:
@@ -36,7 +36,7 @@ Feature: Catches Broken Puzzles
       }
     }
     """
-    When I run pdd it fails with "Too many spaces"
+    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:

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 ."
     And XML file "out.xml" matches "/puzzles[count(puzzle)=1]"
 
   Scenario: Using basic rules

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 ."
     And XML file "out.html" matches "/html/body"

data/features/step_definitions/steps.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -31,8 +29,9 @@ Before do
   @dir = Dir.mktmpdir('test')
   FileUtils.mkdir_p(@dir) unless File.exist?(@dir)
   Dir.chdir(@dir)
-  @opts = Slop.parse ['-v', '-s', @dir] do |o|
+  @opts = Slop.parse ['-q', '-s', @dir] do |o|
     o.bool '-v', '--verbose'
+    o.bool '-q', '--quiet'
     o.string '-s', '--source'
   end
 end
@@ -95,11 +94,11 @@ Then(/^XML file "([^"]+)" matches "([^"]+)"$/) do |file, xpath|
 end
 
 Then(/^Exit code is zero$/) do
-  raise "Non-zero exit code #{@exitstatus}" unless @exitstatus == 0
+  raise "Non-zero exit code #{@exitstatus}" unless @exitstatus.zero?
 end
 
 Then(/^Exit code is not zero$/) do
-  raise 'Zero exit code' if @exitstatus == 0
+  raise 'Zero exit code' if @exitstatus.zero?
 end
 
 When(/^I run bash with$/) do |text|

data/features/support/env.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/features/unicode.feature

@@ -23,5 +23,5 @@ Feature: Unicode
     \xFF test again
     """
     When I run bin/pdd with "--exclude=test.txt -v -f=/dev/null"
-    Then Stdout contains "excluding test.txt"
+    Then Stdout contains "Excluding test.txt"
     Then Exit code is zero

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 ."
     And XML file "out.xml" matches "/puzzles[count(puzzle)=1]"
 

data/lib/pdd.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -23,6 +21,7 @@
 require 'nokogiri'
 require 'logger'
 require 'time'
+require 'rainbow'
 require_relative 'pdd/sources'
 require_relative 'pdd/version'
 require_relative 'pdd/rule/estimates'
@@ -53,10 +52,14 @@ module PDD
 
   # Get logger.
   def self.log
-    unless @logger
+    unless defined?(@logger)
       @logger = Logger.new(STDOUT)
       @logger.formatter = proc { |severity, _, _, msg|
-        "#{severity}: #{msg.dump}\n"
+        if severity == 'ERROR'
+          "#{Rainbow(severity).red}: #{msg}\n"
+        else
+          "#{msg}\n"
+        end
       }
       @logger.level = Logger::ERROR
     end
@@ -75,19 +78,21 @@ module PDD
       @opts = opts
       PDD.log.level = Logger::INFO if @opts[:verbose]
       PDD.log.level = Logger::ERROR if @opts[:quiet]
-      PDD.log.info "my version is #{PDD::VERSION}"
+      PDD.log.info "My version is #{PDD::VERSION}"
       PDD.log.info "Ruby version is #{RUBY_VERSION} at #{RUBY_PLATFORM}"
     end
 
     # Generate XML.
     def xml
       dir = @opts[:source] ? @opts[:source] : Dir.pwd
-      PDD.log.info "reading #{dir}"
+      PDD.log.info "Reading #{dir}"
       sources = Sources.new(dir)
-      @opts[:exclude].each do |p|
-        sources = sources.exclude(p)
-        PDD.log.info "excluding #{p}"
-      end unless @opts[:exclude].nil?
+      unless @opts[:exclude].nil?
+        @opts[:exclude].each do |p|
+          sources = sources.exclude(p)
+          PDD.log.info "Excluding #{p}"
+        end
+      end
       sanitize(
         rules(
           Nokogiri::XML::Builder.new do |xml|
@@ -95,7 +100,7 @@ module PDD
             xml.puzzles(attrs) do
               sources.fetch.each do |source|
                 source.puzzles.each do |puzzle|
-                  PDD.log.info "puzzle #{puzzle.props[:id]} " \
+                  PDD.log.info "Puzzle #{puzzle.props[:id]} " \
                     "#{puzzle.props[:estimate]}/#{puzzle.props[:role]}" \
                     " at #{puzzle.props[:file]}"
                   render puzzle, xml
@@ -145,13 +150,13 @@ module PDD
       list.push('max-duplicates:1').map do |r|
         name, value = r.split(':')
         rule = RULES[name]
-        raise "rule '#{name}' doesn't exist" if rule.nil?
+        raise "Rule '#{name}' doesn't exist" if rule.nil?
         rule.new(doc, value).errors.each do |e|
           PDD.log.error e
           total += 1
         end
       end
-      raise PDD::Error, "#{total} errors, see log above" unless total == 0
+      raise PDD::Error, "#{total} errors, see log above" unless total.zero?
       xml
     end
 

data/lib/pdd/puzzle.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/pdd/rule/duplicates.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/pdd/rule/estimates.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -34,7 +32,7 @@ module PDD
 
         def errors
           @xml.xpath("//puzzle[number(estimate) < #{@min}]").map do |p|
-            "puzzle #{p.xpath('file/text()')}:#{p.xpath('lines/text()')}"\
+            "Puzzle #{p.xpath('file/text()')}:#{p.xpath('lines/text()')}"\
             " has an estimate of #{p.xpath('estimate/text()')} minutes,"\
             " which is lower than #{@min} minutes"
           end
@@ -52,7 +50,7 @@ module PDD
 
         def errors
           @xml.xpath("//puzzle[number(estimate) > #{@min}]").map do |p|
-            "puzzle #{p.xpath('file/text()')}:#{p.xpath('lines/text()')}"\
+            "Puzzle #{p.xpath('file/text()')}:#{p.xpath('lines/text()')}"\
             " has an estimate of #{p.xpath('estimate/text()')} minutes,"\
             " which is bigger than #{@min} minutes"
           end

data/lib/pdd/rule/roles.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/pdd/rule/text.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -36,7 +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()')}"\
+            "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"
           end.compact

data/lib/pdd/source.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -22,7 +20,6 @@
 
 require 'digest/md5'
 require 'shellwords'
-require_relative '../pdd'
 require_relative '../pdd/puzzle'
 
 module PDD
@@ -38,7 +35,7 @@ module PDD
 
     # Fetch all puzzles.
     def puzzles
-      PDD.log.info "reading #{@path}..."
+      PDD.log.info "Reading #{@path}..."
       re = %r{(.*(?:^|\s))@todo\s+#([\w\-\.:/]+)\s+(.+)}
       puzzles = []
       lines = File.readlines(@file)
@@ -47,10 +44,8 @@ module PDD
           re.match(line) do |match|
             puzzles << puzzle(lines.drop(idx + 1), match, idx)
           end
-        rescue Error => ex
-          raise Error, ["in line ##{idx + 1}", ex]
-        rescue ArgumentError => ex
-          raise Error, ["in line ##{idx + 1}", ex]
+        rescue Error, ArgumentError => ex
+          raise Error, "puzzle at line ##{idx + 1}; #{ex.message}"
         end
       end
       lines.each_with_index do |line, idx|
@@ -66,7 +61,7 @@ explains: https://github.com/yegor256/pdd#how-to-format"
 
     # Fetch puzzle
     def puzzle(lines, match, idx)
-      tail = tail(lines, match[1])
+      tail = tail(lines, match[1], idx)
       body = (match[3] + ' ' + tail.join(' ')).gsub(/\s+/, ' ').strip
       marker = marker(match[2])
       Puzzle.new(
@@ -102,35 +97,52 @@ 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)
+    def tail(lines, prefix, start)
       lines
         .take_while { |t| t.start_with?(prefix) }
         .map { |t| t[prefix.length, t.length] }
         .take_while { |t| t =~ /^[ a-zA-Z0-9]/ }
-        .each { |t| raise Error, 'Space expected' unless t.start_with?(' ') }
-        .each { |t| raise Error, 'Too many spaces' if t =~ /^\s{2,}/ }
+        .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}."
+        end
         .map { |t| t[1, t.length] }
     end
 
     # Git information at the line
     def git(pos)
-      cmd = "cd #{Shellwords.escape(File.dirname(@file))} && \
-git blame -L #{pos},#{pos} --porcelain \
-#{Shellwords.escape(File.basename(@file))}"
-      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
-      ]
+      dir = Shellwords.escape(File.dirname(@file))
+      name = Shellwords.escape(File.basename(@file))
+      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[
+          `#{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
+        ]
+      else
+        {}
+      end
     end
   end
 
@@ -148,7 +160,7 @@ git blame -L #{pos},#{pos} --porcelain \
     def puzzles
       @source.puzzles
     rescue Error => ex
-      raise Error, ["in #{@file}", ex]
+      raise Error, "#{@file}; #{ex.message}"
     end
   end
 end

data/lib/pdd/sources.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -22,7 +20,6 @@
 
 require 'shellwords'
 require 'English'
-require_relative '../pdd'
 require_relative 'source'
 
 module PDD

data/lib/pdd/version.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -25,5 +23,5 @@
 # Copyright:: Copyright (c) 2014-2017 Yegor Bugayenko
 # License:: MIT
 module PDD
-  VERSION = '0.17.9'.freeze
+  VERSION = '0.18'.freeze
 end

data/pdd.gemspec

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -20,6 +18,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+require 'English'
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require_relative 'lib/pdd/version'
@@ -35,7 +35,7 @@ Gem::Specification.new do |s|
   s.version = PDD::VERSION
   s.license = 'MIT'
   s.summary = 'Puzzle Driven Development collector'
-  s.description = 'Collects PDD puzzles from source code base'
+  s.description = 'Collects PDD puzzles from a source code base'
   s.authors = ['Yegor Bugayenko']
   s.email = 'yegor256@gmail.com'
   s.homepage = 'http://github.com/yegor256/pdd'
@@ -44,14 +44,16 @@ 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.2'
-  s.add_runtime_dependency 'slop', '~>4.4.1'
+  s.add_runtime_dependency 'nokogiri', '~>1.7'
+  s.add_runtime_dependency 'slop', '~>4.4'
+  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 'minitest', '5.5.0'
-  s.add_development_dependency 'rubocop', '0.41.2'
-  s.add_development_dependency 'rubocop-rspec', '1.5.1'
+  s.add_development_dependency 'rubocop', '0.48.1'
+  s.add_development_dependency 'rubocop-rspec', '1.15.1'
   s.add_development_dependency 'rspec-rails', '3.1.0'
+  s.add_development_dependency 'xcop', '~>0.5'
 end

data/test/test__helper.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/test/test_duplicates.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/test/test_estimates.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/test/test_pdd.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -33,7 +31,7 @@ require_relative '../lib/pdd'
 class TestPDD < Minitest::Test
   def test_basic
     Dir.mktmpdir 'test' do |dir|
-      opts = opts(['-v', '-s', dir, '-e', '**/*.png', '-r', 'max-estimate:15'])
+      opts = opts(['-q', '-s', dir, '-e', '**/*.png', '-r', 'max-estimate:15'])
       File.write(File.join(dir, 'a.txt'), '@todo #55 hello!')
       matches(
         Nokogiri::XML(PDD::Base.new(opts).xml),
@@ -50,7 +48,7 @@ class TestPDD < Minitest::Test
 
   def test_rules_failure
     Dir.mktmpdir 'test' do |dir|
-      opts = opts(['-v', '-s', dir, '-e', '**/*.png', '-r', 'min-estimate:30'])
+      opts = opts(['-q', '-s', dir, '-e', '**/*.png', '-r', 'min-estimate:30'])
       File.write(File.join(dir, 'a.txt'), '@todo #90 hello!')
       assert_raises PDD::Error do
         PDD::Base.new(opts).xml
@@ -61,21 +59,21 @@ class TestPDD < Minitest::Test
   def test_git_repo
     skip if Gem.win_platform?
     Dir.mktmpdir 'test' do |dir|
-      opts = opts(['-v', '-s', dir])
+      opts = opts(['-q', '-s', dir])
       raise unless system("
         set -e
         cd '#{dir}'
-        git init .
+        git init --quiet .
         git config user.email test@teamed.io
         git config user.name 'Mr. Tester'
         mkdir 'a long dir name'
         cd 'a long dir name'
         mkdir 'a kid'
         cd 'a kid'
-        echo '@todo #1 this is the puzzle' > '.это файл.txt'
+        echo '@todo #1 this is some puzzle' > '.это файл.txt'
         cd ../..
         git add -f .
-        git commit -am 'first version'
+        git commit --quiet -am 'first version'
       ")
       matches(
         Nokogiri::XML(PDD::Base.new(opts).xml),
@@ -96,6 +94,7 @@ class TestPDD < Minitest::Test
   def opts(args)
     Slop.parse args do |o|
       o.bool '-v', '--verbose'
+      o.bool '-q', '--quiet'
       o.string '-s', '--source'
       o.array '-e', '--exclude'
       o.array '-r', '--rule'

data/test/test_roles.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/test/test_source.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -22,6 +20,7 @@
 
 require 'minitest/autorun'
 require 'tmpdir'
+require_relative '../lib/pdd'
 require_relative '../lib/pdd/sources'
 
 # Source test.
@@ -49,6 +48,9 @@ class TestSource < Minitest::Test
       assert_equal '2-3', puzzle.props[:lines]
       assert_equal 'hello, how are you doing?', puzzle.props[:body]
       assert_equal '44', puzzle.props[:ticket]
+      assert puzzle.props[:author].nil?
+      assert puzzle.props[:email].nil?
+      assert puzzle.props[:time].nil?
     end
   end
 
@@ -119,13 +121,12 @@ class TestSource < Minitest::Test
       raise unless system("
         set -e
         cd '#{dir}'
-        git init .
+        git init --quiet .
         git config user.email test@teamed.io
         git config user.name test
         echo '@todo #1 this is the puzzle' > a.txt
         git add a.txt
-        git commit -am 'first version'
-        git blame a.txt
+        git commit --quiet -am 'first version'
       ")
       list = PDD::Source.new(File.join(dir, 'a.txt'), '').puzzles
       assert_equal 1, list.size

data/test/test_sources.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/test/test_text.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Copyright (c) 2014-2017 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdd
 version: !ruby/object:Gem::Version
-  version: 0.17.9
+  version: '0.18'
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-07 00:00:00.000000000 Z
+date: 2017-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.2
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.2
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.4.1
+        version: '4.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.4.1
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -114,28 +128,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.41.2
+        version: 0.48.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.41.2
+        version: 0.48.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 1.15.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 1.15.1
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -150,7 +164,21 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.1.0
-description: Collects PDD puzzles from source code base
+- !ruby/object:Gem::Dependency
+  name: xcop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: Collects PDD puzzles from a source code base
 email: yegor256@gmail.com
 executables:
 - pdd