pdd 0.15.4 → 0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 041f30911ddb1eb7abad2b403562d5aa05b77262
-  data.tar.gz: 826360d8e9696c72d30b5895becb9919aeec1a9f
+  metadata.gz: 1ccf65c43c8c73f60aacdb97b18fb0e1aa1d8a95
+  data.tar.gz: 0816acf8952b943efe05cb6f7d0bde9e80240b06
 SHA512:
-  metadata.gz: 6a16c70d4408763eb0f7883fd191c1660868a90874be1b8012b60bf68ad97ee9b0aaf0708e991ab39f6caa06f2221171e42af57ce409883a570e551b13ff7bc1
-  data.tar.gz: db964f42e3f8e699f7799ed877fd26e36807be06d5271b8fe9575af37e2480aae785c1e49897477d2e3d32c72df11fc865223e0337b18d3c56f0d9acc2f8f576
+  metadata.gz: feb1ce6850ca49b79f1f1c24450c7a3a10e457d9d61f59f7fb50a216be0f7997f22d6d293c50792267d5adb56354d9353c28d35abfc883db689f0b4bf9242e79
+  data.tar.gz: 164f86ac91279090b113b712d773bfc721b5b6f2f6b263b2ba4160301c8c564f3847a1422feb4a2f2e7e8df2fe7a3a77d2629714f91f198a19e23fa4ee4a60a7

data/.rubocop.yml

@@ -2,3 +2,5 @@ MethodLength:
   Max: 30
 Style/ClassLength:
   Max: 150
+Metrics/AbcSize:
+  Max: 37

data/.rultor.yml

@@ -1,6 +1,6 @@
 assets:
-  rubygems.yml: yegor256/home#assets/rubygems.yml
-  s3cfg: yegor256/home#assets/s3cfg
+  rubygems.yml: teamed/home#assets/rubygems.yml
+  s3cfg: teamed/home#assets/s3cfg
 install: |
   sudo apt-get update
   sudo apt-get install -y --fix-missing libmagic1 libmagic-dev

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.0.0
+  - 2.2.2
 cache: bundler
 branches:
   only:

data/README.md

@@ -1,5 +1,6 @@
 [![Made By Teamed.io](http://img.teamed.io/btn.svg)](http://www.teamed.io)
 [![DevOps By Rultor.com](http://www.rultor.com/b/teamed/pdd)](http://www.rultor.com/p/teamed/pdd)
+[![We recommend RubyMine](http://img.teamed.io/rubymine-recommend.svg)](https://www.jetbrains.com/ruby/)
 
 [![Build Status](https://travis-ci.org/teamed/pdd.svg)](https://travis-ci.org/teamed/pdd)
 [![Build status](https://ci.appveyor.com/api/projects/status/pojnoa1bp7t2ecbr?svg=true)](https://ci.appveyor.com/project/yegor256/pdd)
@@ -8,13 +9,36 @@
 [![Code Climate](http://img.shields.io/codeclimate/github/teamed/pdd.svg)](https://codeclimate.com/github/teamed/pdd)
 [![Coverage Status](https://img.shields.io/coveralls/teamed/pdd.svg)](https://coveralls.io/r/teamed/pdd)
 
-Install it first:
+## What This is for?
+
+Read this article about
+[Puzzle Driven Development](http://www.yegor256.com/2009/03/04/pdd.html).
+Check also patent application [US 12/840,306](http://www.google.com/patents/US20120023476)
+
+## How to Install?
+
+Install it first (Debian Linux):
 
 ```bash
-$ apt-get install -y libmagic1 libmagic-dev ruby-dev
+$ apt-get install -y libmagic1 libmagic-dev zlib1g-dev ruby-dev
+$ gem install pdd
+```
+
+On RedHat:
+
+```bash
+$ yum install -y libmagic1 libmagic-dev zlib1g-dev ruby-dev
+$ gem install pdd
+```
+
+On OSX and Windows, just that:
+
+```
 $ gem install pdd
 ```
 
+## How to Run?
+
 Run it locally and read its output:
 
 ```bash
@@ -43,11 +67,15 @@ Possible formats of puzzle markers:
 #678:40m/DEV
 ```
 
-Read this article about
-[Puzzle Driven Development](http://www.yegor256.com/2009/03/04/pdd.html).
-Check also patent application [US 12/840,306](http://www.google.com/patents/US20120023476)
+You can exclude certain files from the search, for example:
+
+```bash
+pdd --exclude=src/**/*.java --exclude=target/**/*
+pdd --exclude=src/**/*.java # exclude .java files in src/
+pdd --exclude=src/**/* # exclude all files in src/
+```
 
-## Rules
+## How to Configure Rules
 
 You can specify post-parsing rules for your puzzles, in command line,
 for example:
@@ -76,7 +104,5 @@ Here is a list of rules available now:
   * `max-duplicates:1` blocks more than one duplicate of any puzzle
   (this rule is used by default).
 
-## .pdd
-
 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.

data/bin/pdd

@@ -30,8 +30,8 @@ require 'pdd/version'
 require 'nokogiri'
 
 args = []
-args.push(*File.read('.pdd').split(/\s+/).map(&:strip)) if File.exist?('.pdd')
-args.push(*ARGV)
+args += File.read('.pdd').split(/\s+/).map(&:strip) if File.exist?('.pdd')
+args += ARGV
 
 opts = Slop.parse(args, strict: true, help: true) do
   banner "Usage (#{PDD::VERSION}): pdd [options]"
@@ -72,7 +72,7 @@ opts = Slop.parse(args, strict: true, help: true) do
   )
 end
 
-fail '-f is mandatory when using -v' if opts.verbose? && !opts.file?
+raise '-f is mandatory when using -v' if opts.verbose? && !opts.file?
 
 if opts.help?
   puts opts
@@ -95,8 +95,8 @@ if opts[:format]
       'assets', 'puzzles.xsl'
     )
     output = Nokogiri::XSLT(File.read(xslt)).transform(Nokogiri::XML(output))
-  else
-    fail 'invalid format, use html or xml' if opts[:format] != 'xml'
+  elsif opts[:format] != 'xml'
+    raise 'invalid format, use html or xml'
   end
 end
 file << output

data/features/step_definitions/steps.rb

@@ -46,7 +46,7 @@ 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|
-    f.write(text.gsub(/\\xFF/, "\xFF"))
+    f.write(text.gsub(/\\xFF/, 0xFF.chr))
   end
 end
 
@@ -55,7 +55,7 @@ When(/^I run pdd$/) do
 end
 
 Then(/^XML matches "([^"]+)"$/) do |xpath|
-  fail "XML doesn't match \"#{xpath}\":\n#{@xml}" if @xml.xpath(xpath).empty?
+  raise "XML doesn't match \"#{xpath}\":\n#{@xml}" if @xml.xpath(xpath).empty?
 end
 
 When(/^I run pdd it fails with "([^"]*)"$/) do |txt|
@@ -67,10 +67,10 @@ When(/^I run pdd it fails with "([^"]*)"$/) do |txt|
       raise "PDD failed but exception doesn't contain \"#{txt}\": #{ex.message}"
     end
   end
-  fail "PDD didn't fail" if passed
+  raise "PDD didn't fail" if passed
 end
 
-When(/^I run bin\/pdd with "([^"]*)"$/) do |arg|
+When(%r{^I run bin/pdd with "([^"]*)"$}) do |arg|
   home = File.join(File.dirname(__FILE__), '../..')
   @stdout = `ruby -I#{home}/lib #{home}/bin/pdd #{arg}`
   @exitstatus = $CHILD_STATUS.exitstatus
@@ -78,29 +78,29 @@ end
 
 Then(/^Stdout contains "([^"]*)"$/) do |txt|
   unless @stdout.include?(txt)
-    fail "STDOUT doesn't contain '#{txt}':\n#{@stdout}"
+    raise "STDOUT doesn't contain '#{txt}':\n#{@stdout}"
   end
 end
 
 Then(/^Stdout is empty$/) do
-  fail "STDOUT is not empty:\n#{@stdout}" unless @stdout == ''
+  raise "STDOUT is not empty:\n#{@stdout}" unless @stdout == ''
 end
 
 Then(/^XML file "([^"]+)" matches "([^"]+)"$/) do |file, xpath|
-  fail "File #{file} doesn't exit" unless File.exist?(file)
+  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?
-    fail "XML file #{file} doesn't match \"#{xpath}\":\n#{xml}"
+    raise "XML file #{file} doesn't match \"#{xpath}\":\n#{xml}"
   end
 end
 
 Then(/^Exit code is zero$/) do
-  fail "Non-zero exit code #{@exitstatus}" unless @exitstatus == 0
+  raise "Non-zero exit code #{@exitstatus}" unless @exitstatus == 0
 end
 
 Then(/^Exit code is not zero$/) do
-  fail 'Zero exit code' if @exitstatus == 0
+  raise 'Zero exit code' if @exitstatus == 0
 end
 
 When(/^I run bash with$/) do |text|

data/lib/pdd.rb

@@ -50,7 +50,7 @@ module PDD
     'min-words' => PDD::Rule::Text::MinWords,
     'max-duplicates' => PDD::Rule::MaxDuplicates,
     'available-roles' => PDD::Rule::Roles::Available
-  }
+  }.freeze
 
   # Get logger.
   def self.log
@@ -141,13 +141,13 @@ module PDD
       (@opts[:rule] || []).push('max-duplicates:1').map do |r|
         name, value = r.split(':')
         rule = RULES[name]
-        fail "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
-      fail PDD::Error, "#{total} errors, see log above" unless total == 0
+      raise PDD::Error, "#{total} errors, see log above" unless total == 0
       xml
     end
 
@@ -158,7 +158,7 @@ module PDD
       errors = xsd.validate(Nokogiri::XML(xml)).map(&:message)
       errors.each { |e| PDD.log.error e }
       PDD.log.error(xml) unless errors.empty?
-      fail SchemaError, errors.join('; ') unless errors.empty?
+      raise SchemaError, errors.join('; ') unless errors.empty?
       xml
     end
   end

data/lib/pdd/rule/duplicates.rb

@@ -33,15 +33,16 @@ module PDD
       end
 
       def errors
-        @xml.xpath('//puzzle')
+        @xml
+          .xpath('//puzzle')
           .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()')}"
-            end.join(', ') +
-            ", while maximum #{@max} duplicate is allowed"
+              puzzles.map do |p|
+                "#{p.xpath('file/text()')}:#{p.xpath('lines/text()')}"
+              end.join(', ') +
+              ", while maximum #{@max} duplicate is allowed"
           end.compact
       end
     end

data/lib/pdd/rule/roles.rb

@@ -38,13 +38,13 @@ module PDD
             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"\
-              ", while one of these roles is required: #{@roles}"
-            else
-              " defines role #{role}"\
-              ", while only these roles are allowed: #{@roles}"
-            end
+              if role.empty?
+                " doesn't define any role"\
+                ", while one of these roles is required: #{@roles}"
+              else
+                " defines role #{role}"\
+                ", while only these roles are allowed: #{@roles}"
+              end
           end.compact
         end
       end

data/lib/pdd/source.rb

@@ -38,7 +38,7 @@ module PDD
     # Fetch all puzzles.
     def puzzles
       PDD.log.info "reading #{@path}..."
-      re = /(.*(?:^|\s))@todo\s+#([\w\-\.:\/]+)\s+(.+)/
+      re = %r{(.*(?:^|\s))@todo\s+#([\w\-\.:/]+)\s+(.+)}
       puzzles = []
       lines = File.readlines(@file)
       lines.each_with_index do |line, idx|
@@ -51,8 +51,8 @@ module PDD
         end
       end
       lines.each_with_index do |line, idx|
-        fail Error, "@todo found, but puzzle can't be parsed in line ##{idx}" \
-          if /.*(^|\s)@todo\s+[^#]/.match(line)
+        raise Error, "@todo found, but puzzle can't be parsed in line ##{idx}" \
+          if line =~ /.*(^|\s)@todo\s+[^#]/
       end
       puzzles
     end
@@ -76,9 +76,9 @@ module PDD
 
     # Parse a marker.
     def marker(text)
-      re = /([\w\d\-\.]+)(?::(\d+)(?:(m|h)[a-z]*)?)?(?:\/([A-Z]+))?/
+      re = %r{([\w\d\-\.]+)(?::(\d+)(?:(m|h)[a-z]*)?)?(?:/([A-Z]+))?}
       match = re.match(text)
-      fail "invalid puzzle marker: #{text}" if match.nil?
+      raise "invalid puzzle marker: #{text}" if match.nil?
       {
         ticket: match[1],
         estimate: minutes(match[2], match[3]),
@@ -96,12 +96,12 @@ module PDD
     # Fetch puzzle tail (all lines after the first one)
     def tail(lines, prefix)
       lines
-        .take_while { |txt| txt.start_with?(prefix) }
-        .map { |txt| txt[prefix.length, txt.length] }
-        .take_while { |txt| txt =~ /^[ a-zA-Z0-9]/ }
-        .each { |txt| fail Error, 'Space expected' unless txt.start_with?(' ') }
-        .each { |txt| fail Error, 'Too many spaces' if txt =~ /^\s{2,}/ }
-        .map { |txt| txt[1, txt.length] }
+        .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,}/ }
+        .map { |t| t[1, t.length] }
     end
 
     # Git information at the line

data/lib/pdd/sources.rb

@@ -46,7 +46,7 @@ module PDD
         end
       end.to_a
       PDD.log.info "#{files.size} file(s) found"
-      types = [/^text\//, /application\/xml/]
+      types = [%r{^text/}, %r{application/xml}]
       files
         .select { |f| types.index { |re| @magic.file(f) =~ re } }
         .map do |file|

data/lib/pdd/version.rb

@@ -26,5 +26,5 @@
 # Copyright:: Copyright (c) 2014-2016 Yegor Bugayenko
 # License:: MIT
 module PDD
-  VERSION = '0.15.4'
+  VERSION = '0.16'.freeze
 end

data/pdd.gemspec

@@ -41,19 +41,19 @@ Gem::Specification.new do |s|
   s.email = 'yegor@teamed.io'
   s.homepage = 'http://github.com/teamed/pdd'
   s.files = `git ls-files`.split($RS)
-  s.executables = s.files.grep(/^bin\//) { |f| File.basename(f) }
-  s.test_files = s.files.grep(/^(test|spec|features)\//)
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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.6.7.1'
-  s.add_runtime_dependency 'ruby-filemagic', '0.7.1'
-  s.add_runtime_dependency 'slop', '3.6.0'
-  s.add_runtime_dependency 'rake', '10.4.2'
+  s.add_runtime_dependency 'nokogiri', '~>1.6'
+  s.add_runtime_dependency 'ruby-filemagic', '~>0.7'
+  s.add_runtime_dependency 'slop', '~>3.6'
+  s.add_development_dependency 'rake', '10.5.0'
   s.add_development_dependency 'coveralls', '0.7.2'
   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.24.1'
-  s.add_development_dependency 'rubocop-rspec', '1.2.1'
+  s.add_development_dependency 'rubocop', '0.41.2'
+  s.add_development_dependency 'rubocop-rspec', '1.5.1'
   s.add_development_dependency 'rspec-rails', '3.1.0'
 end

data/test/test_pdd.rb

@@ -63,7 +63,7 @@ class TestPDD < Minitest::Test
     skip if Gem.win_platform?
     Dir.mktmpdir 'test' do |dir|
       opts = opts(['-v', '-s', dir])
-      fail unless system("
+      raise unless system("
         set -e
         cd '#{dir}'
         git init .
@@ -100,7 +100,7 @@ class TestPDD < Minitest::Test
 
   def matches(xml, xpaths)
     xpaths.each do |xpath|
-      fail "doesn't match '#{xpath}': #{xml}" unless xml.xpath(xpath).size == 1
+      raise "doesn't match '#{xpath}': #{xml}" unless xml.xpath(xpath).size == 1
     end
   end
 end

data/test/test_source.rb

@@ -90,7 +90,7 @@ class TestSource < Minitest::Test
     skip if Gem.win_platform?
     Dir.mktmpdir 'test' do |dir|
       file = File.join(dir, 'xx.txt')
-      File.write(file, " * @todo #44 this is a broken unicode: \x92")
+      File.write(file, ' * @todo #44 this is a broken unicode: ' + 0x92.chr)
       assert_raises PDD::Error do
         PDD::VerboseSource.new(file, PDD::Source.new(file, 'xx')).puzzles
       end
@@ -117,7 +117,7 @@ class TestSource < Minitest::Test
   def test_reads_git_author
     skip if Gem.win_platform?
     Dir.mktmpdir 'test' do |dir|
-      fail unless system("
+      raise unless system("
         set -e
         cd '#{dir}'
         git init .

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: pdd
 version: !ruby/object:Gem::Version
-  version: 0.15.4
+  version: '0.16'
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-07 00:00:00.000000000 Z
+date: 2016-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.7.1
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.7.1
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: ruby-filemagic
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: '3.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 10.4.2
-  type: :runtime
+        version: 10.5.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: 10.5.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -128,28 +128,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.24.1
+        version: 0.41.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.24.1
+        version: 0.41.2
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement