texqc 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2099f8e3d8d378158ce5b1496910bacebc2c94dc34bab46497ee2f8705a1f8de
-  data.tar.gz: 5c9eabdcb8918403c336f983d8411a4a63ad0d14644b69169487b13b4bb294c4
+  metadata.gz: 19e114b82eed83d7dc3e0b0320418c89dbc0fbaf557b9886867837264c49939e
+  data.tar.gz: d815e0852ed6fdf217935cdc8a3340bffec993430b51064b5af1f0ef6f56080c
 SHA512:
-  metadata.gz: 272973773f24946901bb376ff47a747cbd01adc3be02fdb077275fa18cdc96f2fe0c32a8a9ff686d835a355bdef708190ec6e9d9985cf9ffc8282ed0c0b20fd4
-  data.tar.gz: dbbbd7523655d391f429389fbb049a6bd842c1f2a47cab12c2825ea9929fe2454b03004dbc5b18fc4e00e73aaeba129194ad15102f4731993c2fb00e9627e1d6
+  metadata.gz: cb0a5f84ecdc58c058ce1ba513cea2e30a9b3deadf42a342b254002f2ea911174f2b853ff05fa0a7ccfeb7ba9a62b193fbe79d51f7763311d378c273d211a914
+  data.tar.gz: 33e1ffc295e36868d42a345ac1522ffd5aa7fb5ea45caad133afb189fb0627bc4a222dabaadeb0376348df9c8ffa507b1cc15086de9bc53ace22e36bb2631eb6

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/.travis.yml

@@ -10,6 +10,7 @@ addons:
     packages:
     - aspell
     - aspell-en
+    - texlive
 install:
   - gem install pdd -v 0.20.5
   - travis_retry bundle update

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/README.md

@@ -29,6 +29,9 @@ $ latexmk -pdf article
 $ texqc article
 ```
 
+If any warnings were reported by LaTeX, you will get a short list of them
+and the exit code will be non-zero (very convenient for your CI/CD scripts).
+
 ## How to contribute
 
 Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).

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.2.0'
+VERSION = '0.5.0'
 
 STDOUT.sync = true
 
@@ -30,13 +30,27 @@ require 'loog'
 require 'open3'
 require 'slop'
 
+# Errors counter.
+class Errors
+  attr_reader :count
+  def initialize
+    @count = 0
+  end
+
+  def report(pos, txt)
+    puts "[#{pos}] #{txt}"
+    @count += 1
+  end
+end
+
 begin
   log = Loog::REGULAR
   begin
     opts = Slop.parse(ARGV, 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
@@ -54,16 +68,31 @@ Options are:"
   end
   raise 'Try --help' if opts.arguments.empty?
   raise 'Too many arguments' unless opts.arguments.length == 1
-  errors = 0
-  f = "#{opts.arguments[0]}.log"
-  File.readlines(f).each do |t|
-    if t.start_with?('Underfull ', 'Overfull ', 'LaTeX Warning: ')
-      errors += 1
-      puts t
+  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
+  matches = [
+    /^Underfull /,
+    /^Overfull /,
+    /^LaTeX Warning: /,
+    /^pdfTeX warning: /,
+    /^Class [a-zA-Z0-9\*]+ Warning: /,
+    /^Package [a-zA-Z0-9\*]+ Warning: /,
+    /^LaTeX Font Warning: /
+  ]
+  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 errors.zero?
-    log.info("#{errors} LaTeX processing errors found in #{f.inspect}")
+  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}")

data/features/cli.feature

@@ -41,6 +41,18 @@ 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 "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.2.0'
+  s.version = '0.5.0'
   s.license = 'MIT'
   s.summary = 'Quality Control of Your LaTeX Build'
   s.description = 'Run it after you compile your LaTeX document'
@@ -46,10 +46,10 @@ 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_development_dependency 'codecov', '0.1.10'
+  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.0.0'
+  s.add_development_dependency 'rake', '12.3.3'
   s.add_development_dependency 'rubocop', '0.61.0'
   s.add_development_dependency 'rubocop-rspec', '1.31.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: texqc
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-10 00:00:00.000000000 Z
+date: 2021-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -44,28 +44,28 @@ 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
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.10
+        version: 0.2.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.10
+        version: 0.2.6
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement