rblade 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76b47c51f5796359252d33fe3865bb7189cd4de068579fee57520c881879755d
-  data.tar.gz: ba1288cd0382290deb526f4faf4c5fe7c15d78372fca5248d41b4861f1ac6abb
+  metadata.gz: 80db67de9379396f85ba9450898e55f81b563cb1ca1ace73080719ad555455da
+  data.tar.gz: 9cc81c55f3893fbe1628dbe29c0d1dae16bdd65a789451e7f79ca6221e857488
 SHA512:
-  metadata.gz: 4783a57cbe6b7f2173f0435b2024ed3c83dff68819637d2eb759addd7ca485fd7b6d3c89987c8a07ff2561bded344037161bbb67b7bbc8147575e9adc568ce1d
-  data.tar.gz: 91f27168157d7448e7e26979a4dc60a731a6471027a8c5ddceb5ac4e23d51f3b39de0d61a2ba1970ec58bc726ccdb3316ed5e6389c463b63c61dd358e8e64f2f
+  metadata.gz: 50092cc06cf7104210d23a47044f9ce7de728812e2c561120d59434480f6fb7cc5ca4e1ef299d3a7bf7368af45ffe8b113299c744eb14679e9a2572d4923610c
+  data.tar.gz: fa8797d09d7621f8122b8460c634e94e6db39ae6940a909e516ee20ef7d2ef1ab9963c2f549aff2a0a002a76899fc79fd5ff8e9b2bceb862364417c3a01af05f

data/CHANGELOG.md

@@ -1,4 +1,11 @@
-## 1.0.0 [UNRELEASED]
+## 1.0.2 [2024-08-09]
+- Fix non-string `@props` defaults being converted to slots
+
+## 1.0.1 [2024-08-09]
+- Automatically detect when properties are used as slots
+- Change `_required` to `required` in @props
+
+## 1.0.0 [2024-08-06]
 - Add quick reference and examples
 - Add @shouldRender directive
 - Add support for ERB style `<%==` unsafe prints

data/README.md

@@ -5,11 +5,25 @@ RBlade is a simple, yet powerful templating engine for Ruby on Rails, inspired b
 
 RBlade template files use the `.rblade` file extension and are typically stored in the `app/views` directory.
 
-<a name="displaying-data"></a>
+
+<a name="getting-started"></a>
+## Getting Started
+
+Add RBlade to your Rails project by adding it to your Gemfile:
+
+```
+bundle add rblade
+```
+
+RBlade will automatically be detected and start parsing templates ending in `.rblade`.
+
+For a quick overview of RBlade's capabilities, refer to the [reference file](REFERENCE.md) or take a look at the [examples](examples/).
+
+<a name="table-of-contents"></a>
 ## Table of Contents
 - [RBlade Templates](#rblade-templates)
-  * [Table of Contents](#table-of-contents)
   * [Getting Started](#getting-started)
+  * [Table of Contents](#table-of-contents)
   * [Displaying Data](#displaying-data)
     + [HTML Entity Encoding](#html-entity-encoding)
     + [RBlade and JavaScript Frameworks](#rblade-and-javascript-frameworks)
@@ -45,20 +59,6 @@ RBlade template files use the `.rblade` file extension and are typically stored
     + [Method Field](#method-field)
   * [Stacks](#stacks)
 
-<a name="getting-started"></a>
-## Getting Started
-
-Add RBlade to your Rails project by adding it to your Gemfile:
-
-```
-bundle add rblade
-```
-
-RBlade will automatically be detected and start parsing templates ending in `.rblade`.
-
-For a quick overview of RBlade's capabilities, refer to the [reference file](REFERENCE.md) or take a look at the [examples](examples/README.md).
-
-
 <a name="displaying-data"></a>
 ## Displaying Data
 
@@ -475,11 +475,11 @@ You can define a component's data properties using a `@props` directive at the t
 
 ```rblade
 {{-- alert.rblade --}}
-@props({type: "warning", message: _required})
+@props({type: "warning", message: required})
 <div class="{{ type }}">{{ message }}</div>
 ```
 
-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:
+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 --}}
@@ -489,7 +489,7 @@ The `@props` directive accepts a Hash where the key is the name of the attribute
 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({"for": _required, "data-value": nil})
+@props({"for": required, "data-value": nil})
 <div>{{ attributes[:for] }} {{ attributes[:'data-value'] }}</div>
 ```
 
@@ -681,7 +681,7 @@ Sometimes a component may need to render multiple different slots in different l
 
 ```rblade
 {{-- /app/views/components/alert.rblade --}}
-@props({title: _required})
+@props({title: required})
 <span class="alert-title">{{ title }}</span>
 <div class="alert alert-danger">
     {{ slot }}
@@ -737,8 +737,8 @@ To interact with slot attributes, you can access the `attributes` property of th
 
 ```rblade
 @props({
-    "heading": _required,
-    "footer": _required,
+    "heading": required,
+    "footer": required,
 })
 
 <div {{ attributes.class('border') }}>

data/REFERENCE.md

@@ -31,7 +31,7 @@ By default, RBlade will look for components in the `app/views/components` folder
 | `<x-name attribute/>`                                    | Pass an attribute to a component with value `true`                                                                                         |
 | `<x-name {{ attributes }}/>`                             | Pass attributes to a child component                                                                                                       |
 | `@props({header: "Header"})`                             | Remove `header` from the attributes Hash and introduce it as a local variable, using the specified value as a default                      |
-| `@props({header: _required})`                            | Remove `header` from the attributes Hash and introduce it as a local variable, raising an error if it is not set                           |
+| `@props({header: required})`                             | Remove `header` from the attributes Hash and introduce it as a local variable, raising an error if it is not set                           |
 | `{{ slot }}`                                             | Output the block content passed into the current component                                                                                 |
 | `<x-name><x-slot::header><h1>Header</h1><//>Content<//>` | Pass a named block to a component                                                                                                          |
 | `{{ header }}`                                           | Output the contents of a named block                                                                                                       |

data/examples/components/content/alert.rblade

@@ -1,4 +1,4 @@
-@props({alert: _required})
+@props({alert: required})
 @shouldRender(alert.present?)
 <p class="py-2 px-3 bg-amber-100 border border-amber-500">
   @@alert

data/examples/layouts/app.rblade

@@ -1,4 +1,4 @@
-@props({title: _required})
+@props({title: required})
 <!DOCTYPE html>
 <html lang="en">
   <head>

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

@@ -11,7 +11,7 @@ module RBlade
         "unless(#{args[0]});return'';end;"
       end
 
-      def compileProps args
+      def compileProps args, tokens
         if args&.count != 1
           raise StandardError.new "Props statement: wrong number of arguments (given #{args&.count || 0}, expecting 1)"
         end
@@ -19,14 +19,20 @@ module RBlade
         props = extractProps args[0]
         props.map do |key, value|
           compiled_code = ""
-          if value == "_required"
-            compiled_code << "if !attributes.has?(:'#{RBlade.escape_quotes(key)}');raise \"Props statement: #{key} is not defined\";end;"
-            compiled_code << "#{key}=attributes[:'#{RBlade.escape_quotes(key)}'];attributes.delete :'#{RBlade.escape_quotes(key)}';"
-          elsif 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)}';"
+
+          # `_required` is deprecated. Use `required`. To be removed in 2.0.0
+          compiled_code << if value == "_required" || value == "required"
+            "if !attributes.has?(:'#{RBlade.escape_quotes(key)}');raise \"Props statement: #{key} is not defined\";end;"
           else
-            compiled_code << "attributes.default(:'#{RBlade.escape_quotes(key)}', #{value});"
+            "attributes.default(:'#{RBlade.escape_quotes(key)}', #{value});"
+          end
+
+          if isValidVariableName key
+            compiled_code << if variableIsSlot key, tokens
+              "#{key}=RBlade::SlotManager.wrap(attributes.delete :'#{RBlade.escape_quotes(key)}');"
+            else
+              "#{key}=attributes.delete :'#{RBlade.escape_quotes(key)}';"
+            end
           end
 
           compiled_code
@@ -83,6 +89,11 @@ module RBlade
 
         true
       end
+
+      # Automatically detect if a variable is a slot by looking for "<var>.attributes"
+      def variableIsSlot name, tokens
+        tokens.any? { |token| token.value.to_s.match "#{name}.attributes" }
+      end
     end
   end
 end

data/lib/rblade/helpers/slot_manager.rb

@@ -24,6 +24,11 @@ module RBlade
       @content.respond_to?(method_name)
     end
 
+    # Wraps var in a slot manager if it's a string
+    def self.wrap var
+      var.is_a?(String) ? new(var) : var
+    end
+
     attr_reader :attributes
   end
 end

data/rblade.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "rblade"
-  s.version = "1.0.0"
+  s.version = "1.0.2"
   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"]
@@ -8,6 +8,7 @@ Gem::Specification.new do |s|
   s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|storage)/}) }
   s.require_paths = ["lib"]
   s.homepage = "https://rubygems.org/gems/rblade"
+  s.metadata = { "source_code_uri" => "https://github.com/mwnciau/rblade" }
   s.license = "MIT"
   s.required_ruby_version = ">= 3.0.0"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rblade
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Simon J
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-06 00:00:00.000000000 Z
+date: 2024-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -122,7 +122,8 @@ files:
 homepage: https://rubygems.org/gems/rblade
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/mwnciau/rblade
 post_install_message: 
 rdoc_options: []
 require_paths: