pug-ruby 1.0.2 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51f257cb6fe31e9b1a23d17a012ae428530c963f
-  data.tar.gz: ce10856aff1c95432672b4947edb8e420ec89730
+  metadata.gz: 9aa23c41b83a1717528e1aa9dc496b6d0fd83c16
+  data.tar.gz: '0234974dc3e87481d6ef79e812af08c9250e1ab9'
 SHA512:
-  metadata.gz: 9b9105920f6fc3dd35e6db1f1b68c5195ae92ee9dd06004242e73c93187d65531f3800e1142512ae1495d1c629cfff0e3a83e61794543e55a6a6fda64ac015b8
-  data.tar.gz: bf5784df0a404c4dcb636894d11684dabab4fb0e8850c7ceefef6bbc7acab2f073c2ebc2b224e56c2e203d3350ad3d7e72f062497580e96700994d64e5e8e9f0
+  metadata.gz: 40553d0204e7d973609ccaa4bf37c8bd947f0bbb25a449b9097dca7f6411777cbb581171bc7a02b0e3fef0214652991118dcaffe60df1e865e9fa05e4f7b23b1
+  data.tar.gz: b995486264f39ed7ad5ed275db5ac9204f97e09586b00677b93fe62123e1003ce68b1cb4864ca91200aada12f9ad19bf7400acb8a235e85951bdf1aeb2eaf3ec

data/.gitignore

@@ -1,7 +1,9 @@
 *.gem
-*.lock
 .bundle
 .ruby-version
 pkg/
 tmp/
 /.idea/
+/node_modules/
+/.yardoc/
+/doc/

data/.rubocop.yml

@@ -0,0 +1,81 @@
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Metrics/LineLength:
+  Enabled: false
+  Max: 110
+
+Style/FileName:
+  Regex: !ruby/regexp /\A[-a-z0-9]+\z/
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+  IndentOneStep: true
+
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Layout/SpaceInsideArrayPercentLiteral:
+  Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/EmptyMethod:
+  Enabled: false
+
+Lint/UselessAssignment:
+  Enabled: false
+
+Lint/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20
+
+Layout/ExtraSpacing:
+  Enabled:                 false
+  AllowForAlignment:       true
+  ForceEqualSignAlignment: true
+
+Style/PercentLiteralDelimiters:
+ PreferredDelimiters:
+   default: '[]'
+   '%i':    '[]'
+   '%':     '{}'
+
+Layout/AlignParameters:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/CaseEquality:
+  Enabled: false

data/.travis.yml

@@ -1,17 +1,26 @@
 language: ruby
 
 rvm:
-  - 2.0.0
-  - 2.1.10
-  - 2.2.5
-  - 2.3.1
-  - 2.4.0
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
 
 cache: bundler
 
 env:
-  - RAILS_ENV=test RAKE_ENV=test
+  - RAKE_ENV=test BUNDLE_PATH=vendor/bundle
 
 before_install:
-  - npm install --global jade
-  - npm install --global pug-cli
+  - . $HOME/.nvm/nvm.sh
+  - nvm install stable
+  - nvm use stable
+  - npm install --global jade pug
+  - gem install bundler
+
+install:
+  - bundle install
+
+script:
+  - bundle exec rake test

data/.yardopts

@@ -0,0 +1,4 @@
+--protected
+--private
+-
+lib/**/*.rb

data/Gemfile

@@ -1,6 +1,6 @@
-# encoding: utf-8
+# encoding: UTF-8
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
+
 gemspec
-gem 'test-unit'

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    pug-ruby (2.0.0)
+      execjs (~> 2.0)
+      memoist (~> 0.15)
+      method-not-implemented (~> 1.0, >= 1.0.1)
+      regexp-match-polyfill (~> 1.0, >= 1.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    execjs (2.7.0)
+    memoist (0.16.0)
+    method-not-implemented (1.0.1)
+    power_assert (1.0.2)
+    rake (10.5.0)
+    regexp-match-polyfill (1.0.2)
+    test-unit (3.2.5)
+      power_assert
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  pug-ruby!
+  rake (~> 10.0)
+  test-unit (~> 3.1)
+
+BUNDLED WITH
+   1.15.3

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Yaroslav Konoplov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,53 +1,285 @@
-## Ruby wrapper for the Pug/Jade template engine
+## Ruby wrapper for the Jade and Pug
 
 [![Gem Version](https://badge.fury.io/rb/pug-ruby.svg)](https://badge.fury.io/rb/pug-ruby)
 [![Build Status](https://travis-ci.org/yivo/pug-ruby.svg?branch=master)](https://travis-ci.org/yivo/pug-ruby)
 
+<img width="49.710808069%" alt="jade" align="left" src="https://user-images.githubusercontent.com/7421323/29007509-4fb4e004-7b0d-11e7-9b21-6bdd98a24344.png">
+
+<img width="48.035162854%" alt="pug" src="https://user-images.githubusercontent.com/7421323/29007510-4fcdb638-7b0d-11e7-80c7-e3c49434ca8a.png">
+
 ## 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>
+
+This gem allows to invoke Jade / Pug from the Ruby code.
+
+**You can compile both Jade and Pug:**
+
+* supports Jade [1.x.x](https://github.com/pugjs/pug/tree/v1.x.x).
+* supports Pug [2.x.x](https://github.com/pugjs/pug/tree/master).
+ 
+**You can choose what compiler to use:**
+
+* *system compiler* – compiler that is installed globally via NPM.
+* *shipped compiler* – compiler that is shipped with the gem as Web version.
+ 
+Available versions of shipped compilers are listed below.
+ 
+**You can lock the Jade / Pug version:**
+
+```ruby
+NEEDED_JADE_VERSION = "1.9.2"
+
+unless Jade.compiler.version == NEEDED_JADE_VERSION
+  raise "Jade #{NEEDED_JADE_VERSION} needed. You have #{Jade.compiler.version}."
+end
+```
+
+**You can configure globally or per compilation:**
+
+```ruby
+Jade.config.pretty = true
+Jade.compile "div Hello, Jade!", pretty: false
+```
+
+**You can render template or compile it to the JavaScript function:**
+
 ```ruby
-Jade.compile(source, options)
-Pug.compile(source, options)
+Jade.compile "div=greeting", locals: { greeting: "Hello, Jade!" } # => "<div>Hello, Jade!</div>"
+Jade.compile "div=greeting", client: true                         # => "(function(jade) { function template(locals) {var buf = [];var jade_mixins = {};var jade_interp;;var locals_for_with = (locals || {});(function (greeting) {buf.push("<div>" + (jade.escape(null == (jade_interp = greeting) ? "" : jade_interp)) + "</div>");}.call(this,"greeting" in locals_for_with?locals_for_with.greeting:typeof greeting!=="undefined"?greeting:undefined));;return buf.join("");}; return template; }).call(this, jade);"
+```
+ 
+**Advanced language features like `include`, `extends` and `block` are supported (only system compilers):**
+```jade
+//- File: /var/www/app/views/header.jade
+ul
+  li: a(href='/') Home
+```
+
+```jade
+//- File: /var/www/app/views/layout.jade
+doctype html
+html
+  head
+      title Application
+  body
+    header
+      include ./header.jade
+```
+
+```ruby
+Jade.use :system
+
+Jade.compile File.read("/var/www/app/views/layout.jade"), filename: "/var/www/app/views/layout.jade"
+  # => "<!DOCTYPE html><html><head><title>Application</title></head><body><header><ul><li><a href="/">Home</a></li></ul></header></body></html>"
 ```
 
 ## Installing gem
-Run `gem install pug-ruby -v '~> 1.0'`. Add `require 'pug-ruby'` to your code.
 
+**RubyGems users**
+
+1. Run `gem install pug-ruby --version "~> 2.0.0"`. 
+2. Add `require "pug-ruby"` to your code.
+
+**Bundler users**
 
-**If you are using bundler.**
-<br>
-Add to your Gemfile:
+1. Add to your Gemfile:
 ```ruby
-gem 'pug-ruby', '~> 1.0'
+gem "pug-ruby", "~> 2.0.0"
 ```
+2. Run `bundle install`.
 
 ## Installing Jade
+
 Install Jade globally via npm:
 ```bash
 npm install --global jade
 ```
+You may require `sudo` depending on your system.
 
 ## Installing Pug
+
 Install Pug globally via npm:
 ```bash
-npm install --global pug-cli
+npm install --global pug
 ```
+You may require `sudo` depending on your system.
+
+## Switching Jade / Pug version
+
+The gem is shipped with different prebuilt versions of Jade and Pug.
+That prebuilt versions are Web version, e.g. they are limited to browser JavaScript.
+Advanced Jade / Pug features like `includes`, `extends`, `block`, and other require filesystem access.
+You will not be able to use that features while dealing with shipped Jade / Pug.
+Use system Jade / Pug in such cases.
+
+**Switching the version permanently:**
+
+```ruby
+Pug.use "2.0.0"      # You have just switched to shipped Pug 2.0.0.
+Pug.compiler.version # Returns "2.0.0".
+
+Pug.use :system      # You have just switched to system Pug.
+Pug.compiler.version # Returns the version of your system-wide installed Pug.
+```
+
+**Switching the version temporarily:**
+
+```ruby
+Jade.use "1.11.0" # You have just switched to shipped Jade 1.11.0.
+
+Jade.use "1.9.2" do
+  # You have just switched to shipped Jade 1.9.2.
+  Jade.compiler.version # Returns "1.9.2".
+
+  # Do you stuff.
+end
+
+# You have been switched back to the 1.11.0.
+Jade.compiler.version # Returns "1.11.0".
+```
+
+**Switching to the system Jade / Pug:**
+
+```ruby
+# Pass :system to switch to the system Jade / Pug.
+Jade.use :system
+Pug.use  :system
+```
+
+**Shipped versions of Jade:**
+
+* 1.0.0
+* 1.0.1
+* 1.0.2
+* 1.1.0
+* 1.1.1
+* 1.1.2
+* 1.1.3
+* 1.1.4
+* 1.1.5
+* 1.2.0
+* 1.3.0
+* 1.3.1
+* 1.4.0
+* 1.4.1
+* 1.4.2
+* 1.5.0
+* 1.6.0
+* 1.7.0
+* 1.8.0
+* 1.8.1
+* 1.8.2
+* 1.9.0
+* 1.9.1
+* 1.9.2
+* 1.10.0
+* 1.11.0
+
+**Shipped versions of Jade runtime:**
+
+* 1.0.0
+* 1.0.1
+* 1.0.2
+* 1.1.0
+* 1.1.1
+* 1.1.2
+* 1.1.3
+* 1.1.4
+* 1.1.5
+* 1.2.0
+* 1.3.0
+* 1.3.1
+* 1.4.0
+* 1.4.1
+* 1.4.2
+* 1.5.0
+* 1.6.0
+* 1.7.0
+* 1.8.0
+* 1.8.1
+* 1.8.2
+* 1.9.0
+* 1.9.1
+* 1.9.2
+* 1.10.0
+* 1.11.0
+
+**Shipped versions of Pug:**
+
+* 2.0.0-beta1
+* 2.0.0-beta2
+* 2.0.0-beta3
+* 2.0.0-beta4
+* 2.0.0-beta5
+* 2.0.0-beta6
+* 2.0.0-beta7
+* 2.0.0-beta8
+* 2.0.0-beta9
+* 2.0.0-beta10
+* 2.0.0-beta11
+* 2.0.0-beta.12 (the dot is not an error)
+* 2.0.0-rc.1
+* 2.0.0-rc.2
+* 2.0.0-rc.3
+
+**Shipped versions of Pug runtime:**
+
+* 2.0.0
+* 2.0.1
+* 2.0.2
+
+## Configuring Jade / Pug
+
+**Accessing configuration:**
+
+```ruby
+Jade.config
+```
+
+**Getting configuration options:**
+
+```ruby
+Jade.config.pretty  # => false
+Jade.config.pretty? # => false
+```
+
+**Setting configuration options:**
+
+```ruby
+Jade.config.pretty = true
+```
+
+**Setting custom configuration options:**
+
+```ruby
+Jade.config.custom_option = "value"
+```
+
+**Serializing configuration:**
+
+```ruby
+Jade.config.to_h
+  # => { filename: nil, doctype: nil, pretty: false, self: false, compile_debug: false, globals: [], name: "template" }
+```
+
+**The documentation for configuration options can be found here:**
+
+* [Official Jade website (Web Archive only)](http://web.archive.org/web/*/jade-lang.com/api)
+* [Jade CLI utility reference](https://github.com/pugjs/pug/blob/v1.x.x/bin/jade.js)
+* [Official Pug website](https://pugjs.org/api/reference.html)
+* [Pug CLI utility reference](https://github.com/pugjs/pug-cli/blob/master/index.js)
+
+**Pass an options to `Jade#compile` or `Pug#compile` as second argument to override global config:**
 
-## Configuring Pug and Jade
-Access Pug and Jade configurations:
 ```ruby
-Jade.config.compile_debug = false
-Pug.config.compile_debug  = false
+Jade.compile "h1 Title\ndiv Content"
+  # => "<h1>Title</h1><div>Content</div>"
+  
+Jade.compile "h1 Title\ndiv Content", pretty: true
+  # => "<h1>Title</h1>\n<div>Content</div>"  
 ```
 
-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
 
-## Running Tests
-1. Install both Pug and Jade 
-2. Install gem dependencies: `bundle install`
-3. Finally run tests: `bundle exec rake test`
+1. Install both Jade and Pug: `npm install --global jade pug`.
+2. Install gem dependencies: `bundle install`.
+3. Finally, run tests: `bundle exec rake test`.