fmt 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 546ccf984763e8c2f3590f1fead68a1a7c9f0a874fefd241df21b2cb54550aac
-  data.tar.gz: 81cd66780873959882857eeffe05abea6bcf447e4de64946daf089c1efe05ab1
+  metadata.gz: 55fc16022e0fcb4b8815d6e7242106018e5786a9d610f38f8040cbb31cadb1a0
+  data.tar.gz: 185f056e8450fb1facfe15c7c637e9b49d2a19a2270689b8e12953c664393e10
 SHA512:
-  metadata.gz: 8c72adc7487d3352361e5ad8f56fda9c623351112dd377542830023e165c98cd6abfac7526b632f4f2a689dddd0bba1c34f901bfdee6ee72d067271e5cb17458
-  data.tar.gz: 6c625ceeabf0aec90bda2945247eb648e5bb05ca41cf6f7b7a139c0366d8d8794f239fcb7a3e0e81b24017494e98a4bc826e55423764206986481c85e94e5186
+  metadata.gz: 707ed8686b167ecba644d7a2358cf179670656cd9a7eb77f6d9408b7b8d5f07a9c204ca94fcd928e8630ca5633ce716c0fb600c4bca8d8e6992a1f682fcd76dc
+  data.tar.gz: 4b350d2ce4dd9ceeca3b7640d392b806c9698607bae33db99f18a39248898dbeef10100040f2d78dfc66f95d78839a982cf9a1cb3391129c70347f68f043bf4d

data/README.md

@@ -9,26 +9,38 @@ I'm currenly using this to help build beautiful CLI applications with Ruby. Plus
 ## Setup
 
 ```
-bundle add fmt
 bundle add rainbow # optional
+bundle add fmt
 ```
 
 ## 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.
+```ruby
+"%{...}"
+```
+
+Filters can be chained after the placeholder like so.
+
+```ruby
+"%{...}FILTER|FILTER|FILTER"
+```
+
+> [!NOTE]
+> 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.
+Filters can be [native Ruby formatting](https://docs.ruby-lang.org/en/master/format_specifications_rdoc.html) as well as String methods like `capitalize`, `downcase`, `strip`, etc.
+Also, you can use Rainbow filters like `bold`, `cyan`, `underline`, et al. if you have the [Rainbow GEM](https://github.com/ku1ik/rainbow) installed.
+
+**You can even [register your own filters](#filters).**
 
 ### Rendering
 
 Basic example:
 
 ```ruby
+require "rainbow"
 require "fmt"
 
 template = "Hello %{name}cyan|bold"
@@ -36,9 +48,12 @@ result = Fmt(template, name: "World")
 #=> "Hello \e[36m\e[1mWorld\e[0m"
 ```
 
+![CleanShot 2024-07-26 at 01 40 33@2x](https://github.com/user-attachments/assets/04ff90e6-254a-42d4-9169-586ac24b82f0)
+
 Mix and match native formatting with Rainbow formatting:
 
 ```ruby
+require "rainbow"
 require "fmt"
 
 template = "Date: %{date}.10s|magenta"
@@ -46,9 +61,14 @@ result = Fmt(template, date: Time.now)
 #=> "Date: \e[35m2024-07-26\e[0m"
 ```
 
+![CleanShot 2024-07-26 at 01 42 53@2x](https://github.com/user-attachments/assets/507913b0-826b-4526-9c79-27f766c904b3)
+
 Multiline example:
 
 ```ruby
+require "rainbow"
+require "fmt"
+
 template = <<~T
   Date: %{date}.10s|underline
 
@@ -61,12 +81,17 @@ 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"
 ```
 
+![CleanShot 2024-07-26 at 01 44 30@2x](https://github.com/user-attachments/assets/8926009c-7cf1-4140-9a2a-6ed718d50926)
+
 ### 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
+require "rainbow"
+require "fmt"
+
 Fmt.add_filter(:repeat20) { |str| str * 20 }
 
 template = <<~T
@@ -78,3 +103,5 @@ 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"
 ```
+
+![CleanShot 2024-07-26 at 01 46 26@2x](https://github.com/user-attachments/assets/bd1d67c6-1182-428b-be05-756f3d330f67)

data/lib/fmt/filters.rb

@@ -17,7 +17,6 @@ module Fmt
       downcase
       lstrip
       reverse
-      rjust
       rstrip
       shellescape
       strip
@@ -38,7 +37,7 @@ module Fmt
 
       if defined? Rainbow
         Rainbow::Presenter.public_instance_methods(false).each do |name|
-          next unless Rainbow::Presenter.instance_method(name).arity == 0
+          next unless Rainbow::Presenter.public_instance_method(name).arity == 0
           add(name) { |str| Rainbow(str).public_send(name) }
         end
 

data/lib/fmt/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fmt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nate Hopkins (hopsoft)