pdd 0.9 → 0.10

data/features/applies_rules.feature

@@ -2,7 +2,7 @@ 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
+  Scenario: Throwing exception on big estimates
     Given I have a "Sample.java" file with content:
     """
     @todo #13:180m This puzzle has too big estimate
@@ -11,7 +11,7 @@ Feature: Applies Post-Parsing Rules
     Then Exit code is not zero
     Then Stdout contains "bigger than 90 minutes"
 
-  Scenario: Throwing exception on invalid estimate
+  Scenario: Throwing exception on small estimates
     Given I have a "Sample.java" file with content:
     """
     @todo #13:15min This puzzle has too small estimate
@@ -20,3 +20,12 @@ Feature: Applies Post-Parsing Rules
     Then Exit code is not zero
     Then Stdout contains "lower than 30 minutes"
 
+  Scenario: Throwing exception on duplicates
+    Given I have a "Sample.java" file with content:
+    """
+    @todo #13:15min The text
+    @todo #13:15min The text
+    """
+    When I run bin/pdd with ""
+    Then Exit code is not zero
+    Then Stdout contains "there are 2 duplicate"

data/features/avoiding_duplicates.feature

@@ -15,4 +15,4 @@ Feature: Avoiding Duplicate Puzzles
       }
     }
     """
-    When I run pdd it fails with "Duplicate key-sequence"
+    When I run pdd it fails with "errors, see log above"

data/features/cli.feature

@@ -39,6 +39,7 @@ Feature: Command Line Processing
     """
     When I run bin/pdd with "> out.xml"
     Then Exit code is zero
+    And Stdout is empty
     And XML file "out.xml" matches "/puzzles[count(puzzle)=1]"
 
   Scenario: Excluding unnecessary files

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} 2>&1`
+  @stdout = `ruby -I#{home}/lib #{home}/bin/pdd #{arg}`
   @exitstatus = $CHILD_STATUS.exitstatus
 end
 
@@ -82,6 +82,10 @@ Then(/^Stdout contains "([^"]*)"$/) do |txt|
   end
 end
 
+Then(/^Stdout is empty$/) do
+  fail "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)
   xml = Nokogiri::XML.parse(File.read(file))

data/features/support/env.rb

@@ -23,5 +23,3 @@
 
 require 'simplecov'
 require 'pdd'
-
-PDD.log = Logger.new(STDOUT)

data/lib/pdd.rb

@@ -25,6 +25,7 @@ require 'pdd/sources'
 require 'pdd/version'
 require 'pdd/rule/estimates'
 require 'pdd/rule/text'
+require 'pdd/rule/duplicates'
 require 'nokogiri'
 require 'logger'
 require 'time'
@@ -45,22 +46,24 @@ module PDD
   RULES = {
     'min-estimate' => PDD::Rule::Estimate::Min,
     'max-estimate' => PDD::Rule::Estimate::Max,
-    'min-words' => PDD::Rule::Text::MinWords
+    'min-words' => PDD::Rule::Text::MinWords,
+    'max-duplicates' => PDD::Rule::MaxDuplicates
   }
 
   # Get logger.
   def self.log
-    unless @log
-      @log = Logger.new(STDOUT)
-      @log.formatter = proc { |severity, _, _, msg|
-        puts "#{severity}: #{msg.dump}"
+    unless @logger
+      @logger = Logger.new(STDOUT)
+      @logger.formatter = proc { |severity, _, _, msg|
+        "#{severity}: #{msg.dump}\n"
       }
+      @logger.level = Logger::ERROR
     end
-    @log
+    @logger
   end
 
   class << self
-    attr_writer :log
+    attr_writer :logger
   end
 
   # Code base abstraction
@@ -69,7 +72,7 @@ module PDD
     # +opts+:: Options
     def initialize(opts)
       @opts = opts
-      PDD.log = Logger.new(File::NULL) unless @opts.verbose?
+      PDD.log.level = Logger::INFO if @opts.verbose?
       PDD.log.info "my version is #{PDD::VERSION}"
     end
 
@@ -82,8 +85,8 @@ module PDD
         sources = sources.exclude(p)
         PDD.log.info "excluding #{p}"
       end unless @opts[:exclude].nil?
-      rules(
-        sanitize(
+      sanitize(
+        rules(
           Nokogiri::XML::Builder.new do |xml|
             xml << "<?xml-stylesheet type='text/xsl' href='#{xsl}'?>"
             xml.puzzles(attrs) do
@@ -132,17 +135,16 @@ module PDD
     def rules(xml)
       doc = Nokogiri::XML(xml)
       total = 0
-      @opts[:rule].map do |r|
+      (@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?
         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
+      end
+      fail PDD::Error, "#{total} errors, see log above" unless total == 0
       xml
     end
 

data/lib/pdd/rule/duplicates.rb

@@ -0,0 +1,49 @@
+# 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
+    # Rule for max duplicates.
+    class MaxDuplicates
+      # Ctor.
+      # +xml+:: XML with puzzles
+      def initialize(xml, max)
+        @xml = xml
+        @max = max
+      end
+
+      def errors
+        @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"
+          end.compact
+      end
+    end
+  end
+end

data/lib/pdd/version.rb

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

data/test/test_duplicates.rb

@@ -0,0 +1,51 @@
+# 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/duplicates'
+
+# PDD::Rule::MaxDuplicates class test.
+# Author:: Yegor Bugayenko (yegor@teamed.io)
+# Copyright:: Copyright (c) 2014 Yegor Bugayenko
+# License:: MIT
+class TestMaxDuplicates < Minitest::Test
+  def test_max_duplicates
+    rule = PDD::Rule::MaxDuplicates.new(
+      Nokogiri::XML::Document.parse(
+        '<puzzles><puzzle><body>test</body></puzzle>
+        <puzzle><body>test</body></puzzle></puzzles>'
+      ), 1
+    )
+    assert !rule.errors.empty?, 'why it is empty?'
+  end
+
+  def test_max_duplicates_without_errors
+    rule = PDD::Rule::MaxDuplicates.new(
+      Nokogiri::XML::Document.parse(
+        '<puzzles><puzzle><body>hello</body></puzzle></puzzles>'
+      ), 1
+    )
+    assert rule.errors.empty?, 'it has to be empty!'
+  end
+end

data/test/test_pdd.rb

@@ -37,7 +37,7 @@ class TestPDD < Minitest::Test
       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),
+        Nokogiri::XML(PDD::Base.new(opts).xml),
         [
           '/processing-instruction("xml-stylesheet")[contains(.,".xsl")]',
           '/puzzles/@version',
@@ -53,7 +53,7 @@ class TestPDD < Minitest::Test
     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
+      assert_raises PDD::Error do
         PDD::Base.new(opts).xml
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pdd
 version: !ruby/object:Gem::Version
-  version: '0.9'
+  version: '0.10'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-04 00:00:00.000000000 Z
+date: 2014-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -222,6 +222,7 @@ files:
 - features/unicode.feature
 - lib/pdd.rb
 - lib/pdd/puzzle.rb
+- lib/pdd/rule/duplicates.rb
 - lib/pdd/rule/estimates.rb
 - lib/pdd/rule/text.rb
 - lib/pdd/source.rb
@@ -229,6 +230,7 @@ files:
 - lib/pdd/version.rb
 - pdd.gemspec
 - test/test__helper.rb
+- test/test_duplicates.rb
 - test/test_estimates.rb
 - test/test_pdd.rb
 - test/test_source.rb
@@ -272,6 +274,7 @@ test_files:
 - features/support/env.rb
 - features/unicode.feature
 - test/test__helper.rb
+- test/test_duplicates.rb
 - test/test_estimates.rb
 - test/test_pdd.rb
 - test/test_source.rb