pdd 0.20.6 → 0.21.0

data/lib/pdd/sources.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2020 Yegor Bugayenko
+# Copyright (c) 2014-2022 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
@@ -18,58 +18,79 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require 'shellwords'
+require 'rainbow'
 require 'English'
+require 'filemagic'
 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/**/*']
+      @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) }
-      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
+      ).reject do |f|
+        File.directory?(f) || exclude_paths.any? { |ptn| f.match(ptn) }
       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(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
 
-    # @todo #98:30min Change the implementation of this method
-    #  to also work in Windows machines. Investigate the possibility
-    #  of use a gem for this. After that, remove the skip of the test
-    #  `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?
+      if text_file?(file)
         false
       else
         PDD.log.info "#{file} is a binary file (#{File.size(file)} bytes)"
         true
       end
     end
+
+    def text_file?(file)
+      fm = FileMagic.new(FileMagic::MAGIC_MIME)
+      fm.file(file) =~ %r{^text/}
+    ensure
+      fm.close
+    end
   end
 end

data/lib/pdd/version.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2020 Yegor Bugayenko
+# Copyright (c) 2014-2022 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
@@ -20,8 +20,8 @@
 
 # PDD main module.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2014-2020 Yegor Bugayenko
+# Copyright:: Copyright (c) 2014-2022 Yegor Bugayenko
 # License:: MIT
 module PDD
-  VERSION = '0.20.6'.freeze
+  VERSION = '0.21.0'.freeze
 end

data/lib/pdd.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2020 Yegor Bugayenko
+# Copyright (c) 2014-2022 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
@@ -30,7 +30,7 @@ require_relative 'pdd/rule/roles'
 
 # PDD main module.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2014-2020 Yegor Bugayenko
+# Copyright:: Copyright (c) 2014-2022 Yegor Bugayenko
 # License:: MIT
 module PDD
   # If it breaks.
@@ -52,21 +52,25 @@ 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"
+        when 'WARN'
+          "#{Rainbow(severity).orange}: #{msg}\n"
         else
           "#{msg}\n"
         end
       }
-      @logger.level = Logger::ERROR
+      @logger.level = Logger::WARN
     end
     @logger
   end
 
   class << self
     attr_writer :logger
+    attr_accessor :opts
   end
 
   # Code base abstraction
@@ -75,6 +79,7 @@ module PDD
     # +opts+:: Options
     def initialize(opts)
       @opts = opts
+      PDD.opts = opts
       PDD.log.level = Logger::INFO if @opts[:verbose]
       PDD.log.level = Logger::ERROR if @opts[:quiet]
       PDD.log.info "My version is #{PDD::VERSION}"
@@ -83,17 +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[: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|
@@ -145,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
 
@@ -166,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

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2020 Yegor Bugayenko
+# Copyright (c) 2014-2022 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
@@ -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'
@@ -38,7 +39,7 @@ Gem::Specification.new do |s|
   s.description = 'Collects PDD puzzles from a source code base'
   s.authors = ['Yegor Bugayenko']
   s.email = 'yegor256@gmail.com'
-  s.homepage = 'http://github.com/yegor256/pdd'
+  s.homepage = 'http://github.com/cqfn/pdd'
   s.files = `git ls-files`.split($RS)
   s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
@@ -46,6 +47,7 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
   s.add_runtime_dependency 'nokogiri', '~> 1.10'
   s.add_runtime_dependency 'rainbow', '~> 3.0'
+  s.add_runtime_dependency 'ruby-filemagic', '~> 0.7.2'
   s.add_runtime_dependency 'slop', '~> 4.6'
   s.add_development_dependency 'aruba', '~> 0.14.1'
   s.add_development_dependency 'codecov', '0.2.12'
@@ -56,5 +58,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

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2020 Yegor Bugayenko
+# Copyright (c) 2014-2022 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
@@ -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
@@ -29,3 +29,16 @@ end
 
 require 'minitest/autorun'
 require_relative '../lib/pdd'
+
+def stub_source_find_github_user(file, path = '')
+  source = PDD::Source.new(file, path)
+  verbose_source = PDD::VerboseSource.new(file, source)
+  fake = proc do |info = {}|
+    email, author = info.values_at(:email, :author)
+    { 'login' => 'yegor256' } if email == 'yegor256@gmail.com' ||
+                                 author == 'Yegor Bugayenko'
+  end
+  source.stub :find_github_user, fake do
+    yield verbose_source
+  end
+end

data/test/test_duplicates.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2020 Yegor Bugayenko
+# Copyright (c) 2014-2022 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
@@ -24,7 +24,7 @@ require_relative '../lib/pdd/rule/duplicates'
 
 # PDD::Rule::MaxDuplicates class test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2014-2020 Yegor Bugayenko
+# Copyright:: Copyright (c) 2014-2022 Yegor Bugayenko
 # License:: MIT
 class TestMaxDuplicates < Minitest::Test
   def test_max_duplicates

data/test/test_estimates.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2020 Yegor Bugayenko
+# Copyright (c) 2014-2022 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
@@ -24,7 +24,7 @@ require_relative '../lib/pdd/rule/estimates'
 
 # PDD::Rule::Estimate module tests.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2014-2020 Yegor Bugayenko
+# Copyright:: Copyright (c) 2014-2022 Yegor Bugayenko
 # License:: MIT
 class TestEstimates < Minitest::Test
   def test_min

data/test/test_pdd.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2020 Yegor Bugayenko
+# Copyright (c) 2014-2022 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
@@ -26,7 +26,7 @@ require_relative '../lib/pdd'
 
 # PDD main module test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2014-2020 Yegor Bugayenko
+# Copyright:: Copyright (c) 2014-2022 Yegor Bugayenko
 # License:: MIT
 class TestPDD < Minitest::Test
   def test_basic
@@ -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),
         [
@@ -95,6 +96,7 @@ class TestPDD < Minitest::Test
     Slop.parse args do |o|
       o.bool '-v', '--verbose'
       o.bool '-q', '--quiet'
+      o.bool '--skip-errors'
       o.string '-s', '--source'
       o.array '-e', '--exclude'
       o.array '-r', '--rule'

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_roles.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2020 Yegor Bugayenko
+# Copyright (c) 2014-2022 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
@@ -24,7 +24,7 @@ require_relative '../lib/pdd/rule/roles'
 
 # PDD::Rule::Role module tests.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2014-2020 Yegor Bugayenko
+# Copyright:: Copyright (c) 2014-2022 Yegor Bugayenko
 # License:: MIT
 class TestRoles < Minitest::Test
   def test_incorrect_role