liquid2 0.1.0 → 0.2.0

data/lib/liquid2/undefined.rb

@@ -5,6 +5,8 @@ require_relative "errors"
 module Liquid2
   # The default undefined type. Can be iterated over an indexed without error.
   class Undefined
+    include Enumerable
+
     attr_reader :force_default
 
     def initialize(name, node: nil)
@@ -37,87 +39,87 @@ module Liquid2
   class StrictUndefined < Undefined
     def initialize(name, node: nil)
       super
-      @message = "#{name.inspect} is undefined"
+      @message = "#{@node.is_a?(Path) ? @node : name.inspect} is undefined"
     end
 
     def respond_to_missing? = true
 
     def method_missing(...)
-      raise UndefinedError.new(@message, @node)
+      raise UndefinedError.new(@message, @node.token)
     end
 
     def [](...)
-      raise UndefinedError.new(@message, @node)
+      raise UndefinedError.new(@message, @node.token)
     end
 
     def key?(...)
-      raise UndefinedError.new(@message, @node)
+      raise UndefinedError.new(@message, @node.token)
     end
 
     def include?(...)
-      raise UndefinedError.new(@message, @node)
+      raise UndefinedError.new(@message, @node.token)
     end
 
     def member?(...)
-      raise UndefinedError.new(@message, @node)
+      raise UndefinedError.new(@message, @node.token)
     end
 
     def fetch(...)
-      raise UndefinedError.new(@message, @node)
+      raise UndefinedError.new(@message, @node.token)
     end
 
     def !
-      raise UndefinedError.new(@message, @node)
+      raise UndefinedError.new(@message, @node.token)
     end
 
     def ==(_other)
-      raise UndefinedError.new(@message, @node)
+      raise UndefinedError.new(@message, @node.token)
     end
 
     def !=(_other)
-      raise UndefinedError.new(@message, @node)
+      raise UndefinedError.new(@message, @node.token)
     end
 
     alias eql? ==
 
     def size
-      raise UndefinedError.new(@message, @node)
+      raise UndefinedError.new(@message, @node.token)
     end
 
     def length
-      raise UndefinedError.new(@message, @node)
+      raise UndefinedError.new(@message, @node.token)
     end
 
     def to_s
-      raise UndefinedError.new(@message, @node)
+      raise UndefinedError.new(@message, @node.token)
     end
 
     def to_i
-      raise UndefinedError.new(@message, @node)
+      raise UndefinedError.new(@message, @node.token)
     end
 
     def to_f
-      raise UndefinedError.new(@message, @node)
+      raise UndefinedError.new(@message, @node.token)
     end
 
     def each(...)
-      raise UndefinedError.new(@message, @node)
+      raise UndefinedError.new(@message, @node.token)
     end
 
     def each_with_index(...)
-      raise UndefinedError.new(@message, @node)
+      raise UndefinedError.new(@message, @node.token)
     end
 
     def join(...)
-      raise UndefinedError.new(@message, @node)
+      raise UndefinedError.new(@message, @node.token)
     end
 
     def to_liquid(_context)
-      raise UndefinedError.new(@message, @node)
+      raise UndefinedError.new(@message, @node.token)
     end
 
     def poke
-      raise UndefinedError.new(@message, @node)
+      raise UndefinedError.new(@message, @node.token)
     end
   end
 

data/lib/liquid2/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Liquid2
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/liquid2.rb

@@ -73,6 +73,8 @@ module Liquid2
   # @param obj [Object]
   # @return [bool]
   def self.truthy?(context, obj)
+    return false if context.env.falsy_undefined && undefined?(obj)
+
     obj = obj.to_liquid(context) if obj.respond_to?(:to_liquid)
     !!obj
   end

data/sig/liquid2.rbs

@@ -76,6 +76,8 @@ module Liquid2
 
     @undefined: singleton(Undefined)
 
+    @falsy_undefined: bool
+
     @loader: TemplateLoader
 
     @globals: Hash[String, untyped]?
@@ -98,7 +100,9 @@ module Liquid2
 
     attr_reader shorthand_indexes: bool
 
-    def initialize: (?context_depth_limit: ::Integer, ?globals: Hash[String, untyped]?, ?loader: TemplateLoader?, ?local_namespace_limit: Integer?, ?loop_iteration_limit: Integer?, ?output_stream_limit: Integer?, ?shorthand_indexes: bool, ?suppress_blank_control_flow_blocks: bool, ?undefined: singleton(Undefined)) -> void
+    attr_reader falsy_undefined: bool
+
+    def initialize: (?context_depth_limit: ::Integer, ?globals: Hash[String, untyped]?, ?loader: TemplateLoader?, ?local_namespace_limit: Integer?, ?loop_iteration_limit: Integer?, ?output_stream_limit: Integer?, ?shorthand_indexes: bool, ?suppress_blank_control_flow_blocks: bool, ?undefined: singleton(Undefined), ?falsy_undefined: bool) -> void
 
     # @param source [String] template source text.
     # @return [Template]
@@ -123,6 +127,10 @@ module Liquid2
     #    if _name_ did not exist in the filter register.
     def delete_filter: (String name) -> ([_Filter, (Integer | nil)] | nil)
 
+    def register_tag: (String name, _Tag tag) -> void
+                    
+    def delete_tag: (String name) -> (_Tag | nil) 
+
     def setup_tags_and_filters: () -> void
 
     def undefined: (String name, ?node: _HasToken?) -> Undefined
@@ -336,6 +344,8 @@ module Liquid2
     def parse_string: () -> String
 
     def parse_identifier: (?trailing_question: bool) -> Identifier
+                        
+    def parse_name: () -> String
 
     # Parse comma separated expression.
     # Leading commas should be consumed by the caller.
@@ -346,6 +356,10 @@ module Liquid2
     # Leading commas should be consumed by the caller.
     # @return [Array<KeywordArgument>]
     def parse_keyword_arguments: () -> Array[KeywordArgument]
+                               
+    def parse_parameters: () -> Hash[String, Parameter]
+                        
+    def parse_arguments: () -> [Array[untyped], Array[KeywordArgument]]
 
     class Precedence
       LOWEST: 1
@@ -461,6 +475,8 @@ module Liquid2
 
     attr_reader up_to_date: Proc::_Callable?
 
+    attr_reader source: String
+
     # @param env [Environment]
     # @param ast [RootNode]
     # @param name [String] The template's name.
@@ -489,6 +505,10 @@ module Liquid2
     
     def comments: () -> Array[BlockComment | InlineComment | Comment]
                 
+    def docs: () -> Array[DocTag]
+            
+    def macros: (?include_partials: bool) -> [Array[MacroTag], Array[CallTag]]
+                
     # Return an array of variables used in this template, without path segments.
     # @param include_partials [bool]
     # @return [Array[String]]
@@ -830,11 +850,11 @@ module Liquid2
     @loops: Array[ForLoop]
 
     # A stack of interrupts used to signal breaking and continuing `for` loops.
-    @interrupts: Array[:break | :continue]
+    @interrupts: Array[Symbol]
 
     attr_reader env: Environment
 
-    attr_reader template: Template
+    attr_accessor template: Template
 
     attr_reader globals: _Namespace
 
@@ -842,8 +862,7 @@ module Liquid2
 
     attr_reader tag_namespace: Hash[Symbol, untyped]
 
-    attr_accessor interrupts: Array[:break | :continue]
-
+    attr_accessor interrupts: Array[Symbol]
 
     BUILT_IN: BuiltIn
 
@@ -911,16 +930,13 @@ module Liquid2
 
     def get_output_buffer: (untyped parent_buffer) -> untyped
 
-    # Mark _string_ as "safe" if auto escape is enabled.
-    def markup: (untyped string) -> untyped
-
     def cycle: (untyped key, untyped length) -> untyped
 
-    def increment: (untyped name) -> untyped
+    def increment: (untyped name) -> Integer
 
-    def decrement: (untyped name) -> untyped
+    def decrement: (untyped name) -> Integer
 
-    def assign_score: (untyped value) -> untyped
+    def assign_score: (untyped value) -> Integer
 
   end
 end
@@ -942,7 +958,7 @@ module Liquid2
 
     attr_accessor source: (String | nil)
 
-    def initialize: (String message, ?[Symbol, String?, Integer]? token) -> void
+    def initialize: (String message, ?[Symbol, String?, Integer]? token, ?template_name: String?) -> void
                   
     def detailed_message: (?highlight: bool, **untyped kwargs) -> String
 
@@ -975,6 +991,12 @@ module Liquid2
   class DisabledTagError < LiquidError
   end
 
+  class TemplateInheritanceError < LiquidError
+  end
+
+  class RequiredBlockError < TemplateInheritanceError
+  end
+
   # The standard _for_ tag.
   class ForTag < Tag
     @expression: LoopExpression
@@ -1117,6 +1139,26 @@ module Liquid2
 
     def evaluate: (RenderContext context) -> [String, untyped]
   end
+
+  class Parameter < Expression
+    @name: String
+
+    @sym: Symbol
+
+    @value: untyped
+
+    attr_reader name: String
+
+    attr_reader sym: Symbol
+
+    attr_reader value: (untyped | :undefined)
+
+    # @param name [Token]
+    # @param value [Expression]
+    def initialize: ([Symbol, String?, Integer] token, String name, untyped value) -> void
+
+    def evaluate: (RenderContext context) -> [String, untyped]
+  end
 end
 
 module Liquid2
@@ -1170,11 +1212,11 @@ module Liquid2
   class FilteredExpression < Expression
     @left: Expression
 
-    @filters: Array[Filter]
+    @filters: Array[Filter]?
 
-    attr_reader filters: Array[Filter]
+    attr_reader filters: Array[Filter]?
 
-    def initialize: ([Symbol, String?, Integer] token, untyped left, Array[Filter] filters) -> void
+    def initialize: ([Symbol, String?, Integer] token, untyped left, Array[Filter]? filters) -> void
 
     def evaluate: (RenderContext context) -> untyped
   end
@@ -1207,25 +1249,17 @@ module Liquid2
   class Filter < Expression
     @name: String
 
-    @args: Array[untyped]
+    @args: Array[untyped]?
 
     attr_reader name: String 
 
-    attr_reader args: Array[untyped] 
+    attr_reader args: Array[untyped]?
 
     # @param name [Token]
     # @param args [Array[Expression]]
-    def initialize: ([Symbol, String?, Integer] token, String name, Array[untyped] args) -> void
+    def initialize: ([Symbol, String?, Integer] token, String name, Array[untyped]? args) -> void
 
     def evaluate: (untyped left, RenderContext context) -> untyped
-
-    private
-
-    # @param context [RenderContext]
-    # @return [positional arguments, keyword arguments] An array with two elements.
-    #   The first is an array of evaluates positional arguments. The second is a hash
-    #   of keyword names to evaluated keyword values.
-    def evaluate_args: (RenderContext context) -> [Array[untyped], Hash[Symbol, untyped]]
   end
 end
 
@@ -1341,10 +1375,16 @@ module Liquid2
     attr_reader segments: Array[String | Integer | Path]
     attr_reader head: (String | Integer | Path)
 
+    RE_PROPERTY: ::Regexp
+
     # @param segments [Array[String | Integer | Path]]
     def initialize: ([Symbol, String?, Integer] token, Array[String | Integer | Path] segments) -> void
 
     def evaluate: (RenderContext context) -> untyped
+                
+    private
+
+    def segment_to_s: (untyped segment, ?head: bool) -> ::String
   end
 end
 
@@ -1717,6 +1757,8 @@ module Liquid2
 
     def self.nil_safe_casecmp: (untyped a, untyped b) -> (0 | 1 | -1)
                              
+    INFINITY_ARRAY: [Float]
+    
     def self.numeric_compare: (untyped left, untyped right) -> (0 | 1 | -1)
 
     def self.ints: (untyped obj) -> Array[(Integer | Float | BigDecimal)]
@@ -1956,6 +1998,8 @@ module Liquid2
   class DocTag < Tag
     @text: String
 
+    attr_reader text: String
+
     def self.parse: ([Symbol, String?, Integer] token, Parser parser) -> DocTag
 
     # @param text [String]
@@ -1984,7 +2028,7 @@ end
 module Liquid2
   # The standard _include_ tag.
   class IncludeTag < Tag
-    @name: untyped
+    @template_name: untyped
 
     @repeat: bool
 
@@ -2014,7 +2058,7 @@ module Liquid2
 
   # The standard _render_ tag.
   class RenderTag < Tag
-    @name: untyped
+    @template_name: untyped
 
     @repeat: bool
 
@@ -2345,4 +2389,166 @@ module Liquid2
     # Return _left_ serialized in JSON format.
     def self.json: (untyped left, ?pretty: bool) -> String
   end
+end
+
+module Liquid2
+  # The _macro_ tag.
+  class MacroTag < Tag
+    @macro_name: String
+
+    @params: Hash[String, Parameter]
+
+    @block: Block
+
+    @blank: bool
+
+    END_BLOCK: Set[String]
+
+    attr_reader macro_name: String
+
+    attr_reader params: Hash[String, Parameter]
+
+    attr_reader Block: Block
+
+    # @param parser [Parser]
+    # @return [MacroTag]
+    def self.parse: ([Symbol, String?, Integer] token, Parser parser) -> MacroTag
+
+    def initialize: ([Symbol, String?, Integer] token, String name, Hash[String, Parameter] params, Block block) -> void
+
+    def render: (RenderContext context, String _buffer) -> void
+  end
+
+  # The _call_ tag.
+  class CallTag < Tag
+    @macro_name: String
+
+    @args: Array[untyped]
+
+    @kwargs: Array[KeywordArgument]
+
+    @blank: bool
+
+    DISABLED_TAGS: Set[String]
+
+    attr_reader macro_name: String
+
+    attr_reader args: Array[untyped]
+
+    attr_reader kwargs: Array[KeywordArgument]
+
+    # @param parser [Parser]
+    # @return [CallTag]
+    def self.parse: ([Symbol, String?, Integer] token, Parser parser) -> CallTag
+
+    def initialize: ([Symbol, String?, Integer] token, String name, Array[untyped] args, Array[KeywordArgument] kwargs) -> void
+
+    def render: (RenderContext context, String buffer) -> void
+  end
+end
+
+module Liquid2
+  # The _extends_ tag.
+  class ExtendsTag < Tag
+    @template_name: String
+
+    @blank: bool
+
+    attr_reader template_name: String
+
+    # @param token [[Symbol, String?, Integer]]
+    # @param parser [Parser]
+    # @return [ExtendsTag]
+    def self.parse: ([Symbol, String?, Integer] token, Parser parser) -> ExtendsTag
+
+    def initialize: ([Symbol, String?, Integer] token, String name) -> void
+
+    def render: (RenderContext context, String buffer) -> void
+
+    def stack_blocks: (RenderContext context, Template template) -> Template?
+
+    def inheritance_nodes: (RenderContext context, Template template) -> [Array[ExtendsTag], Array[BlockTag]]
+  end
+
+  # The _block_ tag.
+  class BlockTag < Tag
+    @block_name: String
+
+    @block: Block
+
+    @required: bool
+
+    @blank: bool
+
+    END_BLOCK: Set[String]
+
+    attr_reader block_name: String
+
+    attr_reader block: Block
+
+    attr_reader required: bool
+
+    # @param token [[Symbol, String?, Integer]]
+    # @param parser [Parser]
+    # @return [BlockTag]
+    def self.parse: ([Symbol, String?, Integer] token, Parser parser) -> BlockTag
+
+    def initialize: ([Symbol, String?, Integer] token, String name, Block block, required: bool) -> void
+
+    def render: (RenderContext context, String buffer) -> void
+  end
+
+  class BlockDrop
+    @token: [Symbol, String?, Integer]
+
+    @context: RenderContext
+
+    @buffer: String
+
+    @name: String
+
+    @parent: [BlockTag, bool, Template, untyped?]?
+
+    attr_reader token: [Symbol, String?, Integer]
+
+    # @param token [[Symbol, String?, Integer]]
+    # @param context [RenderContext]
+    # @param name [String]
+    # @param parent [[BlockTag, bool, String, Block?]?]
+    def initialize: ([Symbol, String?, Integer] token, RenderContext context, String name, untyped parent) -> void
+
+    def to_s: () -> ::String
+
+    def key?: (untyped key) -> bool
+
+    def []: (untyped key) -> untyped
+  end
+end
+
+module Liquid2
+  class WithTag < Tag
+    @args: Array[KeywordArgument]
+
+    @block: Block
+
+    @blank: bool
+
+    END_BLOCK: Set[String]
+
+    # @param token [[Symbol, String?, Integer]]
+    # @param parser [Parser]
+    # @return [WithTag]
+    def self.parse: ([Symbol, String?, Integer] token, Parser parser) -> WithTag
+
+    # @param token [[Symbol, String?, Integer]]
+    # @param args [Array[KeywordArgument]]
+    # @param block [Block]
+    def initialize: ([Symbol, String?, Integer] token, Array[KeywordArgument] args, Block block) -> void
+
+    def render: (RenderContext context, String buffer) -> void
+
+    def children: (untyped _static_context, ?include_partials: bool) -> ::Array[Node]
+
+    def block_scope: () -> Array[Identifier]
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: liquid2
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - James Prior
@@ -51,6 +51,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 email:
 - jamesgr.prior@gmail.com
 executables: []
@@ -59,7 +73,6 @@ extra_rdoc_files: []
 files:
 - ".rubocop.yml"
 - ".ruby-version"
-- ".vscode/settings.json"
 - CHANGELOG.md
 - LICENSE.txt
 - LICENSE_SHOPIFY.txt

data/.vscode/settings.json

@@ -1,32 +0,0 @@
-{
-  "rubocop.mode": "enableUnconditionally",
-  "cSpell.words": [
-    "bigdecimal",
-    "bytesize",
-    "byteslice",
-    "charpos",
-    "Cyclomatic",
-    "endcapture",
-    "endcase",
-    "endcomment",
-    "endraw",
-    "forloop",
-    "ivar",
-    "keyreq",
-    "kwargs",
-    "ljust",
-    "lparen",
-    "lstrip",
-    "ndigits",
-    "nodoc",
-    "parentloop",
-    "rparen",
-    "rpartition",
-    "rstrip",
-    "tablerow",
-    "truncatewords"
-  ],
-  "cSpell.enabledFileTypes": {
-    "ruby": true
-  }
-}