tilt-handlebars 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 60c16fb0db1e4616de9bd0f9e8482fa47dfa242c
-  data.tar.gz: 9c0186d04fc88e47178490a96ca7c0b39dcf0b31
+SHA256:
+  metadata.gz: 9a795c64abee7a47bdbf5cbccad24c92f2ffa9216973ae47db4162bd7a302e02
+  data.tar.gz: d59a4be0a82ab8f58b344181e601ec4aa69a5637826ebc1e5a3c2b96c078abc3
 SHA512:
-  metadata.gz: d3fc7a744cbb23b085ddb98a9bf221b581b706421516a3a2530676299d3bc6336c4b1c1f89f3aee43c189224412ed3c7858699d04ea945bd47bc15ac4ae0a24d
-  data.tar.gz: c75e9eaf9ec8837a16fbca97a9653119c39f27a3ab64cf33f8c335dd2970a4040b521e4a8d68d4a5fbfb8c1a229a7f514a28d95d6eb09da133635667da0c21a7
+  metadata.gz: 5d37f79d703991c9794ce7e052803948229a31aa58d2be8f3cb57053a6d05d9cc96c320bb8ddb4c774e2eba31522b90fbf6f3a84dce7ef424e38998051b2d304
+  data.tar.gz: 220353821875387c0e1cd5f30df25adf8054861fd7967fd31eff7b0095e4af60f5fb0b1939812e52448511cd81ef93547f499df6870e76a3a7a6ef3c2933db42

data/.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig: https://editorconfig.org/
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+tab_width = 2
+trim_trailing_whitespace = true

data/.github/workflows/ci.yml

@@ -0,0 +1,76 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - develop
+      - main
+  pull_request:
+    branches:
+      - develop
+      - main
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Install
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby-3
+          bundler-cache: true
+      - name: Test
+        run: bin/test
+      - name: Upload
+        uses: paambaati/codeclimate-action@v3.0.0
+        env:
+          CC_TEST_REPORTER_ID: fa0a43df2e210318c8da0958f9f100ab1b278c04f57f923affad8bd9fba23901
+        with:
+          coverageLocations: ${{ github.workspace }}/spec/reports/coverage/coverage.xml:cobertura
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Install
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby-3
+          bundler-cache: true
+      - name: Lint
+        run: bin/lint
+
+  test:
+    strategy:
+      matrix:
+        appraisal:
+          - tilt_1
+          - tilt_2
+        os:
+          - macos-latest
+          - ubuntu-latest
+        ruby:
+          - ruby-2.6
+          - ruby-2.7
+          - ruby-3.0
+          - ruby-3.1
+          # - jruby
+          # - truffleruby
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.appraisal }}.gemfile
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Install
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Test
+        run: bin/test
+        env:
+          COVERAGE: false

data/.github/workflows/publish.yml

@@ -0,0 +1,58 @@
+name: Publish
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  packages: write
+
+jobs:
+  github:
+    name: GitHub
+    needs: tag
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Install
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby-3
+          bundler-cache: true
+      - name: Publish to GitHub
+        env:
+          GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+          RUBYGEMS_HOST: https://rubygems.pkg.github.com/${{github.repository_owner}}
+        run: bin/release
+  rubygems:
+    name: RubyGems
+    needs: tag
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Install
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby-3
+          bundler-cache: true
+      - name: Publish to RubyGems
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_TOKEN}}"
+        run: bin/release
+  tag:
+    name: Git Tag
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Install
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby-3
+          bundler-cache: true
+      - name: Tag
+        run: bin/tag

data/.gitignore

@@ -1,17 +1,16 @@
+/[._]*/
+!/.github/
+/doc/
+/pkg/
+/spec/reports/
+/test/reports/
+/tmp/
+/vendor/
+*.a
+*.bundle
 *.gem
+*.lock
+*.o
 *.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+*.so
+mkmf.log

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,189 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.6
+  Exclude:
+    - bin/**/*
+    - vendor/**/*
+  NewCops: enable
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/BlockAlignment:
+  EnforcedStyleAlignWith: start_of_block
+
+Layout/CaseIndentation:
+  # Disabled because IndentOneStep can't be configured for one-liner cases.
+  # See: https://github.com/rubocop-hq/rubocop/issues/6447
+  Enabled: false
+
+Layout/ClassStructure:
+  Enabled: true
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Layout/ExtraSpacing:
+  AllowForAlignment: false
+  AllowBeforeTrailingComments: false
+  ForceEqualSignAlignment: false
+
+Layout/FirstArgumentIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstArrayElementLineBreak:
+  Enabled: true
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementLineBreak:
+  Enabled: true
+
+Layout/FirstMethodArgumentLineBreak:
+  Enabled: false
+
+Layout/FirstMethodParameterLineBreak:
+  Enabled: true
+
+Layout/HeredocArgumentClosingParenthesis:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 80
+
+Layout/MultilineArrayLineBreaks:
+  Enabled: true
+
+Layout/MultilineHashKeyLineBreaks:
+  Enabled: true
+
+Layout/MultilineMethodArgumentLineBreaks:
+  Enabled: true
+
+# Layout/MultilineMethodCallBraceLayout:
+#   EnforcedStyle: new_line
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineMethodDefinitionBraceLayout:
+  EnforcedStyle: new_line
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Lint/DuplicateBranch:
+  Enabled: true
+
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+
+Lint/EmptyBlock:
+  Enabled: true
+  AllowComments: true
+
+Lint/EmptyClass:
+  Enabled: true
+  AllowComments: true
+
+Lint/HeredocMethodCallPosition:
+  Enabled: true
+
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+
+Metrics/BlockLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+  Exclude:
+    - "*.gemspec"
+    - spec/**/*_spec.rb
+    - test/**/*_test.rb
+
+Metrics/ClassLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+  Max: 120
+
+Metrics/MethodLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+  Max: 20
+
+Metrics/ModuleLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+
+Metrics/ParameterLists:
+  Max: 10
+
+Naming/FileName:
+  Exclude:
+    - lib/tilt-handlebars.rb
+
+RSpec/ExampleLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 20
+
+RSpec/NestedGroups:
+  Max: 8
+
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+  AllowBracesOnProceduralOneLiners: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - "**/*.gemfile"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  ConsistentQuotesInMultiline: true
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/WordArray:
+  EnforcedStyle: brackets

data/Appraisals

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+appraise "tilt-1" do
+  gem "tilt", "~> 1"
+end
+
+appraise "tilt-2" do
+  gem "tilt", "~> 2"
+end

data/CONTRIBUTING.md

@@ -0,0 +1,75 @@
+# Contributing
+
+Bug reports and pull requests are welcome on GitHub:
+https://github.com/gi/tilt-handlebars.
+
+1. Fork the repository: https://github.com/gi/tilt-handlebars.
+1. Create an issue branch: `git checkout -b issue-N/summary origin/develop`)
+1. Run [setup](#Setup): `bin/setup`.
+1. Add tests for your updates.
+1. Run [tests](#Test): `bin/test`.
+1. Run linter: `bin/lint`.
+1. Commit changes: `git commit -am '[#N] Summary'`.
+1. Push changes: `git push origin head`.
+1. Create a pull request targeting `develop`.
+
+## Branches
+
+This repository follows a modified version of the
+[Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow):
+* The default development branch is `develop`.
+* The main release branch is `main`.
+
+## Development
+
+### Setup
+
+Run `bin/setup` to install dependencies.
+
+### Console
+
+Run `bin/console` for an interactive prompt that will allow you to experiment.
+
+### Test
+
+Run `bin/test` to run the tests.
+
+### Install
+
+Run `bin/rake install` to install this gem onto your local machine.
+
+## Releases
+
+Releases are created automatically by continuous deployment.
+
+***Please avoid creating releases manually.***
+
+To create a new release:
+1. Checkout a new branch from `develop`:
+    ```sh
+    git fetch origin develop
+    git checkout -b release-x.y.z origin/develop
+    ```
+1. Update the version number:
+    ```sh
+    bin/version x.y.z
+    bin/setup
+    ```
+1. Update the changelog:
+    - add mising entries
+    - move `[Unreleased]` to `[x.y.z] - YYYY-MM-DD`
+1. Commit the changes:
+    ```sh
+    git commit -m 'vx.y.z'
+    ```
+1. Push the new branch:
+    ```sh
+    git push -u origin head
+    ```
+1. Create a merge/pull request to `main`.
+
+When the `main` branch is updated, continuous deployment will tag and push a new
+release.
+
+Afterwards:
+1. Create a merge/pull request from `main` to `develop`.

data/Gemfile

@@ -1,4 +1,6 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in tilt-handlebars.gemspec
 gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Jim Cushing
+Copyright (c) 2021 Zach Gianos
+
+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,25 +1,33 @@
 # Tilt::Handlebars
-<a href="http://badge.fury.io/rb/tilt-handlebars"><img src="https://badge.fury.io/rb/tilt-handlebars@2x.png" alt="Gem Version" height="18"></a>
-[![Build Status](https://travis-ci.org/jimothyGator/tilt-handlebars.png?branch=develop)](https://travis-ci.org/jimothyGator/tilt-handlebars)
-[![Coverage Status](https://coveralls.io/repos/jimothyGator/tilt-handlebars/badge.png?branch=develop)](https://coveralls.io/r/jimothyGator/tilt-handlebars?branch=develop)
-[![Code Climate](https://codeclimate.com/github/jimothyGator/tilt-handlebars.png)](https://codeclimate.com/github/jimothyGator/tilt-handlebars)
 
-[![Codeship Status](https://www.codeship.io/projects/71da7c90-ee55-0130-eff4-7205960840ac/status)](https://www.codeship.io/projects/6182)
+[![Gem Version](https://badge.fury.io/rb/tilt-handlebars.svg)](https://rubygems.org/gems/tilt-handlebars)
+[![Build Status](https://github.com/gi/tilt-handlebars/actions/workflows/ruby-ci.yml/badge.svg)](https://github.com/gi/tilt-handlebars/actions/workflows/ruby-ci.yml)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/19d544fcb843a50db1a2/test_coverage)](https://codeclimate.com/github/gi/tilt-handlebars/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/19d544fcb843a50db1a2/maintainability)](https://codeclimate.com/github/gi/tilt-handlebars/maintainability)
+[![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE.txt)
 
-Adds support for [Handlebars.rb](https://github.com/cowboyd/handlebars.rb) template 
-engine to [Tilt](https://github.com/rtomayko/tilt).
+A [Tilt](https://github.com/rtomayko/tilt) interface for the official JavaScript
+implementation of the [Handlebars.js](https://handlebarsjs.com) template engine.
 
-See the [Handlebars.js](http://handlebarsjs.com) site for syntax.
+[Handlebars::Engine](https://github.com/gi/handlebars-ruby) provides the API
+wrapper. [MiniRacer](https://github.com/rubyjs/mini_racer) provides the
+JavaScript execution environment.
+
+See [Handlebars.js](http://handlebarsjs.com) for template syntax.
+
+See [Handlebars::Engine](https://github.com/gi/handlebars-ruby) for API syntax.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'tilt-handlebars'
+```ruby
+gem 'tilt-handlebars'
+```
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -27,7 +35,7 @@ Or install it yourself as:
 
 ## Usage
 
-Create a Handlebars template file with either a `.hbs` or `.handlebars` extension. 
+Create a Handlebars template file with either a `.hbs` or `.handlebars` extension.
 
 Example, in `hello.hbs`:
 
@@ -50,7 +58,7 @@ Output:
 
 ### Partials
 
-Partials are a file that can be loaded into another. For example, you may define a web page with 
+Partials are a file that can be loaded into another. For example, you may define a web page with
 a master layout (`layout.hbs`), which includes a header (`header.hbs`) and footer (`footer.hbs`).
 In this case, `header.hbs` and `footer.hbs` would be partials; `layout.hbs` includes these partials.
 
@@ -69,7 +77,7 @@ In this case, `header.hbs` and `footer.hbs` would be partials; `layout.hbs` incl
 </html>
 ```
 
-Notice that you do not include the `.hbs` file extension in the partial name. Tilt Handlebars 
+Notice that you do not include the `.hbs` file extension in the partial name. Tilt Handlebars
 will look for the partial relative to the enclosing file (`layout.hbs` in this example) with
 either a `.hbs` or `.handlebars` extension.
 
@@ -94,11 +102,18 @@ This will use the template file named `views/hello.hbs`.
 Partials can also be used with Sinatra. As described previously, partials will be loaded
 relative to the enclosing template (e.g., in the `views` directory).
 
+## Changelog
+
+See [RELEASE_NOTES.md](RELEASE_NOTES.md) for more details.
+
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Add tests, preferrably using Minitest::Spec for consistency.
-4. Commit your changes (`git commit -am 'Add some feature'`)
-5. Push to the branch (`git push origin my-new-feature`)
-6. Create new Pull Request
+Bug reports and pull requests are welcome on GitHub:
+https://github.com/gi/tilt-handlebars.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/RELEASE_NOTES.md

@@ -1,18 +1,60 @@
+Tilt Handlebars Release Notes
+=============================
+
+Version 2.0
+-----------
+* Updated engine to [Handlebars::Engine](https://github.com/gi/handlebars-ruby).
+* Updated build/deploy to GitHub Actions:
+  - test against macos-latest and ubuntu-latest
+  - test against tilt 1.x and 2.x
+  - test against ruby 2.6, 2.7, 3.0, and 3.1
+  - test coverage
+  - lint
+* Updated specs/tests to [RSpec](https://rspec.info/).
+* Updated readme/documentation.
+
+Version 1.4
+-----------
+* Updated to Tilt 2.0. It should still work with Tilt 1.3.
+* Updated to [Handlebars.rb](https://github.com/cowboyd/handlebars.rb) 0.7.0 and [Handlebars.js](https://github.com/wycats/handlebars.js/) 3.0.
+* Issue #3: Fix "Template engine not found error"
+
+Version 1.3.1
+-------------
+
+* Issue #1: Fix uninitialized constant Tilt::HandlebarsTemplate::Pathname. Thank you, [defeated](https://github.com/defeated) for the patch.
+
+
+Version 1.3.0
+-------------
+2014 January 24
+
+* Uses Handlebars.js 1.3.0, and handlebars.rb 0.6.0.
+
+Note: Tilt Handlebars currently uses Tilt 1.4.x, because Sinatra is not yet
+compatible with Tilt 2.0. Once Sinatra is updated for Tilt 2.0, I'll release a
+new version of tilt-handlebars. Alternatively, I could break out Sinatra support
+into a separate gem. If you use Tilt and Tilt Handlebars without Sinatra, and
+Tilt 2.0 support is important to you, please file an issue to let me know.
+
+
 Version 1.2.0
 -------------
 2013 September 30
 
-This version is recommend for all users, as it brings support for the release version of Handlebars.
+This version is recommend for all users, as it brings support for the release
+version of Handlebars.
 
-* Updates to handlebars.rb 0.5.0, which brings with it the 1.0.0 release 
-  version version of the JavaScript Handlebars, and an updated Ruby Racer (Ruby-JavaScript bridge).
-  Thanks to [Yehuda Katz](https://github.com/wycats) and [Charles Lowell](https://github.com/cowboyd)
-  for their continued work on Handlebars and Handlebars.rb, respectively.
+* Updates to handlebars.rb 0.5.0, which brings with it the 1.0.0 release
+  version version of the JavaScript Handlebars, and an updated Ruby Racer
+  (Ruby-JavaScript bridge). Thanks to [Yehuda Katz](https://github.com/wycats)
+  and [Charles Lowell](https://github.com/cowboyd) for their continued work on
+  Handlebars and Handlebars.rb, respectively.
 
-* Backwards compatibility note: If you are using automatic partials loading 
-  with an absolute path, you must now quote the path. For example:
+* Backwards compatibility note: If you are using automatic partials loading with
+ an absolute path, you must now quote the path. For example:
 
-		{{> "/the/path/to/partial.html.hbs" }}
+		{{> "/the/path/to/partial" }}
 
 	This is due to changes in the Handlebars parser.
 

data/Rakefile

@@ -1,11 +1,7 @@
-require "bundler/gem_tasks"
-require 'rake/testtask'
+# frozen_string_literal: true
 
-desc 'Run tests (default)'
-Rake::TestTask.new(:test) do |t|
-  t.test_files = FileList['test/*_test.rb']
-  t.ruby_opts = ['-Itest']
-  t.ruby_opts << '-rubygems' if defined? Gem
+Dir.glob("tasks/**/*.rake") do |file|
+  import(file)
 end
 
-task :default => :test
+task default: [:clobber, :test]