serbea 0.11.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5c25c113b633bbeaaca37974b02ab662c34c803609966124ed390fccfb14440
-  data.tar.gz: e1126de9ab8506745882c2410d64146ac98e88d7b22fe7fa13bdbdc4afc0a1be
+  metadata.gz: 2014debe9382e252988c8d41ebec4102153508a856dca4dd7b72d2e347fb4023
+  data.tar.gz: aa729c3b2212ff33e5399544bc798593864248d6aacaeb0764c92fa43dc0cf8e
 SHA512:
-  metadata.gz: a7daa83b85d6674c5e0a5ea657ba7fa8baaae33a5651c09983cd62a56ccd8420752283b04a0f06c26bad4350f48a964126abd1a8e3613a62015b48fe293ffe3c
-  data.tar.gz: acce221b376b93ce9956bf6928877c9f504ada4b31e8df1b4d5b82cdbb5a9dfd15e6e07aefcc55536a2466fbbc7a5acc5b38434813a05099b01ceb49595f9531
+  metadata.gz: c7d3037ee50671772fad0ab5e8cbce90a9ae402769d5ffd49163df182a8c011da83d66809602d01d3186b2cc513d30116922fab461f03d3d0746b2d3f17a977e
+  data.tar.gz: 63f25bbbc2edd056c6c5cb461c356b52301f4590cc8733ca2be621f430b39d20df30f8ee881344e3c4088e19fb34d5630f4b9ac045db2fb5a3908830ae6bef18

data/docs/src/index.md

@@ -48,7 +48,19 @@ layout: home
 * Built-in frontmatter support. Now you can access the variables written into a top YAML block 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).
 
   For example, you could put `<title>{{ @frontmatter.title }}</title>` in your head partial, and then each page could define `title` frontmatter individually. You can even use Ruby string interpolation within the YAML so titles and other metadata can come from `t` language helpers.
+* Define macros/helpers which can be imported and used within Serbea templates.
 
+  ```serb
+  <!-- _macros.serb -->
+  {% macro :greet do |name:| %}
+    {{ name }}, my old friend!
+  {% end %}
+
+  <!-- tmpl.serb -->
+  {% import "macros" %}
+
+  Hello {{ greet(name: "darkness") }}
+  ```
 
 {% endraw %}
 
@@ -70,7 +82,7 @@ layout: home
 {{ wow | prepend: "OMG! " }}
 ```
 
-Serbea lets us define helpers inside templates directly:
+Use `helper` (alias `macro`) to create ad-hoc filters:
 
 ```serb
 <p>

data/lib/{serbea/rouge_lexer.rb → rouge/lexers/serbea.rb}

@@ -50,4 +50,4 @@ module Rouge
       end
     end
   end
-end
+end

data/lib/serbea/helpers.rb

@@ -9,11 +9,11 @@ module Serbea
     def capture(*args)
       previous_buffer_state = @_erbout
       @_erbout = Serbea::OutputBuffer.new
-      yield(*args)
-      result = @_erbout
+      result = yield(*args)
+      result = @_erbout.presence || result
       @_erbout = previous_buffer_state
 
-      result&.html_safe
+      Serbea::OutputBuffer === result ? result.html_safe : result
     end
 
     def pipeline(context, value)
@@ -22,16 +22,19 @@ module Serbea
 
     def helper(name, &helper_block)
       self.class.define_method(name) do |*args, **kwargs, &block|
-        previous_buffer_state = @_erbout
-        @_erbout = Serbea::OutputBuffer.new
-        result = helper_block.call(*args, **kwargs, &block)
-        @_erbout = previous_buffer_state
-
-        result.is_a?(String) ? result.html_safe : result
+        capture { helper_block.call(*args, **kwargs, &block) }
       end
     end
     alias_method :macro, :helper
 
+    def import(*args, **kwargs, &block)
+      helper_names = %i(partial render)
+      available_helper = helper_names.find { |meth| respond_to?(meth) }
+      raise "Serbea Error: no `render' or `partial' helper available in #{self.class}" unless available_helper
+      available_helper == :partial ? partial(*args, **kwargs, &block) : render(*args, **kwargs, &block)
+      nil
+    end
+
     def h(input)
       ERB::Util.h(input.to_s)
     end

data/lib/serbea/pipeline.rb

@@ -1,3 +1,4 @@
+require "set"
 require "active_support/core_ext/string/output_safety"
 require "active_support/core_ext/object/blank"
 
@@ -68,38 +69,21 @@ module Serbea
       @value = value
     end
 
-    # TODO: clean this up somehow and still support Ruby 2.5..3.0!
     def filter(name, *args, **kwargs)
       if @value.respond_to?(name) && !self.class.value_methods_denylist.include?(name)
         if args.last.is_a?(Proc)
           real_args = args.take(args.length - 1)
           block = args.last
-          unless kwargs.empty?
-            @value = @value.send(name, *real_args, **kwargs, &block)
-          else
-            @value = @value.send(name, *real_args, &block)
-          end
+          @value = @value.send(name, *real_args, **kwargs, &block)
         else
-          unless kwargs.empty?
-            @value = @value.send(name, *args, **kwargs)
-          else
-            @value = @value.send(name, *args)
-          end
+          @value = @value.send(name, *args, **kwargs)
         end
       elsif @context.respond_to?(name)
-        unless kwargs.empty?
-          @value = @context.send(name, @value, *args, **kwargs)
-        else
-          @value = @context.send(name, @value, *args)
-        end
+        @value = @context.send(name, @value, *args, **kwargs)
       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
+          @value = var.call(@value, *args, **kwargs)
         else
           "Serbea warning: Filter #{name} does not respond to call".tap do |warning|
             self.class.raise_on_missing_filters ? raise(warning) : STDERR.puts(warning)

data/lib/serbea.rb

@@ -25,19 +25,3 @@ module Tilt
 end
 
 Tilt.register Tilt::SerbeaTemplate, "serb"
-
-if defined?(Rails::Railtie)
-  class Railtie < ::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
-end
-
-if defined?(Bridgetown)
-  require "serbea/bridgetown_support"
-end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Serbea
-  VERSION = "0.11.3"
+  VERSION = "1.0.0"
 end

data/serbea.gemspec

@@ -11,12 +11,12 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/bridgetownrb/serbea"
   spec.license       = "MIT"
 
-  spec.required_ruby_version = ">= 2.5"
+  spec.required_ruby_version = ">= 2.7"
 
   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("activesupport", "~> 6.0")
+  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")

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: serbea
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Bridgetown Team
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-03 00:00:00.000000000 Z
+date: 2021-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
 - !ruby/object:Gem::Dependency
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-description:
+description: 
 email: maintainers@bridgetownrb.com
 executables: []
 extensions: []
@@ -117,12 +117,10 @@ files:
 - docs/sync.js
 - docs/webpack.config.js
 - docs/yarn.lock
+- lib/rouge/lexers/serbea.rb
 - lib/serbea.rb
-- lib/serbea/bridgetown_support.rb
 - lib/serbea/helpers.rb
 - lib/serbea/pipeline.rb
-- lib/serbea/rails_support.rb
-- lib/serbea/rouge_lexer.rb
 - lib/serbea/template_engine.rb
 - lib/version.rb
 - serbea.gemspec
@@ -130,7 +128,7 @@ homepage: https://github.com/bridgetownrb/serbea
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -138,15 +136,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: Similar to ERB, Except Awesomer
 test_files: []

data/lib/serbea/bridgetown_support.rb

@@ -1,68 +0,0 @@
-require "serbea/rouge_lexer"
-require "bridgetown-core"
-
-module Bridgetown
-  class SerbeaView < ERBView
-    include Serbea::Helpers
-
-    def partial(partial_name, options = {}, &block)
-      options.merge!(options[:locals]) if options[:locals]
-      options[:content] = capture(&block) if block
-
-      partial_segments = partial_name.split("/")
-      partial_segments.last.sub!(%r!^!, "_")
-      partial_name = partial_segments.join("/")
-
-      Tilt::SerbeaTemplate.new(
-        site.in_source_dir(site.config[:partials_dir], "#{partial_name}.serb")
-      ).render(self, options)
-    end
-  end
-
-  module Converters
-    class SerbeaTemplates < Converter
-      priority :highest
-      input :serb
-
-      # Logic to do the Serbea content conversion.
-      #
-      # @param content [String] Content of the file (without front matter).
-      # @param convertible [Bridgetown::Page, Bridgetown::Document, Bridgetown::Layout]
-      #   The instantiated object which is processing the file.
-      #
-      # @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 }
-
-        if convertible.is_a?(Bridgetown::Layout)
-          serb_renderer.render(serb_view) do
-            convertible.current_document_output
-          end
-        else
-          serb_renderer.render(serb_view)
-        end
-      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).tap do |ext_matches|
-          convertible.data[:template_engine] = "serbea" if ext_matches
-        end
-      end
-
-      def output_ext(ext)
-        ext == ".serb" ? ".html" : ext
-      end
-    end
-  end
-end

data/lib/serbea/rails_support.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-require "hash_with_dot_access"
-
-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
-
-      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
-
-    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)
-      end
-    end
-  end
-end
-
-Serbea::TemplateEngine.directive :form, ->(code, buffer) do
-  model_name, space, params = code.lstrip.partition(%r(\s)m)
-  model_name.chomp!(",")
-  model_name = "#{model_name}," unless params.lstrip.start_with?("do", "{")
-
-  buffer << "{%= form_with model: "
-  buffer << model_name << " #{params}"
-  buffer << " %}"
-end
-
-Serbea::TemplateEngine.directive :frame, ->(code, buffer) do
-  buffer << "{%= turbo_frame_tag "
-  buffer << code
-  buffer << " %}"
-end
-
-%i(append prepend update replace remove).each do |action|
-  Serbea::TemplateEngine.directive action, ->(code, buffer) do
-    buffer << "{%= turbo_stream.#{action} "
-    buffer << code
-    buffer << " %}"
-  end
-end
-
-Serbea::TemplateEngine.directive :_, ->(code, buffer) do
-  tag_name, space, params = code.lstrip.partition(%r(\s)m)
-
-  if tag_name.end_with?(":")
-    tag_name.chomp!(":")
-    tag_name = ":#{tag_name}" unless tag_name.start_with?(":")
-  end
-
-  buffer << "{%= tag.tag_string "
-  buffer << tag_name << ", " << params
-  buffer << " %}"
-end
-
-ActionView::Template.register_template_handler(:serb, Serbea::Rails::TemplateHandler)