asciidoctor-templates-compiler 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47d4105679ab592e65c3e054abb7bce74216f51a8ed94e6095f16a75486eac36
-  data.tar.gz: ad30aa2981e5343445a6410f0b99ed75fbecd2ad44414929219165c8bf4684a4
+  metadata.gz: 2bb8bf4e21a7c0da30e0862a44aa6d44bb7b848454e7709586e1d500849de30e
+  data.tar.gz: 1793750752bdcfb66b5193de00e0a51d962c941b41b642c17f8c3129fab0b4d9
 SHA512:
-  metadata.gz: cf9513a6eeed653fa31d1976e752c5a2444cb44a9aa49d6256b512d05a576e9472299d3580766e926d878df902c2462e5e823eb694d32804d8f7733ba6831238
-  data.tar.gz: 6c711e96fd5c3259ae985ee9c2409ef6a734247ac21b840149fdf8eda2955d179747b8ec58d27452096e74307b7c6110d15a0497cbfb047430e161f4c94c915d
+  metadata.gz: 958552ef2e142a7792272b4713997129946bc39325c7325f7cf5e49e37d9d98f211f27efe3e453a2de443a24965d1da4d1de3f0e7b279e0495bd4668d02c8a78
+  data.tar.gz: 237265848e2094213d2387cd8c4e2f23d6296409199e8b9223949c9493a23ff81de74625f1db396bdc8bc8d4ffdb5e7bef036cc01d66ddb8f9cc4b5f444d2a8f

data/README.adoc

@@ -2,7 +2,7 @@
 :source-language: ruby
 // custom
 :gem-name: asciidoctor-templates-compiler
-:gem-version: 0.4.2
+:gem-version: 0.5.0
 :gh-name: jirutka/{gem-name}
 :gh-branch: master
 :codacy-id: b23b8c6503474ea5b13537eaef0c73d5
@@ -57,6 +57,10 @@ delegate_backend::
 engine_opts::
   A Hash of options to pass into the templating engine that compiles templates into Ruby code.
 
+ignore_convert_opts::
+  Ignore (i.e. do not set as local variables) options passed to the `#convert` method (i.e. to the templates).
+  This is needed only for Opal.
+
 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`).
@@ -152,6 +156,46 @@ end
 You can also look into https://github.com/jirutka/asciidoctor-html5s/[asciidoctor-html5s] for a real-world example including integration with https://github.com/asciidoctor/asciidoctor-doctest/[Asciidoctor::DocTest].
 
 
+=== Opal Caveats
+
+The generated converter code can be transpiled into JavaScript using Opal.
+However, there’s one feature that is known to not work: passing options to the `#convert` method.
+
+Consider the following example:
+
+[source, slim]
+.toc.html.slim:
+nav id='toc'
+  = converter.convert document, 'outline', toclevels: 5
+
+[source, slim]
+.outline.html.slim:
+- toclevels ||= document.attr('toclevels').to_i
+
+Variable `toclevels` in `outline.html.slim` should be initialized to `5` when this template is called from the `toc.html.slim` template.
+This is implemented using `Kernel#binding` and `Binding#local_variable_set` which is not supported by Opal.
+In such case you get exception like this:
+
+....
+RuntimeError: node_modules/opal-runtime/src/opal.js
+         throw exception;
+         ^
+
+binding: undefined method `binding` for [some Asciidoctor class]
+....
+
+Unfortunately I don’t know how to implement this feature without using `Binding`, but you can use the following workaround.
+
+Enable `ignore_convert_opts` (see <<Usage>>) to remove the code calling `Kernel#binding` from the converter.
+The options will be still passed, but not binded to the template local variables.
+If you examine the generated code, you can see that the options are passed to the convert methods via argument named `opts`.
+You can exploit this fact and do something like:
+
+[source, slim]
+.outline.html.slim:
+- toclevels = opts[:toclevels] || document.attr('toclevels').to_i
+
+
 == License
 
 This project is licensed under http://opensource.org/licenses/MIT/[MIT License].

data/lib/asciidoctor/templates_compiler/converter_generator.rb

@@ -40,17 +40,21 @@ module Asciidoctor::TemplatesCompiler
     # @param delegate_backend [String, nil] name of the backend (converter) to use as a fallback
     #   for AST nodes not supported by the generated converter. If not specified, no fallback will
     #   be used and converter will raise +NoMethodError+ when it try to convert unsupported node.
+    # @param ignore_convert_opts [Boolean] ignore (i.e. do not set as local variables) options
+    #   passed to the +#convert+ method (i.e. to the templates). This is needed only for Opal.
     #
     # @raise [ArgumentError] if _helpers_code_ is not blank and does not contain module +Helpers+.
     #
     def initialize(class_name:, transforms_code:, helpers_code: nil,
-                   register_for: [], backend_info: {}, delegate_backend: nil, **)
+                   register_for: [], backend_info: {}, delegate_backend: nil,
+                   ignore_convert_opts: false, **)
       @class_name = class_name
       @transforms_code = transforms_code
       @helpers_code = helpers_code
       @register_for = Array(register_for)
       @backend_info = backend_info
       @delegate_backend = delegate_backend
+      @ignore_convert_opts = ignore_convert_opts
 
       if !helpers_code.blank? && helpers_code !~ /\bmodule Helpers[\s#]/
         raise ArgumentError, 'The helpers_code does not contain module Helpers'
@@ -166,6 +170,8 @@ module Asciidoctor::TemplatesCompiler
     end
 
     def support_methods_code
+      return '' if @ignore_convert_opts
+
       <<-EOF.reindent(2)
         def set_local_variables(binding, vars)
           vars.each do |key, val|
@@ -183,7 +189,7 @@ module Asciidoctor::TemplatesCompiler
         out << "  def #{name}(node, opts = {})\n"
         out << "    node.extend(Helpers)\n" unless @helpers_code.blank?
         out << "    node.instance_eval do\n"
-        out << "      converter.set_local_variables(binding, opts) unless opts.empty?\n"
+        out << "      converter.set_local_variables(binding, opts) unless opts.empty?\n" unless @ignore_convert_opts  # rubocop:disable LineLength
         out << code.indent(6, ' ') << "\n"
         out << "    end\n"
         out << "  end\n"

data/lib/asciidoctor/templates_compiler/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module TemplatesCompiler
-    VERSION = '0.4.2'
+    VERSION = '0.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-templates-compiler
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Jakub Jirutka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-11 00:00:00.000000000 Z
+date: 2018-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor