renshi 0.1.6 → 0.1.7

data/README

@@ -1,36 +1,34 @@
-Renshi is a templating language for Ruby which is unobtrusive in HTML and XHTML structures. It is conciser than ERB and offers 'attribute expressions', letting you build sets of inline Ruby instructions upon HTML elements. Renshi was designed to give the Ruby dev. flexibility when creating templates; the use of attribute expressions creates well-formed XHTML, $ interpretation can be used however the dev. wishes.
+Renshi is a templating language for Ruby which is unobtrusive in HTML and XHTML structures. It has a conciser syntax than ERB and an 'attribute expression' library which lets you build and combine sets of inline Ruby instructions upon HTML elements.
 
 Renshi templates are appended with the suffix of .ren, e.g. index.html.ren or index.ren 
 
+Renshi was designed to give the Ruby dev. flexibility when creating templates; the use of attribute expressions creates well-formed XHTML, $ interpretation can be used however the dev. wishes.
+
 $ Ruby Insertion
 ================
-To output data on the page stick a $ in front of your var. or expression
+Very much like ERB.
 
-$foo, $Time.now  (ERB equivalent - <%= foo %>, <%= Time.now %>)
+Use $ or ${..} where you would use <%= ... %> . The single $ is used for one word phrases.
 
-If there's a space in your expression use ${}
+$foo[0], $1+1, $Time.now - ERB equiv. <%= foo[0] %>, <%= 1+1 %>, <%= Time.now %> 
 
 ${some_function "takes this string as input"} (ERB equiv. - <%= some_function "takes this string as input" %>)
 
-To insert statements in your template use $[]
-
-$[foo = "hello world"]
+Use $[] instead of <% ... -%>
 
 $[if foo]
   $foo
 $[end]
 
-(The ERB equiv. should be obvious by now.)
-
 Attribute Expressions
 ===================
 Renshi has 'attribute expressions', which may be inserted into HTML elements as attributes. 
 
-Attribute expressions can be combined on elements and are interpreted in the order of appearance and are cumulative, allowing you to build chunks of inline code which apply to the HTML element (and anything within it).
+Attribute expressions can be combined on elements and are interpreted in the order of appearance and are cumulative, allowing you to program inline  on the HTML structure (the element and everything within it).
 
 For e.g.
 <ul>
-  <li r:for="section in @section.sections" r:if="authorized?(current_user, section)?" id="section_$section.name">$section.name
+  <li r:for="section in @section.sections" r:if="authorized?(current_user, section)" id="section_$section.name">$section.name
     <ul>
       <li r:for="page in section.pages">${link_to page.name, "#{page.path}"}</li>
     </ul>

data/lib/renshi/parser.rb

@@ -5,13 +5,13 @@ module Renshi
   # the document, which are finally compiled into Ruby.
   
   class Parser
-    STRING_END = "^R_END" #maybe replace this with a funky unicode char
-    STRING_START = "^R_START" #maybe replace this with a funky unicode char
+    STRING_END = "_R_END" #maybe replace this with a funky unicode char
+    STRING_START = "_R_START" #maybe replace this with a funky unicode char
     BUFFER_CONCAT_OPEN = "@output_buffer.concat(\""
     BUFFER_CONCAT_CLOSE = "\");"
     NEW_LINE = "@output_buffer.concat('\n');"
-    INSTRUCTION_START = "^R_INSTR_IDX_START^"
-    INSTRUCTION_END = "^R_INSTR_IDX_END^"
+    INSTRUCTION_START = "_R_INSTR_IDX_START_"
+    INSTRUCTION_END = "_R_INSTR_IDX_END_"
     
     #these symbols cannot be normally escaped, as we need to differentiate between < as an
     #escaped string, to be left in the document, and < as a boolean operator
@@ -45,7 +45,6 @@ module Renshi
 
       inner_html = @doc.inner_html
       compiled = compile_to_buffer(inner_html) if inner_html
-       # puts "\n", compiled, "\n"
       return compiled
     end
 
@@ -62,7 +61,8 @@ module Renshi
         for attribute in node.attributes()
           compiled = compile(attribute[1].to_s)
           if compiled
-            node[attribute[0]]= (compiled) 
+            key = store_instruction_for_buffer(compiled)
+            node[attribute[0]]= key      
           end
         end        
       end
@@ -71,11 +71,7 @@ module Renshi
       if node.text?
         compiled = compile(node.text)
         if compiled
-          @instructions << compiled
-          key = "#{INSTRUCTION_START}#{@instr_idx}#{INSTRUCTION_END}"
-          @instr_idx = @instr_idx + 1
-          # node.content = compiled if compiled
-          node.content = key
+          node.content = store_instruction_for_buffer(compiled)
         end
       end
 
@@ -83,12 +79,23 @@ module Renshi
     end
  
 
+    def store_instruction_for_buffer(compiled)
+      @instructions << compiled
+      key = "#{INSTRUCTION_START}#{@instr_idx}#{INSTRUCTION_END}"
+      @instr_idx = @instr_idx + 1
+      return key
+    end
+
     def compile(text)
       idx = text.index("$")
       return text if idx.nil?
       
       bits = []
-      bits << text[0..(idx -1)] if idx != 0
+      
+      if idx != 0
+        before_str = text[0..(idx -1)] 
+         bits << escape_quot_mark(before_str)
+      end
       
       while idx != nil do
         next_char = text[(idx + 1)..(idx + 1)]
@@ -132,7 +139,7 @@ module Renshi
         else #$foo
           
           #divide with a delimiter for anything which is not a name character - alpa-numeric and underscore
-          words = text[(idx +1)..-1].split(/[^\w."'{}()+=*\/\-@\[\]]/)
+          words = text[(idx +1)..-1].split(/[^\w."'{}()+=*\/\-@\[\]:]/)
           words[0] = "'$'" if words[0] == "$"
           statement_str = words.first
           statement = Statement.new(statement_str)
@@ -144,16 +151,14 @@ module Renshi
         
         if next_statement_idx
           gap = text[end_statement_idx..(next_statement_idx -1)]
-          bits << gap
+          bits << escape_quot_mark(gap)
         else
-          bits << text[end_statement_idx..-1]
+          bits << escape_quot_mark(text[end_statement_idx..-1])
         end
         idx = next_statement_idx
       end       
-    
       return bits.join
     end
-
     
     def close_of_phrase_ending_with(char, text, idx)
       phrase_end = (text[(idx + 1)..-1].index("$")) 
@@ -167,6 +172,10 @@ module Renshi
       return closing_brace_idx
     end
     
+    def escape_quot_mark(str)
+      return (str == '"' ? '\"' : str)
+    end
+    
     def compile_to_buffer(str)
       compiled = "@output_buffer ='';" << BUFFER_CONCAT_OPEN      
       str = compile_print_flags(str)    

data/lib/renshi.rb

@@ -9,7 +9,7 @@ require 'renshi/attribute_expressions'
 require 'renshi/frameworks'
 
 module Renshi
-  VERSION="0.1.6"
+  VERSION="0.1.7"
   
   class SyntaxError < StandardError; end
 end

data/spec/parser_spec.rb

@@ -155,4 +155,30 @@ end
       
       html.should eql "hello world"
     end
+    
+    
+    it "should interpret \"${@foo}\" " do
+      raw = Renshi::Parser.parse(%Q!"${@foo}"!)
+      puts raw
+      @foo = "hello world"
+      html = eval(raw, binding)
+      
+      html.should eql %Q!"hello world"!
+    end
+
+    class R
+      attr_accessor :path
+      
+      def initialize
+        @path = "/hello/world"
+      end
+    end
+    
+    it "should interpret <a href='{$r.path}'>hello</a>" do
+      r = R.new
+      raw = Renshi::Parser.parse(%Q!<a href="${r.path}">hello</a>!)
+      html = eval(raw, binding)
+      
+      html.should eql "<a href=\"#{r.path}\">hello</a>"
+    end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: renshi
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors: 
 - Nicholas Faiz
@@ -9,7 +9,7 @@ autorequire: renshi
 bindir: bin
 cert_chain: []
 
-date: 2009-08-24 00:00:00 +10:00
+date: 2009-08-25 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency