fmt 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67c0fef310f41def1104325bdcf64e0e74c00be1c491bde56e8dd18f93121711
-  data.tar.gz: fa7af34e9c94c03ebbd28d4843a0c268fe63304cd95bfde0c0b7cbca7d550916
+  metadata.gz: c5cab8d0eef24b2446c187520bd8a8ac2b71cef4149ff6d0370ffd04d67120d1
+  data.tar.gz: 3e5b6dca4adf86661850769bd7ca0191fe7f9b62b7c7c8612765bb5c5fb54c0b
 SHA512:
-  metadata.gz: b04858bb8cab7de025a11ecf941e175a698559b231c1878bbdf9f5762dcb3eb05cd822ee50b11a0739aa21ee5077ea9a448ef75a0e790e0587c39403e33ca303
-  data.tar.gz: eb55994dbd819d698b626ea170b56dec4177c02742f8b50da3e1d182704c7ff78043e31aece819ec47762cf6ab4297236d0698e2d80c6b5a974e19632817bccd
+  metadata.gz: ceeb6ab3f6d47a8863a35b90addf52135d31905be200c402819a516fa2600bbc0672e03d813555031bee131c865d44a92f3ad431863a3a4efd72ebe7ed3b7cc3
+  data.tar.gz: cfdbbdb355a735235b7417bc5b96a636c7e4392d8911178fbaa80e16a7127db41d388101cbdb8e14aa15c1562846d83a8546b8137c35cca3ade24aa695e39435

data/lib/fmt/parsers/embed_parser.rb

@@ -30,25 +30,18 @@ module Fmt
     # Extracts components for building the AST (Abstract Syntax Tree)
     # @rbs return: Hash[Symbol, Object] -- extracted components
     def extract
-      {}
+      source = urtext.delete_prefix(Sigils::EMBED_PREFIX).delete_suffix(Sigils::EMBED_SUFFIX)
+      {source: source}
     end
 
     # Transforms extracted components into an AST (Abstract Syntax Tree)
     # @rbs return: Node -- AST (Abstract Syntax Tree)
-    def transform(**)
+    def transform(source:)
       key = Node.new(:key, [self.key])
       placeholder = Node.new(:placeholder, [self.placeholder])
-      template = TemplateParser.new(template_urtext).parse
+      template = TemplateParser.new(source).parse
       children = [key, placeholder, template].reject(&:empty?)
-      Node.new(:embed, children, urtext: urtext, source: urtext)
-    end
-
-    private
-
-    # Returns the template urtext
-    # @rbs return: String
-    def template_urtext
-      urtext.delete_prefix(Sigils::EMBED_PREFIX).delete_suffix(Sigils::EMBED_SUFFIX)
+      Node.new(:embed, children, urtext: urtext, source: source)
     end
   end
 end

data/lib/fmt/parsers/macro_parser.rb

@@ -24,9 +24,7 @@ module Fmt
     # Extracts components for building the AST (Abstract Syntax Tree)
     # @rbs return: Hash[Symbol, Object] -- extracted components
     def extract
-      code = urtext
-      code = "#{Sigils::FORMAT_METHOD}('#{urtext}')" if native_format_string?(urtext)
-
+      code = urtext.delete_prefix(Sigils::FORMAT_PREFIX)
       tokens = tokenize(code)
       method = tokens.find(&:method_name?)&.value&.to_sym
 
@@ -46,7 +44,7 @@ module Fmt
     # @rbs arguments_tokens: Array[Token] -- arguments tokens
     # @rbs return: Node -- AST (Abstract Syntax Tree)
     def transform(method:, arguments_tokens:)
-      method = Node.new(:name, [method], urtext: urtext, source: method)
+      method = Node.new(:name, [method], urtext: urtext, source: method.to_s)
       arguments = ArgumentsParser.new(arguments_tokens).parse
       source = "#{method.source}#{arguments.source}"
       children = [method, arguments].reject(&:empty?)
@@ -102,12 +100,5 @@ module Fmt
       return false if arguments_started?(tokens) && !arguments_finished?(tokens)
       true
     end
-
-    # Indicates if a value is a Ruby native format string
-    # @rbs value: String -- value to check
-    # @rbs return: bool
-    def native_format_string?(value)
-      value.start_with? Sigils::FORMAT_PREFIX
-    end
   end
 end

data/lib/fmt/parsers/template_parser.rb

@@ -5,22 +5,18 @@
 module Fmt
   # Parses a template from a string and builds an AST (Abstract Syntax Tree)
   class TemplateParser < Parser
-    PIPELINE_HEAD = %r{(?=(?!#{esc Sigils::PIPE_OPERATOR})#{Sigils::FORMAT_PREFIX})}o   # : Regexp -- detects a native Ruby format string
-    PIPELINE_TAIL = %r{(?=(\s+#{Sigils::FORMAT_PREFIX})|\z)}o # : Regexp -- detects a pipeline suffix
-
-    EMBED_HEAD = %r{(?=#{esc Sigils::EMBED_PREFIX})}o # : Regexp -- detects an embed prefix
-    EMBED_TAIL = %r{#{esc Sigils::EMBED_SUFFIX}}o     # : Regexp -- detects an embed suffix
+    EMBED_PEEK = %r{(?=#{esc Sigils::EMBED_PREFIX})}o # : Regexp -- detects start of an embed prefix (look ahead)
+    PIPELINE_HEAD = %r{[#{Sigils::FORMAT_PREFIX}]}o # : Regexp -- detects start of a pipeline (i.e. Ruby format string)
+    PIPELINE_PEEK = %r{(?=[#{Sigils::FORMAT_PREFIX}][^#{Sigils::FORMAT_PREFIX}]|\z)}o # : Regexp -- detects start of a pipeline (look ahead)
+    PIPELINE_TAIL = %r{\s|\z}o # : Regexp -- detects end of a pipeline
 
     # Constructor
     # @rbs urtext: String -- original source code
-    # @rbs scanner: StringScanner?
-    def initialize(urtext = "", scanner: nil)
+    def initialize(urtext = "")
       @urtext = urtext.to_s
-      @scanner = scanner || StringScanner.new(@urtext)
     end
 
     attr_reader :urtext  # : String -- original source code
-    attr_reader :scanner # : StringScanner?
 
     # Parses the urtext (original source code)
     # @rbs return: Node -- AST (Abstract Syntax Tree)
@@ -36,11 +32,13 @@ module Fmt
     def extract
       source = urtext
 
-      embeds = extract_embeds
+      # 1) extract embeds first and update the source
+      embeds = extract_embeds(source)
       embeds.each do |embed|
-        source = "#{source[0...embed[:index]]}#{embed[:placeholder]}#{source[embed[:rindex]..]}"
+        source = source.sub(embed[:urtext], embed[:placeholder])
       end
 
+      # 2) extract pipelines
       pipelines = extract_pipelines(source)
 
       {embeds: embeds, pipelines: pipelines, source: source}
@@ -65,61 +63,100 @@ module Fmt
 
     private
 
-    # Extracts embed metadata from the urtext
-    # @rbs return: Array[Hash] -- extracted embeds
-    def extract_embeds
-      embeds = []
+    # Extracts the next embed with the scanner
+    # @rbs scanner: StringScanner -- scanner to extract from
+    # @rbs return: String? -- extracted embed
+    # def extract_next_embed(scanner)
+    #  return nil unless scanner.skip_until(EMBED_PEEK)
+
+    #  index = scanner.pos
+    #  rindex = index
+    #  stack = 0
+    #  string = scanner.string
+
+    #  while rindex < string.length
+    #    char = string.getbyte(rindex)
+
+    #    case char
+    #    when Sigils::EMBED_PREFIX.ord then stack += 1
+    #    when Sigils::EMBED_SUFFIX.ord then stack -= 1
+    #    end
+
+    #    rindex += 1
+    #    break if stack.zero?
+    #  end
+
+    #  stack.zero? ? string[index...rindex] : nil
+    # end
+    def extract_next_embed(scanner)
+      return nil unless scanner.skip_until(EMBED_PEEK)
+
+      string = scanner.string
+      index = scanner.pos
+      rindex = index
+      stack = 0
+
+      while rindex < string.length
+        case string[rindex]
+        in Sigils::EMBED_PREFIX[0] then break if (stack += 1).zero?
+        in Sigils::EMBED_SUFFIX[0] then break if (stack -= 1).zero?
+        else # noop
+        end
 
-      index = nil
-      embed = ""
+        rindex += 1
+      end
 
-      scanner = StringScanner.new(urtext)
-      scanner.skip_until(EMBED_HEAD)
+      scanner.pos = rindex
+      stack.zero? ? string[index...rindex] : nil
+    end
 
-      while scanner.matched?
-        index ||= scanner.charpos
-        embed = "#{embed}#{scanner.scan_until(EMBED_TAIL)}"
+    # Extracts embed metadata from the source
+    # @rbs return: Array[Hash] -- extracted embeds
+    def extract_embeds(source)
+      scanner = StringScanner.new(source)
 
-        if embed.scan(EMBED_HEAD).size == embed.scan(EMBED_TAIL).size
-          rindex = scanner.charpos
-          key = :"embed_#{index}_#{rindex}"
+      # will iterate until extract_next_embed returns nil... when run
+      generator = Enumerator.new do |yielder|
+        while (embed = extract_next_embed(scanner))
+          yielder << embed
+        end
+      end
 
-          embeds << {
-            index: index,
-            rindex: rindex,
-            key: key,
-            placeholder: "#{Sigils::FORMAT_PREFIX}#{Sigils::KEY_PREFIXES[-1]}#{key}#{Sigils::KEY_SUFFIXES[-1]}",
-            urtext: embed
-          }
+      # runs the generator and returns the resulting array
+      embeds = generator.to_a
 
-          index = nil
-          embed = scanner.skip_until(EMBED_HEAD)
-        end
+      embeds.map.with_index do |embed, index|
+        key = :"embed_#{index}"
+        placeholder = "#{Sigils::FORMAT_PREFIX}#{Sigils::KEY_PREFIXES[-1]}#{key}#{Sigils::KEY_SUFFIXES[-1]}"
+        {key: key, placeholder: placeholder, urtext: embed}
       end
+    end
 
-      embeds
+    # Extracts the next pipeline with the scanner
+    # @rbs scanner: StringScanner -- scanner to extract from
+    # @rbs return: String? -- extracted pipeline
+    def extract_next_pipeline(scanner)
+      return nil unless scanner.skip_until(PIPELINE_HEAD)
+
+      index = scanner.pos
+      rindex = scanner.skip_until(PIPELINE_PEEK) ? scanner.pos : scanner.terminate.pos
+      pipeline = scanner.string[index - 1...rindex].strip
+      pipeline.rpartition(PIPELINE_TAIL).first
     end
 
     # Extracts pipelines from the source
     # @rbs source: String -- source code to extract pipelines from
     # @rbs return: Array[String] -- extracted pipelines
     def extract_pipelines(source)
-      pipelines = []
-      pipeline = ""
-
       scanner = StringScanner.new(source)
-      scanner.skip_until(PIPELINE_HEAD)
-
-      while scanner.matched?
-        pipeline = scanner.scan_until(PIPELINE_TAIL)
 
-        if scanner.matched?
-          pipelines << pipeline
-          scanner.skip_until(PIPELINE_HEAD)
+      generator = Enumerator.new do |yielder|
+        while (pipeline = extract_next_pipeline(scanner))
+          yielder << pipeline
         end
       end
 
-      pipelines
+      generator.to_a
     end
   end
 end

data/lib/fmt/renderer.rb

@@ -23,45 +23,37 @@ module Fmt
     def render(*args, **kwargs)
       raise Error, "positional and keyword arguments are mutually exclusive" if args.any? && kwargs.any?
 
-      context = template.source
-
-      render_embeds(context, *args, **kwargs) do |embed, result|
+      render_embeds(*args, **kwargs) do |embed, result|
         kwargs[embed.key] = result
       end
 
-      render_pipelines(context, *args, **kwargs)
+      rendered = template.source
+      render_pipelines(*args, **kwargs) do |pipeline, result|
+        rendered = rendered.sub(pipeline.urtext, result.to_s)
+      end
+      rendered
     end
 
     private
 
-    # Escapes a string for use in a regular expression
-    # @rbs value: String -- string to escape
-    # @rbs return: String -- escaped string
-    def esc(value) = Regexp.escape(value.to_s)
-
     # 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(context, *args, **kwargs)
+    # @rbs &block: Proc                 -- block executed for each embed (signature: Proc(Embed, String))
+    def render_embeds(*args, **kwargs)
       template.embeds.each do |embed|
         yield embed, Renderer.new(embed.template).render(*args, **kwargs)
       end
     end
 
     # 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(context, *args, **kwargs)
+    # @rbs block: Proc                  -- block executed for each pipeline (signature: Proc(Pipeline, String))
+    def render_pipelines(*args, **kwargs)
       template.pipelines.each_with_index do |pipeline, index|
-        result = render_pipeline(pipeline, *args[index..], **kwargs)
-        context = context.sub(pipeline.urtext, result)
+        yield pipeline, render_pipeline(pipeline, *args[index..], **kwargs)
       end
-
-      context
     end
 
     # Renders a single pipeline
@@ -70,55 +62,53 @@ module Fmt
     # @rbs kwargs: Hash[Symbol, Object] -- keyword arguments (user provided)
     # @rbs return: String
     def render_pipeline(pipeline, *args, **kwargs)
-      result = ""
+      result = nil
 
       pipeline.macros.each do |macro|
-        result = case macro
-        in name: Sigils::FORMAT_METHOD
-          case [args, kwargs]
-          in [], {} then invoke_formatter(macro)
-          in [], {**} => kwargs then invoke_formatter(macro, **kwargs)
-          in [*], {} then invoke_formatter(macro, *args)
-          in [*], {**} => kwargs then invoke_formatter(macro, *args, **kwargs)
-          end
-        else invoke_macro(result, macro)
-        end
+        result = invoke_macro(result, macro, *args, **kwargs)
       end
 
       result
     end
 
-    # 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, *args, **kwargs)
-      callable = Fmt.registry[[Kernel, macro.name]]
-      context = macro.arguments.args[0]
-      context.instance_exec(*args, **kwargs, &callable)
-    rescue => error
-      raise_format_error(macro, *args, cause: error, **kwargs)
-    end
-
     # Invokes a macro
     # @rbs context: Object              -- self in callable (Proc)
     # @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: Object               -- result
-    def invoke_macro(context, macro)
+    def invoke_macro(context, macro, *args, **kwargs)
       callable = Fmt.registry[[context.class, macro.name]] || Fmt.registry[[Object, macro.name]]
-      raise Error, "[#{context.class.name} | Object, #{macro.name}] is not a registered formatter!" unless callable
-
-      args = macro.arguments.args
-      kwargs = macro.arguments.kwargs
 
-      context.instance_exec(*args, **kwargs, &callable)
+      case callable
+      in nil
+        if kwargs.key? macro.name
+          kwargs[macro.name]
+        else
+          quietly do
+            context.instance_exec { sprintf(macro.urtext, *args, **kwargs) }
+          end
+        end
+      else
+        context.instance_exec(*macro.arguments.args, **macro.arguments.kwargs, &callable)
+      end
     rescue => error
       args ||= []
       kwargs ||= {}
       raise_format_error(macro, *args, cause: error, **kwargs)
     end
 
+    # Suppresses verbose output for the duration of the block
+    # @rbs block: Proc -- block to execute
+    # @rbs return: void
+    def quietly
+      verbose = $VERBOSE
+      $VERBOSE = nil
+      yield
+    ensure
+      $VERBOSE = verbose
+    end
+
     # Raises an invocation error if/when Proc invocations fail
     # @rbs macro: Macro                 -- macro that failed
     # @rbs args: Array[Object]          -- positional arguments (user provided)

data/lib/fmt/version.rb

@@ -3,5 +3,5 @@
 # rbs_inline: enabled
 
 module Fmt
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/sig/generated/fmt/parsers/embed_parser.rbs

@@ -25,12 +25,6 @@ module Fmt
 
     # Transforms extracted components into an AST (Abstract Syntax Tree)
     # @rbs return: Node -- AST (Abstract Syntax Tree)
-    def transform: (**untyped) -> Node
-
-    private
-
-    # Returns the template urtext
-    # @rbs return: String
-    def template_urtext: () -> String
+    def transform: (source: untyped) -> Node
   end
 end

data/sig/generated/fmt/parsers/macro_parser.rbs

@@ -51,10 +51,5 @@ module Fmt
     # @rbs tokens: Array[Token] -- tokens to check
     # @rbs return: bool
     def finished?: (Array[Token] tokens) -> bool
-
-    # Indicates if a value is a Ruby native format string
-    # @rbs value: String -- value to check
-    # @rbs return: bool
-    def native_format_string?: (String value) -> bool
   end
 end

data/sig/generated/fmt/parsers/template_parser.rbs

@@ -3,23 +3,20 @@
 module Fmt
   # Parses a template from a string and builds an AST (Abstract Syntax Tree)
   class TemplateParser < Parser
-    PIPELINE_HEAD: ::Regexp
+    EMBED_PEEK: ::Regexp
 
-    PIPELINE_TAIL: ::Regexp
+    PIPELINE_HEAD: ::Regexp
 
-    EMBED_HEAD: ::Regexp
+    PIPELINE_PEEK: ::Regexp
 
-    EMBED_TAIL: ::Regexp
+    PIPELINE_TAIL: ::Regexp
 
     # Constructor
     # @rbs urtext: String -- original source code
-    # @rbs scanner: StringScanner?
-    def initialize: (?String urtext, ?scanner: StringScanner?) -> untyped
+    def initialize: (?String urtext) -> untyped
 
     attr_reader urtext: untyped
 
-    attr_reader scanner: untyped
-
     # Parses the urtext (original source code)
     # @rbs return: Node -- AST (Abstract Syntax Tree)
     def parse: () -> Node
@@ -38,9 +35,18 @@ module Fmt
 
     private
 
-    # Extracts embed metadata from the urtext
+    # stack.zero? ? string[index...rindex] : nil
+    # end
+    def extract_next_embed: (untyped scanner) -> untyped
+
+    # Extracts embed metadata from the source
     # @rbs return: Array[Hash] -- extracted embeds
-    def extract_embeds: () -> Array[Hash]
+    def extract_embeds: (untyped source) -> Array[Hash]
+
+    # Extracts the next pipeline with the scanner
+    # @rbs scanner: StringScanner -- scanner to extract from
+    # @rbs return: String? -- extracted pipeline
+    def extract_next_pipeline: (StringScanner scanner) -> String?
 
     # Extracts pipelines from the source
     # @rbs source: String -- source code to extract pipelines from

data/sig/generated/fmt/renderer.rbs

@@ -20,24 +20,17 @@ module Fmt
 
     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
+    # @rbs &block: Proc                 -- block executed for each embed (signature: Proc(Embed, String))
+    def render_embeds: (*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
+    # @rbs block: Proc                  -- block executed for each pipeline (signature: Proc(Pipeline, String))
+    def render_pipelines: (*untyped args, **untyped kwargs) -> untyped
 
     # Renders a single pipeline
     # @rbs pipeline: Pipeline           -- pipeline to render
@@ -46,18 +39,18 @@ module Fmt
     # @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 args: Array[Object]          -- positional arguments (user provided)
+    # @rbs kwargs: Hash[Symbol, Object] -- keyword arguments (user provided)
     # @rbs return: Object               -- result
-    def invoke_macro: (Object context, Macro macro) -> Object
+    def invoke_macro: (Object context, Macro macro, *untyped args, **untyped kwargs) -> Object
+
+    # Suppresses verbose output for the duration of the block
+    # @rbs block: Proc -- block to execute
+    # @rbs return: void
+    def quietly: () -> void
 
     # Raises an invocation error if/when Proc invocations fail
     # @rbs macro: Macro                 -- macro that failed

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmt
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Nate Hopkins (hopsoft)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-22 00:00:00.000000000 Z
+date: 2024-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ast
@@ -301,7 +301,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: CLI Templating System and String Formatter