rblade 0.3.0 → 0.5.0

data/TODO.md

@@ -0,0 +1,2 @@
+Add @shouldRender? Or say you can use return (return _out) to exit early? @return? @exitComponent?
+

data/lib/rblade/compiler/compiles_components.rb

@@ -26,17 +26,16 @@ module RBlade
     private
 
     def compile_token_start token
-      @component_count += 1
-
-      @component_stack << {
+      component = {
         name: token.value[:name],
-        index: @component_count
+        index: @component_stack.count
       }
+      @component_stack << component
 
       attributes = compile_attributes token.value[:attributes]
 
-      code = "_c#{@component_count}_swap=_out;_out='';"
-      code << "_c#{@component_count}_attr={#{attributes.join(",")}};"
+      code = "_c#{component[:index]}_swap=_out;_out='';"
+      code << "_c#{component[:index]}_attr={#{attributes.join(",")}};"
 
       code
     end
@@ -50,15 +49,34 @@ module RBlade
         raise StandardError.new "Unexpected closing tag (#{token.value[:name]}) expecting #{component[:name]}"
       end
 
-      code = "_slot=_out;_out=_c#{component[:index]}_swap;"
-      code << "_out<<#{ComponentStore.component(component[:name])}(_slot,_c#{component[:index]}_attr);"
-      code << "_slot=nil;_c#{component[:index]}_swap=nil;"
+      namespace = nil
+      name = component[:name]
+      if name.match '::'
+        namespace, name = component[:name].split("::")
+      end
+
+      code = if namespace == 'slot'
+        compile_slot_end name, component
+      else
+        compile_component_end component
+      end
+    end
+
+    def compile_slot_end name, component
+      parent = @component_stack.last
+
+      code = "_c#{parent[:index]}_attr[:'#{RBlade.escape_quotes(name)}']=RBlade::SlotManager.new(_out,_c#{component[:index]}_attr);"
+      code << "_out=_c#{component[:index]}_swap;_c#{component[:index]}_swap=nil;_c#{component[:index]}_attr=nil;"
 
       code
     end
 
-    def get_method_name name
-      name.gsub(/[^a-zA-Z0-9_]/, "_")
+    def compile_component_end component
+      code = "_slot=RBlade::SlotManager.new(_out);_out=_c#{component[:index]}_swap;"
+      code << "_out<<#{ComponentStore.component(component[:name])}(_slot,_c#{component[:index]}_attr);"
+      code << "_slot=nil;_c#{component[:index]}_swap=nil;_c#{component[:index]}_attr=nil;"
+
+      code
     end
 
     def compile_attributes attributes

data/lib/rblade/compiler/compiles_echos.rb

@@ -8,8 +8,8 @@ module RBlade
     private
 
     def compile_regular_echos!(tokens)
-      compile_echos! tokens, "{{", "}}", "h"
-      compile_echos! tokens, "<%=", "%>", "h"
+      compile_echos! tokens, "{{", "}}", "RBlade.e"
+      compile_echos! tokens, "<%=", "%>", "RBlade.e"
     end
 
     def compile_unsafe_echos!(tokens)
@@ -35,8 +35,8 @@ module RBlade
             segments.delete_at i
             segments.delete_at i + 1
             segment_value = "_out<<"
-            # Special case for slot and attributes - we want this to be able to output HTML
-            segment_value <<= if !wrapper_function.nil? && segments[i] != "slot" && !segments[i].start_with?("attributes")
+
+            segment_value <<= if !wrapper_function.nil?
               wrapper_function + "(" + segments[i] + ");"
             else
               "(" + segments[i] + ").to_s;"

data/lib/rblade/compiler/compiles_ruby.rb

@@ -11,7 +11,7 @@ module RBlade
           # <%% and %%> are escape ERB style tags
           (<%%)(.+?)(%%>)
           |
-          (?:^|[\b\s])(@ruby)\s+(.+?)[\s;]*(@endruby)(?:$|[\b\s])
+          \s?(?<!\w)(@ruby)\s+(.+?)[\s;]*(@endruby)(?!\w)\s?
           |
           (<%)\s+(.+?)[\s;]*(%>)
         /xm)

data/lib/rblade/compiler/compiles_statements.rb

@@ -1,6 +1,8 @@
 require "rblade/compiler/statements/compiles_conditionals"
+require "rblade/compiler/statements/compiles_html_attributes"
 require "rblade/compiler/statements/compiles_inline_ruby"
 require "rblade/compiler/statements/compiles_loops"
+require "rblade/compiler/statements/compiles_once"
 require "rblade/compiler/statements/compiles_props"
 require "rblade/compiler/statements/compiles_stacks"
 
@@ -43,7 +45,7 @@ module RBlade
     private
 
     def getHandler(name)
-      handler_class, handler_method = @@statement_handlers[name]
+      handler_class, handler_method = @@statement_handlers[name.tr("_", "").downcase]
 
       if !handler_class&.method_defined?(handler_method)
         raise StandardError.new "Unhandled statement: @#{name}"
@@ -65,6 +67,7 @@ module RBlade
       "breakif" => [CompilesLoops, :compileBreakIf],
       "case" => [CompilesConditionals, :compileCase],
       "checked" => [CompilesConditionals, :compileChecked],
+      "class" => [CompilesHtmlAttributes, :compileClass],
       "disabled" => [CompilesConditionals, :compileDisabled],
       "else" => [CompilesConditionals, :compileElse],
       "elsif" => [CompilesConditionals, :compileElsif],
@@ -75,27 +78,38 @@ module RBlade
       "endcase" => [CompilesStatements, :compileEnd],
       "endeach" => [CompilesStatements, :compileEnd],
       "endeachelse" => [CompilesStatements, :compileEnd],
+      "endenv" => [CompilesStatements, :compileEnd],
       "endfor" => [CompilesStatements, :compileEnd],
       "endforelse" => [CompilesStatements, :compileEnd],
       "endif" => [CompilesStatements, :compileEnd],
+      "endonce" => [CompilesStatements, :compileEnd],
       "endprepend" => [CompilesStacks, :compileEndPrepend],
+      "endprependonce" => [CompilesOnce, :compileEndPrependOnce],
+      "endproduction" => [CompilesStatements, :compileEnd],
       "endpush" => [CompilesStacks, :compileEndPush],
+      "endpushonce" => [CompilesOnce, :compileEndPushOnce],
       "endunless" => [CompilesStatements, :compileEnd],
       "enduntil" => [CompilesStatements, :compileEnd],
       "endwhile" => [CompilesStatements, :compileEnd],
+      "env" => [CompilesConditionals, :compileEnv],
       "for" => [CompilesLoops, :compileFor],
       "forelse" => [CompilesLoops, :compileForElse],
       "if" => [CompilesConditionals, :compileIf],
       "next" => [CompilesLoops, :compileNext],
       "nextif" => [CompilesLoops, :compileNextIf],
+      "once" => [CompilesOnce, :compileOnce],
       "prepend" => [CompilesStacks, :compilePrepend],
+      "prependonce" => [CompilesOnce, :compilePrependOnce],
+      "production" => [CompilesConditionals, :compileProduction],
       "props" => [CompilesProps, :compileProps],
       "push" => [CompilesStacks, :compilePush],
+      "pushonce" => [CompilesOnce, :compilePushOnce],
       "readonly" => [CompilesConditionals, :compileReadonly],
       "required" => [CompilesConditionals, :compileRequired],
       "ruby" => [CompilesInlineRuby, :compile],
       "selected" => [CompilesConditionals, :compileSelected],
       "stack" => [CompilesStacks, :compileStack],
+      "style" => [CompilesHtmlAttributes, :compileStyle],
       "unless" => [CompilesConditionals, :compileUnless],
       "until" => [CompilesLoops, :compileUntil],
       "when" => [CompilesConditionals, :compileWhen],

data/lib/rblade/compiler/compiles_verbatim.rb

@@ -0,0 +1,29 @@
+module RBlade
+  class CompilesVerbatim
+    def compile!(tokens)
+      tokens.map! do |token|
+        next(token) if token.type != :unprocessed
+
+        segments = token.value.split(/\s?(?<!\w)(@verbatim)(?!\w)\s?(.+?)\s?(?<!\w)@end_?verbatim(?!\w)\s?/mi)
+
+        i = 0
+        while i < segments.count
+          if segments[i] == "@verbatim"
+            segments.delete_at i
+            segments[i] = Token.new(type: :raw_text, value: segments[i])
+
+            i += 1
+          elsif !segments[i].nil? && segments[i] != ""
+            segments[i] = Token.new(type: :unprocessed, value: segments[i])
+
+            i += 1
+          else
+            segments.delete_at i
+          end
+        end
+
+        segments
+      end.flatten!
+    end
+  end
+end

data/lib/rblade/compiler/statements/compiles_conditionals.rb

@@ -88,6 +88,32 @@ module RBlade
 
         "if #{args[0]};_out<<'selected';end;"
       end
+
+      def compileEnv args
+        if args&.count != 1
+          raise StandardError.new "Env statement: wrong number of arguments (given #{args&.count || 0}, expecting 1)"
+        end
+
+        environments = args[0].strip
+
+        "if Array.wrap(#{environments}).include?(Rails.env);"
+      end
+
+      def compileProduction args
+        unless args.nil?
+          raise StandardError.new "Production statement: wrong number of arguments (given #{args.count}, expecting 1)"
+        end
+
+        "if Rails.env.production?;"
+      end
+
+      def compileOnce args
+        if args&.count&.> 1
+          raise StandardError.new "Production statement: wrong number of arguments (given #{args.count}, expecting 0 or 1)"
+        end
+
+        args[0].nil? ? "" : args[0]
+      end
     end
   end
 end

data/lib/rblade/compiler/statements/compiles_html_attributes.rb

@@ -0,0 +1,21 @@
+module RBlade
+  class CompilesStatements
+    class CompilesHtmlAttributes
+      def compileClass args
+        if args&.count != 1
+          raise StandardError.new "Class statement: wrong number of arguments (given #{args&.count || 0}, expecting 1)"
+        end
+
+        "_out<<'class=\"'<<RBlade::ClassManager.new(#{args[0]})<<'\"';"
+      end
+
+      def compileStyle args
+        if args&.count != 1
+          raise StandardError.new "Style statement: wrong number of arguments (given #{args&.count || 0}, expecting 1)"
+        end
+
+        "_out<<'style=\"'<<RBlade::StyleManager.new(#{args[0]})<<'\"';"
+      end
+    end
+  end
+end

data/lib/rblade/compiler/statements/compiles_loops.rb

@@ -6,19 +6,15 @@ module RBlade
       end
 
       def compileBreak args
-        if !args.nil?
-          raise StandardError.new "Break statement: wrong number of arguments (given #{args&.count}, expecting 0)"
+        if args&.count&.> 1
+          raise StandardError.new "Break statement: wrong number of arguments (given #{args&.count}, expecting 0 or 1)"
         end
 
-        "break;"
-      end
-
-      def compileBreakIf args
-        if args&.count != 1
-          raise StandardError.new "Break statement: wrong number of arguments (given #{args&.count}, expecting 1)"
+        if args.nil?
+          "break;"
+        else
+          "if #{args[0]};break;end;"
         end
-
-        "if #{args[0]};break;end;"
       end
 
       def compileEach args
@@ -77,19 +73,7 @@ module RBlade
         if args.nil?
           "next;"
         else
-          "next #{args[0]};"
-        end
-      end
-
-      def compileNextIf args
-        if args.nil? || args.count > 2
-          raise StandardError.new "For statement: wrong number of arguments (given #{args&.count || 0}, expecting 1 or 2)"
-        end
-
-        if args.count == 1
           "if #{args[0]};next;end;"
-        else
-          "if #{args[0]};next #{args[1]};end;"
         end
       end
 

data/lib/rblade/compiler/statements/compiles_once.rb

@@ -0,0 +1,57 @@
+module RBlade
+  class CompilesStatements
+    class CompilesOnce
+      def initialize
+        @once_counter = 0
+      end
+
+      def compileOnce args
+        if args&.count&.> 1
+          raise StandardError.new "Once statement: wrong number of arguments (given #{args.count}, expecting 0 or 1)"
+        end
+
+        once_id = args.nil? ? ":_#{@once_counter += 1}" : args[0]
+
+        "unless $_once_tokens.include? #{once_id};$_once_tokens<<#{once_id};"
+      end
+
+      def compilePushOnce args
+        if args&.count != 1 && args&.count != 2
+          raise StandardError.new "Push once statement: wrong number of arguments (given #{args.count}, expecting 1 or 2)"
+        end
+        @once_counter += 1
+        once_id = args[1].nil? ? ":_#{@once_counter}" : args[1]
+
+        "unless $_once_tokens.include? #{once_id};$_once_tokens<<#{once_id};" \
+          << "_p1_#{@once_counter}=#{args[0]};_p1_#{@once_counter}_b=_out;_out='';"
+      end
+
+      def compileEndPushOnce args
+        if !args.nil?
+          raise StandardError.new "End push once statement: wrong number of arguments (given #{args&.count}, expecting 0)"
+        end
+
+        "RBlade::StackManager.push(_p1_#{@once_counter}, _out);_out=_p1_#{@once_counter}_b;end;"
+      end
+
+      def compilePrependOnce args
+        if args&.count != 1 && args&.count != 2
+          raise StandardError.new "Prepend once statement: wrong number of arguments (given #{args.count}, expecting 1 or 2)"
+        end
+        @once_counter += 1
+        once_id = args[1].nil? ? ":_#{@once_counter}" : args[1]
+
+        "unless $_once_tokens.include? #{once_id};$_once_tokens<<#{once_id};" \
+          << "_p1_#{@once_counter}=#{args[0]};_p1_#{@once_counter}_b=_out;_out='';"
+      end
+
+      def compileEndPrependOnce args
+        if !args.nil?
+          raise StandardError.new "End prepend once statement: wrong number of arguments (given #{args&.count}, expecting 0)"
+        end
+
+        "RBlade::StackManager.prepend(_p1_#{@once_counter}, _out);_out=_p1_#{@once_counter}_b;end;"
+      end
+    end
+  end
+end

data/lib/rblade/compiler/statements/compiles_props.rb

@@ -10,14 +10,23 @@ module RBlade
 
         props = extractProps args[0]
         props.map do |key, value|
+          compiled_code = ""
           if value == "_required"
-            "if !defined?(#{key})&&!attributes.has?(:'#{RBlade.escape_quotes(key)}');raise \"Props statement: #{key} is not defined\";end;#{key.sub(/[^a-zA-Z0-9_]/, "_")}=attributes.default(:'#{RBlade.escape_quotes(key)}');"
+            compiled_code << "if !attributes.has?(:'#{RBlade.escape_quotes(key)}');raise \"Props statement: #{key} is not defined\";end;"
+          end
+          if isValidVariableName key
+            compiled_code << "#{key}=attributes[:'#{RBlade.escape_quotes(key)}'].nil? ? #{value} : attributes[:'#{RBlade.escape_quotes(key)}'];"
+            compiled_code << "attributes.delete :'#{RBlade.escape_quotes(key)}';"
           else
-            "#{key.sub(/[^a-zA-Z0-9_]/, "_")}=attributes.default(:'#{RBlade.escape_quotes(key)}',#{value});"
+            compiled_code << "attributes.default(:'#{RBlade.escape_quotes(key)}', #{value});"
           end
+
+          compiled_code
         end.join
       end
 
+      private
+
       def extractProps prop_string
         if !prop_string.start_with?("{") || !prop_string.end_with?("}")
           raise StandardError.new "Props statement: expecting hash as parameter"
@@ -31,9 +40,9 @@ module RBlade
 
           key, value = prop.split(/^
             (?:
-              ('.+'):
+              '(.+)':
               |
-              (".+"):
+              "(.+)":
               |
               ([^ :]+):
               |
@@ -56,6 +65,16 @@ module RBlade
 
         props
       end
+
+      RUBY_RESERVED_KEYWORDS = %w[__FILE__ __LINE__ alias and begin BEGIN break case class def defined? do else elsif end END ensure false for if in module next nil not or redo rescue retry return self super then true undef unless until when while yield].freeze
+
+      def isValidVariableName key
+        return false unless key.match?(/^[a-zA-Z_][a-zA-Z0-9_]*$/)
+
+        return false if RUBY_RESERVED_KEYWORDS.include? key
+
+        true
+      end
     end
   end
 end

data/lib/rblade/compiler/statements/compiles_stacks.rb

@@ -23,7 +23,7 @@ module RBlade
         else
           @push_counter += 1
 
-          "_push_#{@push_counter}_name=#{args[0]};_push_#{@push_counter}_buffer=_out;_out='';"
+          "_p_#{@push_counter}=#{args[0]};_p_#{@push_counter}_b=_out;_out='';"
         end
       end
 
@@ -34,7 +34,7 @@ module RBlade
 
         @push_counter -= 1
 
-        "RBlade::StackManager.prepend(_push_#{@push_counter + 1}_name, _out);_out=_push_#{@push_counter + 1}_buffer;"
+        "RBlade::StackManager.prepend(_p_#{@push_counter + 1}, _out);_out=_p_#{@push_counter + 1}_b;"
       end
 
       def compilePush args
@@ -47,7 +47,7 @@ module RBlade
         else
           @push_counter += 1
 
-          "_push_#{@push_counter}_name=#{args[0]};_push_#{@push_counter}_buffer=_out;_out='';"
+          "_p_#{@push_counter}=#{args[0]};_p_#{@push_counter}_b=_out;_out='';"
         end
       end
 
@@ -58,7 +58,7 @@ module RBlade
 
         @push_counter -= 1
 
-        "RBlade::StackManager.push(_push_#{@push_counter + 1}_name, _out);_out=_push_#{@push_counter + 1}_buffer;"
+        "RBlade::StackManager.push(_p_#{@push_counter + 1}, _out);_out=_p_#{@push_counter + 1}_b;"
       end
     end
   end

data/lib/rblade/compiler/tokenizes_statements.rb

@@ -8,12 +8,23 @@ module RBlade
         next(token) if token.type != :unprocessed
 
         segments = token.value.split(/
-          (?:^|[\b\s])
-          (@@?)
-          (\w+(?:::\w+)?)
-          (?:[ \t]*
-            (\(.*?\))
-          )?/mx)
+          \s?(?<!\w)
+          (?:
+            (?:
+              (@@)
+              (\w+(?!\w))
+            )
+            |
+            (?:
+              (@)
+              (\w+(?!\w))
+              (?:[ \t]*
+                (\(.*?\))
+              )?
+            )
+          )
+          \s?
+        /mx)
 
         parseSegments! segments
       end.flatten!
@@ -35,11 +46,6 @@ module RBlade
         elsif segment == "@"
           tokenizeStatement! segments, i
 
-          # Remove trailing whitespace if it exists, but don't double dip when another statement follows
-          if !segments[i + 1].nil? && segments[i + 1].match(/^\s/) && (segments[i + 1].length > 1 || segments[i + 2].nil?)
-            segments[i + 1].slice! 0, 1
-          end
-
           i += 1
         elsif !segments[i].nil? && segments[i] != ""
           segments[i] = Token.new(type: :unprocessed, value: segments[i])

data/lib/rblade/compiler.rb

@@ -2,9 +2,11 @@ require "rblade/compiler/compiles_comments"
 require "rblade/compiler/compiles_components"
 require "rblade/compiler/compiles_echos"
 require "rblade/compiler/compiles_ruby"
+require "rblade/compiler/compiles_verbatim"
 require "rblade/compiler/compiles_statements"
 require "rblade/compiler/tokenizes_components"
 require "rblade/compiler/tokenizes_statements"
+require "rblade/helpers/html_string"
 
 Token = Struct.new(:type, :value)
 
@@ -18,10 +20,19 @@ module RBlade
     string.gsub(/['\\\x0]/, '\\\\\0')
   end
 
+  def self.e string
+    if string.is_a? HtmlString
+      string
+    else
+      h(string)
+    end
+  end
+
   class Compiler
     def self.compileString(string_template)
       tokens = [Token.new(:unprocessed, string_template)]
 
+      CompilesVerbatim.new.compile! tokens
       CompilesComments.new.compile! tokens
       CompilesRuby.new.compile! tokens
       TokenizesComponents.new.tokenize! tokens
@@ -36,8 +47,8 @@ module RBlade
     def self.compileAttributeString(string_template)
       tokens = [Token.new(:unprocessed, string_template)]
 
-      CompilesRuby.compile! tokens
       CompilesComments.compile!(tokens)
+      CompilesRuby.compile! tokens
       CompilesEchos.compile!(tokens)
 
       compileTokens tokens

data/lib/rblade/helpers/attributes_manager.rb

@@ -1,5 +1,7 @@
+require "rblade/helpers/html_string"
+
 module RBlade
-  class AttributesManager
+  class AttributesManager < HtmlString
     @attributes = {}
     def initialize attributes
       @attributes = attributes
@@ -33,6 +35,10 @@ module RBlade
       end.join " "
     end
 
+    def to_str
+      to_s
+    end
+
     def only(keys)
       keys = if keys.is_a? Array
         keys.map(&:to_sym)

data/lib/rblade/helpers/class_manager.rb

@@ -19,5 +19,9 @@ module RBlade
     def to_s
       @classes
     end
+
+    def to_str
+      to_s
+    end
   end
 end

data/lib/rblade/helpers/html_string.rb

@@ -0,0 +1,4 @@
+module RBlade
+  class HtmlString
+  end
+end

data/lib/rblade/helpers/slot_manager.rb

@@ -0,0 +1,23 @@
+require "rblade/helpers/attributes_manager"
+require "rblade/helpers/html_string"
+
+module RBlade
+  class SlotManager < HtmlString
+    def initialize content, attributes = nil
+      @content = content
+      @attributes = attributes && AttributesManager.new(attributes)
+    end
+
+    def to_s
+      @content
+    end
+
+    def to_str
+      to_s
+    end
+
+    def attributes
+      @attributes
+    end
+  end
+end

data/lib/rblade/helpers/stack_manager.rb

@@ -46,6 +46,10 @@ module RBlade
         "#{@before_stack}#{@prepends}#{@stack}"
       end
 
+      def to_str
+        to_s
+      end
+
       def push code
         @stack << code
       end

data/lib/rblade/helpers/style_manager.rb

@@ -33,5 +33,9 @@ module RBlade
     def to_s
       @styles
     end
+
+    def to_str
+      to_s
+    end
   end
 end

data/lib/rblade/rails_template.rb

@@ -3,25 +3,29 @@ require "rblade/compiler"
 require "rblade/component_store"
 require "rblade/helpers/attributes_manager"
 require "rblade/helpers/class_manager"
+require "rblade/helpers/slot_manager"
 require "rblade/helpers/stack_manager"
 require "rblade/helpers/style_manager"
 
 module RBlade
   class RailsTemplate
     def call(template, source = nil)
+      RBlade::ComponentStore.clear
+      RBlade::StackManager.clear
+
       unless template.nil?
         view_name = template.short_identifier
-          .delete_prefix('app/views/')
-          .delete_suffix('.rblade')
-          .delete_suffix('.html')
-          .tr('/', '.')
+          .delete_prefix("app/views/")
+          .delete_suffix(".rblade")
+          .delete_suffix(".html")
+          .tr("/", ".")
 
         # Let the component store know about the current view for relative components
         RBlade::ComponentStore.view_name(
           "view::#{view_name}"
         )
       end
-      setup = "_out='';_stacks=[];"
+      setup = "_out='';_stacks=[];$_once_tokens=[];"
       code = RBlade::Compiler.compileString(source || template.source)
       setdown = "RBlade::StackManager.get(_stacks) + _out"
       setup + ComponentStore.get + code + setdown

data/rblade.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name = "rblade"
-  s.version = "0.3.0"
-  s.summary = "Blade templates for ruby"
-  s.description = "A port of the Laravel blade templating engine to ruby"
+  s.version = "0.5.0"
+  s.summary = "A component-first templating engine for Rails"
+  s.description = "RBlade is a simple, yet powerful templating engine for Ruby on Rails, inspired by Laravel Blade."
   s.authors = ["Simon J"]
   s.email = "2857218+mwnciau@users.noreply.github.com"
   s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|storage)/}) }