fmt 0.1.2 → 0.3.0

data/sig/generated/fmt/registries/registry.rbs

@@ -0,0 +1,69 @@
+# Generated from lib/fmt/registries/registry.rb with RBS::Inline
+
+module Fmt
+  # Registry for storing and retrieving String formatters i.e. Procs
+  class Registry
+    extend Forwardable
+
+    INSTANCE_VAR: ::Symbol
+
+    # Constructor
+    def initialize: () -> untyped
+
+    # Indicates if a method name is registered for any Class
+    # @rbs method_name: Symbol -- method name to check
+    # @rbs return: bool
+    def any?: (Symbol method_name) -> bool
+
+    # Indicates if a method name is unregistered
+    # @rbs method_name: Symbol -- method name to check
+    # @rbs return: bool
+    def none?: (Symbol method_name) -> bool
+
+    # Adds a keypair to the registry
+    # @rbs key: Array[Class | Module, Symbol] -- key to use
+    # @rbs overwrite: bool -- overwrite the existing keypair (default: false)
+    # @rbs block: Proc -- Proc to add (optional, if proc is provided)
+    # @rbs return: Proc
+    def add: (Array[Class | Module, Symbol] key, ?overwrite: bool) ?{ (?) -> untyped } -> Proc
+
+    # Deletes a keypair from the registry
+    # @rbs key: Array[Class | Module, Symbol] -- key to delete
+    # @rbs return: Proc?
+    def delete: (Array[Class | Module, Symbol] key) -> Proc?
+
+    # Fetches a Proc from the registry
+    # @rbs key: Array[Class | Module, Symbol] -- key to retrieve
+    # @rbs callable: Proc -- Proc to use if the key is not found (optional, if block is provided)
+    # @rbs block: Proc -- block to use if the key is not found (optional, if proc is provided)
+    # @rbs return: Proc
+    def fetch: (Array[Class | Module, Symbol] key, ?callable: Proc) ?{ (?) -> untyped } -> Proc
+
+    # Retrieves the registered key for a Proc
+    # @rbs callable: Proc -- Proc to retrieve the key for
+    # @rbs return: Symbol?
+    def key_for: (Proc callable) -> Symbol?
+
+    # Merges another registry into this one
+    # @rbs other: Fmt::Registry -- other registry to merge
+    # @rbs return: Fmt::Registry
+    def merge!: (Fmt::Registry other) -> Fmt::Registry
+
+    # Executes a block with registry overrides
+    #
+    # @note Overrides will temporarily be added to the registry
+    #       and will overwrite existing entries for the duration of the block
+    #       Non overriden entries remain unchanged
+    #
+    # @rbs overrides: Hash[Array[Class | Module, Symbol], Proc] -- overrides to apply
+    # @rbs block: Proc -- block to execute with overrides
+    # @rbs return: void
+    def with_overrides: (Hash[Array[Class | Module, Symbol], Proc] overrides) ?{ (?) -> untyped } -> void
+
+    attr_reader store: untyped
+
+    # Hash of registered method names
+    # @rbs return: Hash[Symbol, TrueClass]
+    def method_names: () -> Hash[Symbol, TrueClass]
+  end
+end

data/sig/generated/fmt/renderer.rbs

@@ -0,0 +1,70 @@
+# Generated from lib/fmt/renderer.rb with RBS::Inline
+
+module Fmt
+  # Renders templates to a formatted string
+  class Renderer
+    PIPELINE_START: untyped
+
+    # Constructor
+    # @rbs template: Template
+    def initialize: (Template template) -> untyped
+
+    attr_reader template: untyped
+
+    # Renders the template to a string
+    # @note Positional and Keyword arguments are mutually exclusive
+    # @rbs args: Array[Object]          -- positional arguments (user provided)
+    # @rbs kwargs: Hash[Symbol, Object] -- keyword arguments (user provided)
+    # @rbs return: String               -- rendered template
+    def render: (*untyped args, **untyped kwargs) -> String
+
+    private
+
+    # Escapes a string for use in a regular expression
+    # @rbs value: String -- string to escape
+    # @rbs return: String -- escaped string
+    def esc: (String value) -> String
+
+    # Renders all template embeds
+    # @rbs context: String              -- starting context
+    # @rbs args: Array[Object]          -- positional arguments (user provided)
+    # @rbs kwargs: Hash[Symbol, Object] -- keyword arguments (user provided)
+    # @rbs &block: Proc                 -- block to execute after rendering embeds (signature: Proc(String, *args, **kwargs))
+    def render_embeds: (String context, *untyped args, **untyped kwargs) -> untyped
+
+    # Renders all template pipelines
+    # @rbs context: String              -- starting context
+    # @rbs args: Array[Object]          -- positional arguments (user provided)
+    # @rbs kwargs: Hash[Symbol, Object] -- keyword arguments (user provided)
+    # @rbs return: String
+    def render_pipelines: (String context, *untyped args, **untyped kwargs) -> String
+
+    # Renders a single pipeline
+    # @rbs pipeline: Pipeline           -- pipeline to render
+    # @rbs args: Array[Object]          -- positional arguments (user provided)
+    # @rbs kwargs: Hash[Symbol, Object] -- keyword arguments (user provided)
+    # @rbs return: String
+    def render_pipeline: (Pipeline pipeline, *untyped args, **untyped kwargs) -> String
+
+    # Invokes native Ruby string formatting
+    # @rbs macro: Macro                 -- macro to use (source, arguments, etc.)
+    # @rbs args: Array[Object]          -- positional arguments (user provided)
+    # @rbs kwargs: Hash[Symbol, Object] -- keyword arguments (user provided)
+    # @rbs return: String
+    def invoke_formatter: (Macro macro, *untyped args, **untyped kwargs) -> String
+
+    # Invokes a macro
+    # @rbs context: Object              -- self in callable (Proc)
+    # @rbs macro: Macro                 -- macro to use (source, arguments, etc.)
+    # @rbs return: Object               -- result
+    def invoke_macro: (Object context, Macro macro) -> Object
+
+    # Raises an invocation error if/when Proc invocations fail
+    # @rbs macro: Macro                 -- macro that failed
+    # @rbs args: Array[Object]          -- positional arguments (user provided)
+    # @rbs cause: Exception             -- exception that caused the error
+    # @rbs kwargs: Hash[Symbol, Object] -- keyword arguments (user provided)
+    # @rbs return: void
+    def raise_format_error: (Macro macro, *untyped args, cause: Exception, **untyped kwargs) -> void
+  end
+end

data/sig/generated/fmt/sigils.rbs

@@ -0,0 +1,30 @@
+# Generated from lib/fmt/sigils.rb with RBS::Inline
+
+module Fmt
+  # Common Fmt sigils (used in String templates)
+  class Sigils
+    # Native Ruby format specifiers
+    # @see https://docs.ruby-lang.org/en/master/format_specifications_rdoc.html
+    FORMAT_PREFIX: ::String
+
+    FORMAT_SPECIFIERS: untyped
+
+    FORMAT_FLAGS: untyped
+
+    FORMAT_METHOD: ::Symbol
+
+    KEY_PREFIXES: untyped
+
+    KEY_SUFFIXES: untyped
+
+    ARGS_PREFIX: ::String
+
+    ARGS_SUFFIX: ::String
+
+    PIPE_OPERATOR: ::String
+
+    EMBED_PREFIX: ::String
+
+    EMBED_SUFFIX: ::String
+  end
+end

data/sig/generated/fmt/token.rbs

@@ -0,0 +1,77 @@
+# Generated from lib/fmt/token.rb with RBS::Inline
+
+module Fmt
+  # Convenience wrapper for Ripper tokens
+  #
+  # @see https://rubyapi.org/3.4/o/ripper
+  # @see doc/RIPPER.md (cheetsheet)
+  #
+  # @example Ripper Token
+  #   [[lineno, column], type, token, state]
+  #   [[Integer, Integer], Symbol, String, Object]
+  class Token
+    include Matchable
+
+    # Constructor
+    # @rbs ripper_token: Array[[Integer, Integer], Symbol, String, Object] -- Ripper token
+    def initialize: (Array[[ Integer, Integer ], Symbol, String, Object] ripper_token) -> untyped
+
+    attr_reader ripper_token: untyped
+
+    attr_reader lineno: untyped
+
+    attr_reader column: untyped
+
+    attr_reader type: untyped
+
+    attr_reader token: untyped
+
+    attr_reader state: untyped
+
+    # Returns a Hash representation of the token
+    # @rbs return: Hash[Symbol, Object]
+    def to_h: () -> Hash[Symbol, Object]
+
+    # Returns a Hash representation of the token limited to the given keys
+    # @rbs keys: Array[Symbol] -- keys to include
+    # @rbs return: Hash[Symbol, Object]
+    def deconstruct_keys: (?Array[Symbol] keys) -> Hash[Symbol, Object]
+
+    # Indicates if the token is a left paren (i.e. start of arguments)
+    # @rbs return: bool
+    def arguments_start?: () -> bool
+
+    # Indicates if the token is a right paren (i.e. end of arguments)
+    # @rbs return: bool
+    def arguments_finish?: () -> bool
+
+    # Indicates if the token starts a key (string formatting named parameter)
+    # @rbs return: bool
+    def key_start?: () -> bool
+
+    # Indicates if the token finishes a key (string formatting named parameter)
+    # @rbs return: bool
+    def key_finish?: () -> bool
+
+    # Indicates if the token is an identifier (e.g. method name, format specifier, variable name, etc.)
+    # @rbs return: bool
+    def identifier?: () -> bool
+
+    # Indicates if the token is a method name (i.e. method name or operator)
+    # @rbs return: bool
+    def method_name?: () -> bool
+
+    # Indicates if the token is an operator
+    # @rbs return: bool
+    def operator?: () -> bool
+
+    # Indicates if the token is a whitespace
+    # @rbs return: bool
+    def whitespace?: () -> bool
+
+    # Indicates if the token is a native String format specifier
+    # @see Sigils::FORMAT_SPECIFIERS
+    # @rbs return: bool
+    def specifier?: () -> bool
+  end
+end

data/sig/generated/fmt/tokenizer.rbs

@@ -0,0 +1,51 @@
+# Generated from lib/fmt/tokenizer.rb with RBS::Inline
+
+module Fmt
+  # Ruby source code token extractor
+  #
+  # Uses Ripper from Ruby's standard library
+  # @see https://rubyapi.org/3.4/o/ripper
+  # @see doc/RIPPER.md (cheetsheet)
+  #
+  # @example Ripper token
+  #   [[lineno, column], type, token, state]
+  #   [[Integer, Integer], Symbol, String, Object]
+  class Tokenizer
+    # Constructor
+    # @rbs urtext: String -- original source code
+    def initialize: (String urtext) -> untyped
+
+    attr_reader urtext: untyped
+
+    attr_reader tokens: untyped
+
+    # Tokenizes the urtext (original source code)
+    # @rbs return: Array[Token] -- wrapped ripper tokens
+    def tokenize: () -> Array[Token]
+
+    # Returns identifier tokens (typically method names)
+    # @rbs start: Integer -- start index
+    # @rbs return: Array[Token]
+    def identifier_tokens: (?start: Integer) -> Array[Token]
+
+    # Returns method tokens (identifiers and operators)
+    # @rbs start: Integer -- start index
+    # @rbs return: Array[Token]
+    def method_name_tokens: (?start: Integer) -> Array[Token]
+
+    # Returns key (named parameter) tokens
+    # @rbs start: Integer -- start index
+    # @rbs return: Array[Token]?
+    def key_tokens: (?start: Integer) -> Array[Token]?
+
+    # Returns operator tokens
+    # @rbs start: Integer -- start index
+    # @rbs return: Array[Token]
+    def operator_tokens: (?start: Integer) -> Array[Token]
+
+    # Returns the argument tokens
+    # @rbs start: Integer -- start index
+    # @rbs return: Array[Token]
+    def argument_tokens: (?start: Integer) -> Array[Token]
+  end
+end

data/sig/generated/fmt/version.rbs

@@ -0,0 +1,5 @@
+# Generated from lib/fmt/version.rb with RBS::Inline
+
+module Fmt
+  VERSION: ::String
+end

data/sig/generated/fmt.rbs

@@ -0,0 +1,41 @@
+# Generated from lib/fmt.rb with RBS::Inline
+
+# Extends native Ruby String format specifications
+# @see https://ruby-doc.org/3.3.4/format_specifications_rdoc.html
+module Fmt
+  LOCK: untyped
+
+  # Standard error class for Fmt
+  class Error < StandardError
+  end
+
+  # Error for formatting failures
+  class FormatError < Error
+  end
+
+  # Global registry for storing and retrieving String formatters i.e. Procs
+  def self.registry: () -> untyped
+
+  # Adds a keypair to the registry
+  # @rbs key: Array[Class | Module, Symbol] -- key to use
+  # @rbs overwrite: bool -- overwrite the existing keypair (default: false)
+  # @rbs block: Proc -- Proc to add (optional, if proc is provided)
+  # @rbs return: Proc
+  def self.register: () -> Proc
+
+  # Deletes a keypair from the registry
+  # @rbs key: Array[Class | Module, Symbol] -- key to delete
+  # @rbs return: Proc?
+  def self.unregister: () -> Proc?
+
+  # Executes a block with registry overrides
+  #
+  # @note Overrides will temporarily be added to the registry
+  #       and will overwrite existing entries for the duration of the block
+  #       Non overriden entries remain unchanged
+  #
+  # @rbs overrides: Hash[Array[Class | Module, Symbol], Proc] -- overrides to apply
+  # @rbs block: Proc -- block to execute with overrides
+  # @rbs return: void
+  def self.with_overrides: () -> void
+end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: fmt
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Nate Hopkins (hopsoft)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-29 00:00:00.000000000 Z
+date: 2024-09-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.1.4
 - !ruby/object:Gem::Dependency
   name: amazing_print
   requirement: !ruby/object:Gem::Requirement
@@ -25,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: magic_frozen_string_literal
+  name: fiddle
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-cc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rbs-inline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: tocer
   requirement: !ruby/object:Gem::Requirement
@@ -150,7 +220,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A simple template engine based on native Ruby String formatting mechanics
+description: Pipeline driven template engine based on native Ruby String formatting
 email:
 - natehop@gmail.com
 executables: []
@@ -159,17 +229,57 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/fmt.rb
-- lib/fmt/embed.rb
-- lib/fmt/filter.rb
-- lib/fmt/filters.rb
-- lib/fmt/formatter.rb
-- lib/fmt/scanners.rb
-- lib/fmt/scanners/base_scanner.rb
-- lib/fmt/scanners/embed_scanner.rb
-- lib/fmt/scanners/filter_scanner.rb
-- lib/fmt/scanners/key_scanner.rb
-- lib/fmt/transformer.rb
+- lib/fmt/boot.rb
+- lib/fmt/lru_cache.rb
+- lib/fmt/mixins/matchable.rb
+- lib/fmt/models/arguments.rb
+- lib/fmt/models/embed.rb
+- lib/fmt/models/macro.rb
+- lib/fmt/models/model.rb
+- lib/fmt/models/pipeline.rb
+- lib/fmt/models/template.rb
+- lib/fmt/node.rb
+- lib/fmt/parsers/arguments_parser.rb
+- lib/fmt/parsers/embed_parser.rb
+- lib/fmt/parsers/macro_parser.rb
+- lib/fmt/parsers/parser.rb
+- lib/fmt/parsers/pipeline_parser.rb
+- lib/fmt/parsers/template_parser.rb
+- lib/fmt/refinements/kernel_refinement.rb
+- lib/fmt/registries/native_registry.rb
+- lib/fmt/registries/rainbow_registry.rb
+- lib/fmt/registries/registry.rb
+- lib/fmt/renderer.rb
+- lib/fmt/sigils.rb
+- lib/fmt/token.rb
+- lib/fmt/tokenizer.rb
 - lib/fmt/version.rb
+- sig/generated/fmt.rbs
+- sig/generated/fmt/boot.rbs
+- sig/generated/fmt/lru_cache.rbs
+- sig/generated/fmt/mixins/matchable.rbs
+- sig/generated/fmt/models/arguments.rbs
+- sig/generated/fmt/models/embed.rbs
+- sig/generated/fmt/models/macro.rbs
+- sig/generated/fmt/models/model.rbs
+- sig/generated/fmt/models/pipeline.rbs
+- sig/generated/fmt/models/template.rbs
+- sig/generated/fmt/node.rbs
+- sig/generated/fmt/parsers/arguments_parser.rbs
+- sig/generated/fmt/parsers/embed_parser.rbs
+- sig/generated/fmt/parsers/macro_parser.rbs
+- sig/generated/fmt/parsers/parser.rbs
+- sig/generated/fmt/parsers/pipeline_parser.rbs
+- sig/generated/fmt/parsers/template_parser.rbs
+- sig/generated/fmt/refinements/kernel_refinement.rbs
+- sig/generated/fmt/registries/native_registry.rbs
+- sig/generated/fmt/registries/rainbow_registry.rbs
+- sig/generated/fmt/registries/registry.rbs
+- sig/generated/fmt/renderer.rbs
+- sig/generated/fmt/sigils.rbs
+- sig/generated/fmt/token.rbs
+- sig/generated/fmt/tokenizer.rbs
+- sig/generated/fmt/version.rbs
 homepage: https://github.com/hopsoft/fmt
 licenses:
 - MIT
@@ -191,8 +301,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
-summary: A simple template engine based on native Ruby String formatting mechanics
+summary: Pipeline driven template engine based on native Ruby String formatting
 test_files: []

data/lib/fmt/embed.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Fmt
-  class Embed
-    def initialize(string)
-      @string = string
-    end
-
-    attr_reader :string
-
-    def placeholder
-      "{{#{string}}}"
-    end
-
-    def format(**locals)
-      Fmt(string, **locals)
-    end
-  end
-end

data/lib/fmt/filter.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Fmt
-  class Filter
-    def initialize(name, value)
-      raise ArgumentError, "value must be a String or Proc" unless value.is_a?(String) || value.is_a?(Proc)
-      @name = name
-      @value = value
-    end
-
-    attr_reader :name, :value
-
-    def apply(string)
-      case value
-      when String then sprintf("%#{filter.value}", string)
-      when Proc then filter.value.call(string)
-      end
-    end
-
-    def string?
-      value.is_a? String
-    end
-
-    def proc?
-      value.is_a? Proc
-    end
-
-    def inspect
-      "#<#{self.class.name} name=#{name.inspect} value=#{value.inspect}>"
-    end
-  end
-end

data/lib/fmt/filters.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-require "monitor"
-require_relative "filter"
-
-module Fmt
-  class Filters
-    include Enumerable
-    include MonitorMixin
-
-    NATIVE_FILTERS = %i[
-      capitalize
-      chomp
-      chop
-      downcase
-      lstrip
-      reverse
-      rstrip
-      shellescape
-      strip
-      succ
-      swapcase
-      undump
-      unicode_normalize
-      upcase
-    ]
-
-    def initialize
-      super
-      @entries = {}
-
-      NATIVE_FILTERS.each do |name|
-        add(name) { |str| str.then(&:"#{name}") }
-      end
-
-      if defined? Rainbow
-        begin
-          Rainbow::Presenter.public_instance_methods(false).each do |name|
-            next unless Rainbow::Presenter.public_instance_method(name).arity == 0
-            add(name) { |str| Rainbow(str).public_send(name) }
-          end
-
-          Rainbow::X11ColorNames::NAMES.keys.each do |name|
-            add(name) { |str| Rainbow(str).public_send(name) }
-          end
-        rescue => error
-          puts "Error adding Rainbow filters! #{error.inspect}"
-        end
-      end
-    end
-
-    def each(&block)
-      entries.each(&block)
-    end
-
-    def add(name, filter = nil, &block)
-      raise ArgumentError, "filter and block are mutually exclusive" if filter && block
-      raise ArgumentError, "filter must be a Proc" unless block || filter.is_a?(Proc)
-      entries[name.to_sym] = Filter.new(name, filter || block)
-    end
-
-    alias_method :<<, :add
-
-    def [](name)
-      synchronize { entries[name.to_sym] }
-    end
-
-    def fetch(name, default = nil)
-      synchronize { entries.fetch name.to_sym, default }
-    end
-
-    private
-
-    attr_reader :entries
-  end
-end