pug-ruby 1.0.2 → 2.0.0.rc1

data/lib/jade-pug/errors/compilation-error.rb

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+module JadePug
+  #
+  # Used for template compilation errors, for example:
+  # - any template engine errors
+  # - syntax errors in template
+  # - any JavaScript exceptions (they are caught by ExecJS)
+  #
+  class CompilationError < StandardError
+
+  end
+end

data/lib/jade-pug/errors/compiler-error.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+module JadePug
+  #
+  # Used when something is wrong with shipped engine compiler, for example:
+  # - when compiler source couldn't be read (file is missing or permissions problem?)
+  # - when compiler couldn't be compiled (when ExecJS fails to compile JavaScript code)
+  #
+  class CompilerError < StandardError
+
+  end
+end

data/lib/jade-pug/shipped-compiler.rb

@@ -0,0 +1,80 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+require "execjs"
+
+module JadePug
+  #
+  # Abstraction layer for shipped engine compiler.
+  #
+  class ShippedCompiler < Compiler
+    #
+    # @param engine [Jade, Pug] The Jade or Pug module.
+    # @param version [String]
+    def initialize(engine, version)
+      super
+      @execjs = compile_compiler_source(read_compiler_source(path_to_compiler_source))
+    end
+
+    #
+    # Compiles template.
+    #
+    # @param source [String, #read]
+    # @param options [Hash]
+    # @return [String]
+    def compile(source, options = {})
+      source  = prepare_source(source)
+      options = prepare_options(options)
+      snippet = compilation_snippet \
+        method:    "compile#{"Client" if options[:client]}",
+        arguments: [source, options],
+        locals:    options.fetch(:locals, {}),
+        options:   options
+      result  = @execjs.eval(snippet)
+      process_result(source, result, options)
+    rescue ExecJS::ProgramError => e
+      raise engine::CompilationError, e.message
+    end
+
+  protected
+
+    #
+    # Returns absolute path to the file with compiler source.
+    #
+    # @return [String]
+    def path_to_compiler_source
+      File.expand_path("../../../vendor/#{engine.name.downcase}-#{version}.min.js", __FILE__)
+    end
+
+    #
+    # Reads the compiler source from a file and returns it.
+    #
+    # @param path [String]
+    # @return [String]
+    def read_compiler_source(path)
+      unless File.readable?(path)
+        raise engine::CompilerError, "Couldn't read compiler source: #{path}"
+      end
+      File.read(path)
+    end
+
+    #
+    # Compiles the compiler from source and returns it as {ExecJS::Runtime}.
+    #
+    # @param source [String]
+    # @return [ExecJS::Runtime]
+    def compile_compiler_source(source)
+      ExecJS.compile(source).tap do |compiler|
+        raise engine::CompilerError, "Failed to compile #{engine.name} compiler" unless compiler
+      end
+    end
+
+    #
+    # Returns the JavaScript code used to access engine NPM package.
+    #
+    # @return [String]
+    def npm_package_require_snippet
+      engine.name.downcase
+    end
+  end
+end

data/lib/jade-pug/system-compiler.rb

@@ -0,0 +1,139 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+require "open3"
+require "json"
+
+module JadePug
+  #
+  # Abstraction layer for system engine compiler.
+  #
+  class SystemCompiler < Compiler
+    #
+    # @param engine [Jade, Pug]
+    def initialize(engine)
+      super(engine, nil)
+
+      check_node_runtime!
+      check_npm_package!
+
+      engine.echo "Resolved system #{engine.name} to #{version}."
+    end
+
+    #
+    # Compiles the template.
+    #
+    # @param source [String, #read]
+    # @param options [hash]
+    # @return [String]
+    def compile(source, options = {})
+      source  = prepare_source(source)
+      options = prepare_options(options)
+      command = ["node", "--eval"]
+      command.push compilation_snippet \
+        method:    "compile#{"Client" if options[:client]}",
+        arguments: [source, options],
+        locals:    options.fetch(:locals, {}),
+        options:   options
+      stdout, stderr, exit_status = Open3.capture3(*command)
+      raise engine::CompilationError, stderr unless exit_status.success?
+      process_result(source, stdout, options)
+    end
+
+    #
+    # Returns version of engine installed system-wide.
+    #
+    # @return [String]
+    def version
+      stdout, exit_status = Open3.capture2 "node", "--eval", \
+        "console.log(require(#{ JSON.dump(File.join(npm_package_path, "package.json")) }).version)"
+
+      if exit_status.success?
+        stdout.strip
+      else
+        raise engine::CompilerError, \
+          %{Failed to get #{engine.name} version. Perhaps, the problem with Node.js runtime.}
+      end
+    end
+    memoize :version
+
+  protected
+
+    #
+    # Return the name of engine NPM package.
+    #
+    # @return [String]
+    def npm_package_name
+      engine.name.downcase
+    end
+
+    #
+    # Returns the path of globally installed engine NPM package.
+    #
+    # @return [String]
+    def npm_package_path
+      File.join(npm_packages_root, engine.name.downcase)
+    end
+
+    #
+    # Returns the JavaScript code used to require engine NPM package.
+    #
+    # @return [String]
+    def npm_package_require_snippet
+      "require(#{ JSON.dump(npm_package_path) })"
+    end
+
+    #
+    # Returns the root directory of globally installed NPM packages.
+    #
+    # @return [String]
+    def npm_packages_root
+      stdout, exit_status = Open3.capture2("npm", "root", "--global")
+
+      if exit_status.success?
+        stdout.strip
+      else
+        raise engine::CompilerError, \
+          %{Unable to get NPM packages root. Perhaps, the problem with Node.js runtime.}
+      end
+    end
+    memoize :npm_packages_root
+
+    #
+    # Checks if Node.js runtime exists in $PATH and is accessible.
+    #
+    # @raise {JadePug::CompilerError}
+    #   If Node.js runtime doesn't exist in system.
+    # @return [nil]
+    def check_node_runtime!
+      stdout, exit_status = Open3.capture2("node", "--version")
+
+      if exit_status.success?
+        @node_version = stdout.strip.gsub(/\Av/, "")
+        engine.echo "Using Node.js runtime #{@node_version}."
+      else
+        raise engine::CompilerError, %{No Node.js runtime has been found in your system.}
+      end
+      nil
+    end
+    memoize :check_node_runtime!
+
+    #
+    # Checks if engine NPM package has been installed.
+    #
+    # @raise {JadePug::CompilerError}
+    #   If engine NPM package han't been installed.
+    # @return [nil]
+    def check_npm_package!
+      exit_status = Open3.capture2("node", "--eval", npm_package_require_snippet)[1]
+
+      unless exit_status.success?
+        raise engine::CompilerError, \
+          %{No #{engine.name} NPM package has been found in your system. } +
+          %{Have you forgotten to "npm install --global #{npm_package_name}"?}
+      end
+      nil
+    end
+    memoize :check_npm_package!
+  end
+end

data/lib/jade-ruby/compilation-essentials.rb

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+module Jade
+  #
+  # Used to share common things between compilers.
+  #
+  module CompilationEssentials
+    #
+    # Responds for post-processing compilation result.
+    #
+    # @param source [String] The source code of template.
+    # @param result [String] The compiled code of template.
+    # @param options [Hash] The compilation options.
+    # @return [String]
+    def process_result(source, result, options)
+      if options[:client]
+        "(function(jade) { #{super}; return #{options[:name]}; }).call(this, jade);"
+      else
+        super
+      end
+    end
+  end
+end

data/lib/jade-ruby/config.rb

@@ -1,51 +1,24 @@
-# encoding: utf-8
+# encoding: UTF-8
 # frozen_string_literal: true
 
 module Jade
-  class Config
-    # http://web.archive.org/web/20160404025722/http://jade-lang.com/api/
-    # http://web.archive.org/web/20160618141847/http://jade-lang.com/command-line/
-    attr_accessor :filename
-    attr_accessor :doctype
-    attr_accessor :pretty
-    attr_accessor :self
-    attr_accessor :debug
-    attr_accessor :compile_debug
-    attr_accessor :cache
-    attr_accessor :globals
-    attr_accessor :client
-    attr_accessor :name
-    attr_accessor :name_after_file
-    attr_accessor :out
-    attr_accessor :extension
-    attr_accessor :hierarchy
-
+  #
+  # Defines Jade compiler configuration.
+  #
+  # The documentation for Jade configuration options can be found here:
+  # - {http://web.archive.org/web/*/jade-lang.com/api}
+  # - {https://github.com/pugjs/pug/blob/v1.x.x/bin/jade.js}
+  #
+  class Config < JadePug::Config
     def initialize
-      @filename        = nil
-      @doctype         = nil
-      @pretty          = false
-      @self            = false
-      @debug           = false
-      @compile_debug   = false
-      @cache           = false
-      @globals         = []
-      @client          = false
-      @name            = 'template'
-      @name_after_file = nil
-      @out             = nil
-      @extension       = nil
-      @hierarchy       = false
-    end
-
-    def to_hash
-      %i( filename      doctype         pretty
-          self          debug           compile_debug
-          cache         globals         client
-          name          name_after_file out
-          extension     hierarchy ).each_with_object({}) { |x, y| y[x] = send(x) }
+      super
+      @filename      = nil
+      @doctype       = nil
+      @pretty        = false
+      @self          = false
+      @compile_debug = false
+      @globals       = []
+      @name          = "template"
     end
   end
-
-  class << self; attr_accessor :config; end
-  self.config = Config.new
 end

data/lib/jade-ruby/errors/compilation-error.rb

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+module Jade
+  #
+  # Used for template compilation errors, for example:
+  # - any template engine errors
+  # - syntax errors in template
+  # - any JavaScript exceptions (they are caught by ExecJS)
+  #
+  class CompilationError < JadePug::CompilationError
+
+  end
+end

data/lib/jade-ruby/errors/compiler-error.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+module Jade
+  #
+  # Used when something is wrong with shipped Jade compiler, for example:
+  # - when compiler source couldn't be read (file is missing or permissions problem?)
+  # - when compiler couldn't be compiled (when ExecJS fails to compile JavaScript code)
+  #
+  class CompilerError < JadePug::CompilerError
+
+  end
+end

data/lib/jade-ruby/shipped-compiler.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+module Jade
+  #
+  # Abstraction layer for shipped Jade compiler.
+  #
+  class ShippedCompiler < JadePug::ShippedCompiler
+    include CompilationEssentials
+
+    def initialize(version)
+      super Jade, version
+    end
+  end
+end

data/lib/jade-ruby/system-compiler.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+module Jade
+  #
+  # Abstraction layer for system Jade compiler.
+  #
+  class SystemCompiler < JadePug::SystemCompiler
+    include CompilationEssentials
+
+    def initialize
+      super Jade
+    end
+  end
+end

data/lib/pug-ruby.rb

@@ -1,7 +1,48 @@
-# encoding: utf-8
+# encoding: UTF-8
 # frozen_string_literal: true
 
-require 'jade-ruby/config'
-require 'jade-ruby/compile'
-require 'pug-ruby/config'
-require 'pug-ruby/compile'
+#
+# This module contains common thing related Jade and Pug.
+#
+module JadePug
+  autoload :Config,           "jade-pug/config"
+  autoload :Compiler,         "jade-pug/compiler"
+  autoload :ShippedCompiler,  "jade-pug/shipped-compiler"
+  autoload :SystemCompiler,   "jade-pug/system-compiler"
+  autoload :CompilationError, "jade-pug/errors/compilation-error"
+  autoload :CompilerError,    "jade-pug/errors/compiler-error"
+end
+
+require "jade-pug/base"
+
+#
+# This module contains all stuff related to Jade template engine.
+# See the list below.
+#
+module Jade
+  extend JadePug
+
+  autoload :Config,                "jade-ruby/config"
+  autoload :Compiler,              "jade-ruby/compiler"
+  autoload :ShippedCompiler,       "jade-ruby/shipped-compiler"
+  autoload :SystemCompiler,        "jade-ruby/system-compiler"
+  autoload :CompilationEssentials, "jade-ruby/compilation-essentials"
+  autoload :CompilationError,      "jade-ruby/errors/compilation-error"
+  autoload :CompilerError,         "jade-ruby/errors/compiler-error"
+end
+
+#
+# This module contains all stuff related to Pug template engine.
+# See the list below.
+#
+module Pug
+  extend JadePug
+
+  autoload :Config,                "pug-ruby/config"
+  autoload :Compiler,              "pug-ruby/compiler"
+  autoload :ShippedCompiler,       "pug-ruby/shipped-compiler"
+  autoload :SystemCompiler,        "pug-ruby/system-compiler"
+  autoload :CompilationEssentials, "pug-ruby/compilation-essentials"
+  autoload :CompilationError,      "pug-ruby/errors/compilation-error"
+  autoload :CompilerError,         "pug-ruby/errors/compiler-error"
+end