twig_ruby 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de30e1d0f458a7c5e2683f725036d8cf37e0fd09238bf14b7921d17af9f08998
-  data.tar.gz: bfdc53936b6dc8449c44269e5bb0b717c01e02597911266404550a805cbb34b8
+  metadata.gz: 4e727b10dc2226c2da43a9a2b8e1cd4a2e1b5a18ffb16eca116611b0d0f307cf
+  data.tar.gz: ef48d56a8bef43bd999cd17dc3def1371b58c12e4fba6c6bb143ba8b21dba6c4
 SHA512:
-  metadata.gz: 6554b109c0e00241e6a5dac0dfd4f8c36e78b50dcc45edff041ff9907cf02609d2abd4b5cdc326ca1ee92b12217ed83a8ba420c60afc65f790bb34567fbc9af9
-  data.tar.gz: 70bf08c22925adf25f6b469bc7afcad62bdd3b4ed45761dbca3cd4619b1a213dcf2a3d70c1595ae7958354b2527fde438b78763c72238281971dc35c2aeaba71
+  metadata.gz: 1cbec5dd395ca0c306ab6eee643aa5954e46cd3181985e55fac994a2eecbdc4473aaba91a344e9681ad1aa28be3e77980461da775a740e908ec2dbb2fdbf73dc
+  data.tar.gz: fa32c024631b8cb528fb35463422b09e8b461ed75c1ef440bc4ccd8268686d928bcad868a82b9f98d5621a1e99047b2c4949589d7d967de23bcdf4ebe2b192ad

data/README.md

@@ -2,11 +2,105 @@
 
 Implementation of [Twig](https://twig.symfony.com/) in Ruby.
 
+## Table of Contents
+
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Template Features](#template-features)
+  - [Filters](#filters)
+  - [Functions](#functions)
+  - [Tests](#tests)
+  - [Tags](#tags)
+- [Rails Integration](#rails-integration)
+- [Advanced Features](#advanced-features)
+- [Configuration](#configuration)
+- Advanced Docs
+  - [Loaders](doc/loaders.md)
+  - [Extensions](doc/extensions.md)
+
+## Installation
+
 ```bash
-bundle add twig-ruby
+bundle add twig_ruby
+```
+
+## Quick Start
+
+Here's a simple example to get you started:
+
+```ruby
+require 'twig_ruby'
+
+# Create a loader with your templates
+loader = Twig::Loader::Hash.new({
+  'hello.twig' => 'Hello {{ name }}!'
+})
+
+# Create environment and render
+environment = Twig::Environment.new(loader)
+template = environment.load('hello.twig')
+puts template.render({ name: "World" })
+# Output: Hello World!
+```
+
+Or from your file system:
+
+```ruby
+loader = Twig::Loader::Filesystem.new(__dir__, ['app/views'])
+```
+
+## Template Features
+
+Twig has the notion of Filters, Functions, and Tests
+
+### Filters
+
+Filters are used to modify variables.
+
+```twig
+{{ "hello"|capitalize }} {# Hello #}
+{{ ["Hello", "World"]|join(" ") }} {# Hello World #}
+```
+
+### Functions
+
+Functions are used to generate content.
+
+```twig
+{{ max([1, 2, 3]) }} {# 3 #}
+{{ include("other.twig") }} {# contents of other.twig #}
 ```
 
-## Rails
+### Tests
+
+Tests are used to evaluate variables.
+
+```twig
+{{ 2 is even ? 'yup' : 'nope' }} {# yup #}
+{{ ([1, 2, 3] has some n => n % 2 == 0) ? 'yup' : 'nope' }} {# yup #}
+```
+
+### Tags
+
+Tags are used to control the logic of the template.
+
+```twig
+{% if n > 1 %}
+  Some
+{% else %}
+  None
+{% endif %}
+```
+
+```twig
+<ul>
+  {% for i in [1, 2, 3] %}
+    <li>Item {{ i }}</li>
+  {% endfor %}
+</ul>
+```
+
+## Rails Integration
 
 This gem includes a Railtie that will automatically add your views folder and
 register a `:twig` template handler. Just simply create your views such as
@@ -22,7 +116,14 @@ register a `:twig` template handler. Just simply create your views such as
 {% endblock %}
 ```
 
-You should add `layout false` in your `ApplicationController`
+Since Twig supports layouts through template inheritance (which is more flexible than Rails layouts),
+you'll typically want to use Twig's inheritance system instead of Rails layouts. This allows you to:
+
+1. Create a base template with common structure
+2. Override specific blocks in child templates
+3. Nest layouts for more complex page structures
+
+To use Twig's inheritance instead of Rails layouts, disable Rails layouts in your controller:
 
 ```ruby
 class ApplicationController < ActionController::Base
@@ -30,20 +131,21 @@ class ApplicationController < ActionController::Base
 end
 ```
 
-## Rails Configuration
+## Configuration
 
 These are all the defaults. You only need this configuration if you plan to change anything. 
 
 ```ruby
 Rails.application.configure do
-  config.twig.root = ::Rails.root, # Used for default Filesystem Loader
-  config.twig.paths = %w[/ app/views/], # Used for default Filesystem Loader
-  config.twig.debug = ::Rails.env.development?,
-  config.twig.allow_helper_methods = true,
-  config.twig.cache = ::Rails.root.join('tmp/cache/twig').to_s,
-  config.twig.charset = 'UTF-8',
-  config.twig.strict_variables = true,
-  config.twig.auto_reload = nil,
+  config.twig.root = ::Rails.root # Used for default Filesystem Loader
+  config.twig.paths = %w[/ app/views/] # Used for default Filesystem Loader
+  config.twig.debug = ::Rails.env.development?
+  config.twig.allow_helper_methods = true
+  config.twig.cache = ::Rails.root.join('tmp/cache/twig').to_s
+  config.twig.charset = 'UTF-8'
+  config.twig.strict_variables = true
+  config.twig.autoescape = :name
+  config.twig.auto_reload = nil
   config.twig.loader = lambda do
     ::Twig::Loader::Filesystem.new(
       current.root,
@@ -66,7 +168,7 @@ end
 If you plan to create your own loader that loads templates from another source like the database, you can provide
 a different lamba in the config for initializing it. 
 
-## Additions
+## Advanced Features
 
 Twig Ruby supports symbols as Ruby does and can be used in places strings can as 
 hash keys, arguments, etc.
@@ -85,6 +187,14 @@ can be used with helpers like `form_with`
   {{ f.email_field(:email) }}
 {% endyield %}
 ```
+
+Rails helpers can also be called. Parenthesis is only required when passing arguments:
+
+```twig
+{{ stylesheet_link_tag(:app, "data-turbo-track": "reload") }}
+{{ javascript_importmap_tags }}
+```
+
 ### Cache Tag
 
 The way the `cache` tag works in Rails is that it captures output from the buffer that 
@@ -96,7 +206,7 @@ Using `{% yield cache() do %}` WILL NOT WORK CORRECTLY.
 ```twig
 {% cache(product) %}
   ...
-{% endyield %}
+{% endcache %}
 ```
 
 Macros can also use Ruby notation for default values:

data/lib/tasks/twig_parity.rake

@@ -150,7 +150,7 @@ class TwigFixture
       replace(template, replacements[:fixture]) + (' ' * index)
     end
 
-    loader = ::Twig::Loader::Array.new(gsub_templates)
+    loader = ::Twig::Loader::Hash.new(gsub_templates)
     environment = ::Twig::Environment.new(loader, {
       cache: false,
       strict_variables: true,

data/lib/twig/environment.rb

@@ -137,7 +137,7 @@ module Twig
              end
 
       chain_loader = Loader::Chain.new([
-        Loader::Array.new({ name => template }),
+        Loader::Hash.new({ name => template }),
         current = loader,
       ])
 

data/lib/twig/extension/core.rb

@@ -997,7 +997,7 @@ module Twig
           (object.respond_to?(:empty?) && object.empty?) ||
           (object.respond_to?(:length) && (object.length&.== 0)) || # rubocop:disable Style/ZeroLengthPredicate
           (object.respond_to?(:size) && (object.size&.== 0)) || # rubocop:disable Style/ZeroLengthPredicate
-          (object.respond_to?(:to_s) && (object.to_s&.== ''))
+          (object.respond_to?(:to_s) && (object.to_s == ''))
       end
 
       # @param [Environment] environment

data/lib/twig/loader/{array.rb → hash.rb}

@@ -2,7 +2,7 @@
 
 module Twig
   module Loader
-    class Array < Loader::Base
+    class Hash < Loader::Base
       # @param [Hash<String>] templates
       def initialize(templates)
         super()

data/lib/twig/node/expression/name.rb

@@ -30,13 +30,8 @@ module Twig
 
           compiler.add_debug_info(self)
 
-          if attributes[:name][0] == '@'
-            check = "context.call_context.instance_variable_defined?('#{name}')"
-            get = "context.call_context.instance_variable_get('#{name}')"
-          else
-            check = "context.key?(:#{name})"
-            get = "context[:#{name}]"
-          end
+          check = "context.has?(:#{name})"
+          get = "context.get(:#{name})"
 
           if define_test_enabled?
             if attributes[:always_defined] || SPECIAL_VARS.key?(name)

data/lib/twig/runtime/context.rb

@@ -52,6 +52,24 @@ module Twig
         self.class.new(other, call_context:, output_buffer:)
       end
 
+      def has?(name)
+        if name[0] == '@'
+          call_context.instance_variable_defined?(name)
+        else
+          key?(name) || call_context.respond_to?(name)
+        end
+      end
+
+      def get(name)
+        if name[0] == '@'
+          call_context.instance_variable_get(name)
+        elsif key?(name)
+          self[name]
+        elsif call_context.respond_to?(name)
+          call_context.send(name)
+        end
+      end
+
       def push_stack
         stack.push({ remove: [], replace: {} })
       end

data/lib/twig/token_parser/yield.rb

@@ -27,6 +27,16 @@ module Twig
         body = parser.subparse(method(:decide_yield_end), drop_needle: true)
         stream.expect(Token::BLOCK_END_TYPE)
 
+        # If it's a context variable, turn it into a helper method
+        # ex: {% yield turbo_frame_tag do %}
+        if expr.is_a?(Node::Expression::Variable::Context)
+          expr = Node::Expression::HelperMethod.new(
+            expr.attributes[:name],
+            Node::Nodes.new({}),
+            lineno
+          )
+        end
+
         Node::Yield.new(expr, body, arguments, lineno)
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twig_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Craig Blanchette
 - Fabian Potencier
 bindir: bin
 cert_chain: []
-date: 2025-07-23 00:00:00.000000000 Z
+date: 2025-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -84,10 +84,10 @@ files:
 - lib/twig/extension_set.rb
 - lib/twig/file_extension_escaping_strategy.rb
 - lib/twig/lexer.rb
-- lib/twig/loader/array.rb
 - lib/twig/loader/base.rb
 - lib/twig/loader/chain.rb
 - lib/twig/loader/filesystem.rb
+- lib/twig/loader/hash.rb
 - lib/twig/node/auto_escape.rb
 - lib/twig/node/base.rb
 - lib/twig/node/block.rb
@@ -220,7 +220,7 @@ files:
 - lib/twig_ruby.rb
 homepage: https://rubygems.org/gems/twig-ruby
 licenses:
-- MIT
+- BSD-3-Clause
 metadata:
   allowed_push_host: https://rubygems.org
   rubygems_mfa_required: 'true'