pdd 0.8 → 0.9

data/Rakefile

@@ -26,8 +26,6 @@ require 'rake'
 require 'rdoc'
 require 'rake/clean'
 
-CLEAN = FileList['coverage', 'rdoc']
-
 def name
   @name ||= File.basename(Dir['*.gemspec'].first, '.*')
 end
@@ -41,6 +39,7 @@ task default: [:clean, :test, :features, :rubocop]
 require 'rake/testtask'
 desc 'Run all unit tests'
 Rake::TestTask.new(:test) do |test|
+  Rake::Cleaner.cleanup_files(['coverage'])
   test.libs << 'lib' << 'test'
   test.pattern = 'test/**/test_*.rb'
   test.verbose = false
@@ -64,6 +63,7 @@ end
 
 require 'cucumber/rake/task'
 Cucumber::Rake::Task.new(:features) do |t|
+  Rake::Cleaner.cleanup_files(['coverage'])
   t.profile = 'travis'
 end
 Cucumber::Rake::Task.new(:"features:html") do |t|

data/bin/pdd

@@ -37,6 +37,7 @@ opts = Slop.parse(ARGV, strict: true, help: true) do
   on 'f', 'file', 'File to save XML into', argument: :required
   on 'e', 'exclude', 'Glob pattern to exclude', as: Array, argument: :required
   on 't', 'format', 'Format to use (xml|html)', argument: :required
+  on 'r', 'rule', 'Format to use (xml|html)', argument: :required, as: Array
 end
 
 fail '-f is mandatory when using -v' if opts.verbose? && !opts.file?

data/features/applies_rules.feature

@@ -0,0 +1,22 @@
+Feature: Applies Post-Parsing Rules
+  As a source code writer I want to be sure that
+  certain post-parsing rules are applied
+
+  Scenario: Throwing exception on invalid estimate
+    Given I have a "Sample.java" file with content:
+    """
+    @todo #13:180m This puzzle has too big estimate
+    """
+    When I run bin/pdd with "--rule=max-estimate:90"
+    Then Exit code is not zero
+    Then Stdout contains "bigger than 90 minutes"
+
+  Scenario: Throwing exception on invalid estimate
+    Given I have a "Sample.java" file with content:
+    """
+    @todo #13:15min This puzzle has too small estimate
+    """
+    When I run bin/pdd with "--rule=min-estimate:30"
+    Then Exit code is not zero
+    Then Stdout contains "lower than 30 minutes"
+

data/features/step_definitions/steps.rb

@@ -72,7 +72,7 @@ end
 
 When(/^I run bin\/pdd with "([^"]*)"$/) do |arg|
   home = File.join(File.dirname(__FILE__), '../..')
-  @stdout = `ruby -I#{home}/lib #{home}/bin/pdd #{arg}`
+  @stdout = `ruby -I#{home}/lib #{home}/bin/pdd #{arg} 2>&1`
   @exitstatus = $CHILD_STATUS.exitstatus
 end
 

data/lib/pdd.rb

@@ -23,6 +23,8 @@
 
 require 'pdd/sources'
 require 'pdd/version'
+require 'pdd/rule/estimates'
+require 'pdd/rule/text'
 require 'nokogiri'
 require 'logger'
 require 'time'
@@ -40,6 +42,12 @@ module PDD
   class SchemaError < Error
   end
 
+  RULES = {
+    'min-estimate' => PDD::Rule::Estimate::Min,
+    'max-estimate' => PDD::Rule::Estimate::Max,
+    'min-words' => PDD::Rule::Text::MinWords
+  }
+
   # Get logger.
   def self.log
     unless @log
@@ -74,20 +82,22 @@ module PDD
         sources = sources.exclude(p)
         PDD.log.info "excluding #{p}"
       end unless @opts[:exclude].nil?
-      sanitize(
-        Nokogiri::XML::Builder.new do |xml|
-          xml << "<?xml-stylesheet type='text/xsl' href='#{xsl}'?>"
-          xml.puzzles(attrs) do
-            sources.fetch.each do |source|
-              source.puzzles.each do |puzzle|
-                PDD.log.info "puzzle #{puzzle.props[:ticket]}:" \
-                  "#{puzzle.props[:estimate]}/#{puzzle.props[:role]}" \
-                  " at #{puzzle.props[:file]}"
-                render puzzle, xml
+      rules(
+        sanitize(
+          Nokogiri::XML::Builder.new do |xml|
+            xml << "<?xml-stylesheet type='text/xsl' href='#{xsl}'?>"
+            xml.puzzles(attrs) do
+              sources.fetch.each do |source|
+                source.puzzles.each do |puzzle|
+                  PDD.log.info "puzzle #{puzzle.props[:ticket]}:" \
+                    "#{puzzle.props[:estimate]}/#{puzzle.props[:role]}" \
+                    " at #{puzzle.props[:file]}"
+                  render puzzle, xml
+                end
               end
             end
-          end
-        end.to_xml
+          end.to_xml
+        )
       )
     end
 
@@ -119,6 +129,23 @@ module PDD
       end
     end
 
+    def rules(xml)
+      doc = Nokogiri::XML(xml)
+      total = 0
+      @opts[:rule].map do |r|
+        name, value = r.split(':')
+        rule = RULES[name]
+        fail "rule '#{name}' doesn't exist" if rule.nil?
+        rule.new(doc, value.to_i).errors.each do |e|
+          puts e
+          PDD.log.error e
+          total += 1
+        end
+      end unless @opts[:rule].nil?
+      fail "#{total} errors, see log above" unless total == 0
+      xml
+    end
+
     def sanitize(xml)
       xsd = Nokogiri::XML::Schema(
         File.read(File.join(File.dirname(__FILE__), '../assets/puzzles.xsd'))

data/lib/pdd/rule/estimates.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+#
+# Copyright (c) 2014 TechnoPark Corp.
+# Copyright (c) 2014 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.
+
+module PDD
+  module Rule
+    module Estimate
+      # Rule for min estimate.
+      class Min
+        # Ctor.
+        # +xml+:: XML with puzzles
+        def initialize(xml, min)
+          @xml = xml
+          @min = min
+        end
+
+        def errors
+          @xml.xpath("//puzzle[number(estimate) < #{@min}]").map do |p|
+            "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
+        end
+      end
+
+      # Rule for max estimate.
+      class Max
+        # Ctor.
+        # +xml+:: XML with puzzles
+        def initialize(xml, min)
+          @xml = xml
+          @min = min
+        end
+
+        def errors
+          @xml.xpath("//puzzle[number(estimate) > #{@min}]").map do |p|
+            "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
+        end
+      end
+    end
+  end
+end

data/lib/pdd/rule/text.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+#
+# Copyright (c) 2014 TechnoPark Corp.
+# Copyright (c) 2014 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.
+
+module PDD
+  module Rule
+    module Text
+      # Rule for minimum length of description.
+      class MinWords
+        # Ctor.
+        # +xml+:: XML with puzzles
+        def initialize(xml, min)
+          @xml = xml
+          @min = min
+        end
+
+        def errors
+          @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"
+          end.compact
+        end
+      end
+    end
+  end
+end

data/lib/pdd/source.rb

@@ -75,7 +75,7 @@ module PDD
       rescue Error => ex
         raise Error, "#{ex.message} in line ##{idx}"
       end
-      body = (match[3] + ' ' + tail.join(' ')).gsub(/\s+/, ' ').strip
+      body = (match[3] + ' ' + tail.join(' ')).gsub(/[\s\n\t]+/, ' ').strip
       Puzzle.new(
         marker(match[2]).merge(
           lines: "#{idx + 1}-#{idx + tail.size + 1}",

data/lib/pdd/version.rb

@@ -26,5 +26,5 @@
 # Copyright:: Copyright (c) 2014 Yegor Bugayenko
 # License:: MIT
 module PDD
-  VERSION = '0.8'
+  VERSION = '0.9'
 end

data/test/{test_helper.rb → test__helper.rb}

@@ -23,3 +23,4 @@
 
 require 'simplecov'
 require 'pdd'
+require 'minitest/autorun'

data/test/test_estimates.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+#
+# Copyright (c) 2014 TechnoPark Corp.
+# Copyright (c) 2014 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 'nokogiri'
+require 'pdd/rule/estimates'
+
+# PDD::Rule::Estimate module tests.
+# Author:: Yegor Bugayenko (yegor@teamed.io)
+# Copyright:: Copyright (c) 2014 Yegor Bugayenko
+# License:: MIT
+class TestEstimates < Minitest::Test
+  def test_min
+    rule = PDD::Rule::Estimate::Min.new(
+      Nokogiri::XML::Document.parse(
+        '<puzzles><puzzle><estimate>15</estimate></puzzle></puzzles>'
+      ), 30
+    )
+    assert !rule.errors.empty?, 'why it is empty?'
+  end
+
+  def test_max
+    rule = PDD::Rule::Estimate::Max.new(
+      Nokogiri::XML::Document.parse(
+        '<puzzles><puzzle><estimate>30</estimate></puzzle></puzzles>'
+      ), 15
+    )
+    assert !rule.errors.empty?, 'why it is empty?'
+  end
+end

data/test/test_pdd.rb

@@ -34,11 +34,7 @@ require 'slop'
 class TestPDD < Minitest::Test
   def test_basic
     Dir.mktmpdir 'test' do |dir|
-      opts = Slop.parse ['-v', '-s', dir, '-e', '**/*.png'] do
-        on 'v', 'verbose'
-        on 's', 'source', argument: :required
-        on 'e', 'exclude', as: Array, argument: :required
-      end
+      opts = opts(['-v', '-s', dir, '-e', '**/*.png', '-r', 'max-estimate:15'])
       File.write(File.join(dir, 'a.txt'), '@todo #55 hello!')
       matches(
         Nokogiri::XML::Document.parse(PDD::Base.new(opts).xml),
@@ -53,6 +49,25 @@ class TestPDD < Minitest::Test
     end
   end
 
+  def test_rules_failure
+    Dir.mktmpdir 'test' do |dir|
+      opts = opts(['-v', '-s', dir, '-e', '**/*.png', '-r', 'min-estimate:30'])
+      File.write(File.join(dir, 'a.txt'), '@todo #90 hello!')
+      assert_raises RuntimeError do
+        PDD::Base.new(opts).xml
+      end
+    end
+  end
+
+  def opts(args)
+    Slop.parse args do
+      on 'v', 'verbose'
+      on 's', 'source', argument: :required
+      on 'e', 'exclude', as: Array, argument: :required
+      on 'r', 'rule', as: Array, argument: :required
+    end
+  end
+
   def matches(xml, xpaths)
     xpaths.each do |xpath|
       fail "doesn't match '#{xpath}': #{xml}" unless xml.xpath(xpath).size == 1

data/test/test_text.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+#
+# Copyright (c) 2014 TechnoPark Corp.
+# Copyright (c) 2014 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 'nokogiri'
+require 'pdd/rule/text'
+
+# PDD::Rule::Text module tests.
+# Author:: Yegor Bugayenko (yegor@teamed.io)
+# Copyright:: Copyright (c) 2014 Yegor Bugayenko
+# License:: MIT
+class TestText < Minitest::Test
+  def test_min_words
+    rule = PDD::Rule::Text::MinWords.new(
+      Nokogiri::XML::Document.parse(
+        '<puzzles><puzzle><body>short text</body></puzzle>
+        <puzzle><body>body with four words</body></puzzle></puzzles>'
+      ), 4
+    )
+    assert rule.errors.size == 1
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pdd
 version: !ruby/object:Gem::Version
-  version: '0.8'
+  version: '0.9'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-02 00:00:00.000000000 Z
+date: 2014-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -210,6 +210,7 @@ files:
 - assets/puzzles.xsl
 - bin/pdd
 - cucumber.yml
+- features/applies_rules.feature
 - features/avoiding_duplicates.feature
 - features/catches_broken_puzzles.feature
 - features/cli.feature
@@ -221,14 +222,18 @@ files:
 - features/unicode.feature
 - lib/pdd.rb
 - lib/pdd/puzzle.rb
+- lib/pdd/rule/estimates.rb
+- lib/pdd/rule/text.rb
 - lib/pdd/source.rb
 - lib/pdd/sources.rb
 - lib/pdd/version.rb
 - pdd.gemspec
-- test/test_helper.rb
+- test/test__helper.rb
+- test/test_estimates.rb
 - test/test_pdd.rb
 - test/test_source.rb
 - test/test_sources.rb
+- test/test_text.rb
 homepage: http://github.com/teamed/pdd
 licenses:
 - MIT
@@ -256,6 +261,7 @@ signing_key:
 specification_version: 2
 summary: Puzzle Driven Development collector
 test_files:
+- features/applies_rules.feature
 - features/avoiding_duplicates.feature
 - features/catches_broken_puzzles.feature
 - features/cli.feature
@@ -265,7 +271,9 @@ test_files:
 - features/step_definitions/steps.rb
 - features/support/env.rb
 - features/unicode.feature
-- test/test_helper.rb
+- test/test__helper.rb
+- test/test_estimates.rb
 - test/test_pdd.rb
 - test/test_source.rb
 - test/test_sources.rb
+- test/test_text.rb