jade-rails 1.11.0.0 → 1.11.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea5675355be3294f2c41a542b0903f7dce8a2892
-  data.tar.gz: 06585d018f271cbeb6b721c29053232699898ff5
+  metadata.gz: 5daf720219cde3a9acc61c884bdb8c36c945b7d1
+  data.tar.gz: 0a846c24ab2f425032e18dd23715db7f168400c6
 SHA512:
-  metadata.gz: 33a213e6b54f6b6e70f914c4e40c0849cc05e937ad6e980e5b52ec27b213666d147de6212e942da5a62b316933cdf9ee77653ecb76a82f9c9f3297c4f9b61e56
-  data.tar.gz: 26a32286e9e082a316de221e17d918fc1134cc3ca013983ca86f6f0a8f9346591c096dc7691dca8d1d3692a074c50173a0e90f72cb695e06ef332a8a1119d5ed
+  metadata.gz: fbff9f116362d01341ed86b535417cee43a2490ae59cb0b2bc186df48c8d91e5353cc7c721366418e21ec5f60b8bb1425a61759527b133a2fd483154196a8419
+  data.tar.gz: b13772c010acbae87dc7ef609be6ad3e1a15734739b55b01064809d78d2e3f875dcf8ee2d72f40e7980fd8cd4febf80c96749c96fbefeefd0b1a317ac70d3d7b

data/README.md

@@ -11,7 +11,7 @@ to render Jade templates anywhere on the front end of your Rails app.
 Add to your Gemfile:
 
 ```ruby
-gem 'jade-rails', '~> 1.11.0.0'
+gem 'jade-rails', '~> 1.11.0.1'
 ```
 
 In your `application.js`, require the Jade runtime before any files that include

data/integration-tests/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# This line will be overwritten by the integration-testing script as needed.
+# gem 'rails', 'X.Y.Z'

data/integration-tests/fixtures/amazing_template.jst.jade

@@ -0,0 +1,4 @@
+h1 Jade: A Template Engine
+p.lead.
+  Jade is a terse and simple templating language with a strong focus on
+  performance and powerful features.

data/integration-tests/fixtures/index.html.erb

@@ -0,0 +1,7 @@
+<div id="test-container">
+</div>
+
+<%= javascript_tag do -%>
+  var testElement = document.getElementById("test-container");
+  testElement.innerHTML = JST['amazing_template']();
+<% end -%>

data/integration-tests/fixtures/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  root 'test#index'
+end

data/integration-tests/fixtures/test_controller.rb

@@ -0,0 +1,4 @@
+class TestController < ApplicationController
+  def index
+  end
+end

data/integration-tests/run-tests.sh

@@ -0,0 +1,153 @@
+#!/bin/bash
+#
+# This script runs "integration tests" for the jade-rails gem.
+# For each Rails version we'd like to confirm compatibility with, the script will:
+#   1. Instantiate a new Rails app.
+#   2. Add the jade-rails gem to the app.
+#   3. Set up a basic controller and view.
+#   4. Add a simple Jade template, and set up the view to render it.
+#   5. Assert that the Jade template is correctly compiled. Specifically:
+#       5.1. In development, assert that the Jade template correctly compiles to a JS file.
+#       5.2. In production, assert that:
+#             - the application.js file compiles
+#             - the application.js file contains the Jade template JS
+#
+# ASSUMPTIONS:
+#   - This script is running on OS X. (The sed syntax is specific to OS X.)
+#   - The bundler gem is globally available.
+#   - rbenv is being used to manage Ruby versions.
+#---------------------------------------------------------------------------------------------------
+set -e
+set -o pipefail
+
+# This is a utility function to fail-fast if an assertion fails.
+# It takes 1 argument which is the text of the error itself.
+raise () {
+  echo
+  echo "ERROR"
+  echo $1
+  echo
+  exit 1
+}
+
+# To simplify all the other references to files and paths, force this script to only run from inside
+# the integration-tests directory itself.
+current_directory=$(pwd)
+if [[ $current_directory != *"integration-tests" ]]; then
+  raise "This script must be run from inside the integration-tests directory."
+fi
+
+# Test against the currently-supported Rails versions.
+# See: http://guides.rubyonrails.org/maintenance_policy.html
+rails_versions=(4.1.15 4.2.6)
+# rails_versions=(4.1.15)
+dev_server_port=30000
+for rails_version in ${rails_versions[@]}; do
+  echo
+  echo "Beginning integration test for Rails v${rails_version}..."
+  echo
+
+  # Set up the version of Rails we're testing against.
+  sed -i '' "5 s/.*/gem 'rails', '${rails_version}'/" ./Gemfile
+  bundle install
+  rbenv rehash
+  installed_rails_version=$(bundle exec rails -v)
+  if [[ $installed_rails_version != "Rails ${rails_version}" ]]; then
+    raise "Failed to correctly install Rails version ${rails_version}."
+  fi
+
+  # Instantiate a new Rails app using that version.
+  app_name="test-${rails_version}"
+  bundle exec rails new ${app_name}
+
+  # Inside this Rails app, set up the jade-rails gem.
+  # (1) Add it to the Gemfile.
+  sed -i '' "$ a\\
+    gem 'jade-rails', :path => '../../'
+    " ./${app_name}/Gemfile
+  # (2) Run `bundle install` for the Rails app.
+  cd ${app_name}
+  bundle install
+  # (3) Add the jade-runtime to the application.js.
+  sed -i '' "/require_tree/ i\\
+    //= require jade/runtime
+    " ./app/assets/javascripts/application.js
+
+  # Now set up a simple Jade template, along with the controller, view, and route to render it.
+  # These files look exactly the same regardless of Rails version or app name.
+  cp ../fixtures/amazing_template.jst.jade ./app/assets/javascripts/
+  cp ../fixtures/test_controller.rb ./app/controllers/
+  mkdir ./app/views/test
+  cp ../fixtures/index.html.erb ./app/views/test/
+  cp ../fixtures/routes.rb ./config/routes.rb
+
+  # Now that we have a barebones Rails app set up with the gem and a Jade
+  # template, we test to ensure the template compiles and renders properly, in
+  # both dev and production. We also want to test the ability to set the
+  # config.jade flags in the app code. So, specifically, the test plan is:
+  #
+  # 1. Test production assets.
+  #     - Compile assets for production.
+  #     - Confirm that the compiled application.js contains a Jade template ready to use.
+  #     - Confirm that the compiled application.js does not have Jade code
+  #       compiled with compileDebug (because this should be disabled by the
+  #       default configuration for this gem). See lib/jade/rails/engine.rb.
+  # 2. Test development assets.
+  #     - Start a Rails dev server and request the application.js compiled on the fly for dev.
+  #     - Confirm that the application.js served in development has the Jade template ready to use.
+  #     - Confirm that the template was compiled with compileDebug turned on.
+  # 3. Test app-level configuration.
+  #     - Set config.jade.compile_debug to true in config/environments/production.rb.
+  #     - Recompile assets for production.
+  #     - Confirm that the compiled application.js has debugging code inside the Jade template.
+  #
+  # (Note that, by default, our test code also requires all commands to execute
+  # successfully, because of the settings at the top of this script.)
+
+  # These are the strings we'll check for to indicate whether or not
+  # compileDebug was used when compiling the Jade template.
+  compile_debug_off_string="this.JST.amazing_template=function(){var e=[];return e.push('<h1>Jade: A Template Engine</h1>"
+  compile_debug_on_string="unshift(new jade.DebugItem("
+
+  # 1. Test production assets.
+  RAILS_ENV=production bundle exec rake assets:precompile
+  production_compiled_js=$(cat public/assets/application-*.js)
+  if [[ $production_compiled_js != *"$compile_debug_off_string"* ]]; then
+    raise "Precompiled application.js did not have expected production-ready Jade template code."
+  fi
+  if [[ $production_compiled_js == *"$compile_debug_on_string"* ]]; then
+    raise "Precompiled application.js contained debugging code inside Jade template."
+  fi
+
+  # 2. Test development assets.
+  # Start up a server, request the compiled asset for the Jade template, and check its contents.
+  # bundle exec rails s -p ${dev_server_port} > /dev/null 2>&1 &
+  bundle exec rails s -p ${dev_server_port} &
+  sleep 5 # Give the dev server time to boot.
+  dev_compiled_js=$(curl localhost:${dev_server_port}/assets/application.js)
+  if [[ $dev_compiled_js != *"$compile_debug_on_string"* ]]; then
+    raise "Development application.js did not contain debugging code inside Jade template."
+  fi
+  # Clean up the backgrounded dev server.
+  kill %%
+
+  # 3. Test app-level configuration.
+  sed -i '' "/Rails.application.configure do/ a\\
+    config.jade.compile_debug = true
+    " ./config/environments/production.rb
+  rm -r tmp/
+  rm -r public/assets
+  RAILS_ENV=production bundle exec rake assets:precompile
+  production_compiled_js=$(cat public/assets/application-*.js)
+  if [[ $production_compiled_js != *"$compile_debug_on_string"* ]]; then
+    raise "Precompiled application.js with compileDebug true did not contain debugging code inside Jade template."
+  fi
+
+  # Clean out the instantiated Rails app.
+  cd ..
+  rm -r ${app_name}
+
+  echo
+  echo "Successfully completed integration test for Rails v${rails_version}."
+  echo
+done

data/jade-rails.gemspec

@@ -1,10 +1,10 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'jade/version'
+require 'jade/rails/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'jade-rails'
-  spec.version       = Jade::VERSION
+  spec.version       = Jade::Rails::VERSION
   spec.author        = 'Paul Raythattha'
   spec.email         = 'paul@appfactories.com'
   spec.summary       = %q{Jade adapter for the Rails asset pipeline.}

data/lib/jade-rails.rb

@@ -1,25 +1,2 @@
 # Jade Template Compiler for Ruby
-
-require 'json'
-require 'execjs'
-
-module Jade
-  class << self
-
-    def compile(source, options = {})
-      @@context ||= begin
-        jade_js = File.read(File.expand_path('../../vendor/assets/javascripts/jade/jade.js', __FILE__))
-        ExecJS.compile <<-JS
-          var window = {};
-          #{jade_js}
-          var jade = window.jade;
-        JS
-      end
-      source = source.read if source.respond_to?(:read)
-      @@context.eval("jade.compileClient(#{source.to_json}, #{options.to_json})")
-    end
-
-  end
-end
-
-require 'jade/railtie' if defined?(Rails)
+require 'jade/rails'

data/lib/jade/rails.rb

@@ -0,0 +1,10 @@
+module Jade
+  module Rails
+  end
+end
+
+require 'jade/rails/version'
+require 'jade/rails/engine'
+require 'jade/rails/compiler'
+require 'jade/rails/processor'
+require 'jade/rails/template'

data/lib/jade/rails/compiler.rb

@@ -0,0 +1,26 @@
+module Jade
+  module Rails
+    class Compiler
+      def self.compile(source, options = {})
+        @@context ||= begin
+          jade_js = File.read(File.expand_path('../../../../vendor/assets/javascripts/jade/jade.js', __FILE__))
+          ExecJS.compile <<-JS
+            var window = {};
+            #{jade_js}
+            var jade = window.jade;
+          JS
+        end
+
+        # Get the compilation options from the application's config.jade.
+        # See lib/jade/rails/engine.rb for details.
+        options = ::Rails.application.config.jade.merge(options)
+        # For one of the options keys, we need to manually camel-case before
+        # passing to the Jade compiler.
+        options[:compileDebug] = options.delete(:compile_debug) { false }
+
+        source = source.read if source.respond_to?(:read)
+        compiled = @@context.eval("jade.compileClient(#{source.to_json}, #{options.to_json})")
+      end
+    end
+  end
+end

data/lib/jade/rails/engine.rb

@@ -0,0 +1,35 @@
+module Jade
+  module Rails
+    class Engine < ::Rails::Engine
+
+      config.jade = ActiveSupport::OrderedOptions.new
+
+      # Set default values. See README for details.
+      config.jade.pretty        = ::Rails.env.development?
+      config.jade.self          = false
+      config.jade.compile_debug = ::Rails.env.development?
+      config.jade.globals       = []
+
+      initializer 'jade.assets.register', :group => :all do |app|
+        config.assets.configure do |env|
+          env.register_mime_type   'text/x-jade-template', :extensions => ['.jade', '.jst.jade']
+          if env.respond_to?(:register_transformer)
+            # Sprockets 3 introduces the idea of "transformers," which is
+            # exactly what we want here.  Note that this transformer class
+            # should also be compatible with Sprockets 4. For details, see:
+            # https://github.com/rails/sprockets/blob/master/guides/extending_sprockets.md
+            env.register_transformer 'text/x-jade-template', 'application/javascript', Jade::Rails::Processor
+          else
+            # If it's not possible to register a transformer, we must be in
+            # Sprockets 2.  In this case, we'll continue with the old way of
+            # using a Tilt template.  Later, when we decide to drop support for
+            # Sprockets 2, it should be a simple matter of just deleting this
+            # clause and the lib/jade/rails/template.rb file.
+            app.assets.register_engine '.jade', ::Jade::Rails::Template
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/jade/rails/processor.rb

@@ -0,0 +1,27 @@
+module Jade
+  module Rails
+    class Processor
+
+      def initialize(filename, &block)
+        @filename = filename
+        @source   = block.call
+      end
+
+      def render(variable, empty_hash)
+        self.class.run(@filename, @source)
+      end
+
+      def self.call(input)
+        # Compile the Jade template into a JS template function.
+        source   = input[:data]
+        filename = input[:filename]
+        compiled = Compiler.compile(source, { :filename => filename })
+
+        # Then use the JST processor to add the template to the window.JST object.
+        input[:data] = compiled
+        return ::Sprockets::JstProcessor.call(input)
+      end
+
+    end
+  end
+end

data/lib/jade/rails/template.rb

@@ -0,0 +1,36 @@
+require 'tilt'
+
+module Jade
+  module Rails
+    class Template < Tilt::Template
+      def self.engine_initialized?
+        true
+      end
+
+      def initialize_engine
+      end
+
+      def prepare
+      end
+
+      # Compile template data using Jade compiler.
+      #
+      # This returns a String containing a JS function, which is intended
+      # to be used with the Sprockets JST engine. Name your file so that
+      # it is processed by both of these engines, and then the template
+      # will be available on the JST global on the front end.
+      #
+      # For example, `my_template.jst.jade` will be available on the front
+      # end as JST['my_template'], which is a function that takes a single
+      # argument containing the locals to use in rendering the template:
+      #
+      #   # => function template(locals) { ... }
+      #
+      def evaluate(context, locals, &block)
+        options = { }
+        options[:filename] = eval_file
+        Compiler.compile(data, options)
+      end
+    end
+  end
+end

data/lib/jade/rails/version.rb

@@ -0,0 +1,5 @@
+module Jade
+  module Rails
+    VERSION = '1.11.0.1'
+  end
+end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: jade-rails
 version: !ruby/object:Gem::Version
-  version: 1.11.0.0
+  version: 1.11.0.1
 platform: ruby
 authors:
 - Paul Raythattha
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-13 00:00:00.000000000 Z
+date: 2016-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !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: Jade adapter for the Rails asset pipeline.
@@ -72,16 +72,25 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- integration-tests/Gemfile
+- integration-tests/fixtures/amazing_template.jst.jade
+- integration-tests/fixtures/index.html.erb
+- integration-tests/fixtures/routes.rb
+- integration-tests/fixtures/test_controller.rb
+- integration-tests/run-tests.sh
 - jade-rails.gemspec
 - lib/jade-rails.rb
-- lib/jade/railtie.rb
-- lib/jade/template.rb
-- lib/jade/version.rb
+- lib/jade/rails.rb
+- lib/jade/rails/compiler.rb
+- lib/jade/rails/engine.rb
+- lib/jade/rails/processor.rb
+- lib/jade/rails/template.rb
+- lib/jade/rails/version.rb
 - test/test_jade-rails.rb
 - vendor/assets/javascripts/jade/LICENSE
 - vendor/assets/javascripts/jade/jade.js
@@ -97,17 +106,17 @@ 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.0.14
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Jade adapter for the Rails asset pipeline.

data/lib/jade/railtie.rb

@@ -1,25 +0,0 @@
-require 'jade/template'
-
-module Jade
-  class Railtie < Rails::Engine
-    module JadeContext
-      attr_accessor :jade_config
-    end
-
-    config.jade = ActiveSupport::OrderedOptions.new
-
-    config.jade.pretty        = Rails.env.development?
-    config.jade.self          = false
-    config.jade.compile_debug = Rails.env.development?
-    config.jade.globals       = []
-
-    initializer :setup_jade, after: 'sprockets.environment', group: :all do |app|
-      if app.assets
-        app.assets.register_engine '.jade', ::Jade::Template
-
-        app.assets.context_class.extend(JadeContext)
-        app.assets.context_class.jade_config = app.config.jade
-      end
-    end
-  end
-end

data/lib/jade/template.rb

@@ -1,49 +0,0 @@
-require 'tilt'
-
-module Jade
-  class Template < Tilt::Template
-
-    def self.engine_initialized?
-      defined? ::Jade
-    end
-
-    def initialize_engine
-      require_template_library 'jade'
-    end
-
-    def prepare
-    end
-
-    # Compile template data using Jade compiler.
-    #
-    # This returns a String containing a JS function, which is intended
-    # to be used with the Sprockets JST engine. Name your file so that
-    # it is processed by both of these engines, and then the template
-    # will be available on the JST global on the front end.
-    #
-    # For example, `my_template.jst.jade` will be available on the front
-    # end as JST['my_template'], which is a function that takes a single
-    # argument containing the locals to use in rendering the template:
-    #
-    #   # => function template(locals) { ... }
-    #
-    def evaluate(context, locals, &block)
-      options = { }
-      options[:filename] = eval_file
-
-      # For Rails 4.0.x and 4.1.x, the app-level config is on context.environment.
-      # For Rails 4.2.x, it's on context.assets instead.
-      app_level_config = context.environment.context_class.jade_config
-      if app_level_config.nil?
-        app_level_config = context.assets.context_class.jade_config
-      end
-      jade_config = app_level_config.merge(options)
-
-      # Manually camelize the one option key that needs to be camelized.
-      jade_config[:compileDebug] = jade_config.delete(:compile_debug) { false }
-
-      Jade.compile(data, jade_config)
-    end
-
-  end
-end

data/lib/jade/version.rb

@@ -1,3 +0,0 @@
-module Jade
-  VERSION = '1.11.0.0'
-end