houcluttex 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 829d946b580113b2b827909a19c48cf232b6073d5967d670503b5d779826ed61
+  data.tar.gz: 7b76686faba0bf7641673f9518afc0ee1aa49541bf524d15df216698221dd5f8
+SHA512:
+  metadata.gz: 4076b9d9a540042ceeb2a3393cb9adb0b53630644229fd5b6ab91196149cfc9ff9f664e14ce708de97db752690492665dda07c8b21a36e74c9ddc2f951cd3de6
+  data.tar.gz: 98d5467b4273daf468eba8e8322fc7774cf2fa153742f3027f1ffeccc03945f892e7451eed376c0b5676af98d89ba4ec3cc8bce323af21117133bf76651e2110

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+.DS_Store
+
+sample/**/*.pdf
+sample/**/*.synctex.gz

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in houcluttex.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ishotihadus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# houcluttex: 放課後クライマックス ClutTeX ガールズ
+
+コンフィグファイルやマジックコメントからのコンフィグを利用して [ClutTeX](https://github.com/minoki/cluttex/) を実行するツールです。
+
+## インストール
+
+    $ gem install houcluttex
+
+## 使い方
+
+    $ cluttex [OPTIONS] [--] INPUT.tex
+
+### コンフィグ
+
+コンフィグは、次の 3 通りで指定できます。下のオプションが優先されます。
+
+- コンフィグファイル（`houcluttex.yml`）
+- マジックコメント
+- コマンドラインオプション
+
+#### コンフィグファイル
+
+yaml 形式で指定します。`houcluttex.yml` をデフォルトとしますが、`houcluttex.yaml`、`houcluttexrc`、`.houcluttexrc` なども可能です。
+コマンドラインオプション `--config` でファイル名を指定できます。
+
+yaml ファイルは Key-value の形式で ClutTeX のオプションを指定します。
+
+```houcluttex.yml
+engine: uplatex
+bibtex: upbibtex
+shell-escape: true
+synctex: 1
+file-line-error: true
+halt-on-error: false
+```
+
+#### マジックコメント
+
+[atom-latex](https://github.com/thomasjo/atom-latex/wiki/Overridding-Build-Settings) のようなマジックコメントを使うことができます。
+
+対応しているのは次のオプションです。
+
+- `root`
+- `engine` / `program`
+- `synctex`
+- `jobname`
+- `makeindex`
+- `bibtex`
+- `format` / `outputFormat`
+- `outputDirectory`
+- `enableSynctex`
+- `enableShellEscape`
+
+`root` オプションは、入力ファイル（`input` オプションの値）を再帰的に `root` オプションで指定されたファイルに書き換えます。
+
+#### コマンドラインオプション
+
+ClutTeX と同様のコマンドラインオプションと、`config` オプション、`cluttex-path` オプションが利用できます。
+
+#### 特別なオプション
+
+`input` オプションで指定したファイル名は、入力ファイルがコマンドラインで与えられなかった場合の入力ファイルとして利用します。
+このオプションはコマンドラインでは利用できません。
+
+`cluttex-path` オプションは ClutTeX のパスを指定します。デフォルトは `cluttex` です。
+
+## ライセンス
+
+この gem は [MIT License](https://opensource.org/licenses/MIT) のもとで利用できます。

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'houcluttex'
+
+# 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

@@ -0,0 +1,8 @@
+#!/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/exe/houcluttex

@@ -0,0 +1,189 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'shellwords'
+require 'yaml'
+
+def convert_bool(str)
+    case str.downcase
+    when 'yes', 'true'
+        true
+    when 'no', 'false'
+        false
+    end
+end
+
+config = {
+    'cluttex-path' => nil,
+    'input' => nil,
+
+    'engine' => nil,
+    'output' => nil,
+    'fresh' => false,
+    'max-iterations' => 3,
+    'change-directory' => false,
+    'watch' => false,
+    'color' => 'auto',
+    'includeonly' => nil,
+    'make-depends' => nil,
+    'tex-option' => [],
+    'dvipdfmx-option' => [],
+    'verbose' => false,
+
+    'makeindex' => nil,
+    'bibtex' => nil,
+    'biber' => nil,
+    'makeglossaries' => nil,
+
+    'shell-escape' => true,
+    'shell-restricted' => false,
+    'synctex' => nil,
+    'file-line-error' => true,
+    'halt-on-error' => true,
+    'interaction' => 'nonstopmode',
+    'jobname' => nil,
+    'fmt' => nil,
+    'output-directory' => nil,
+    'output-format' => 'pdf'
+}
+
+config_file = ['houcluttex.yml', 'houcluttex.yaml', 'houcluttex_config.yml', 'houcluttex_config.yaml', 'houcluttexrc', '.houcluttexrc'].find{|e| File.exist?(e)}
+
+# parse command-line options
+
+argv = ARGV.dup
+config_by_args = {}
+remain_args = []
+
+until argv.empty?
+    arg = argv.shift
+    if arg == '--'
+        remain_args += argv
+        argv = []
+    elsif arg.start_with?('--')
+        m = arg.match(/\A--([^=]+)(=(.*))?\z/)
+        case m[1]
+        when 'fresh', 'change-directory', 'watch', 'verbose', 'shell-escape', 'shell-restricted', 'file-line-error', 'halt-on-error'
+            config_by_args[m[1]] = true
+        when 'no-change-directory', 'no-shell-escape', 'no-file-line-error', 'no-halt-on-error'
+            config_by_args[m[1][3..-1]] = false
+        when 'tex-options', 'dvipdfmx-options'
+            config_by_args[m[1][0..-2]] ||= []
+            config_by_args[m[1][0..-2]] += Shellwords.split(m[3] || argv.shift)
+        when 'tex-option', 'dvipdfmx-option'
+            config_by_args[m[1]] ||= []
+            config_by_args[m[1]] << (m[3] || argv.shift)
+        when 'input'
+            raise 'cannot use `--input` option in command-line'
+        when 'config'
+            config_file = m[3] || argv.shift
+        else
+            config_by_args[m[1]] = m[3] || argv.shift
+        end
+    elsif arg.start_with?('-')
+        case arg
+        when '-e'
+            config_by_args['engine'] = argv.shift
+        when '-o'
+            config_by_args['output'] = argv.shift
+        when '-V'
+            config_by_args['verbose'] = true
+        else
+            warn "option `#{arg}` is ignored"
+        end
+    else
+        remain_args << arg
+    end
+end
+
+# load yaml
+config.merge!(YAML.load_file(config_file)) if config_file
+
+# decide input file
+raise 'multiple input files' if remain_args.size >= 2
+config['input'] = remain_args.first unless remain_args.empty?
+raise 'no input file' if config['input'].nil?
+
+# parse magic comments
+
+loop do
+    raise "input file `#{config['input']}` does not exist" unless File.exist?(config['input'])
+
+    root_file = nil
+    File.foreach(config['input']) do |line|
+        next if line.strip.empty?
+        break unless line[0] == '%'
+        m = line.match(/^%\s*!TEX (\S+)\s*=\s*(.*?)\s*$/)
+        next unless m
+        key = m[1].tr('_-', '').downcase
+        value = m[2]
+        case key
+        when 'root'
+            root_file = value
+        when 'engine', 'synctex', 'jobname', 'makeindex', 'bibtex'
+            config[key] = value
+        when 'program'
+            config['engine'] = value
+        when 'format', 'outputformat'
+            config['output-format'] = value
+        when 'outputdirectory'
+            config['output-directory'] = value
+        when 'enablesynctex'
+            value = convert_bool(value)
+            raise 'magic option `enableSynctex` must be boolean' if value.nil?
+            config['synctex'] = value ? (config['synctex'] || 1) : nil
+        when 'enableshellescape'
+            value = convert_bool(value)
+            raise 'magic option `enableShellEscape` must be boolean' if value.nil?
+            config['shell-escape'] = value
+        else
+            warn "magic comment `#{m[1]}` is ignored"
+        end
+    end
+    break if root_file.nil? || config['input'] == root_file
+    config['input'] = root_file
+end
+
+# merge config
+config.merge!(config_by_args)
+
+# specify command
+config['cluttex-path'] ||= 'cluttex'
+`type #{config['cluttex-path']} 2>&1`
+raise "command `#{config['cluttex-path']}` not found" unless $?.success?
+
+if config['verbose']
+    warn 'ClutTeX options:'
+    config.each do |k, v|
+        warn "  #{k}: #{v.inspect}"
+    end
+end
+
+# generate command
+
+cmd_args = []
+
+config.each do |k, v|
+    case k
+    when 'cluttex-path', 'input'
+        # ignore
+    when 'tex-option', 'dvipdfmx-option'
+        v.each{|e| cmd_args << "--#{k}=#{e}"}
+    when 'includeonly'
+        cmd_args << (v.is_a?(Array) ? "--#{k}=#{v.join(',')}" : "--#{k}=#{v}") if v
+    when 'fresh', 'watch', 'verbose', 'shell-restricted'
+        cmd_args << "--#{k}" if v
+    when 'change-directory', 'shell-escape', 'file-line-error', 'halt-on-error'
+        cmd_args << (v ? "--#{k}" : "--no-#{k}")
+    else
+        cmd_args << "--#{k}=#{v}" unless v.nil?
+    end
+end
+
+cmd_args << '--'
+cmd_args << config['input']
+
+FileUtils.mkdir_p(config['output-directory']) if config['output-directory']
+
+system(config['cluttex-path'], *cmd_args)

data/houcluttex.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$:.unshift(lib) unless $:.include?(lib)
+require 'houcluttex/version'
+
+Gem::Specification.new do |spec|
+    spec.name = 'houcluttex'
+    spec.version       = Houcluttex::VERSION
+    spec.authors       = ['Ishotihadus']
+    spec.email         = ['hanachan.pao@gmail.com']
+
+    spec.summary       = 'configurable cluttex wrapper'
+    spec.description   = 'configurable cluttex wrapper'
+    spec.homepage      = 'https://github.com/ishotihadus/houcluttex'
+    spec.license       = 'MIT'
+
+    # Specify which files should be added to the gem when it is released.
+    # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+    spec.files = Dir.chdir(File.expand_path(__dir__)) do
+        `git ls-files -z`.split("\x0").reject{|f| f.match(%r{^(test|spec|features)/})}
+    end
+    spec.bindir        = 'exe'
+    spec.executables   = spec.files.grep(%r{^exe/}){|f| File.basename(f)}
+    spec.require_paths = ['lib']
+
+    spec.add_development_dependency 'bundler'
+    spec.add_development_dependency 'rake'
+end

data/lib/houcluttex/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Houcluttex
+    VERSION = '1.0.0'
+end

data/lib/houcluttex.rb

@@ -0,0 +1,6 @@
+require "houcluttex/version"
+
+module Houcluttex
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sample/magic/test.bib

@@ -0,0 +1,7 @@
+@inproceedings{testcite,
+author = {Kasuga, Mirai and Yabuki, Kana and Tanaka, Kotoha},
+booktitle = {THE IDOLM@STER MILLION THE@TER GENERATION 17 STAR ELEMENTS},
+pages = {1--7},
+title = {Episode. {T}iara},
+year = {2019}
+}

data/sample/magic/test.tex

@@ -0,0 +1,15 @@
+% !TEX engine = uplatex
+% !TEX enableSynctex = true
+% !TEX enableShellEscape = true
+% !TEX bibtex = upbibtex
+
+\documentclass[uplatex]{jsarticle}
+\bibliographystyle{plain}
+
+\begin{document}
+
+本気はレプリカじゃない　だからそれぞれ 立ち向かうべき　今日があるって\cite{testcite}
+
+\bibliography{test}
+
+\end{document}

data/sample/yaml/houcluttex.yml

@@ -0,0 +1,7 @@
+engine: uplatex
+bibtex: upbibtex
+shell-escape: true
+synctex: 1
+file-line-error: true
+halt-on-error: false
+input: test.tex

data/sample/yaml/test.bib

@@ -0,0 +1,7 @@
+@inproceedings{testcite,
+author = {Kasuga, Mirai and Yabuki, Kana and Tanaka, Kotoha},
+booktitle = {THE IDOLM@STER MILLION THE@TER GENERATION 17 STAR ELEMENTS},
+pages = {1--7},
+title = {Episode. {T}iara},
+year = {2019}
+}

data/sample/yaml/test.tex

@@ -0,0 +1,10 @@
+\documentclass[uplatex]{jsarticle}
+\bibliographystyle{plain}
+
+\begin{document}
+
+本気はレプリカじゃない　だからそれぞれ 立ち向かうべき　今日があるって\cite{testcite}
+
+\bibliography{test}
+
+\end{document}

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: houcluttex
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ishotihadus
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: configurable cluttex wrapper
+email:
+- hanachan.pao@gmail.com
+executables:
+- houcluttex
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/houcluttex
+- houcluttex.gemspec
+- lib/houcluttex.rb
+- lib/houcluttex/version.rb
+- sample/magic/test.bib
+- sample/magic/test.tex
+- sample/yaml/houcluttex.yml
+- sample/yaml/test.bib
+- sample/yaml/test.tex
+homepage: https://github.com/ishotihadus/houcluttex
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: configurable cluttex wrapper
+test_files: []