rblade 1.0.5 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7334cbd159959066834b8d7407b4b8e0eb8af1aa57501fd3a3ea352b1a043058
-  data.tar.gz: 104b6b0f7abbf9aee1f35c6ca74ffedc0c771b5d0cfe32796e593ddc55730828
+  metadata.gz: 12abc58f2de63aabc65abf34fe60b17b63b8ba70141dbd16447d6d5b42b84a0a
+  data.tar.gz: 101e136868a7cbb2d5eb7ab2d117b90013999c1dcd544726fa9a0423a3b6566e
 SHA512:
-  metadata.gz: a9956d9b662c3bf264bdd9228087fdaf72ff51972427ae21eb1d33c10358fefcf4e0fcd1a8aa362a6df237d3cee51a3bf8d1831750b0b9e55f6e20709dcefb85
-  data.tar.gz: 6de71435e6f099b719b907ab9157eb117a6cd8cfd8c6854b657e533525e67d97b5e66b40ccb0aa97c91cc25fd3340897b0db75971383868e4eeaefd21ae3f44a
+  metadata.gz: 6a96e14502ccb338afc0779779f8d18901b9f8ea4ef90ba26e0142d24acc7f8a8cac85e290f3109a92b7d82c5752da795481084c733810dc3ffcfed97302a6c4
+  data.tar.gz: 0a17982fdb228fb5edaa308e9dbb2c58a16c9733d2bd5bbe89188a4bb1431940558be5904a41d02093fe9ae5346b631a98bcd2dd825fe72e47de390e85912343

data/.gitignore

@@ -1,2 +1,3 @@
 storage
 Gemfile.lock
+*.gem

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.1.1 [2024-08-23]
+- Remove requirement for including braces in `@props` directive
+
+## 1.1.0 [2024-08-23]
+- Add `@eachWithIndex` directive
+- Fix attribute manager output of attributes with no value (#10)
+
 ## 1.0.5 [2024-08-14]
 - Allow use of variables in @method directive
 

data/README.md

@@ -222,6 +222,16 @@ In addition to conditional statements, RBlade provides simple directives for wor
     <p>This is user {{ user.id }}</p>
 @endEach
 
+{{-- Compiles to users.each_with_index do |user, index| ... --}}
+@eachWithIndex (user, index in users)
+    <p>This is user {{ index }} {{ user.name }}</p>
+@endEachWithIndex
+
+{{-- eachWithIndex has a special case for Hashes: in this example, the result is "Item 1: a A" --}}
+@eachWithIndex (key, value, index  in {a: 'A'})
+    Item #{{ index + 1 }}: {{ key }} {{ value }}
+@endEachWithIndex
+
 @forElse (name in [])
     <li>{{ name }}</li>
 @empty
@@ -234,6 +244,12 @@ In addition to conditional statements, RBlade provides simple directives for wor
     <p>No users</p>
 @endEachElse
 
+@eachWithIndexElse (user, index in users)
+    <li>{{ index }}: {{ user.name }}</li>
+@empty
+    <p>No users</p>
+@endEachWithIndexElse
+
 @while (true)
     <p>I'm looping forever.</p>
 @endWhile
@@ -475,7 +491,7 @@ 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>
 ```
 
@@ -489,7 +505,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 +697,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 }}
@@ -736,10 +752,10 @@ Like RBlade components, you can assign additional [attributes](#component-attrib
 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({
+@props(
     "heading": required,
     "footer": required,
-})
+)
 
 <div {{ attributes.class('border') }}>
     <h1 {{ heading.attributes.class('text-lg') }}>
@@ -761,7 +777,7 @@ Sometimes, you may wish to return early from a component without printing anythi
 
 ```rblade
 {{-- components/error.rblade --}}
-@props({errors: []})
+@props(errors: [])
 @shouldRender(errors.present?)
 ...
 ```

data/REFERENCE.md

@@ -30,12 +30,13 @@ By default, RBlade will look for components in the `app/views/components` folder
 | `<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                           |
+| `@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                                                                                            |
+| `@shouldRender(RUBY_EXPRESSION)`                         | Only renders the component if RUBY_EXPRESSION evaluates to true                                                                            |
 
 <a name="quick-reference-attributes"></a>
 ## Attributes
@@ -75,19 +76,22 @@ The attributes variable is an instance of a class that manages attributes. As we
 <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                            |
+| 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                                                |
+| `@eachWithIndex( value, index in ['a', 'b'] ) ... @endEachWithIndex`               | Calls `each_with_index` on the given Array, with `\|value, index\|` as the block arguments                                  |
+| `@eachWithIndex( key, value, index in {a: 1} ) ... @endEachWithIndex`              | Calls `each_with_index` on the given Hash, where `key` is the Hash key, `value` is the Hash value, and `index` is the index |
+| `@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                  |
+| `@eachWithIndexElse( value, index in 1..10 ) ... @empty ... @endEachWithIndexElse` | Compiles to a each_with_index 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

data/lib/rblade/compiler/compiles_statements.rb

@@ -81,6 +81,8 @@ module RBlade
       "elsif" => [CompilesConditionals, :compileElsif],
       "each" => [CompilesLoops, :compileEach],
       "eachelse" => [CompilesLoops, :compileEachElse],
+      "eachwithindex" => [CompilesLoops, :compileEachWithIndex],
+      "eachwithindexelse" => [CompilesLoops, :compileEachWithIndexElse],
       "empty" => [CompilesLoops, :compileEmpty],
       "empty?" => [CompilesConditionals, :compileEmpty],
       "end" => [CompilesStatements, :compileEnd],

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

@@ -42,12 +42,12 @@ module RBlade
       private
 
       def extractProps prop_string
-        if !prop_string.start_with?("{") || !prop_string.end_with?("}")
-          raise StandardError.new "Props statement: expecting hash as parameter"
+        if prop_string.start_with?("{") && prop_string.end_with?("}")
+          prop_string = prop_string.delete_prefix("{").delete_suffix("}")
         end
 
         props = {}
-        prop_strings = Tokenizer.extractCommaSeparatedValues prop_string[1..-2]
+        prop_strings = Tokenizer.extractCommaSeparatedValues prop_string
 
         prop_strings.each do |prop|
           prop.strip!

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

@@ -19,27 +19,74 @@ module RBlade
 
       def compileEach 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 statement: wrong number of arguments (given #{args&.count || 0}, expecting 1 or 2)"
         end
-        # Allow variables to be a key, value pair
-        args = args.join ","
+        last_arg, collection = args.pop.split(" in ")
+        args.push(last_arg)
 
-        variables, collection = args.split(" in ")
+        if collection.nil?
+          raise StandardError.new "Each statement: collection not found (expecting 'in')"
+        end
 
-        "#{collection}.each do |#{variables}|;"
+        "#{collection}.each do |#{args.join(",")}|;"
+      end
+
+      def compileEachWithIndex args
+        if args.nil? || args.count > 3
+          raise StandardError.new "Each with index statement: wrong number of arguments (given #{args&.count || 0}, expecting 1 to 3)"
+        end
+        last_arg, collection = args.pop.split(" in ")
+        args.push(last_arg)
+
+        if collection.nil?
+          raise StandardError.new "Each with index statement: collection not found (expecting 'in')"
+        end
+
+        # Special case for 3 arguments: the first 2 arguments are the key/value pair in a Hash, and
+        # the third is the index
+        if args.count == 3
+          "#{collection}.each_with_index do |_ivar,#{args[2]}|;#{args[0]},#{args[1]}=_ivar;"
+        else
+          "#{collection}.each_with_index do |#{args.join(",")}|;"
+        end
       end
 
       def compileEachElse args
         if args.nil? || args.count > 2
           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 ","
+        last_arg, collection = args.pop.split(" in ")
+        args.push(last_arg)
+
+        if collection.nil?
+          raise StandardError.new "Each else statement: collection not found (expecting 'in')"
+        end
+
         @loop_else_counter += 1
 
-        variables, collection = args.split(" in ")
+        "_looped_#{@loop_else_counter}=false;#{collection}.each do |#{args.join(",")}|;_looped_#{@loop_else_counter}=true;"
+      end
+
+      def compileEachWithIndexElse args
+        if args.nil? || args.count > 3
+          raise StandardError.new "Each with index statement: wrong number of arguments (given #{args&.count || 0}, expecting 1 to 3)"
+        end
+        last_arg, collection = args.pop.split(" in ")
+        args.push(last_arg)
+
+        if collection.nil?
+          raise StandardError.new "Each with index statement: collection not found (expecting 'in')"
+        end
+
+        @loop_else_counter += 1
 
-        "_looped_#{@loop_else_counter}=false;#{collection}.each do |#{variables}|;_looped_#{@loop_else_counter}=true;"
+        # Special case for 3 arguments: the first 2 arguments are the key/value pair in a Hash, and
+        # the third is the index
+        if args.count == 3
+          "_looped_#{@loop_else_counter}=false;#{collection}.each_with_index do |_ivar,#{args[2]}|;#{args[0]},#{args[1]}=_ivar;_looped_#{@loop_else_counter}=true;"
+        else
+          "_looped_#{@loop_else_counter}=false;#{collection}.each_with_index do |#{args.join(",")}|;_looped_#{@loop_else_counter}=true;"
+        end
       end
 
       def compileFor args

data/lib/rblade/helpers/attributes_manager.rb

@@ -37,7 +37,7 @@ module RBlade
       attributes ||= @attributes
 
       attributes.map do |key, value|
-        "#{key}=\"#{(value == true) ? key : h(value)}\""
+        (value == true) ? key : "#{key}=\"#{h(value)}\""
       end.join " "
     end
 

data/rblade.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "rblade"
-  s.version = "1.0.5"
+  s.version = "1.1.1"
   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: 1.0.5
+  version: 1.1.1
 platform: ruby
 authors:
 - Simon J
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-14 00:00:00.000000000 Z
+date: 2024-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -140,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: A component-first templating engine for Rails