trmnl-liquid 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71c903fca7e32e8b95b094e74dc73fcda3321abb23304adb0ed0f2df2873a24c
-  data.tar.gz: d2da61eec30c53e924dce31ec7a8a021a531b7318738005f656f84a25568925e
+  metadata.gz: c484c8483e883a76d94ccf35c0984ad405c498b890a7185e46474d706d1a613e
+  data.tar.gz: 72dc97f7b558c0a6d20e02640f781befb3fe68f15039e4e4e990f5a2520765a4
 SHA512:
-  metadata.gz: c97a0eefc2eb7cfba1438b3c862bf17709ec953228ac2ba96e273b0d4298d767a358c95ad4b62a986559fb4719dc4305c3670ffcd414ae7df5d75180b0b5a19e
-  data.tar.gz: 77f741d77b3cbeeae0c20e15124b5075c2d302b208f628152bfd2fedc2b702832e42775c7c741a7ae853280d92329548725e5a988dfada2baceae7741a063b5d
+  metadata.gz: 6182847e14836fa4b3fe9b76210faf7c96e983a0c20495cf794234e4c0a62a1c345a933d41a38638f10cdd44df6516fefa9ae40678dd1291f462f500b62330f7
+  data.tar.gz: 0a0da9095cc5be9c55bb284051a711ee2877b233bdd434dcf5dc6b4f320a883f8197f364123bcdb63e9671c45afd4c141fbbf4321cc6fcac3a5e6ffbdc9064f4

data/lib/trmnl/liquid/file_system.rb

@@ -0,0 +1,21 @@
+module TRMNL
+  module Liquid
+    # This in-memory "file system" is the backing storage for custom templates defined {% template [name] %} tags.
+    class FileSystem < ::Liquid::BlankFileSystem
+      def initialize
+        super
+        @templates = {}
+      end
+
+      # called by Markup::LiquidTemplateTag to save users' custom shared templates via our custom {% template %} tag
+      def register(name, body)
+        @templates[name] = body
+      end
+
+      # called by ::Liquid::Template for {% render 'foo' %} when rendering screen markup
+      def read_template_file(name)
+        @templates[name] || raise(::Liquid::FileSystemError, "Template not found: #{name}")
+      end
+    end
+  end
+end

data/lib/trmnl/liquid/template_tag.rb

@@ -0,0 +1,33 @@
+module TRMNL
+  module Liquid
+    # The {% template [name] %} tag block is used in conjunction with InlineTemplatesFileSystem to allow users to define
+    # custom templates within the context of the current Liquid template. Generally speaking, they will define their own
+    # templates in the "shared" markup content, which is prepended to the individual screen templates before rendering.
+    class TemplateTag < ::Liquid::Block
+      NAME_REGEX = %r{\A[a-zA-Z0-9_/]+\z}
+
+      def initialize(tag_name, markup, options)
+        super
+        @name = markup.strip
+      end
+
+      def parse(tokens)
+        @body = ""
+        while (token = tokens.shift)
+          break if token.strip == "{% endtemplate %}"
+
+          @body << token
+        end
+      end
+
+      def render(context)
+        unless @name =~ NAME_REGEX
+          return "Liquid error: invalid template name #{@name.inspect} - template names must contain only letters, numbers, underscores, and slashes"
+        end
+
+        context.registers[:file_system].register(@name, @body.strip)
+        ''
+      end
+    end
+  end
+end

data/lib/trmnl/liquid/version.rb

@@ -2,6 +2,6 @@
 # frozen_string_literal: true
 module TRMNL
   module Liquid
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/trmnl/liquid.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+require 'liquid'
+
 require 'trmnl/liquid/filters'
-require 'trmnl/liquid/template'
+require 'trmnl/liquid/file_system'
+require 'trmnl/liquid/template_tag'
 require 'trmnl/liquid/version'
 
 begin
@@ -20,9 +23,13 @@ end
 
 module TRMNL
   module Liquid
-    # empty
+    def self.build_environment(*args)
+      ::Liquid::Environment.build(*args) do |env|
+        env.register_filter(TRMNL::Liquid::Filters)
+        env.register_tag('template', TRMNL::Liquid::TemplateTag)
+        env.file_system = TRMNL::Liquid::FileSystem.new
+        yield(env) if block_given?
+      end
+    end
   end
-end
-
-::Liquid::Template.register_filter(TRMNL::Liquid::Filters)
-::Liquid::Template.register_tag('template', TRMNL::Liquid::Template::TemplateTag)
+end

data/trmnl-liquid.gemspec

@@ -28,6 +28,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "actionview", "~> 8.0"
-  spec.add_dependency "liquid", "~> 5.5"
+  spec.add_dependency "liquid", "~> 5.6"
   spec.add_dependency "redcarpet", "~> 3.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trmnl-liquid
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - TRMNL
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '5.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '5.6'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -58,10 +58,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/trmnl/liquid.rb
+- lib/trmnl/liquid/file_system.rb
 - lib/trmnl/liquid/filters.rb
-- lib/trmnl/liquid/template.rb
-- lib/trmnl/liquid/template/file_system.rb
-- lib/trmnl/liquid/template/template_tag.rb
+- lib/trmnl/liquid/template_tag.rb
 - lib/trmnl/liquid/version.rb
 - trmnl-liquid.gemspec
 homepage: https://github.com/usetrmnl/trmnl-liquid

data/lib/trmnl/liquid/template/file_system.rb

@@ -1,23 +0,0 @@
-module TRMNL
-  module Liquid
-    class Template < ::Liquid::Template
-      # This in-memory "file system" is the backing storage for custom templates defined {% template [name] %} tags.
-      class FileSystem < ::Liquid::BlankFileSystem
-        def initialize
-          super
-          @templates = {}
-        end
-
-        # called by Markup::LiquidTemplateTag to save users' custom shared templates via our custom {% template %} tag
-        def register(name, body)
-          @templates[name] = body
-        end
-
-        # called by ::Liquid::Template for {% render 'foo' %} when rendering screen markup
-        def read_template_file(name)
-          @templates[name] || raise(::Liquid::FileSystemError, "Template not found: #{name}")
-        end
-      end
-    end
-  end
-end

data/lib/trmnl/liquid/template/template_tag.rb

@@ -1,35 +0,0 @@
-module TRMNL
-  module Liquid
-    class Template < ::Liquid::Template
-      # The {% template [name] %} tag block is used in conjunction with InlineTemplatesFileSystem to allow users to define
-      # custom templates within the context of the current Liquid template. Generally speaking, they will define their own
-      # templates in the "shared" markup content, which is prepended to the individual screen templates before rendering.
-      class TemplateTag < ::Liquid::Block
-        NAME_REGEX = %r{\A[a-zA-Z0-9_/]+\z}
-
-        def initialize(tag_name, markup, options)
-          super
-          @name = markup.strip
-        end
-
-        def parse(tokens)
-          @body = ""
-          while (token = tokens.shift)
-            break if token.strip == "{% endtemplate %}"
-
-            @body << token
-          end
-        end
-
-        def render(context)
-          unless @name =~ NAME_REGEX
-            return "Liquid error: invalid template name #{@name.inspect} - template names must contain only letters, numbers, underscores, and slashes"
-          end
-
-          context.registers[:file_system].register(@name, @body.strip)
-          ''
-        end
-      end
-    end
-  end
-end

data/lib/trmnl/liquid/template.rb

@@ -1,21 +0,0 @@
-require 'liquid'
-
-require_relative 'template/file_system'
-require_relative 'template/template_tag'
-
-module TRMNL
-  module Liquid
-    # A very thin wrapper around Liquid::Template with TRMNL-specific functionality.
-    class Template < ::Liquid::Template
-      def self.parse(*)
-        template = super
-
-        # set up a temporary in-memory file system for custom user templates, via the magic :file_system register
-        # which will override the default file system
-        template.registers[:file_system] = FileSystem.new
-
-        template
-      end
-    end
-  end
-end