tilt-handlebars 1.2.0 → 2.0.0

data/bin/audit

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+root = File.absolute_path("..", __dir__)
+audit = File.absolute_path("bundler-audit", __dir__)
+
+Dir.chdir(root)
+exec([audit, "audit"], "--update", *ARGV)

data/bin/build

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+root = File.absolute_path("..", __dir__)
+rake = File.absolute_path("rake", __dir__)
+
+Dir.chdir(root)
+exec([rake, "rake"], "build", *ARGV)

data/bin/bundle

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_requirement
+    @bundler_requirement ||=
+      env_var_version || cli_arg_version ||
+        bundler_requirement_for(lockfile_version)
+  end
+
+  def bundler_requirement_for(version)
+    return "#{Gem::Requirement.default}.a" unless version
+
+    bundler_gem_version = Gem::Version.new(version)
+
+    requirement = bundler_gem_version.approximate_recommendation
+
+    return requirement unless Gem::Version.new(Gem::VERSION) < Gem::Version.new("2.7.0")
+
+    requirement += ".a" if bundler_gem_version.prerelease?
+
+    requirement
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/bin/bundler-audit

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler-audit' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("bundler-audit", "bundler-audit")

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "handlebars/engine"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/doc

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+root = File.absolute_path("..", __dir__)
+rake = File.absolute_path("rake", __dir__)
+
+Dir.chdir(root)
+exec([rake, "rake"], "doc", *ARGV)

data/bin/lint

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+root = File.absolute_path("..", __dir__)
+rubocop = File.absolute_path("rubocop", __dir__)
+
+Dir.chdir(root)
+exec([rubocop, "rubocop"], *ARGV)

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/release

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+dir="$(cd "$(dirname "${BASH_SOURCE[0]}" )" && pwd)"
+
+branch=$(git rev-parse --abbrev-ref HEAD)
+
+if [[ "${branch}" != "main" ]]; then
+  echo "Releases are restricted to the main branch."
+  exit 1
+fi
+
+diff=$(git diff HEAD --quiet; echo $?)
+
+if [[ "${diff}" != "0" ]]; then
+  echo "Releases are restricted to clean branches."
+  exit 1
+fi
+
+if [[ -n "${CI}" ]]; then
+  git config --global user.email "gi+handlebars-ruby@users.noreply.github.com"
+  git config --global user.name "handlebars-ruby"
+  git fetch --tags
+fi
+
+"${dir}/rake" release

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/bin/setup

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+if [[ -n "${CI:-}" ]]; then
+  gem install bundler
+  bundle config set --local deployment 'true'
+fi
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/tag

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+dir="$(cd "$(dirname "${BASH_SOURCE[0]}" )" && pwd)"
+
+branch=$(git rev-parse --abbrev-ref HEAD)
+
+if [[ "${branch}" != "main" ]]; then
+  echo "Releases are restricted to the main branch."
+  exit 1
+fi
+
+diff=$(git diff HEAD --quiet; echo $?)
+
+if [[ "${diff}" != "0" ]]; then
+  echo "Releases are restricted to clean branches."
+  exit 1
+fi
+
+if [[ -n "${CI}" ]]; then
+  git config --global user.email "gi+handlebars-ruby@users.noreply.github.com"
+  git config --global user.name "handlebars-ruby"
+  git fetch --tags
+fi
+
+"${dir}/rake" release:source_control_push

data/bin/test

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+root = File.absolute_path("..", __dir__)
+rake = File.absolute_path("rake", __dir__)
+
+Dir.chdir(root)
+exec([rake, "rake"], "test", *ARGV)

data/bin/version

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+dir="$(cd "$(dirname "${BASH_SOURCE[0]}" )" && pwd)"
+root="$(cd "${dir}/.." && pwd)"
+
+file="${root}/lib/tilt/handlebars/version.rb"
+
+current() {
+  ruby -r "${file}" -e 'puts Tilt::Handlebars::VERSION'
+}
+
+update() {
+  # sed -E -i '' "s/VERSION = \".*\"/VERSION = \"${version}\"/" "${file}"
+  ruby -i -p -e "gsub(/VERSION = \".*\"/, 'VERSION = \"${version}\"')" "${file}"
+}
+
+version=$1
+
+if [[ "${version}" == "" ]]; then
+  current
+else
+  update
+  current
+fi

data/gemfiles/tilt_1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "tilt", "~> 1"
+
+gemspec path: "../"

data/gemfiles/tilt_2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "tilt", "~> 2"
+
+gemspec path: "../"

data/lib/sinatra/handlebars.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
+require "tilt/handlebars"
+
 module Sinatra
-	module Handlebars
-		def handlebars(*args)
-			render(:handlebars, *args)
-		end
-	end
+  module Handlebars
+    def handlebars(*args)
+      render(:handlebars, *args)
+    end
+  end
 
-	helpers Handlebars
+  helpers Handlebars
 end

data/lib/tilt/handlebars/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Tilt
   module Handlebars
-    VERSION = "1.2.0"
+    VERSION = "2.0.0"
   end
 end

data/lib/tilt/handlebars.rb

@@ -1,85 +1,96 @@
-require 'tilt' unless defined? Tilt
-require 'handlebars'
+# frozen_string_literal: true
+
+require "handlebars/engine"
+require "pathname"
+require "tilt"
 
 module Tilt
+  module Handlebars
+    class Error < RuntimeError; end
+  end
 
-  # Handlebars.rb template implementation. See:
-  # https://github.com/cowboyd/handlebars.rb
-  # and http://handlebarsjs.com
-  #
-  # Handlebars is a logic-less template rendered with JavaScript.
-  # Handlebars.rb is a Ruby wrapper around Handlebars, that allows
-  # Handlebars templates to be rendered server side.
+  # A Tilt interface for the official JavaScript implementation of the
+  # Handlebars.js template engine.
   #
+  # @see https://github.com/rtomayko/tilt
+  # @see https://handlebarsjs.com
   class HandlebarsTemplate < Template
-    def initialize_engine
-      return if defined? ::Handlebars
-      require_template_library 'handlebars'
-    end    
+    EXTENSIONS = ["handlebars", "hbs"].freeze
+
+    # Loads the template engine, if necessary.
+    #
+    # This method is needed in Tilt 1 but was removed in Tilt 2. It is provided
+    # here for backwards compatibility.
+    # @see https://github.com/rtomayko/tilt/blob/tilt-1/lib/tilt/template.rb#L58
+    def initialize_engine; end
 
     def prepare
-      @context = ::Handlebars::Context.new
-      @context.partial_missing { |partial_name| load_partial partial_name }
-      @template = @context.compile(data)
+      @engine = ::Handlebars::Engine.new(**options.slice(:lazy, :path))
+      @engine.register_partial_missing { |name| load_partial(name) }
+      @template = @engine.compile(data)
     end
 
-
-    def evaluate(scope, locals = {}, &block)
+    # rubocop:disable Metrics/AbcSize
+    def evaluate(scope, locals, &block)
       # Based on LiquidTemplate
-      locals = locals.inject({}){ |h,(k,v)| h[k.to_s] = v ; h }
+      locals = locals.transform_keys(&:to_s)
       if scope.respond_to?(:to_h)
-        scope  = scope.to_h.inject({}){ |h,(k,v)| h[k.to_s] = v ; h }
+        scope = scope.to_h.transform_keys(&:to_s)
         locals = scope.merge(locals)
       else
         scope.instance_variables.each do |var|
           key = var.to_s.delete("@")
-          locals[key] = scope.instance_variable_get(var) unless locals.has_key? key
+          locals[key] = scope.instance_variable_get(var) unless locals.key? key
         end
       end
 
-      locals['yield'] = block.nil? ? '' : yield
-      locals['content'] = locals['yield']
-
-      @template.call(locals);
-    end
-
-    def register_helper(name, &fn)
-      @context.register_helper(name, &fn)
-    end
+      locals["yield"] = block.nil? ? "" : yield
+      locals["content"] = locals["yield"]
 
-    def register_partial(*args)
-      @context.register_partial(*args)
+      @template.call(locals)
     end
+    # rubocop:enable Metrics/AbcSize
 
-    def partial_missing(&fn)
-      @context.partial_missing(&fn)
+    def partial_missing(*args, **opts, &block)
+      @engine.register_partial_missing(*args, **opts, &block)
     end
 
     def allows_script?
       false
     end
 
+    private
+
     def load_partial(partial_name)
-      if Pathname.new(partial_name).absolute? 
+      if Pathname.new(partial_name).absolute?
         dir = ""
       elsif file
         dir = File.dirname file
       end
 
-      partial_file = File.expand_path("#{partial_name}.hbs", dir)
-      partial_file = File.expand_path("#{partial_name}.handlebars", dir) unless File.file? partial_file
-      if File.file? partial_file
-        return IO.read(partial_file)
-      end
+      paths = EXTENSIONS.map { |ext|
+        File.expand_path("#{partial_name}.#{ext}", dir)
+      }
+      path = paths.find { |p|
+        File.file?(p)
+      }
+
+      return File.read(path) if path
+
+      message =
+        "The partial '#{partial_name}' could not be found. No such files "\
+        "#{paths.join(", ")}"
+      raise Handlebars::Error, message
+    end
 
-      raise "The partial '#{partial_name}' could not be found. No such file #{partial_file}"
+    def method_missing(name, *args, &block)
+      @engine.send(name, *args, &block)
     end
 
-    private :load_partial
-    
+    def respond_to_missing?(name, *)
+      @engine.respond_to?(name) || super
+    end
   end
 
-  register HandlebarsTemplate, 'handlebars', 'hbs'
+  register HandlebarsTemplate, *HandlebarsTemplate::EXTENSIONS
 end
-
-

data/lib/tilt-handlebars.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "tilt/handlebars"

data/spec/fixtures/helpers.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Fixtures
+  module Helpers
+    def fixture_dir
+      __dir__
+    end
+
+    def fixture_data(path)
+      File.read(fixture_path(path))
+    end
+
+    def fixture_file(path)
+      File.open(fixture_path(path))
+    end
+
+    def fixture_path(path)
+      File.expand_path(path, __dir__)
+    end
+  end
+end

data/spec/fixtures/views/hello.hbs

@@ -0,0 +1 @@
+Hello, {{name}}.

data/spec/fixtures/views/hello_missing.hbs

@@ -0,0 +1 @@
+Hello, {{> missing}}.

data/spec/fixtures/views/hello_partial.hbs

@@ -0,0 +1 @@
+Hello, {{> partial}}.

data/spec/fixtures/views/hello_partial2.hbs

@@ -0,0 +1 @@
+Hello, {{> partial2}}.

data/spec/fixtures/views/partial.hbs

@@ -0,0 +1 @@
+{{name}} (a '{{type}}')

data/spec/fixtures/views/partial2.handlebars

@@ -0,0 +1 @@
+{{name}} (a '{{type}}')

data/spec/sinatra/handlebars_spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "rack/test"
+require "sinatra/base"
+require "sinatra/handlebars"
+
+RSpec.describe Sinatra::Handlebars do
+  let(:app) {
+    Sinatra.new(Sinatra::Base) do
+      extend Fixtures::Helpers
+
+      set :environment, :test
+      set :root, fixture_dir
+      helpers Sinatra::Handlebars # rubocop:disable RSpec/DescribedClass
+
+      get "/:name" do
+        template = params["name"].to_sym
+        handlebars template, locals: { name: "World", type: "planet" }
+      end
+    end
+  }
+  let(:client) {
+    Rack::Test::Session.new(Rack::MockSession.new(app))
+  }
+
+  describe "#handlebars" do
+    context "with a simple template" do
+      let(:rendered) { "Hello, World." }
+      let(:response) { client.get("/hello") }
+      let(:response_data) { response.body.strip }
+
+      it "renders correctly" do
+        expect(response_data).to eq(rendered)
+      end
+    end
+
+    context "with a partial template" do
+      let(:rendered) { "Hello, World (a 'planet')\n." }
+      let(:response) { client.get("/hello_partial") }
+      let(:response_data) { response.body.strip }
+
+      it "renders correctly" do
+        expect(response_data).to eq(rendered)
+      end
+    end
+  end
+end