pdd 0.3 → 0.4

data/.rultor.yml

@@ -8,7 +8,7 @@ release:
     - "sudo bundle install"
     - "rake"
     - "rm -rf *.gem"
-    - "sed -i \"s/1\\.0\\.snapshot/${tag}/g\" pdd.gemspec"
+    - "sed -i \"s/1\\.0\\.snapshot/${tag}/g\" lib/pdd/version.rb"
     - "gem build pdd.gemspec"
     - "chmod 0600 ../rubygems.yml"
     - "gem push *.gem --config-file ../rubygems.yml"

data/asserts/puzzles.xsd

@@ -73,6 +73,8 @@
       <xs:sequence>
         <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" />

data/bin/pdd

@@ -26,10 +26,10 @@ STDOUT.sync = true
 
 require 'pdd'
 require 'slop'
+require 'pdd/version'
 
-opts = Slop.parse do
-  banner 'Usage: pdd [options]'
-  on 'h', 'help', 'Print this page'
+opts = Slop.parse(ARGV, strict: true, help: true) do
+  banner "Usage (#{PDD::VERSION}): pdd [options]"
   on 'v', 'verbose', 'Enable verbose mode'
   on 's', 'source', 'Source directory to parse', argument: :required
   on 'f', 'file', 'File to save XML into', argument: :required

data/features/cli.feature

@@ -5,7 +5,7 @@ Feature: Command Line Processing
   Scenario: Help can be printed
     When I run bin/pdd with "-h"
     Then Exit code is zero
-    And Stdout contains "Usage: pdd"
+    And Stdout contains "-v, --verbose"
 
   Scenario: Simple puzzles collecting
     Given I have a "Sample.java" file with content:
@@ -36,3 +36,23 @@ Feature: Command Line Processing
     When I run bin/pdd with "> out.xml"
     Then Exit code is zero
     And XML file "out.xml" matches "/puzzles[count(puzzle)=1]"
+
+  Scenario: Excluding unnecessary files
+    Given 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
+    """
+    When I run bin/pdd with "-e **/*.md --exclude **/*.txt > out.xml"
+    Then Exit code is zero
+    And XML file "out.xml" matches "/puzzles[count(puzzle)=0]"
+
+  Scenario: Rejects unknown options
+    Given I have a "test.txt" file with content:
+    """
+    """
+    When I run bin/pdd with "--some-unknown-option"
+    Then Exit code is not zero

data/features/step_definitions/steps.rb

@@ -91,3 +91,7 @@ end
 Then(/^Exit code is zero$/) do
   fail "Non-zero exit code #{@exitstatus}" unless @exitstatus == 0
 end
+
+Then(/^Exit code is not zero$/) do
+  fail 'Zero exit code' if @exitstatus == 0
+end

data/lib/pdd.rb

@@ -22,8 +22,10 @@
 # SOFTWARE.
 
 require 'pdd/sources'
+require 'pdd/version'
 require 'nokogiri'
 require 'logger'
+require 'time'
 
 # PDD main module.
 # Author:: Yegor Bugayenko (yegor@teamed.io)
@@ -60,6 +62,7 @@ module PDD
     def initialize(opts)
       @opts = opts
       PDD.log = Logger.new(File::NULL) unless @opts.verbose?
+      PDD.log.info "my version is #{PDD::VERSION}"
     end
 
     # Generate XML.
@@ -74,7 +77,7 @@ module PDD
       sanitize(
         Nokogiri::XML::Builder.new do |xml|
           xml << '<?xml-stylesheet type="text/xsl" href="puzzles.xsl"?>'
-          xml.puzzles do
+          xml.puzzles(version: PDD::VERSION, date: Time.now.utc.iso8601) do
             sources.fetch.each do |source|
               source.puzzles.each do |puzzle|
                 PDD.log.info "puzzle #{puzzle.props[:ticket]}:" \
@@ -105,6 +108,7 @@ module PDD
       )
       errors = xsd.validate(Nokogiri::XML(xml)).map { |error| error.message }
       errors.each { |e| PDD.log.error e }
+      PDD.log.error(xml) unless errors.empty?
       fail SchemaError, errors.join('; ') unless errors.empty?
       xml
     end

data/lib/pdd/version.rb

@@ -0,0 +1,30 @@
+# 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.
+
+# PDD main module.
+# Author:: Yegor Bugayenko (yegor@teamed.io)
+# Copyright:: Copyright (c) 2014 Yegor Bugayenko
+# License:: MIT
+module PDD
+  VERSION = '0.4'
+end

data/pdd.gemspec

@@ -21,6 +21,10 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pdd/version'
+
 Gem::Specification.new do |s|
   s.specification_version = 2 if s.respond_to? :specification_version=
   if s.respond_to? :required_rubygems_version=
@@ -29,7 +33,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = '2.2.2'
   s.required_ruby_version = '>= 1.9.3'
   s.name = 'pdd'
-  s.version = '0.3'
+  s.version = PDD::VERSION
   s.license = 'MIT'
   s.summary = 'Puzzle Driven Development collector'
   s.description = 'Collects puzzles from source code base'

data/test/test_pdd.rb

@@ -41,6 +41,7 @@ class TestPDD < Minitest::Test
       end
       File.write(File.join(dir, 'a.txt'), '@todo #55 hello!')
       xml = Nokogiri::XML::Document.parse(PDD::Base.new(opts).xml)
+      assert_equal 1, xml.xpath('/puzzles/@version').size
       assert_equal 1, xml.xpath('/puzzles/puzzle[file="a.txt"]').size
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pdd
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
   prerelease: 
 platform: ruby
 authors:
@@ -260,6 +260,7 @@ files:
 - lib/pdd/puzzle.rb
 - lib/pdd/source.rb
 - lib/pdd/sources.rb
+- lib/pdd/version.rb
 - pdd.gemspec
 - test/test_helper.rb
 - test/test_pdd.rb