lbt 0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 61cb8ee73b25172d9eccfc116cd96cfb5c80fe8b5569bb070ecf8d5bb678bb19
+  data.tar.gz: 79854bfca082e2aadf712c89f91d514163eb87d9465105cb59d358004595dc7d
+SHA512:
+  metadata.gz: bdb858eec9763e0df398028d895d5f3091d2ff2b682246210ff2cf43bc508fdf0ed266a458811db29e47eec52ba1072e09710b2850951387a7c88a3bb118c548
+  data.tar.gz: b956421ce68031ed88d80c4a67c6c8b71a626aeb3cf31f8b4e1b3506906818337bcc55e96c00eeec1cfc1ba7ea6de1636e2decb97cf9b6ea2faf066c0df0d73c

data/bin/lbt

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'lbt'
+include Lbt
+case ARGV[0]
+when "new"
+  case ARGV.size
+  when 2 then create ARGV[1]
+  when 3 then create ARGV[1], ARGV[2]
+  when 4 then create ARGV[1], ARGV[2], ARGV[3]
+  else return
+  end
+when "build"
+  build
+when "part_typeset"
+  return unless ARGV.size == 2
+  part_typeset ARGV[1]
+when "renum"
+  renum
+else
+  $stderr.print <<~EOS
+  Usage: lbt command [argument]
+  The command and argument are one of:
+    new directory [document_style [build_directory]]: create a new working directory.
+      document_style: article, book (default) or beamer
+      build_directory: It will be made under the directory (the first argument). The default is _build.
+    build: build a pdf file from all the source files.
+    part_typeset file_or_numbers: build a pdf file from a single source file.
+      example: part_typeset 1-2-2 => part_typeset part1/chap2/sec2.xxx
+    renum: renumber the source files.
+  EOS
+end

data/lib/lbt/build.rb

@@ -0,0 +1,36 @@
+require_relative 'utils.rb'
+
+module Lbt
+  # Typeset LaTeX source files into a PDF file.
+  def build
+    m = File.read(".config").match(/^build_dir = (.*)$/)
+    build_dir = m[1] ? m[1] : "_build"
+    raise "main.tex not exist." unless File.exist?('main.tex')
+    mkdir build_dir unless Dir.exist?(build_dir)
+
+    # Build main.tex
+    main_tex = File.read('main.tex')
+    m = /\\title(\[(.*?)\])?\s*\{(.*?)\}/.match(main_tex.remove_tex_comment)
+    # Beamer has \title[short title]{title} command.
+    # Other documentclasses don't have such short style option.
+    title = m[2] || m[3]
+    files = PCS.new.to_a
+    input_commands = files.map{|f| "\\input{#{f.ext('.tex')}}\n"}.flatten.join
+    main_tex = main_tex.sub(/\\end{document}/, "#{input_commands}\n\\end{document}")
+    File.write("#{build_dir}/main.tex", main_tex)
+    # copy or convert the files into build_dir
+    cp_conv build_dir
+    # Typeset
+    cur_dir = Dir.pwd
+    cd build_dir
+    system "latexmk -lualatex -pdflualatex=\"lualatex --halt-on-error %O %S\" main.tex"
+    cd cur_dir
+    
+    # Copy the pdf file.
+    temp = "#{build_dir}/main.pdf"
+    target = "#{title}.pdf"
+    unless File.exist?(target) && File.mtime(temp) <= File.mtime(target)
+      cp temp, target
+    end
+  end
+end

data/lib/lbt/create.rb

@@ -0,0 +1,218 @@
+require 'fileutils'
+require 'base64'
+
+module Lbt
+=begin rdoc
+The create method creates a source file directory and put some templates in the directory.
+
+Parameters are:
+
+[dir] The name of the source file directory
+[document\_class] The document class of the LaTeX source file. For example, article, book and beamer.
+[build\_dir] The working directory in which typeset is carried out.
+=end
+  def create dir, document_class="book", build_dir="_build"
+    raise "Argument error." unless dir.is_a?(String) && dir =~ /[[:^space:]]+/
+    raise "#{dir} already exists." if Dir.exist?(dir)
+    mkdir_p(dir)
+    File.write("#{dir}/.config", "build_dir = #{build_dir}\n")
+    helper_tex = <<~EOS
+    \\usepackage{amsmath,amssymb}
+    \\usepackage[luatex]{graphicx}
+    \\usepackage{tikz}
+    \\usepackage[margin=2.4cm]{geometry}
+    \\usepackage[colorlinks=true,linkcolor=black]{hyperref}
+    % If your source includes Markdown, you probably need the following lines.
+    % It is because Pandoc generates some undefined commands.
+    % The Pandoc template file shows how to define them.
+    % You can see it by 'pandoc --print-default-template=latex'.
+    \\providecommand{\\tightlist}{%
+      \\setlength{\\itemsep}{0pt}\\setlength{\\parskip}{0pt}}
+    EOS
+
+    if ["book", "ltjsbook"].include? document_class
+        main_tex = <<~EOS
+        \\documentclass{#{document_class}}
+        \\input{helper.tex}
+        \\title{Title}
+        \\author{Author}
+        \\begin{document}
+        \\frontmatter
+        \\begin{titlepage}
+        \\input{cover.tex}
+        \\end{titlepage}
+        \\tableofcontents
+        \\mainmatter
+
+        \\end{document}
+      EOS
+
+      cover_tex = <<~EOS
+        \\newgeometry{margin=2.4cm}
+        \\begin{center}
+        \\begin{tikzpicture}
+          \\node at (0,0) {\\includegraphics[width=100pt]{gecko.png}};
+          \\node at (70pt,0) {\\includegraphics[width=100pt]{gecko.png}};
+          \\node at (140pt,0) {\\includegraphics[width=100pt]{gecko.png}};
+          \\node at (210pt,0) {\\includegraphics[width=100pt]{gecko.png}};
+          \\node at (280pt,0) {\\includegraphics[width=100pt]{gecko.png}};
+          \\node at (350pt,0) {\\includegraphics[width=100pt]{gecko.png}};
+        \\end{tikzpicture}
+        \\end{center}
+
+        \\vspace{2cm}
+        \\begin{center}
+        {\\fontsize{64}{0} \\selectfont Title}
+        \\end{center}
+        \\vspace{1cm}
+        \\begin{center}
+        {\\huge Author}
+        \\end{center}
+
+        \\vspace{9cm}
+        %\\vspace{6.5cm}
+        %\\begin{center}
+        %{\\Large Foobar University}
+        %\\end{center}
+        %\\begin{center}
+        %{\\Large School of Foobar}
+        %\\end{center}
+
+        \\vspace{3cm}
+        \\begin{center}
+        \\begin{tikzpicture}
+          \\node at (0,0) {\\includegraphics[width=100pt]{gecko.png}};
+          \\node at (70pt,0) {\\includegraphics[width=100pt]{gecko.png}};
+          \\node at (140pt,0) {\\includegraphics[width=100pt]{gecko.png}};
+          \\node at (210pt,0) {\\includegraphics[width=100pt]{gecko.png}};
+          \\node at (280pt,0) {\\includegraphics[width=100pt]{gecko.png}};
+          \\node at (350pt,0) {\\includegraphics[width=100pt]{gecko.png}};
+        \\end{tikzpicture}
+        \\end{center}
+        \\restoregeometry
+      EOS
+
+      File.write("#{dir}/main.tex", main_tex)
+      File.write("#{dir}/helper.tex", helper_tex)
+      File.write("#{dir}/cover.tex", cover_tex)
+      gecko_png = __dir__+"/../../images/gecko.png"
+      cp(gecko_png, "#{dir}/gecko.png")
+    elsif ["article", "ltjsarticle"].include? document_class
+      main_tex = <<~EOS
+      \\documentclass{#{document_class}}
+      \\input{helper.tex}
+      \\title{Title}
+      \\author{Author}
+      \\begin{document}
+      \\maketitle
+      \\tableofcontents
+
+      \\end{document}
+      EOS
+      File.write("#{dir}/main.tex", main_tex)
+      File.write("#{dir}/helper.tex", helper_tex)
+    elsif document_class == "beamer"
+      main_tex = <<~EOS
+      \\documentclass[utf8,aspectratio=149]{beamer}
+      \\mode<presentation>
+      {
+        \\usetheme{Warsaw}
+        \\setbeamercovered{transparent}
+      }
+      \\input{helper.tex}
+      % Don't show navigation symbol => If you want to show it, comment out the following line.
+      \\setbeamertemplate{navigation symbols}{}
+      \\title[short\\_title] % (optional, use only with long paper titles)
+      {titile}
+      \\subtitle
+      {substitile}
+      \\author[short\\_author] % (optional, use only with lots of authors)
+      {author \\\\ \\texttt{sample\\_address@email.com}}
+      % - Give the names in the same order as the appear in the paper.
+      % - Use the \\inst{?} command only if the authors have different
+      %   affiliation.
+      \\institute[short\\_institute] % (optional, but mostly needed)
+      {
+      %  \\inst{1}%
+        Department of Mathematics and Technology\\\\
+        School of Education and Humanities\\\\
+        XXXX University
+      }
+      % - Use the \\inst command only if there are several affiliations.
+      % - Keep it simple, no one is interested in your street address.
+      \\date[short\\_date] % (optional, should be abbreviation of conference name)
+      {XXXX meeting on Wednesday, April 27 2022}
+      % - Either use conference name or its abbreviation.
+      % - Not really informative to the audience, more for people (including
+      %   yourself) who are reading the slides online
+      \\subject{subject}
+      % If you have a file called "university-logo-filename.xxx", where xxx
+      % is a graphic format that can be processed by lualatex,
+      % resp., then you can add a logo as follows:
+      % \\pgfdeclareimage[height=0.5cm]{university-logo}{university-logo-filename}
+      % \\logo{\\pgfuseimage{university-logo}}
+      \\begin{document}
+      \\begin{frame}
+        \\titlepage
+      \\end{frame}
+      \\begin{frame}{Outline}
+        \\tableofcontents
+      %  \\begin{center}
+      %    \\includegraphics[width=6cm,keepaspectratio]{photo.jpg}
+      %  \\end{center}
+      \\end{frame}
+
+      \\end{document}
+      EOS
+      helper_tex = <<~EOS
+      \\usepackage{luatexja}
+      % 和文のデフォルトをゴシック体に
+      \\renewcommand{\\kanjifamilydefault}{\\gtdefault}
+      \\usepackage{amsmath,amssymb}
+      \\usepackage{tikz}
+      \\usepackage[absolute,overlay]{textpos}
+      EOS
+      sec1_tex = <<~EOS
+      % This is a sample latex file for the beamer documentclass.
+      \\begin{frame}{introduction}
+      About something
+      \\begin{itemize}
+        \\item item 1
+        \\item<2> item 2
+      \\end{itemize}
+      About another thing
+      \\begin{enumerate}
+        \\item<3> item 1
+        \\item<3-4> item 2
+      \\end{enumerate}
+      \\alert{alert message, which is red.}
+      \\end{frame}
+      % Show a photo that extends to the whole slide view.
+      \\begin{frame}
+      \\begin{textblock*}{128mm}(0pt,0pt)
+      \\includegraphics[width=128mm,height=96mm,keepaspectratio]{lagoon.jpg}
+      \\end{textblock*}
+      \\end{frame}
+      EOS
+      File.write("#{dir}/main.tex", main_tex)
+      File.write("#{dir}/helper.tex", helper_tex)
+      File.write("#{dir}/sec1.tex", sec1_tex)
+      lagoon_jpg = __dir__+"/../../images/lagoon.jpg"
+      cp(lagoon_jpg, "#{dir}/lagoon.jpg")
+    else
+      main_tex = <<~EOS
+      \\documentclass{#{document_class}}
+      \\input{helper.tex}
+      \\title{Title}
+      \\author{Author}
+      \\begin{document}
+      \\maketitle
+      \\tableofcontents
+
+      \\end{document}
+      EOS
+      File.write("#{dir}/main.tex", main_tex)
+      File.write("#{dir}/helper.tex", helper_tex)
+    end
+  end
+end

data/lib/lbt/part_typeset.rb

@@ -0,0 +1,55 @@
+require_relative 'utils.rb'
+
+module Lbt
+  # Typeset one source file to check the PDF.
+  #
+  # Parameter:
+  # [file_or_number]
+  # It can be either a filename or the number of a filename.
+  # For example, part1/chap2/sec3.tex or 1-2-3
+  def part_typeset file_or_number
+    return unless file_or_number.is_a? String
+    if File.file?(file_or_number)
+      file = file_or_number
+    else
+      file = num2path(file_or_number)
+      return unless File.file? file
+    end
+
+    m = File.read(".config").match(/^build_dir = (.*)$/)
+    build_dir = m[1] ? m[1] : "_build"
+    raise "main.tex not exist." unless File.exist?('main.tex')
+    mkdir build_dir unless Dir.exist?(build_dir)
+
+    main_tex = File.read('main.tex')
+    main_tex = main_tex.sub(/\\end{document}/, "\\input{#{file.ext('.tex')}}\n\\end{document}")
+    File.write("#{build_dir}/main.tex", main_tex)
+    # copy or convert the files into build_dir
+    cp_conv build_dir
+    # Typeset
+    cur_dir = Dir.pwd
+    cd build_dir
+    system "latexmk -lualatex -pdflualatex=\"lualatex --halt-on-error %O %S\" main.tex"
+    cd cur_dir
+  end
+
+  # :nodoc:
+  def num2path n_n_n
+    return nil unless n_n_n.is_a? String
+    num_pcs = /^(\d+(\.\d+)?)-(\d+(\.\d+)?)-(\d+(\.\d+)?)$/
+    num_cs = /^(\d+(\.\d+)?)-(\d+(\.\d+)?)$/
+    num_s = /^(\d+(\.\d+)?)$/
+    if n_n_n =~ num_pcs
+      path = "part#{$1}/chap#{$3}/sec#{$5}"
+    elsif n_n_n =~ num_cs
+      path = "chap#{$1}/sec#{$3}"
+    elsif n_n_n =~ num_s
+      path = "sec#{$1}"
+    else
+      return nil
+    end
+    srcs = Dir.glob("#{path}.*")
+    return nil if srcs.size != 1
+    srcs[0]
+  end
+end

data/lib/lbt/renumber.rb

@@ -0,0 +1,50 @@
+module Lbt
+  # Renumber the source files.
+  # For example,
+  # - sec1.tex, sec1.5.tex, sec2.tex => sec1.tex, sec2.tex, sec3.tex
+  # - chap1/sec1.tex, chap1/sec1.2.tex, chap1.3/sec10.tex => chap1/sec1.tex, chap1/sec2.tex, chap2/sec1.tex
+  def renum
+    if Dir.children(".").select{|d| d =~ /^part\d+(\.\d+)?$/}.size > 0
+      renumber "part"
+    elsif Dir.children(".").select{|d| d =~ /^chap\d+(\.\d+)?$/}.size > 0
+      renumber "chap"
+    else
+      renumber "sec"
+    end
+  end
+
+  # :nodoc:
+  def renumber pcs
+    case pcs
+    when "part", "chap"
+      files = Dir.children(".").select{|d| d =~ /^#{pcs}\d+(\.\d+)?$/}
+    when "sec"
+      files = Dir.children(".").select{|d| d =~ /^#{pcs}\d+(\.\d+)?\.\w+$/}
+    end
+    files.sort! do |a,b|
+      a.match(/^#{pcs}(\d+(\.\d+)?)/)[1] <=> b.match(/^#{pcs}(\d+(\.\d+)?)/)[1]
+    end
+    n = files.size
+    case pcs
+    when "part", "chap"
+      temp_files = (1..n).map{|i| "#{pcs}#{i}_temp"}
+    when "sec"
+      temp_files = (1..n).map{|i| "#{pcs}#{i}#{File.extname(files[i-1])}_temp"}
+    end
+    n.times do |i|
+      File.rename(files[i], temp_files[i])
+    end
+    n.times do |i|
+      File.rename(temp_files[i], temp_files[i].sub(/_temp$/, ""))
+    end
+    return if pcs == "sec"
+    Dir.children(".").select{|d| d =~ /^#{pcs}\d+(\.\d+)?$/}.each do |f|
+      cd f
+      case pcs
+      when "part" then renumber "chap"
+      when "chap" then renumber "sec"
+      end
+      cd ".."
+    end
+  end
+end

data/lib/lbt/utils.rb

@@ -0,0 +1,142 @@
+require 'fileutils'
+
+include FileUtils
+
+class String
+  # Remove verbatim environments and comments (including the following new line) from self (LaTeX source).
+  def remove_tex_comment
+    gsub(/\\begin\{verbatim\}.*\\end\{verbatim\}/m, '').gsub(/%.*\n/,'')
+  end
+  # Return a string with the new suffix.
+  # If the suffix is illegal, nil is returned.
+  # Be careful that the suffix begins with a period.
+  #
+  # It redefines itself if it has been defined. For example, rake defines ext method.
+  def ext(suffix)
+    return nil unless suffix.is_a?(String) && /^\.\w+$/ =~ suffix
+    s = File.extname(self)
+    self.sub(/#{s}$/, suffix)
+  end
+end
+
+module Lbt
+=begin rdoc
+When you create an instance of the PCS class, it keeps the structure of Part-Chapter-Section files.
+For example,
+  +-part1-+-chap1-+-sec1.tex
+  |       |       +-sec2.tex`
+  |       +-chap2-+-sec1.tex`
+  |       |       +-sec2.tex`
+  +-part2-+-chap1-+-sec1.tex
+          |       +-sec2.tex`
+If the files are as above, the PCS instance keeps the six filenames whch are sorted alphabetically.
+=end
+  class PCS
+    # Type is one of :PCS, :CS and :S
+    # - :PCS => The file structure has part, chap directories.
+    # - :CS  => The file structure has chap directories.
+    # - :S   => The file structure doesn't have any directories.
+    attr_reader :type
+    # The name of the top direcotory
+    attr_reader :dir
+    # Create a new PCS instance.
+    # You can give a top directory as an argument.
+    def initialize dir="."
+      @dir = dir.dup
+      @dir.freeze
+      @files = Dir.glob("part*/chap*/sec*", base: @dir).select{|f| f.match?(/^part\d+(\.\d+)?\/chap\d+(\.\d+)?\/sec\d+(\.\d+)?\.\w+$/)}
+      unless @files.empty?
+        @type = :PCS
+        @files.sort! do |a, b|
+          m = /^part(\d+(\.\d+)?)\/chap(\d+(\.\d+)?)\/sec(\d+(\.\d+)?)\.\w*$/.match(a)
+          ap = m[1].to_f; ac= m[3].to_f; as = m[5].to_f
+          m = /^part(\d+(\.\d+)?)\/chap(\d+(\.\d+)?)\/sec(\d+(\.\d+)?)\.\w*$/.match(b)
+          bp = m[1].to_f; bc= m[3].to_f; bs = m[5].to_f
+          if ap != bp
+            ap <=> bp
+          elsif ac != bc
+            ac <=> bc
+          else
+            as <=> bs
+          end
+        end
+        return
+      end
+      @files = Dir.glob("chap*/sec*", base: @dir).select{|f| f.match?(/^chap\d+(\.\d+)?\/sec\d+(\.\d+)?\.\w+$/)}
+      unless @files.empty?
+        @type = :CS
+        @files.sort! do |a, b|
+          m = /^chap(\d+(\.\d+)?)\/sec(\d+(\.\d+)?)\.\w*$/.match(a)
+          ac= m[1].to_f; as = m[3].to_f
+          m = /^chap(\d+(\.\d+)?)\/sec(\d+(\.\d+)?)\.\w*$/.match(b)
+          bc= m[1].to_f; bs = m[3].to_f
+          if ac != bc
+            ac <=> bc
+          else
+            as <=> bs
+          end
+        end
+        return
+      end
+      @files = Dir.glob("sec*", base: @dir).select{|f| f.match?(/^sec\d+(\.\d+)?\.\w+$/)}
+      unless @files.empty?
+        @type = :S
+        @files.sort! do |a, b|
+          m = /^sec(\d+(\.\d+)?)\.\w*$/.match(a)
+          as = m[1].to_f
+          m = /^sec(\d+(\.\d+)?)\.\w*$/.match(b)
+          bs = m[1].to_f
+          as <=> bs
+        end
+        return
+      end
+      raise "No [[part/]chap/]sec files exist.\n" if @files.empty?
+    end
+
+    # Return an array of pathnames which are relative from the top directory.
+    # The returned pathnames are the copies.
+    # So, even if a user changes them, the original pathnames in the PCS instance are not changed.
+    def to_a
+      @files.map {|s| s.dup}
+    end
+    # Executes the block with each pathname.
+    def each
+      @files.each {|f| yield(f)}
+    end
+  end
+
+  # Return a hash (key: extension, value: Proc object) of converters.
+  def get_converters
+    converters = {'.md':  lambda {|src, dst| system("pandoc -o #{dst} #{src}")} }
+    if File.file?("converters.rb")
+      c = eval(File.read("converters.rb"))
+      c.each {|key, val| converters[key] = val} if c.is_a?(Hash)
+    end
+    converters
+  end
+
+  # copy or convert source files into build directory.
+  def cp_conv build_dir
+    converters = get_converters
+    files = Dir.children(".").reject{|f| f == build_dir || f == "main.tex"}
+    cp_conv_0 ".", files, build_dir, converters
+  end
+  # :nodoc:
+  def cp_conv_0 sdir, files, ddir, converters
+    files.each do |f|
+      f1 = "#{sdir}/#{f}"; f2 = "#{ddir}/#{f}"; ext = File.extname(f).to_sym
+      if Dir.exist?(f1)
+        mkdir_p f2
+        f1_files = Dir.children(f1)
+        cp_conv_0 f1, f1_files, f2, converters
+      elsif converters.has_key?(ext)
+        f2 = f2.ext ".tex"
+        unless File.exist?(f2) && File.mtime(f1) <= File.mtime(f2)
+          converters[ext].call(f1, f2)
+        end
+      elsif File.file?(f1)
+        cp f1, f2
+      end
+    end
+  end
+end

data/lib/lbt.rb

@@ -0,0 +1,11 @@
+require_relative 'lbt/build.rb'
+require_relative 'lbt/create.rb'
+require_relative 'lbt/part_typeset.rb'
+require_relative 'lbt/renumber.rb'
+require_relative 'lbt/utils.rb'
+
+# LaTeX-Buildtools provides Ruby script +lbt+ to create template, build it and do other tasks.
+# The +lbt+ command includes Lbt module and calls its instance methods.
+# All the methods are instance methods and Lbt module doesn't have any singleton methods.
+module Lbt
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: lbt
+version: !ruby/object:Gem::Version
+  version: '0.5'
+platform: ruby
+authors:
+- Toshio Sekiya
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-04-15 00:00:00.000000000 Z
+dependencies: []
+description: Lbt is a build tool for LaTeX. It is useful for big documents.
+email: lxboyjp@gmail.com
+executables:
+- lbt
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/lbt
+- lib/lbt.rb
+- lib/lbt/build.rb
+- lib/lbt/create.rb
+- lib/lbt/part_typeset.rb
+- lib/lbt/renumber.rb
+- lib/lbt/utils.rb
+homepage: https://github.com/ToshioCP/LaTeX-BuildTools
+licenses:
+- GPL-3.0
+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.4.11
+signing_key:
+specification_version: 4
+summary: LaTeX Build Tools
+test_files: []