fmt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 546ccf984763e8c2f3590f1fead68a1a7c9f0a874fefd241df21b2cb54550aac
+  data.tar.gz: 81cd66780873959882857eeffe05abea6bcf447e4de64946daf089c1efe05ab1
+SHA512:
+  metadata.gz: 8c72adc7487d3352361e5ad8f56fda9c623351112dd377542830023e165c98cd6abfac7526b632f4f2a689dddd0bba1c34f901bfdee6ee72d067271e5cb17458
+  data.tar.gz: 6c625ceeabf0aec90bda2945247eb648e5bb05ca41cf6f7b7a139c0366d8d8794f239fcb7a3e0e81b24017494e98a4bc826e55423764206986481c85e94e5186

data/README.md

@@ -0,0 +1,80 @@
+# Fmt
+
+Fmt is a simple template engine based on native Ruby String formatting mechanics.
+
+## Why?
+
+I'm currenly using this to help build beautiful CLI applications with Ruby. Plus it's fun.
+
+## Setup
+
+```
+bundle add fmt
+bundle add rainbow # optional
+```
+
+## Usage
+
+Simply create a string with embedded formatting syntax as you'd normally do with `sprintf` or `format`.
+i.e. `"%{...}"`
+
+Filters can be chained after the placeholder like so `"%{...}FILTER|FILTER|FILTER"`
+Filters are processed in the order they are specified.
+
+You can use native Ruby formatting as well as String methods like `upcase`, `reverse`, `strip`, etc.
+If you have the Rainbow GEM installed, you can also use Rainbow formatting like `red`, `bold`, etc.
+
+### Rendering
+
+Basic example:
+
+```ruby
+require "fmt"
+
+template = "Hello %{name}cyan|bold"
+result = Fmt(template, name: "World")
+#=> "Hello \e[36m\e[1mWorld\e[0m"
+```
+
+Mix and match native formatting with Rainbow formatting:
+
+```ruby
+require "fmt"
+
+template = "Date: %{date}.10s|magenta"
+result = Fmt(template, date: Time.now)
+#=> "Date: \e[35m2024-07-26\e[0m"
+```
+
+Multiline example:
+
+```ruby
+template = <<~T
+  Date: %{date}.10s|underline
+
+  Greetings, %{name}upcase|bold
+
+  %{message}strip|green
+T
+
+result = Fmt(template, date: Time.now, name: "Hopsoft", message: "This is neat!")
+#=> "Date: \e[4m2024-07-26\e[0m\n\nGreetings, \e[1mHOPSOFT\e[0m\n\n\e[32mThis is neat!\e[0m\n"
+```
+
+### Filters
+
+You can also add your own filters to Fmt by calling `Fmt.add_filter(:name, &block)`.
+The block accepts a string and should return a replacement string.
+
+```ruby
+Fmt.add_filter(:repeat20) { |str| str * 20 }
+
+template = <<~T
+  %{head}repeat20|faint
+  %{message}bold
+  %{tail}repeat20|faint
+T
+
+result = Fmt(template, head: "#", message: "Give it a try!", tail: "#")
+#=> "\e[2m####################\e[0m\n\e[1mGive it a try!\e[0m\n\e[2m####################\e[0m\n"
+```

data/lib/fmt/filter.rb

@@ -0,0 +1,32 @@
+# 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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "monitor"
+require_relative "filter"
+
+module Fmt
+  class Filters
+    include Enumerable
+    include MonitorMixin
+
+    DELIMITER = "|"
+
+    NATIVE_FILTERS = %i[
+      capitalize
+      chomp
+      chop
+      downcase
+      lstrip
+      reverse
+      rjust
+      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
+        Rainbow::Presenter.public_instance_methods(false).each do |name|
+          next unless Rainbow::Presenter.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
+      end
+    rescue
+      # noop
+    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

data/lib/fmt/formatter.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "singleton"
+require_relative "filters"
+require_relative "transformer"
+
+module Fmt
+  class Formatter
+    include Singleton
+
+    OPEN = /%\{/
+    CLOSE = /\}/
+    KEY = /\w+(?=\})/
+    FILTERS = /[^\s]+(?=\s|$)/
+
+    attr_reader :filters
+
+    def format(string, **locals)
+      result = string.to_s
+      transformer = next_transformer(result)
+
+      while transformer
+        result = transformer.transform(result, **locals)
+        transformer = next_transformer(result)
+      end
+
+      result
+    end
+
+    private
+
+    def initialize
+      super
+      @filters = Fmt::Filters.new
+    end
+
+    def next_transformer(string)
+      scanner = StringScanner.new(string)
+
+      # 1. advance to the opening delimiter
+      scanner.skip_until(OPEN)
+
+      # 2. extract the key to be transformed
+      key = scanner.scan(KEY)
+
+      # 3. advance to the closing delimiter
+      scanner.skip_until(CLOSE) if key
+
+      # 4. scan for the filters
+      filter_string = scanner.scan(FILTERS) if key
+
+      return nil if key.nil? || filter_string.nil?
+
+      mapped_filters = filter_string.split(Fmt::Filters::DELIMITER).map do |name|
+        filters.fetch name.to_sym, Fmt::Filter.new(name, name)
+      end
+
+      Fmt::Transformer.new(key.to_sym, *mapped_filters, placeholder: "%{#{key}}#{filter_string}".strip)
+    end
+  end
+end

data/lib/fmt/transformer.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Fmt
+  class Transformer
+    def initialize(key, *filters, placeholder:)
+      @key = key
+      @filters = filters
+      @placeholder = placeholder
+    end
+
+    attr_reader :key, :filters, :placeholder, :proc_filters, :string_filters
+
+    def transform(string, **locals)
+      return string if filters.none?
+
+      raise Fmt::Error, "Missing key :#{key} in #{locals.inspect}" unless locals.key?(key)
+      replacement = locals[key]
+
+      filters.each do |filter|
+        if filter.string?
+          begin
+            replacement = format("%#{filter.value}", replacement)
+          rescue => error
+            raise Fmt::Error, "Invalid filter! #{filter.inspect} Check the spelling and verify that it's registered `Fmt.add_filter(:#{filter.name}, &block)`; #{error.message}"
+          end
+        elsif filter.proc?
+          begin
+            replacement = filter.value.call(replacement)
+          rescue => error
+            raise Fmt::Error, "Error in filter! #{filter.inspect} #{error.message}"
+          end
+        end
+      end
+
+      string.sub placeholder, replacement
+    end
+  end
+end

data/lib/fmt/version.rb

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

data/lib/fmt.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "fmt/version"
+require_relative "fmt/formatter"
+
+module Fmt
+  class Error < StandardError; end
+
+  class << self
+    def formatter
+      Formatter.instance
+    end
+
+    def add_filter(...)
+      formatter.filters.add(...)
+    end
+  end
+end
+
+def Fmt(...)
+  Fmt.formatter.format(...)
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: fmt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nate Hopkins (hopsoft)
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: amazing_print
+  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: magic_frozen_string_literal
+  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
+  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
+    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
+    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-doc
+  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: rainbow
+  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: rake
+  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: yard
+  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'
+description: A simple template engine based on native Ruby String formatting mechanics
+email:
+- natehop@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/fmt.rb
+- lib/fmt/filter.rb
+- lib/fmt/filters.rb
+- lib/fmt/formatter.rb
+- lib/fmt/transformer.rb
+- lib/fmt/version.rb
+homepage: https://github.com/hopsoft/fmt
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hopsoft/fmt
+  source_code_uri: https://github.com/hopsoft/fmt
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.5
+signing_key:
+specification_version: 4
+summary: A simple template engine based on native Ruby String formatting mechanics
+test_files: []