asciidoctor-templates-compiler 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 284ae9f82eaa132717e6fbb51d7bb84fb5814a6a
+  data.tar.gz: 7330fa5e9a09c109082a406f283e7961578943d3
+SHA512:
+  metadata.gz: ce6e27c02ec9a9d3fea1ebb00d51986fdbbb0546916ca94c157b89d2eb6d6a9f8743d649d7bded06dedb73683c1d13754507831874d2f2dc952189433e9b8032
+  data.tar.gz: 6eef241dfe9d24f2fdfe8679508a8261cf062c411d9b651222a76e4065ab165472e20b0a252860de72625e48ff3aa49e3a2accf3c56a2aff15c771f0babbee6d

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright 2017 Jakub Jirutka <jakub@jirutka.cz>.
+
+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.adoc

@@ -0,0 +1,62 @@
+= Asciidoctor Templates Compiler
+:source-language: ruby
+// custom
+:gem-name: asciidoctor-templates-compiler
+:gem-version: 0.1.2
+
+ifdef::env-github[]
+image:https://img.shields.io/gem/v/{gem-name}.svg?style=flat[Gem Version, link="https://rubygems.org/gems/{gem-name}"]
+endif::env-github[]
+
+This tool allows to precompile Slim templates into Ruby code and assemble them into a single-file pure Ruby converter (backend).
+
+TODO
+
+
+== Installation
+
+Add this line to your application’s Gemfile:
+
+[source, subs="+attributes"]
+group :development do
+  gem '{gem-name}', '~> {gem-version}'
+end
+
+or to your gemspec:
+
+[source, subs="+attributes"]
+s.add_development_dependency '{gem-name}', '~> {gem-version}'
+
+and then execute:
+
+[source, sh]
+$ bundle install
+
+
+== Usage
+
+[source, subs="+attributes"]
+----
+require '{gem-name}'
+
+File.open('html_custom_converter.rb', 'w') do |file|
+  Asciidoctor::TemplatesCompiler::Slim.compile_converter(
+      templates_dir: 'data/templates',
+      class_name: 'HtmlCustomConverter',
+      delegate_backend: 'html5',
+      register_for: ['html-custom'],
+      backend_info: {
+        basebackend: 'html',
+        outfilesuffix: '.html',
+        filetype: 'html',
+      },
+      pretty: true,
+      output: file)
+end
+----
+
+
+== License
+
+This project is licensed under http://opensource.org/licenses/MIT/[MIT License].
+For the full text of the license, see the link:LICENSE[LICENSE] file.

data/asciidoctor-templates-compiler.gemspec

@@ -0,0 +1,21 @@
+require File.expand_path('../lib/asciidoctor/templates_compiler/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = 'asciidoctor-templates-compiler'
+  s.version       = Asciidoctor::TemplatesCompiler::VERSION
+  s.author        = 'Jakub Jirutka'
+  s.email         = 'jakub@jirutka.cz'
+  s.homepage      = 'https://github.com/jirutka/asciidoctor-templates-compiler'
+  s.license       = 'MIT'
+
+  s.summary       = 'Compile templates-based Asciidoctor converter (backend) into a single Ruby file'
+
+  s.files         = Dir['lib/**/*', '*.gemspec', 'LICENSE*', 'README*']
+
+  s.required_ruby_version = '>= 2.3'
+
+  s.add_runtime_dependency 'asciidoctor', '~> 1.5'
+  s.add_runtime_dependency 'corefines', '~> 1.2'
+  s.add_runtime_dependency 'slim', '>= 2.1', '< 4.0'
+  s.add_runtime_dependency 'ruby-beautify', '~> 0.97'
+end

data/lib/asciidoctor-templates-compiler.rb

@@ -0,0 +1 @@
+require 'asciidoctor/templates_compiler'

data/lib/asciidoctor/templates_compiler.rb

@@ -0,0 +1,3 @@
+require 'asciidoctor/templates_compiler/version'
+require 'asciidoctor/templates_compiler/base'
+require 'asciidoctor/templates_compiler/slim'

data/lib/asciidoctor/templates_compiler/base.rb

@@ -0,0 +1,73 @@
+require 'asciidoctor/templates_compiler/version'
+require 'asciidoctor/templates_compiler/converter_generator'
+require 'asciidoctor/templates_compiler/ruby_beautify'
+require 'stringio'
+
+module Asciidoctor::TemplatesCompiler
+  class Base
+
+    class << self
+      def compile_converter(**opts)
+        new.compile_converter(**opts)
+      end
+
+      alias_method :call, :compile_converter
+    end
+
+
+    def compile_converter(output: StringIO.new, templates_dir:, pretty: false, **opts)
+      unless Dir.exists? templates_dir
+        fail "Templates directory '#{templates_dir}' does not exist"
+      end
+
+      backend_info = opts[:backend_info] || {}
+      templates = find_templates(templates_dir)
+      transforms_code = compile_templates(templates, backend_info: backend_info, pretty: pretty)
+
+      generate_class(output: output, transforms_code: transforms_code,
+          helpers_code: read_helpers(templates_dir), **opts)
+    end
+
+    alias_method :call, :compile_converter
+
+
+    protected
+
+    def compile_template(filename, backend_info: {})
+      fail NotImplementedError
+    end
+
+    def find_templates(dirname)
+      fail NotImplementedError
+    end
+
+
+    def beautify_code(code, **opts)
+      RubyBeautify.call(code, **opts)
+    end
+
+    def compile_templates(template_files, backend_info: {}, pretty: false)
+      template_files.lazy.map do |path|
+        code = compile_template(path, backend_info: backend_info)
+        code = beautify_code(code) if pretty
+
+        [transform_name_from_tmpl_name(path), code]
+      end
+    end
+
+    def generate_class(**opts)
+      ConverterGenerator.call(**opts)
+    end
+
+    def read_helpers(templates_dir)
+      path = File.join(templates_dir, 'helpers.rb')
+      IO.read(path) if File.exists? path
+    end
+
+    def transform_name_from_tmpl_name(filename)
+      File.basename(filename)
+          .sub(/\..*$/, '')
+          .sub(/^block_/, '')
+    end
+  end
+end

data/lib/asciidoctor/templates_compiler/converter_generator.rb

@@ -0,0 +1,167 @@
+require 'asciidoctor/templates_compiler/version'
+require 'corefines'
+require 'stringio'
+
+module Asciidoctor::TemplatesCompiler
+  class ConverterGenerator
+    using Corefines::String::indent
+
+    class << self
+      def generate(output: nil, **opts)
+        new(**opts).call(output)
+      end
+
+      alias_method :call, :generate
+    end
+
+
+    def initialize(class_name:, transforms_code:, helpers_code: nil,
+                   register_for: [], backend_info: {}, delegate_backend: nil, **_)
+      @class_name = class_name
+      @transforms_code = transforms_code
+      @helpers_code = helpers_code
+      @register_for = register_for
+      @backend_info = backend_info
+      @delegate_backend = delegate_backend
+    end
+
+    def generate(out = StringIO.new)
+      out << head_code << "\n"
+      out << helpers_code << "\n" if @helpers_code
+      out << initialization_code << "\n"
+      out << convert_method_code << "\n"
+      transform_methods_code(out)
+      out << support_methods_code << "\n"
+      out << tail_code
+      out
+    end
+
+    alias_method :call, :generate
+
+    protected
+
+    def head_code
+      init_modules = @class_name
+          .split('::')[0..-2]
+          .map { |name| "module #{name};"}
+          .tap { |ary| ary.push('end ' * ary.size) }
+          .join(' ').strip
+
+      <<~EOF
+        # This file has been generated!
+
+        #{init_modules}
+        class #{@class_name} < ::Asciidoctor::Converter::Base
+      EOF
+    end
+
+    def helpers_code
+      <<~EOF.indent(2, ' ')
+        #{separator 'Begin of Helpers'}
+        #{@helpers_code}
+
+        # Make Helpers' constants accessible from transform methods.
+        Helpers.constants.each do |const|
+          const_set(const, Helpers.const_get(const))
+        end
+
+        #{separator 'End of Helpers'}
+      EOF
+    end
+
+    def initialization_code
+      setup_backend_info = @backend_info
+          .map { |k, v| "  #{k} #{v.inspect}" }.join("\n")
+
+      if !@register_for.empty?
+        register_for = "register_for #{@register_for.map(&:inspect).join(', ')}\n"
+      end
+
+      if @delegate_backend
+        delegate_converter = <<~EOF.rstrip.indent(2, ' ')
+
+          delegate_backend = (opts[:delegate_backend] || #{@delegate_backend.inspect}).to_s
+          factory = ::Asciidoctor::Converter::Factory
+
+          converter = factory.create(delegate_backend, backend_info)
+          @delegate_converter = if converter == self
+              factory.new.create(delegate_backend, backend_info)
+            else
+              converter
+            end
+        EOF
+      end
+
+      [
+        register_for,
+        'def initialize(backend, opts = {})',
+        '  super',
+           setup_backend_info,
+           delegate_converter,
+        'end',
+        '',
+      ].compact.join("\n").indent(2, ' ')
+    end
+
+    def convert_method_code
+      converter = if @delegate_backend
+          'respond_to?(transform) ? self : @delegate_converter'
+        else
+          'self'
+        end
+
+      <<~EOF.indent(2, ' ')
+        def convert(node, transform = nil, opts = {})
+          transform ||= node.node_name
+          converter = #{converter}
+
+          if opts.empty?
+            converter.send(transform, node)
+          else
+            converter.send(transform, node, opts)
+          end
+        end
+      EOF
+    end
+
+    def support_methods_code
+      <<~EOF.indent(2, ' ')
+        def set_local_variables(binding, vars)
+          vars.each do |key, val|
+            binding.local_variable_set(key.to_sym, val)
+          end
+        end
+      EOF
+    end
+
+    def transform_methods_code(out)
+      out << "  #{separator 'Begin of generated transformation methods'}"
+
+      @transforms_code.each do |name, code|
+        out << <<~EOF.indent(2, ' ')
+
+          def #{name}(node, opts = {})
+            node.extend(Helpers)
+            node.instance_eval do
+              converter.set_local_variables(binding, opts) unless opts.empty?
+          #{code.indent(4, ' ')}
+            end
+          end
+        EOF
+      end
+
+      out << "  #{separator 'End of generated transformation methods'}\n"
+    end
+
+    def tail_code
+      "end\n"
+    end
+
+    private
+
+    def separator(title)
+      dashes = '-' * ((76 - title.length) / 2)
+      "##{dashes} #{title} #{dashes}#\n"
+    end
+  end
+end

data/lib/asciidoctor/templates_compiler/ruby_beautify.rb

@@ -0,0 +1,27 @@
+require 'asciidoctor/templates_compiler/version'
+require 'ruby-beautify'
+
+module Asciidoctor::TemplatesCompiler
+  module RubyBeautify
+    extend self
+
+    def pretty_string(code, indent_count: 2)
+      new_lines_old = ::RubyBeautify::NEW_LINES
+      ::RubyBeautify::NEW_LINES.push(:on_semicolon)  # XXX: sandbox somehow?
+
+      s = "def __\n#{code}\nend\n"
+      s.gsub! /^;/, ''         # remove leading semicolons
+      s.gsub! /;\s*$/, ''      # remove trailing semicolons
+      s.replace ::RubyBeautify.pretty_string(s, indent_token: "\1", indent_count: indent_count)
+      s.gsub! ";\1", "\n\1"    # remove trailing semicolons after formatting
+      s.gsub! "\1", ' '        # replace placeholder indent char with space
+      s.sub! /\Adef __\n/, ''  # remove wrapper method
+      s.sub! /\nend\n\z/, ''   # remove wrapper method
+
+      ::RubyBeautify::NEW_LINES.replace(new_lines_old)  # XXX: not thread-safe
+      s
+    end
+
+    alias :call :pretty_string
+  end
+end

data/lib/asciidoctor/templates_compiler/slim.rb

@@ -0,0 +1,39 @@
+require 'asciidoctor/converter'
+require 'asciidoctor/converter/template'
+require 'asciidoctor/templates_compiler/version'
+require 'asciidoctor/templates_compiler/base'
+require 'corefines'
+require 'slim'
+require 'slim/include'
+
+module Asciidoctor::TemplatesCompiler
+  class Slim < Base
+    using Corefines::Object::then
+
+    protected
+
+    def compile_template(filename, backend_info: {})
+      htmlsyntax = backend_info[:htmlsyntax] || backend_info['htmlsyntax'] || :html
+      opts = engine_options.merge(file: filename, format: htmlsyntax.to_sym)
+      content = IO.read(filename)
+
+      ::Slim::Engine.new(opts).call(content).tap do |code|
+        code.scan(/::(?:Slim|Temple)(?:\:\:\w+)*/).uniq.each do |name|
+          $stderr.puts "WARNING: Compiled template '#{filename}' references constant #{name}"
+        end
+      end
+    end
+
+    def find_templates(dirname)
+      Dir.glob("#{dirname}/[^_]*.slim")
+    end
+
+    def read_helpers(templates_dir)
+      super.then { |s| s.sub('module Slim::Helpers', 'module Helpers') }
+    end
+
+    def engine_options
+      ::Asciidoctor::Converter::TemplateConverter::DEFAULT_ENGINE_OPTIONS[:slim]
+    end
+  end
+end

data/lib/asciidoctor/templates_compiler/version.rb

@@ -0,0 +1,5 @@
+module Asciidoctor
+  module TemplatesCompiler
+    VERSION = '0.1.2'
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-templates-compiler
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Jakub Jirutka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: corefines
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-beautify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.97'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.97'
+description: 
+email: jakub@jirutka.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.adoc
+- asciidoctor-templates-compiler.gemspec
+- lib/asciidoctor-templates-compiler.rb
+- lib/asciidoctor/templates_compiler.rb
+- lib/asciidoctor/templates_compiler/base.rb
+- lib/asciidoctor/templates_compiler/converter_generator.rb
+- lib/asciidoctor/templates_compiler/ruby_beautify.rb
+- lib/asciidoctor/templates_compiler/slim.rb
+- lib/asciidoctor/templates_compiler/version.rb
+homepage: https://github.com/jirutka/asciidoctor-templates-compiler
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Compile templates-based Asciidoctor converter (backend) into a single Ruby
+  file
+test_files: []