pug-ruby 1.0.2 → 2.0.0.rc1

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

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+module Pug
+  #
+  # 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]
+        if options[:inline_runtime_functions]
+          "(function() { #{super}; return #{options[:name]}; }).call(this);"
+        else
+          pug = "typeof pugRuntime === 'object' && pugRuntime !== null ? pugRuntime : pug"
+          "(function(pug) { #{super}; return #{options[:name]}; }).call(this, #{pug});"
+        end
+      else
+        super
+      end
+    end
+  end
+end

data/lib/pug-ruby/config.rb

@@ -1,52 +1,26 @@
-# encoding: utf-8
+# encoding: UTF-8
 # frozen_string_literal: true
 
 module Pug
-  class Config
-    # https://pugjs.org/api/reference.html
-    # https://github.com/pugjs/pug-cli
-    attr_accessor :filename
-    attr_accessor :basedir
-    attr_accessor :doctype
-    attr_accessor :pretty
-    attr_accessor :self
-    attr_accessor :debug
-    attr_accessor :compile_debug
-    attr_accessor :globals
-    attr_accessor :inline_runtime_functions
-    attr_accessor :name
-    attr_accessor :name_after_file
-    attr_accessor :out
-    attr_accessor :extension
-    attr_accessor :silent
-
+  #
+  # Defines Pug compiler configuration.
+  #
+  # The documentation for Pug configuration options can be found here:
+  # - {https://pugjs.org/api/reference.html}
+  # - {https://github.com/pugjs/pug-cli/blob/master/index.js}
+  #
+  class Config < JadePug::Config
     def initialize
+      super
       @filename                 = nil
       @basedir                  = nil
       @doctype                  = nil
       @pretty                   = false
       @self                     = false
-      @debug                    = false
       @compile_debug            = false
       @globals                  = []
       @inline_runtime_functions = true
-      @name                     = 'template'
-      @name_after_file          = nil
-      @out                      = nil
-      @extension                = nil
-      @silent                   = true
-    end
-
-    def to_hash
-      %i( filename      basedir         doctype
-          pretty        self            debug
-          compile_debug globals         inline_runtime_functions
-          name          name_after_file out
-          extension     silent ).each_with_object({}) { |x, y| y[x] = send(x) }
+      @name                     = "template"
     end
   end
-
-  singleton_class.class_exec { attr_accessor :config }
-  self.config = Config.new
 end
-

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

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+module Pug
+  #
+  # 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/pug-ruby/errors/compiler-error.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+module Pug
+  #
+  # Used when something is wrong with shipped Pug 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/pug-ruby/shipped-compiler.rb

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

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

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

data/lib/pug-ruby/version.rb

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#
+# Keeps the "pug-ruby" gem version.
+#
+PUG_RUBY_GEM_VERSION = "2.0.0.rc1"

data/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "pug-ruby",
+  "devDependencies": {
+    "babel-plugin-transform-es2015-block-scoping": "^6.24.1",
+    "babel-preset-es2015": "^6.24.1",
+    "babelify": "^7.3.0",
+    "browserify": "^14.4.0",
+    "envify": "^4.1.0",
+    "uglify-js": "^3.0.26"
+  }
+}

data/pug-ruby.gemspec

@@ -1,20 +1,27 @@
-# encoding: utf-8
+# encoding: UTF-8
 # frozen_string_literal: true
 
+require File.expand_path("../lib/pug-ruby/version", __FILE__)
+
 Gem::Specification.new do |s|
-  s.name            = 'pug-ruby'
-  s.version         = '1.0.2'
-  s.author          = 'Yaroslav Konoplov'
-  s.email           = 'eahome00@gmail.com'
-  s.summary         = 'Ruby wrapper for the Pug/Jade template engine.'
-  s.description     = 'Ruby wrapper for the Pug/Jade template engine.'
-  s.homepage        = 'https://github.com/yivo/pug-ruby'
-  s.license         = 'MIT'
+  s.name            = "pug-ruby"
+  s.version         = PUG_RUBY_GEM_VERSION
+  s.author          = "Yaroslav Konoplov"
+  s.email           = "eahome00@gmail.com"
+  s.summary         = "Ruby wrapper for the Jade / Pug template engine."
+  s.description     = "Ruby wrapper for the Jade / Pug template engine."
+  s.homepage        = "https://github.com/yivo/pug-ruby"
+  s.license         = "MIT"
 
   s.files           = `git ls-files -z`.split("\x0")
   s.test_files      = `git ls-files -z -- {test,spec,features}/*`.split("\x0")
-  s.require_paths   = ['lib']
+  s.require_paths   = ["lib"]
 
-  s.add_development_dependency 'bundler', '~> 1.7'
-  s.add_development_dependency 'rake',    '~> 10.0'
+  s.add_dependency             "execjs",                 "~> 2.0"
+  s.add_dependency             "memoist",                "~> 0.15"
+  s.add_dependency             "regexp-match-polyfill",  "~> 1.0", ">= 1.0.2"
+  s.add_dependency             "method-not-implemented", "~> 1.0", ">= 1.0.1"
+  s.add_development_dependency "rake",                   "~> 10.0"
+  s.add_development_dependency "test-unit",              "~> 3.1"
+  s.add_development_dependency "bundler",                "~> 1.7"
 end

data/support/browserify-jade-runtime.js

@@ -0,0 +1,19 @@
+process.env['NODE_ENV']  = 'production';
+
+var fs                   = require('fs');
+var browserify           = require('browserify');
+
+var ENGINE_RUNTIME_DIR   = process.argv[2];
+var ENGINE_RUNTIME_VER   = process.argv[3];
+var OUTPUT_FILE          = process.argv[4];
+
+var ENGINE_RUNTIME_INDEX = ENGINE_RUNTIME_DIR + '/lib/runtime.js';
+
+browserify({entries: [ENGINE_RUNTIME_INDEX], standalone: 'jade'})
+  .transform('babelify', {
+    presets: ['es2015'],
+    plugins: ['transform-es2015-block-scoping']
+  })
+  .transform('envify')
+  .bundle()
+  .pipe(fs.createWriteStream(OUTPUT_FILE));

data/support/browserify-jade.js

@@ -0,0 +1,17 @@
+process.env['NODE_ENV'] = 'production';
+
+var fs                  = require('fs');
+var browserify          = require('browserify');
+
+var ENGINE_DIR          = process.argv[2];
+var ENGINE_VERSION      = process.argv[3];
+var OUTPUT_FILE         = process.argv[4];
+
+browserify({entries: [ENGINE_DIR + '/lib/index.js'], standalone: 'jade'})
+  .transform('babelify', {
+    presets: ['es2015'],
+    plugins: ['transform-es2015-block-scoping']
+  })
+  .transform('envify')
+  .bundle()
+  .pipe(fs.createWriteStream(OUTPUT_FILE));

data/support/browserify-pug-runtime.js

@@ -0,0 +1,19 @@
+process.env['NODE_ENV'] = 'production';
+
+var fs                  = require('fs');
+var browserify          = require('browserify');
+
+var ENGINE_RUNTIME_DIR  = process.argv[2];
+var ENGINE_RUNTIME_VER  = process.argv[3];
+var OUTPUT_FILE         = process.argv[4];
+
+var ENGINE_RUNTIME_INDEX = ENGINE_RUNTIME_DIR + '/index.js';
+
+browserify({entries: [ENGINE_RUNTIME_INDEX], standalone: 'pugRuntime'})
+  .transform('babelify', {
+    presets: ['es2015'],
+    plugins: ['transform-es2015-block-scoping']
+  })
+  .transform('envify')
+  .bundle()
+  .pipe(fs.createWriteStream(OUTPUT_FILE));

data/support/browserify-pug.js

@@ -0,0 +1,23 @@
+process.env['NODE_ENV'] = 'production';
+
+var fs                  = require('fs');
+var browserify          = require('browserify');
+
+var ENGINE_DIR          = process.argv[2];
+var ENGINE_VERSION      = process.argv[3];
+var OUTPUT_FILE         = process.argv[4];
+
+var ENGINE_INDEX        = fs.existsSync(ENGINE_DIR + '/packages/pug/lib/index.js') ?
+                          ENGINE_DIR + '/packages/pug/lib/index.js' :
+                          ENGINE_DIR + '/lib/index.js';
+
+browserify({entries: [ENGINE_INDEX], standalone: 'pug'})
+  .transform('babelify', {
+    global:  true,
+    only:    /\/node_modules\/pug-/,
+    presets: ['es2015'],
+    plugins: ['transform-es2015-block-scoping']
+  })
+  .transform('envify')
+  .bundle()
+  .pipe(fs.createWriteStream(OUTPUT_FILE));

data/support/minify-jade.js

@@ -0,0 +1,11 @@
+process.env['NODE_ENV'] = 'production';
+
+var fs                  = require('fs');
+var uglifyJS            = require('uglify-js');
+
+var INPUT_FILE          = process.argv[2];
+var OUTPUT_FILE         = INPUT_FILE;
+
+var code = fs.readFileSync(INPUT_FILE, 'UTF-8');
+
+fs.writeFileSync(OUTPUT_FILE, uglifyJS.minify(code, {compress: true, mangle: true}).code);

data/support/minify-pug.js

@@ -0,0 +1,11 @@
+process.env['NODE_ENV'] = 'production';
+
+var fs                  = require('fs');
+var uglifyJS            = require('uglify-js');
+
+var INPUT_FILE          = process.argv[2];
+var OUTPUT_FILE         = INPUT_FILE;
+
+var code = fs.readFileSync(INPUT_FILE, 'UTF-8');
+
+fs.writeFileSync(OUTPUT_FILE, uglifyJS.minify(code, {compress: true, mangle: true}).code);

data/test/helper.rb

@@ -0,0 +1,202 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+Bundler.require :default, :development
+require "stringio"
+require "regexp-match-polyfill"
+
+Jade.silence = true
+Pug.silence  = true
+
+module JadePugTestHelpers
+  def engine
+    Object.const_get self.class.name.gsub(/Test\z/, "")
+  end
+
+  def each_version
+    ([:system] + engine.versions).each { |v| yield(v) }
+  end
+
+  def ext
+    ".#{engine.name.downcase}"
+  end
+
+  def expand_path(relative_path)
+    File.expand_path(File.join("../#{engine.name.downcase}", relative_path), __FILE__)
+  end
+
+  def assert_match_doctype(string)
+    assert_match(doctype_regex, string)
+  end
+
+  def assert_no_match_doctype(string)
+    assert_no_match(doctype_regex, string)
+  end
+
+  def assert_match_template_function(string)
+    assert_match(template_function_regex, string)
+  end
+
+  def assert_no_match_template_function(string)
+    assert_no_match(template_function_regex, string)
+  end
+
+  def doctype_regex
+    /[<\\u003C]!DOCTYPE html[>\\u003E]/
+  end
+
+  def template_function_regex
+    /function\s+#{engine.config.name}\s*\(locals\)\s*\{.*\}/m
+  end
+end
+
+module JadePugTest
+  def self.included(base)
+    base.class_eval do
+      include JadePugTestHelpers
+
+      versions = [:system] + Object.const_get(base.name.gsub(/Test\z/, "")).versions
+      versions = [:system] if ENV["QUICK"]
+
+      versions.each do |version|
+        test "compilation_#{version}" do
+          engine.use version
+          result = engine.compile("div Hello, world!")
+          assert_no_match_template_function(result)
+          assert_no_match_doctype(result)
+        end
+
+        test "compilation_with_doctype_#{version}" do
+          engine.use version
+          result = engine.compile(File.read(expand_path("index#{ext}")))
+          assert_no_match_template_function(result)
+          assert_match_doctype(result)
+        end
+
+        test "compilation_with_io_#{version}" do
+          engine.use version
+          template = "div\n  | Hello, world!"
+          io       = StringIO.new(template)
+          assert_equal(engine.compile(template), engine.compile(io))
+        end
+
+        test "compilation_with_syntax_error_#{version}" do
+          engine.use version
+          assert_raise(engine::CompilationError) { engine.compile("else\n  div") }
+        end
+
+        test "client_compilation_#{version}" do
+          engine.use version
+          result = engine.compile("div Hello, world!", client: true)
+          assert_match_template_function(result)
+          assert_no_match_doctype(result)
+        end
+
+        test "client_compilation_with_doctype_#{version}" do
+          engine.use version
+          result = engine.compile(File.read(expand_path("index#{ext}")), client: true)
+          assert_match_template_function(result)
+          assert_match_doctype(result)
+        end
+
+        test "compilation_with_locals_#{version}" do
+          engine.use version
+          template = "div=greeting"
+          result   = engine.compile(template, locals: { greeting: "Hello, world!" })
+          assert_no_match_template_function(result)
+          assert_match("Hello, world!", result)
+          assert_no_match(/greeting/, result)
+        end
+
+        test "client_compilation_with_locals_#{version}" do
+          engine.use version
+          template = "div=greeting"
+          result   = engine.compile(template, locals: { greeting: "Hello, world!" }, client: true)
+          assert_match_template_function(result)
+          assert_no_match(/Hello, world!/, result)
+          assert_match("greeting", result)
+        end
+
+        test "switch_version_permanently_#{version}" do
+          engine.use version
+          assert_equal(version == :system ? engine.versions.last : version, engine.compiler.version)
+        end
+
+        test "switch_version_temporarily_#{version}" do
+          was     = engine.compiler.system? ? :system : engine.compiler.version
+          @called = false
+          engine.use(version) { @called = true }
+          assert_equal(engine.compiler.system? ? :system : engine.compiler.version, was)
+          assert @called
+        end
+      end
+    end
+  end
+
+  def test_compilation_with_includes
+    engine.use :system
+    file     = expand_path("includes/index#{ext}")
+    template = File.read(file)
+    result   = engine.compile(template, filename: file)
+    assert_no_match_template_function(result)
+    assert_match_doctype(result)
+  end
+
+  def test_compilation_with_extends
+    engine.use :system
+    file     = expand_path("extends/index#{ext}")
+    template = File.read(file)
+    result   = engine.compile(template, filename: file)
+    assert_no_match_template_function(result)
+    assert_match_doctype(result)
+  end
+
+  def test_client_compilation_with_includes
+    engine.use :system
+    file     = expand_path("includes/index#{ext}")
+    template = File.read(file)
+    result   = engine.compile(template, filename: file, client: true)
+    assert_match_template_function(result)
+    assert_match_doctype(result)
+  end
+
+  def test_client_compilation_with_extends
+    engine.use :system
+    file     = expand_path("extends/index#{ext}")
+    template = File.read(file)
+    result   = engine.compile(template, filename: file, client: true)
+    assert_match_template_function(result)
+    assert_match_doctype(result)
+  end
+
+  def test_version_list
+    assert_equal engine == Jade ? "1.0.0"  : "2.0.0-beta1", engine.versions.first
+    assert_equal engine == Jade ? "1.11.0" : "2.0.0-rc.3",  engine.versions.last
+  end
+
+  def test_runtime_version_list
+    assert_equal engine == Jade ? "1.0.0"  : "2.0.0", engine.runtime_versions.first
+    assert_equal engine == Jade ? "1.11.0" : "2.0.2", engine.runtime_versions.last
+  end
+
+  def test_config_serialization
+    [:filename, :doctype, :pretty].each do |option|
+      assert_include engine.config.to_h.keys, option
+    end
+  end
+
+  def test_config_customization
+    engine.config.custom_option = "value"
+    assert_equal "value", engine.config.custom_option
+    assert engine.config.custom_option?
+    assert_include engine.config.to_h.keys, :custom_option
+  end
+
+  def test_get_known_compiler
+    assert engine::ShippedCompiler === engine.compiler(engine.versions.sample)
+  end
+
+  def test_get_unknown_compiler
+    assert_raise(engine::CompilerError) { engine.compiler "0.0.0" }
+  end
+end