ltx 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 72b57a2490f51b68108c3d6221a246d80922cbe0
+  data.tar.gz: f56953d780dec504532e9fba584e7fe0b2542701
+SHA512:
+  metadata.gz: 25ed0b18b366f30b3e45e68cc2f882c821ea50b9a304fa0d2d3be041ac2a0f04c95725481da8fd8516b83fa8e1f91fecfc7bf7d36f516cfa42ec8132aa912d22
+  data.tar.gz: 93bc013610df2f409bd2eda3954e2fc928acf0c4117bd0b41653d90d76f844feb61fb0cb2590cfdd2b29fc62aafe79a6f386fde4f3b1ba03f3bf1fb53101cd2c

data/.gitignore

@@ -0,0 +1,42 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.sw[op]
+
+## Rubinius
+*.rbc
+.rbx
+
+## PROJECT::GENERAL
+*.gem
+coverage
+profiling
+turbulence
+rdoc
+pkg
+tmp
+doc
+log
+.yardoc
+measurements
+
+## BUNDLER
+.bundle
+Gemfile.lock
+
+## ctags
+tags
+gems.tags
+
+## PROJECT::SPECIFIC
+tmp-*

data/.rspec

@@ -0,0 +1,6 @@
+--color
+--fail-fast
+--format progress
+--profile
+--order random
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1 @@
+config/rubocop.yml

data/.ruby-version

@@ -0,0 +1 @@
+2.3.3

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+ruby '2.3.3'
+
+gemspec

data/Guardfile

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+guard :bundler do
+  watch('Gemfile')
+  watch('Gemfile.lock')
+  watch(/\A(.+)\.gemspec\z/)
+end
+
+guard :rspec, cmd: 'bundle exec rspec ' +
+                   File.read('.rspec').split.join(' '),
+              failed_mode: :keep do
+  # Run all specs if configuration is modified
+  watch('.rspec')              { 'spec' }
+  watch('Guardfile')           { 'spec' }
+  watch('Gemfile.lock')        { 'spec' }
+  watch('spec/spec_helper.rb') { 'spec' }
+
+  # Run all specs if supporting files files are modified
+  watch(%r{\Aspec/(?:fixtures|lib|support|shared)/.+\.rb\z}) { 'spec' }
+
+  # Run unit specs if associated lib code is modified
+  watch(%r{\Alib/(.+)\.rb\z}) do |m|
+    Dir["spec/unit/#{m[1]}*"]
+  end
+
+  watch(%r{\Alib/(.+)/support/(.+)\.rb\z}) do |m|
+    Dir["spec/unit/#{m[1]}/#{m[2]}*"]
+  end
+
+  watch("lib/#{File.basename(File.expand_path('../', __FILE__))}.rb") do
+    'spec'
+  end
+
+  # Run a spec if it is modified
+  watch(%r{\Aspec/(?:unit|integration|features)/.+_spec\.rb\z})
+end
+
+guard :rubocop, cli: %w(--config config/rubocop.yml) do
+  watch(/.+\.(?:rb|rake|gemspec)\z/)
+  watch(%r{\Aconfig/rubocop\.yml\z})  { |m| File.dirname(m[0]) }
+  watch(%r{(?:.+/)?\.rubocop\.yml\z}) { |m| File.dirname(m[0]) }
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014-2017 Firas Zaidan
+
+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,25 @@
+# ltx - LaTeX Project Build Tool
+
+This project provides the ltx command. It reads your `project.yml` and
+compiles your LaTeX files to a tmp folder in your project subdirectory.  This
+does not mess your project with temporary files and simplifies the clean up
+procedure. It also let you define a project specific file name with optional
+version number and version prefix.
+
+## Example project.yml
+
+```yaml
+title: Your Name - Some Project
+version: 1.0.0
+version_prefix: ' v'
+main: main.tex
+compiler: pdflatex
+```
+
+## Credits
+
+ * [Firas Zaidan](https://github.com/zaidan)
+
+## License
+
+See `LICENSE` file.

data/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require 'devtools'
+
+Devtools.init_rake_tasks

data/bin/ltx

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+root = File.dirname(File.dirname(File.expand_path(__FILE__)))
+$LOAD_PATH << File.join(root, 'lib')
+
+require 'ltx'
+
+LTX::Build.new(LTX::Config.new).call

data/config/devtools.yml

@@ -0,0 +1,2 @@
+---
+unit_test_timeout: 0.1

data/config/flay.yml

@@ -0,0 +1,3 @@
+---
+threshold: 8
+total_score: 226

data/config/flog.yml

@@ -0,0 +1,2 @@
+---
+threshold: 10.0

data/config/mutant.yml

@@ -0,0 +1,3 @@
+name: ltx
+namespace: LTX
+ignore_subjects: []

data/config/reek.yml

@@ -0,0 +1,103 @@
+---
+Attribute:
+  enabled: false
+  exclude: []
+BooleanParameter:
+  enabled: true
+  exclude: []
+ClassVariable:
+  enabled: true
+  exclude: []
+ControlParameter:
+  enabled: true
+  exclude: []
+DataClump:
+  enabled: true
+  exclude: []
+  max_copies: 0
+  min_clump_size: 2
+DuplicateMethodCall:
+  enabled: true
+  exclude: []
+  max_calls: 1
+  allow_calls: []
+FeatureEnvy:
+  enabled: true
+  exclude: []
+IrresponsibleModule:
+  enabled: true
+  exclude: []
+LongParameterList:
+  enabled: true
+  exclude: []
+  max_params: 2
+  overrides: {}
+LongYieldList:
+  enabled: true
+  exclude: []
+  max_params: 0
+NestedIterators:
+  enabled: true
+  exclude: []
+  max_allowed_nesting: 1
+  ignore_iterators: []
+NilCheck:
+  enabled: true
+  exclude: []
+RepeatedConditional:
+  enabled: true
+  exclude: []
+  max_ifs: 1
+TooManyConstants:
+  enabled: true
+  exclude: []
+TooManyInstanceVariables:
+  enabled: true
+  exclude: []
+  max_instance_variables: 2
+TooManyMethods:
+  enabled: true
+  exclude: []
+  max_methods: 15
+TooManyStatements:
+  enabled: true
+  exclude: []
+  max_statements: 5
+UncommunicativeMethodName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeModuleName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  accept: []
+UncommunicativeParameterName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeVariableName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UnusedParameters:
+  enabled: true
+  exclude: []
+UtilityFunction:
+  enabled: true
+  exclude: []
+  max_helper_calls: 0

data/config/rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  Exclude: []
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/config/yardstick.yml

@@ -0,0 +1,2 @@
+---
+threshold: 100.0

data/lib/ltx.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'tmpdir'
+require 'yaml'
+require 'fileutils'
+
+require 'ltx/config'
+require 'ltx/build'

data/lib/ltx/build.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module LTX
+  # Ruby LaTeX builder
+  class Build
+    # LTX build error
+    class Error
+    end
+
+    def initialize(config)
+      @config = config
+
+      @command = build_command
+    end
+
+    def call
+      t1 = Time.now
+      puts 'Compiling Latex Project...'
+      puts @command.join(' ')
+      FileUtils.mkdir_p @config.compile_dir
+      # FileUtils.cp Dir.glob(File.join(@config.root,("*.bst"))),
+      #              @config.compile_dir
+      Kernel.system(*@command)
+      t = Time.now - t1
+      puts "Finished compiling in #{t} seconds"
+      self
+    end
+
+    def view
+      puts 'Starting PDF Viewer...'
+      puts view_command.join(' ')
+      Kernel.system(*view_command)
+
+      self
+    end
+
+    private
+
+    def build_command
+      case @config.compiler
+      when 'pdflatex' then pdflatex_command
+      when 'latex'    then latex_command
+      when 'xelatex'  then xelatex_command
+      when 'lualatex' then lualatex_command
+      else
+        raise Error, "unknown compiler: #{compiler}"
+      end
+    end
+
+    def view_command
+      [
+        'evince',
+        '--fullscreen',
+        File.join(@config.compile_dir, "#{@config.title}.pdf")
+      ]
+    end
+
+    def latexmk_base_command
+      [
+        'latexmk',
+        '-cd',
+        '-f',
+        "-jobname=#{@config.title}",
+        '-auxdir=' + @config.compile_dir,
+        '-outdir=' + @config.compile_dir
+      ]
+    end
+
+    def pdflatex_command
+      latexmk_base_command.concat [
+        '-pdf',
+        '-e',
+        "$pdflatex='pdflatex -synctex=1 -interaction=batchmode %O %S'",
+        File.join(@config.compile_dir, @config.main)
+      ]
+    end
+
+    def latex_command
+      latexmk_base_command.concat [
+        '-pdfdvi',
+        '-e',
+        "$latex='latex -synctex=1 -interaction=batchmode %O %S'",
+        File.join(@config.compile_dir, @config.main)
+      ]
+    end
+
+    def xelatex_command
+      latexmk_base_command.concat [
+        '-xelatex',
+        '-e',
+        "$pdflatex='xelatex -synctex=1 -interaction=batchmode %O %S'",
+        File.join(@config.compile_dir, @config.main)
+      ]
+    end
+
+    def lualatex_command
+      latexmk_base_command.concat [
+        '-pdf',
+        '-e',
+        "$pdflatex='lualatex -synctex=1 -interaction=batchmode %O %S'",
+        File.join(@config.compile_dir, @config.main)
+      ]
+    end
+  end
+end

data/lib/ltx/config.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+module LTX
+  # Load config from project.yaml
+  class Config
+    # Config errors
+    class Error
+    end
+    attr_reader :main
+    attr_reader :compiler
+    attr_reader :compile_dir
+    attr_reader :timeout
+    attr_reader :title
+    attr_reader :version
+    attr_reader :version_prefix
+
+    MISSING_MAIN_ERROR = 'Please supply path to main tex file!'
+    DEFAULT_PROJECT_YAML = 'project.yml'
+    DEFAULT_MAIN_TEX = 'main.tex'
+
+    def initialize
+      @config = load_config
+      fetch_settings
+    end
+
+    def root
+      File.dirname(@main)
+    end
+
+    private
+
+    def load_config(file = DEFAULT_PROJECT_YAML)
+      config_file = File.join(Dir.pwd, file)
+      File.exist?(config_file) ? YAML.load_file(file) : {}
+    end
+
+    def fetch(name, n, default)
+      ARGV.fetch(n, @config.fetch(name, default))
+    end
+
+    def fetch_settings
+      @main = fetch_main
+
+      @compiler = fetch('compiler', 1, 'pdflatex')
+      @compile_dir = fetch_compile_dir
+
+      @timeout = fetch('timeout', 3, 60_000)
+      @version = fetch('version', 5, '')
+      @version_prefix = fetch('version_prefix', 5, ' - v')
+      @title = fetch_title
+    end
+
+    def fetch_main(mainfile = DEFAULT_MAIN_TEX)
+      main = File.absolute_path(fetch('main', 0, mainfile))
+      raise Error, MISSING_MAIN_ERROR unless File.exist?(main)
+      main
+    end
+
+    def fetch_compile_dir
+      base = File.basename(@main, '.*')
+      File.absolute_path(fetch('compile_dir', 2, "tmp-#{base}"))
+    end
+
+    def fetch_title
+      title = fetch('title', 4, 'output')
+      if @version.nil? || @version == ''
+        title
+      else
+        "#{title}#{@version_prefix}#{@version}"
+      end
+    end
+  end
+end

data/lib/ltx/version.rb

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

data/ltx.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require File.expand_path('../lib/ltx/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'ltx'
+  gem.version     = LTX::VERSION.dup
+  gem.authors     = ['Firas Zaidan']
+  gem.email       = ['firas@zaidan.de']
+  gem.description = 'LaTeX Project Build Tool'
+  gem.summary     = gem.description
+  gem.homepage    = 'https://github.com/zaidan/ltx'
+  gem.license     = 'MIT'
+
+  gem.bindir                = 'bin'
+  gem.require_paths         = %w(lib bin)
+  gem.files                 = `git ls-files`
+                              .split($INPUT_RECORD_SEPARATOR)
+  gem.executables           = `git ls-files -- bin/*`
+                              .split("\n").map { |f| File.basename(f) }
+  gem.test_files            = `git ls-files -- spec`
+                              .split($INPUT_RECORD_SEPARATOR)
+  gem.extra_rdoc_files      = %w(README.md)
+  gem.required_ruby_version = '>= 2.2'
+
+  gem.requirements << 'latexmk'
+  gem.add_development_dependency 'devtools',       '~> 0.1.x'
+  gem.add_development_dependency 'guard',          '~> 2.14'
+  gem.add_development_dependency 'guard-bundler',  '~> 2.1'
+  gem.add_development_dependency 'guard-rspec',    '~> 4.7', '>= 4.7.3'
+  gem.add_development_dependency 'guard-rubocop',  '~> 1.2'
+end

data/spec/fixtures/main.tex

@@ -0,0 +1,4 @@
+\documentclass[12pt]{article}
+\begin{document}
+Some text.
+\end{document}

data/spec/fixtures/project.yml

@@ -0,0 +1,5 @@
+title: Your Name - Some Project
+version: 1.0.0
+version_prefix: ' v'
+main: main.tex
+compiler: pdflatex

data/spec/integration/build_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+require 'English'
+
+describe 'ltx command' do
+  let(:root) do
+    File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))
+  end
+
+  let(:fixtures) { File.join(root, 'spec', 'fixtures') }
+
+  let(:command) { File.join(root, 'bin', 'ltx') }
+
+  let(:tmp) { File.join(fixtures, 'tmp-main') }
+  let(:title) { 'Your Name - Some Project v1.0.0' }
+  let(:pdf) { File.join(tmp, "#{title}.pdf") }
+  let(:log) { File.join(tmp, "#{title}.log") }
+
+  def clean
+    FileUtils.rm_r tmp
+  end
+
+  after do
+    clean
+  end
+
+  it 'should build project' do
+    Dir.chdir fixtures
+    `'#{command}'`
+    expect($CHILD_STATUS.success?).to be true
+    expect(File).to exist(pdf)
+    expect(File).to exist(log)
+    log_content = File.read(log)
+    expect(log_content).to_not include('error')
+    expect(log_content).to include('Output written on')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+if ENV['COVERAGE'] == 'true'
+  require 'simplecov'
+
+  SimpleCov.start do
+    command_name 'spec:unit'
+
+    add_filter 'config'
+    add_filter 'spec'
+
+    minimum_coverage 100
+  end
+end
+
+$LOAD_PATH << 'lib'
+
+require 'ltx'
+
+require 'devtools/spec_helper'
+
+# require spec support files and shared behavior
+Dir[File.expand_path('../{support,shared}/**/*.rb', __FILE__)].each do |file|
+  require file
+end
+
+RSpec.configure do |config|
+  config.include(SpecHelper)
+  config.mock_framework = :rspec
+end

data/spec/support/helper.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+# Spec Helper
+module SpecHelper
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: ltx
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Firas Zaidan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: devtools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.x
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.x
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+    - - ">="
+      - !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'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: LaTeX Project Build Tool
+email:
+- firas@zaidan.de
+executables:
+- ltx
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/ltx
+- config/devtools.yml
+- config/flay.yml
+- config/flog.yml
+- config/mutant.yml
+- config/reek.yml
+- config/rubocop.yml
+- config/yardstick.yml
+- lib/ltx.rb
+- lib/ltx/build.rb
+- lib/ltx/config.rb
+- lib/ltx/version.rb
+- ltx.gemspec
+- spec/fixtures/main.tex
+- spec/fixtures/project.yml
+- spec/integration/build_spec.rb
+- spec/spec_helper.rb
+- spec/support/helper.rb
+homepage: https://github.com/zaidan/ltx
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- bin
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- latexmk
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: LaTeX Project Build Tool
+test_files:
+- spec/fixtures/main.tex
+- spec/fixtures/project.yml
+- spec/integration/build_spec.rb
+- spec/spec_helper.rb
+- spec/support/helper.rb