flavour_saver 0.3.7 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c3efa30121a2e226ebb1274cf5597d35ab7f9c47
-  data.tar.gz: c89bc7f065e3dfbb07882c44465711981643d454
+SHA256:
+  metadata.gz: 003f6b787316f313dc1a044deb52b4fcc9a87ef0b00819784ab364dca840d567
+  data.tar.gz: 5b9fd6980a44472f106e7e37b046d5abc896198f169896dedb8b58f41416986d
 SHA512:
-  metadata.gz: 1292541b248293451704808a7458b2132ab7109f9664845c77d01c375581396192af2ee2a19c6cfae4fa567294757cb5b563803e23ccfd8110961f204adbdd03
-  data.tar.gz: a74f63a36b4864fbc248fde7ff9e03c19ffc49412f37b472521cf2ed13bf7403e24243e423211c1599c924a92a8e9f9b1472ba15c07b12a12955de70f131da7c
+  metadata.gz: 243f501f9280e5394bcb861bf1689e365a9e43b925ab332fad4e1050c8c2aad9e03a6d76d86fb41e9273d4f935e2775fa7d2d5119b7cd938772daaa4ce6e9271
+  data.tar.gz: 936b3241cd8bad53c819e02bfc6cac334433207ead739628eaeafd619d36544c60f71da9b6a888c218a83afb292b639eb8246b07efed84d4d436868936950c7a

data/.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: Continuous integration
+
+on:
+  push:
+    branches: [ master ]
+    tags: [ 'v*' ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0', '3.1']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rspec
+
+  publish-gem:
+    if: github.ref_type == 'tag'
+    runs-on: ubuntu-latest
+    needs: [test]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.7
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [2.0.0]
+
+### Breaking Changes
+
+* The #if and #unless helpers now treat zero as falsey (#54, #55)
+* The #unless helper now treats empty objects as falsey (#55)
+* Using #each on a hash now yields the value instead of an array of key, value (#52)
+
+### Added
+
+* Support for @root object (#49)
+* Support for @key object inside #each blocks with Hashes (#52)
+
+### Fixed
+
+* Lex number literals that start with 0 (#53)
+
+## [1.0.0] - 2022-01-19
+
+### Added
+
+* Ruby 3.0 and 3.1 support
+
+### Changed
+
+* The gem is now maintained by the FlavourSaver organization
+
+### Removed
+
+* Dropped support for Ruby 1.9, 2.0, 2.1, 2.2, 2.3, and 2.4
+

data/Gemfile.lock

@@ -1,82 +1,54 @@
 PATH
   remote: .
   specs:
-    flavour_saver (0.3.7)
+    flavour_saver (2.0.0)
       rltk (~> 2.2.0)
       tilt
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.0.13)
-      i18n (~> 0.6, >= 0.6.9)
-      minitest (~> 4.2)
-      multi_json (~> 1.3)
-      thread_safe (~> 0.1)
-      tzinfo (~> 0.3.37)
-    coderay (1.0.9)
-    diff-lcs (1.2.4)
-    ffi (1.9.0)
-    formatador (0.2.4)
-    guard (1.8.3)
-      formatador (>= 0.2.4)
-      listen (~> 1.3)
-      lumberjack (>= 1.0.2)
-      pry (>= 0.9.10)
-      thor (>= 0.14.6)
-    guard-bundler (1.0.0)
-      bundler (~> 1.0)
-      guard (~> 1.1)
-    guard-rspec (3.1.0)
-      guard (>= 1.8)
-      rspec (~> 2.13)
-    i18n (0.7.0)
-    listen (1.3.1)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-      rb-kqueue (>= 0.2)
-    lumberjack (1.0.4)
-    method_source (0.8.2)
-    minitest (4.7.5)
-    multi_json (1.10.1)
-    pry (0.9.12.2)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.4)
-    rake (10.1.0)
-    rb-fsevent (0.9.3)
-    rb-inotify (0.9.2)
-      ffi (>= 0.5.0)
-    rb-kqueue (0.2.0)
-      ffi (>= 0.5.0)
+    activesupport (6.1.4.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.5.0)
+    ffi (1.15.5)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    minitest (5.15.0)
+    rake (13.0.6)
     rltk (2.2.1)
       ffi (>= 1.0.0)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.5)
-    rspec-expectations (2.14.3)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.3)
-    slop (3.4.6)
-    thor (0.18.1)
-    thread_safe (0.3.4)
-    tilt (2.0.1)
-    tzinfo (0.3.42)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    tilt (2.0.10)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.5.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (~> 4.0.2)
+  activesupport (< 7.0)
   flavour_saver!
-  guard-bundler
-  guard-rspec
   rake
-  rspec-core
-  rspec-expectations
-  rspec-mocks
+  rspec
 
 BUNDLED WITH
-   1.10.6
+   2.2.17

data/README.md

@@ -2,25 +2,18 @@
 
 [Handlebars.js](http://handlebarsjs.com) without the `.js`
 
-[![Build Status](https://travis-ci.org/jamesotron/FlavourSaver.png)](https://travis-ci.org/jamesotron/FlavourSaver)
-[![Dependency Status](https://gemnasium.com/jamesotron/FlavourSaver.png)](https://gemnasium.com/jamesotron/FlavourSaver)
-[![Code Climate](https://codeclimate.com/github/jamesotron/FlavourSaver.png)](https://codeclimate.com/github/jamesotron/FlavourSaver)
+[![Gem Version](https://badge.fury.io/rb/flavour_saver.svg)](https://badge.fury.io/rb/flavour_saver)
+![Build Status](https://github.com/FlavourSaver/FlavourSaver/actions/workflows/ci.yml/badge.svg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/89a99bec5bbf49359081/maintainability)](https://codeclimate.com/github/FlavourSaver/FlavourSaver/maintainability)
 
 ## WAT?
 
-FlavourSaver is a ruby-based implementation of the [Handlebars.js](http://handlebars.js)
+FlavourSaver is a ruby-based implementation of the [Handlebars.js](http://handlebarsjs.com)
 templating language. FlavourSaver supports Handlebars template rendering natively on
 Rails and on other frameworks (such as Sinatra) via Tilt.
 
 Please use it, break it, and send issues/PR's for improvement.
 
-## Caveat
-
-FlavourSaver is used in production by a lot of folks, none of whom are me.  As
-I don't use FlavourSaver in my daily life I will not be responding to issues
-unless they have a corresponding PR.  If you'd like to take over maintaining
-this project then get in contact.
-
 ## License
 
 FlavourSaver is Copyright (c) 2013 Resistor Limited and licensed under the terms
@@ -74,6 +67,7 @@ Currently supported:
     - Inverse blocks
   - Partials
   - Raw content (`{{{{raw}}}} not parsed or validated {{{{/raw}}}}`)
+  - Subexpressions (`{{sum 1 (sum 1 1)}}` returns `3`)
 
 ## Helpers
 
@@ -248,6 +242,35 @@ Which could be used like so:
 {{/isFemale}}
 ```
 
+### Subexpressions
+
+You can use a subexpression as any value for a helper, and it will be executed before it is ran. You can also nest them, and use them in assignment of variables. 
+
+Below are some examples, utilizing a "sum" helper than adds together two numbers.
+
+```
+{{sum (sum 5 10) (sum 2 (sum 1 4))}}
+#=> 22
+
+{{#if (sum 1 2) > 2}}its more{{/if}}
+#=> its more
+
+{{#student_heights size=(sum boys girls)}}
+```
+
+### Raw Content
+
+Sometimes you don't want a section of content to be evaluted as handlebars, such as when you want to display it in a page that renders with handlebars. FlavourSaver offers a `raw` helper, that will allow you to pass anything through wrapped in those elements, and it will not be evaluated. 
+
+```
+{{{{raw}}}}
+{{if} this tries to parse, it will break on syntax
+{{{{/raw}}}}
+=> {{if} this tries to parse, it will break on syntax
+```
+
+Its important to note that while this looks like a block helper, it is not in practice. This is why you must omit the use of a `#` when writing it. 
+
 ### Using Partials
 
 Handlebars allows you to register a partial either as a function or a string template with

data/flavour_saver.gemspec

@@ -2,11 +2,18 @@
 require File.expand_path('../lib/flavour_saver/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["James Harton"]
-  gem.email         = ["james@resistor.io"]
+  gem.authors       = ["Clayton Passmore", "James Harton"]
+  gem.email         = ["ctpassmore+flavoursaver@gmail.com"]
   gem.description   = %q{FlavourSaver is a pure-ruby implimentation of the Handlebars templating language}
   gem.summary       = %q{Handlebars.js without the .js}
-  gem.homepage      = "http://jamesotron.github.com/FlavourSaver/"
+  gem.homepage      = "http://github.com/FlavourSaver/FlavourSaver"
+  gem.license       = "MIT"
+  gem.metadata      = {
+    "bug_tracker_uri"   => "http://github.com/FlavourSaver/FlavourSaver/issues",
+    "changelog_uri"     => "http://github.com/FlavourSaver/FlavourSaver/blob/master/CHANGELOG.md",
+    "homepage_uri"      => "http://github.com/FlavourSaver/FlavourSaver",
+    "source_code_uri"   => "http://github.com/FlavourSaver/FlavourSaver",
+  }
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -15,13 +22,11 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = FlavourSaver::VERSION
 
+  gem.required_ruby_version = ">= 2.6.0"
+
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'guard-rspec'
-  gem.add_development_dependency 'rspec-core'
-  gem.add_development_dependency 'rspec-mocks'
-  gem.add_development_dependency 'rspec-expectations'
-  gem.add_development_dependency 'guard-bundler'
-  gem.add_development_dependency 'activesupport', '~> 4.0.2'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'activesupport', '< 7.0'
 
   gem.add_dependency 'rltk', '~> 2.2.0'
   gem.add_dependency 'tilt'

data/lib/flavour_saver/helpers.rb

@@ -11,24 +11,31 @@ module FlavourSaver
         r = []
         count = 0
         collection.each do |element|
-          r << yield.contents(element, 'index' => count)
+          locals ={
+            'index' => count,
+            'last' => count == collection.size - 1,
+            'first' => count == 0
+          }
+
+          locals['key'], element = element if collection.is_a?(Hash)
+
+          r << yield.contents(element, locals)
           count += 1
         end
         yield.rendered!
         r.join ''
       end
 
-      def if(truthy)
-        truthy = false if truthy.respond_to?(:size) && (truthy.size == 0)
-        if truthy
+      def if(value)
+        if truthy?(value)
           yield.contents
         else
           yield.inverse
         end
       end
 
-      def unless(falsy,&b)
-        self.if(!falsy,&b)
+      def unless(value, &b)
+        self.if(!truthy?(value), &b)
       end
 
       def this
@@ -39,6 +46,16 @@ module FlavourSaver
         FS.logger.debug("FlavourSaver: #{message}")
         ''
       end
+
+      private
+
+      # Think of this as a compatability layer to make Ruby conditionals
+      # behave like JavaScript conditionals.
+      def truthy?(value)
+        value = false if value.respond_to?(:size) && (value.size == 0)
+        value = false if value.respond_to?(:zero?) && value.zero?
+        value
+      end
     end
 
     class Decorator < Defaults
@@ -59,7 +76,7 @@ module FlavourSaver
 
       def [](accessor)
         if array?
-          if accessor.match /[0-9]+/
+          if accessor.match?(/[0-9]+/)
             return @source.at(accessor.to_i)
           end
         end
@@ -85,7 +102,7 @@ module FlavourSaver
     end
 
     def register_helper(method,&b)
-      if method.respond_to? :name
+      if !method.is_a?(Symbol) && method.respond_to?(:name)
         registered_helpers[method.name.to_sym] = method
       elsif b
         registered_helpers[method.to_sym] = b
@@ -104,15 +121,13 @@ module FlavourSaver
 
     def decorate_with(context, helper_names=[], locals={})
       helpers = if helper_names.any?
-                  helper_names = helper_names.map(&:to_sym)
-                  registered_helpers.select { |k,v| helper_names.member? k }.merge(locals)
+                  helper_symbols = helper_names.map(&:to_sym)
+                  registered_helpers.select { |k,v| helper_symbols.member? k }
                 else
-                  helpers = registered_helpers
+                  registered_helpers
                 end
       helpers = helpers.merge(locals)
       Decorator.new(helpers, context)
     end
-
   end
 end
-

data/lib/flavour_saver/lexer.rb

@@ -52,7 +52,7 @@ module FlavourSaver
       :GT
     end
 
-    rule /([1-9][0-9]*(\.[0-9]+)?)/, :expression do |n|
+    rule /([0-9]+(\.[0-9]+)?)/, :expression do |n|
       [ :NUMBER, n ]
     end
 
@@ -78,7 +78,7 @@ module FlavourSaver
       :ELSE
     end
 
-    rule /([A-Za-z]\w*)/, :expression do |name|
+    rule /([A-Za-z_]\w*)/, :expression do |name|
       [ :IDENT, name ]
     end
 
@@ -86,6 +86,14 @@ module FlavourSaver
       :DOT
     end
 
+    rule /\(/, :expression do
+      :OPAR
+    end
+
+    rule /\)/, :expression do
+      :CPAR
+    end
+
     rule /\=/, :expression do
       :EQ
     end
@@ -114,10 +122,15 @@ module FlavourSaver
       pop_state
     end
 
-    # Handlebars allows methods with hyphens in them. Ruby doesn't, so
-    # we'll assume you're trying to index the context with the identifier
-    # and call the result.
-    rule /([A-Za-z][a-z0-9_-]*[a-z0-9])/, :expression do |str|
+    # Handlebars allows identifiers with characters in them which Ruby does not.
+    # These are mapped to the literal notation and accessed in this way.
+    #
+    # As per the http://handlebarsjs.com/expressions.html:
+    #
+    #   Identifiers may be any unicode character except for the following:
+    #   Whitespace ! " # % & ' ( ) * + , . / ; < = > @ [ \ ] ^ ` { | } ~
+    #
+    rule /([^\s!-#%-,.\/;->@\[-^`{-~]+)/, :expression do |str|
       [ :LITERAL, str ]
     end
 

data/lib/flavour_saver/nodes.rb

@@ -95,7 +95,7 @@ module FlavourSaver
   end
 
   class ParentCallNode < CallNode
-    value :depth, Fixnum
+    value :depth, Integer
 
     def to_callnode
       CallNode.new(name,arguments)

data/lib/flavour_saver/parser.rb

@@ -86,6 +86,10 @@ module FlavourSaver
       clause('EXPRST expression_contents EXPRE') { |_,e,_| e }
     end
 
+    production(:subexpr) do
+      clause('OPAR expression_contents CPAR') { |_,e,_| e }
+    end
+
     production(:expr_comment) do
       clause('EXPRST BANG COMMENT EXPRE') { |_,_,e,_| e }
     end
@@ -111,7 +115,6 @@ module FlavourSaver
 
     production(:expression_contents) do
       clause('WHITE? call WHITE?') { |_,e,_| e }
-      clause('WHITE? local WHITE?') { |_,e,_| [e] }
     end
 
     production(:call) do
@@ -120,17 +123,13 @@ module FlavourSaver
       clause('DOT') { |_| [CallNode.new('this', [])] }
     end
 
-    production(:local) do
-      clause('AT IDENT') { |_,e| LocalVarNode.new(e) }
-    end
-
     production('arguments') do
       clause('argument_list') { |e| e }
       clause('argument_list WHITE hash') { |e0,_,e1| e0 + [e1] }
       clause('hash') { |e| [e] }
     end
-
-    nonempty_list(:argument_list, [:object_path,:lit], :WHITE)
+    
+    nonempty_list(:argument_list, [:object_path,:lit, :subexpr], :WHITE)
 
     production(:lit) do
       clause('string') { |e| e }
@@ -157,6 +156,7 @@ module FlavourSaver
     end
 
     production(:hash_item) do
+      clause('IDENT EQ subexpr') { |e0,_,e1| { e0.to_sym => e1 } }
       clause('IDENT EQ string') { |e0,_,e1| { e0.to_sym => e1 } }
       clause('IDENT EQ number') { |e0,_,e1| { e0.to_sym => e1 } }
       clause('IDENT EQ object_path') { |e0,_,e1| { e0.to_sym => e1 } }
@@ -170,6 +170,7 @@ module FlavourSaver
     nonempty_list(:object_path, :object, :object_sep)
 
     production(:object) do
+      clause('AT IDENT') { |_,e| LocalVarNode.new(e) }
       clause('IDENT') { |e| CallNode.new(e, []) }
       clause('LITERAL') { |e| LiteralCallNode.new(e, []) }
       clause('parent_call') { |e| e }

data/lib/flavour_saver/runtime.rb

@@ -8,7 +8,7 @@ module FlavourSaver
   UnknownHelperException            = Class.new(RuntimeError)
   class Runtime
 
-    attr_accessor :context, :parent, :ast
+    attr_accessor :context, :parent, :ast, :privates
 
     def self.run(ast, context, locals={}, helpers=[])
       self.new(ast, context, locals, helpers).to_s
@@ -20,7 +20,7 @@ module FlavourSaver
       @helpers = helpers
       @context = context
       @parent = parent
-      @privates = {}
+      @privates = parent ? parent.privates.dup : { 'root' => context }
     end
 
     def to_s(tmp_context = nil,privates={})
@@ -34,7 +34,7 @@ module FlavourSaver
         @privates = old_privates
         @context = old_context
       else
-        result = evaluate_node(@ast)
+        result = evaluate_node(@ast).to_s.force_encoding(Encoding::default_external)
       end
       result
     end
@@ -46,13 +46,13 @@ module FlavourSaver
     def private_variable_get(name)
       begin
         @privates.fetch(name)
-      rescue KeyError => e
+      rescue KeyError
         raise UndefinedPrivateVariableException, "private variable not found @#{name}"
       end
     end
 
     def strip(tmp_context = nil)
-      self.to_s(tmp_context).gsub(/[\s\r\n]+/,' ').strip
+      self.to_s(tmp_context).gsub(/[\s]+/,' ').strip
     end
 
     def evaluate_node(node)
@@ -256,9 +256,9 @@ module FlavourSaver
             "'"
           when '"'
             """
-            when '`'
-              "`"
-            end
+          when '`'
+            "`"
+          end
         end
 
         # Mark it as already escaped if we're in Rails

data/lib/flavour_saver/version.rb

@@ -1,3 +1,3 @@
 module FlavourSaver
-  VERSION = "0.3.7"
+  VERSION = "2.0.0"
 end

data/spec/acceptance/backtrack_spec.rb

@@ -9,6 +9,6 @@ describe 'Fixture: backtrack.hbs' do
   it 'renders correctly' do
     context.person = Struct.new(:name).new('Alan')
     context.company = Struct.new(:name).new('Rad, Inc.')
-    subject.should == "Alan - Rad, Inc."
+    expect(subject).to eq "Alan - Rad, Inc."
   end
 end

data/spec/acceptance/comment_spec.rb

@@ -7,6 +7,6 @@ describe 'Fixture: comment.hbs' do
   let(:context)  { double(:context) }
 
   it 'renders correctly' do
-    subject.should == "I am a very nice person!"
+    expect(subject).to eq "I am a very nice person!"
   end
 end

data/spec/acceptance/custom_block_helper_spec.rb

@@ -18,7 +18,7 @@ describe 'Fixture: custom_block_helper.hbs' do
         end.join ''
       end
       FlavourSaver.register_helper(method(:three_times))
-      subject.should == "1 time. 2 time. 3 time."
+      expect(subject).to eq "1 time. 2 time. 3 time."
     end
   end
 
@@ -29,7 +29,7 @@ describe 'Fixture: custom_block_helper.hbs' do
           b.call.contents i
         end.join ''
       }
-      subject.should == "1 time. 2 time. 3 time."
+      expect(subject).to eq "1 time. 2 time. 3 time."
     end
   end
 end

data/spec/acceptance/custom_helper_spec.rb

@@ -10,6 +10,6 @@ describe 'Fixture: custom_helper.hbs' do
     FlavourSaver.register_helper(:say_what_again) do
       'What?'
     end
-    subject.should == "What?"
+    expect(subject).to eq "What?"
   end
 end

data/spec/acceptance/ensure_no_rce_spec.rb

@@ -8,7 +8,7 @@ describe "Can't call methods that the context doesn't respond to" do
 
   it 'renders correctly' do
     expect(Kernel).not_to receive(:system)
-    expect { subject }.to raise_error
+    expect { subject }.to raise_error(RuntimeError)
   end
 end
 
@@ -19,7 +19,7 @@ describe "Can't eval arbitrary Ruby code" do
 
   it 'renders correctly' do
     expect(Kernel).not_to receive(:eval)
-    expect { subject }.to raise_error
+    expect { subject }.to raise_error(RuntimeError)
   end
 end