texqc 0.3.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11c959ccc1a42d66bc7d3d3daa09ca54a8ebdf98facb6354d57238398238d63a
-  data.tar.gz: b1fa00eb6c705501b0f9b5cd3663c91f8b52b1c5393c87076f715777808fd498
+  metadata.gz: c6417dba6502ed4e98ee381614ada43663890850be482dc3e7f4dc30b72b8d25
+  data.tar.gz: 36a4e4704d3f35c92a7ab5ae66ced90d33f83cf96bea35c2138aaf526ea70095
 SHA512:
-  metadata.gz: d92293bb5536644213817b1d003feb3d13de5a2eb784a17dfde450cb3940cbf0d81683344c99767ae012b3dbd909dc0397cf9ef00c822b442d149e066118f790
-  data.tar.gz: 6e6492a16bc3c31293a64e830d8ad8f637378c192b2ccd76971f3fff60dc32cf65883cd42c8e046105db5b74287710947616cb20f3736e3425d12e80aeaf413c
+  metadata.gz: b61800ce2230eb64d841be40bc6dcabc6eeb4359878c7225b16be4cb1539c5812f90493e190ca02b2b20838a3d15ad8289ec30198b7ae1483824cfa4601b6244
+  data.tar.gz: 6b2481529eb732483a68acf882a8311c15088658d6e5b04bed6a766e4a89f8f33b20fda47f08852baaa1e84fd3b9f9696b9d5d54a3d35fa0208f65d10f78a67b

data/.rultor.yml

@@ -1,6 +1,7 @@
 assets:
   rubygems.yml: yegor256/home#assets/rubygems.yml
 install: |
+  export PATH=$PATH:/usr/local/texlive/2021/bin/x86_64-linux/
   sudo apt install -y aspell
   pdd -f /dev/null
   sudo bundle install --no-color "--gemfile=$(pwd)/Gemfile"

data/.simplecov

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Yegor Bugayenko
+# Copyright (c) 2020-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

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2020 Yegor Bugayenko
+# Copyright (c) 2020-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

data/Rakefile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2020 Yegor Bugayenko
+# Copyright (c) 2020-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

data/bin/texqc

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# Copyright (c) 2020 Yegor Bugayenko
+# Copyright (c) 2020-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
@@ -21,7 +21,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-VERSION = '0.3.1'
+VERSION = '0.6.0'
 
 STDOUT.sync = true
 
@@ -47,9 +47,10 @@ begin
   log = Loog::REGULAR
   begin
     opts = Slop.parse(ARGV, strict: true, help: true) do |o|
-      o.banner = "Usage (#{VERSION}): texqc [options] file
+      o.banner = "Usage (#{VERSION}): texqc [options] file...
 Options are:"
-      o.array '--dry', 'Don\'t fail the build on errors'
+      o.bool '--dry', 'Don\'t fail the build on errors'
+      o.array '--ignore', 'Ignore given regexp'
       o.bool '--version', 'Print current version' do
         puts VERSION
         exit
@@ -65,30 +66,37 @@ Options are:"
   rescue Slop::Error => ex
     raise ex.message
   end
-  raise 'Try --help' if opts.arguments.empty?
-  raise 'Too many arguments' unless opts.arguments.length == 1
-  doc = opts.arguments[0]
-  if doc.end_with?('.tex')
-    log.info("File extention removed from #{doc.inspect}")
-    doc = doc.gsub(/\.tex$/, '')
-  end
-  f = "#{doc}.log"
-  e = Errors.new
-  File.readlines(f).each_with_index do |t, i|
-    [
+  candidates = opts.arguments
+  candidates += Dir['*.tex'] if candidates.empty?
+  candidates.each do |doc|
+    if doc.end_with?('.tex')
+      log.info("File extention removed from #{doc.inspect}")
+      doc = doc.gsub(/\.tex$/, '')
+    end
+    f = "#{doc}.log"
+    e = Errors.new
+    matches = [
       /^Underfull /,
       /^Overfull /,
       /^LaTeX Warning: /,
+      /^pdfTeX warning: /,
       /^Class [a-zA-Z0-9\*]+ Warning: /,
       /^Package [a-zA-Z0-9\*]+ Warning: /,
       /^LaTeX Font Warning: /
-    ].each { |p| e.report(i, t) if p.match?(t) }
-  end
-  unless e.count.zero?
-    log.info("#{e.count} LaTeX processing errors found in #{f.inspect}")
-    exit 1
+    ]
+    File.readlines(f).each_with_index do |t, i|
+      matches.each do |p|
+        next unless p.match?(t)
+        next if opts[:ignore].any? { |re| /.*#{re}.*/.match?(t) }
+        e.report(i, t)
+      end
+    end
+    unless e.count.zero?
+      log.info("#{e.count} LaTeX processing errors found in #{f.inspect}")
+      exit 1
+    end
+    log.info("No LaTeX processing errors found in #{f.inspect}")
   end
-  log.info("No LaTeX processing errors found in #{f.inspect}")
 rescue StandardError => ex
   if opts[:verbose]
     puts Backtrace.new(ex).to_s

data/features/cli.feature

@@ -15,7 +15,7 @@ Feature: Command Line Processing
     \end{document}
     """
     When I run bash with "pdflatex article.tex"
-    Then I run bin/texqc with "article"
+    Then I run bin/texqc with ""
     Then Exit code is zero
     And Stdout contains "No LaTeX processing errors found"
 
@@ -44,3 +44,15 @@ Feature: Command Line Processing
     Then I run bin/texqc with "article.tex"
     Then Exit code is not zero
     And Stdout contains "1 LaTeX processing errors"
+
+  Scenario: Bad LaTeX log output checked with LaTeX warning, but ignored
+    Given I have a "article.tex" file with content:
+    """
+    \documentclass{article}
+    \begin{document}
+    test\label{xxx}test\label{xxx}
+    \end{document}
+    """
+    When I run bash with "pdflatex article.tex"
+    Then I run bin/texqc with "--ignore 'may have changed' article.tex"
+    Then Exit code is zero

data/features/step_definitions/steps.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2020 Yegor Bugayenko
+# Copyright (c) 2020-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

data/features/support/env.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2020 Yegor Bugayenko
+# Copyright (c) 2020-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

data/texqc.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2020 Yegor Bugayenko
+# Copyright (c) 2020-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
@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = '2.2'
   s.required_ruby_version = '>= 2.3'
   s.name = 'texqc'
-  s.version = '0.3.1'
+  s.version = '0.6.0'
   s.license = 'MIT'
   s.summary = 'Quality Control of Your LaTeX Build'
   s.description = 'Run it after you compile your LaTeX document'
@@ -46,7 +46,7 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
   s.add_runtime_dependency 'backtrace', '~> 0.3'
   s.add_runtime_dependency 'loog', '~> 0.2'
-  s.add_runtime_dependency 'slop', '~> 4.6'
+  s.add_runtime_dependency 'slop', '~> 4.8.2'
   s.add_development_dependency 'codecov', '0.2.6'
   s.add_development_dependency 'cucumber', '~> 1.3.17'
   s.add_development_dependency 'rake', '12.3.3'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: texqc
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-19 00:00:00.000000000 Z
+date: 2021-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: 4.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: 4.8.2
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -171,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 2
 summary: Quality Control of Your LaTeX Build