asciidoctor-templates-compiler 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 367bbbb5d5b7d7f38e994e845a65921592fe9036
-  data.tar.gz: f941a11c99f96177f4a251cc8f15820670c348b3
+  metadata.gz: ad02dd81d47a7185c55b040d6a80af3f6fa5ba24
+  data.tar.gz: 26b3aaa536e7f76843fa4f7036c9d8d1901e4453
 SHA512:
-  metadata.gz: dc05c92e8548eb23e49de8a8d6dee7d67b985b0c5ce74af785c0d0f41d360f9ffb4c0d3708b5ccf3323db5c441bde2a6536a6de70cd67296923f21f3fbf0b2a0
-  data.tar.gz: c466abc187ea3d4d7b781caad7b061db1873f37cbaa0109538c1506f2c76ad268db7a5bcde865674af92e19c0a60c409470f951d2d0895361a3f8363fadc2a19
+  metadata.gz: 5190bb978d148d33659d16ce2065f6455e7da03322fe8c45979403ef6f4fc1f60baf27765d5900e16d04019466ff3e55169301172f897715d55772d903f1423e
+  data.tar.gz: 27cb8c19f213138b057d998d8f1a53eae0a03798ba0d508053ae651750ecbeec2b321d3d922bf4ef32db521c3b36b7ff34d9120f2400ecccafa6147563c391e5

data/README.adoc

@@ -2,7 +2,7 @@
 :source-language: ruby
 // custom
 :gem-name: asciidoctor-templates-compiler
-:gem-version: 0.1.3
+:gem-version: 0.2.0
 :gh-name: jirutka/{gem-name}
 :gh-branch: master
 :codacy-id: b23b8c6503474ea5b13537eaef0c73d5
@@ -43,9 +43,8 @@ $ bundle install
 
 The main entry point is method `Asciidoctor::TemplatesCompiler::Slim#compile_converter` (for Slim) that accepts the following keyword arguments.
 
-templates_dir::
-  Path of the directory where to look for templates (`*.slim` files not starting with `_`, in the case of Slim) and (optional) `helpers.rb`.
-  This argument is **required**.
+backend_info::
+  A hash of keys for `backend_info`: `basebackend`, `outfilesuffix`, `filetype`, `htmlsyntax`.
 
 class_name::
   Full name of the converter class to generate (e.g. `My::HTML::Converter`).
@@ -55,20 +54,24 @@ delegate_backend::
   Name of the backend (converter) to use as a fallback for AST nodes not supported by your converter.
   If not specified (default), no fallback will be used and converter will raise `NoMethodError` when it try to convert an unsupported node.
 
-register_for::
-  An array of backend names that the generated converter should be registered in Asciidoctor to handle.
-  Default is empty.
+engine_opts::
+  A Hash of options to pass into the templating engine that compiles templates into Ruby code.
 
-backend_info::
-  A hash of keys for `backend_info`: `basebackend`, `outfilesuffix`, `filetype`, `htmlsyntax`.
+output::
+  An output stream (`IO` object like opened file, `$stdout`, …) to write the generated converter into.
+  Default is `StringIO.new` (it’s the return value of `#compile_converter`).
 
 pretty::
   Enable pretty-formatting of the generated Ruby code (generated by Slim/Temple)?
   Default is `false`.
 
-output::
-  An output stream (`IO` object like opened file, `$stdout`, …) to write the generated converter into.
-  Default is `StringIO.new` (it’s the return value of `#compile_converter`).
+register_for::
+  An array of backend names that the generated converter should be registered in Asciidoctor to handle.
+  Default is empty.
+
+templates_dir::
+  Path of the directory where to look for templates (`*.slim` files not starting with `_`, in the case of Slim) and (optional) `helpers.rb`.
+  This argument is **required**.
 
 
 === Examples

data/lib/asciidoctor/templates_compiler/base.rb

@@ -14,16 +14,15 @@ module Asciidoctor::TemplatesCompiler
       alias call compile_converter
     end
 
-    def compile_converter(output: StringIO.new, templates_dir:, pretty: false, **opts)
+    def compile_converter(templates_dir:, engine_opts: {}, pretty: false, **opts)
       unless Dir.exist? templates_dir
         raise "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)
+      transforms_code = compile_templates(templates, engine_opts, pretty: pretty)
 
-      generate_class(output: output, transforms_code: transforms_code,
+      generate_class(transforms_code: transforms_code,
                      helpers_code: read_helpers(templates_dir), **opts)
     end
 
@@ -32,7 +31,7 @@ module Asciidoctor::TemplatesCompiler
     protected
 
     # @abstract
-    def compile_template(filename, backend_info: {})
+    def compile_template(filename, engine_opts = {})
     end
 
     # @abstract
@@ -43,9 +42,9 @@ module Asciidoctor::TemplatesCompiler
       RubyBeautify.call(code, **opts)
     end
 
-    def compile_templates(template_files, backend_info: {}, pretty: false)
+    def compile_templates(template_files, engine_opts = {}, pretty: false)
       template_files.lazy.map do |path|
-        code = compile_template(path, backend_info: backend_info)
+        code = compile_template(path, engine_opts)
         code = beautify_code(code) if pretty
 
         [transform_name_from_tmpl_name(path), code]
@@ -58,7 +57,7 @@ module Asciidoctor::TemplatesCompiler
 
     def read_helpers(templates_dir)
       path = File.join(templates_dir, 'helpers.rb')
-      IO.read(path) if File.exist? path
+      File.exist?(path) ? IO.read(path) : ''
     end
 
     def transform_name_from_tmpl_name(filename)

data/lib/asciidoctor/templates_compiler/converter_generator.rb

@@ -6,6 +6,7 @@ require 'stringio'
 module Asciidoctor::TemplatesCompiler
   class ConverterGenerator
     using Corefines::String::indent
+    using Corefines::Object::blank?
 
     class << self
       def generate(output: StringIO.new, **opts)
@@ -20,14 +21,18 @@ module Asciidoctor::TemplatesCompiler
       @class_name = class_name
       @transforms_code = transforms_code
       @helpers_code = helpers_code
-      @register_for = register_for
+      @register_for = Array(register_for)
       @backend_info = backend_info
       @delegate_backend = delegate_backend
+
+      if !helpers_code.blank? && helpers_code !~ /\bmodule Helpers[\s#]/
+        raise ArgumentError, 'The helpers_code does not contain module Helpers'
+      end
     end
 
     def generate(out = StringIO.new)
       out << head_code << "\n"
-      out << helpers_code << "\n" if @helpers_code
+      out << helpers_code << "\n" unless @helpers_code.blank?
       out << initialization_code << "\n"
       out << convert_method_code << "\n"
       transform_methods_code(out)
@@ -142,7 +147,7 @@ module Asciidoctor::TemplatesCompiler
         out << <<~EOF.indent(2, ' ')
 
           def #{name}(node, opts = {})
-            node.extend(Helpers)
+          #{'  node.extend(Helpers)' unless @helpers_code.blank?}
             node.instance_eval do
               converter.set_local_variables(binding, opts) unless opts.empty?
           #{code.indent(6, ' ')}

data/lib/asciidoctor/templates_compiler/slim.rb

@@ -3,22 +3,29 @@ require 'asciidoctor/converter'
 require 'asciidoctor/converter/template'
 require 'asciidoctor/templates_compiler/version'
 require 'asciidoctor/templates_compiler/base'
+require 'asciidoctor/templates_compiler/temple_ext'
 require 'corefines'
 require 'slim'
 require 'slim/include'
 
 module Asciidoctor::TemplatesCompiler
   class Slim < Base
-    using Corefines::Object::then
+
+    DEFAULT_ENGINE_OPTS =
+      ::Asciidoctor::Converter::TemplateConverter::DEFAULT_ENGINE_OPTIONS[:slim].dup.freeze
+
+    def compile_converter(backend_info: {}, engine_opts: {}, **)
+      engine_opts[:format] ||= backend_info.fetch('htmlsyntax', 'html').to_sym
+      super
+    end
 
     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)
+    def compile_template(filename, engine_opts = {})
+      engine_opts = DEFAULT_ENGINE_OPTS.merge(**engine_opts, file: filename)
       content = IO.read(filename)
 
-      ::Slim::Engine.new(opts).call(content).tap do |code|
+      ::Slim::Engine.new(engine_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
@@ -30,11 +37,7 @@ module Asciidoctor::TemplatesCompiler
     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]
+      super.sub('module Slim::Helpers', 'module Helpers')
     end
   end
 end

data/lib/asciidoctor/templates_compiler/temple_ext.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require 'temple'
+
+module Temple
+  # Monkey-patch Temple::Generator to fix bugs/inconviences waiting to be
+  # merged into upstream.
+  class Generator
+
+    # XXX: Remove after https://github.com/judofyr/temple/pull/113 is merged.
+    def initialize(opts = {})
+      self.class.options[:capture_generator] = self.class
+      super
+    end
+
+    # XXX: Remove after https://github.com/judofyr/temple/pull/112 is merged.
+    def on_capture(name, exp)
+      capture_generator.new(**options, buffer: name).call(exp)
+    end
+  end
+end

data/lib/asciidoctor/templates_compiler/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module TemplatesCompiler
-    VERSION = '0.1.3'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-templates-compiler
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Jakub Jirutka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-27 00:00:00.000000000 Z
+date: 2017-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -143,6 +143,7 @@ files:
 - lib/asciidoctor/templates_compiler/converter_generator.rb
 - lib/asciidoctor/templates_compiler/ruby_beautify.rb
 - lib/asciidoctor/templates_compiler/slim.rb
+- lib/asciidoctor/templates_compiler/temple_ext.rb
 - lib/asciidoctor/templates_compiler/version.rb
 homepage: https://github.com/jirutka/asciidoctor-templates-compiler
 licenses:
@@ -164,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Compile templates-based Asciidoctor converter (backend) into a single Ruby