flavour_saver 1.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2874ca7f6ce28bbd9ed5f1ba887a0bc7244bdd448be995c2447078439e32bb82
-  data.tar.gz: cdae84ceb24202a2f03db262a973f254dc750a3de30efae7138e01a3ef6187cb
+  metadata.gz: 5bd75dc7f4e17072e0e18ffdefdfa81c6f24e98859786bb37c45191095964f2c
+  data.tar.gz: 41ac8be61e4a0969a7aa669a7f1cb488530f8a4d5514aca979fa37da151aca32
 SHA512:
-  metadata.gz: 404531d6a27b3c6e8739d98dc7ab9b5af81e8b29cc9260869784882704b58b4cd7ab2e2f3e741768cbe5386c326c66e1fc1be66d3ab1f6702a2902b9ee811017
-  data.tar.gz: b5ae4b6c36462dfc80a29e6eb25cca006330462aa44b1d38dd234e353a072ee906ac41943201ab5cce233b3812f14da697be6b29a189b4bf7b8820a98afecc7e
+  metadata.gz: d771d2bdc69eea05f39b747299a962f914a53a3e1475a26089ea951eef505acd5d7e8511b9fd1d61e2d22cdceaf3bd52e7b7326901c3cd7cdb1216eb3c4ba4d2
+  data.tar.gz: ba14f4e5d4c62ace6ae2c8a1776cd8f7d9757333a1545473169d5f3c7f12c621149804736c1ff453927d8ed87b6ed31c756df8aee53cde2c54c2a094eefd2cb5

data/.github/workflows/ci.yml

@@ -3,6 +3,7 @@ name: Continuous integration
 on:
   push:
     branches: [ master ]
+    tags: [ 'v*' ]
   pull_request:
     branches: [ master ]
 
@@ -24,3 +25,23 @@ jobs:
     - 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

@@ -7,6 +7,39 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.2]
+
+### Fixed
+
+* Deprecation warning for template handler (#59)
+
+### Changed
+
+* Relaxed version constraint on activesupport dependency (#60)
+
+## [2.0.1]
+
+### Fixed
+
+* Ability to dereference arrays at a specific index (#57)
+
+## [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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    flavour_saver (1.0.0)
+    flavour_saver (2.0.2)
       rltk (~> 2.2.0)
       tilt
 
@@ -45,7 +45,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (< 7.0)
+  activesupport (< 8.0)
   flavour_saver!
   rake
   rspec

data/flavour_saver.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'activesupport', '< 7.0'
+  gem.add_development_dependency 'activesupport', '< 8.0'
 
   gem.add_dependency 'rltk', '~> 2.2.0'
   gem.add_dependency 'tilt'

data/lib/flavour_saver/helpers.rb

@@ -11,27 +11,31 @@ module FlavourSaver
         r = []
         count = 0
         collection.each do |element|
-          r << yield.contents(element, 
-            'index' => count, 
-            'last' => count == collection.size - 1, 
-            'first' => count == 0)
+          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
@@ -42,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
@@ -107,10 +121,10 @@ 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)

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
 

data/lib/flavour_saver/parser.rb

@@ -115,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
@@ -124,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, :local, :subexpr], :WHITE)
+
+    nonempty_list(:argument_list, [:object_path, :lit, :subexpr], :WHITE)
 
     production(:lit) do
       clause('string') { |e| e }
@@ -172,9 +167,20 @@ module FlavourSaver
       clause('FWSL') { |_| }
     end
 
-    nonempty_list(:object_path, :object, :object_sep)
+    production(:object_path) do
+      clause('object') { |e| [e] }
+      clause('object_path object_sep object') { |e0,_,e1| e0 + [e1] }
+
+      # Accomodates objects dereferenced with a number like foo.0.text
+      clause('object_path object_sep number_object') { |e0,_,e1| e0 + [e1] }
+    end
+
+    production(:number_object) do
+      clause('NUMBER') { |e| LiteralCallNode.new(e, []) }
+    end
 
     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={})

data/lib/flavour_saver/version.rb

@@ -1,3 +1,3 @@
 module FlavourSaver
-  VERSION = "1.0.0"
+  VERSION = "2.0.2"
 end

data/lib/flavour_saver.rb

@@ -17,10 +17,11 @@ module FlavourSaver
     end
 
     ActiveSupport.on_load(:action_view) do
-      handler = proc do |template|
+      handler = proc do |template, source|
+        source ||= template.source
         # I'd rather be caching the Runtime object ready to fire, but apparently I don't get that luxury.
         <<-SOURCE
-        FlavourSaver.evaluate((begin;#{template.source.inspect};end),self)
+        FlavourSaver.evaluate((begin;#{source.inspect};end),self)
         SOURCE
       end
       ActionView::Template.register_template_handler(:hbs, handler)

data/spec/acceptance/handlebars_qunit_spec.rb

@@ -406,6 +406,21 @@ describe FlavourSaver do
       end
     end
 
+    describe 'array with numeric dereference' do
+      let(:template) {"{{goodbyes.0.text}} cruel {{world}}!"}
+
+      it 'properly inserts the referenced element' do
+        goodbyes = []
+        goodbyes << double(:goodbye)
+        expect(goodbyes[0]).to receive(:text).and_return('goodbye')
+
+        allow(context).to receive(:goodbyes).and_return(goodbyes)
+        allow(context).to receive(:world).and_return('world')
+
+        expect(subject).to eq "goodbye cruel world!"
+      end
+    end
+
     describe 'empty block' do
       let(:template) { "{{#goodbyes}}{{/goodbyes}}cruel {{world}}!" }
 
@@ -909,6 +924,17 @@ describe FlavourSaver do
       end
     end
 
+    describe 'each with @index in a nested block' do
+      let(:template) { "{{#each goodbyes}}{{#if @last}}{{@index}}. {{/if}}{{text}}! {{/each}}cruel {{world}}!" }
+
+      example 'the @index variable is used' do
+        g = Struct.new(:text)
+        allow(context).to receive(:goodbyes).and_return([g.new('goodbye'), g.new('Goodbye'), g.new('GOODBYE')])
+        allow(context).to receive(:world).and_return('world')
+        expect(subject).to eq "goodbye! Goodbye! 2. GOODBYE! cruel world!"
+      end
+    end
+
     describe 'each with @last' do
       let(:template) { "{{#each goodbyes}}{{@index}}. {{text}}! {{#if @last}}last{{/if}}{{/each}} cruel {{world}}!" }
 
@@ -931,6 +957,58 @@ describe FlavourSaver do
       end
     end
 
+    describe 'each with @root' do
+      let(:template) { "{{#each goodbyes}}{{@index}}. {{text}} cruel {{@root.place}}! {{/each}}" }
+
+      example 'the root variable is used' do
+        g = Struct.new(:text)
+        allow(context).to receive(:goodbyes).and_return([g.new('goodbye'), g.new('Goodbye'), g.new('GOODBYE')])
+        allow(context).to receive(:place).and_return('world')
+        expect(subject).to eq "0. goodbye cruel world! 1. Goodbye cruel world! 2. GOODBYE cruel world! "
+      end
+    end
+
+    describe 'each with @root in a nested block' do
+      let(:template) { "{{#each goodbyes}}{{@index}}. {{text}}{{#if @last}} cruel {{@root.place}}{{/if}}! {{/each}}" }
+
+      example 'the root variable is used' do
+        g = Struct.new(:text)
+        allow(context).to receive(:goodbyes).and_return([g.new('goodbye'), g.new('Goodbye'), g.new('GOODBYE')])
+        allow(context).to receive(:place).and_return('world')
+        expect(subject).to eq "0. goodbye! 1. Goodbye! 2. GOODBYE cruel world! "
+      end
+    end
+
+    describe 'each with @key' do
+      let(:template) { "{{#each goodbyes}}{{@key}}. {{text}}! {{/each}}cruel {{world}}!" }
+
+      example 'the @key variable is used' do
+        g = Struct.new(:text)
+        allow(context).to receive(:goodbyes).and_return({
+          one: g.new('goodbye'),
+          two: g.new('Goodbye'),
+          three: g.new('GOODBYE')
+        })
+        allow(context).to receive(:world).and_return('world')
+        expect(subject).to eq "one. goodbye! two. Goodbye! three. GOODBYE! cruel world!"
+      end
+    end
+
+    describe 'each with @key in a nested block' do
+      let(:template) { "{{#each goodbyes}}{{#if @last}}{{@key}}. {{/if}}{{text}}! {{/each}}cruel {{world}}!" }
+
+      example 'the @key variable is used' do
+        g = Struct.new(:text)
+        allow(context).to receive(:goodbyes).and_return({
+          one: g.new('goodbye'),
+          two: g.new('Goodbye'),
+          three: g.new('GOODBYE')
+        })
+        allow(context).to receive(:world).and_return('world')
+        expect(subject).to eq "goodbye! Goodbye! three. GOODBYE! cruel world!"
+      end
+    end
+
     describe 'log' do
       let(:template) { "{{log blah}}" }
       let(:log) { double(:log) }

data/spec/acceptance/if_else_spec.rb

@@ -3,15 +3,46 @@ require 'flavour_saver'
 
 describe 'Fixture: if_else.hbs' do
   subject { Tilt.new(template).render(context).gsub(/[\s\r\n]+/, ' ').strip }
-  let(:context) { Struct.new(:name).new }
+  let(:context) { Struct.new(:value).new }
   let(:template) { File.expand_path('../../fixtures/if_else.hbs', __FILE__) }
 
-  it 'renders correctly when given a name' do
-    context.name = 'Alan'
-    expect(subject).to eq "Say hello to Alan."
+  it "renders the if block when given a string" do
+    context.value = "Alan"
+    expect(subject).to eq "The given value is truthy: Alan."
   end
 
-  it 'renders correctly when not given a name' do
-    expect(subject).to eq "Nobody to say hi to."
+  it "renders the if block when given a number greater than zero" do
+    context.value = 1
+    expect(subject).to eq "The given value is truthy: 1."
+  end
+
+  it "renders the if block when given an array that is not empty" do
+    context.value = [1]
+    expect(subject).to eq "The given value is truthy: [1]."
+  end
+
+  it "renders the else block when given false" do
+    context.value = false
+    expect(subject).to eq "The given value is falsy: false."
+  end
+
+  it 'renders the else block when given nil' do
+    context.value = nil
+    expect(subject).to eq "The given value is falsy: ."
+  end
+
+  it "renders the else block when given an empty string" do
+    context.value = ""
+    expect(subject).to eq "The given value is falsy: ."
+  end
+
+  it "renders the else block when given a zero" do
+    context.value = 0
+    expect(subject).to eq "The given value is falsy: 0."
+  end
+
+  it "renders the else block when given an empty array" do
+    context.value = []
+    expect(subject).to eq "The given value is falsy: []."
   end
 end

data/spec/acceptance/unless_spec.rb

@@ -0,0 +1,48 @@
+require 'tilt'
+require 'flavour_saver'
+
+describe 'Fixture: unless.hbs' do
+  subject { Tilt.new(template).render(context).gsub(/[\s\r\n]+/, ' ').strip }
+  let(:context) { Struct.new(:value).new }
+  let(:template) { File.expand_path('../../fixtures/unless.hbs', __FILE__) }
+
+  it "renders the unless block when given false" do
+    context.value = false
+    expect(subject).to eq "The given value is falsy: false."
+  end
+
+  it 'renders the unless block when given nil' do
+    context.value = nil
+    expect(subject).to eq "The given value is falsy: ."
+  end
+
+  it "renders the unless block when given an empty string" do
+    context.value = ""
+    expect(subject).to eq "The given value is falsy: ."
+  end
+
+  it "renders the unless block when given a zero" do
+    context.value = 0
+    expect(subject).to eq "The given value is falsy: 0."
+  end
+
+  it "renders the unless block when given an empty array" do
+    context.value = []
+    expect(subject).to eq "The given value is falsy: []."
+  end
+
+  it "renders the else block when given a string" do
+    context.value = "Alan"
+    expect(subject).to eq "The given value is truthy: Alan."
+  end
+
+  it "renders the else block when given a number greater than zero" do
+    context.value = 1
+    expect(subject).to eq "The given value is truthy: 1."
+  end
+
+  it "renders the else block when given an array that is not empty" do
+    context.value = [1]
+    expect(subject).to eq "The given value is truthy: [1]."
+  end
+end

data/spec/fixtures/if_else.hbs

@@ -1,5 +1,5 @@
-{{#if name}}
-  Say hello to {{name}}.
+{{#if value}}
+  The given value is truthy: {{value}}.
   {{else}}
-  Nobody to say hi to.
+  The given value is falsy: {{value}}.
 {{/if}}

data/spec/fixtures/unless.hbs

@@ -0,0 +1,5 @@
+{{#unless value}}
+  The given value is falsy: {{value}}.
+{{else}}
+  The given value is truthy: {{value}}.
+{{/unless}}

data/spec/lib/flavour_saver/lexer_spec.rb

@@ -71,7 +71,38 @@ describe FlavourSaver::Lexer do
         it 'has values in the correct order' do
           expect(subject.map(&:value).compact).to eq [ 'foo', 'bar', 'baz', 'hello', 'goodbye' ]
         end
+      end
+
+      describe '{{0}}' do
+        subject { FlavourSaver::Lexer.lex "{{0}}" }
+
+        it 'properly lexes the expression' do
+          expect(subject.map(&:type)).to eq(
+            [:EXPRST, :NUMBER, :EXPRE, :EOS]
+          )
+        end
 
+        it 'contains only the number "0"' do
+          expect(subject[1..-3].size).to eq 1
+          expect(subject[1].type).to eq :NUMBER
+          expect(subject[1].value).to eq '0'
+        end
+      end
+
+      describe '{{0.0123456789}}' do
+        subject { FlavourSaver::Lexer.lex "{{0.0123456789}}" }
+
+        it 'properly lexes the expression' do
+          expect(subject.map(&:type)).to eq(
+            [:EXPRST, :NUMBER, :EXPRE, :EOS]
+          )
+        end
+
+        it 'contains only the number "0.0123456789"' do
+          expect(subject[1..-3].size).to eq 1
+          expect(subject[1].type).to eq :NUMBER
+          expect(subject[1].value).to eq '0.0123456789'
+        end
       end
     end
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: flavour_saver
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Clayton Passmore
 - James Harton
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-21 00:00:00.000000000 Z
+date: 2022-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: rltk
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +123,7 @@ files:
 - spec/acceptance/segment_literals_spec.rb
 - spec/acceptance/simple_expression_spec.rb
 - spec/acceptance/subexpression_spec.rb
+- spec/acceptance/unless_spec.rb
 - spec/fixtures/backtrack.hbs
 - spec/fixtures/comment.hbs
 - spec/fixtures/custom_block_helper.hbs
@@ -134,6 +135,7 @@ files:
 - spec/fixtures/raw.hbs
 - spec/fixtures/sections.hbs
 - spec/fixtures/simple_expression.hbs
+- spec/fixtures/unless.hbs
 - spec/lib/flavour_saver/lexer_spec.rb
 - spec/lib/flavour_saver/parser_spec.rb
 - spec/lib/flavour_saver/runtime_spec.rb
@@ -146,7 +148,7 @@ metadata:
   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
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -161,8 +163,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Handlebars.js without the .js
 test_files:
@@ -181,6 +183,7 @@ test_files:
 - spec/acceptance/segment_literals_spec.rb
 - spec/acceptance/simple_expression_spec.rb
 - spec/acceptance/subexpression_spec.rb
+- spec/acceptance/unless_spec.rb
 - spec/fixtures/backtrack.hbs
 - spec/fixtures/comment.hbs
 - spec/fixtures/custom_block_helper.hbs
@@ -192,6 +195,7 @@ test_files:
 - spec/fixtures/raw.hbs
 - spec/fixtures/sections.hbs
 - spec/fixtures/simple_expression.hbs
+- spec/fixtures/unless.hbs
 - spec/lib/flavour_saver/lexer_spec.rb
 - spec/lib/flavour_saver/parser_spec.rb
 - spec/lib/flavour_saver/runtime_spec.rb