mnogootex 0.2.1 → 2.0.0

data/lib/mnogootex/log/levels.yml

@@ -0,0 +1,29 @@
+- !ruby/struct:Mnogootex::Log::Level
+  priority: -.inf
+  name: !ruby/symbol all
+  # NOTE: merely symbolic, not to be used in matchers
+
+- !ruby/struct:Mnogootex::Log::Level
+  priority: 0
+  name: !ruby/symbol trace
+  color: !ruby/symbol white
+
+- !ruby/struct:Mnogootex::Log::Level
+  priority: 1
+  name: !ruby/symbol info
+  color: !ruby/symbol light_white
+
+- !ruby/struct:Mnogootex::Log::Level
+  priority: 2
+  name: !ruby/symbol warning
+  color: !ruby/symbol light_yellow
+
+- !ruby/struct:Mnogootex::Log::Level
+  priority: 3
+  name: !ruby/symbol error
+  color: !ruby/symbol light_red
+
+- !ruby/struct:Mnogootex::Log::Level
+  priority: .inf
+  name: !ruby/symbol off
+  # NOTE: merely symbolic, not to be used in matchers

data/lib/mnogootex/log/line.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Mnogootex
+  module Log
+    # This data structure represents a log line.
+    # It can have a log {level} along with its {text}.
+    #
+    # @!attribute text
+    #   @return [String] the contents of the line
+    # @!attribute level
+    #   @return [Symbol] the associated log level
+    Line = Struct.new(:text, :level)
+  end
+end

data/lib/mnogootex/log/matcher.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Mnogootex
+  module Log
+    # This data structure represents a typology of log line chunks
+    # belonging to a given log {level}.
+    # They start with a line matching {regexp} and have a fixed {length}.
+    #
+    # @!attribute regexp
+    #   @return [Regexp] the regexp to match the first line
+    # @!attribute level
+    #   @return [Symbol] the associated log level
+    # @!attribute length
+    #   @return [Integer] the number of matched lines
+    Matcher = Struct.new(:regexp, :level, :length) # rubocop:disable Lint/StructNewOverride
+  end
+end

data/lib/mnogootex/log/matchers.yml

@@ -0,0 +1,205 @@
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/LaTeX Warning: You have requested package/'
+  level: !ruby/symbol trace
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/LaTeX Font Warning: Some font shapes/'
+  level: !ruby/symbol trace
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/LaTeX Font Warning: Size substitutions/'
+  level: !ruby/symbol trace
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/Package caption Warning: Unsupported document class/'
+  level: !ruby/symbol trace
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/Package fixltx2e Warning: fixltx2e is not required/'
+  level: !ruby/symbol trace
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/Package frenchb?\.ldf Warning: (Figures|The definition)/'
+  level: !ruby/symbol trace
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/\*\*\* Reloading Xunicode for encoding/' # spurious ***
+  level: !ruby/symbol trace
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/This is `?(epsf\.tex|.*\.sty|TAP)/' # so what
+  level: !ruby/symbol trace
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/pdfTeX warning:.*inclusion: fou/'
+  level: !ruby/symbol trace
+  length: 1
+  sample: |
+    pdfTeX warning: pdflatex.exe (file ./fig.pdf): PDF inclusion: found PDF version <1.6>, but at most version <1.5> allowed
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/pdfTeX warning:.*inclusion: mul/'
+  level: !ruby/symbol trace
+  length: 1
+  sample: |
+    pdfTeX warning: pdflatex (file ./doc.pdf): PDF inclusion: multiple pdfs with page group included in a single page
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/libpng warning: iCCP: Not recognizing/'
+  level: !ruby/symbol trace
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/! $/'
+  level: !ruby/symbol trace
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/This is/'
+  level: !ruby/symbol info
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/Output written/'
+  level: !ruby/symbol info
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/No pages of output/'
+  level: !ruby/symbol info
+  length: 1
+
+# TODO: better classification below this point
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/\(.*end occurred inside a group/'
+  level: !ruby/symbol warning
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/\\endL.*problem/' # XeTeX?
+  level: !ruby/symbol warning
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/\*\*\*\s/' # *** from some packages or subprograms
+  level: !ruby/symbol warning
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/all text was ignored after line/'
+  level: !ruby/symbol warning
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/.*for symbol.*on input line/'
+  level: !ruby/symbol warning
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/^.*?:[0-9]+:/' # usual file:lineno: form
+  level: !ruby/symbol warning
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/l\.[0-9]+/' # line number marking
+  level: !ruby/symbol warning
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/(LaTeX|Package|Class).*Warning/'
+  level: !ruby/symbol warning
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/(Und|Ov)erfull/'
+  level: !ruby/symbol warning
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/.*Citation.*undefined/'
+  level: !ruby/symbol warning
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/Missing character:/' # good to show (need \tracinglostchars=1)
+  level: !ruby/symbol warning
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/.*Fatal error/'
+  level: !ruby/symbol error
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/.* Error/' # as in \Url Error ->...
+  level: !ruby/symbol error
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/(LaTeX|Package|Class).*Error/'
+  level: !ruby/symbol error
+  length: 1
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/^> [^<]/' # from \show..., but not "> <img.whatever"
+  level: !ruby/symbol error
+  length: 2
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/^.*pdfTeX warning/' # pdftex complaints often cross lines
+  level: !ruby/symbol error
+  length: 2
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/^LaTeX Font Warning: Font shape/'
+  level: !ruby/symbol error
+  length: 2
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/^Package hyperref Warning: Token not allowed/'
+  level: !ruby/symbol error
+  length: 2
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/^removed on input line/' # hyperref
+  level: !ruby/symbol error
+  length: 2
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/^Runaway argument/'
+  level: !ruby/symbol error
+  length: 2
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp "/^! Undefined control sequence./"
+  level: !ruby/symbol error
+  length: 3
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp "/^! Too many }'s./"
+  level: !ruby/symbol error
+  length: 3
+  sample: |
+    ! Too many }'s.
+    l.7 ...d foo bar baz qux zod foo bar baz qux zod }
+                                                        foo
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  regexp: !ruby/regexp '/^!/' # usual ! form
+  level: !ruby/symbol error
+  length: 2
+
+- !ruby/struct:Mnogootex::Log::Matcher
+  # NOTE: do not remove, this is a catch-all filter to mark untagged lines as :trace
+  regexp: !ruby/regexp '/.*/'
+  level: !ruby/symbol trace
+  length: 1

data/lib/mnogootex/log/processor.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'mnogootex/log'
+require 'mnogootex/log/line'
+
+require 'colorize'
+
+module Mnogootex
+  module Log
+    # This class exposes methods to
+    # {Processor.strings_to_lines! convert} strings into {Line}s that can be
+    # {Processor.tag_lines! tagged},
+    # {Processor.filter_lines! filtered},
+    # {Processor.colorize_lines! colored} (using {Level}s and {Matcher}s to define how)
+    # and finally
+    # {Processor.render_lines! rendered} into printable content.
+    #
+    # It can also be {Processor.initialize instantiated} with a specific configuration
+    # to {#run} the whole process repeatably on multiple inputs.
+    class Processor
+      # Converts strings into {Line}s.
+      #
+      # @param strings [Array<String>]
+      # @return [Array<Line>]
+      def self.strings_to_lines!(strings)
+        strings.map! do |line|
+          Line.new line.chomp
+        end
+      end
+
+      # Updates {Line#level}s of the given {Line}s using the {Matcher}s.
+      #
+      # @param lines [Array<Line>]
+      # @param matchers [Array<Matcher>]
+      # @return [Array<Line>]
+      def self.tag_lines!(lines, matchers:)
+        tail_length, matcher = 0 # , nil
+        lines.each do |line|
+          if tail_length.zero?
+            matcher = matchers.detect { |m| line.text =~ m.regexp }
+            tail_length = matcher&.length&.-(1) || 0
+          else # still on the tail of the previous match
+            tail_length -= 1
+          end
+          line.level = matcher&.level
+        end
+      end
+
+      # Discards {Line}s having {Line.level}s with {Level#priority}
+      # lower than the minimum, according the {Level}s hash.
+      #
+      # @param lines [Array<Line>]
+      # @param levels [Hash<Symbol, Level>]
+      # @param min_level [Symbol]
+      # @return [Array<Line>]
+      def self.filter_lines!(lines, levels:, min_level:)
+        lines.select! do |line|
+          levels.fetch(line.level).priority >= levels.fetch(min_level).priority
+        end
+      end
+
+      # Applies {Level#color}s to the {Line}s, according the {Level}s hash.
+      #
+      # @param lines [Array<Line>]
+      # @param levels [Array<Level>]
+      # @return [Array<Line>]
+      def self.colorize_lines!(lines, levels:)
+        lines.each do |line|
+          line.text = line.text.colorize(levels.fetch(line.level).color)
+        end
+      end
+
+      # Renders {Line}s to space-indented strings terminated by a newline.
+      #
+      # @param lines [Array<Line>]
+      # @param indent_width [Fixnum]
+      # @return [Array<String>]
+      def self.render_lines!(lines, indent_width:)
+        lines.map! { |line| "#{' ' * indent_width}#{line.text}\n" }
+      end
+
+      # @param matchers [Array<Matcher>]
+      # @param levels [Array<Level>]
+      # @param indent_width [Fixnum]
+      # @param min_level [Symbol]
+      def initialize(matchers:, levels:, min_level:, colorize:, indent_width:)
+        @matchers = matchers
+        @levels = levels
+        @min_level = min_level
+        @colorize = colorize
+        @indent_width = indent_width
+      end
+
+      # Runs the {Processor Processor} on the given strings to
+      # {Processor.strings_to_lines! convert},
+      # {Processor.tag_lines! tag},
+      # {Processor.filter_lines! filter},
+      # {Processor.colorize_lines! color} and
+      # {Processor.render_lines! render} them
+      # using its {Processor.initialize initialization} parameters.
+      #
+      # @param lines [Array<String>]
+      # @return [Array<String>]
+      def run(lines)
+        @lines = lines.dup
+        Processor.strings_to_lines! @lines
+        Processor.tag_lines! @lines, matchers: @matchers
+        Processor.filter_lines! @lines, levels: @levels, min_level: @min_level
+        Processor.colorize_lines! @lines, levels: @levels if @colorize
+        Processor.render_lines! @lines, indent_width: @indent_width
+        @lines
+      end
+    end
+  end
+end

data/lib/mnogootex/log.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'mnogootex/log/level'
+require 'mnogootex/log/matcher'
+
+require 'pathname'
+require 'yaml'
+
+module Mnogootex
+  # {Log} implements means to reduce log floods into filtered, color coded and human friendly summaries.
+  #
+  # * {Line}s are log lines.
+  # * {Level}s define log levels, their priority and color coding.
+  # * {Matcher}s define patterns to determine the level of log lines.
+  # * {Processor}s implement all transformations.
+  #
+  module Log
+    DEFAULT_LEVELS_PATH = Pathname.new(__dir__).join('log', 'levels.yml')
+    DEFAULT_MATCHERS_PATH = Pathname.new(__dir__).join('log', 'matchers.yml')
+    DEFAULT_LEVELS = YAML.load_file(DEFAULT_LEVELS_PATH).map { |l| [l.name, l] }.to_h.freeze
+    DEFAULT_MATCHERS = YAML.load_file(DEFAULT_MATCHERS_PATH).freeze
+  end
+end

data/lib/mnogootex/utils.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+module Mnogootex
+  module Utils
+    def self.short_md5(input)
+      [Digest::MD5.digest(input)]. # get 16 bytes of MD5
+        pack('m0'). # pack them into 22+2 base64 bytes (w/o trailing newline)
+        tr('+/', '-_'). # make then url/path-safe
+        chomp('==') # drop last 2 padding bytes
+    end
+
+    def self.humanize_bytes(size)
+      %w[b Kb Mb Gb Tb Pb Eb Zb Yb].reduce(size) do |magnitude, unit|
+        break "#{magnitude}#{unit}" if magnitude < 1024
+
+        magnitude / 1024
+      end
+    end
+
+    def self.dir_size(mask)
+      Dir.glob(Pathname.new(mask).join('**', '*')).
+        map! { |f| Pathname.new(f).size }.inject(:+) || 0
+    end
+  end
+end

data/lib/mnogootex/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mnogootex
-  VERSION = "0.2.1"
+  VERSION = '2.0.0'
 end

data/lib/mnogootex.rb

@@ -1,7 +1,7 @@
-require "mnogootex/version"
-require "mnogootex/configuration"
-require "mnogootex/job"
+# frozen_string_literal: true
+
+require 'mnogootex/version'
+require 'mnogootex/cli'
 
 module Mnogootex
-  # Your code goes here...
 end

data/mnogootex.gemspec

@@ -1,30 +1,55 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "mnogootex/version"
+require 'mnogootex/version'
 
-Gem::Specification.new do |spec|
-  spec.name          = "mnogootex"
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
+  spec.name          = 'mnogootex'
   spec.version       = Mnogootex::VERSION
-  spec.authors       = ["Paolo Brasolin"]
-  spec.email         = ["paolo.brasolin@gmail.com"]
+  spec.authors       = ['Paolo Brasolin']
+  spec.email         = ['paolo.brasolin@gmail.com']
 
-  spec.summary       = %q{Mnogootex (многоꙮтех) is a device to handle the compilation of TeX sources with different preambles at one time.}
-  spec.description   = %q{Mnogootex (многоꙮтех) is a device to handle the compilation of TeX sources with different preambles at one time. This avoids wasting time when you have to submit a paper to journals using outdated or crummy document classes.}
-  spec.homepage      = "https://github.com/tetrapharmakon/mnogootex"
-  spec.license       = "MIT"
+  spec.summary       = <<~SUMMARY.tr("\n", ' ').squeeze(' ').strip
+    Многоꙮтех (mnogootex) is a utility that parallelizes compilation
+    of a LaTeX document using different classes and offers a
+    meaningfully filtered output.
+  SUMMARY
+
+  spec.description = <<~DESCRIPTION.tr("\n", ' ').squeeze(' ').strip
+    Многоꙮтех (mnogootex) is a utility that parallelizes compilation
+    of a LaTeX document using different classes and offers a
+    meaningfully filtered output.
+    The motivating use case is maintaining a single preamble while
+    submitting a paper to many journals using their outdated or crummy
+    document classes.
+  DESCRIPTION
+
+  spec.homepage      = 'https://github.com/tetrapharmakon/mnogootex'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features|mwe|mnogootex_classes)/})
+    f.match(%r{^(test|mwe)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.6'
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 2.2.30'
+  spec.add_development_dependency 'byebug', '~> 11.1.3'
+  # spec.add_development_dependency 'dry-inflector', '~> 0.1.1'
+  spec.add_development_dependency 'guard', '~> 2.18.0'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7.3'
+  # spec.add_development_dependency 'mutant', '~> 0.8.14'
+  # spec.add_development_dependency 'mutant-rspec', '~> 0.8.14'
+  spec.add_development_dependency 'rake', '~> 13.0.6'
+  spec.add_development_dependency 'rspec', '~> 3.10.0'
+  spec.add_development_dependency 'rubocop', '~> 1.22.3'
+  spec.add_development_dependency 'simplecov', '~> 0.21.2'
+  spec.add_development_dependency 'yard', '~> 0.9.26'
 
-  spec.add_dependency "colorize"
+  spec.add_dependency 'colorize', '~> 0.8.1'
+  spec.add_dependency 'thor', '~> 0.20.0'
 end

data/spec/mnogootex/cfg_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+require 'yaml'
+require 'tmpdir'
+
+require 'mnogootex/cfg'
+
+describe Mnogootex::Cfg do
+  describe 'load_descending' do
+    context 'fake file structure' do
+      subject { described_class.load_descending(pathname: Pathname.new('foobar'), basename: 'cfg.yml') }
+
+      it 'raises an error on loading a fake path' do
+        expect { subject }.to raise_exception Errno::ENOENT
+      end
+    end
+
+    context 'real file structure' do
+      subject { described_class.load_descending(pathname: tmp_dir.join('A', 'B'), basename: 'cfg.yml') }
+      let(:defaults) { { default: true, winner: 'default' } }
+      let(:tmp_dir) { Pathname.new(Dir.mktmpdir).join('mnogootex-test') }
+
+      before do
+        tmp_dir.join('A', 'B').mkpath
+        tmp_dir.join('cfg.yml').write('') # NOTE: empty file
+        tmp_dir.join('A', 'cfg.yml').write({ parent: true, winner: 'parent', merged: { deep: true } }.to_yaml)
+        tmp_dir.join('A', 'B', 'cfg.yml').write({ child: true, winner: 'child', merged: {} }.to_yaml)
+      end
+
+      after do
+        tmp_dir.rmtree
+      end
+
+      it 'merges paths' do
+        expect(subject).to include(:parent)
+        expect(subject).to include(:child)
+      end
+
+      it 'merges shallowly' do
+        expect(subject[:merged]).to_not include(:deep)
+      end
+
+      it 'privileges deeper paths' do
+        expect(subject[:winner]).to eq('child')
+      end
+
+      it 'privileges non defaults' do
+        expect(subject[:winner]).to_not eq('default')
+      end
+    end
+  end
+end