pug-ruby 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be027b8c14e9788bac1f212ef1f2b75c275f2334
+  data.tar.gz: f67f06fb7e0f3c50fe5bd9bcc45c93a9f0ebb396
+SHA512:
+  metadata.gz: 64a162f930c8f41dca937990fc11c5d808cc6fdb48b50059218d8bde5503c9d40f0e32b0b06e9d70ace036585789c526f2684b48b177de06bf43252766741b55
+  data.tar.gz: 1a8f9c0edb89455693a40e3d2f1de5db1c0450f6ce17a9ce5fae9484a2eb294d228042d0783c7ba108ae239fe34e7905610290e3cc8ff62b965e404f9cae8163

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+*.lock
+.bundle
+.ruby-version
+pkg/
+tmp/
+/.idea/

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+
+rvm:
+  - 2.3.1
+
+cache: bundler
+
+branches:
+  only:
+    - master
+
+env:
+  - RAILS_ENV=test RAKE_ENV=test
+
+before_script:
+  - npm install jade
+  - npm install pug-cli
+
+script:
+  - bundle exec rake test

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+gem 'test-unit'

data/README.md

@@ -0,0 +1,50 @@
+## Ruby wrapper for the Pug/Jade template engine
+
+## About
+This gem is wrapper for Pug/Jade command line interface. You can compile both Jade templates ([version 1.x](https://github.com/pugjs/pug/tree/v1.x.x)) and Pug ([version 2.x](https://github.com/pugjs/pug)).
+<br>
+```ruby
+Jade.compile(source, options)
+Pug.compile(source, options)
+```
+
+## Installing gem
+Run `gem install pug-ruby -v '~> 1.0'`. Add `require 'pug-ruby'` to your code.
+
+
+**If you are using bundler.**
+<br>
+Add to your Gemfile:
+```ruby
+gem 'pug-ruby', '~> 1.0'
+```
+
+## Installing Jade
+Install Jade globally via npm:
+```bash
+npm install -g jade
+```
+
+## Installing Pug
+Install Pug globally via npm:
+```bash
+npm install -g pug-cli
+```
+
+## Configuring Pug and Jade
+Access Pug and Jade configurations:
+```ruby
+Jade.config.compile_debug = false
+Pug.config.compile_debug  = false
+```
+
+Refer to official website for configuration options meaning: 
+<br>
+[pugjs.org](https://pugjs.org)
+<br>
+[jade-lang.com (sorry, webarchive only)](http://web.archive.org/web/*/jade-lang.com)
+
+## Running Tests
+1. Install both Pug and Jade 
+2. Install gem dependencies: `bundle install`
+3. Finally run tests: `bundle exec rake test`

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run test suite'
+task default: :test

data/lib/jade-ruby/compile.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+require 'open3'
+require 'json'
+require 'shellwords'
+
+module Jade
+  class << self
+    def compile(source, options = {})
+      check_executable!
+
+      source  = source.read if source.respond_to?(:read)
+      options = config.to_hash.merge(options)
+
+      # http://web.archive.org/web/*/http://jade-lang.com/command-line/
+      cmd = ['jade']
+
+      options[:compileDebug]  = options[:compile_debug]
+      options[:nameAfterFile] = options[:name_after_file]
+
+      options.respond_to?(:compact) ? options.compact : options.delete_if { |k, v| v.nil? }
+
+      # Command line arguments take precedence over json options
+      # https://github.com/jadejs/jade/blob/master/bin/jade.js
+      cmd.push('--obj',             JSON.generate(options))
+
+      cmd.push('--out',             escape(options[:out]))             if options[:out]
+      cmd.push('--path',            escape(options[:filename]))        if options[:filename]
+      cmd.push('--basedir',         escape(options[:basedir]))         if options[:basedir]
+      cmd.push('--pretty')                                             if options[:pretty]
+      cmd.push('--client')                                             if options[:client]
+      cmd.push('--name',            escape(options[:name]))            if options[:name]
+      cmd.push('--no-debug')                                           unless options[:compile_debug]
+      cmd.push('--extension',       escape(options[:extension]))       if options[:extension]
+      cmd.push('--hierarchy',       escape(options[:hierarchy]))       if options[:hierarchy]
+      cmd.push('--name-after-file', escape(options[:name_after_file])) if options[:name_after_file]
+      cmd.push('--doctype',         escape(options[:doctype]))         if options[:doctype]
+
+      stdout, stderr, exit_status = Open3.capture3(*cmd, stdin_data: source)
+      raise CompileError.new(stderr) unless exit_status.success?
+
+      if options[:client]
+        %{ (function(jade) { #{stdout}; return #{options[:name]}; }).call(this, jade); }
+      else
+        stdout
+      end
+    end
+
+    def check_executable!
+      unless @executable_checked
+        `jade --version`
+        unless $?.success?
+          raise ExecutableError, 'No jade executable found in your system. Did you forget to "npm install -g jade"?'
+        end
+        @executable_checked = true
+      end
+    end
+
+  protected
+    def escape(string)
+      Shellwords.escape(string)
+    end
+  end
+
+  class CompileError < StandardError
+  end
+
+  class ExecutableError < StandardError
+  end
+end

data/lib/jade-ruby/config.rb

@@ -0,0 +1,49 @@
+# 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
+
+    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) }
+    end
+  end
+
+  class << self; attr_accessor :config; end
+  self.config = Config.new
+end

data/lib/pug-ruby.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+require 'jade-ruby/config'
+require 'jade-ruby/compile'
+require 'pug-ruby/config'
+require 'pug-ruby/compile'

data/lib/pug-ruby/compile.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+require 'open3'
+require 'json'
+require 'shellwords'
+
+module Pug
+  class << self
+    def compile(source, options = {})
+      check_executable!
+
+      source  = source.read if source.respond_to?(:read)
+      options = config.to_hash.merge(options)
+
+      # https://github.com/pugjs/pug-cli
+      cmd = ['pug']
+
+      options[:compileDebug]           = options[:compile_debug]
+      options[:nameAfterFile]          = options[:name_after_file]
+      options[:inlineRuntimeFunctions] = options[:inline_runtime_functions]
+
+      options.respond_to?(:compact) ? options.compact : options.delete_if { |k, v| v.nil? }
+
+      # Command line arguments take precedence over json options
+      # https://github.com/pugjs/pug-cli/blob/master/index.js
+      cmd.push('--obj',             JSON.generate(options))
+
+      cmd.push('--out',             escape(options[:out]))             if options[:out]
+      cmd.push('--path',            escape(options[:filename]))        if options[:filename]
+      cmd.push('--basedir',         escape(options[:basedir]))         if options[:basedir]
+      cmd.push('--pretty')                                             if options[:pretty]
+      cmd.push('--client')                                             if options[:client]
+      cmd.push('--name',            escape(options[:name]))            if options[:name]
+      cmd.push('--no-debug')                                           unless options[:compile_debug]
+      cmd.push('--extension',       escape(options[:extension]))       if options[:extension]
+      cmd.push('--silent')                                             if options[:silent]
+      cmd.push('--name-after-file', escape(options[:name_after_file])) if options[:name_after_file]
+      cmd.push('--doctype',         escape(options[:doctype]))         if options[:doctype]
+
+      stdout, stderr, exit_status = Open3.capture3(*cmd, stdin_data: source)
+
+      raise CompileError.new(stderr) unless exit_status.success?
+
+      if options[:client]
+        if options[:inline_runtime_functions]
+          %{ (function() { #{stdout}; return #{options[:name]}; }).call(this); }
+        else
+          %{ (function(pug) { #{stdout}; return #{options[:name]}; }).call(this, pug); }
+        end
+      else
+        stdout
+      end
+    end
+
+    def check_executable!
+      unless @executable_checked
+        `pug --version`
+        unless $?.success?
+          raise ExecutableError, 'No pug executable found in your system. Did you forget to "npm install -g pug-cli"?'
+        end
+        @executable_checked = true
+      end
+    end
+
+  protected
+    def escape(string)
+      Shellwords.escape(string)
+    end
+  end
+
+  class CompileError < StandardError
+  end
+
+  class ExecutableError < StandardError
+  end
+end
+

data/lib/pug-ruby/config.rb

@@ -0,0 +1,50 @@
+# 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
+
+    def initialize
+      @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) }
+    end
+  end
+
+  singleton_class.class_exec { attr_accessor :config }
+  self.config = Config.new
+end
+

data/pug-ruby.gemspec

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+Gem::Specification.new do |s|
+  s.name            = 'pug-ruby'
+  s.version         = '1.0.1'
+  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.executables     = `git ls-files -z -- bin/*`.split("\x0").map{ |f| File.basename(f) }
+  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.add_development_dependency 'bundler', '~> 1.7'
+  s.add_development_dependency 'rake',    '~> 10.0'
+end

data/test/jade/extends/index.jade

@@ -0,0 +1,8 @@
+//- index.jade
+extends ./layout.jade
+
+block title
+  title Article title
+
+block content
+  h1 Article content

data/test/jade/extends/layout.jade

@@ -0,0 +1,9 @@
+//- layout.jade
+doctype html
+html
+  head
+    block title
+      title This is default title
+  body
+    block content
+      h1 This is default content

data/test/jade/includes/includes/footer.jade

@@ -0,0 +1,3 @@
+//- includes/footer.jade
+footer.footer#footer
+  p Copyright (c) me

data/test/jade/includes/includes/header.jade

@@ -0,0 +1,4 @@
+//- includes/header.jade
+header.header#header
+  navigation.menu
+    a(href='/') Home

data/test/jade/includes/index.jade

@@ -0,0 +1,10 @@
+//- index.jade
+doctype html
+html
+  head
+    title My site
+  body
+    include ./includes/header.jade
+    h1 Welcome!
+    p Welcome to my site.
+    include ./includes/footer.jade

data/test/jade/index.jade

@@ -0,0 +1,16 @@
+doctype html
+html(lang='en')
+  head
+    title=pageTitle
+    script(type='text/javascript').
+      if (foo) bar(1 + 5);
+  body
+    h1 Jade - node template engine
+    #container.col
+      if youAreUsingJade
+        p You are amazing
+      else
+        p Get on it!
+      p.
+        Jade is a terse and simple templating language with a
+        strong focus on performance and powerful features.

data/test/pug/extends/index.pug

@@ -0,0 +1,8 @@
+//- index.pug
+extends ./layout.pug
+
+block title
+  title Article title
+
+block content
+  h1 Article content

data/test/pug/extends/layout.pug

@@ -0,0 +1,9 @@
+//- layout.pug
+doctype html
+html
+  head
+    block title
+      title This is default title
+  body
+    block content
+      h1 This is default content

data/test/pug/includes/includes/footer.pug

@@ -0,0 +1,3 @@
+//- includes/footer.pug
+footer.footer#footer
+  p Copyright (c) me

data/test/pug/includes/includes/header.pug

@@ -0,0 +1,4 @@
+//- includes/header.pug
+header.header#header
+  navigation.menu
+    a(href='/') Home

data/test/pug/includes/index.pug

@@ -0,0 +1,10 @@
+//- index.pug
+doctype html
+html
+  head
+    title My site
+  body
+    include ./includes/header.pug
+    h1 Welcome!
+    p Welcome to my site.
+    include ./includes/footer.pug

data/test/pug/index.pug

@@ -0,0 +1,16 @@
+doctype html
+html(lang='en')
+  head
+    title=pageTitle
+    script(type='text/javascript').
+      if (foo) bar(1 + 5);
+  body
+    h1 Jade - node template engine
+    #container.col
+      if youAreUsingJade
+        p You are amazing
+      else
+        p Get on it!
+      p.
+        Jade is a terse and simple templating language with a
+        strong focus on performance and powerful features.

data/test/test-jade.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+require 'pug-ruby'
+require 'test/unit'
+
+class JadeTest < Test::Unit::TestCase
+
+  def test_compile
+    file     = expand_path('index.jade')
+    template = File.read(file)
+    result   = Jade.compile(template, client: true)
+    assert_match_template_function(result)
+    assert_no_match_doctype(result)
+  end
+
+  def test_compile_with_io
+    io = StringIO.new("div\n  | Hello, world!")
+    assert_equal(Jade.compile("div\n  | Hello, world!"), Jade.compile(io))
+  end
+
+  def test_compilation_error
+    assert_raise(Jade::CompileError) { Jade.compile("else\n  div") }
+  end
+
+  def test_includes
+    file     = expand_path('includes/index.jade')
+    template = File.read(file)
+    result   = Jade.compile(template, filename: file, client: false)
+    assert_match_doctype(result)
+  end
+
+  def test_extends
+    file     = expand_path('extends/layout.jade')
+    template = File.read(file)
+    result   = Jade.compile(template, filename: file, client: false)
+    assert_match_doctype(result)
+  end
+
+  def test_includes_client
+    file     = expand_path('includes/index.jade')
+    template = File.read(file)
+    result   = Jade.compile(template, filename: file, client: true)
+    assert_match_template_function(result)
+    assert_no_match_doctype(result)
+  end
+
+  def test_extends_client
+    file     = expand_path('extends/layout.jade')
+    template = File.read(file)
+    result   = Jade.compile(template, filename: file, client: true)
+    assert_match_template_function(result)
+    assert_no_match_doctype(result)
+  end
+
+protected
+  def expand_path(relative_path)
+    File.expand_path(File.join('..', 'jade', relative_path), __FILE__)
+  end
+
+  def assert_match_doctype(string)
+    assert_match(/^\s*<!DOCTYPE html>/, string)
+  end
+
+  def assert_no_match_doctype(string)
+    assert_no_match(/^\s*<!DOCTYPE html>/, string)
+  end
+
+  def assert_match_template_function(string)
+    assert_match(/function\s+#{Jade.config.name}\s*\(locals\)\s*\{.*\}/m, string)
+  end
+end

data/test/test-pug.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+require 'pug-ruby'
+require 'test/unit'
+
+class PugTest < Test::Unit::TestCase
+
+  def test_compile
+    file     = expand_path('index.pug')
+    template = File.read(file)
+    result   = Pug.compile(template, client: true)
+    assert_match_template_function(result)
+    assert_no_match_doctype(result)
+  end
+
+  def test_compile_with_io
+    io = StringIO.new("div\n  | Hello, world!")
+    assert_equal(Pug.compile("div\n  | Hello, world!"), Pug.compile(io))
+  end
+
+  def test_compilation_error
+    assert_raise(Pug::CompileError) { Pug.compile("else\n  div") }
+  end
+
+  def test_includes
+    file     = expand_path('includes/index.pug')
+    template = File.read(file)
+    result   = Pug.compile(template, filename: file, client: false)
+    assert_match_doctype(result)
+  end
+
+  def test_extends
+    file     = expand_path('extends/layout.pug')
+    template = File.read(file)
+    result   = Pug.compile(template, filename: file, client: false)
+    assert_match_doctype(result)
+  end
+
+  def test_includes_client
+    file     = expand_path('includes/index.pug')
+    template = File.read(file)
+    result   = Pug.compile(template, filename: file, client: true)
+    assert_match_template_function(result)
+    assert_no_match_doctype(result)
+  end
+
+  def test_extends_client
+    file     = expand_path('extends/layout.pug')
+    template = File.read(file)
+    result   = Pug.compile(template, filename: file, client: true)
+    assert_match_template_function(result)
+    assert_no_match_doctype(result)
+  end
+
+protected
+  def expand_path(relative_path)
+    File.expand_path(File.join('..', 'pug', relative_path), __FILE__)
+  end
+
+  def assert_match_doctype(string)
+    assert_match(/^\s*<!DOCTYPE html>/, string)
+  end
+
+  def assert_no_match_doctype(string)
+    assert_no_match(/^\s*<!DOCTYPE html>/, string)
+  end
+
+  def assert_match_template_function(string)
+    assert_match(/function\s+#{Pug.config.name}\s*\(locals\)\s*\{.*\}/m, string)
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: pug-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Yaroslav Konoplov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Ruby wrapper for the Pug/Jade template engine.
+email: eahome00@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/jade-ruby/compile.rb
+- lib/jade-ruby/config.rb
+- lib/pug-ruby.rb
+- lib/pug-ruby/compile.rb
+- lib/pug-ruby/config.rb
+- pug-ruby.gemspec
+- test/jade/extends/index.jade
+- test/jade/extends/layout.jade
+- test/jade/includes/includes/footer.jade
+- test/jade/includes/includes/header.jade
+- test/jade/includes/index.jade
+- test/jade/index.jade
+- test/pug/extends/index.pug
+- test/pug/extends/layout.pug
+- test/pug/includes/includes/footer.pug
+- test/pug/includes/includes/header.pug
+- test/pug/includes/index.pug
+- test/pug/index.pug
+- test/test-jade.rb
+- test/test-pug.rb
+homepage: https://github.com/yivo/pug-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Pug/Jade template engine.
+test_files:
+- test/jade/extends/index.jade
+- test/jade/extends/layout.jade
+- test/jade/includes/includes/footer.jade
+- test/jade/includes/includes/header.jade
+- test/jade/includes/index.jade
+- test/jade/index.jade
+- test/pug/extends/index.pug
+- test/pug/extends/layout.pug
+- test/pug/includes/includes/footer.pug
+- test/pug/includes/includes/header.pug
+- test/pug/includes/index.pug
+- test/pug/index.pug
+- test/test-jade.rb
+- test/test-pug.rb