mnogootex 0.2.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f84bc4403ed2b6c0cf0ced691e4ebf69449de8fb
-  data.tar.gz: 826c773e078eb685b7dacfa0b7c9936a07b5c29c
+SHA256:
+  metadata.gz: 654469a2719e7a34e16be659b3b59cbf8611f1f5025ccba19ba1bea60e35d87b
+  data.tar.gz: cc026af91f6270d36fd5affa76565e49ba781638965cb0b377c8775d84cbc8fb
 SHA512:
-  metadata.gz: 5dd132fa97940367f3aab6b6ef9a284ab5bb7164adb5b7c20f6aaeaa791218f13d33af0529fcb5809f37755e434d09eda3938488a083f0706c7f33b6642d7e77
-  data.tar.gz: 81aecc276bc9a5f880bb5b92043859c0e130ec5b07b5caa0b1190b1f1cafef75e531f4271bd59d2a40475cd41169a8d42363dfdc681df73b45bcd1a5c4df5e29
+  metadata.gz: 2cf80aa5a52753bfec92a5ce7a6ff1c0a1d3d84376fdc897ed364097b52126245e5852284b474e81adee288c30d316753cb0bd38b8d75fbf541345512c834754
+  data.tar.gz: a71bda28d8eded4790cb3b40b6b673c58e3f96e630e42bb512c80afd004f869f559938ff83c7fb358780f59007c4117cad5bd0cf0b20e9d956c9c1d81425cfac

data/.github/workflows/main.yml

@@ -0,0 +1,41 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  main:
+    name: >-
+      ${{ matrix.os }} ${{ matrix.ruby }}
+    runs-on: ${{ matrix.os }}-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu, macos ]
+        ruby: [ '2.6', '2.7', '3.0' ]
+
+    steps:
+
+      - name: Checkout repo
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Cache Ruby gems
+        uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: gems-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('Gemfile', 'mnogootex.gemspec') }}
+          restore-keys: gems-${{ matrix.os }}-${{ matrix.ruby }}-
+
+      - name: Install Ruby gems
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 3 --retry 3
+
+      - name: Run tests
+        run: bundle exec rake spec:rspec

data/.gitignore

@@ -51,3 +51,6 @@ Gemfile.lock
 
 # rspec failure tracking
 .rspec_status
+
+# byebug history
+**/.byebug_history

data/.rspec

@@ -1,3 +1 @@
---format documentation
---color
 --require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+Metrics/LineLength:
+  Max: 120
+Layout/DotPosition:
+  EnforcedStyle: trailing
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+# TODO: re-enable
+Style/Documentation:
+  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at TODO: Write your email address. All
+reported by contacting the project team at <paolo.brasolin@gmail.com>. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

data/Gemfile

@@ -1,6 +1,7 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-# Specify your gem's dependencies in mnogootex.gemspec
 gemspec

data/Guardfile

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  watch(dsl.rspec.spec_helper) { dsl.rspec.spec_dir }
+  watch(dsl.rspec.spec_files)
+
+  # Ruby files
+  dsl.watch_spec_files_for(dsl.ruby.lib_files)
+end
+
+# # TODO: refactor the following into a new version of guard-mutant
+
+# require 'mutant'
+# require 'dry/inflector'
+# require 'guard/compat/plugin'
+
+# # NOTE: :: is mandatory for inline guards
+# module ::Guard
+#   class Mutant < Plugin
+#     def initialize(options = {})
+#       opts = options.dup
+#       # @my_option = opts.delete(:my_special_option)
+#       super(opts) # important to call + avoid passing options Guard doesn't understand
+#     end
+
+#     # TODO: how would this make sense?
+#     # def run_all; end
+
+#     def run_on_modifications(paths)
+#       inflector = Dry::Inflector.new
+#       subjects = paths.map do |path|
+#         match = path.match(%r{(?:spec|lib)\/(.*?)(?:_spec)?.rb}).captures.first
+#         inflector.camelize match
+#       end
+#       succesful = ::Mutant::CLI.run(%w[--use rspec --fail-fast] + subjects)
+#       throw :task_has_failed unless succesful
+#       self
+#     end
+#   end
+# end
+
+# guard :mutant do
+#   require 'guard/rspec/dsl'
+#   dsl = Guard::RSpec::Dsl.new(self)
+
+#   # RSpec files
+#   # watch(dsl.rspec.spec_helper) { dsl.rspec.spec_dir }
+#   watch(dsl.rspec.spec_files)
+
+#   # Ruby files
+#   dsl.watch_spec_files_for(dsl.ruby.lib_files)
+# end

data/README.md

@@ -1,38 +1,184 @@
 # Многоꙮтех
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mnogootex`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+[![Build Status](https://travis-ci.org/paolobrasolin/mnogootex.svg?branch=master)](https://travis-ci.org/paolobrasolin/mnogootex)
+[![Gem Version](https://badge.fury.io/rb/mnogootex.svg)](https://badge.fury.io/rb/mnogootex)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code Climate](https://codeclimate.com/github/paolobrasolin/mnogootex/badges/gpa.svg)](https://codeclimate.com/github/paolobrasolin/mnogootex)
+<!-- [![Test Coverage](https://codeclimate.com/github/paolobrasolin/mnogootex/badges/coverage.svg)](https://codeclimate.com/github/paolobrasolin/mnogootex/coverage) -->
+<!-- [![Inline docs](http://inch-ci.org/github/paolobrasolin/mnogootex.svg?branch=master)](http://inch-ci.org/github/paolobrasolin/mnogootex) -->
+<!-- [![Issue Count](https://codeclimate.com/github/paolobrasolin/mnogootex/badges/issue_count.svg)](https://codeclimate.com/github/paolobrasolin/mnogootex) -->
+
+Многоꙮтех (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.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+The only requirement is [Ruby](https://www.ruby-lang.org) (>=2.5 as earlier versions are untested).
+
+To install многоꙮтех execute
+
+    gem install mnogootex
+    
+To install `mnogoo` (strongly recommended shell integration) add this to your shell profile
 
-```ruby
-gem 'mnogootex'
-```
+    [ -s "$(mnogootex mnogoo)" ] && . "$(mnogootex mnogoo)"
 
-And then execute:
+## Quick start
 
-    $ bundle
+Set up your `LaTeX` project as usual - let's say its main file is `~/project/main.tex` and contains `\documentclass{...}`.
 
-Or install it yourself as:
+Create a configuration file `~/project/.mnogootex.yml`
+containing the list of document classes you want to compile your
+project against:
 
-    $ gem install mnogootex
+    jobs:
+      - scrartcl
+      - article
+      - book
+      
+Run `mnogootex go ~/project/main.tex` and enjoy the technicolor:
+
+![Demo TTY GIF](tty.gif?raw=true "Demo TTY GIF")
 
 ## Usage
 
-TODO: Write usage instructions here
+In essence, Многоꙮтех
+1. takes the _source_ directory of a project, 
+2. clones it into _target_ directories (one for each _job_),
+3. applies a different source code transformation to each one and then
+4. attempts to compile them.
+
+Its convenience lies in the fact that it
+* automates the setup process,
+* parallelizes compilation,
+* filters and colour codes the infamous waterfall logs and
+* allows you to easily navigate through targets/source folders. 
+
+Многоꙮтех can be invoked from commandline in two ways: `mnogootex` and `mnogoo`.
+The latter is more powerful and requires an extra [installation](#installation) step.
+
+Commands listed below can be passed to both unless otherwise stated.
+
+### Commands
+
+> **NOTATION:** `[FOO]` means that _`FOO` is optional_ while `FOO ...` means _one or more `FOO`s_. 
+
+#### `help [COMMAND]`
+
+Prints the help for `COMMAND` (or all commands if none is given).
+
+#### `mnogoo`
+
+Prints the location of the `mnogoo` shell integration script.
+Useful only for its [installation](#installation).
+
+#### `go [JOB ...] [MAIN]`
+
+Run given compilation `JOB`s for the `MAIN` document.
+
+If no `JOB` list is given then all of them are run.
+They are deduced from the [configuration](#configuration).
+
+If no `MAIN` document is given then it's deduced from either
+your current working directory or the [configuration](#configuration).
+
+#### `dir [JOB] [MAIN]`
+
+Print `JOB`'s temporary directory for the `MAIN` document.
+
+If no `JOB` is given then it prints the source directory.
+
+If no `MAIN` document is given then it's deduced from either
+your current working directory or the [configuration](#configuration).
+
+#### `cd [JOB] [MAIN]`
+
+> **NOTE:** recognized by `mnogoo` only.
+
+Checks into `JOB`'s temporary directory for the `MAIN` document.
+
+If no `JOB` is given then it checks into the source directory.
+
+If no `MAIN` document is given then it's deduced from either
+your current working directory or the [configuration](#configuration).
+
+#### `clobber`
+
+Deletes all temporary files.
+Useful to free up some space from time to time.
+
+#### `pdf [JOB ...] [MAIN]`
+
+Print `JOB`'s output PDF path for the `MAIN` document.
+
+If no `JOB` list is given then all their output PDFs paths are printed.
+They are deduced from the [configuration](#configuration).
+
+If no `MAIN` document is given then it's deduced from either
+your current working directory or the [configuration](#configuration).
+
+#### `open [JOB ...] [MAIN]`
+
+> **NOTE:** recognized by `mnogoo` only.
+
+Open `JOB`'s output PDF for the `MAIN` document with your default viewer.
+
+If no `JOB` list is given then all their output PDFs are opened.
+They are deduced from the [configuration](#configuration).
+
+If no `MAIN` document is given then it's deduced from either
+your current working directory or the [configuration](#configuration).
+
+### Configuration
+
+Многоꙮтех is configured through [`YAML`](https://learnxinyminutes.com/docs/yaml/)
+files named `.mnogootex.yml` put into your projects' root directory.
+
+When  loads a configuration it also looks up for `.mnogootex.yml`
+files in all parent directories to merge then together (from the
+shallowest to the deepest path).  This means that e.g. you can keep
+a configuration file in your home folder and use it as a global
+configuration for all you projects, while overwriting only specific
+options in the configuration files of each one.
+
+Многоꙮтех currently accepts three options.
+
+#### `spinner`
+
+This option is a string whose characters are the frames used to
+animate the spinners for the command line interface.
+
+    # Default value:
+    spinner: ⣾⣽⣻⢿⡿⣟⣯⣷
+
+#### `commandline`
+
+This option is an array of the components for the commandline used
+to compile documents.
+
+    # Default value:
+    commandline:
+      - latexmk
+      - -pdf
+      - --interaction=nonstopmode
+
+#### `work_path`
 
-## Development
+This option is an override for the path where compilation happens.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+    # Default value:
+    work_path: null
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+By default each run happens in a new empty folder. Overriding this allows you to easily reach the compilation artifacts, but leaves handling cleanup and conflicts with previous runs up to you.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mnogootex. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/paolobrasolin/mnogootex. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -40,4 +186,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Mnogootex project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/mnogootex/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the многоꙮтех project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/paolobrasolin/mnogootex/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,6 +1,27 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
 
-RSpec::Core::RakeTask.new(:spec)
+# require 'mutant'
+# require 'dry/inflector'
 
-task :default => :spec
+require 'rspec/core/rake_task'
+
+namespace :spec do
+  desc 'run RSpec'
+  RSpec::Core::RakeTask.new(:rspec) do |task|
+    task.rspec_opts = '--format documentation'
+  end
+
+  desc 'run SimpleCov'
+  task :simplecov do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task['spec:rspec'].invoke
+  end
+
+  # desc 'run Mutant'
+  # task :mutant, [:subject] do |_, args|
+  #   subjects = [args[:subject]].compact
+  #   subjects << 'Mnogootex*' if subjects.empty?
+  #   successful = ::Mutant::CLI.run(%w[--use rspec --fail-fast] + subjects)
+  #   raise('Mutant task is not successful') unless successful
+  # end
+end

data/exe/mnogootex

@@ -1,96 +1,6 @@
 #!/usr/bin/env ruby
-# coding: utf-8
+# frozen_string_literal: true
 
 require 'mnogootex'
 
-
-# require 'pathname'
-
-# target = ARGV[0]
-# target_path = File.expand_path target
-# cfg = Mnogootex::Configuration.new
-# cfg.load target_path
-
-require 'tmpdir'
-require 'fileutils'
-require 'open3'
-
-require 'colorize'
-
-target = ARGV[0]
-
-
-raise "No parameters given." if ARGV.length.zero?
-
-if ARGV.length == 3
-  raise "Unknown command." unless %w{show view open}.include? ARGV[1].downcase
-  job = Mnogootex::Job.new cls: ARGV[2], target: File.expand_path(target)
-  pdf = Dir.glob("#{job.tmp_dirname}/*.pdf").first
-  raise "PDF non esiste." unless File.exist? pdf
-  `open #{pdf}`
-  exit
-end
-
-puts "Mnogootex v#{Mnogootex::VERSION}"
-
-main_path = File.expand_path(target)
-main_basename = File.basename main_path
-main_dirname = File.dirname main_path
-
-cfg = Mnogootex::Configuration.new
-cfg.load main_dirname
-
-raise "File non esiste." unless File.exist? main_path
-
-@documentclasses = cfg['compile_with']
-
-$jobs = []
-$threads = []
-$draw_threads = []
-
-$threads = []
-
-$anim = cfg['animation'].freeze
-
-STDOUT.sync = true
-
-def draw_status
-  icons = $jobs.map do |j|
-    icon = $anim[j.ticks % $anim.length]
-    case j.thread.status
-    when 'sleep', 'run', 'aborting'
-      icon.yellow
-    when false, nil # exited (normally or w/ error)
-      j.success? ? icon.green : icon.red
-    end
-  end
-  print '  Jobs: ' + icons.join + "\r"
-end
-
-draw_status
-
-@documentclasses.each_with_index do |cls, index|
-  job = Mnogootex::Job.new cls: cls, target: main_path
-  job.setup
-  job.run
-
-  $jobs << job
-
-  $draw_threads << job.tick_thread
-  $threads << job.thread
-end
-
-$threads.map(&:join)
-$draw_threads.map(&:join)
-
-puts
-
-puts '  Details:'
-$jobs.each do |job|
-  if job.success?
-    puts '    ' + "✔".green + ' ' + File.basename(job.cls)
-  else
-    puts '    ' + "✘".red + ' ' + File.basename(job.cls)
-    puts job.log[2..-2].join.gsub(/^/,' '*6).chomp.red
-  end
-end
+Mnogootex::CLI.start ARGV

data/lib/mnogootex/cfg.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'pathname'
+
+require 'mnogootex/core_ext'
+
+module Mnogootex
+  module Cfg
+    BASENAME = '.mnogootex.yml'
+    DEFAULTS = YAML.load_file(Pathname.new(__dir__).join('defaults.yml'))
+
+    def self.load_descending(pathname:, basename:)
+      pathname.realpath.descend.
+        map { |path| path.join(basename) }.
+        select(&:exist?).reject(&:zero?).
+        map { |path| YAML.load_file(path) }.
+        reduce(&:merge!)
+    end
+
+    def self.recombobulate(*args)
+      try_args(*args) || try_link(*args) || try_cfgs(*args)
+    end
+
+    class << self
+      private
+
+      def try_args(*args)
+        main = Pathname.new(args.fetch(-1, ''))
+        return unless main.file?
+
+        main = main.realpath
+        cfg = load_descending(pathname: main.dirname, basename: BASENAME)
+        jobs = args[0..-2].unless(&:empty?)
+
+        [jobs, main, cfg]
+      end
+
+      def try_link(*args)
+        link = Pathname.pwd.ascend.map { |p| p.join('.mnogootex.src') }.detect(&:symlink?)
+        return if link.nil?
+
+        main = link.readlink.realpath
+        cfg = load_descending(pathname: main.dirname, basename: BASENAME)
+        jobs = args
+
+        [jobs, main, cfg]
+      end
+
+      def try_cfgs(*args)
+        yaml = Pathname.pwd.ascend.map { |p| p.join('.mnogootex.yml') }.detect(&:file?)
+        return if yaml.nil?
+
+        cfg = load_descending(pathname: yaml.dirname, basename: BASENAME)
+        main = yaml.dirname.join(cfg.fetch('main', '')).if(&:file?)&.realpath
+        jobs = args
+
+        [jobs, main, cfg]
+      end
+    end
+  end
+end

data/lib/mnogootex/cli.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'pathname'
+
+require 'mnogootex/utils'
+require 'mnogootex/job/warden'
+require 'mnogootex/job/porter'
+require 'mnogootex/cfg'
+
+module Mnogootex
+  class CLI < Thor
+    IS_MNOGOO = (ENV['IS_MNOGOO'] == 'true')
+
+    def self.basename
+      IS_MNOGOO ? 'mnogoo' : super
+    end
+
+    desc 'cd [JOB] [MAIN]',
+         'Check into dir of JOB (or source) for MAIN (or inferred) document'
+    def cd(*args); end
+
+    desc 'open [JOB ...] [MAIN]',
+         'Open PDF of each (or every) JOB for MAIN (or inferred) document'
+    def open(*args); end
+
+    remove_command :cd, :open unless IS_MNOGOO
+
+    desc 'mnogoo',
+         'Print path of the shell wrapper script'
+    def mnogoo
+      puts Pathname.new(__dir__).join('mnogoo.sh').realpath
+    end
+
+    desc 'clobber',
+         'Clean up all temporary files'
+    def clobber
+      # NOTE: this is a tad slow - using shell would improve that
+      # TODO: this does not account for custom work_path
+      tmp_dir = Pathname.new(Dir.tmpdir).join('mnogootex')
+      tmp_dir_size = Mnogootex::Utils.humanize_bytes Mnogootex::Utils.dir_size(tmp_dir)
+      print "Freeing up #{tmp_dir_size}... "
+      FileUtils.rm_r tmp_dir, secure: true if tmp_dir.directory?
+      puts 'Done.'
+    end
+
+    desc 'go [JOB ...] [MAIN]',
+         'Run each (or every) JOB for MAIN (or inferred) document'
+    def go(*args)
+      _, main, cfg = Mnogootex::Cfg.recombobulate(*args)
+      cfg = Mnogootex::Cfg::DEFAULTS.merge cfg
+      Mnogootex::Job::Warden.new(source: main, configuration: cfg).start
+    end
+
+    desc 'dir [JOB] [MAIN]',
+         'Print dir of JOB (or source) for MAIN (or inferred) document'
+    def dir(*args)
+      jobs, main, cfg = Mnogootex::Cfg.recombobulate(*args)
+
+      if jobs.empty?
+        puts main.dirname
+      else
+        jobs.map! { |hid| Mnogootex::Job::Porter.new hid: hid, source_path: main, work_path: cfg['work_path'] }
+        jobs.map!(&:target_dir)
+        puts jobs
+      end
+    end
+
+    desc 'pdf [JOB ...] [MAIN]',
+         'Print PDF path of each (or every) JOB for MAIN (or inferred) document'
+    def pdf(*args)
+      jobs, main, cfg = Mnogootex::Cfg.recombobulate(*args)
+
+      jobs = cfg['jobs'] if jobs.empty?
+      jobs.map! { |hid| Mnogootex::Job::Porter.new hid: hid, source_path: main, work_path: cfg['work_path'] }
+      jobs.map! { |porter| porter.target_path.sub_ext('.pdf') }
+      puts jobs
+    end
+  end
+end

data/lib/mnogootex/core_ext.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Object
+  def if
+    tap { |object| break unless yield object }
+  end
+
+  def unless
+    tap { |object| break if yield object }
+  end
+end

data/lib/mnogootex/defaults.yml

@@ -0,0 +1,7 @@
+# This is the default configuration file
+spinner: ⣾⣽⣻⢿⡿⣟⣯⣷
+commandline:
+  - latexmk
+  - -pdf
+  - --interaction=nonstopmode
+work_path: null