serbea 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c69f1aa7916899c197489290d683afad319c66bccff8bd32d3e9a0e943bfa41
-  data.tar.gz: 267760c9cbbc3cbde6af0a3479b905c4bd8eca6e601dee2d1bb43cb0a819aabd
+  metadata.gz: 352c314f5f5a9b6df23933e1b379af39617c82c9b583f4c0703480a5f71df498
+  data.tar.gz: 364a353dba20ce3af4bcc071247477ec6dfa6f95c15bb94c88677520344a3cf1
 SHA512:
-  metadata.gz: c50177a140769d470f500446902009faac98bb390ef44f7930ed28b3c1cb92ac0a499e15ee2c66384ef0c7a52e55dca892ff2c17fe3f85bc8022b92c2f1c6a6a
-  data.tar.gz: 330296668991421be44b92b1a4a87470dc93ffd78e4b00530e26003fff1af293a9b4d51ee46fbcac2b541379a6e4c2a0179ec6365fafce14c219905ee8b73617
+  metadata.gz: 6bcdd89d15300e24e051f68de0d87899bec18c9f304162e3b667afc7c8a420ab5978e5eb91ab40f8dfd4201375a7fab769d9419a19562196e3ba93b85692e262
+  data.tar.gz: 8ba0cddf305d712c3e970adb06979e27f426aae797b2d99702f844e6e5c9248d34a96e35238134314da783e5fbd3de93b56cf7d5701ecc909690719393aa05fc

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

@@ -1,8 +1,8 @@
-👑 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 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

@@ -4,14 +4,13 @@ require "tilt/erubi"
 require "serbea/helpers"
 require "serbea/pipeline"
 require "serbea/template_engine"
-require "serbea/component_renderer"
 
 module Tilt
   class SerbeaTemplate < ErubiTemplate
     def prepare
       @options.merge!(
         outvar: "@_erbout",
-        bufval: "Serbea::Buffer.new", 
+        bufval: "Serbea::OutputBuffer.new", 
         literal_prefix: "{%",
         literal_postfix: "%}",
         engine_class: Serbea::TemplateEngine
@@ -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

@@ -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,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,7 +1,7 @@
 require "strscan"
 
 module Serbea
-  class Buffer < String
+  class OutputBuffer < String
     def concat_to_s(input)
       concat input.to_s
     end
@@ -66,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__").
@@ -84,17 +82,16 @@ 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
 
-          s = StringScanner.new(code[2...-2])
-          done = false
+          s = StringScanner.new($1)
           escaped_segment = ""
           segments = []
-          while !done
+          until s.eos?
             portion = s.scan_until(/\|>?/)
             if portion
               if portion.end_with?('\|')
@@ -124,11 +121,11 @@ module Serbea
                 # or just the rest will do
                 segments << s.rest
               end
-              done = true
+              s.terminate
             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
@@ -148,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.7.0"
+  VERSION = "0.9.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.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-31 00:00:00.000000000 Z
+date: 2020-11-19 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: []
@@ -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