luoma 0.1.0

data/sig/luoma/drop.rbs

@@ -0,0 +1,44 @@
+module Luoma
+  class Drop
+    include Enumerable[untyped]
+
+    #  (untyped, RenderContext) -> bool
+    def key?: (untyped obj, Luoma::RenderContext context) -> bool
+
+    #  (String, RenderContext) -> untyped
+    def fetch: (untyped name, Luoma::RenderContext context, ?default: untyped?) -> untyped
+
+    def each: () ?{ (?) -> untyped } -> untyped
+            
+    def to_a: () -> Array[untyped]
+            
+    #  (untyped, RenderContext) -> bool
+    def eq?: (untyped obj, Luoma::RenderContext context) -> bool
+
+    #  (untyped, RenderContext) -> bool
+    def lt?: (untyped obj, Luoma::RenderContext context) -> bool
+
+    #  (untyped, RenderContext) -> bool
+    def gt?: (untyped obj, Luoma::RenderContext context) -> bool
+           
+    #  (untyped, RenderContext) -> bool
+    def contains?: (untyped obj, Luoma::RenderContext context) -> bool
+
+    # Return the length of this object.
+    # Along with `#slice`,  `#length` is part of the iterator protocol.
+    #  (RenderContext) -> Integer
+    def length: (Luoma::RenderContext context) -> Integer
+
+    #  (Integer, Integer, Integer) -> Enumerable[untyped]
+    def slice: (Integer start, Integer stop, Integer step) -> untyped
+
+    #  (:data | :numeric | :string | :boolean, RenderContext) -> untyped
+    def to_primitive: (:data | :numeric | :string | :boolean hint, Luoma::RenderContext context) -> untyped
+
+    #  () -> String
+    def to_s: () -> String
+
+    #  (RenderContext) -> String?
+    def render: (RenderContext context) -> String?
+  end
+end

data/sig/luoma/drops/block.rbs

@@ -0,0 +1,10 @@
+module Luoma
+  class BlockDrop < Drop
+    @block: t_block
+
+    #  (t_block) -> void
+    def initialize: (t_block block) -> void
+
+    def render: (RenderContext context) -> string
+  end
+end

data/sig/luoma/drops/expression.rbs

@@ -0,0 +1,10 @@
+module Luoma
+  class ExpressionDrop < Drop
+    @expr: LambdaExpr
+
+    attr_reader expr: LambdaExpr
+
+    #  (LambdaExpr) -> void
+    def initialize: (LambdaExpr expr) -> void
+  end
+end

data/sig/luoma/drops/html_safe.rbs

@@ -0,0 +1,14 @@
+module Luoma
+  class HTMLSafe < Drop
+    @s: String
+
+    #  (String | HTMLSafe) -> HTMLSafe
+    def self.escape: (String | HTMLSafe value) -> HTMLSafe
+
+    #  (String | HTMLSafe) -> HTMLSafe
+    def self.from: (String | HTMLSafe value) -> HTMLSafe
+
+    #  (String) -> void
+    def initialize: (String s) -> void
+  end
+end

data/sig/luoma/drops/range.rbs

@@ -0,0 +1,15 @@
+module Luoma
+  class RangeDrop < Drop
+    @start: Integer
+
+    @stop: Integer
+
+    @range: Range[Integer]
+
+    attr_reader start: Integer
+
+    attr_reader stop: Integer
+
+    def initialize: (Integer start, Integer stop) -> void
+  end
+end

data/sig/luoma/drops/undefined.rbs

@@ -0,0 +1,27 @@
+module Luoma
+  attr_reader path: String
+
+  # The default and base "undefined" type.
+  class UndefinedDrop < Drop
+    @path: String
+
+    @token: t_token
+
+    @source: String
+
+    @template_name: String
+
+    #  (String, t_token, String, String) -> void
+    def initialize: (String path, t_token token, String source, String template_name) -> void
+
+    #  (untyped, RenderContext) -> bool
+    def eq?: (untyped obj, RenderContext context) -> bool
+  end
+
+  class StrictUndefinedDrop < UndefinedDrop
+    def error: () -> untyped
+  end
+
+  class FalsyStrictUndefinedDrop < StrictUndefinedDrop
+  end
+end

data/sig/luoma/environment.rbs

@@ -0,0 +1,212 @@
+module Luoma
+  type t_namespace = Hash[String, untyped]
+
+  interface _Namespace
+    def key?: (String) -> bool
+    def fetch: (String, ?::Symbol default) -> untyped
+    def []: (String) -> untyped
+    def nil?: () -> bool
+  end
+  
+  interface _Lexer
+    def tokenize: (Environment, String) -> Array[t_token]
+  end
+
+  interface _Parser
+    def parse: (Environment, String, String, Array[t_token]) -> t_block
+  end
+
+  class Environment
+    @auto_trim: '-' | '~' | nil
+
+    @globals: t_namespace?
+
+    @lexer: _Lexer
+
+    @loader: TemplateLoader
+
+    @parser: _Parser
+
+    @strict: bool
+
+    @suppress_blank_control_flow_blocks: bool
+
+    @undefined: singleton(UndefinedDrop)
+
+    @tags: Hash[String, _Tag]
+
+    @filters: Hash[String, untyped]
+
+    @predicates: Hash[String, ^(untyped) -> bool]
+
+    @max_assign_score_cumulative: Integer?
+
+    @max_assign_score: Integer?
+
+    @max_context_depth: Integer
+
+    @max_render_score_cumulative: Integer?
+
+    @max_render_score: Integer?
+    
+    @max_render_size: Integer?
+
+    @persistent_registers: Set[Symbol]
+
+    attr_accessor auto_trim: '-' | '~' | nil
+
+    attr_accessor globals: t_namespace?
+
+    attr_accessor lexer: _Lexer
+
+    attr_accessor loader: TemplateLoader
+
+    attr_accessor parser: _Parser
+
+    attr_reader filters: Hash[String, untyped]
+
+    attr_reader predicates: Hash[String, ^(untyped) -> bool]
+
+    attr_accessor strict: bool
+
+    attr_reader tags: Hash[String, _Tag]
+
+    attr_accessor undefined: singleton(UndefinedDrop)
+
+    attr_accessor max_assign_score_cumulative: Integer?
+
+    attr_accessor max_assign_score: Integer?
+
+    attr_accessor max_context_depth: Integer
+
+    attr_accessor max_render_score_cumulative: Integer?
+
+    attr_accessor max_render_score: Integer?
+
+    attr_accessor max_render_size: Integer?
+
+    attr_reader persistent_registers: Set[Symbol]
+
+    RE_INTEGER: Regexp
+
+    RE_DECIMAL: Regexp
+
+    def initialize: (
+      ?auto_trim: ('-' | '~' | nil), 
+      ?globals: t_namespace?, 
+      ?lexer: _Lexer, 
+      ?loader: TemplateLoader?, 
+      ?parser: _Parser, 
+      ?strict: bool, 
+      ?suppress_blank_control_flow_blocks: bool, 
+      ?undefined: singleton(UndefinedDrop),
+      ?max_assign_score_cumulative: Integer?,
+      ?max_assign_score: Integer?,
+      ?max_context_depth: Integer,
+      ?max_render_score_cumulative: Integer?,
+      ?max_render_score: Integer?,
+      ?max_render_size: Integer?
+    ) -> void
+
+    #  (String,
+    #   ?globals: t_namespace?,
+    #   ?name: String?,
+    #   ?overlay: t_namespace?,
+    #   ?up_to_date: Proc::_Callable?) -> Template
+    def parse: (String source, ?globals: t_namespace?, ?name: String?, ?overlay: t_namespace?, ?up_to_date: untyped?) -> Template
+
+    #  (String, ?t_namespace?) -> String
+    def render: (String source, ?t_namespace? data) -> String
+
+    #  (String, ?globals: t_namespace?, ?context: RenderContext?, **untyped) -> Template
+    def get_template: (String name, ?globals: t_namespace?, ?context: RenderContext?, **untyped kwargs) -> Template
+
+    # Add or replace a filter. The same callable can be registered multiple
+    # times with different names.
+    #
+    # When evaluated as a filter, _callable_ will be called with an instance of
+    # `FilterContext` as the first argument, and the result of the expression
+    # to the left of the pipe operator as the second argument.
+    #
+    # Remaining positional and keyword arguments are passed through from the
+    # filter invocation.
+    #
+    #: (String, untyped) -> void
+    def register_filter: (String name, untyped callable) -> void
+
+    # Remove a filter from the filter register.
+    #: (String) -> untyped
+    def delete_filter: (String name) -> void
+
+    # Add or replace a tag.
+    #: (String, _Tag) -> void
+    def register_tag: (String name, _Tag tag) -> void
+
+    # Remove a tag from the tag register.
+    #: (String) -> (_Tag | nil)
+    def delete_tag: (String name) -> _Tag?
+                  
+    # Add or replace a predicate function.
+    #: (String, ^(untyped) -> bool) -> void
+    def register_predicate: (String name, untyped callable) -> void
+
+    # Remove a predicate from the predicate register.
+    #: (String) -> (^(untyped) -> bool | nil)
+    def delete_predicate: (String name) -> untyped
+
+    #  () -> void
+    def setup_tags_filters_and_predicates: () -> void
+
+    #  (untyped, untyped, RenderContext, t_token) -> bool
+    def contains?: (untyped left, untyped right, RenderContext context, t_token token) -> bool
+
+    #  (untyped, untyped, RenderContext, t_token) -> bool
+    def eq?: (untyped left, untyped right, RenderContext context, t_token token) -> bool
+
+    #  (untyped, untyped, RenderContext, t_token) -> bool?
+    def lt?: (untyped left, untyped right, RenderContext context, t_token token) -> bool?
+
+    #  (untyped, untyped, RenderContext, t_token) -> (-1 | 1 | 0 | nil)
+    def cmp: (untyped left, untyped right, RenderContext context, t_token token) -> (-1 | 1 | 0 | nil)
+
+    #  (untyped) -> bool
+    def nothing?: (untyped obj) -> bool
+
+    #  (untyped, RenderContext) -> bool
+    def truthy?: (untyped obj, RenderContext context) -> bool
+
+    #  (untyped, RenderContext) -> String
+    def serialize: (untyped obj, RenderContext context) -> String
+                 
+    #  (untyped, RenderContext) -> Array[untyped]
+    def to_a: (untyped obj, RenderContext context) -> Array[untyped]
+    
+    #  (untyped, RenderContext) -> Hash[untyped, untyped]
+    def to_h: (untyped obj, RenderContext context) -> Hash[untyped, untyped]
+
+    # [X] (untyped, RenderContext, ?default: X) -> (Integer | X)
+    def to_i: [X] (untyped obj, RenderContext context, ?default: X) -> (Integer | X)
+
+    #  [X] (untyped, RenderContext, ?default: X) -> (Numeric | X)
+    def to_numeric: [X] (untyped obj, RenderContext context, ?default: X) -> (Numeric | X)
+
+    #  (untyped, RenderContext) -> Enumerable
+    def to_enumerable: (untyped obj, RenderContext context) -> Enumerable[untyped]
+
+    #  (untyped, RenderContext) -> String
+    def to_string: (untyped obj, RenderContext context) -> String
+                 
+    # Cast _obj_ to a  date and time. Return `nil` if casting fails.
+    # NOTE: This was copied from Shopify/liquid.
+    def to_date: (untyped obj, RenderContext context) -> untyped
+
+    #  (String, String?, String?) -> String
+    def trim: (String value, String? left, String? right) -> String
+
+    #  (t_namespace?) -> t_namespace?
+    def make_globals: (t_namespace? namespace) -> t_namespace?
+                    
+    #  (untyped, RenderContext) -> untyped
+    def to_data: (untyped obj, RenderContext context) -> untyped
+  end
+end

data/sig/luoma/errors.rbs

@@ -0,0 +1,67 @@
+module Luoma
+  # The base class for all template errors.
+  class LuomaError < StandardError
+  end
+
+  class DetailedLuomaError < LuomaError
+    @token: t_token
+
+    @template_name: String
+
+    @source: String
+
+    attr_accessor token: t_token
+
+    attr_accessor template_name: String
+
+    attr_accessor source: String
+
+    def initialize: (String message, t_token token, String source, String template_name) -> void
+
+    def detailed_message: (?highlight: bool, **untyped kwargs) -> String
+
+    def error_context: (String source, Integer index) -> [Integer, Integer, String]
+  end
+
+  class DisabledTagError < DetailedLuomaError
+  end
+
+  class FilterArgumentError < DetailedLuomaError
+  end
+
+  class FilterNotFoundError < DetailedLuomaError
+  end
+
+  class PredicateNotFoundError < DetailedLuomaError
+  end
+
+  class RequiredBlockError < TemplateInheritanceError
+  end
+
+  class ResourceLimitError < LuomaError
+  end
+
+  class ContextDepthError < ResourceLimitError
+  end
+
+  class TemplateInheritanceError < DetailedLuomaError
+  end
+
+  class TemplateNotFoundError < LuomaError
+  end
+
+  class NoSuchTemplateError < DetailedLuomaError
+  end
+
+  class TemplateSyntaxError < DetailedLuomaError
+  end
+
+  class TemplateTypeError < DetailedLuomaError
+  end
+
+  class UndefinedVariableError < DetailedLuomaError
+  end
+
+  class IncomparableValuesError < LuomaError
+  end
+end

data/sig/luoma/escape.rbs

@@ -0,0 +1,15 @@
+module Luoma
+  RE_ESCAPE: ::Regexp
+
+  ESCAPE_MAP: Hash[String, String]
+
+  RE_UNESCAPE: ::Regexp
+
+  UNESCAPE_MAP: Hash[String, String]
+
+  #  (String) -> String
+  def self.escape: (String s) -> String
+
+  #  (String) -> String
+  def self.unescape: (String s) -> String
+end