texqc 0.3.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0320a39681a88dd049a570f07f2f7da888a252031cbc837bbeabef8193a03914
-  data.tar.gz: d8a66224bb2ea5f9a629affc4bb775bef198557bb062278b42941cc4a197d784
+  metadata.gz: e88425aca179dc71ac9e248a801d9c1b186099971c9eeaeec39758f57198c64b
+  data.tar.gz: 3bf5fe50c3ca447464518b63fc0c239015875f101d47eb9b921a9e75ab2bdcfb
 SHA512:
-  metadata.gz: 346a1f0a696fab388789ecd93cb0a90e65fd89943bd8d74717019c64b368d7d51354f33665a846d1a62a16b3c85fdb08aed7f6baba0aa2694cb5a195e8cfd957
-  data.tar.gz: 7ce08f94b5116f9ee571cae314258816aec8243f4ebe7ba8b246ad8d7dc024903aa2c8927a7f405f88c18e25d56948e70bacdaf70704076337a846e8690a8713
+  metadata.gz: 8368418b1b9bdbaadfaaf0f4e2fe9b0e02e6744b0ec459d5b5d43333dbcd5aaaa6dbeb270cfc84829802ef1949bea88959e016ee5d3b5736877d661ddf58dd5f
+  data.tar.gz: b2feafedb767d24ac19a2e506ed7c711fe5254e7694bf201806e6c91f6282eeede0d42d614471c8b15c8723f0da338fc7464ee03b9bc30d5c2022bec0b645ccc

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.2'
+VERSION = '0.7.0'
 
 STDOUT.sync = true
 
@@ -45,11 +45,22 @@ end
 
 begin
   log = Loog::REGULAR
+  args = []
+  if File.exist?('.texqc')
+    cfg = File.new('.texqc')
+    body = File.read(cfg)
+    extra = body.split(/\s+/).map(&:strip)
+    args += extra
+    puts "Found #{body.split(/\n/).length} lines in #{File.absolute_path(cfg)}"
+  end
+  args += ARGV
+
   begin
-    opts = Slop.parse(ARGV, strict: true, help: true) do |o|
-      o.banner = "Usage (#{VERSION}): texqc [options] file
+    opts = Slop.parse(args, strict: true, help: true) do |o|
+      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 +76,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,31 @@ 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
+
+  Scenario: Bad LaTeX log output checked with LaTeX warning, but ignored with .texqc
+    Given I have a "article.tex" file with content:
+    """
+    \documentclass{article}
+    \begin{document}
+    test\label{xxx}test\label{xxx}
+    \end{document}
+    """
+    And I have a ".texqc" file with content:
+    """
+    --ignore 'may have changed' article.tex
+    """
+    When I run bash with "pdflatex article.tex"
+    Then I run bin/texqc
+    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.2'
+  s.version = '0.7.0'
   s.license = 'MIT'
   s.summary = 'Quality Control of Your LaTeX Build'
   s.description = 'Run it after you compile your LaTeX document'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: texqc
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-18 00:00:00.000000000 Z
+date: 2021-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -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