rblade 0.6.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b46e864d0ce53aee73ce1353a29f538c54954a4afeb988de4975b64076d5fe3c
-  data.tar.gz: 12a74fcc836959872de298418892c16b89ce5690d63cb1def6be4c7cadb6a51a
+  metadata.gz: 76b47c51f5796359252d33fe3865bb7189cd4de068579fee57520c881879755d
+  data.tar.gz: ba1288cd0382290deb526f4faf4c5fe7c15d78372fca5248d41b4861f1ac6abb
 SHA512:
-  metadata.gz: b824b61c6fc8d08f57f09de311d4b9d0dfcf2d236712eb5aa5664f27d2819083e66488518e9fa21eb6f8360f332e64676e2ee01f02979d08effdb746eddd1415
-  data.tar.gz: 3c47fc2906be91c9a908c022a57a3222366142479c2167173605e0d31db9bdceaf0bca10a7a58ae9273d0fff5999679c943b92af204f7cc0448ce1e48146fafd
+  metadata.gz: 4783a57cbe6b7f2173f0435b2024ed3c83dff68819637d2eb759addd7ca485fd7b6d3c89987c8a07ff2561bded344037161bbb67b7bbc8147575e9adc568ce1d
+  data.tar.gz: 91f27168157d7448e7e26979a4dc60a731a6471027a8c5ddceb5ac4e23d51f3b39de0d61a2ba1970ec58bc726ccdb3316ed5e6389c463b63c61dd358e8e64f2f

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 1.0.0 [UNRELEASED]
+- Add quick reference and examples
+- Add @shouldRender directive
+- Add support for ERB style `<%==` unsafe prints
+- Fix bugs with statement argument error handling
+- Remove deprecated "breakIf" and "nextIf" statements
+- Rename "echo" compilers to "print"
+- Update README
+
 ## 0.6.1 [2024-08-02]
 - Fix broken build
 
@@ -56,4 +65,4 @@
 - Add attributes, class and style manager
 
 ## 0.1.0 [2024-07-22]
-- Initial release
+- Initial release

data/README.md

@@ -1,10 +1,18 @@
+<a name="rblade-templates"></a>
 # RBlade Templates
 
+RBlade is a simple, yet powerful templating engine for Ruby on Rails, inspired by [Laravel Blade](https://laravel.com/docs/blade). Unlike other Rails templating engines, RBlade prioritises the use of components and partials within templates.
+
+RBlade template files use the `.rblade` file extension and are typically stored in the `app/views` directory.
+
+<a name="displaying-data"></a>
+## Table of Contents
 - [RBlade Templates](#rblade-templates)
-  * [Introduction](#introduction)
+  * [Table of Contents](#table-of-contents)
+  * [Getting Started](#getting-started)
   * [Displaying Data](#displaying-data)
     + [HTML Entity Encoding](#html-entity-encoding)
-    + [Blade and JavaScript Frameworks](#blade-and-javascript-frameworks)
+    + [RBlade and JavaScript Frameworks](#rblade-and-javascript-frameworks)
       - [The `@verbatim` Directive](#the-at-verbatim-directive)
   * [RBlade Directives](#rblade-directives)
     + [If Statements](#if-statements)
@@ -37,15 +45,24 @@
     + [Method Field](#method-field)
   * [Stacks](#stacks)
 
-<a name="introduction"></a>
-## Introduction
+<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).
 
-RBlade is a simple, yet powerful templating engine for Ruby on Rails, inspired by [Laravel Blade](https://laravel.com/docs/blade). Unlike some templating engines, RBlade does not restrict you from using plain Ruby code in your templates. Blade template files use the `.rblade` file extension and are typically stored in the `app/views` directory.
 
 <a name="displaying-data"></a>
 ## Displaying Data
 
-You may display data that is passed to your RBlade views by wrapping the variable in curly braces. For example, given the following controller method:
+You can display data that is passed to your RBlade views by wrapping the variable in curly braces. For example, given the following controller method:
 
 ```ruby
 def index
@@ -53,16 +70,16 @@ def index
 end
 ```
 
-You may display the contents of the `name` variable like so:
+You can display the contents of the `name` variable like so:
 
 ```rblade
 Hello, {{ name }}.
 ```
 
 > [!NOTE]  
-> RBlade's `{{ }}` print statements are automatically sent through Rails' `h` function to prevent XSS attacks.
+> RBlade's `{{ }}` print directives 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 RBlade print directive:
+You are not limited to displaying the contents of the variables passed to the view. You can 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 }}.
@@ -71,19 +88,19 @@ The current UNIX timestamp is {{ Time.now.to_i }}.
 <a name="html-entity-encoding"></a>
 ### HTML Entity Encoding
 
-By default, RBlade `{{ }}` statements are automatically sent through Rails' `h` function to prevent XSS attacks. If you do not want your data to be escaped, you may use the following syntax:
+By default, RBlade `{{ }}` directives are automatically sent through Rails' `h` function to prevent XSS attacks. If you do not want your data to be escaped, you can use the following syntax:
 
 ```rblade
 Hello, {!! name !!}.
 ```
 
 > [!WARNING]  
-> Be very careful when echoing content that is supplied by users of your application. You should typically use the escaped, double curly brace syntax to prevent XSS attacks when displaying user supplied data.
+> Be very careful when printing content that is supplied by users of your application. You should typically use the escaped, double curly brace syntax to prevent XSS attacks when displaying user supplied data.
 
-<a name="blade-and-javascript-frameworks"></a>
-### Blade and JavaScript Frameworks
+<a name="rblade-and-javascript-frameworks"></a>
+### RBlade and JavaScript Frameworks
 
-Since many JavaScript frameworks also use "curly" braces to indicate a given expression should be displayed in the browser, you may use the `@` symbol to inform the RBlade rendering engine an expression should remain untouched. For example:
+Since many JavaScript frameworks also use "curly" braces to indicate a given expression should be displayed in the browser, you can use the `@` symbol to inform the RBlade rendering engine an expression should remain untouched. For example:
 
 ```rblade
 <h1>Laravel</h1>
@@ -91,12 +108,12 @@ Since many JavaScript frameworks also use "curly" braces to indicate a given exp
 Hello, @{{ name }}.
 ```
 
-In this example, the `@` symbol will be removed by Blade; however, `{{ name }}` expression will remain untouched by the RBlade engine, allowing it to be rendered by your JavaScript framework.
+In this example, the `@` symbol will be removed by RBlade; however, `{{ name }}` expression will remain untouched by the RBlade engine, allowing it to be rendered by your JavaScript framework.
 
-The `@` symbol may also be used to escape RBlade directives:
+The `@` symbol can also be used to escape RBlade directives:
 
 ```rblade
-{{-- Blade template --}}
+{{-- RBlade template --}}
 @@if()
 
 <!-- HTML output -->
@@ -106,7 +123,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 print directive with an `@` symbol:
+If you are displaying JavaScript variables in a large portion of your template, you can wrap the HTML in the `@verbatim` directive so that you do not have to prefix each RBlade print directive with an `@` symbol:
 
 ```rblade
 @verbatim
@@ -116,18 +133,18 @@ If you are displaying JavaScript variables in a large portion of your template,
 @endverbatim
 ```
 
-<a name="blade-directives"></a>
+<a name="rblade-directives"></a>
 ## RBlade Directives
 
 In addition to template inheritance and displaying data, RBlade also provides convenient shortcuts for common Ruby control structures, such as conditional statements and loops. These shortcuts provide a very clean, terse way of working with Ruby control structures while also remaining familiar to their ruby counterparts.
 
 > [!NOTE]  
-> RBlade directives are case insensitive and ignore underscores, so depending on your preference, all of `@endif`, `@endIf` and `@end_if` are identical.
+> RBlade directives are case insensitive and ignore underscores, so depending on your preference, all of `@endIf`, `@endIf` and `@end_if` are identical.
 
 <a name="if-statements"></a>
 ### If Statements
 
-You may construct `if` statements using the `@if`, `@elseIf`, `@else`, `@endIf`, `@unless`, and `@endUnless` directives. These directives function identically to their Ruby counterparts:
+You can construct `if` statements using the `@if`, `@elseIf`, `@else`, `@endIf`, `@unless`, and `@endUnless` directives. These directives function identically to their Ruby counterparts:
 
 ```rblade
 @unless(records.nil?)
@@ -141,20 +158,20 @@ You may construct `if` statements using the `@if`, `@elseIf`, `@else`, `@endIf`,
 @endUnless
 ```
 
-In addition to the conditional directives above, the `@blank?`, `defined?`, `@empty?`, `@nil?` and `@present` directives may be used as convenient shortcuts:
+In addition to the conditional directives above, the `@blank?`, `defined?`, `@empty?`, `@nil?` and `@present` directives can be used as convenient shortcuts:
 
 ```rblade
 @present?(records)
     // records is defined and is not nil
 @else
-    // These directives are shortcuts to if statements so @else may be used
+    // Since these directives are compiled to if statements, you can also use the @else directive
 @endempty?
 ```
 
 <a name="environment-directives"></a>
 #### Environment Directives
 
-You may check if the application is running in the production environment using the `@production` directive:
+You can check if the application is running in the production environment using the `@production` directive:
 
 ```rblade
 @production
@@ -162,7 +179,7 @@ You may check if the application is running in the production environment using
 @endProduction
 ```
 
-Or, you may determine if the application is running in a specific environment using the `@env` directive:
+Or, you can determine if the application is running in a specific environment using the `@env` directive:
 
 ```rblade
 @env('staging')
@@ -238,7 +255,7 @@ for (user in users)
 @endFor
 ```
 
-You may also include the continuation or break condition within the directive declaration:
+You can also include the continuation or break condition within the directive declaration:
 
 ```rblade
 @for (user in users)
@@ -253,7 +270,7 @@ You may also include the continuation or break condition within the directive de
 <a name="conditional-classes-and-styles"></a>
 ### Conditional Classes & Styles
 
-The `@class` directive conditionally adds CSS classes. The directive accepts a `Hash` of classes where the key contains the class or classes you wish to add, and the value is a boolean expression:
+The `@class` directive conditionally adds CSS classes. The directive accepts a Hash of classes where the key contains the class or classes you wish to add, and the value is a boolean expression:
 
 ```rblade
 @ruby
@@ -271,7 +288,7 @@ The `@class` directive conditionally adds CSS classes. The directive accepts a `
 <span class="p-4 text-gray-500 bg-red"></span>
 ```
 
-Likewise, the `@style` directive may be used to conditionally add inline CSS styles to an HTML element:
+Likewise, the `@style` directive can be used to conditionally add inline CSS styles to an HTML element:
 
 ```rblade
 @ruby
@@ -289,7 +306,7 @@ Likewise, the `@style` directive may be used to conditionally add inline CSS sty
 <a name="additional-attributes"></a>
 ### Additional Attributes
 
-For convenience, you may use the `@checked` directive to easily indicate if a given HTML checkbox input is "checked". This directive will print `checked` if the provided condition evaluates to `true`:
+For convenience, you can use the `@checked` directive to easily indicate if a given HTML checkbox input is "checked". This directive will print `checked` if the provided condition evaluates to `true`:
 
 ```rblade
 <input type="checkbox"
@@ -298,7 +315,7 @@ For convenience, you may use the `@checked` directive to easily indicate if a gi
   @checked(user.active)) />
 ```
 
-Likewise, the `@selected` directive may be used to indicate if a given select option should be "selected":
+Likewise, the `@selected` directive can be used to indicate if a given select option should be "selected":
 
 ```rblade
 <select name="version">
@@ -310,13 +327,13 @@ Likewise, the `@selected` directive may be used to indicate if a given select op
 </select>
 ```
 
-Additionally, the `@disabled` directive may be used to indicate if a given element should be "disabled":
+Additionally, the `@disabled` directive can be used to indicate if a given element should be "disabled":
 
 ```rblade
 <button type="submit" @disabled(isDisabled)>Submit</button>
 ```
 
-Moreover, the `@readonly` directive may be used to indicate if a given element should be "readonly":
+Moreover, the `@readonly` directive can be used to indicate if a given element should be "readonly":
 
 ```rblade
 <input type="email"
@@ -325,7 +342,7 @@ Moreover, the `@readonly` directive may be used to indicate if a given element s
   @readonly(!user.isAdmin) />
 ```
 
-In addition, the `@required` directive may be used to indicate if a given element should be "required":
+In addition, the `@required` directive can be used to indicate if a given element should be "required":
 
 ```rblade
 <input type="text"
@@ -337,7 +354,7 @@ In addition, the `@required` directive may be used to indicate if a given elemen
 <a name="the-once-directive"></a>
 ### The `@once` Directive
 
-The `@once` directive allows you to define a portion of the template that will only be evaluated once per rendering cycle. This may be useful for pushing a given piece of JavaScript into the page's header using [stacks](#stacks). For example, if you are rendering a given [component](#components) within a loop, you may wish to only push the JavaScript to the header the first time the component is rendered:
+The `@once` directive allows you to define a portion of the template that will only be evaluated once per rendering cycle. This can be useful for pushing a given piece of JavaScript into the page's header using [stacks](#stacks). For example, if you are rendering a given [component](#components) within a loop, you may wish to only push the JavaScript to the header the first time the component is rendered:
 
 ```rblade
 @once
@@ -402,7 +419,7 @@ Components are a way of including sub-views into your templates. To illustrate h
 
 First, we will create a new `alert.rblade` file in the `app/views/components/forms` directory. Templates in the `app/views/components` directory and its subdirectories are are automatically discovered as components, so no further registration is required. Both `.rblade` and `.html.rblade` are valid extensions for RBlade components.
 
-Once your component has been created, it may be rendered using its tag alias:
+Once your component has been created, it can be rendered using its tag alias:
 
 ```rblade
 <x-forms.alert/>
@@ -411,7 +428,7 @@ Once your component has been created, it may be rendered using its tag alias:
 <a name="rendering-components"></a>
 ### Rendering Components
 
-To display a component, you may use a Blade component tag within one of your Blade templates. Blade component tags start with the string `x-` followed by the kebab case name of the component class:
+To display a component, you can use a RBlade component tag within one of your RBlade templates. RBlade component tags start with the string `x-` followed by the kebab case name of the component class:
 
 ```rblade
 {{-- Render the `alert` component in app/views/components/ --}}
@@ -462,7 +479,7 @@ You can define a component's data properties using a `@props` directive at the t
 <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 --}}
@@ -479,7 +496,7 @@ All properties in the `@props` directive are automatically removed from `attribu
 <a name="short-attribute-syntax"></a>
 #### Short Attribute Syntax
 
-When passing attributes to components, you may also use a "short attribute" syntax. This is often convenient since attribute names frequently match the variable names they correspond to:
+When passing attributes to components, you can also use a "short attribute" syntax. This is often convenient since attribute names frequently match the variable names they correspond to:
 
 ```rblade
 {{-- Short attribute syntax... --}}
@@ -492,7 +509,7 @@ When passing attributes to components, you may also use a "short attribute" synt
 <a name="escaping-attribute-rendering"></a>
 #### Escaping Attribute Rendering
 
-Since some JavaScript frameworks such as Alpine.js also use colon-prefixed attributes, you may use a double colon (`::`) prefix to inform RBlade that the attribute is not a Ruby expression. For example, given the following component:
+Since some JavaScript frameworks such as Alpine.js also use colon-prefixed attributes, you can use a double colon (`::`) prefix to inform RBlade that the attribute is not a Ruby expression. For example, given the following component:
 
 ```rblade
 <x-button ::class="{ danger: isDeleting }">
@@ -511,13 +528,13 @@ The following HTML will be rendered by RBlade:
 <a name="component-attributes"></a>
 ### Component Attributes
 
-We've already examined how to pass data attributes to a component; however, sometimes you may need to specify additional HTML attributes, such as `class`, that are not part of the data required for a component to function. Typically, you want to pass these additional attributes down to the root element of the component template. For example, imagine we want to render an `alert` component like so:
+We've already examined how to pass data attributes to a component; however, sometimes you can need to specify additional HTML attributes, such as `class`, that are not part of the data required for a component to function. Typically, you want to pass these additional attributes down to the root element of the component template. For example, imagine we want to render an `alert` component like so:
 
 ```rblade
 <x-alert type="error" :message class="mt-4"/>
 ```
 
-All of the attributes that are not part of the component's constructor will automatically be added to the component's "attribute manager". This attribute manager is automatically made available to the component via the `attributes` variable. All of the attributes may be rendered within the component by printing this variable:
+All of the attributes that are not part of the component's constructor will automatically be added to the component's "attribute manager". This attribute manager is automatically made available to the component via the `attributes` variable. All of the attributes can be rendered within the component by printing this variable:
 
 ```rblade
 <div {{ attributes }}>
@@ -528,7 +545,7 @@ All of the attributes that are not part of the component's constructor will auto
 <a name="default-and-merged-attributes"></a>
 #### Default & Merged Attributes
 
-Sometimes you may need to specify default values for attributes or merge additional values into some of the component's attributes. To accomplish this, you may use the attribute manager's `merge` method. This method is particularly useful for defining a set of default CSS classes that should always be applied to a component:
+Sometimes you can need to specify default values for attributes or merge additional values into some of the component's attributes. To accomplish this, you can use the attribute manager's `merge` method. This method is particularly useful for defining a set of default CSS classes that should always be applied to a component:
 
 ```rblade
 <div {{ attributes.merge({"class": "alert alert-#{type}"}) }}>
@@ -606,19 +623,19 @@ If you need to merge other attributes onto your component, you can chain the `me
 
 The attributes manager is a wrapper around the Ruby Hash class. Unless explicitly overwritten, any methods called on the attributes manager will call that same method on the underlying Hash.
 
-You may filter attributes using the `filter` and `slice` methods. These methods call `filter` and `slice` on the underlying Hash and return a new attributes manager with the result.
+You can filter attributes using the `filter` and `slice` methods. These methods call `filter` and `slice` on the underlying Hash and return a new attributes manager with the result.
 
 ```rblade
 {{ attributes.filter { |k, v| k == 'foo'} }}
 {{ attributes.slice :foo }}
 ```
 
-If you would like to check if an attribute is present on the component, you may use the `has?` method. This method accepts the attribute name as its only argument and returns a boolean indicating whether or not the attribute is present:
+If you would like to check if an attribute is present on the component, you can use the `has?` method. This method accepts the attribute name as its only argument and returns a boolean indicating whether or not the attribute is present:
 
 ```rblade
 @if (attributes.has?(:class))
     <div>Class attribute is present</div>
-@endif
+@endIf
 ```
 
 If multiple parameters are passed to the `has?` method, the method will determine if all of the given attributes are present on the component:
@@ -626,15 +643,15 @@ If multiple parameters are passed to the `has?` method, the method will determin
 ```rblade
 @if (attributes.has?('name', 'class'))
     <div>All of the attributes are present</div>
-@endif
+@endIf
 ```
 
-The `has_any?` method may be used to determine if any of the given attributes are present on the component:
+The `has_any?` method can be used to determine if any of the given attributes are present on the component:
 
 ```rblade
 @if (attributes.has_any?('href', ':href', 'v-bind:href'))
     <div>One of the attributes is present</div>
-@endif
+@endIf
 ```
 
 <a name="slots"></a>
@@ -649,7 +666,7 @@ You will often need to pass additional content to your component via "slots". Th
 </div>
 ```
 
-We may pass content to the `slot` by injecting content into the component:
+We can pass content to the `slot` by injecting content into the component:
 
 ```rblade
 <x-alert>
@@ -657,6 +674,9 @@ We may pass content to the `slot` by injecting content into the component:
 </x-alert>
 ```
 
+> [!NOTE]  
+> You can instead use `<//>` as the closing tag of RBlade components; however, this will bypass some of the template sanity checking that the compiler performs.
+
 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
@@ -668,7 +688,7 @@ Sometimes a component may need to render multiple different slots in different l
 </div>
 ```
 
-You may define the content of the named slot using the `x-slot` tag. Any content not within an explicit `x-slot` tag will be passed to the component in the `slot` variable:
+You can define the content of the named slot using the `x-slot` tag. Any content not within an explicit `x-slot` tag will be passed to the component in the `slot` variable:
 
 ```xml
 <x-alert>
@@ -690,14 +710,14 @@ The slot object extends the String interface, so you can invoke a slot's `empty?
         This is default content if the slot is empty.
     @else
         {{ slot }}
-    @endif
+    @endIf
 </div>
 ```
 
 <a name="slot-attributes"></a>
 #### Slot Attributes
 
-Like RBlade components, you may assign additional [attributes](#component-attributes) to slots such as CSS class names:
+Like RBlade components, you can assign additional [attributes](#component-attributes) to slots such as CSS class names:
 
 ```xml
 <x-card class="shadow-sm">
@@ -713,7 +733,7 @@ Like RBlade components, you may assign additional [attributes](#component-attrib
 </x-card>
 ```
 
-To interact with slot attributes, you may access the `attributes` property of the slot's variable. For more information on how to interact with attributes, please consult the documentation on [component attributes](#component-attributes):
+To interact with slot attributes, you can access the `attributes` property of the slot's variable. For more information on how to interact with attributes, please consult the documentation on [component attributes](#component-attributes):
 
 ```rblade
 @props({
@@ -734,6 +754,18 @@ To interact with slot attributes, you may access the `attributes` property of th
 </div>
 ```
 
+<a name="conditional-rendering"></a>
+#### Conditional Rendering
+
+Sometimes, you may wish to return early from a component without printing anything. For example, if you make an error component and no errors are passed in as properties, you might want to skip rendering. You can use the `@shouldRender` directive anywhere within a component to prevent the component from being rendered:
+
+```rblade
+{{-- components/error.rblade --}}
+@props({errors: []})
+@shouldRender(errors.present?)
+...
+```
+
 <a name="registering-additional-component-directories"></a>
 ### Registering Additional Component Directories
 
@@ -822,7 +854,7 @@ RBlade allows you to push to named stacks which can be rendered elsewhere in ano
 @endPush
 ```
 
-If you would like to `@push` content if a given boolean expression evaluates to `true`, you may use the `@pushif` directive:
+If you would like to `@push` content if a given boolean expression evaluates to `true`, you can use the `@pushif` directive:
 
 ```rblade
 @pushIf(shouldPush, 'scripts')
@@ -830,7 +862,7 @@ If you would like to `@push` content if a given boolean expression evaluates to
 @endPushIf
 ```
 
-You may push to a stack as many times as needed. To render the complete stack contents, pass the name of the stack to the `@stack` directive:
+You can push to a stack as many times as needed. To render the complete stack contents, pass the name of the stack to the `@stack` directive:
 
 ```rblade
 <head>

data/REFERENCE.md

@@ -0,0 +1,138 @@
+<a name="quick-reference"></a>
+# Quick Reference
+
+A table below provides a quick overview of RBlade syntax and directives. The [readme](README.md) has a more in depth look at RBlade's capabilities.
+
+| Syntax                                                  | Description                                                                               |
+|:--------------------------------------------------------|:------------------------------------------------------------------------------------------|
+| `{{ RUBY_EXPRESSION }}`<br/>`<%= RUBY_EXPRESSION %>`    | Print the string value of the ruby expression, escaping HTML special characters           |
+| `{!! RUBY_EXPRESSION !!}`<br/>`<%== RUBY_EXPRESSION %>` | Print the string value of the ruby expression, _without_ escaping HTML special characters |
+| `@ruby( RUBY_EXPRESSION )`                              | Execute an inline ruby expression                                                         |
+| `@ruby ... @endRuby`                                    | Execute a block of ruby code                                                              |
+| `{{-- ... --}}`<br/>`<%# ... %>`                        | Comments, removed from the compiled template with no performance cost                     |
+| `@verbatim ... @endVerbatim`                            | Print the given content without parsing RBlade directives                                 |
+
+<a name="quick-reference-components"></a>
+## Components
+
+By default, RBlade will look for components in the `app/views/components` folder. Additionally, components in the `layout` namespace are found in the `app/views/layouts` folder, and components in the `view` namespace are found in the `app/views` folder.
+
+| Syntax                                                   | Description                                                                                                                                |
+|:---------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------|
+| `<x-component.name/>`                                    | Render the component found at `app/views/components/name{.rblade,.html.rblade}` or `app/views/components/name/index{.rblade,.html.rblade}` |
+| `<x-layout::name/>`                                      | Render the "name" component found in the "layout" namespace folder                                                                         |
+| `<x-component.name>...</x-component.name>`               | Render the component with the given slot content                                                                                           |
+| `<x-component.name>...<//>`                              | Short closing tag syntax (note: this bypasses some sanity checking during compilation)                                                     |
+| `<x-name attribute="STRING"/>`                           | Pass a string value to a component                                                                                                         |
+| `<x-name :attribute="RUBY_EXPRESSION"/>`                 | Pass a ruby expression, executed in the local scope, to a component                                                                        |
+| `<x-name :attribute/>`                                   | Pass the `attribute` local variable into a component                                                                                       |
+| `<x-name @class({'bg-red-600': is_error})/>`             | Conditionally pass classes to a component                                                                                                  |
+| `<x-name @style({'bg-red-600': is_error})/>`             | Conditionally pass styles to a component                                                                                                   |
+| `<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                           |
+| `{{ 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                                                                                                       |
+| `<div {{ header.attributes }}>`                          | Output the attributes passed into a named block                                                                                            |
+
+<a name="quick-reference-attributes"></a>
+## Attributes
+
+The attributes variable is an instance of a class that manages attributes. As well as the methods used in the examples below, you can use any method belonging to the Hash class.
+
+| Syntax                                                                   | Description                                                                                                |
+|:-------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------|
+| `<div {{ attributes }}>`                                                 | Print the contents of attributes as HTML attributes                                                        |
+| `<div {{ attributes.merge({class: "text-black", type: "button"}) }}>`    | Merge in additional attributes, combining the `:class` and `:style`, and setting defaults for other values |
+| `<div {{ attributes.except(['type']) }}>`                                | Output the attributes array excluding the given keys                                                       |
+| `<div {{ attributes.only(['type']) }}>`                                  | Output only the given keys of the attributes array                                                         |
+| `<div {{ attributes.filter { \|key, value\| key.start_with? "on:" } }}>` | Output the attributes for which the block returns true                                                     |
+| `<div @class({'bg-red-600': is_error})>`                                 | Conditionally print classes in an HTML class attribute                                                     |
+| `<div @style({'bg-red-600': is_error})>`                                 | Conditionally print styles in an HTML style attribute                                                      |
+
+<a name="quick-reference-conditions"></a>
+## Conditions
+
+| Syntax                                                                | Description                                                                                                        |
+|:----------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------|
+| `@if( RUBY_EXPRESSION ) ... @endIf`                                   | Compiles to a Ruby if statement                                                                                    |
+| `@if( RUBY_EXPRESSION ) ... @else ... @endIf`                         | Compiles to a Ruby if/else statement                                                                               |
+| `@if( RUBY_EXPRESSION ) ... @elsif( RUBY_EXPRESSION ) ... @endIf`     | Compiles to a Ruby if/elsif statement                                                                              |
+| `@unless( RUBY_EXPRESSION ) ... @endunless`                           | Compiles to a Ruby unless statement                                                                                |
+| `@case( RUBY_EXPRESSION ) @when(1) ... @when(2) ... @else ... @endIf` | Compiles to a Ruby case statement                                                                                  |
+| `@blank?( RUBY_EXPRESSION ) ... @endBlank?`                           | Compiles to a Ruby if statement that calls `blank?` method on the given expression                                 |
+| `@defined?( RUBY_EXPRESSION ) ... @endDefined?`                       | Compiles to a Ruby if statement that calls `defined?` function on the given expression                             |
+| `@empty?( RUBY_EXPRESSION ) ... @endEmpty?`                           | Compiles to a Ruby if statement that calls `empty?` method on the given expression                                 |
+| `@nil?( RUBY_EXPRESSION ) ... @endNil?`                               | Compiles to a Ruby if statement that calls `nil?` method on the given expression                                   |
+| `@present?( RUBY_EXPRESSION ) ... @endPresent?`                       | Compiles to a Ruby if statement that calls `present?` method on the given expression                               |
+| `@env(['development', 'test']) ... @endEnv`                           | Compiles to a Ruby if statement that checks if the current Rails environment matches any of the given environments |
+| `@production ... @endProduction`                                      | Shortcut for `@env('production')`                                                                                  |
+| `@once ... @endOnce`                                                  | Render the given block the first time it appears in the template                                                   |
+| `@once('unique key') ... @endOnce`                                    | Render the given block the first time "unique key" is used in the template                                         |
+
+<a name="quick-reference-loops"></a>
+## Loops
+
+| Syntax                                                | Description                                                                                                |
+|:------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------|
+| `@while( looping ) ... @endWhile`                     | Compiles to a Ruby while statement                                                                         |
+| `@until( finished ) ... @endUntil`                    | Compiles to a Ruby until statement                                                                         |
+| `@for( i in 1..10 ) ... @endFor`                      | Compiles to a Ruby for loop                                                                                |
+| `@each( i in 1..10 ) ... @endEach`                    | Calls `each` on the given collection, with `\|i\|` as the block argument                                   |
+| `@each( key, value in {a: 1} ) ... @endEach`          | Calls `each` on the given Hash, with `\|key, value\|` as the block arguments                               |
+| `@forElse( i in 1..10 ) ... @empty ... @endForElse`   | Compiles to a for loop as above, but the block after `@empty` is printed if the given collection is empty  |
+| `@eachElse( i in 1..10 ) ... @empty ... @endEachElse` | Compiles to a each loop as above, but the block after `@empty` is printed if the given collection is empty |
+| `@break`                                              | Break out of the current loop                                                                              |
+| `@next`                                               | Go to the next iteration in the current loop                                                               |
+| `@break( RUBY_EXPRESSION )`                           | Break out of the current loop if the expression evaluate to true                                           |
+| `@next( RUBY_EXPRESSION )`                            | Go to the next iteration in the current loop if the expression evaluate to true                            |
+
+<a name="quick-reference-forms"></a>
+## Forms
+
+| Syntax                           | Description                                                                                                      |
+|:---------------------------------|:-----------------------------------------------------------------------------------------------------------------|
+| `@old(:email, user[:email])`     | Fetches `:email` from the params Hash, defaulting to the user's email if it doesn't exist                        |
+| `@method('PATCH')`               | Prints a hidden input setting the HTTP request type to the given value using the Rails MethodOverride middleware |
+| `@DELETE`                        | Shortcut for `@method('DELETE')`                                                                                 |
+| `@PATCH`                         | Shortcut for `@method('PATCH')`                                                                                  |
+| `@PUT`                           | Shortcut for `@method('PUT')`                                                                                    |
+| `@checked( RUBY_EXPRESSION )`    | Prints "checked" if the ruby expression evaluates to true                                                        |
+| `@disabled( RUBY_EXPRESSION )`   | Prints "disabled" if the ruby expression evaluates to true                                                       |
+| `@readonly( RUBY_EXPRESSION )`   | Prints "readonly" if the ruby expression evaluates to true                                                       |
+| `@required( RUBY_EXPRESSION )`   | Prints "required" if the ruby expression evaluates to true                                                       |
+| `@selected( RUBY_EXPRESSION )`   | Prints "selected" if the ruby expression evaluates to true                                                       |
+
+<a name="quick-reference-stacks"></a>
+## Stacks
+
+Stacks are a way of rendering content outside of the usual document order. For example, you could define a "sidebar" stack, then you'd be able to add content to that sidebar from anywhere else in the site.
+
+Note that the stack is printed once the current view or component finishes. 
+
+| Syntax                                                      | Description                                                                                 |
+|:------------------------------------------------------------|:--------------------------------------------------------------------------------------------|
+| `@stack('scripts')`                                         | Start a stack with the name 'scripts'. Stacks can be pushed to elsewhere in the code.       |
+| `@push('scripts') ... @endPush`                             | Add block content to the 'scripts' stack                                                    |
+| `@prepend('scripts') ... @endPrepend`                       | Add block content to the start of the 'scripts' stack                                       |
+| `@pushIf(RUBY_EXPRESSION, 'scripts') ... @endPushIf`        | Add block content to the 'scripts' stack if the expression evaluate to true                 |
+| `@prependIf(RUBY_EXPRESSION, 'scripts') ... @endprependIf`  | Add block content to the start of the 'scripts' stack if the expression evaluate to true    |
+| `@pushOnce('scripts') ... @endPushOnce`                     | Add block content to the 'scripts' stack only once                                          |
+| `@prependOnce('scripts') ... @endPrependOnce`               | Add block content to the start of the 'scripts' stack only once                             |
+| `@pushOnce('scripts', 'unique key') ... @endPushOnce`       | Add block content to the 'scripts' stack the first time "unique key" is pushed              |
+| `@prependOnce('scripts', 'unique key') ... @endPrependOnce` | Add block content to the start of the 'scripts' stack the first time "unique key" is pushed |
+
+## Tips
+
+* Except for `@push`, `@prepend` and their variants, all end directives can simply be replaced with `@end` if preferred:
+    -  `@nil?(...) ... @endnil?`
+    -  `@nil?(...) ... @endnil`
+    -  `@nil?(...) ... @end`
+* Except for `@ruby` and `@verbatim`, directives are case insensitive and can contain underscores. The following are identical:
+    - `@pushonce`
+    - `@pushOnce`
+    - `@PushOnce` 
+    - `@push_once` 
+    - `@PUSHONCE` 

data/examples/README.md

@@ -0,0 +1,3 @@
+# RBlade Examples
+
+This folder is structured like a Rails `app/views` folder and contains some examples of RBlade templates. 

data/examples/application/home.rblade

@@ -0,0 +1,23 @@
+@ruby
+# Typically these values would be set in the controller
+banner_image = 'banner.png'
+alert = nil
+@endruby
+<x-layout::app title="Home page">
+  <x-content.alert :alert/>
+  <x-content.alert alert="This is an alert"/>
+  <x-h1 blue>Welcome to the home page!</x-h1>
+
+  <x-p class="mt-2">
+    Lorem ipsum dolor sit amet, consectetur adipisicing elit. Alias amet architecto, at commodi consectetur ipsa itaque magni minus neque nostrum pariatur possimus recusandae sunt! Est explicabo praesentium quidem vero voluptatum!
+  </x-p>
+
+  @if (banner_image)
+    <x-content.hero class="mt-4">
+      <x-slot::heading class="text-blue-600">
+        Beatae placeat porro quibusdam repudiandae sunt?
+      </x-slot::heading>
+      Adipisci blanditiis, dolor dolorem, ea iste laudantium minima natus nesciunt nostrum odio perferendis praesentium quae, similique.
+    </x-content.hero>
+  @endif
+</x-layout::app>

data/examples/components/content/alert.rblade

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

data/examples/components/content/hero.rblade

@@ -0,0 +1,14 @@
+@props({heading: nil})
+@pushOnce('scripts')
+<script src="/js/hero.js"></script>
+@endPushOnce
+<div class="bg-blue-50 p-16">
+  <div class="max-w-96">
+    @if (heading)
+      <h2 {{ heading.attributes.merge({class: "text-lg font-bold"}) }}>
+        {{ heading }}
+      </h2>
+    @end
+    <p class="mt-4">{{ slot }}</p>
+  </div>
+</div>

data/examples/components/h1.rblade

@@ -0,0 +1,6 @@
+@props({blue: false})
+<h1 {{ attributes.merge({
+    class: "text-xl font-bold #{blue ? 'text-blue-700' : 'text-black'}"
+}) }}>
+  {{ slot }}
+</h1>

data/examples/components/p.rblade

@@ -0,0 +1,14 @@
+<p {{ attributes.merge({
+    class: "
+      text-base font-normal
+      {{--
+        The tailwindcss-unimportant plugin works well with component design:
+        the "-:" prefix allows the consumer of the component to easily override
+        the component classes and extend the component.
+        See: https://www.npmjs.com/package/tailwindcss-unimportant
+      --}}
+      -:mt-1
+    "
+}) }}>
+  {{ slot }}
+</p>

data/examples/layouts/app.rblade

@@ -0,0 +1,16 @@
+@props({title: _required})
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta http-equiv="X-UA-Compatible" content="ie=edge">
+    <title>{{ title }}</title>
+    <script src="https://cdn.tailwindcss.com"></script>
+    @stack('scripts')
+  </head>
+  <body>
+    <div {{ attributes.merge({class: "max-w-prose mt-8 mx-auto flex flex-col gap-4"}) }}>
+	  {{ slot }}
+  </body>
+</html>

data/lib/rblade/compiler/compiles_components.rb

@@ -51,11 +51,11 @@ module RBlade
 
       namespace = nil
       name = component[:name]
-      if name.match '::'
+      if name.match? "::"
         namespace, name = component[:name].split("::")
       end
 
-      code = if namespace == 'slot'
+      if namespace == "slot"
         compile_slot_end name, component
       else
         compile_component_end component

data/lib/rblade/compiler/{compiles_echos.rb → compiles_prints.rb}

@@ -1,22 +1,23 @@
 module RBlade
-  class CompilesEchos
+  class CompilesPrints
     def compile!(tokens)
-      compile_regular_echos!(tokens)
-      compile_unsafe_echos!(tokens)
+      compile_unsafe_prints!(tokens)
+      compile_regular_prints!(tokens)
     end
 
     private
 
-    def compile_regular_echos!(tokens)
-      compile_echos! tokens, "{{", "}}", "RBlade.e"
-      compile_echos! tokens, "<%=", "%>", "RBlade.e"
+    def compile_regular_prints!(tokens)
+      compile_prints! tokens, "{{", "}}", "RBlade.e"
+      compile_prints! tokens, "<%=", "%>", "RBlade.e"
     end
 
-    def compile_unsafe_echos!(tokens)
-      compile_echos! tokens, "{!!", "!!}"
+    def compile_unsafe_prints!(tokens)
+      compile_prints! tokens, "{!!", "!!}"
+      compile_prints! tokens, "<%==", "%>"
     end
 
-    def compile_echos!(tokens, start_token, end_token, wrapper_function = nil)
+    def compile_prints!(tokens, start_token, end_token, wrapper_function = nil)
       tokens.map! do |token|
         next(token) if token.type != :unprocessed
 
@@ -41,7 +42,7 @@ module RBlade
             else
               "(" + segments[i] + ").to_s;"
             end
-            segments[i] = Token.new(:echo, segment_value)
+            segments[i] = Token.new(:print, segment_value)
 
             i += 1
           elsif !segments[i].nil? && segments[i] != ""

data/lib/rblade/compiler/compiles_statements.rb

@@ -1,10 +1,10 @@
+require "rblade/compiler/statements/compiles_component_helpers"
 require "rblade/compiler/statements/compiles_conditionals"
 require "rblade/compiler/statements/compiles_form"
 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"
 
 module RBlade
@@ -71,7 +71,6 @@ module RBlade
     @@statement_handlers = {
       "blank?" => [CompilesConditionals, :compileBlank],
       "break" => [CompilesLoops, :compileBreak],
-      "breakif" => [CompilesLoops, :compileBreakIf],
       "case" => [CompilesConditionals, :compileCase],
       "checked" => [CompilesConditionals, :compileChecked],
       "class" => [CompilesHtmlAttributes, :compileClass],
@@ -97,7 +96,6 @@ module RBlade
       "if" => [CompilesConditionals, :compileIf],
       "method" => [CompilesForm, :compileMethod],
       "next" => [CompilesLoops, :compileNext],
-      "nextif" => [CompilesLoops, :compileNextIf],
       "nil?" => [CompilesConditionals, :compileNil],
       "old" => [CompilesForm, :compileOld],
       "once" => [CompilesOnce, :compileOnce],
@@ -107,7 +105,7 @@ module RBlade
       "prependonce" => [CompilesOnce, :compilePrependOnce],
       "present?" => [CompilesConditionals, :compilePresent],
       "production" => [CompilesConditionals, :compileProduction],
-      "props" => [CompilesProps, :compileProps],
+      "props" => [CompilesComponentHelpers, :compileProps],
       "push" => [CompilesStacks, :compilePush],
       "pushif" => [CompilesStacks, :compilePushIf],
       "pushonce" => [CompilesOnce, :compilePushOnce],
@@ -116,6 +114,7 @@ module RBlade
       "required" => [CompilesConditionals, :compileRequired],
       "ruby" => [CompilesInlineRuby, :compile],
       "selected" => [CompilesConditionals, :compileSelected],
+      "shouldrender" => [CompilesComponentHelpers, :compileShouldRender],
       "stack" => [CompilesStacks, :compileStack],
       "style" => [CompilesHtmlAttributes, :compileStyle],
       "unless" => [CompilesConditionals, :compileUnless],

data/lib/rblade/compiler/statements/{compiles_props.rb → compiles_component_helpers.rb}

@@ -2,10 +2,18 @@ require "rblade/helpers/tokenizer"
 
 module RBlade
   class CompilesStatements
-    class CompilesProps
+    class CompilesComponentHelpers
+      def compileShouldRender args
+        if args&.count != 1
+          raise StandardError.new "Should render statement: wrong number of arguments (given #{args&.count || 0}, expecting 1)"
+        end
+
+        "unless(#{args[0]});return'';end;"
+      end
+
       def compileProps args
-        if args.nil?
-          raise StandardError.new "Props statement: wrong number of arguments (given #{args&.count}, expecting 1)"
+        if args&.count != 1
+          raise StandardError.new "Props statement: wrong number of arguments (given #{args&.count || 0}, expecting 1)"
         end
 
         props = extractProps args[0]
@@ -13,8 +21,8 @@ module RBlade
           compiled_code = ""
           if value == "_required"
             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)}'];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)}';"
           else

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

@@ -58,8 +58,8 @@ module RBlade
       end
 
       def compileElse args
-        if !args.nil?
-          raise StandardError.new "Else statement: wrong number of arguments (given #{args&.count || 0}, expecting 0)"
+        unless args.nil?
+          raise StandardError.new "Else statement: wrong number of arguments (given #{args.count}, expecting 0)"
         end
 
         "else;"
@@ -82,8 +82,8 @@ module RBlade
       end
 
       def compileWhen args
-        if args.nil? || args.count == 0
-          raise StandardError.new "When statement: wrong number of arguments (given #{args&.count || 0}, expecting at least 1)"
+        if args.nil?
+          raise StandardError.new "When statement: wrong number of arguments (given 0, expecting at least 1)"
         end
 
         "when #{args.join ","};"
@@ -141,19 +141,11 @@ module RBlade
 
       def compileProduction args
         unless args.nil?
-          raise StandardError.new "Production statement: wrong number of arguments (given #{args.count}, expecting 1)"
+          raise StandardError.new "Production statement: wrong number of arguments (given #{args.count}, expecting 0)"
         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_form.rb

@@ -3,40 +3,40 @@ module RBlade
     class CompilesForm
       def compileMethod args
         if args&.count != 1
-          raise StandardError.new "Once statement: wrong number of arguments (given #{args&.count || 0}, expecting 1)"
+          raise StandardError.new "Method statement: wrong number of arguments (given #{args&.count || 0}, expecting 1)"
         end
-        method = RBlade.h(args[0].tr "\"'", "")
+        method = RBlade.h(args[0].tr("\"'", ""))
 
-        %[_out<<'<input type="hidden" name="_method" value="#{method}">';]
+        %(_out<<'<input type="hidden" name="_method" value="#{method}">';)
       end
 
       def compileDelete args
-        if !args.nil?
-          raise StandardError.new "Once statement: wrong number of arguments (given #{args.count}, expecting 0)"
+        unless args.nil?
+          raise StandardError.new "Delete statement: wrong number of arguments (given #{args.count}, expecting 0)"
         end
 
-        compileMethod(['DELETE'])
+        compileMethod(["DELETE"])
       end
 
       def compilePatch args
-        if !args.nil?
-          raise StandardError.new "Once statement: wrong number of arguments (given #{args.count}, expecting 0)"
+        unless args.nil?
+          raise StandardError.new "Patch statement: wrong number of arguments (given #{args.count}, expecting 0)"
         end
 
-        compileMethod(['PATCH'])
+        compileMethod(["PATCH"])
       end
 
       def compilePut args
-        if !args.nil?
-          raise StandardError.new "Once statement: wrong number of arguments (given #{args.count}, expecting 0)"
+        unless args.nil?
+          raise StandardError.new "Put statement: wrong number of arguments (given #{args.count}, expecting 0)"
         end
 
-        compileMethod(['PUT'])
+        compileMethod(["PUT"])
       end
 
       def compileOld args
         if args.nil? || args.count > 2
-          raise StandardError.new "Once statement: wrong number of arguments (given #{args.count}, expecting 0)"
+          raise StandardError.new "Old statement: wrong number of arguments (given #{args&.count || 0}, expecting 1 or 2)"
         end
 
         default_value = args[1] || "''"

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

@@ -7,7 +7,7 @@ module RBlade
 
       def compileBreak args
         if args&.count&.> 1
-          raise StandardError.new "Break statement: wrong number of arguments (given #{args&.count}, expecting 0 or 1)"
+          raise StandardError.new "Break statement: wrong number of arguments (given #{args.count}, expecting 0 or 1)"
         end
 
         if args.nil?
@@ -31,7 +31,7 @@ module RBlade
 
       def compileEachElse args
         if args.nil? || args.count > 2
-          raise StandardError.new "Each statement: wrong number of arguments (given #{args&.count || 0}, expecting 1)"
+          raise StandardError.new "Each else statement: wrong number of arguments (given #{args&.count || 0}, expecting 1)"
         end
         # Allow variables to be a key, value pair
         args = args.join ","
@@ -59,7 +59,11 @@ module RBlade
         "_looped_#{@loop_else_counter}=false;for #{args[0]};_looped_#{@loop_else_counter}=true;"
       end
 
-      def compileEmpty
+      def compileEmpty args
+        unless args.nil?
+          raise StandardError.new "Empty statement: wrong number of arguments (given #{args.count}, expecting 0)"
+        end
+
         @loop_else_counter -= 1
 
         "end;if !_looped_#{@loop_else_counter + 1};"
@@ -67,7 +71,7 @@ module RBlade
 
       def compileNext args
         if args&.count&.> 1
-          raise StandardError.new "For statement: wrong number of arguments (given #{args&.count || 0}, expecting 0 or 1)"
+          raise StandardError.new "Next statement: wrong number of arguments (given #{args.count}, expecting 0 or 1)"
         end
 
         if args.nil?

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

@@ -17,7 +17,7 @@ module RBlade
 
       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)"
+          raise StandardError.new "Push once statement: wrong number of arguments (given #{args&.count || 0}, expecting 1 or 2)"
         end
         @once_counter += 1
         once_id = args[1].nil? ? ":_#{@once_counter}" : args[1]
@@ -27,8 +27,8 @@ module RBlade
       end
 
       def compileEndPushOnce args
-        if !args.nil?
-          raise StandardError.new "End push once statement: wrong number of arguments (given #{args&.count}, expecting 0)"
+        unless 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;"
@@ -36,7 +36,7 @@ module RBlade
 
       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)"
+          raise StandardError.new "Prepend once statement: wrong number of arguments (given #{args&.count || 0}, expecting 1 or 2)"
         end
         @once_counter += 1
         once_id = args[1].nil? ? ":_#{@once_counter}" : args[1]
@@ -46,8 +46,8 @@ module RBlade
       end
 
       def compileEndPrependOnce args
-        if !args.nil?
-          raise StandardError.new "End prepend once statement: wrong number of arguments (given #{args&.count}, expecting 0)"
+        unless 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;"

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

@@ -7,7 +7,7 @@ module RBlade
 
       def compileStack args
         if args&.count != 1
-          raise StandardError.new "Stack statement: wrong number of arguments (given #{args&.count}, expecting 1)"
+          raise StandardError.new "Stack statement: wrong number of arguments (given #{args&.count || 0}, expecting 1)"
         end
 
         "RBlade::StackManager.initialize(#{args[0]}, _out);_stacks.push(#{args[0]});_out = '';"
@@ -15,7 +15,7 @@ module RBlade
 
       def compilePrepend args
         if args&.count != 1
-          raise StandardError.new "Prepend statement: wrong number of arguments (given #{args&.count}, expecting 1)"
+          raise StandardError.new "Prepend statement: wrong number of arguments (given #{args&.count || 0}, expecting 1)"
         end
 
         @push_counter += 1
@@ -24,7 +24,7 @@ module RBlade
       end
 
       def compileEndPrepend args
-        if !args.nil?
+        unless args.nil?
           raise StandardError.new "End prepend statement: wrong number of arguments (given #{args&.count}, expecting 0)"
         end
 
@@ -42,8 +42,8 @@ module RBlade
       end
 
       def compileEndPrependIf args
-        if !args.nil?
-          raise StandardError.new "End push if statement: wrong number of arguments (given #{args&.count}, expecting 0)"
+        unless args.nil?
+          raise StandardError.new "End prepend if statement: wrong number of arguments (given #{args.count}, expecting 0)"
         end
 
         "end;" + compileEndPush(nil)
@@ -61,15 +61,15 @@ module RBlade
 
       def compilePushIf args
         if args&.count != 2
-          raise StandardError.new "Push if statement: wrong number of arguments (given #{args&.count}, expecting 2)"
+          raise StandardError.new "Push if statement: wrong number of arguments (given #{args&.count || 0}, expecting 2)"
         end
 
         "if #{args[0]};" + compilePush([args[1]])
       end
 
       def compileEndPush args
-        if !args.nil?
-          raise StandardError.new "End push statement: wrong number of arguments (given #{args&.count}, expecting 0)"
+        unless args.nil?
+          raise StandardError.new "End push statement: wrong number of arguments (given #{args.count}, expecting 0)"
         end
 
         @push_counter -= 1
@@ -78,8 +78,8 @@ module RBlade
       end
 
       def compileEndPushIf args
-        if !args.nil?
-          raise StandardError.new "End push if statement: wrong number of arguments (given #{args&.count}, expecting 0)"
+        unless args.nil?
+          raise StandardError.new "End push if statement: wrong number of arguments (given #{args.count}, expecting 0)"
         end
 
         "end;" + compileEndPush(nil)

data/lib/rblade/compiler/tokenizes_statements.rb

@@ -79,7 +79,7 @@ module RBlade
       case segments[i][:value][:name]
       when "case"
         # Remove any whitespace before a when statement
-        until segments[i + 1].nil? || segments[i + 1] == '@'
+        until segments[i + 1].nil? || segments[i + 1] == "@"
           segments.delete_at i + 1
         end
       end

data/lib/rblade/compiler.rb

@@ -1,6 +1,6 @@
 require "rblade/compiler/compiles_comments"
 require "rblade/compiler/compiles_components"
-require "rblade/compiler/compiles_echos"
+require "rblade/compiler/compiles_prints"
 require "rblade/compiler/compiles_ruby"
 require "rblade/compiler/compiles_verbatim"
 require "rblade/compiler/compiles_statements"
@@ -37,7 +37,7 @@ module RBlade
       CompilesRuby.new.compile! tokens
       TokenizesComponents.new.tokenize! tokens
       TokenizesStatements.new.tokenize! tokens
-      CompilesEchos.new.compile! tokens
+      CompilesPrints.new.compile! tokens
       CompilesStatements.new.compile! tokens
       CompilesComponents.new.compile! tokens
 
@@ -49,7 +49,7 @@ module RBlade
 
       CompilesComments.compile!(tokens)
       CompilesRuby.compile! tokens
-      CompilesEchos.compile!(tokens)
+      CompilesPrints.compile!(tokens)
 
       compileTokens tokens
     end

data/lib/rblade/helpers/attributes_manager.rb

@@ -15,15 +15,17 @@ module RBlade
       @attributes[key]
     end
 
-    def has?(key)
-      !@attributes[key].nil?
+    def has?(*keys)
+      keys.map!(&:to_sym)
+
+      keys.all? { |key| @attributes.has_key? key }
     end
 
-    def method_missing(method, *, &block)
+    def method_missing(method, *, &)
       if [:select, :filter, :slice].include? method
-        AttributesManager.new @attributes.send(method, *, &block)
+        AttributesManager.new @attributes.send(method, *, &)
       else
-        @attributes.send(method, *, &block)
+        @attributes.send(method, *, &)
       end
     end
 
@@ -91,12 +93,6 @@ module RBlade
       AttributesManager.new new_attributes
     end
 
-    def has?(*keys)
-      keys.map!(&:to_sym)
-
-      keys.all? { |key| @attributes.has_key? key }
-    end
-
     def has_any?(*keys)
       keys.map!(&:to_sym)
 

data/lib/rblade/helpers/slot_manager.rb

@@ -24,8 +24,6 @@ module RBlade
       @content.respond_to?(method_name)
     end
 
-    def attributes
-      @attributes
-    end
+    attr_reader :attributes
   end
 end

data/rblade.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "rblade"
-  s.version = "0.6.1"
+  s.version = "1.0.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.6.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Simon J
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-02 00:00:00.000000000 Z
+date: 2024-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -79,24 +79,32 @@ files:
 - Gemfile
 - LICENSE.md
 - README.md
+- REFERENCE.md
 - Rakefile
 - do
 - docker-compose.yml
+- examples/README.md
+- examples/application/home.rblade
+- examples/components/content/alert.rblade
+- examples/components/content/hero.rblade
+- examples/components/h1.rblade
+- examples/components/p.rblade
+- examples/layouts/app.rblade
 - lib/rblade.rb
 - lib/rblade/compiler.rb
 - lib/rblade/compiler/compiles_comments.rb
 - lib/rblade/compiler/compiles_components.rb
-- lib/rblade/compiler/compiles_echos.rb
+- lib/rblade/compiler/compiles_prints.rb
 - lib/rblade/compiler/compiles_ruby.rb
 - lib/rblade/compiler/compiles_statements.rb
 - lib/rblade/compiler/compiles_verbatim.rb
+- lib/rblade/compiler/statements/compiles_component_helpers.rb
 - lib/rblade/compiler/statements/compiles_conditionals.rb
 - lib/rblade/compiler/statements/compiles_form.rb
 - lib/rblade/compiler/statements/compiles_html_attributes.rb
 - lib/rblade/compiler/statements/compiles_inline_ruby.rb
 - lib/rblade/compiler/statements/compiles_loops.rb
 - lib/rblade/compiler/statements/compiles_once.rb
-- lib/rblade/compiler/statements/compiles_props.rb
 - lib/rblade/compiler/statements/compiles_stacks.rb
 - lib/rblade/compiler/tokenizes_components.rb
 - lib/rblade/compiler/tokenizes_statements.rb