serbea 0.6.4 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d16e1fa13dfcc4f2b10dc287e5d4c150130c0760a8be00cf323287849132f49
-  data.tar.gz: 60ab217fb343de0d7af90cf4dc18592dc867f6bbad8ce31349901dc64e677390
+  metadata.gz: 439fb102e78e2208de075b03b058b77d1cc909a6fe9414c341a48370fd3988e2
+  data.tar.gz: d0ff78ac67f00a59fa1047f7f05795cee88051ff0fdb9c179601984601fecae4
 SHA512:
-  metadata.gz: ed744553b4a670b1de4a617a8d34d2ecd4fac83135795994f601b4873f9ef46763e2ec09d814881c4005a5f070ed530f35e4334998e0e3445a62d5025030a665
-  data.tar.gz: 3d875dc56647f48098b1ba129a05c5fa56a7be4294de207199fb5e7ca5ab41d19ce511585e4b0533a74b000e6671fb6e3a0dd54d7779e9e5ee27ae0003df0d0d
+  metadata.gz: 6ca9922186315539c54e3a44fad5da81b3075425bb991dd8521e4777f5d46e515d4a65f9fd7fd54c52b870df21c8155b32beb3a24c84080c95367b1143526ff5
+  data.tar.gz: ccb34f9d8129fe5c4e34f96d7cbce118f5dbf8538151ae554cca9c35f63e223a0d14b4456e1463c8a79661de6109831ca3058aaee184f2925af974acfbc5f6b1

data/README.md

@@ -1,3 +1,109 @@
-👑 Serbea: Similar to ERB, Except Awesomer
+# 👑 Serbea: Similar to ERB, Except Awesomer
 
-The Ruby template language you always dreamed of is here. Le roi est mort, vive le roi!
+The Ruby template language you've always dreamed of is finally here. _Le roi est mort, vive le roi!_
+
+Serbea combines the best ideas from "brace-style" template languages such as Liquid, Nunjucks, Twig, Jinja, Mustache, etc.—and applies them to the world of ERB. You can use Serbea in Rails applications, Bridgetown static sites, or pretty much any Ruby scenario you could imagine.
+
+## Features
+
+* Real Ruby. Like, for real.
+* Filters!!! Pipeline operators!!!
+* Autoescaped variables by default within the pipeline (`{{ }}`) tags. Use the `safe`/`raw` or `escape`/`h` filters to control escaping on output.
+* Render directive `{%@ %}` as shortcut for rendering either string-named partials (`render "tmpl"`) or object instances (`render MyComponent.new`).
+* Supports every convention of ERB and builds upon it with new features (which is why it's "awesomer!").
+* Builtin frontmatter support so you can access the variables written into the top YAML within your templates. In any Rails view, including layouts, you'll have access to the `@frontmatter` ivar which is a merged `HashWithDotAccess::Hash` with data from any part of the view tree (partials, pages, layout).
+* The filters accessible within Serbea templates are either helpers (where the variable gets passed as the first argument) or instance methods of the variable itself, so you can build extremely expressive pipelines that take advantage of the code you already know and love. (For example, in Rails you could write `{{ "My Link" | link_to: route_path }}`).
+* The `Serbea::Pipeline.exec` method lets you pass a pipeline template in, along with an optional input value or included helpers module, and you'll get the output as a object of any type (not converted to a string like in traditional templates). For example: `Serbea::Pipeline.exec("[1,2,3] |> map: ->(i) { i * 10 }")` will return `[10, 20, 30]`.
+
+## What It Looks Like
+
+```hbs
+# example.serb
+
+{% wow = capture do %}
+  This is {{ "amazing" + "!" | upcase }}
+{% end.each_char.reduce("") do |newstr, c|
+    newstr += " #{c}"
+   end.strip %}
+
+{{ wow | prepend: "OMG! " }}
+```
+
+```hbs
+<p>
+  {%
+    helper :multiply_array do |input, multiply_by = 2|
+      input.map do |i|
+        i.to_i * multiply_by
+      end
+    end
+  %}
+
+  Multiply! {{ [1,3,6, "9"] | multiply_array: 10 }}
+</p>
+```
+
+```hbs
+{%= form classname: "checkout" do |f| %}
+  {{ f.input :first_name, required: true | errors: error_messages }}
+{% end %}
+```
+
+```hbs
+{%= render "box" do %}
+  This is **dope!**
+  {%= render "card", title: "Nifty!" do %}
+    So great.
+  {% end %}
+{% end %}
+
+# Let's simplify that using the new render directive!
+
+{%@ "box" do %}
+  This is **dope!**
+  {%@ "card", title: "Nifty!" do %}
+    So great.
+  {% end %}
+{% end %}
+```
+
+```hbs
+# Works with ViewComponent!
+
+{%= render(Theme::DropdownComponent.new(name: "banner", label: "Banners")) do |dropdown| %}
+  {% RegistryTheme::BANNERS.each do |banner| %}
+    {% dropdown.slot(:item, value: banner) do %}
+      <img src="{{ banner | parameterize: separator: "_" | prepend: "/themes/" | append: ".jpg" }}">
+      <strong>{{ banner }}</strong>
+    {% end %}
+  {% end %}
+{% end %}
+
+# Even better, use the new render directive!
+
+{%@ Theme::DropdownComponent name: "banner", label: "Banners" do |dropdown| %}
+  {% RegistryTheme::BANNERS.each do |banner| %}
+    {% dropdown.slot(:item, value: banner) do %}
+      <img src="{{ banner | parameterize: separator: "_" | prepend: "/themes/" | append: ".jpg" }}">
+      <strong>{{ banner }}</strong>
+    {% end %}
+  {% end %}
+{% end %}
+```
+
+```hbs
+# The | and |> pipeline operators are equivalent, so you can write like this if you want!
+
+{{
+  [1,2,3] |>
+  map: -> i  {
+    i * 10
+  } |>
+  filter: -> i do
+    i > 15
+  end |>
+  assign_to: :array_length
+}}
+
+Array length: {{ @array_length.length }}
+```

data/lib/serbea.rb

@@ -4,7 +4,6 @@ require "tilt/erubi"
 require "serbea/helpers"
 require "serbea/pipeline"
 require "serbea/template_engine"
-require "serbea/component_renderer"
 
 module Tilt
   class SerbeaTemplate < ErubiTemplate
@@ -32,6 +31,8 @@ if defined?(Rails::Railtie)
     initializer :serbea do |app|
       ActiveSupport.on_load(:action_view) do
         require "serbea/rails_support"
+
+        ActionController::Base.include Serbea::Rails::FrontmatterControllerActions
       end
     end
   end

data/lib/serbea/bridgetown_support.rb

@@ -40,6 +40,8 @@ module Bridgetown
       #
       # @return [String] The converted content.
       def convert(content, convertible)
+        return content if convertible.data[:template_engine] != "serbea"
+
         serb_view = Bridgetown::SerbeaView.new(convertible)
 
         serb_renderer = Tilt::SerbeaTemplate.new(convertible.relative_path) { content }
@@ -53,16 +55,17 @@ module Bridgetown
         end
       end
 
-      def matches(ext, convertible = nil)
-        if convertible
-          if convertible.data[:template_engine] == "serbea" ||
-              (convertible.data[:template_engine].nil? &&
-                @config[:template_engine] == "serbea")
-            return true
-          end
+      def matches(ext, convertible)
+        if convertible.data[:template_engine] == "serbea" ||
+            (convertible.data[:template_engine].nil? &&
+              @config[:template_engine] == "serbea")
+          convertible.data[:template_engine] = "serbea"
+          return true
         end
 
-        super(ext)
+        super(ext).tap do |ext_matches|
+          convertible.data[:template_engine] = "serbea" if ext_matches
+        end
       end
 
       def output_ext(ext)
@@ -71,13 +74,3 @@ module Bridgetown
     end
   end
 end
-
-Bridgetown::Hooks.register :site, :pre_render, reloadable: false do |site|
-  # make sure Liquid doesn't find {% %} and decide to process Serbea code!
-  site.contents.each do |convertible|
-    convertible.data.render_with_liquid = false if convertible.extname == ".serb"
-  end
-  site.layouts.values.each do |convertible|
-    convertible.data.render_with_liquid = false if convertible.ext == ".serb"
-  end
-end

data/lib/serbea/helpers.rb

@@ -22,7 +22,7 @@ module Serbea
       @_erbout = previous_buffer_state
       @output_buffer = previous_ob_state
 
-      result.html_safe
+      result&.html_safe
     end
   
     def pipeline(context, value)

data/lib/serbea/rails_support.rb

@@ -1,22 +1,40 @@
 # frozen_string_literal: true
 
-# inspired by https://github.com/haml/haml/blob/main/lib/haml/plugin.rb
 module Serbea
+  module Rails
+    module FrontmatterHelpers
+      def set_page_frontmatter=(data)
+        @frontmatter ||= HashWithDotAccess::Hash.new
+        @frontmatter.update(data)
+      end
+    end
+
+    module FrontmatterControllerActions
+      extend ActiveSupport::Concern
 
-  # This module makes Serbea work with Rails using the template handler API.
-  class Plugin
-    def handles_encoding?; true; end
+      included do
+        Serbea::TemplateEngine.front_matter_preamble = "self.set_page_frontmatter = local_frontmatter = YAML.load"
+    
+        before_action { @frontmatter ||= HashWithDotAccess::Hash.new }
 
-    def compile(template, source)
-      "self.class.include(Serbea::Helpers);" + Tilt::SerbeaTemplate.new { source }.precompiled_template([])
+        helper Serbea::Rails::FrontmatterHelpers
+      end
     end
 
-    def self.call(template, source = nil)
-      source ||= template.source
+    class TemplateHandler
+      def handles_encoding?; true; end
+
+      def compile(template, source)
+        "self.class.include(Serbea::Helpers);" + Tilt::SerbeaTemplate.new { source }.precompiled_template([])
+      end
+
+      def self.call(template, source = nil)
+        source ||= template.source
 
-      new.compile(template, source)
+        new.compile(template, source)
+      end
     end
   end
 end
 
-ActionView::Template.register_template_handler(:serb, Serbea::Plugin)
+ActionView::Template.register_template_handler(:serb, Serbea::Rails::TemplateHandler)

data/lib/serbea/template_engine.rb

@@ -1,3 +1,5 @@
+require "strscan"
+
 module Serbea
   class Buffer < String
     def concat_to_s(input)
@@ -64,13 +66,11 @@ module Serbea
   
       # Ensure the raw "tag" will strip out all ERB-style processing
       until string.empty?
-        text, code, string = string.partition(/{% raw %}.*?{% endraw %}/m)
+        text, code, string = string.partition(/{% raw %}(.*?){% endraw %}/m)
   
         buff << text
         if code.length > 0
-          buff << code.
-            sub("{% raw %}", "").
-            sub("{% endraw %}", "").
+          buff << $1.
             gsub("{{", "__RAW_START_PRINT__").
             gsub("}}", "__RAW_END_PRINT__").
             gsub("{%", "__RAW_START_EVAL__").
@@ -82,27 +82,61 @@ module Serbea
       string = buff
       buff = ""
       until string.empty?
-        text, code, string = string.partition(/{{.*?}}/m)
+        text, code, string = string.partition(/{{(.*?)}}/m)
   
         buff << text
         if code.length > 0
           original_line_length = code.lines.size
-          processed_filters = false
-  
-          code = code.gsub('\|', "__PIPE_C__")
-  
-          subs = code.gsub(/\s*\|>?\s+(.*?)\s([^|}]*)/) do
-            args = $2
-            args = nil if args.strip == ""
-            prefix = processed_filters ? ")" : "))"
-            processed_filters = true
-            "#{prefix}.filter(:#{$1.chomp(":")}" + (args ? ", #{args}" : "")
+
+          s = StringScanner.new($1)
+          escaped_segment = ""
+          segments = []
+          until s.eos?
+            portion = s.scan_until(/\|>?/)
+            if portion
+              if portion.end_with?('\|')
+                # the pipe is escaped, so save that for later
+                escaped_segment += portion.sub(/\\\|$/, "|")
+              elsif escaped_segment.length > 0
+                # we already have escaped content, so finish that up
+                segments << escaped_segment + portion.sub(/\|>?$/, "")
+                escaped_segment = ""
+              else
+                # let's find out if this is actionable now
+                if s.check(/\|/)
+                  # nope, the next character is another pipe, so let's escape
+                  s.pos += 1
+                  escaped_segment += portion + "|"
+                else
+                  # finally, we have liftoff!
+                  segments << portion.sub(/\|>?$/, "")
+                end
+              end
+            else
+              # we've reached the last bit of the code
+              if escaped_segment.length > 0
+                # escape and get the rest
+                segments << escaped_segment + s.rest
+              else
+                # or just the rest will do
+                segments << s.rest
+              end
+              s.terminate
+            end
+          end
+
+          segments[0] = "pipeline(self, (#{segments[0].strip}))"
+          segments[1..-1].each_with_index do |segment, index|
+            filter, args = segment.strip.match(/([^ :]*)(.*)/m).captures
+            segments[index + 1] = ".filter(:" + filter
+            if args == ""
+              segments[index + 1] += ")"
+            else
+              segments[index + 1] += "," + args.sub(/^:/, "") + ")"
+            end
           end
-  
-          pipeline_suffix = processed_filters ? ") %}" : ")) %}"
-  
-          subs = subs.sub("{{", "{%= pipeline(self, (").sub("}}", pipeline_suffix).gsub("__PIPE_C__", '|')
 
+          subs = "{%= #{segments.join} %}"
           buff << subs
 
           (original_line_length - subs.lines.size).times do
@@ -111,24 +145,15 @@ module Serbea
         end
       end
 
-      # Process any directives
-      #
-      # TODO: allow custom directives! aka
-      # {%@something whatever %}
-      # {%@script
-      #   const foo = "really? #{really}!"
-      #   alert(foo.toLowerCase())
-      # %}
-      # {%@preact AwesomeChart data={#{ruby_data.to_json}} %}
+      # Process any render directives
       string = buff
       buff = ""
       until string.empty?
-        text, code, string = string.partition(/{%@.*?%}/m)
+        text, code, string = string.partition(/{%@(.*?)%}/m)
   
         buff << text
         if code.length > 0
-          code.sub!(/^\{%@/, "")
-          code.sub!(/%}$/, "")
+          code = $1
           unless ["end", ""].include? code.strip
             original_line_length = code.lines.size
 

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Serbea
-  VERSION = "0.6.4"
+  VERSION = "0.8.1"
 end

data/serbea.gemspec

@@ -16,8 +16,10 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features)/!) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency("rake", "~> 13.0")
-  spec.add_runtime_dependency("erubi", "~> 1.9")
   spec.add_runtime_dependency("activesupport", "~> 6.0")
+  spec.add_runtime_dependency("erubi", "~> 1.9")
+  spec.add_runtime_dependency("hash_with_dot_access", "~> 1.1")
   spec.add_runtime_dependency("tilt", "~> 2.0")
+
+  spec.add_development_dependency("rake", "~> 13.0")
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: serbea
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.8.1
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-31 00:00:00.000000000 Z
+date: 2020-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: erubi
   requirement: !ruby/object:Gem::Requirement
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.9'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: hash_with_dot_access
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 description: 
 email: maintainers@bridgetownrb.com
 executables: []
@@ -78,7 +92,6 @@ files:
 - Rakefile
 - lib/serbea.rb
 - lib/serbea/bridgetown_support.rb
-- lib/serbea/component_renderer.rb
 - lib/serbea/helpers.rb
 - lib/serbea/pipeline.rb
 - lib/serbea/rails_support.rb

data/lib/serbea/component_renderer.rb

@@ -1,19 +0,0 @@
-module Serbea
-  class ComponentRenderer
-    include Helpers
-
-    def initialize(variables = {})
-      @variables = variables
-    end
-
-    def respond_to_missing?(key, include_private = false)
-      @variables.key?(key)
-    end
-
-    def method_missing(key)
-      return @variables[key] if respond_to_missing?(key)
-      
-      super
-    end
-  end
-end