renshi 0.0.4 → 0.0.5

data/README

@@ -20,23 +20,33 @@ $foo
 Attribute Expressions
 ===================
 Renshi has a small library of expressions which can be inserted into HTML or XML elements as attributes.
-Attribute expressions follow the form of 
+Attribute expressions generally follow the form of 
 
 r:expression_name="expression" - the expression value is treated as a Ruby expression .
 
+Some expressions, such as r:each, use the quoted value to also hold parameter information.
+
 * Current Attribute Expressions
-* If
-* Elsif
+* If 
+* Unless
+* Elsif 
 * Else
 * While
 * For
-
+* Each
 
 * If
-<span r:if="true">hello!</span> would render "<span>hello</span>"
+<span r:if="true">hello</span>
+would render "<span>hello</span>"
 
 <span r:if="false">goodbye!</span> will render "".
 
+* Unless
+<span r:unless="false">hello</span>
+would render "<span>hello</span>"
+
+<span r:unless="true">goodbye!</span> will render "".
+
 * Elsif
 
 <span r:if="false">hello!</span>
@@ -109,22 +119,32 @@ renders:
 
 <div id="content0">
 hello0
-</div><div id="content1">
-hello1
-</div><div id="content2">
-hello2
+</div>
+...etc
+<div id="content99">
+hello99
+</div>
+
+* Each
+<div id="content$foo" r:each="foos, |foo|">
+hello$foo
 </div>
 
+<div id="content0">
+hello0
+</div>
+...etc
+<div id="content99">
+hello99
+</div>
+
+
 Further elements will appear as I have time to make them or others want to contribute them. There isn't much to making them. 
 
 See renshi/lib/renshi/attribute_expressions for how they work.
 
 Planned element expressions:
 
-* r:each
-* r:unless
-* r:def - something like genshi's py:def
-
 Other Rules
 ===========
 $ values inside of attributes are only interpreted as Renshi variables for regular attributes (not renshi attributes).
@@ -152,12 +172,9 @@ There is a Rails 2.3.2 example app in the examples directory. Go there, start up
 I'd welcome integrations for Sinatra and Merb or XYZ framework. See renshi/lib/renshi/frameworks 
 
 
-Gem Building
+Installation
 ============
-run 
-`rake gem`
-then
-`sudo gem install pkg/renshi-0.0.2.gem`
+Renshi is hosted on Rubyforge so 'sudo gem install renshi'. Alternatively, use github to do what you want with it.
 
 
 Development
@@ -173,7 +190,7 @@ Firstly, it doesn't need a reason. It's a fun project.
 But ...
 
 I've always found ERB to be a bit cumbersome - <%= is quite tiring to type out when you realise it could be much shorter. I used to think that Velocity, in Java, 
-was the most fun templating language I'd used, and I had wanted something equally as concise for Ruby.
+was the funnest templating language I'd used, and I had wanted something equally as concise for Ruby.
 
 A real need for it emerged in a project which relied upon an external design house handing us HTML. Converting it incessantly into HAML was nightmarish. A colleague 
 mentioned Genshi in Python as ideal, which was when the idea of Renshi was conceived.

data/lib/renshi/attribute_expressions/each.rb

@@ -0,0 +1,11 @@
+module Renshi
+  module AttributeExpressions
+    class Each      
+      def evaluate(expression, node)        
+        bits = expression.split(",")
+        node.open_clause("#{bits[0]}.each do #{bits[1]}")
+        node.close_clause("end")
+      end
+    end
+  end
+end

data/lib/renshi/attribute_expressions/else.rb

@@ -1,10 +1,10 @@
 module Renshi
   module AttributeExpressions
     class Else
+      
       def evaluate(expression, node)
         node.open_clause("else")
         node.close_clause("end")
-        node.remove_attribute("r:else")
       end
     end
   end

data/lib/renshi/attribute_expressions/elsif.rb

@@ -1,6 +1,6 @@
 module Renshi
   module AttributeExpressions
-    class Elsif
+    class Elsif      
       def evaluate(expression, node)
         node.open_clause("elsif (#{expression})")
   
@@ -12,14 +12,12 @@ module Renshi
           if sibling_commands.first
             expression = sibling_commands.first[0][2..-1]
             if expression == "else"
-              node.remove_attribute("r:elsif")
               return
             end
           end
         end
         
         node.close_clause("end")
-        node.remove_attribute("r:elsif")
       end
     end
   end

data/lib/renshi/attribute_expressions/for.rb

@@ -1,10 +1,10 @@
 module Renshi
   module AttributeExpressions
     class For
+      
       def evaluate(expression, node)
         node.open_clause("for #{expression}")
         node.close_clause("end")
-        node.remove_attribute("r:for")
       end
     end
   end

data/lib/renshi/attribute_expressions/if.rb

@@ -1,6 +1,6 @@
 module Renshi
   module AttributeExpressions
-    class If
+    class If      
       def evaluate(expression, node)
         node.open_clause("if (#{expression})")
   
@@ -12,14 +12,12 @@ module Renshi
           if sibling_commands.first
             expression = sibling_commands.first[0][2..-1]
             if expression == "else" or expression == "elsif"
-              node.remove_attribute("r:if")
               return
             end
           end
         end
         
         node.close_clause("end")
-        node.remove_attribute("r:if")
       end
     end
   end

data/lib/renshi/attribute_expressions/unless.rb

@@ -0,0 +1,24 @@
+module Renshi
+  module AttributeExpressions
+    class Unless      
+      def evaluate(expression, node)
+        node.open_clause("unless (#{expression})")
+  
+        sibling = node.next_real
+        
+        if sibling
+          sibling_commands = sibling.commands
+        
+          if sibling_commands.first
+            expression = sibling_commands.first[0][2..-1]
+            if expression == "else" or expression == "elsif"
+              return
+            end
+          end
+        end
+        
+        node.close_clause("end")
+      end
+    end
+  end
+end

data/lib/renshi/attribute_expressions/while.rb

@@ -1,13 +1,9 @@
 module Renshi
   module AttributeExpressions
-    class While
-      include Renshi::AttributeExpressions
-      
-      def evaluate(expression, node)
-        expression = encode_xml_entities(expression)
+    class While      
+      def evaluate(expression, node)        
         node.open_clause("while (#{expression})")
         node.close_clause("end")
-        node.remove_attribute("r:while")
       end
     end
   end

data/lib/renshi/attribute_expressions.rb

@@ -3,11 +3,30 @@ require 'renshi/attribute_expressions/elsif'
 require 'renshi/attribute_expressions/else'
 require 'renshi/attribute_expressions/while'
 require 'renshi/attribute_expressions/for'
+require 'renshi/attribute_expressions/unless'
+require 'renshi/attribute_expressions/each'
 
 module Renshi
   module AttributeExpressions
     
-    def encode_xml_entities(expression)
+    def self.perform_expression(node, command)
+      expression = command[0][2..-1]
+      
+      obj = nil
+      begin
+        obj = eval "Renshi::AttributeExpressions::#{expression.capitalize}.new"
+      rescue StandardError 
+        raise Renshi::SyntaxError, "Could not find attribute expression called #{expression}.rb", caller
+      end
+      
+      expression = encode_xml_entities(command[1].to_s)
+      obj.evaluate(expression, node)
+      
+      #removes attribute after it's performed so it doesn't appear in end document
+      node.remove_attribute(command[0])
+    end
+    
+    def self.encode_xml_entities(expression)
       expression.gsub!("<", Renshi::Parser::XML_LT)
       expression.gsub!(">", Renshi::Parser::XML_GT)
       expression.gsub!("&", Renshi::Parser::XML_AMP)

data/lib/renshi/parser.rb

@@ -5,17 +5,17 @@ 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');"
     
     #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
-    XML_LT = "R_LT"
-    XML_GT = "R_GT"
-    XML_AMP = "R_AMP"
+    XML_LT = "^R_LT^"
+    XML_GT = "^R_GT^"
+    XML_AMP = "^R_AMP^"
     
     def self.parse(xhtml)
       doc = Nokogiri::HTML.fragment(xhtml)
@@ -34,7 +34,7 @@ module Renshi
       if node.attributes
         expressions = node.commands
         for expression in expressions 
-          perform_expression(node, expression)
+          AttributeExpressions.perform_expression(node, expression)
         end
       end
       
@@ -56,19 +56,6 @@ module Renshi
 
       node.children.each {|child| transform_node(child)}
     end
-
-    def self.perform_expression(node, command)
-      expression = command[0][2..-1]
-      
-      obj = nil
-      begin
-        obj = eval "Renshi::AttributeExpressions::#{expression.capitalize}.new"
-      rescue StandardError 
-        raise Renshi::SyntaxError, "Could not find attribute expression called #{expression}.rb", caller
-      end
-      
-      obj.evaluate(command[1].to_s, node)
-    end
     
     def self.compile(text)
       idx = text.index("$")

data/lib/renshi.rb

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

data/spec/data/if_2.ren

@@ -5,3 +5,13 @@
     </div>
   </body>
 </html>
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <body>
+    <div id="content" r:each="foos, |foo|">
+    hello
+    </div>
+  </body>
+</html>
+

data/spec/each_spec.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'nokogiri'
+
+describe Renshi::Parser do      
+  it "should evaluate r:unless(false)" do
+    foos = [0,1,2]
+     doc = Nokogiri::HTML("<span id='red$foo' r:each='foos, |foo|'/>hello$foo</span>")
+     compiled = Renshi::Parser.parse(doc.root.to_s)
+     out = eval(compiled, binding)
+    (doc/"span[@id='red0']").text.strip.should eql "hello0"
+    (doc/"span[@id='red1']").text.strip.should eql "hello1"
+    (doc/"span[@id='red2']").text.strip.should eql "hello2"
+  end   
+end

data/spec/unless_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'nokogiri'
+
+describe Renshi::Parser do      
+  it "should evaluate r:unless(false)" do
+    doc = Nokogiri::HTML("<span id='red' r:unless='false'>hello</span>")
+    compiled = Renshi::Parser.parse(doc.root.to_s)
+    out = eval(compiled, binding)
+   (doc/"span[@id='red']").text.strip.should eql "hello"
+  end   
+end

data/spec/xml_entities_in_expressions_spec.rb

@@ -10,4 +10,18 @@ describe Renshi::Parser do
     (doc/"div[@id='content0']").text.strip.should =~ /hello0/
     (doc/"div[@id='content1']").text.strip.should =~ /hello1/
   end   
+  
+  it "should evaluate r:if(foo < 2)" do
+    doc = Nokogiri::HTML("<span r:if='1 < 2'>hello</div>")
+    body = doc.root.children.first
+    node = body.children.first
+    eval(deliver_compiled(node), binding).should eql "hello"
+  end   
+  
+  it "should evaluate r:elsif(foo < 2)" do
+    doc = Nokogiri::HTML("<span r:if='false'/><span r:elsif='1 < 2'>hello</div>")
+    compiled = deliver_compiled(doc.root)
+    puts compiled
+    eval(compiled, binding).should eql "hello"
+  end   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: renshi
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Nicholas Faiz
@@ -33,10 +33,12 @@ extra_rdoc_files:
 files: 
 - lib/renshi
 - lib/renshi/attribute_expressions
+- lib/renshi/attribute_expressions/each.rb
 - lib/renshi/attribute_expressions/else.rb
 - lib/renshi/attribute_expressions/elsif.rb
 - lib/renshi/attribute_expressions/for.rb
 - lib/renshi/attribute_expressions/if.rb
+- lib/renshi/attribute_expressions/unless.rb
 - lib/renshi/attribute_expressions/while.rb
 - lib/renshi/attribute_expressions.rb
 - lib/renshi/frameworks
@@ -72,7 +74,7 @@ rubyforge_project:
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: Renshi is a lightweight XHTML template language, inspired by Python's Genshi and build on Nokogiri - http://nokogiri.rubyforge.org
+summary: Renshi is a lightweight XHTML template language, inspired by Python's Genshi and build on Nokogiri.
 test_files: 
 - spec/data
 - spec/data/attribute_values_parsed.ren
@@ -86,6 +88,7 @@ test_files:
 - spec/data/while.ren
 - spec/data/while_lt.ren
 - spec/data/white_space.ren
+- spec/each_spec.rb
 - spec/else_spec.rb
 - spec/elsif_spec.rb
 - spec/for_spec.rb
@@ -95,5 +98,6 @@ test_files:
 - spec/renshi_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/unless_spec.rb
 - spec/while_spec.rb
 - spec/xml_entities_in_expressions_spec.rb