asciidoctor-templates-compiler 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 284ae9f82eaa132717e6fbb51d7bb84fb5814a6a
-  data.tar.gz: 7330fa5e9a09c109082a406f283e7961578943d3
+  metadata.gz: 367bbbb5d5b7d7f38e994e845a65921592fe9036
+  data.tar.gz: f941a11c99f96177f4a251cc8f15820670c348b3
 SHA512:
-  metadata.gz: ce6e27c02ec9a9d3fea1ebb00d51986fdbbb0546916ca94c157b89d2eb6d6a9f8743d649d7bded06dedb73683c1d13754507831874d2f2dc952189433e9b8032
-  data.tar.gz: 6eef241dfe9d24f2fdfe8679508a8261cf062c411d9b651222a76e4065ab165472e20b0a252860de72625e48ff3aa49e3a2accf3c56a2aff15c771f0babbee6d
+  metadata.gz: dc05c92e8548eb23e49de8a8d6dee7d67b985b0c5ce74af785c0d0f41d360f9ffb4c0d3708b5ccf3323db5c441bde2a6536a6de70cd67296923f21f3fbf0b2a0
+  data.tar.gz: c466abc187ea3d4d7b781caad7b061db1873f37cbaa0109538c1506f2c76ad268db7a5bcde865674af92e19c0a60c409470f951d2d0895361a3f8363fadc2a19

data/README.adoc

@@ -2,9 +2,15 @@
 :source-language: ruby
 // custom
 :gem-name: asciidoctor-templates-compiler
-:gem-version: 0.1.2
+:gem-version: 0.1.3
+:gh-name: jirutka/{gem-name}
+:gh-branch: master
+:codacy-id: b23b8c6503474ea5b13537eaef0c73d5
 
 ifdef::env-github[]
+image:https://travis-ci.org/{gh-name}.svg?branch={gh-branch}[Build Status, link="https://travis-ci.org/{gh-name}"]
+image:https://api.codacy.com/project/badge/Coverage/{codacy-id}["Test Coverage", link="https://www.codacy.com/app/{gh-name}"]
+image:https://api.codacy.com/project/badge/Grade/{codacy-id}["Codacy Code quality", link="https://www.codacy.com/app/{gh-name}"]
 image:https://img.shields.io/gem/v/{gem-name}.svg?style=flat[Gem Version, link="https://rubygems.org/gems/{gem-name}"]
 endif::env-github[]
 
@@ -35,16 +41,49 @@ $ bundle install
 
 == Usage
 
+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**.
+
+class_name::
+  Full name of the converter class to generate (e.g. `My::HTML::Converter`).
+  This argument is **required**.
+
+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.
+
+backend_info::
+  A hash of keys for `backend_info`: `basebackend`, `outfilesuffix`, `filetype`, `htmlsyntax`.
+
+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`).
+
+
+=== Examples
+
 [source, subs="+attributes"]
+.Minimal example
 ----
 require '{gem-name}'
 
-File.open('html_custom_converter.rb', 'w') do |file|
+File.open('converter.rb', 'w') do |file|
   Asciidoctor::TemplatesCompiler::Slim.compile_converter(
       templates_dir: 'data/templates',
-      class_name: 'HtmlCustomConverter',
+      class_name: 'ShinyHtml::Converter',
       delegate_backend: 'html5',
-      register_for: ['html-custom'],
+      register_for: ['shiny-html'],
       backend_info: {
         basebackend: 'html',
         outfilesuffix: '.html',
@@ -55,6 +94,60 @@ File.open('html_custom_converter.rb', 'w') do |file|
 end
 ----
 
+[source, subs="+attributes"]
+.Example of usage in Rakefile
+----
+#!/usr/bin/env rake
+
+CONVERTER_FILE = 'lib/asciidoctor/shiny_html/converter.rb'
+TEMPLATES_DIR = 'data/templates'
+
+namespace :build do
+
+  file CONVERTER_FILE, [:mode] => FileList["#{TEMPLATES_DIR}/*"] do |t, args|
+    require '{gem-name}'
+
+    File.open(CONVERTER_FILE, 'w') do |file|
+      $stderr.puts "Generating #{file.path}."
+      Asciidoctor::TemplatesCompiler::Slim.compile_converter(
+          templates_dir: TEMPLATES_DIR,
+          class_name: 'Asciidoctor::ShinyHtml::Converter',
+          delegate_backend: 'html5',
+          register_for: ['shiny-html'],
+          backend_info: {
+            basebackend: 'html',
+            outfilesuffix: '.html',
+            filetype: 'html',
+          },
+          pretty: (args[:mode] == :pretty),
+          output: file)
+    end
+  end
+
+  namespace :converter do
+    desc 'Compile Slim templates and generate converter.rb (pretty mode)'
+    task :pretty do
+      Rake::Task[CONVERTER_FILE].invoke(:pretty)
+    end
+
+    desc 'Compile Slim templates and generate converter.rb (fast mode)'
+    task :fast do
+      Rake::Task[CONVERTER_FILE].invoke
+    end
+  end
+
+  task :converter => 'converter:pretty'
+end
+
+task :build => 'build:converter:pretty'
+
+task :clean do
+  rm_rf CONVERTER_FILE
+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].
+
 
 == License
 

data/asciidoctor-templates-compiler.gemspec

@@ -1,16 +1,16 @@
 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.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.summary  = 'Compile templates-based Asciidoctor converter (backend) into a single Ruby file'
 
-  s.files         = Dir['lib/**/*', '*.gemspec', 'LICENSE*', 'README*']
+  s.files    = Dir['lib/**/*', '*.gemspec', 'LICENSE*', 'README*']
 
   s.required_ruby_version = '>= 2.3'
 
@@ -18,4 +18,9 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'corefines', '~> 1.2'
   s.add_runtime_dependency 'slim', '>= 2.1', '< 4.0'
   s.add_runtime_dependency 'ruby-beautify', '~> 0.97'
+
+  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_development_dependency 'rspec', '~> 3.6'
+  s.add_development_dependency 'rubocop', '~> 0.49.0'
+  s.add_development_dependency 'simplecov', '~> 0.14'
 end

data/lib/asciidoctor-templates-compiler.rb

@@ -1 +1,2 @@
+# frozen_string_literal: true
 require 'asciidoctor/templates_compiler'

data/lib/asciidoctor/templates_compiler.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'asciidoctor/templates_compiler/version'
 require 'asciidoctor/templates_compiler/base'
 require 'asciidoctor/templates_compiler/slim'

data/lib/asciidoctor/templates_compiler/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'asciidoctor/templates_compiler/version'
 require 'asciidoctor/templates_compiler/converter_generator'
 require 'asciidoctor/templates_compiler/ruby_beautify'
@@ -5,19 +6,17 @@ require 'stringio'
 
 module Asciidoctor::TemplatesCompiler
   class Base
-
     class << self
       def compile_converter(**opts)
         new.compile_converter(**opts)
       end
 
-      alias_method :call, :compile_converter
+      alias 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"
+      unless Dir.exist? templates_dir
+        raise "Templates directory '#{templates_dir}' does not exist"
       end
 
       backend_info = opts[:backend_info] || {}
@@ -25,23 +24,21 @@ module Asciidoctor::TemplatesCompiler
       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)
+                     helpers_code: read_helpers(templates_dir), **opts)
     end
 
-    alias_method :call, :compile_converter
-
+    alias call compile_converter
 
     protected
 
+    # @abstract
     def compile_template(filename, backend_info: {})
-      fail NotImplementedError
     end
 
+    # @abstract
     def find_templates(dirname)
-      fail NotImplementedError
     end
 
-
     def beautify_code(code, **opts)
       RubyBeautify.call(code, **opts)
     end
@@ -61,13 +58,13 @@ module Asciidoctor::TemplatesCompiler
 
     def read_helpers(templates_dir)
       path = File.join(templates_dir, 'helpers.rb')
-      IO.read(path) if File.exists? path
+      IO.read(path) if File.exist? path
     end
 
     def transform_name_from_tmpl_name(filename)
       File.basename(filename)
-          .sub(/\..*$/, '')
-          .sub(/^block_/, '')
+        .sub(/\..*$/, '')
+        .sub(/^block_/, '')
     end
   end
 end

data/lib/asciidoctor/templates_compiler/converter_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'asciidoctor/templates_compiler/version'
 require 'corefines'
 require 'stringio'
@@ -7,16 +8,15 @@ module Asciidoctor::TemplatesCompiler
     using Corefines::String::indent
 
     class << self
-      def generate(output: nil, **opts)
+      def generate(output: StringIO.new, **opts)
         new(**opts).call(output)
       end
 
-      alias_method :call, :generate
+      alias call generate
     end
 
-
     def initialize(class_name:, transforms_code:, helpers_code: nil,
-                   register_for: [], backend_info: {}, delegate_backend: nil, **_)
+                   register_for: [], backend_info: {}, delegate_backend: nil, **)
       @class_name = class_name
       @transforms_code = transforms_code
       @helpers_code = helpers_code
@@ -36,16 +36,16 @@ module Asciidoctor::TemplatesCompiler
       out
     end
 
-    alias_method :call, :generate
+    alias 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
+        .split('::')[0..-2]
+        .map { |name| "module #{name};" }
+        .tap { |ary| ary.push('end ' * ary.size) }
+        .join(' ').strip
 
       <<~EOF
         # This file has been generated!
@@ -70,8 +70,9 @@ module Asciidoctor::TemplatesCompiler
     end
 
     def initialization_code
-      setup_backend_info = @backend_info
-          .map { |k, v| "  #{k} #{v.inspect}" }.join("\n")
+      setup_backend_info = if !@backend_info.empty?
+        @backend_info.map { |k, v| "  #{k} #{v.inspect}" }.join("\n")
+      end
 
       if !@register_for.empty?
         register_for = "register_for #{@register_for.map(&:inspect).join(', ')}\n"
@@ -85,10 +86,10 @@ module Asciidoctor::TemplatesCompiler
 
           converter = factory.create(delegate_backend, backend_info)
           @delegate_converter = if converter == self
-              factory.new.create(delegate_backend, backend_info)
-            else
-              converter
-            end
+            factory.new.create(delegate_backend, backend_info)
+          else
+            converter
+          end
         EOF
       end
 
@@ -96,8 +97,8 @@ module Asciidoctor::TemplatesCompiler
         register_for,
         'def initialize(backend, opts = {})',
         '  super',
-           setup_backend_info,
-           delegate_converter,
+        setup_backend_info,
+        delegate_converter,
         'end',
         '',
       ].compact.join("\n").indent(2, ' ')
@@ -105,10 +106,10 @@ module Asciidoctor::TemplatesCompiler
 
     def convert_method_code
       converter = if @delegate_backend
-          'respond_to?(transform) ? self : @delegate_converter'
-        else
-          'self'
-        end
+        'respond_to?(transform) ? self : @delegate_converter'
+      else
+        'self'
+      end
 
       <<~EOF.indent(2, ' ')
         def convert(node, transform = nil, opts = {})
@@ -144,7 +145,7 @@ module Asciidoctor::TemplatesCompiler
             node.extend(Helpers)
             node.instance_eval do
               converter.set_local_variables(binding, opts) unless opts.empty?
-          #{code.indent(4, ' ')}
+          #{code.indent(6, ' ')}
             end
           end
         EOF

data/lib/asciidoctor/templates_compiler/ruby_beautify.rb

@@ -1,27 +1,45 @@
+# frozen_string_literal: true
 require 'asciidoctor/templates_compiler/version'
 require 'ruby-beautify'
 
 module Asciidoctor::TemplatesCompiler
   module RubyBeautify
-    extend self
+    include ::RubyBeautify
+    extend self  # rubocop:disable Style/ModuleFunction
+
+    alias pretty_string_orig pretty_string
+    private :pretty_string_orig
 
     def pretty_string(code, indent_count: 2)
-      new_lines_old = ::RubyBeautify::NEW_LINES
-      ::RubyBeautify::NEW_LINES.push(:on_semicolon)  # XXX: sandbox somehow?
+      new_lines_old = NEW_LINES
+      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
+      s = +"module M_\n#{code}\nend\n"
+      s.gsub!(/^[ \t]*;/, '')      # remove leading semicolons
+      s.gsub!(/;\s*$/, '')         # remove trailing semicolons
+      s.replace(pretty_string_orig(s, indent_token: "\1", indent_count: indent_count))
+      s.gsub!(";\1", "\n\1")       # remove trailing semicolons after formatting
+      s.gsub!(/^#{"\1" * indent_count}/, '')  # remove redundant indentation level
+      s.tr!("\1", ' ')             # replace placeholder indent char with space
+      s.sub!(/\Amodule M_\n/, '')  # remove wrapper module
+      s.sub!(/\nend\n\z/, '')      # remove wrapper module
 
-      ::RubyBeautify::NEW_LINES.replace(new_lines_old)  # XXX: not thread-safe
+      NEW_LINES.replace(new_lines_old)  # XXX: not thread-safe
       s
     end
 
-    alias :call :pretty_string
+    alias call pretty_string
+
+    # XXX: Remove after https://github.com/erniebrodeur/ruby-beautify/pull/43 is merged.
+    # Overwrite this method from ::RubyBeautify with implementation that does
+    # not execute ruby subprocess.
+    def syntax_ok?(string)
+      catch :good do
+        eval "BEGIN { throw :good }; #{string}"  # rubocop:disable Security/Eval
+      end
+      true
+    rescue SyntaxError
+      false
+    end
   end
 end

data/lib/asciidoctor/templates_compiler/slim.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'asciidoctor/converter'
 require 'asciidoctor/converter/template'
 require 'asciidoctor/templates_compiler/version'

data/lib/asciidoctor/templates_compiler/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Asciidoctor
   module TemplatesCompiler
-    VERSION = '0.1.2'
+    VERSION = '0.1.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-templates-compiler
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Jakub Jirutka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-10 00:00:00.000000000 Z
+date: 2017-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -72,6 +72,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.97'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
 description: 
 email: jakub@jirutka.cz
 executables: []