pdd 0.2.3 → 0.3

data/README.md

@@ -12,10 +12,10 @@ Install it first:
 gem install pdd
 ```
 
-Run it locally:
+Run it locally and read its output:
 
 ```bash
-pdd
+pdd --help
 ```
 
 Every puzzle has to be formatted like this:
@@ -35,7 +35,8 @@ Possible formats of puzzle markers:
 #TEST-13
 #55:45min
 #67/DES
+#678:40m/DEV
 ```
 
 Read this article about
-[Puzzle Drive Development](http://www.xdsd.org/2009/03/04/pdd.html).
+[Puzzle Drive Development](http://www.yegor256.com/2009/03/04/pdd.html).

data/Rakefile

@@ -24,6 +24,9 @@
 require 'rubygems'
 require 'rake'
 require 'rdoc'
+require 'rake/clean'
+
+CLEAN = FileList['coverage', 'rdoc']
 
 def name
   @name ||= File.basename(Dir['*.gemspec'].first, '.*')
@@ -33,14 +36,14 @@ def version
   Gem::Specification.load(Dir['*.gemspec'].first).version
 end
 
-task default: [:test, :features, :rubocop]
+task default: [:clean, :test, :features, :rubocop]
 
 require 'rake/testtask'
 desc 'Run all unit tests'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
   test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+  test.verbose = false
 end
 
 require 'rdoc/task'

data/bin/pdd

@@ -33,6 +33,7 @@ opts = Slop.parse do
   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
+  on 'e', 'exclude', 'Glob pattern to exclude', as: Array, argument: :required
 end
 
 fail '-f is mandatory when using -v' if opts.verbose? && !opts.file?

data/lib/pdd.rb

@@ -66,11 +66,16 @@ module PDD
     def xml
       dir = @opts.source? ? @opts[:source] : Dir.pwd
       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?
       sanitize(
         Nokogiri::XML::Builder.new do |xml|
           xml << '<?xml-stylesheet type="text/xsl" href="puzzles.xsl"?>'
           xml.puzzles do
-            Sources.new(dir).fetch.each do |source|
+            sources.fetch.each do |source|
               source.puzzles.each do |puzzle|
                 PDD.log.info "puzzle #{puzzle.props[:ticket]}:" \
                   "#{puzzle.props[:estimate]}/#{puzzle.props[:role]}" \

data/lib/pdd/sources.rb

@@ -23,25 +23,38 @@
 
 require 'filemagic'
 require 'pdd/source'
+require 'rake/file_list'
 
 module PDD
   # Code base abstraction
   class Sources
     # Ctor.
     # +dir+:: Directory with source code files
-    def initialize(dir)
+    def initialize(dir, ptns = [])
       @dir = dir
+      @exclude = ptns
       @magic = FileMagic.new(FileMagic::MAGIC_MIME)
     end
 
     # Fetch all sources.
     def fetch
+      files = Rake::FileList.new(@dir + '/**/*') do |list|
+        @exclude.each do |ptn|
+          Rake::FileList.new(@dir + '/' + ptn).each do |f|
+            list.exclude(f)
+          end
+        end
+      end
       types = [/^text\//, /application\/xml/]
-      Dir.glob(@dir + '/**/*')
+      files.to_a
         .select { |f| types.index { |re| @magic.file(f) =~ re } }
         .map do |file|
           Source.new(file, file[@dir.length + 1, file.length])
         end
     end
+
+    def exclude(ptn)
+      Sources.new(@dir, @exclude.push(ptn))
+    end
   end
 end

data/pdd.gemspec

@@ -29,7 +29,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.2.3'
+  s.version = '0.3'
   s.license = 'MIT'
   s.summary = 'Puzzle Driven Development collector'
   s.description = 'Collects puzzles from source code base'
@@ -44,7 +44,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'nokogiri', '~> 1.6', '>= 1.6.3.1'
   s.add_runtime_dependency 'ruby-filemagic', '~> 0.6', '>= 0.6.0'
   s.add_runtime_dependency 'slop', '~> 3.6', '>= 3.6.0'
-  s.add_development_dependency 'rake', '~> 10.1'
+  s.add_runtime_dependency 'rake', '~> 10.1'
   s.add_development_dependency 'coveralls', '~> 0.7', '>= 0.7.0'
   s.add_development_dependency 'rdoc', '~> 3.11'
   s.add_development_dependency 'cucumber', '1.3.11'

data/test/test_pdd.rb

@@ -34,9 +34,10 @@ require 'slop'
 class TestPDD < Minitest::Test
   def test_basic
     Dir.mktmpdir 'test' do |dir|
-      opts = Slop.parse ['-v', '-s', dir] do
+      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
       File.write(File.join(dir, 'a.txt'), '@todo #55 hello!')
       xml = Nokogiri::XML::Document.parse(PDD::Base.new(opts).xml)

data/test/test_sources.rb

@@ -31,18 +31,14 @@ require 'tmpdir'
 # License:: MIT
 class TestSources < Minitest::Test
   def test_iterator
-    Dir.mktmpdir 'test' do |dir|
-      File.write(File.join(dir, 'a.txt'), '@todo hello!')
-      Dir.mkdir(File.join(dir, 'b'))
-      File.write(File.join(dir, 'b/c.txt'), 'hello, again')
+    in_temp(['a.txt', 'b/c.txt']) do |dir|
       list = PDD::Sources.new(dir).fetch
       assert_equal 2, list.size
     end
   end
 
   def test_ignores_binary_files
-    Dir.mktmpdir 'test' do |dir|
-      File.write(File.join(dir, 'c'), 'how are you?')
+    in_temp(['c', 'd.png']) do |dir|
       File.write(File.join(dir, 'd.png'), '')
       list = PDD::Sources.new(dir).fetch
       assert_equal 1, list.size
@@ -50,7 +46,7 @@ class TestSources < Minitest::Test
   end
 
   def test_detects_all_text_files
-    Dir.mktmpdir 'test' do |dir|
+    in_temp([]) do |dir|
       exts = %w[(xsl java rb cpp apt)]
       exts.each do |ext|
         File.write(File.join(dir, "test.#{ext}"), 'text')
@@ -61,10 +57,28 @@ class TestSources < Minitest::Test
   end
 
   def test_detects_xml_file
-    Dir.mktmpdir 'test' do |dir|
+    in_temp(['a.xml']) do |dir|
       File.write(File.join(dir, 'a.xml'), '<?xml version="1.0"?><hello/>')
       list = PDD::Sources.new(dir).fetch
       assert_equal 1, list.size
     end
   end
+
+  def test_excludes_by_pattern
+    in_temp(['a/first.txt', 'b/c/d/second.txt']) do |dir|
+      list = PDD::Sources.new(dir).exclude('b/c/d/second.txt').fetch
+      assert_equal 1, list.size
+    end
+  end
+
+  def in_temp(files)
+    Dir.mktmpdir 'x' do |dir|
+      files.each do |path|
+        file = File.join(dir, path)
+        FileUtils.mkdir_p(File.dirname(file))
+        File.write(file, 'some test content')
+      end
+      yield dir
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pdd
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: '0.3'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-11 00:00:00.000000000 Z
+date: 2014-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -85,7 +85,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.1'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false