erbse 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df7ee95b6879b5591ad8cd4ee86fd374ac12e66d
-  data.tar.gz: a4c1100201726eebaada8b091c763d1b1925892c
+  metadata.gz: deb5a744396c2f7901a545c6c2ae480eb6e7893e
+  data.tar.gz: 3738953bcabb49eb00ccd3db0a1feb99e39d63ac
 SHA512:
-  metadata.gz: 999650c0c6f0e0ac13d597874b10f62010ae573f04a51964f50a43543808c58b6b1a53456d4f931a6d0cfe41f6272cb22c8cd225e21913edb961a795585663d7
-  data.tar.gz: 42fb43d4d2de42d32c97e9e752175c1170395a9361be975c6ca59c65f5c6298055aea1430f421b755d850effd776b4c85c809b6c4d7b81af46d63f1f981114be
+  metadata.gz: bdf4146a9703c7b3d1254fa3ad865bb3391a3a97b083c1a7424462c02fa470d469a743053b50ce43eccdd51525403ad5e539c0a0dbcb5bdb41486c3893a4ef5a
+  data.tar.gz: a4842875cae85c733a006931a84a55e5b7363a53ca62aade95c35c470c2eb07bf1356dcb3b4dd035c8b4a124cf1ee7272b0e7749cbce2b6b9d7c4beb5f0d7728

data/CHANGES.md

@@ -1,3 +1,9 @@
+# 0.1.1
+
+* Introduce the `<%@ %>` tag. This is a built-in capture mechanism. It will assign all block content to a local variable but *not* output it.
+* Make comments be recognized before `end`, which fixes a syntax error with `<%# end %>`.
+* Don't recognize ERB tags with a string containing "do" as a block.
+
 # 0.1.0
 
 * Internally, we're parsing the ERB template into a SEXP structure and let [Temple](https://github.com/judofyr/temple) compile it to Ruby. Many thanks to the Temple team! 😘

data/README.md

@@ -14,6 +14,19 @@ Erbse::Engine.new.call("<% ... %>") #=> string of compiled ruby.
 
 The returned string can then be `eval`uated in a certain context.
 
+## Output Buffers
+
+Erbse does not use instance variables as output buffer, only local variables.
+
+| Tag | Behavior |
+| --- | --- |
+| `<% %>` | Executes the code but does not output anything. |
+| `<% .. do %>` | Executes the code but does not output anything. In the block, output is written to the current buffer. |
+| `<%= %>` | Executes the code, outputs to current buffer. |
+| `<%= .. do %>` | Executes the code and appends returned value to the current buffer. In the block, output is written to a new buffer that is returned when `yield`ing. |
+| `<%@ .. do %>` | Executes the code but does not output anything. In the block, output is written to a new buffer that is returned when `yield`ing. |
+
+
 ## Block Yielding
 
 Erbse supports blocks à la Rails.
@@ -42,12 +55,36 @@ Usually, returning the content from the helper will be sufficient.
 
 However, you can totally pass that block to a completely different object and yield it there. Since there's no global state as in ERB, this will work.
 
+## Capture
+
+With the `<%= helper do %>` tag, block content is assigned to a new output buffer and the result of `helper` rendered.
+
+To capture the block without outputting anything, use the `<%@ %>` tag. This will still use a new output buffer for the block, but not output anything.
+
+```erb
+<%@ content = capture do %>
+  Whatever
+<% end %>
+
+<%= content %>
+```
+
+The `capture` method will receive a block, what you do with it is up to you. It would usually simply yield the block.
+
+```ruby
+def capture(&block)
+  yield
+end
+```
+
 ## Removed Features
 
-Erbse does *not* support any tags other than `<% %>` and `<%= %>`. Tags such as `<%% %>`, `<%== %>`, `<%- %>` or `<% -%>` will be reduced to the supported tags.
+Erbse does *not* support any tags other than `<% %>`, `<%= %>` and `<%@ %>`. Tags such as `<%% %>`, `<%== %>`, `<%- %>` or `<% -%>` will be reduced to the supported tags.
 
 ## TODO
 
+The parser code got drastically reduced and might be missing essential features. [Please report](https://github.com/apotonick/erbse/issues) compiled syntax errors.
+
 * Block comments
 * Add newlines in compiled Ruby.
 

data/lib/erbse.rb

@@ -12,11 +12,21 @@ module Erbse
       # this still needs the Temple::Filters::ControlFlow run-through.
       [:multi,
         [:block, "#{outter_i} = #{code}",
-          [:capture, inner_i, compile(content_ast)] # compile() is recursion on nested block content.
+          [:capture, inner_i, compile(content_ast)]
         ],
         [:dynamic, outter_i] # return the outter buffer. # DISCUSS: why do we need that, again?
       ]
     end
+
+    # assign all code in the block to new local output buffer without outputting it.
+    # handles <%@ do %>
+    def on_capture_block(code, content_ast)
+      [:multi,
+        [:block, code, # var = capture do
+          [:capture, unique_name, compile(content_ast)]
+        ]
+      ]
+    end
   end
 
   class Engine < Temple::Engine

data/lib/erbse/parser.rb

@@ -1,9 +1,14 @@
 module Erbse
   class Parser
     # ERB_EXPR = /<%(=|\#)?(.*?)%>(\n)*/m # this is the desired pattern.
-    ERB_EXPR = /<%(=+|-|\#|%)?(.*?)[-=]?%>(\n)*/m # this is for backward-compatibility.
+    ERB_EXPR = /<%(=+|-|\#|@|%)?(.*?)[-=]?%>(\n)*/m # this is for backward-compatibility.
     # BLOCK_EXPR     = /\s*((\s+|\))do|\{)(\s*\|[^|]*\|)?\s*\Z/
-    BLOCK_EXPR = /\b(if|unless)\b|\bdo\b/
+    BLOCK_EXPR = /\b(if|unless)\b|\sdo\s*$|\sdo\s+\|/
+
+    # Parsing patterns
+    #
+    # Blocks will be recognized when written:
+    # <% ... do %> or <% ... do |...| %>
 
     def initialize(*)
     end
@@ -34,11 +39,14 @@ module Erbse
           else
             buffers.last << [:dynamic, code]
           end
-        elsif code =~ /\bend\b/ # <% end %>
-          buffers.pop
         elsif ch =~ /#/ # DISCUSS: doesn't catch <% # this %>
           newlines = code.count("\n")
           buffers.last.concat  [[:newline]] * newlines if newlines > 0
+        elsif code =~ /\bend\b/ # <% end %>
+          buffers.pop
+        elsif ch == ?@
+          buffers.last << [:capture, :block, code, block = [:multi]] # picked up by our own BlockFilter. # TODO: merge with %= ?
+          buffers << block
         else # <% %>
           if code =~ BLOCK_EXPR
             buffers.last << [:block, code, block = [:multi]] # picked up by Temple's ControlFlow filter.

data/lib/erbse/version.rb

@@ -1,3 +1,3 @@
 module Erbse
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/test/erbse_test.rb

@@ -99,6 +99,12 @@ Hi
       code = %{_buf = []; _buf << ("Hello@@".freeze); @; _buf << ("Hola@@".freeze); @; @; _buf << ("Hi@@".freeze);  # this ; @; _buf = _buf.join("".freeze)}
       ruby.must_equal code
     end
+
+    # <%# end %>
+    it { Erbse::Parser.new.(%{Yo
+<%# bla do %>
+<%# end %>
+1}).must_equal [:multi, [:static, "Yo\n"], [:newline], [:newline], [:static, "1"]] }
   end
 
   describe "content after last ERB tag" do
@@ -113,4 +119,32 @@ blubb</b>} }
     it { Erbse::Parser.new.(%{<%% 1 %>}).must_equal [:multi, [:code, " 1 "]] }
     it { Erbse::Parser.new.(%{<%% 1 -%>}).must_equal [:multi, [:code, " 1 "]] }
   end
+
+  describe "<% var = 1 %>" do
+    let (:str) { %{<% var = 1 %><%= var %>} }
+    it { eval(Erbse::Engine.new.(str)).must_equal "1" }
+  end
+
+  describe "<% \"string with do\" %>" do
+    it { Erbse::Parser.new.(%{<% var = "do 1" %><%= var %>}).must_equal [:multi, [:code, " var = \"do 1\" "], [:dynamic, " var "]] }
+    it { Erbse::Parser.new.(%{<% var = " do 1" %><%= var %>}).must_equal [:multi, [:code, " var = \" do 1\" "], [:dynamic, " var "]] }
+  end
+
+  describe "do" do
+    it { Erbse::Parser.new.(%{<% form do %>1<% end %>}).must_equal [:multi, [:block, " form do ", [:multi, [:static, "1"]]]] }
+    it { Erbse::Parser.new.(%{<% form do |i| %>1<% end %>}).must_equal [:multi, [:block, " form do |i| ", [:multi, [:static, "1"]]]] }
+  end
+
+  describe "capture" do
+    let (:str) { %{<%@ content = capture do %>
+  Yo!
+  <%= 1 %>
+<% end %>} }
+
+    it do
+      ruby = Erbse::Engine.new.(str).gsub("\n", "@").gsub('\n', "@@")
+      code = %{_buf = [];  content = capture do ; _erbse_blockfilter1 = ''; @; _erbse_blockfilter1 << (\"  Yo!@@  \".freeze); _erbse_blockfilter1 << (( 1 ).to_s); @; _erbse_blockfilter1; end; _buf = _buf.join(\"\".freeze)}
+      ruby.must_equal code
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erbse
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-05 00:00:00.000000000 Z
+date: 2016-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: temple