flavour_saver 0.3.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3efa30121a2e226ebb1274cf5597d35ab7f9c47
-  data.tar.gz: c89bc7f065e3dfbb07882c44465711981643d454
+  metadata.gz: 0965ce577ba5f5e0e84097ff444c306b053ba899
+  data.tar.gz: f92b0741008a767ef778841404397eabf41620f6
 SHA512:
-  metadata.gz: 1292541b248293451704808a7458b2132ab7109f9664845c77d01c375581396192af2ee2a19c6cfae4fa567294757cb5b563803e23ccfd8110961f204adbdd03
-  data.tar.gz: a74f63a36b4864fbc248fde7ff9e03c19ffc49412f37b472521cf2ed13bf7403e24243e423211c1599c924a92a8e9f9b1472ba15c07b12a12955de70f131da7c
+  metadata.gz: 11472cf0bc62d973eb98cf1e1c6c1275aa1c37b55ac52f43776104cb5629308ad5d2676887fc760657fa794a560e0f2bd8e826ddb338557772254fca4e6ef10a
+  data.tar.gz: 6e238d05a52deafb8309454977ca86d4a6c2f09171baff67a814bac81a005cfb97511e95bd8b0feec0ea0e47c47e9c1a15fee75d68966ddc902946d9de00ba19

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    flavour_saver (0.3.7)
+    flavour_saver (0.3.8)
       rltk (~> 2.2.0)
       tilt
 

data/README.md

@@ -74,6 +74,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 +249,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/lib/flavour_saver/helpers.rb

@@ -11,7 +11,10 @@ module FlavourSaver
         r = []
         count = 0
         collection.each do |element|
-          r << yield.contents(element, 'index' => count)
+          r << yield.contents(element, 
+            'index' => count, 
+            'last' => count == collection.size - 1, 
+            'first' => count == 0)
           count += 1
         end
         yield.rendered!

data/lib/flavour_saver/lexer.rb

@@ -86,6 +86,14 @@ module FlavourSaver
       :DOT
     end
 
+    rule /\(/, :expression do
+      :OPAR
+    end
+
+    rule /\)/, :expression do
+      :CPAR
+    end
+
     rule /\=/, :expression do
       :EQ
     end

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
@@ -129,8 +133,8 @@ module FlavourSaver
       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, :local, :subexpr], :WHITE)
 
     production(:lit) do
       clause('string') { |e| e }
@@ -157,6 +161,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 } }

data/lib/flavour_saver/runtime.rb

@@ -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

data/lib/flavour_saver/version.rb

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

data/spec/acceptance/handlebars_qunit_spec.rb

@@ -909,6 +909,28 @@ describe FlavourSaver do
       end
     end
 
+    describe 'each with @last' do
+      let(:template) { "{{#each goodbyes}}{{@index}}. {{text}}! {{#if @last}}last{{/if}}{{/each}} cruel {{world}}!" }
+
+      example 'the @last variable is used' do
+        g = Struct.new(:text)
+        context.stub(:goodbyes).and_return([g.new('goodbye'), g.new('Goodbye'), g.new('GOODBYE')])
+        context.stub(:world).and_return('world')
+        subject.should == "0. goodbye! 1. Goodbye! 2. GOODBYE! last cruel world!"
+      end
+    end
+
+    describe 'each with @first' do
+      let(:template) { "{{#each goodbyes}}{{@index}}. {{text}} {{#if @first}}first{{/if}}! {{/each}}cruel {{world}}!" }
+
+      example 'the first variable is used' do
+        g = Struct.new(:text)
+        context.stub(:goodbyes).and_return([g.new('goodbye'), g.new('Goodbye'), g.new('GOODBYE')])
+        context.stub(:world).and_return('world')
+        subject.should == "0. goodbye first! 1. Goodbye ! 2. GOODBYE ! cruel world!"
+      end
+    end
+
     describe 'log' do
       let(:template) { "{{log blah}}" }
       let(:log) { double(:log) }

data/spec/acceptance/subexpression_spec.rb

@@ -0,0 +1,38 @@
+require 'tilt'
+require 'flavour_saver'
+
+describe 'Subexpressions' do
+
+  subject { Tilt['handlebars'].new{ template }.render(context).gsub(/[\s\r\n]+/, ' ').strip }
+  
+  let(:context)  { double(:context) }
+  before(:all) do
+    FlavourSaver.register_helper(:sum) { |a,b| a + b}
+  end
+  context "simple subexpression" do
+    let(:template) { "{{sum 1 (sum 1 1)}}" }
+    specify{subject.should == "3"}
+  end
+
+  context "nested subexpressions" do
+    let(:template) { "{{sum 1 (sum 1 (sum 1 1))}}" }
+    specify{subject.should == "4"}
+  end
+
+  context "subexpression as argument" do
+    before {FlavourSaver.register_helper(:cents) { |a| a[:total] + 10}}
+    let(:template) { "{{cents total=(sum 1 1)}}" }
+    specify{subject.should == "12"}
+  end
+
+  context "subexpression in block" do
+    before {FlavourSaver.register_helper(:repeat) do |a, &block| 
+      s = ''
+      a.times {s += block.call.contents}
+      s
+    end}
+    let(:template) { "{{#repeat (sum 1 2)}}*{{/repeat}}" }
+    specify{subject.should == "***"}
+  end
+  
+end

data/spec/lib/flavour_saver/lexer_spec.rb

@@ -49,6 +49,18 @@ describe FlavourSaver::Lexer do
         end
       end
 
+      describe '{{foo (bar "baz")}}' do
+        subject { FlavourSaver::Lexer.lex "{{foo (bar 'baz')}}" }
+
+        it 'has tokens in the correct order' do
+          subject.map(&:type).should ==  [ :EXPRST, :IDENT, :WHITE, :OPAR, :IDENT, :WHITE, :S_STRING, :CPAR, :EXPRE, :EOS ]
+        end
+
+        it 'has values in the correct order' do
+          subject.map(&:value).compact.should == [ 'foo', 'bar', 'baz' ]
+        end
+      end
+
       describe '{{foo bar="baz" hello="goodbye"}}' do
         subject { FlavourSaver::Lexer.lex '{{foo bar="baz" hello="goodbye"}}' }
 
@@ -63,6 +75,18 @@ describe FlavourSaver::Lexer do
       end
     end
 
+    describe '{{foo bar=(baz qux)}}' do
+      subject { FlavourSaver::Lexer.lex '{{foo bar=(baz qux)}}' }
+
+      it 'has tokens in the correct order' do
+        subject.map(&:type).should == [:EXPRST, :IDENT, :WHITE, :IDENT, :EQ, :OPAR, :IDENT, :WHITE, :IDENT, :CPAR, :EXPRE, :EOS]
+      end
+
+      it 'has values in the correct order' do
+        subject.map(&:value).compact.should == [ 'foo', 'bar', 'baz', 'qux' ]
+      end
+    end
+
     describe '{{else}}' do
       subject { FlavourSaver::Lexer.lex '{{else}}' }
 

data/spec/lib/flavour_saver/parser_spec.rb

@@ -143,6 +143,28 @@ describe FlavourSaver::Parser do
     end
   end
 
+  describe '{{foo (bar "baz") }}' do
+    subject { FlavourSaver::Parser.parse(FlavourSaver::Lexer.lex('{{foo (bar "baz") }}')) }
+
+    it 'calls the method "foo"' do
+      items.first.method.should be_one
+      items.first.method.first.should be_a(FlavourSaver::CallNode)
+      items.first.method.first.name.should == 'foo'
+    end
+
+    describe 'with arguments' do
+      subject { FlavourSaver::Parser.parse(FlavourSaver::Lexer.lex('{{foo (bar "baz") }}')).items.first.method.first.arguments }
+
+      describe '[0]' do
+        it 'is a subexpression' do
+          subject.first.first.should be_a(FlavourSaver::CallNode)
+          subject.first.first.name.should == 'bar'
+        end
+      end
+
+    end
+  end
+
   describe '{{foo bar="baz"}}' do
     subject { FlavourSaver::Parser.parse(FlavourSaver::Lexer.lex('{{foo bar="baz"}}')) }
 
@@ -154,6 +176,17 @@ describe FlavourSaver::Parser do
     end
   end
 
+  describe '{{foo bar=(baz "qux")}}' do
+    subject { FlavourSaver::Parser.parse(FlavourSaver::Lexer.lex('{{foo bar=(baz "qux")}}')) }
+
+    it 'calls the method "foo" with the hash {:bar => (baz "qux")} as arguments' do
+      items.first.method.first.should be_a(FlavourSaver::CallNode)
+      items.first.method.first.name.should == 'foo'
+      items.first.method.first.arguments.first.should be_a(Hash)
+      items.first.method.first.arguments.first[:bar].first.should be_a(FlavourSaver::CallNode)
+    end
+  end
+
   describe "{{foo bar=1}}" do
     subject { FlavourSaver::Parser.parse(FlavourSaver::Lexer.lex("{{foo bar=1}}")) }
 

data/spec/lib/flavour_saver/runtime_spec.rb

@@ -110,6 +110,17 @@ describe FlavourSaver::Runtime do
       end
     end
 
+    describe 'when called with a subexpression' do
+      let(:template) { "{{hello (there world)}}" }
+
+      it 'calls there & world first, then passes off to hello' do
+        context.should_receive(:world).and_return('world')
+        context.should_receive(:there).with('world').and_return('there world')
+        context.should_receive(:hello).with('there world').and_return('hello there world')
+        subject.evaluate_expression(expr).should == 'hello there world'
+      end
+    end
+
     describe 'when called with an object path' do
       let(:template) { "{{hello.world}}" }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flavour_saver
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.8
 platform: ruby
 authors:
 - James Harton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-16 00:00:00.000000000 Z
+date: 2015-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -177,6 +177,7 @@ files:
 - spec/acceptance/sections_spec.rb
 - spec/acceptance/segment_literals_spec.rb
 - spec/acceptance/simple_expression_spec.rb
+- spec/acceptance/subexpression_spec.rb
 - spec/fixtures/backtrack.hbs
 - spec/fixtures/comment.hbs
 - spec/fixtures/custom_block_helper.hbs
@@ -230,6 +231,7 @@ test_files:
 - spec/acceptance/sections_spec.rb
 - spec/acceptance/segment_literals_spec.rb
 - spec/acceptance/simple_expression_spec.rb
+- spec/acceptance/subexpression_spec.rb
 - spec/fixtures/backtrack.hbs
 - spec/fixtures/comment.hbs
 - spec/fixtures/custom_block_helper.hbs