twig_ruby 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31919ddaf84c7eb3ddbf272092cf86714ae8cc82daeaf3d9c1ea07a968a34957
-  data.tar.gz: 9e405d3820213e10efe310023576fa4d7fc10c8b132956cb86a1ce454e79568b
+  metadata.gz: de30e1d0f458a7c5e2683f725036d8cf37e0fd09238bf14b7921d17af9f08998
+  data.tar.gz: bfdc53936b6dc8449c44269e5bb0b717c01e02597911266404550a805cbb34b8
 SHA512:
-  metadata.gz: fe9835a8158b2f0c4e7e2147dc2055070b271539389715adfa9965eb131e052de3ce146b9677574e9005912e965c5f87f41da6a462ddc3e878e35854198df9cc
-  data.tar.gz: 291c349b4c7af42c23814a06bd4b12ddcb8182368bea8662ca0eb1bebafefb9ca2c61c100a255078b43d19e9a197f581a96ed3610f76cb68178be2a1eaffd65b
+  metadata.gz: 6554b109c0e00241e6a5dac0dfd4f8c36e78b50dcc45edff041ff9907cf02609d2abd4b5cdc326ca1ee92b12217ed83a8ba420c60afc65f790bb34567fbc9af9
+  data.tar.gz: 70bf08c22925adf25f6b469bc7afcad62bdd3b4ed45761dbca3cd4619b1a213dcf2a3d70c1595ae7958354b2527fde438b78763c72238281971dc35c2aeaba71

data/README.md

@@ -0,0 +1,116 @@
+# twig-ruby
+
+Implementation of [Twig](https://twig.symfony.com/) in Ruby.
+
+```bash
+bundle add twig-ruby
+```
+
+## Rails
+
+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
+`app/views/welcome/index.html.twig` and it will start rendering them.
+
+```twig
+{# welcome/index.html.twig #}
+
+{% extends 'base.html.twig' %}
+
+{% block body %}
+  Welcome to my site!
+{% endblock %}
+```
+
+You should add `layout false` in your `ApplicationController`
+
+```ruby
+class ApplicationController < ActionController::Base
+  layout false
+end
+```
+
+## Rails 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.loader = lambda do
+    ::Twig::Loader::Filesystem.new(
+      current.root,
+      current.paths
+    )
+  end
+end
+```
+
+The loader is memoized as late as possible, so if you need to actually access the loader instance, you can
+use `Twig.loader` to create the instance. If you do this, you can no longer set a new loader with the config
+or paths. You would need to use any available methods on the loader to alter it:
+
+```ruby
+config.after_initialize do
+  Twig.loader.prepend_path('app/views/theme', 'theme')
+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
+
+Twig Ruby supports symbols as Ruby does and can be used in places strings can as 
+hash keys, arguments, etc.
+
+```twig
+{{ name[:first] }}
+{{ user_func(:first, :second) }}
+{% set hash = { key: :value } %}
+```
+
+Since Ruby has the concept of blocks, a new tag is introduced call `yield` it
+can be used with helpers like `form_with`
+
+```twig
+{% yield form_with(url: 'login') do |f| %}
+  {{ f.email_field(:email) }}
+{% endyield %}
+```
+### Cache Tag
+
+The way the `cache` tag works in Rails is that it captures output from the buffer that 
+sends the contents of the response. Twig cannot do this prematurely since a cache might be used within
+a block or other callable meant to return the string. There is a cache tag to handle this instead 
+that is passed the same arguments it normally would, but has extra code to capture the cache. 
+Using `{% yield cache() do %}` WILL NOT WORK CORRECTLY.
+
+```twig
+{% cache(product) %}
+  ...
+{% endyield %}
+```
+
+Macros can also use Ruby notation for default values:
+
+Typical Twig:
+```twig
+{% macro input(name, value, type = "text", size = 20) %}
+  <input type="{{ type }}" name="{{ name }}" value="{{ value|e }}" size="{{ size }}"/>
+{% endmacro %}
+```
+
+Twig Ruby (Both versions work)
+```twig
+{% macro input(name, value, type: "text", size: 20) %}
+  <input type="{{ type }}" name="{{ name }}" value="{{ value|e }}" size="{{ size }}"/>
+{% endmacro %}
+```

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twig_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Craig Blanchette
@@ -44,6 +44,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/tasks/twig_parity.rake
 - lib/twig/auto_hash.rb
 - lib/twig/cache/base.rb
@@ -221,7 +222,9 @@ homepage: https://rubygems.org/gems/twig-ruby
 licenses:
 - MIT
 metadata:
+  allowed_push_host: https://rubygems.org
   rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/isometriks/twig-ruby
 rdoc_options: []
 require_paths:
 - lib