pdd 0.20.7 → 0.20.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8220e74b7aca6e6feddfe8ccad195c1156386ad766ae1dd31311122242c1292c
-  data.tar.gz: 97816bbe7fdfdb29d595683dd98b6eb41d6bc1880e269c4dc11eee4a2b02f582
+  metadata.gz: e3ff37e6f0ac2629e0b31888df2b56f7024512b04b07bd58c29a0525186a40f0
+  data.tar.gz: 61076844123f2eda0b32734b2c917ed6eb033956177197626219bda878add5b5
 SHA512:
-  metadata.gz: c4128efeb2b302351595bbe99978845e8d8d546f11e341c0d0308821e673f6f2aa2730c4d2170751d711892d17942563275641b8dbec04916d9bb7bac8715f2a
-  data.tar.gz: 501ddaf76735e9ce50ae3a233c45331d568075979ef3875395e7d361139e008954de9767e14856af7d247adf2a597254b3e89104cc96e5832baa03a278f89a3c
+  metadata.gz: e9b46c3238588062c781b1b3705cf343d1ca0e70481b2546ffc407b9a5be6534d45b3c8d0d4ebaab0ac39630ebfc6652feb8c69a8dd8d787bf33eae1a9cb0935
+  data.tar.gz: 790b7d73f1b7ea5d2666864b238dfdde211572186d3d84c29a6d6448936b54ef87a567473b83fccfad83ec945ad6f9677a739b0730fde5199618dc79f6cc9ead

data/.gitignore

@@ -1,8 +1,8 @@
-coverage/
+coverage/**/*
 Gemfile.lock
-.idea/
+.idea/**/*
 *.gem
-.bundle/
+.bundle/**/*
 .DS_Store
-rdoc/
-tmp/
+rdoc/**/*
+tmp/**/*

data/.overcommit.yml

@@ -0,0 +1,96 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/sds/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/sds/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/sds/overcommit#configuration
+
+PreCommit:
+  ALL:
+    problem_on_unmodified_line: report
+    requires_files: true
+    required: false
+    quiet: false
+
+  AuthorEmail:
+    enabled: true
+    description: 'Check author email'
+    requires_files: false
+    required: true
+    quiet: true
+    pattern: '^[^@]+@.*$'
+
+  AuthorName:
+    enabled: true
+    description: 'Check for author name'
+    requires_files: false
+    required: true
+    quiet: true
+
+  BundleCheck:
+    enabled: true
+    description: 'Check Gemfile dependencies'
+    required_executable: 'bundle'
+    flags: ['check']
+    include:
+      - 'Gemfile'
+      - 'Gemfile.lock'
+      - '*.gemspec'
+
+  BundleOutdated:
+    enabled: true
+    description: 'List installed gems with newer versions available'
+    required_executable: 'bundle'
+    flags: ['outdated', '--strict', '--parseable']
+
+  RuboCop:
+    enabled: true
+    description: 'Analyze with RuboCop'
+    required_executable: 'bundle'
+    flags: ['exec', 'rubocop']
+
+# Hooks that are run against every commit message after a user has written it.
+# These hooks are useful for enforcing policies on commit messages written for a
+# project.
+CommitMsg:
+  ALL:
+    requires_files: false
+    quiet: false
+
+  EmptyMessage:
+    enabled: true
+    description: 'Check for empty commit message'
+    quiet: true
+
+  MessageFormat:
+    enabled: true
+    description: 'Check commit message matches expected pattern'
+    pattern: '(\[#)(.+)(\]\s)(.+)'
+    expected_pattern_message: '[#<Issue Id>] <Commit Message Description>'
+    sample_message: '[#167] Refactored onboarding flow'
+
+PrePush:
+  ALL:
+    requires_files: false
+    required: false
+    quiet: false
+
+  RakeTarget:
+    enabled: true
+    quite: true
+    description: 'Run rake targets'
+    targets:
+     - 'rubocop'
+     - 'test'
+     - 'xcop'
+    required_executable: 'bundle'
+    flags: ['exec', 'rake']
+

data/.pdd

@@ -1,9 +1,13 @@
 --source=.
 --verbose
 --skip-errors
+--skip-gitignore
+--include lib/pdd/sources.rb
 --exclude .idea/**/*
+--exclude .bundle/**/*
 --exclude target/**/*
 --exclude coverage/**/*
+--exclude test_assets/**/*
 --exclude README.md
 --exclude features/cli.feature
 --exclude features/parsing.feature

data/.rubocop.yml

@@ -16,8 +16,5 @@ Style/MultilineBlockChain:
   Enabled: false
 Metrics/BlockLength:
   Max: 50
-# @todo #123:30m Needs to enable this check and fix all issues.
-#  For now, this is out of the scope of this issue.
-#  This issue appeared after update TargetRubyVersion to 2.3
 Style/FrozenStringLiteralComment:
   Enabled: false

data/.simplecov

@@ -18,21 +18,21 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-if Gem.win_platform? then
+if Gem.win_platform?
   SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
     SimpleCov::Formatter::HTMLFormatter
   ]
   SimpleCov.start do
-    add_filter "/test/"
-    add_filter "/features/"
+    add_filter '/test/'
+    add_filter '/features/'
   end
 else
   SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
     SimpleCov::Formatter::HTMLFormatter
   )
   SimpleCov.start do
-    add_filter "/test/"
-    add_filter "/features/"
+    add_filter '/test/'
+    add_filter '/features/'
     minimum_coverage 90
   end
 end

data/README.md

@@ -41,7 +41,13 @@ Run it locally and read its output:
 $ pdd --help
 ```
 
-You can exclude certain files from the search, for example:
+### File and Directory Selection
+You can exclude & include certain number of files from the search via these options:
+
+`` --exclude=glob ``
+
+You can skip any file(s) with a name suffix that matches the pattern glob, using wildcard matching; 
+a name suffix is either the whole path and name, or reg expr, for example:
 
 ```bash
 pdd --exclude=src/**/*.java --exclude=target/**/*
@@ -49,6 +55,17 @@ pdd --exclude=src/**/*.java # exclude .java files in src/
 pdd --exclude=src/**/* # exclude all files in src/
 ```
 
+`` --include=glob ``
+
+Search only files whose name matches glob, using wildcard matching as described under ``--exclude``. 
+If contradictory ``--include`` and ``--exclude`` options are given, the last matching one wins. 
+If no ``--include`` or ``--exclude`` options are given, all files from working directory are included, example:
+аомтрптм
+```bash
+pdd --include=src/**/*.py # include only .py files in src/
+pdd --include=src/**/* # include all files in src/
+```
+
 ## How to Format?
 
 Every puzzle has to be formatted like this (pay attention
@@ -169,6 +186,7 @@ The XML produced will look approximately like this (here is a
   </puzzle>
 </puzzles>
 ```
+NOTE: puzzles are saved with utf-8 encoding
 
 [XSD Schema](http://pdd-xsd.teamed.io/0.19.4.xsd) is here.
 The most interesting parts of each puzzle are:
@@ -189,15 +207,21 @@ The most interesting parts of each puzzle are:
 ## How to contribute
 
 Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
-Make sure you build is green before you contribute
+Make sure your build is green before you contribute
 your pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2.3+ and
 [Bundler](https://bundler.io/) installed. Then:
 
 ```
-$ bundle update
+$ bundle install --path .bundle
 $ bundle exec rake
 ```
 
+Next, install and run overcommit to install hooks (required once)
+```
+$ gem install overcommit -v '=0.58.0'
+$ overcommit --install
+```
+
 If it's clean and you don't see any error messages, submit your pull request.
 
 This is how you run the tool locally to test how it works:

data/Rakefile

@@ -66,6 +66,12 @@ Xcop::RakeTask.new :xcop do |task|
   task.excludes = ['target/**/*', 'coverage/**/*']
 end
 
+require 'pdd/rake_task'
+desc 'Collecting and parsing all puzzles in project'
+PDD::RakeTask.new :pdd do |task|
+  task.includes = ['**/*']
+end
+
 require 'cucumber/rake/task'
 Cucumber::Rake::Task.new(:features) do |t|
   t.cucumber_opts = 'features --format progress'

data/bin/pdd

@@ -19,7 +19,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-STDOUT.sync = true
+$stdout.sync = true
 
 require 'shellwords'
 require 'English'
@@ -42,11 +42,6 @@ begin
   end
   args += ARGV
 
-  dir = Dir.pwd
-  @dir = File.absolute_path(dir)
-  files = Dir.glob(
-    File.join(@dir, '**/*'), File::FNM_DOTMATCH
-  ).reject { |f| File.directory?(f) }
   begin
     opts = Slop.parse(args, strict: true, help: true) do |o|
       o.banner = "Usage (#{PDD::VERSION}): pdd [options]"
@@ -65,15 +60,15 @@ begin
       o.array '-e', '--exclude', 'Glob pattern to exclude, e.g. "**/*.jpg"',
               default: []
       o.array '-n', '--include', 'Glob pattern to include, e.g. "**/*.jpg"',
-              default: [files]
+              default: []
       o.string '-t', '--format', 'Format of the report (xml|html)'
       o.array(
         '-r', '--rule', 'Rule to apply (can be used many times)',
         delimiter: ';'
       )
     end
-  rescue Slop::Error => ex
-    raise StandardError, "#{ex.message}, try --help"
+  rescue Slop::Error => e
+    raise StandardError, "#{e.message}, try --help"
   end
 
   if opts.help?
@@ -87,13 +82,17 @@ https://github.com/cqfn/pdd/blob/master/README.md"
     raise '-f is mandatory when using -v, try --help for more information'
   end
 
-  if opts['skip-gitignore']
-    raise 'For --skip-gitignore see https://github.com/cqfn/pdd/issues/80'
+  if opts['skip-gitignore'] && File.exist?('.gitignore')
+    cfg = File.new('.gitignore')
+    body = File.read(cfg)
+    extra = body.split(/\s+/).map(&:strip)
+    opts['skip-gitignore'] = extra
+    puts "Found #{body.split(/\n/).length} lines in #{File.absolute_path(cfg)}"
   end
 
   Encoding.default_external = Encoding::UTF_8
   Encoding.default_internal = Encoding::UTF_8
-  file = opts.file? ? File.new(opts[:file], 'w') : STDOUT
+  file = opts.file? ? File.new(opts[:file], 'w') : $stdout
   output = PDD::Base.new(opts).xml
   if opts[:format]
     if opts[:format] == 'html'
@@ -107,12 +106,12 @@ https://github.com/cqfn/pdd/blob/master/README.md"
     end
   end
   file << output
-rescue SystemExit => ex
-  puts ex.message unless ex.success?
-  PDD.log.info "Exit code is #{ex.status}"
-  exit(ex.status)
-rescue PDD::Error => ex
-  puts "#{Rainbow('ERROR').red}: #{ex.message}
+rescue SystemExit => e
+  puts e.message unless e.success?
+  PDD.log.info "Exit code is #{e.status}"
+  exit(e.status)
+rescue PDD::Error => e
+  puts "#{Rainbow('ERROR').red}: #{e.message}
 If you can't understand the cause of this issue or you don't know \
 how to fix it, please submit a GitHub issue, we will try to help you: \
 https://github.com/cqfn/pdd/issues. This tool is still in its beta \
@@ -120,8 +119,8 @@ version and we will appreciate your feedback. Here is where you can find \
 more documentation: https://github.com/cqfn/pdd/blob/master/README.md."
   PDD.log.info 'Exit code is 1'
   exit(1)
-rescue StandardError => ex
-  puts "#{Rainbow('ERROR').red} (#{ex.class.name}): #{ex.message}"
+rescue StandardError => e
+  puts "#{Rainbow('ERROR').red} (#{e.class.name}): #{e.message}"
   PDD.log.info 'Exit code is 255'
   exit(255)
 end

data/features/cli.feature

@@ -26,7 +26,7 @@ Feature: Command Line Processing
     """
     When I run bin/pdd with "-v -s . -f out.xml"
     Then Exit code is zero
-    And Stdout contains "Reading ."
+    And Stdout contains "Reading from root dir ."
     And XML file "out.xml" matches "/puzzles[count(puzzle)=1]"
     And XML file "out.xml" matches "//puzzle[starts-with(body,'Привет, Let')]"
 

data/features/html_output.feature

@@ -18,5 +18,5 @@ Feature: HTML output
     """
     When I run bin/pdd with "-v -s . -f out.html --format=html"
     Then Exit code is zero
-    And Stdout contains "Reading ."
+    And Stdout contains "Reading from root dir ."
     And XML file "out.html" matches "/html/body"

data/features/rake.feature

@@ -1,19 +1,21 @@
 Feature: Rake Task
-  Scenario: For now we failed if run rake task
+  As a source code writer I want to be able to
+  run PDD from Rakefile
+  Scenario: PDD can be used in Rakefile
     Given It is Unix
-    And a file named "Rakefile" with:
+    And I have a "Rakefile" file with content:
     """
     require 'pdd/rake_task'
-    PDD::RakeTask.new
+    PDD::RakeTask.new(:pdd) do |task|
+      task.includes = ['a.txt']
+    end
     """
-    When I run the following commands with `bash`:
-    """bash
-    rake pdd
+    And I have a "a.txt" file with content:
     """
-    Then the exit status should be 1
-    And the stderr should contain:
+    \x40todo #55 hello!
     """
-    NOT IMPLEMENTED
-    """
-    When I remove a file named "Rakefile" with full force
-    Then a file named "Rakefile" does not exist
+
+    When I run bash with "rake pdd"
+    Then Exit code is zero
+
+

data/features/step_definitions/steps.rb

@@ -64,9 +64,9 @@ When(/^I run pdd it fails with "([^"]*)"$/) do |txt|
   begin
     PDD::Base.new(@opts).xml
     passed = true
-  rescue PDD::Error => ex
-    unless ex.message.include?(txt)
-      raise "PDD failed but exception doesn't contain \"#{txt}\": #{ex.message}"
+  rescue PDD::Error => e
+    unless e.message.include?(txt)
+      raise "PDD failed but exception doesn't contain \"#{txt}\": #{e.message}"
     end
   end
   raise "PDD didn't fail" if passed
@@ -90,6 +90,7 @@ end
 
 Then(/^XML file "([^"]+)" matches "([^"]+)"$/) do |file, xpath|
   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?

data/features/uses_config.feature

@@ -16,6 +16,6 @@ Feature: Using .pdd config file
     """
     When I run bin/pdd with ""
     Then Exit code is zero
-    And Stdout contains "Reading ."
+    And Stdout contains "Reading from root dir ."
     And XML file "out.xml" matches "/puzzles[count(puzzle)=1]"
 

data/lib/pdd/rake_task.rb

@@ -1,16 +1,23 @@
 require 'rake'
 require 'rake/tasklib'
+require 'minitest/autorun'
+require 'nokogiri'
+require 'tmpdir'
+require 'slop'
+require 'pdd'
 
 # PDD Rake task
 module PDD
   # Rake task
   class RakeTask < Rake::TaskLib
-    attr_accessor :name
+    attr_accessor :name, :fail_on_error, :includes, :license, :quiet
+
     def initialize(*args, &task_block)
-      # @todo #125:30m Needs to have more parameters to run this task.
-      #  For now, we just have a single parameter - the name.
-      #  Needs more parameters like the xcop rake task has.
       @name = args.shift || :pdd
+      @includes = []
+      @excludes = []
+      @license = nil
+      @quiet = false
       desc 'Run PDD' unless ::Rake.application.last_description
       task(name, *args) do |_, task_args|
         RakeFileUtils.send(:verbose, true) do
@@ -20,11 +27,13 @@ module PDD
       end
     end
 
+    private
+
     def run
       # @todo #125:30m need to implement this method.
       #  For now, it's just a task,
-      #  that accepts one parameter and throws a system error.
-      abort('NOT IMPLEMENTED')
+      #  that prints a simple Running pdd... message to user
+      puts 'Running pdd...' unless @quiet
     end
   end
 end

data/lib/pdd/rule/duplicates.rb

@@ -35,6 +35,7 @@ module PDD
           .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()')}"

data/lib/pdd/rule/roles.rb

@@ -34,6 +34,7 @@ module PDD
           @xml.xpath('//puzzle').map do |p|
             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"\

data/lib/pdd/rule/text.rb

@@ -34,6 +34,7 @@ module PDD
           @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"

data/lib/pdd/source.rb

@@ -39,7 +39,7 @@ module PDD
 
     def match_markers(line)
       MARKERS.map do |mkr|
-        %r{(.*(?:^|\s))#{mkr}\s+#([\w\-\.:/]+)\s+(.+)}.match(line)
+        %r{(.*(?:^|\s))#{mkr}\s+#([\w\-.:/]+)\s+(.+)}.match(line)
       end.compact
     end
 
@@ -106,7 +106,7 @@ see https://github.com/cqfn/pdd#how-to-format"
     # Fetch puzzle
     def puzzle(lines, match, idx)
       tail = tail(lines, match[1], idx)
-      body = (match[3] + ' ' + tail.join(' ')).gsub(/\s+/, ' ').strip
+      body = "#{match[3]} #{tail.join(' ')}".gsub(/\s+/, ' ').strip
       body = body.chomp('*/-->').strip
       marker = marker(match[2])
       Puzzle.new(
@@ -121,7 +121,7 @@ see https://github.com/cqfn/pdd#how-to-format"
 
     # Parse a marker.
     def marker(text)
-      re = %r{([\w\-\.]+)(?::(\d+)(?:(m|h)[a-z]*)?)?(?:/([A-Z]+))?}
+      re = %r{([\w\-.]+)(?::(\d+)(?:(m|h)[a-z]*)?)?(?:/([A-Z]+))?}
       match = re.match(text)
       if match.nil?
         raise "Invalid puzzle marker \"#{text}\", most probably formatted \
@@ -148,10 +148,11 @@ against the rules explained here: https://github.com/cqfn/pdd#how-to-format"
         .map { |t| t[prefix.length, t.length] }
         .take_while { |t| t =~ /^[ a-zA-Z0-9]/ }
         .each_with_index do |t, i|
-          next if t.start_with?(' ')
-          raise Error, "Space expected at #{start + i + 2}:#{prefix.length}; \
+        next if t.start_with?(' ')
+
+        raise Error, "Space expected at #{start + i + 2}:#{prefix.length}; \
 make sure all lines in the puzzle body have a single leading space."
-        end
+      end
         .map { |t| t[1, t.length] }
     end
 
@@ -167,21 +168,22 @@ make sure all lines in the puzzle body have a single leading space."
       if `#{git} rev-parse --is-inside-work-tree 2>/dev/null`.strip == 'true'
         cmd = "#{git} blame -L #{pos},#{pos} --porcelain #{name}"
         add_github_login(Hash[
-          `#{cmd}`.split("\n").map do |line|
-            if line =~ /^author /
-              [:author, line.sub(/^author /, '')]
-            elsif line =~ /^author-mail [^@]+@[^\.]+\..+/
-              [:email, line.sub(/^author-mail <(.+)>$/, '\1')]
-            elsif line =~ /^author-time /
-              [
-                :time,
-                Time.at(
-                  line.sub(/^author-time ([0-9]+)$/, '\1').to_i
-                ).utc.iso8601
-              ]
-            end
-          end.compact
-        ])
+                           `#{cmd}`.split("\n").map do |line|
+                             case line
+                             when /^author /
+                               [:author, line.sub(/^author /, '')]
+                             when /^author-mail [^@]+@[^.]+\..+/
+                               [:email, line.sub(/^author-mail <(.+)>$/, '\1')]
+                             when /^author-time /
+                               [
+                                 :time,
+                                 Time.at(
+                                   line.sub(/^author-time ([0-9]+)$/, '\1').to_i
+                                 ).utc.iso8601
+                               ]
+                             end
+                           end.compact
+                         ])
       else
         {}
       end
@@ -207,12 +209,14 @@ make sure all lines in the puzzle body have a single leading space."
       email, author = info.values_at(:email, :author)
       # if email is not defined, changes have not been committed
       return if email.nil?
+
       base_uri = 'https://api.github.com/search/users?per_page=1'
       query = base_uri + "&q=#{email}+in:email"
       json = get_json query
       # find user by name instead since users can make github email private
       unless json['total_count'].positive?
         return if author.nil?
+
         query = base_uri + "&q=#{author}+in:fullname"
         json = get_json query
       end
@@ -240,8 +244,8 @@ make sure all lines in the puzzle body have a single leading space."
     # Fetch all puzzles.
     def puzzles
       @source.puzzles
-    rescue Error => ex
-      raise Error, "#{@file}; #{ex.message}"
+    rescue Error => e
+      raise Error, "#{@file}; #{e.message}"
     end
   end
 end

data/lib/pdd/sources.rb

@@ -18,54 +18,61 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+require 'rainbow'
 require 'shellwords'
 require 'English'
 require_relative 'source'
+require_relative '../../utils/glob'
 
 module PDD
   # Code base abstraction
   class Sources
     # Ctor.
     # +dir+:: Directory with source code files
-    def initialize(dir, ptns = [])
+    def initialize(dir)
       @dir = File.absolute_path(dir)
-      @exclude = ptns + ['.git/**/*']
-      @include = ptns + ['.git/**/*']
+      @exclude = ['.git/**/*']
+      @include = []
     end
 
     # Fetch all sources.
     def fetch
+      exclude_paths = @exclude.map do |ptn|
+        Glob.new(File.join(@dir, ptn)).to_regexp
+      end
       files = Dir.glob(
         File.join(@dir, '**/*'), File::FNM_DOTMATCH
-      ).reject { |f| File.directory?(f) }
-      included = 0
-      @include.each do |ptn|
-        Dir.glob(File.join(@dir, ptn), File::FNM_DOTMATCH) do |f|
-          files.keep_if { |i| i != f }
-          included += 1
-        end
+      ).reject do |f|
+        File.directory?(f) || exclude_paths.any? { |ptn| f.match(ptn) }
       end
-      PDD.log.info "#{files.size} file(s) found, #{included} files included"
-      excluded = 0
-      @exclude.each do |ptn|
-        Dir.glob(File.join(@dir, ptn), File::FNM_DOTMATCH) do |f|
-          files.delete_if { |i| i == f }
-          excluded += 1
-        end
-      end
-      PDD.log.info "#{files.size} file(s) found, #{excluded} excluded"
+      files += Dir.glob(
+        @include.map { |ptn| File.join(@dir, ptn) }
+      ).reject { |f| File.directory?(f) }
+      files = files.uniq # remove duplicates
       files.reject { |f| binary?(f) }.map do |file|
         path = file[@dir.length + 1, file.length]
         VerboseSource.new(path, Source.new(file, path))
       end
     end
 
-    def exclude(ptn)
-      Sources.new(@dir, @exclude.push(ptn))
+    def exclude(paths)
+      paths = paths.nil? ? [] : paths
+      paths = paths.is_a?(Array) ? paths : [paths]
+      @exclude.push(*paths)
+      paths&.each do |path|
+        PDD.log.info "#{Rainbow('Excluding').orange} #{path}"
+      end
+      self
     end
 
-    def include(ptn)
-      Sources.new(@dir, @include.push(ptn))
+    def include(paths)
+      paths = paths.nil? ? [] : paths
+      paths = paths.is_a?(Array) ? paths : [paths]
+      @include.push(*paths)
+      paths&.each do |path|
+        PDD.log.info "#{Rainbow('Including').blue} #{path}"
+      end
+      self
     end
 
     private
@@ -76,6 +83,7 @@ module PDD
     #  `test_ignores_binary_files` in `test_sources.rb`.
     def binary?(file)
       return false if Gem.win_platform?
+
       `grep -qI '.' #{Shellwords.escape(file)}`
       if $CHILD_STATUS.success?
         false

data/lib/pdd/version.rb

@@ -23,5 +23,5 @@
 # Copyright:: Copyright (c) 2014-2021 Yegor Bugayenko
 # License:: MIT
 module PDD
-  VERSION = '0.20.7'.freeze
+  VERSION = '0.20.8'.freeze
 end

data/lib/pdd.rb

@@ -52,11 +52,12 @@ module PDD
   # Get logger.
   def self.log
     unless defined?(@logger)
-      @logger = Logger.new(STDOUT)
+      @logger = Logger.new($stdout)
       @logger.formatter = proc { |severity, _, _, msg|
-        if severity == 'ERROR'
+        case severity
+        when 'ERROR'
           "#{Rainbow(severity).red}: #{msg}\n"
-        elsif severity == 'WARN'
+        when 'WARN'
           "#{Rainbow(severity).orange}: #{msg}\n"
         else
           "#{msg}\n"
@@ -87,20 +88,15 @@ module PDD
 
     # Generate XML.
     def xml
-      dir = @opts[:source] ? @opts[:source] : Dir.pwd
-      PDD.log.info "Reading #{dir}"
+      dir = @opts[:source] || Dir.pwd
+      PDD.log.info "Reading from root dir #{dir}"
       require_relative 'pdd/sources'
-      sources = Sources.new(dir)
-      @opts[:include]&.each do |p|
-        sources = sources.include(p)
-      end
-      @opts[:exclude]&.each do |p|
-        sources = sources.exclude(p)
-        PDD.log.info "Excluding #{p}"
-      end
+      sources = Sources.new(File.expand_path(dir))
+      sources.exclude((@opts[:exclude] || []) + (@opts['skip-gitignore'] || []))
+      sources.include(@opts[:include])
       sanitize(
         rules(
-          Nokogiri::XML::Builder.new do |xml|
+          Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
             xml << "<?xml-stylesheet type='text/xsl' href='#{xsl}'?>"
             xml.puzzles(attrs) do
               sources.fetch.each do |source|
@@ -152,16 +148,19 @@ module PDD
       unless list.select { |r| r.start_with?('max-duplicates:') }.empty?
         raise PDD::Error, 'You can\'t modify max-duplicates, it\'s always 1'
       end
+
       list.push('max-duplicates:1').map do |r|
         name, value = r.split(':')
         rule = RULES[name]
         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
       raise PDD::Error, "#{total} errors, see log above" unless total.zero?
+
       xml
     end
 
@@ -173,6 +172,7 @@ module PDD
       errors.each { |e| PDD.log.error e }
       PDD.log.error(xml) unless errors.empty?
       raise SchemaError, errors.join('; ') unless errors.empty?
+
       xml
     end
   end

data/pdd.gemspec

@@ -20,17 +20,18 @@
 
 require 'English'
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require_relative 'lib/pdd/version'
 
 Gem::Specification.new do |s|
   s.specification_version = 2 if s.respond_to? :specification_version=
   if s.respond_to? :required_rubygems_version=
-    s.required_rubygems_version = Gem::Requirement.new('>= 0')
+    s.required_rubygems_version =
+      Gem::Requirement.new('>= 0')
   end
   s.rubygems_version = '2.3'
-  s.required_ruby_version = '>= 2.3'
+  s.required_ruby_version = '~> 2.3'
   s.name = 'pdd'
   s.version = PDD::VERSION
   s.license = 'MIT'
@@ -56,5 +57,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec-rails', '3.1.0'
   s.add_development_dependency 'rubocop', '0.52.1'
   s.add_development_dependency 'rubocop-rspec', '1.15.1'
+  s.add_development_dependency 'slop', '4.9.1'
   s.add_development_dependency 'xcop', '0.5.8'
 end

data/test/test__helper.rb

@@ -18,7 +18,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-STDOUT.sync = true
+$stdout.sync = true
 
 require 'simplecov'
 SimpleCov.start

data/test/test_pdd.rb

@@ -75,6 +75,7 @@ class TestPDD < Minitest::Test
         git add -f .
         git commit --quiet -am 'first version'
       ")
+
       matches(
         Nokogiri::XML(PDD::Base.new(opts).xml),
         [

data/test/test_rake_task.rb

@@ -5,11 +5,14 @@ require_relative '../lib/pdd/rake_task'
 
 # Test for RakeTask
 class TestRakeTask < Minitest::Test
-  def test_base
-    PDD::RakeTask.new(:pdd1)
-    error = assert_raises SystemExit do
+  def test_basic
+    Dir.mktmpdir 'test' do |dir|
+      file = File.join(dir, 'a.txt')
+      File.write(file, "\x40todo #55 hello!")
+      PDD::RakeTask.new(:pdd1) do |task|
+        task.quiet = true
+      end
       Rake::Task['pdd1'].invoke
     end
-    assert_equal('NOT IMPLEMENTED', error.message)
   end
 end

data/test/test_source.rb

@@ -122,6 +122,25 @@ class TestSource < Minitest::Test
     end
   end
 
+  def test_succeed_utf8_encoded_body
+    Dir.mktmpdir 'test' do |dir|
+      file = File.join(dir, 'a.txt')
+      File.write(
+        file,
+        "
+        * \x40todo #44 Привет, мир, мне кофе
+        *  вторая линия
+        "
+      )
+      list = PDD::VerboseSource.new(file, PDD::Source.new(file, 'hey')).puzzles
+      assert_equal 1, list.size
+      puzzle = list.first
+      assert_equal '2-3', puzzle.props[:lines]
+      assert_equal 'Привет, мир, мне кофе вторая линия', puzzle.props[:body]
+      assert_equal '44', puzzle.props[:ticket]
+    end
+  end
+
   def test_failing_on_incomplete_puzzle
     Dir.mktmpdir 't5' do |dir|
       file = File.join(dir, 'ff.txt')
@@ -141,7 +160,7 @@ class TestSource < Minitest::Test
   def test_failing_on_broken_unicode
     Dir.mktmpdir 'test' do |dir|
       file = File.join(dir, 'xx.txt')
-      File.write(file, ' * \x40todo #44 this is a broken unicode: ' + 0x92.chr)
+      File.write(file, " * \\x40todo #44 this is a broken unicode: #{0x92.chr}")
       assert_raises PDD::Error do
         stub_source_find_github_user(file, 'xx', &:puzzles)
       end
@@ -209,6 +228,7 @@ class TestSource < Minitest::Test
         git add a.txt
         git commit --quiet -am 'first version'
       ")
+
       stub_source_find_github_user(File.join(dir, 'a.txt')) do |source|
         list = source.puzzles
         assert_equal 1, list.size
@@ -237,6 +257,7 @@ class TestSource < Minitest::Test
         git add a.txt
         git commit --quiet -am 'first version'
       ")
+
       stub_source_find_github_user(File.join(dir, 'a.txt')) do |source|
         list = source.puzzles
         assert_equal 1, list.size
@@ -264,6 +285,7 @@ class TestSource < Minitest::Test
         git add a.txt
         git commit --quiet -am 'first version'
       ")
+
       stub_source_find_github_user(File.join(dir, 'a.txt')) do |source|
         list = source.puzzles
         assert_equal 1, list.size
@@ -286,6 +308,7 @@ class TestSource < Minitest::Test
         git commit --quiet -am 'first version'
         echo '\x40todo #1 this is a puzzle uncommitted' > a.txt
       ")
+
       stub_source_find_github_user(File.join(dir, 'a.txt')) do |source|
         list = source.puzzles
         assert_equal 1, list.size

data/test/test_source_todo.rb

@@ -73,6 +73,18 @@ class TestSourceTodo < Minitest::Test
     )
   end
 
+  def test_todo_utf8_encoded_body
+    check_valid_puzzle(
+      "
+      // TODO #45 Привет, мир, мне кофе
+      //  вторая линия
+      ",
+      '2-3',
+      'Привет, мир, мне кофе вторая линия',
+      '45'
+    )
+  end
+
   def test_todo_colon_parsing
     check_valid_puzzle(
       "

data/test/test_sources.rb

@@ -92,14 +92,16 @@ class TestSources < Minitest::Test
   def test_includes_by_pattern
     in_temp(['a/first.txt', 'b/c/d/second.txt']) do |dir|
       list = PDD::Sources.new(dir).include('b/c/d/second.txt').fetch
-      assert_equal 1, list.size
+      assert_equal 2, list.size
     end
   end
 
   def test_includes_recursively
     in_temp(['a/first.txt', 'b/c/second.txt', 'b/c/d/third.txt']) do |dir|
-      list = PDD::Sources.new(dir).include('**/*').fetch
-      assert_equal 0, list.size
+      sources = PDD::Sources.new(dir).exclude('b/c/**')
+      sources.include('b/c/d/third.txt')
+      list = sources.fetch
+      assert_equal 2, list.size
     end
   end
 

data/utils/glob.rb

@@ -0,0 +1,67 @@
+# Copyright (c) 2014-2021 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.
+
+# Utility glob class
+class Glob
+  NO_LEADING_DOT = '(?=[^\.])'.freeze
+
+  def initialize(glob_string)
+    @glob_string = glob_string
+  end
+
+  # rubocop:disable Metrics/CyclomaticComplexity
+  # rubocop:disable Metrics/MethodLength
+  def to_regexp
+    chars = @glob_string.gsub(%r{(\*\*\/\*)|(\*\*)}, '*').split('')
+    in_curlies = 0, escaping = false
+    chars.map do |char|
+      if escaping
+        escaping = false
+        return char
+      end
+      case char
+      when '*'
+        '.*'
+      when '?'
+        '.'
+      when '.'
+        '\\.'
+      when '{'
+        in_curlies += 1
+        '('
+      when '}'
+        if in_curlies.positive?
+          in_curlies -= 1
+          return ')'
+        end
+        return char
+      when ','
+        in_curlies.positive? ? '|' : char
+      when '\\'
+        escaping = true
+        '\\'
+      else
+        char
+      end
+    end.join
+  end
+  # rubocop:enable Metrics/CyclomaticComplexity
+  # rubocop:enable Metrics/MethodLength
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdd
 version: !ruby/object:Gem::Version
-  version: 0.20.7
+  version: 0.20.8
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-24 00:00:00.000000000 Z
+date: 2021-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -178,6 +178,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.15.1
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.9.1
 - !ruby/object:Gem::Dependency
   name: xcop
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +220,7 @@ files:
 - ".github/ISSUE_TEMPLATE.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
+- ".overcommit.yml"
 - ".pdd"
 - ".rubocop.yml"
 - ".rultor.yml"
@@ -258,6 +273,7 @@ files:
 - test_assets/cambria.woff
 - test_assets/elegant-objects.png
 - test_assets/favicon.ico
+- utils/glob.rb
 homepage: http://github.com/cqfn/pdd
 licenses:
 - MIT
@@ -269,7 +285,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement