xantora 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e62bb76f892c8c6d8ae8f6ec720e1ddeb5f8d7fe51ff40d932cfcaa3c320fc7b
+  data.tar.gz: 725c922eed0d2c2e6aad23c86617a9d682174930b17e185f5a8e368887fe60ea
+SHA512:
+  metadata.gz: 5b69af38b6f177fd99e88553c76b6e5fd3ae5e35dc59933eeecea533814fe27630f764378b2822573540565ce276d34a7791a70b9d76f4f0b3828a90ee4a7431
+  data.tar.gz: 3b2e555986bb077b8846105b7fbfa236a01761c1fc4ae83f0729c9b3ce86cace840541f9700fbb0f6ce87c80fef33b503af66ded41100e5ac3fb1c6fe0efa315

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.pdf
+/*.gem

data/.gitlab-ci.yml

@@ -0,0 +1,13 @@
+image: ruby:2.7.1
+
+before_script:
+  - gem install bundler -v 2.2.25
+  - bundle install
+
+test:
+  script:
+    - bundle exec rake
+
+build:
+  script:
+    - gem build

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in xantora.gemspec
+gemspec
+
+gem "minitest", "~> 5.0"
+gem "rake", "~> 13.0"
+gem "rubocop", "~> 1.7"
+
+# gem "prawn-table", github: "prawnpdf/prawn-table", branch: "HEAD"

data/Gemfile.lock

@@ -0,0 +1,96 @@
+PATH
+  remote: .
+  specs:
+    xantora (0.1.0)
+      asciidoctor-pdf (~> 1.6.0)
+      thor (~> 1.1.0)
+      tty-spinner (~> 0.9.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    Ascii85 (1.1.0)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    afm (0.2.2)
+    asciidoctor (2.0.16)
+    asciidoctor-pdf (1.6.0)
+      asciidoctor (~> 2.0)
+      concurrent-ruby (~> 1.1)
+      prawn (~> 2.4.0)
+      prawn-icon (~> 3.0.0)
+      prawn-svg (~> 0.32.0)
+      prawn-table (~> 0.2.0)
+      prawn-templates (~> 0.1.0)
+      safe_yaml (~> 1.0.0)
+      treetop (~> 1.6.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
+    css_parser (1.10.0)
+      addressable
+    hashery (2.1.2)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pdf-core (0.9.0)
+    pdf-reader (2.5.0)
+      Ascii85 (~> 1.0)
+      afm (~> 0.2.1)
+      hashery (~> 2.0)
+      ruby-rc4
+      ttfunk
+    polyglot (0.3.5)
+    prawn (2.4.0)
+      pdf-core (~> 0.9.0)
+      ttfunk (~> 1.7)
+    prawn-icon (3.0.0)
+      prawn (>= 1.1.0, < 3.0.0)
+    prawn-svg (0.32.0)
+      css_parser (~> 1.6)
+      prawn (>= 0.11.1, < 3)
+      rexml (~> 3.2)
+    prawn-table (0.2.2)
+      prawn (>= 1.3.0, < 3.0.0)
+    prawn-templates (0.1.2)
+      pdf-reader (~> 2.0)
+      prawn (~> 2.2)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.19.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.10.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    ruby-rc4 (0.1.5)
+    safe_yaml (1.0.5)
+    thor (1.1.0)
+    treetop (1.6.11)
+      polyglot (~> 0.3)
+    ttfunk (1.7.0)
+    tty-cursor (0.7.1)
+    tty-spinner (0.9.3)
+      tty-cursor (~> 0.7)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.7)
+  xantora!
+
+BUNDLED WITH
+   2.2.25

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Nik Wolfgramm
+
+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,63 @@
+# Xantora
+
+A PDF-converter for [Antora](https://antora.org/) (AsciiDoc) documents.
+
+This Ruby CLI-Tool uses [asciidoctor-pdf](https://asciidoctor.org/docs/asciidoctor-pdf/) and makes it easy to export PDF's from Antora projects.
+
+## Installation
+
+Install the gem:
+
+```sh
+gem install xantora
+```
+
+## Usage
+
+Convert a single AsciiDoc document:
+
+```bash
+xantora convert -s modules/user-guide/pages/index.adoc
+```
+
+Convert a all documents within an Antora component:
+
+```bash
+xantora convert -s modules/
+```
+
+Convert all documents and store PDF's in the attachment folders (using option `--to-attachments` or `-A`):
+
+```bash
+xantora convert-modules -s modules/ --to-attachments 
+```
+
+See `xantora help` for more usage instructions.
+
+## Features
+
+- Preconfigured [asciidoctor-pdf](https://asciidoctor.org/docs/asciidoctor-pdf/) setup wich makes it simple to convert single Antora documents or whole modules into PDF's
+- Integrated PDF-theme suppport which makes your documents look good out of the box
+- Uses the santisized AsciiDoc document title as PDF filename
+- Sets the image-path according your Antora folder structure
+- Autodetects `antora.yml` configs in order to extract metadata such as `page-component-title`, which can be used in themes (i.e. header and footer)
+- Optionaly Xantora will safe PDF's in attachments folders coresponding to source documents
+
+## Known Limitations
+
+- Images referenced outside the documents own Antora module can't be loaded
+- Same limitations as with asciidoctor-pdf do apply, see [asciidoctor-pdf known-limitations](https://github.com/asciidoctor/asciidoctor-pdf#known-limitations)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/niwo/xantora. This project is intended to be a safe, welcoming space for collaboration.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/asciidoctor-pdf/themes/puzzle-theme.yml

@@ -0,0 +1,70 @@
+extends: default
+toc-title: Inhaltsverzeichnis
+font:
+  catalog:
+    merge: true
+    Roboto:
+      normal: Roboto-Regular.ttf
+      italic: Roboto-Italic.ttf
+      bold: Roboto-Bold.ttf
+      bold_italic: Roboto-BoldItalic.ttf
+    DroidSansFallback: DroidSansFallback.ttf
+  fallbacks:
+  - DroidSansFallback
+ulist:
+  marker:
+    circle:
+      content: "\u2022"
+link:
+  font-color: #2C97A6
+base:
+  font_family: Roboto
+  font_style: normal
+page:
+  margin: [1.0in, 0.67in, 0.67in, 0.67in]
+heading:
+  font-color: #1E5A96
+header:
+  font_color: #999999
+  height: 1.0in
+  line_height: 1
+  recto:
+    columns: "<40% =20% >40%"
+    right:
+      content: '{localdate}'
+    center:
+      content: image:puzzle-logo.png[pdfwidth=0.8in]
+    left:
+      content: '{page-component-title}'
+  verso:
+    columns: $header_recto_columns
+    left:
+      content: $header_recto_right_content
+    center:
+      content: $header_recto_center_content
+    right:
+      content: $header_recto_left_content
+footer:
+  font-color: $header_font_color
+  font_size: $base_font_size_small
+  # NOTE if background_color is set, background and border will span width of page
+  border_color: #DDDDDD
+  border_width: 0.25
+  height: $base_line_height_length * 2.5
+  line_height: 1
+  padding: [$base_line_height_length / 2, 1, 0, 1]
+  vertical_align: top
+  recto:
+    right:
+      content: 'Seite {page-number}/{page-count}'
+    center:
+      content: '(C) {localyear} -- {company}'
+    left:
+      content: '{doctitle}'
+  verso:
+    center:
+      content: $footer_recto_center_content
+    left:
+      content: $footer_recto_right_content
+    right:
+      content: $footer_recto_left_content

data/bin/console

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

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "xantora"
+
+Xantora::CLI.start(ARGV)

data/lib/xantora.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "xantora/version"
+require_relative "xantora/document"
+require_relative "xantora/cli"
+
+module Xantora
+  class Error < StandardError; end
+end

data/lib/xantora/cli.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "thor"
+require "tty-spinner"
+require "stringio"
+
+module Xantora
+  # Class responsible for the CLI logic based on thor
+  class CLI < Thor
+    # Error raised by this runner
+    Error = Class.new(StandardError)
+
+    def self.exit_on_failure?
+      true
+    end
+
+    desc "version", "Xantora version"
+    def version
+      puts "v#{Xantora::VERSION}"
+    end
+    map %w[--version -v] => :version
+
+    desc "convert", "Convert Antora document(s) to PDF"
+    option :source,
+           desc: "Antora document (.adoc) or modules path",
+           aliases: %w[-s],
+           required: true
+    option :output,
+           desc: "destination file or directory",
+           aliases: %w[-o],
+           default: Dir.pwd
+    option :attributes,
+           desc: "additional ascciidoc page attributes (attr1:value1 attr2:value2 ...)",
+           type: :hash,
+           aliases: %w[-a],
+           default: {}
+    option :to_attachments,
+           desc: "place output in the modules attachment-dir",
+           type: :boolean,
+           aliases: %w[-A],
+           default: false
+    def convert
+      if File.directory? options[:source]
+        puts "[.] Scanning module directory for .adoc files ..."
+        Dir.glob("#{options[:source]}/**/pages/*.adoc") { |file| convert_document(file, options) }
+      elsif options[:source].end_with? ".adoc"
+        convert_document(options[:source], options)
+      else
+        puts "[error] No valid source detected."
+        exit 1
+      end
+    end
+
+    no_tasks do
+      def convert_document(file, options)
+        doc = Document.new(file)
+        spinner = TTY::Spinner.new(
+          "[:spinner] Converting #{File.basename(doc.path)} to #{destination(doc, options)} ... ",
+          format: :bouncing_ball
+        )
+        spinner.auto_spin
+        capture_stderr { doc.convert_to_pdf(options) }
+        spinner.success "(successful)"
+      rescue StandardError => e
+        spinner.error("(error: #{e.message})")
+      end
+
+      def destination(doc, options)
+        options[:output]&.end_with?(".pdf") ? File.basename(options[:output]) : doc.pdf_name
+      end
+
+      def capture_stderr
+        real_stderr = $stderr
+        $stderr = StringIO.new
+        yield
+        $stderr.string
+      ensure
+        $stderr = real_stderr
+      end
+    end
+  end
+end

data/lib/xantora/document.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "asciidoctor"
+require "asciidoctor-pdf"
+
+module Xantora
+  # Document represents a Antora document and holds the functionality for PDF conversion based on asciidoctor-pdf
+  class Document
+    attr_reader :path
+
+    GEM_DIR = File.expand_path("../..", __dir__)
+
+    def initialize(path, options = {})
+      @path = path
+      @to_dir = options[:to_dir]
+      @to_file = options[:to_file]
+    end
+
+    def component_dir
+      File.expand_path "../../../", File.dirname(@path)
+    end
+
+    def module_dir
+      File.expand_path "..", File.dirname(@path)
+    end
+
+    def page_component_title
+      YAML.load_file(
+        File.join(component_dir, "antora.yml")
+      )["title"]
+    rescue StandardError
+      ""
+    end
+
+    def pdf_name
+      name = File.basename(@path, ".adoc")
+      if name == "index"
+        doc = Asciidoctor.load_file @path, safe: :safe
+        name = doc.doctitle ? doc.doctitle.gsub(/[^0-9A-Za-z.\-]/, "_") : "index"
+      end
+      "#{name}.pdf"
+    end
+
+    def pdf_path(options)
+      if options[:to_attachments]
+        File.join(attachments_path, pdf_name)
+      elsif !options[:output]
+        pdf_name
+      elsif options[:output].end_with? ".pdf"
+        options[:output]
+      else
+        File.join options[:output], pdf_name
+      end
+    end
+
+    def attachments_path
+      if Dir.exist? File.join(module_dir, "attachments")
+        File.join(module_dir, "attachments")
+      else
+        File.join(module_dir, "assets/attachments")
+      end
+    end
+
+    def images_dir
+      if Dir.exist? File.join(module_dir, "images")
+        "../images"
+      elsif Dir.exist? File.join(module_dir, "assets/images")
+        "../assets/images"
+      else
+        ""
+      end
+    end
+
+    def asciidoctor_options(options)
+      a_opts = {}
+      a_opts[:to_file] = pdf_path(options)
+      a_opts[:backend] = "pdf"
+      a_opts[:safe] = :unsafe
+      a_opts[:attributes] = asciidoc_attributes(options[:attributes])
+      a_opts
+    end
+
+    def asciidoc_attributes(optional_attributes = {})
+      attributes = {
+        "toc" => "auto",
+        "toclevels" => "1",
+        "pdf-theme" => "puzzle",
+        "pdf-themesdir" => File.join(GEM_DIR, "asciidoctor-pdf/themes"),
+        "pdf-fontsdir" => "#{File.join(GEM_DIR, "asciidoctor-pdf/fonts")};GEM_FONTS_DIR",
+        "imagesdir" => images_dir
+      }
+      attributes.merge!({ "page-component-title" => page_component_title })
+      attributes.merge(optional_attributes)
+    end
+
+    def convert_to_pdf(options = {})
+      Asciidoctor.convert_file @path, asciidoctor_options(options)
+    end
+  end
+end

data/lib/xantora/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Xantora
+  VERSION = "0.1.0"
+end

data/xantora.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/xantora/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "xantora"
+  spec.version       = Xantora::VERSION
+  spec.authors       = ["Nik Wolfgramm"]
+  spec.email         = ["wolfgramm@puzzle.ch"]
+
+  spec.summary       = "A PDF-converter for Antora AsciiDoc documents"
+  spec.description   = "A Ruby CLI-Tool which makes it easy to export PDF's from your Antora AsciiDoc-Files"
+  spec.homepage      = "https://github.com/niwo/xantora"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "asciidoctor-pdf", "~> 1.6.0"
+  spec.add_dependency "thor", "~> 1.1.0"
+  spec.add_dependency "tty-spinner", "~> 0.9.3"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: xantora
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nik Wolfgramm
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor-pdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+description: A Ruby CLI-Tool which makes it easy to export PDF's from your Antora
+  AsciiDoc-Files
+email:
+- wolfgramm@puzzle.ch
+executables:
+- xantora
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- asciidoctor-pdf/fonts/DroidSansFallback.ttf
+- asciidoctor-pdf/fonts/Roboto-Bold.ttf
+- asciidoctor-pdf/fonts/Roboto-BoldItalic.ttf
+- asciidoctor-pdf/fonts/Roboto-Italic.ttf
+- asciidoctor-pdf/fonts/Roboto-Regular.ttf
+- asciidoctor-pdf/themes/puzzle-logo.png
+- asciidoctor-pdf/themes/puzzle-theme.yml
+- bin/console
+- bin/setup
+- exe/xantora
+- lib/xantora.rb
+- lib/xantora/cli.rb
+- lib/xantora/document.rb
+- lib/xantora/version.rb
+- xantora.gemspec
+homepage: https://github.com/niwo/xantora
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/niwo/xantora
+  source_code_uri: https://github.com/niwo/xantora
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A PDF-converter for Antora AsciiDoc documents
+test_files: []