fmt 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4bafcbfda352b24f4203057c8ae8c8df4ddc109727fd610250d54c1db02ea2a
-  data.tar.gz: 1e672363e323f01757e1590441d8f836bba9b03936b4551189cd040a942936f2
+  metadata.gz: 7aded878eeff57ab27f37b6e76bc34281d94000c95c5d0ae77dde2bee5ab5989
+  data.tar.gz: 0d6390579afbfa629f0e53a127c25b60c04548b831e8ec13b9ebd8ed0880a238
 SHA512:
-  metadata.gz: 39a4f811f2a9ee86e82fd0e7ce557aa6f22971cd31bde8c5a717b47f74b35119c8d7616580dac5de18851329edd304a72549ecd8239c2104caea3f41d4a3da7e
-  data.tar.gz: 75fe78f4908b6b94eb7fe37ba0d76819562d7005405d72d3c14ccb93b55d465da95e890becd9794b53eb7c3d44970a6f14ba3d62d45c1eb78e1cf31810e4885f
+  metadata.gz: 1235f7508b608760ce2f984cdcb321c01ac2a1cd3d7d5b9d1b586b45614e3b79c38bf900264b569fa469c17e34d2b6e1999984715a9b51c8caa792ee7d080aa9
+  data.tar.gz: '012095a10cbeac34f3457bf18ebe9135513a774984139cd1c7c300cd00d774590eff1826f7af137adbb32acd77f2eb8bffa1d52b48c579422fe43a2e7c3769cf'

data/README.md

@@ -1,6 +1,6 @@
 <p align="center">
   <a href="http://blog.codinghorror.com/the-best-code-is-no-code-at-all/">
-    <img alt="Lines of Code" src="https://img.shields.io/badge/loc-316-47d299.svg" />
+    <img alt="Lines of Code" src="https://img.shields.io/badge/loc-347-47d299.svg" />
   </a>
   <a href="https://github.com/testdouble/standard">
     <img alt="Ruby Style" src="https://img.shields.io/badge/style-standard-168AFE?logo=ruby&logoColor=FE1616" />
@@ -38,7 +38,7 @@ I'm currenly using this to help build beautiful CLI applications with Ruby. Plus
 ## Setup
 
 ```
-bundle add rainbow # optional
+bundle add rainbow # <- optional
 bundle add fmt
 ```
 
@@ -72,6 +72,8 @@ Basic example:
 require "rainbow"
 require "fmt"
 
+Fmt.add_rainbow_filters
+
 template = "Hello %{name}cyan|bold"
 Fmt template, name: "World"
 
@@ -86,6 +88,8 @@ Mix and match native formatting with Rainbow formatting:
 require "rainbow"
 require "fmt"
 
+Fmt.add_rainbow_filters
+
 template = "Date: %{date}.10s|magenta"
 Fmt template, date: Time.now
 
@@ -100,6 +104,8 @@ Multiline example:
 require "rainbow"
 require "fmt"
 
+Fmt.add_rainbow_filters
+
 template = <<~T
   Date: %{date}.10s|underline
 
@@ -124,6 +130,7 @@ The block accepts a string and should return a replacement string.
 require "rainbow"
 require "fmt"
 
+Fmt.add_rainbow_filters
 Fmt.add_filter(:ljust) { |val| "".ljust 14, val.to_s }
 
 template = <<~T
@@ -148,6 +155,8 @@ Just wrap the embedded template in double curly braces: `{{EMBEDDED TEMPLATE HER
 require "rainbow"
 require "fmt"
 
+Fmt.add_rainbow_filters
+
 template = "%{value}lime {{%{embed_value}red|bold|underline}}"
 Fmt template, value: "Outer", embed_value: "Inner"
 

data/lib/fmt/filter_groups/filter_group.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "monitor"
+require_relative "../filter"
+
+module Fmt
+  class FilterGroup
+    include Enumerable
+    include MonitorMixin
+
+    def initialize
+      super
+      @data = {}
+    end
+
+    def [](name)
+      synchronize { data[name.to_sym] }
+    end
+
+    def add(name, filter_proc = nil, &block)
+      raise ArgumentError, "filter_proc and block are mutually exclusive" if filter_proc && block
+      raise ArgumentError, "filter_proc must be a Proc" unless block || filter_proc.is_a?(Proc)
+      synchronize do
+        data[name.to_sym] = Fmt::Filter.new(name.to_sym, filter_proc || block)
+      end
+    end
+
+    def each(&block)
+      synchronize { data.each(&block) }
+    end
+
+    def fetch(name, default = nil)
+      synchronize { data.fetch name.to_sym, default }
+    end
+
+    def key?(name)
+      synchronize { data.key? name.to_sym }
+    end
+
+    alias_method :added?, :key?
+    alias_method :include?, :key?
+
+    def merge!(other)
+      synchronize { data.merge! other.to_h }
+      self
+    end
+
+    def to_h
+      data.dup
+    end
+
+    protected
+
+    attr_reader :data
+  end
+end

data/lib/fmt/filter_groups/rainbow_filter_group.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "filter_group"
+
+module Fmt
+  class RainbowFilterGroup < FilterGroup
+    def initialize
+      super
+
+      if defined? Rainbow
+        methods = Rainbow::Presenter.public_instance_methods(false).select do |method|
+          Rainbow::Presenter.public_instance_method(method).arity == 0
+        end
+
+        method_names = methods
+          .map { |m| m.name.to_sym }
+          .concat(Rainbow::X11ColorNames::NAMES.keys)
+
+        method_names.each do |name|
+          add(name) { |string| Rainbow(string).public_send name }
+        end
+      end
+    rescue => error
+      puts "Error adding Rainbow filters! #{error.inspect}"
+    end
+  end
+end

data/lib/fmt/filter_groups/string_filter_group.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "filter_group"
+
+module Fmt
+  class StringFilterGroup < FilterGroup
+    def initialize
+      super
+
+      # rubocop:disable Layout/ExtraSpacing AllowForAlignment
+      add :capitalize,        ->(s) { s.capitalize }
+      add :chomp,             ->(s) { s.chomp }
+      add :chop,              ->(s) { s.chop }
+      add :downcase,          ->(s) { s.downcase }
+      add :lstrip,            ->(s) { s.lstrip }
+      add :reverse,           ->(s) { s.reverse }
+      add :rstrip,            ->(s) { s.rstrip }
+      add :shellescape,       ->(s) { s.shellescape }
+      add :strip,             ->(s) { s.strip }
+      add :succ,              ->(s) { s.succ }
+      add :swapcase,          ->(s) { s.swapcase }
+      add :undump,            ->(s) { s.undump }
+      add :unicode_normalize, ->(s) { s.unicode_normalize }
+      add :upcase,            ->(s) { s.upcase }
+      # rubocop:enable Layout/ExtraSpacing AllowForAlignment
+    end
+  end
+end

data/lib/fmt/formatter.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require "singleton"
-require_relative "filters"
+require_relative "filter_groups/filter_group"
+require_relative "filter_groups/rainbow_filter_group"
+require_relative "filter_groups/string_filter_group"
 require_relative "scanners"
 require_relative "transformer"
 
@@ -11,6 +13,14 @@ module Fmt
 
     attr_reader :filters
 
+    def add_rainbow_filters
+      filters.merge! Fmt::RainbowFilterGroup.new.to_h
+    end
+
+    def add_filter(...)
+      filters.add(...)
+    end
+
     def format(string, **locals)
       result = string.to_s
       transformer = next_transformer(result)
@@ -27,7 +37,7 @@ module Fmt
 
     def initialize
       super
-      @filters = Fmt::Filters.new
+      @filters = Fmt::FilterGroup.new.merge!(Fmt::StringFilterGroup.new)
     end
 
     def next_transformer(string)

data/lib/fmt/transformer.rb

@@ -22,26 +22,20 @@ module Fmt
         if filter.string?
           begin
             replacement = sprintf("%#{filter.value}", replacement)
-          rescue => error
-            message = <<~MSG
-              Invalid filter!
-              #{filter.inspect}
-              Verify it's either a valid native filter or is registered with Fmt.
-              Example: Fmt.add_filter(:#{filter.name}, &block)
-              #{error.message}
+          rescue
+            raise Fmt::Error, <<~MSG
+              Invalid filter! #{filter.inspect}
+              Verify it has been properly registered. SEE: Fmt.add_filter(:#{filter.name}, &block)
             MSG
-            raise Fmt::Error, message
           end
         elsif filter.proc?
           begin
             replacement = filter.value.call(replacement)
           rescue => error
-            message = <<~MSG
-              Error in filter!
-              #{filter.inspect}
+            raise Fmt::Error, <<~MSG
+              Error in filter! #{filter.inspect}
               #{error.message}
             MSG
-            raise Fmt::Error, message
           end
         end
       end

data/lib/fmt/version.rb

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

data/lib/fmt.rb

@@ -15,11 +15,13 @@ module Fmt
       formatter.filters
     end
 
-    def add_filter(...)
-      formatter.filters.add(...)
+    def add_rainbow_filters
+      formatter.add_rainbow_filters
     end
 
-    alias_method :add, :add_filter
+    def add_filter(...)
+      formatter.add_filter(...)
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fmt
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Nate Hopkins (hopsoft)
@@ -161,7 +161,9 @@ files:
 - lib/fmt.rb
 - lib/fmt/embed.rb
 - lib/fmt/filter.rb
-- lib/fmt/filters.rb
+- lib/fmt/filter_groups/filter_group.rb
+- lib/fmt/filter_groups/rainbow_filter_group.rb
+- lib/fmt/filter_groups/string_filter_group.rb
 - lib/fmt/formatter.rb
 - lib/fmt/scanners.rb
 - lib/fmt/scanners/base_scanner.rb

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