serbea 0.7.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5b809ec2d2de960b954c9d12d4bdfaaf1f910ff1f1e5aa7ac217db968cd1ac7
-  data.tar.gz: e819b84c2c0a33767f4d3736de70e916bfdd41fe354ba89a9f551172b22bdb41
+  metadata.gz: f7961cb287d077b528dd0367681aee6087a5efc9b3838670e7f8c7072b09c9ad
+  data.tar.gz: ca1a4701f70e49e28c67dfb407018dfd56eaf42391a0aa4230e1a15dc1b57f86
 SHA512:
-  metadata.gz: 71b3ab77eed51511959586f271ff814e094c6ef4fb4278dc60d85b92dafec4a328a084e27359c7626b661dea18e4e4f6007bceb40b4780557e1454752ed95d27
-  data.tar.gz: ff277d2b7471f668586248e0524429c8380ca30322f5b698bdf44b094a4cd7a202dfdfd3a87a7d1de3b652140eaf5d9e285f1addeb632e79e4be96b83e2e415b
+  metadata.gz: 84036346ec67f5789c380bd0772f1da6644223e1b82f6a5974de93c9c3b82c98b34c5a6f27c8c69dbb598b230a24b33a0ae16a9bee3a284b494eec81cec9f0ff
+  data.tar.gz: 78da2c4e5f3828153b9933fd0173475aaacdf3bb42e4a56a4ec69f12b6991488559a7cfb57f8f1a64008173dd280b7c3c47de4daebc4cda537ed3638c7af3cbc

data/Gemfile

@@ -4,5 +4,3 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in serbea.gemspec
 gemspec
-
-gem "erubi", github: "jaredcwhite/erubi", branch: "config-literal-prefix"

data/README.md

@@ -2,7 +2,7 @@
 
 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 application, Bridgetown static sites, or pretty much any Ruby scenario you could imagine.
+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
 
@@ -11,9 +11,9 @@ Serbea combines the best ideas from "brace-style" template languages such as Liq
 * 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 (even in Rails!) so you can access the variables written into the top YAML within your templates.
+* 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]`.
+* 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("arr |> map: ->(i) { i * 10 }", arr: [1,2,3])` will return `[10, 20, 30]`.
 
 ## What It Looks Like
 

data/lib/serbea.rb

@@ -10,7 +10,7 @@ module Tilt
     def prepare
       @options.merge!(
         outvar: "@_erbout",
-        bufval: "Serbea::Buffer.new", 
+        bufval: "Serbea::OutputBuffer.new", 
         literal_prefix: "{%",
         literal_postfix: "%}",
         engine_class: Serbea::TemplateEngine
@@ -31,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

@@ -8,11 +8,12 @@ module Serbea
 
     def capture(obj = nil, &block)
       previous_buffer_state = @_erbout
-      @_erbout = Serbea::Buffer.new
+      @_erbout = Serbea::OutputBuffer.new
 
       # For compatibility with ActionView, not used by Bridgetown normally
       previous_ob_state = @output_buffer
-      @output_buffer = Serbea::Buffer.new
+      @output_buffer = Serbea::OutputBuffer.new
+
 
       result = instance_exec(obj, &block)
       if @output_buffer != ""
@@ -22,7 +23,7 @@ module Serbea
       @_erbout = previous_buffer_state
       @output_buffer = previous_ob_state
 
-      result.html_safe
+      result&.html_safe
     end
   
     def pipeline(context, value)
@@ -32,11 +33,11 @@ module Serbea
     def helper(name, &helper_block)
       self.class.define_method(name) do |*args, &block|
         previous_buffer_state = @_erbout
-        @_erbout = Serbea::Buffer.new
+        @_erbout = Serbea::OutputBuffer.new
   
         # For compatibility with ActionView, not used by Bridgetown normally
         previous_ob_state = @output_buffer
-        @output_buffer = Serbea::Buffer.new
+        @output_buffer = Serbea::OutputBuffer.new
   
         result = helper_block.call(*args, &block)
         if @output_buffer != ""

data/lib/serbea/pipeline.rb

@@ -1,12 +1,13 @@
 require "active_support/core_ext/string/output_safety"
+require "active_support/core_ext/object/blank"
 
 module Serbea
   class Pipeline
-    def self.exec(template, input: (no_input_passed = true; nil), include_helpers: nil)
+    def self.exec(template, locals = {}, include_helpers: nil, **kwargs)
       anon = Class.new do
         include Serbea::Helpers
 
-        attr_accessor :input, :output
+        attr_accessor :output
       end
 
       if include_helpers
@@ -14,12 +15,11 @@ module Serbea
       end
 
       pipeline_obj = anon.new
-      pipeline_obj.input = input unless no_input_passed
 
       full_template = "{{ #{template} | assign_to: :output }}"
 
       tmpl = Tilt::SerbeaTemplate.new { full_template }
-      tmpl.render(pipeline_obj)
+      tmpl.render(pipeline_obj, locals.presence || kwargs)
 
       pipeline_obj.output
     end
@@ -54,8 +54,9 @@ module Serbea
       @value_methods_denylist ||= Set.new
     end
 
-    def initialize(context, value)
-      @context = context
+    def initialize(binding, value)
+      @binding = binding
+      @context = binding.receiver
       @value = value
     end
 
@@ -83,6 +84,19 @@ module Serbea
         else
           @value = @context.send(name, @value, *args)
         end
+      elsif @binding.local_variables.include?(name)
+        var = @binding.local_variable_get(name)
+        if var.respond_to?(:call)
+          unless kwargs.empty?
+            @value = var.call(@value, *args, **kwargs)
+          else
+            @value = var.call(@value, *args)
+          end
+        else
+          "Serbea warning: Filter #{name} does not respond to call".tap do |warning|
+            self.class.raise_on_missing_filters ? raise(warning) : STDERR.puts(warning)
+          end
+        end
       else
         "Serbea warning: Filter not found: #{name}".tap do |warning|
           self.class.raise_on_missing_filters ? raise(warning) : STDERR.puts(warning)

data/lib/serbea/rails_support.rb

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

data/lib/serbea/template_engine.rb

@@ -1,7 +1,7 @@
 require "strscan"
 
 module Serbea
-  class Buffer < String
+  class OutputBuffer < String
     def concat_to_s(input)
       concat input.to_s
     end
@@ -14,11 +14,42 @@ module Serbea
   class TemplateEngine < Erubi::Engine
     FRONT_MATTER_REGEXP = %r!\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)!m.freeze
 
-    def self.render_directive=(directive)
-      @render_directive = directive
+    def self.directive(new_directive, directive_resolution)
+      directives[new_directive.to_s] = directive_resolution
     end
-    def self.render_directive
-      @render_directive ||= "render"
+    def self.directives
+      @directives ||= {
+        "@" => ->(code, buffer) do
+          original_line_length = code.lines.size
+
+          pieces = code.split(" ")
+          if pieces[0].start_with?(/[A-Z]/) # Ruby class name
+            pieces[0].prepend " "
+            pieces[0] << ".new("
+          else # string or something else
+            pieces[0].prepend "("
+          end
+
+          includes_block = false
+          pieces.reverse.each do |piece|
+            if piece == "do" && (pieces.last == "do" || pieces.last.end_with?("|"))
+              piece.prepend(") ")
+              includes_block = true
+              break
+            end
+          end
+
+          if includes_block
+            buffer << "{%= render#{pieces.join(" ")} %}"
+          else
+            pieces.last << ")"
+            buffer << "{%= render#{pieces.join(" ")} %}"
+          end
+          (original_line_length - 1).times do
+            buffer << "\n{% %}" # preserve original directive line length
+          end
+        end
+      }
     end
 
     def self.front_matter_preamble=(varname)
@@ -125,7 +156,7 @@ module Serbea
             end
           end
 
-          segments[0] = "pipeline(self, (#{segments[0].strip}))"
+          segments[0] = "pipeline(binding, (#{segments[0].strip}))"
           segments[1..-1].each_with_index do |segment, index|
             filter, args = segment.strip.match(/([^ :]*)(.*)/m).captures
             segments[index + 1] = ".filter(:" + filter
@@ -149,39 +180,19 @@ module Serbea
       string = buff
       buff = ""
       until string.empty?
-        text, code, string = string.partition(/{%@(.*?)%}/m)
-  
+        text, code, string = string.partition(/{%@([a-z_]+)?(.*?)%}/m)
+
         buff << text
         if code.length > 0
-          code = $1
+          directive = $1
+          code = $2
           unless ["end", ""].include? code.strip
-            original_line_length = code.lines.size
-
-            pieces = code.split(" ")
-            if pieces[0].start_with?(/[A-Z]/) # Ruby class name
-              pieces[0].prepend " "
-              pieces[0] << ".new("
-            else # string or something else
-              pieces[0].prepend "("
-            end
+            directive = $1 ? self.class.directives[$1] : self.class.directives["@"]
 
-            includes_block = false
-            pieces.reverse.each do |piece|
-              if piece == "do" && (pieces.last == "do" || pieces.last.end_with?("|"))
-                piece.prepend(") ")
-                includes_block = true
-                break
-              end
-            end
-
-            if includes_block
-              buff << "{%= #{self.class.render_directive}#{pieces.join(" ")} %}"
+            if directive
+              directive.(code, buff)
             else
-              pieces.last << ")"
-              buff << "{%= #{self.class.render_directive}#{pieces.join(" ")} %}"
-            end
-            (original_line_length - 1).times do
-              buff << "\n{% %}" # preserve original directive line length
+              raise "Handler for Serbea template directive `#{$1}' not found"
             end
           else
             buff << "{% end %}"

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Serbea
-  VERSION = "0.7.1"
+  VERSION = "0.10.0"
 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.10")
+  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,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: serbea
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-01 00:00:00.000000000 Z
+date: 2020-12-01 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
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.10'
 - !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: []