mnogootex 0.2.0 → 1.1.0

data/spec/spec_helper.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'timeout'
+
+if ENV['COVERAGE'] == 'true'
+  require 'simplecov'
+
+  SimpleCov.configure do
+    track_files 'lib/**/*.rb'
+    add_filter '/spec/'
+  end
+
+  # SimpleCov.at_exit do
+  #   SimpleCov.result.format!
+  #   puts "#{SimpleCov.result.covered_percent.floor}%"
+  # end
+
+  SimpleCov.start
+end
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.fail_fast = true
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # This allows you to limit a spec run to individual examples or groups
+  #   # you care about by tagging them with `:focus` metadata. When nothing
+  #   # is tagged with `:focus`, all examples get run. RSpec also provides
+  #   # aliases for `it`, `describe`, and `context` that include `:focus`
+  #   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+  #
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+
+  # # Timeout to help mutant
+  # config.around(:each) do |example|
+  #   Timeout.timeout(0.1, &example)
+  # end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mnogootex
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Paolo Brasolin
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-01-06 00:00:00.000000000 Z
+date: 2021-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,59 +16,158 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.2.30
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.2.30
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.18.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.3
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.26
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.9.26
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 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.
+        version: 0.20.0
+description: Многоꙮтех (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.
 email:
 - paolo.brasolin@gmail.com
 executables:
@@ -76,28 +175,49 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
-- ".gitmodules"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - exe/mnogootex
 - lib/mnogootex.rb
-- lib/mnogootex/configuration.rb
-- lib/mnogootex/job.rb
+- lib/mnogootex/cfg.rb
+- lib/mnogootex/cli.rb
+- lib/mnogootex/core_ext.rb
+- lib/mnogootex/defaults.yml
+- lib/mnogootex/job/logger.rb
+- lib/mnogootex/job/porter.rb
+- lib/mnogootex/job/runner.rb
+- lib/mnogootex/job/warden.rb
+- lib/mnogootex/log.rb
+- lib/mnogootex/log/level.rb
+- lib/mnogootex/log/levels.yml
+- lib/mnogootex/log/line.rb
+- lib/mnogootex/log/matcher.rb
+- lib/mnogootex/log/matchers.yml
+- lib/mnogootex/log/processor.rb
+- lib/mnogootex/mnogoo.sh
+- lib/mnogootex/utils.rb
 - lib/mnogootex/version.rb
 - mnogootex.gemspec
+- spec/mnogootex/cfg_spec.rb
+- spec/mnogootex/job/porter_spec.rb
+- spec/mnogootex/job/runner_spec.rb
+- spec/mnogootex/log/processor_spec.rb
+- spec/mnogootex/utils_spec.rb
+- spec/spec_helper.rb
+- tty.gif
 homepage: https://github.com/tetrapharmakon/mnogootex
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,17 +225,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
-summary: Mnogootex (многоꙮтех) is a device to handle the compilation of TeX sources
-  with different preambles at one time.
+summary: Многоꙮтех (mnogootex) is a utility that parallelizes compilation of a LaTeX
+  document using different classes and offers a meaningfully filtered output.
 test_files: []

data/.gitmodules

@@ -1,3 +0,0 @@
-[submodule "mnogootex_classes"]
-	path = mnogootex_classes
-	url = https://paolobrasolin@bitbucket.org/paolobrasolin/mnogootex_classes.git

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.5
-before_install: gem install bundler -v 1.16.1

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "mnogootex"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/mnogootex/configuration.rb

@@ -1,46 +0,0 @@
-# coding: utf-8
-
-require 'yaml'
-
-module Mnogootex
-  class Configuration < Hash
-    DEFAULT = {
-      'animation' => '⣾⣽⣻⢿⡿⣟⣯⣷'
-    }
-
-    CFG_FILENAME = '.mnogootex.yml'.freeze
-
-    def initialize
-      @paths = []
-      merge! DEFAULT
-    end
-
-    def load(pathname = Dir.pwd)
-      scan_cfg Pathname(pathname)
-      filter_cfg
-      merge! load_cfg
-      self
-    end
-
-    private
-
-    def scan_cfg(pathname)
-      @paths << pathname.join(CFG_FILENAME)
-      return if pathname.root?
-      scan_cfg pathname.parent
-    end
-
-    def filter_cfg
-      @paths.
-        select!(&:readable?).
-        reject!(&:zero?)
-    end
-
-    def load_cfg
-      @paths.
-        reverse.
-        map { |pathname| YAML.load_file pathname }.
-        inject(&:merge!) # TODO: deep merge
-    end
-  end
-end

data/lib/mnogootex/job.rb

@@ -1,75 +0,0 @@
-require 'digest'
-require 'tmpdir'
-require 'pathname'
-
-module Mnogootex
-  class Job
-    attr_reader :thread, :stdout_stderr, :log, :ticks, :cls
-
-    def initialize(cls:, target:)
-      @main_path = File.expand_path target
-      @main_basename = File.basename @main_path
-      @main_dirname = File.dirname @main_path
-      raise "File non esiste." unless File.exist? @main_path
-
-      @cls = cls
-      @log = []
-      @ticks = 0
-
-      @id = Digest::MD5.hexdigest(@cls + @main_path)
-    end
-
-    def success?
-      @thread.value.exitstatus == 0
-    end
-
-    def tmp_dirname
-      @tmp_dirname ||= Pathname(Dir.tmpdir).join("mnogootex-#{@id}")
-    end
-
-    def setup
-      FileUtils.cp_r File.join(@main_dirname, '.'), tmp_dirname
-
-      @path = File.join tmp_dirname, @main_basename
-
-      code = File.read @path
-      replace = code.sub /\\documentclass(\[.*?\])?{.*?}/,
-                        "\\documentclass{#{@cls}}"
-
-      File.open @path, "w" do |file|
-        file.puts replace
-      end
-    end
-
-    def run
-      _, @stdout_stderr, @thread = Open3.popen2e(
-        "texfot",
-        "pdflatex",
-        # "latexmk",
-        # "-pdf",
-        "--shell-escape", # TODO: remove me!
-        "--interaction=nonstopmode",
-        @main_basename,
-        chdir: tmp_dirname
-      )
-    end
-
-    def tick_thread
-      Thread.new do
-        # 50ms polling cycle
-        until (line = @stdout_stderr.gets).nil? do
-          sleep 0.05
-          @log << line
-          @ticks += 1
-          draw_status
-          break unless @thread.alive?
-        end
-        # end of life treatment
-        lines = @stdout_stderr.read.lines
-        @log.concat lines
-        @ticks += lines.length
-        draw_status
-      end
-    end
-  end
-end