makebook 0.0.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc96443605ecbb4bc2292739399d78bca1ed5dfe
-  data.tar.gz: cc4582fa85d2d3c8a146a75632f8968cbfabd007
+  metadata.gz: 6e0fc9cdd0fdc3c57455e7d4b0cd6d5ac37facee
+  data.tar.gz: 5a33589ba0d2878076ff2665e61f0c833aa49aaa
 SHA512:
-  metadata.gz: 69e253043ee5d518c90ea349f8d5d057ea88933160bce17e1732792d643cfaddda9f057d55d52c51e859bafb956e9858bf3391699cbf4a028b1d98fc195c44d7
-  data.tar.gz: 8703a9ec3771644e3619ed65416be682802539ab6da64d4b3a0d741d407acbdac0ac1332861b5243b62dcb661dab299015caa4cff8b1d5df500f60554f10133b
+  metadata.gz: f1ffb6ec591c5171dfbab6b55ef5109d0cfbaa6dc91d07317e25376b7eab234b159a0ce2cbda30d7967af6e1568db25994305176d7b6215e2c877512dceb6e78
+  data.tar.gz: 9195ae0e5c4f67efc44faea0f0334bd83afa87a5b2a5db5a21a4a98f44f658563e19edc85a81cdb838f8c30359ff87aa7cd63199a74baec2d05c060d1b5e992d

data/bin/makebook

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'makebook/cli'
+
+MakeBook::CLI.start(ARGV)

data/lib/makebook.rb

@@ -1 +1,11 @@
+# Make books from Markdown
 module MakeBook; end
+
+require 'makebook/build'
+require 'makebook/book'
+require 'makebook/chapter'
+require 'makebook/formats'
+
+module MakeBook
+  EXT = '.book.yml'.freeze
+end

data/lib/makebook/book.rb

@@ -0,0 +1,54 @@
+require 'yaml'
+
+# A book
+class MakeBook::Book
+  attr_reader :source
+
+  def initialize(file)
+    @source = Pathname.new(file)
+  end
+
+  private def book
+    @book ||= YAML.load(File.read(source))
+  end
+
+  def root
+    source.dirname
+  end
+
+  def name
+    book['name'] || source.basename(MakeBook::EXT)
+  end
+
+  def dir
+    root + name
+  end
+
+  def formats
+    book['output']['formats'] || []
+  end
+
+  def title
+    book['title'] || name
+  end
+
+  def chapters
+    (book['chapters'] || []).map do |c|
+      MakeBook::Chapter.new(book: self, name: c)
+    end
+  end
+
+  def styles
+    (book['styles'] || []).map do |s|
+      MakeBook::Formats::HTML::Stylesheet.new(root + s)
+    end
+  end
+
+  def toc
+    book['toc'] && Integer(book['toc'])
+  end
+
+  def toc?
+    !toc.nil?
+  end
+end

data/lib/makebook/build.rb

@@ -0,0 +1,28 @@
+# Build context
+class MakeBook::Build
+  attr_reader :root
+
+  def initialize(out: nil)
+    @root = Pathname.new(out || MakeBook::Build.default_root)
+  end
+
+  def build(book)
+    b = MakeBook::Book.new(book)
+    b.formats.each do |format|
+      format, options = format.first if format.is_a? Hash
+      options ||= {}
+
+      case format
+      when 'html' then MakeBook::Formats::HTML.new(b, self, options).make
+      when 'pdf' then MakeBook::Formats::PDF.new(b, self, options).make
+      else raise NotImplementedError, format
+      end
+    end
+  end
+
+  class << self
+    def default_root
+      Pathname.pwd + 'out'
+    end
+  end
+end

data/lib/makebook/chapter.rb

@@ -0,0 +1,13 @@
+# A book chapter
+class MakeBook::Chapter
+  attr_reader :source
+
+  def initialize(file = nil, book: nil, name: nil)
+    file ||= book.root + "#{name}.md"
+    @source = Pathname.new(file)
+  end
+
+  def root
+    source.dirname
+  end
+end

data/lib/makebook/cli.rb

@@ -0,0 +1,20 @@
+require 'thor'
+require 'makebook'
+
+# CLI commands
+class MakeBook::CLI < Thor
+  class_option :verbose, type: :boolean
+
+  desc 'build [--out=DIRECTORY] [BOOK|...]', 'Make a book or more'
+  options out: :optional
+  def build(*books)
+    build = MakeBook::Build.new(out: options[:out])
+
+    books = Pathname.glob("**/*#{MakeBook::EXT}") if books.empty?
+
+    books.each do |book|
+      puts "building #{book}" if options[:verbose]
+      build.build(book)
+    end
+  end
+end

data/lib/makebook/formats.rb

@@ -0,0 +1,5 @@
+# Output format
+module MakeBook::Formats; end
+
+require 'makebook/formats/html'
+require 'makebook/formats/pdf'

data/lib/makebook/formats/html.rb

@@ -0,0 +1,304 @@
+require 'kramdown'
+require 'nokogiri'
+require 'base64'
+
+# HTML output format
+# rubocop:disable Metrics/ClassLength
+class MakeBook::Formats::HTML
+  attr_reader :book, :build
+
+  def initialize(book, build, options = {})
+    @book = book
+    @build = build
+    @options = options
+  end
+
+  # External element
+  class Asset
+    attr_reader :source, :mime
+
+    def initialize(source, mime: nil)
+      @source = source
+      @mime = mime
+    end
+
+    def digest
+      sha1 = Digest::SHA1.new
+      sha1 << read
+      sha1.hexdigest
+    end
+
+    def build_name
+      "#{digest}#{source.extname}"
+    end
+
+    def read
+      File.read(source)
+    end
+
+    def base64
+      Base64.encode64(read)
+    end
+
+    def data_uri
+      "data:#{mime};base64,#{base64}"
+    end
+  end
+
+  # Wrap a string range for manipulation
+  class Range
+    def initialize(string, range)
+      @string = string
+      @range = range
+    end
+
+    def value=(string)
+      @string[@range] = string
+    end
+  end
+
+  # Stylesheet asset
+  class Stylesheet < Asset
+    TYPES = {
+      'eot'  => 'application/vnd.ms-fontobject',
+      'otf'  => 'application/font-sfnt',
+      'ttf'  => 'application/font-sfnt',
+      'woff' => 'application/font-woff',
+      'png' => 'image/png',
+      'jpg'  => 'image/jpg',
+      'jpeg' => 'image/jpg',
+      'svg'  => 'image/svg+xml',
+      'gif'  => 'image/gif',
+    }.freeze
+
+    def initialize(source, mime: 'text/css')
+      super
+    end
+
+    def assets
+      scan(/url\("([^"]+\.(#{TYPES.keys.join('|')}))"\)/).map do |path, ext|
+        [
+          Asset.new(source.dirname + path, mime: TYPES[ext]),
+          wrap(Regexp.last_match.begin(1)...Regexp.last_match.end(1)),
+        ]
+      end
+    end
+
+    def to_css
+      read
+    end
+
+    def read
+      @read ||= super
+    end
+
+    private
+
+    def scan(re)
+      read.enum_for(:scan, re)
+    end
+
+    def wrap(range)
+      Range.new(read, range)
+    end
+  end
+
+  # Section output
+  class Section
+    attr_reader :source
+
+    def initialize(source)
+      @source = source
+    end
+
+    def source_document
+      Kramdown::Document.new(File.read(source),
+                             input: 'GFM', hard_wrap: false)
+    end
+
+    def node
+      @node ||= wrap(Nokogiri::HTML(source_document.to_html))
+    end
+
+    def to_html
+      node.to_s
+    end
+
+    # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+    def toc(levels, ordered: false)
+      fragment = Nokogiri::HTML.fragment('')
+      tag = ordered ? 'ol' : 'ul'
+
+      toc_elements(levels).reduce([fragment, nil]) do |(level, last), header|
+        if last.nil? || last.name < header.name
+          level << node = Nokogiri::XML::Node.new(tag, fragment).tap do |ul|
+            ul['class'] = header.name
+          end
+          level = node
+        elsif last.name > header.name
+          level = level.parent
+        end
+
+        level << Nokogiri::XML::Node.new('li', fragment).tap do |li|
+          li['class'] = header.name
+          li << Nokogiri::XML::Node.new('a', fragment).tap do |a|
+            a['href'] = "##{header['id']}"
+            a.content = header.text
+          end
+        end
+
+        [level, header]
+      end
+
+      fragment
+    end
+    # rubocop:enable Metrics/AbcSize,Metrics/MethodLength
+
+    private def toc_elements(levels)
+      node.css(toc_selector(levels))
+    end
+
+    private def toc_selector(levels)
+      Array.new(levels) { |i| "h#{i + 1}" }.join(', ')
+    end
+
+    def images
+      node.css('img').map { |img| [Asset.new(root + img['src']), img] }
+    end
+
+    def root
+      source.dirname
+    end
+
+    private def wrap(doc)
+      doc.css('body').first.tap do |c|
+        c.name = 'section'
+        c['class'] = 'chapter'
+      end
+    end
+  end
+
+  def sections
+    @sections ||= book.chapters.map { |c| Section.new(c.source) }
+  end
+
+  # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+  def make
+    build_dir.mkpath
+
+    head << <<-HTML
+      <title>#{book.title}</title>
+    HTML
+
+    book.styles.each do |stylesheet|
+      stylesheet.assets.reverse_each do |asset, range|
+        range.value = asset.build_name
+        FileUtils.cp(asset.source, build_dir + asset.build_name)
+      end
+
+      File.open(build_dir + stylesheet.build_name, 'wb') do |f|
+        f.write(stylesheet.to_css)
+      end
+
+      head << <<-HTML
+        <link rel="stylesheet" href="#{build_dir.basename + stylesheet.build_name}" />
+      HTML
+    end
+
+    header << book.title
+
+    sections.each do |section|
+      nav << section.toc(book.toc).to_s if book.toc?
+
+      section.images.each do |asset, img|
+        img['src'] = build_dir.basename + asset.build_name
+        FileUtils.cp(asset.source, build_dir + asset.build_name)
+      end
+
+      main << section.to_html
+    end
+
+    open { |io| assemble(io) }
+  end
+  # rubocop:enable Metrics/AbcSize,Metrics/MethodLength
+
+  # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+  private def assemble(io)
+    io.write("<!DOCTYPE html>\n")
+    io.write(<<-EOS)
+      <html>
+        <head>
+          <meta charset="utf-8" />
+    EOS
+    io.write(head)
+    io.write(<<-EOS)
+        </head>
+        <body class='book'>
+          <header>
+    EOS
+    io.write(header)
+    io.write(<<-EOS)
+          </header>
+          <nav>
+    EOS
+    io.write(nav)
+    io.write(<<-EOS)
+          </nav>
+          <main>
+    EOS
+    io.write(main)
+    io.write(<<-EOS)
+          </main>
+          <footer>
+    EOS
+    io.write(footer)
+    io.write(<<-EOS)
+          </footer>
+        </body>
+      </html>
+    EOS
+  end
+  # rubocop:enable Metrics/AbcSize,Metrics/MethodLength
+
+  private def head
+    @head ||= ''
+  end
+
+  private def header
+    @header ||= ''
+  end
+
+  private def nav
+    @nav ||= ''
+  end
+
+  private def main
+    @main ||= ''
+  end
+
+  private def footer
+    @footer ||= ''
+  end
+
+  def build_name
+    build.root + book.root + book.name
+  end
+
+  def build_file
+    Pathname("#{build_name}.html")
+  end
+
+  def build_dir
+    build_name
+  end
+
+  def stale?
+    book.source.mtime > build_file.mtime
+  rescue Errno::ENOENT
+    true
+  end
+
+  private def open
+    File.open(build_file, 'wb') { |f| yield f }
+  end
+end

data/lib/makebook/formats/pdf.rb

@@ -0,0 +1,61 @@
+require 'pdfkit'
+
+# PDF output format
+class MakeBook::Formats::PDF
+  attr_reader :book, :build
+
+  def initialize(book, build, options = {})
+    @book = book
+    @build = build
+    @options = kit_options_from(options)
+  end
+
+  def make
+    html = MakeBook::Formats::HTML.new(book, build)
+    html.make if html.stale?
+
+    kit = PDFKit.new(File.new(html.build_file), options)
+    kit.to_file(build_file)
+  end
+
+  private def options
+    {
+      print_media_type: true,
+      page_size: 'A4',
+      margin_top: '2cm',
+      margin_bottom: '2cm',
+      margin_left: '2cm',
+      margin_right: '2cm',
+    }.merge(@options)
+  end
+
+  private def kit_options_from(options)
+    options.dup.tap do |o|
+      %w(header-html footer-html).each do |k|
+        o[:"#{k}"] = uri_from(relative_path(o.delete(k))) if o.key?(k)
+      end
+    end
+  end
+
+  private def uri_from(path)
+    "file://#{Pathname.pwd + path}"
+  end
+
+  private def relative_path(path)
+    book.source + path
+  end
+
+  def build_name
+    build.root + book.root + book.name
+  end
+
+  def build_file
+    Pathname("#{build_name}.pdf")
+  end
+
+  def stale?
+    book.source.mtime > build_file.mtime
+  rescue Errno::ENOENT
+    true
+  end
+end

metadata

@@ -1,26 +1,145 @@
 --- !ruby/object:Gem::Specification
 name: makebook
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.3.0
 platform: ruby
 authors:
-- ADHOC-GTI
+- Loic Nageleisen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-02 00:00:00.000000000 Z
-dependencies: []
-description: ''
-email: foss@adhoc-gti.com
-executables: []
+date: 2018-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: tilt-pdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+description: "   Assembling books with style from Markdown sources\n"
+email: l.nageleisen@adhoc-gti.com
+executables:
+- makebook
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
+- bin/makebook
 - lib/makebook.rb
-homepage: https://github.com/adhoc-gti/makebook
-licenses:
-- BSD-3-Clause
+- lib/makebook/book.rb
+- lib/makebook/build.rb
+- lib/makebook/chapter.rb
+- lib/makebook/cli.rb
+- lib/makebook/formats.rb
+- lib/makebook/formats/html.rb
+- lib/makebook/formats/pdf.rb
+homepage: https://gitlab.adhoc-gti.com/lnageleisen/makebook
+licenses: []
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -41,5 +160,5 @@ rubyforge_project:
 rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
-summary: Generate HTML and PDF from Markdown chapters
+summary: Creating books from Markdown
 test_files: []

data/LICENSE

@@ -1,24 +0,0 @@
-Copyright (c) 2016, ADHOC-GTI
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-    * Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in the
-      documentation and/or other materials provided with the distribution.
-    * Neither the name of the copyright holders nor the
-      names of its contributors may be used to endorse or promote products
-      derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.