rblade 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a3fbdc85ee9754a8b3c184a389407a0df5e145f0f0613069386cc5ca488ac2c
-  data.tar.gz: 0f1c60eb458e89dfe8f57ce8e225b2a1ec643bf9a5f5c393d62cb96a4bf85970
+  metadata.gz: d795f1e81eb6dd60c3c581ccb22de43921bfab0997eb45daf6309298fb83fc5d
+  data.tar.gz: 2189078e98ad7ede598bc77c524bb1a88b396390098dc451565567e37532ba03
 SHA512:
-  metadata.gz: e309cedd41919e03dbd6b3db209cc5d0cef9cb2dc8c9308abf6de414ce87c4ef5b55157ef51fdd867cab03bac9773c08d36ec10868daa9e13b1914357b66e25e
-  data.tar.gz: fb16ec608debaf7cd0caf5c9b662969617b9fad57ebbe65e620c1ffcab2008218199f9472d3a6ba9a72433ea24457e5c24d6c4902f3ac2f9909f98cef8df1f6c
+  metadata.gz: a8206e2599b2cd9556e2ff9eb03a5789bd87aa73d2776edce7f35c02c1bde56497838d7dece88e05a986775df1a21371d2ef1adf37a7aef75ed6a442e5fe0c5a
+  data.tar.gz: e0b5eeaff73cc4530c70cd6c3f054b561948feaa4e845f31b29c496f465c2d73de6d822d4828b740b40ced23fd85658cbbfc5f5120fc2c564ae343bb2fc4b551

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-## 0.4.0
+## 0.5.0
+- Add support for slots
+- Change @props to only add valid variable names to global scope
+- Change @props to remove from attributes array
+
+## 0.4.0 [2024-07-29]
 - Add @class and @style statements
 - Add @env and @production statements
 - Add @once, @pushOnce and @prependOnce statements

data/README.md

@@ -31,9 +31,9 @@ Hello, {{ name }}.
 ```
 
 > [!NOTE]  
-> RBlade's `{{ }}` echo statements are automatically sent through Rails' `h` function to prevent XSS attacks.
+> RBlade's `{{ }}` print statements are automatically sent through Rails' `h` function to prevent XSS attacks.
 
-You are not limited to displaying the contents of the variables passed to the view. You may also print the results of any Ruby function. In fact, you can put any Ruby code you wish inside of a Blade echo statement:
+You are not limited to displaying the contents of the variables passed to the view. You may also print the results of any Ruby function. In fact, you can put any Ruby code you wish inside of a RBlade print directive:
 
 ```rblade
 The current UNIX timestamp is {{ Time.now.to_i }}.
@@ -77,7 +77,7 @@ The `@` symbol may also be used to escape RBlade directives:
 <a name="the-at-verbatim-directive"></a>
 #### The `@verbatim` Directive
 
-If you are displaying JavaScript variables in a large portion of your template, you may wrap the HTML in the `@verbatim` directive so that you do not have to prefix each Blade echo statement with an `@` symbol:
+If you are displaying JavaScript variables in a large portion of your template, you may wrap the HTML in the `@verbatim` directive so that you do not have to prefix each Blade print directive with an `@` symbol:
 
 ```rblade
 @verbatim
@@ -530,7 +530,7 @@ You can pass data to RBlade components using HTML attributes. Hard-coded strings
 
 #### Component Properties
 
-You can define a component's data properties using a `@props` statement at the top of the component. You can then reference these properties using local variables within the template:
+You can define a component's data properties using a `@props` directive at the top of the component. You can then reference these properties using local variables within the template:
 
 ```rblade
 {{-- alert.rblade --}}
@@ -538,25 +538,18 @@ You can define a component's data properties using a `@props` statement at the t
 <div class="{{ type }}">{{ message }}</div>
 ```
 
-The `@props` statement accepts a `Hash` where the key is the name of the attribute, and the value is the default value for the property. You can use the special `_required` value to represent a property with no default that must always be defined:
+The `@props` directive accepts a `Hash` where the key is the name of the attribute, and the value is the default value for the property. You can use the special `_required` value to represent a property with no default that must always be defined:
 
 ```rblade
 {{-- This will give an error because the alert component requires a message propery --}}
 <x-alert/>
 ```
 
-Kebab-case properties can be referenced using underscores in place of the dashes:
+All properties in the `@props` directive are automatically removed from `attributes`. Properties with names that aren't valid Ruby variable names or are Ruby reserved keywords are not created as local variables. However, you can reference them via the `attributes` local variable:
 
 ```rblade
-@props({"data-value": _required})
-<div>{{ data_value }}</div>
-```
-
-Properties that contain other non-alphanumeric characters or are Ruby reserved keywords are not created as local variables. However, you can reference them via the `attributes` local variable:
-
-```rblade
-@props({"for": _required})
-<div>{{ attributes[:for] }}</div>
+@props({"for": _required, "data-value": nil})
+<div>{{ attributes[:for] }} {{ attributes[:'data-value'] }}</div>
 ```
 
 <a name="short-attribute-syntax"></a>
@@ -774,11 +767,11 @@ We may pass content to the `slot` by injecting content into the component:
 </x-alert>
 ```
 
-**TODO this**  
 Sometimes a component may need to render multiple different slots in different locations within the component. Let's modify our alert component to allow for the injection of a "title" slot:
 
 ```rblade
 {{-- /app/views/components/alert.rblade --}}
+@props({title: _required})
 <span class="alert-title">{{ title }}</span>
 <div class="alert alert-danger">
     {{ slot }}
@@ -796,7 +789,7 @@ You may define the content of the named slot using the `x-slot` tag. Any content
     <strong>Whoops!</strong> Something went wrong!
 </x-alert>
 ```
-
+**TODO this**
 You may invoke a slot's `isEmpty` method to determine if the slot contains content:
 
 ```rblade

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/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.rb

@@ -6,6 +6,7 @@ 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)
 
@@ -19,6 +20,14 @@ 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)]

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/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/rails_template.rb

@@ -3,6 +3,7 @@ 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"
 

data/rblade.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "rblade"
-  s.version = "0.4.0"
+  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"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rblade
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Simon J
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-29 00:00:00.000000000 Z
+date: 2024-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -103,6 +103,8 @@ files:
 - lib/rblade/component_store.rb
 - lib/rblade/helpers/attributes_manager.rb
 - lib/rblade/helpers/class_manager.rb
+- lib/rblade/helpers/html_string.rb
+- lib/rblade/helpers/slot_manager.rb
 - lib/rblade/helpers/stack_manager.rb
 - lib/rblade/helpers/style_manager.rb
 - lib/rblade/helpers/tokenizer.rb