fd 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fbb1328292e9e5ebe74262b8d9c91adf2d9d71e44055e81e1ecd1fb35965768
-  data.tar.gz: 7dfc538b1293aa6b1690c74729c2a52fc0a8f5dc74bf4d04b75ebfa3aa18bceb
+  metadata.gz: 867ca2b5b5c93216fffa4486285d16f53a066f1b98359c18781c954abdc42071
+  data.tar.gz: f56557d88d4e1ff44cc5702e6fa2dc7f24c518f7035b3e1ed677c378b678e98a
 SHA512:
-  metadata.gz: 8dc642b1028e40559b8a868f01cf595eebd22b65678ad676abb4866865a5a43fedd46af54ede138b8bc82fdb269918580eb44779f10625ec0a86f4dde173a29b
-  data.tar.gz: b18f4270ceb80cddccad59db720be725ce9f2e91ca43c7d2de580d9d2f469dd6d24282fcfd0ded09c91174405d9afd2df4db3fef6ee28b93dcb8972d77c79712
+  metadata.gz: 0ee0824ce6e7b1cefa11dba4ffbd06b514e8f3f7f82d56d0f77c5aa0003dc85df293c5dbd04bbb0d9c67f03db4e2d00f89e8466c1a67a45a4560fb76ab808462
+  data.tar.gz: f8a1ac2e48b72124faa67d9667ba37694b1e26e480a1a278c7f2f95d0aa9f10c2bd788475a7849f7794a87a3b2c76210a118023b9ba55a39e33550307e80c408

data/.github/workflows/main.yml

@@ -10,7 +10,7 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.2.1
+        ruby-version: 3.3
         bundler-cache: true
     - name: Run the default task
       run: bundle exec rake

data/README.md

@@ -42,37 +42,41 @@ You can pass _file names_ on the command line:
 fd [-w number] [file_names]
 ```
 
-For example:
+For example (without colour highlighting of invisible characters):
 
 ```bash
 > echo "Bacon ipsum dolor amet short ribs flank irure filet mignon brisket buffalo est porchetta." > some_file
-> fd -w 7 some_file
+>  ~/dev/fd ᚠ main > fd -w 7 some_file
 some_file
-42 61 63 6f 6e 20 69 |    B    a    c    o    n   __    i
-70 73 75 6d 20 64 6f |    p    s    u    m   __    d    o
-6c 6f 72 20 61 6d 65 |    l    o    r   __    a    m    e
-74 20 73 68 6f 72 74 |    t   __    s    h    o    r    t
-20 72 69 62 73 20 66 |   __    r    i    b    s   __    f
-6c 61 6e 6b 20 69 72 |    l    a    n    k   __    i    r
-75 72 65 20 66 69 6c |    u    r    e   __    f    i    l
-65 74 20 6d 69 67 6e |    e    t   __    m    i    g    n
-6f 6e 20 62 72 69 73 |    o    n   __    b    r    i    s
-6b 65 74 20 62 75 66 |    k    e    t   __    b    u    f
-66 61 6c 6f 20 65 73 |    f    a    l    o   __    e    s
-74 20 70 6f 72 63 68 |    t   __    p    o    r    c    h
-   65 74 74 61 2e 0a |         e    t    t    a    .   LF
+42 61 63 6f 6e 20 69 | B a c o n ␠ i
+70 73 75 6d 20 64 6f | p s u m ␠ d o
+6c 6f 72 20 61 6d 65 | l o r ␠ a m e
+74 20 73 68 6f 72 74 | t ␠ s h o r t
+20 72 69 62 73 20 66 | ␠ r i b s ␠ f
+6c 61 6e 6b 20 69 72 | l a n k ␠ i r
+75 72 65 20 66 69 6c | u r e ␠ f i l
+65 74 20 6d 69 67 6e | e t ␠ m i g n
+6f 6e 20 62 72 69 73 | o n ␠ b r i s
+6b 65 74 20 62 75 66 | k e t ␠ b u f
+66 61 6c 6f 20 65 73 | f a l o ␠ e s
+74 20 70 6f 72 63 68 | t ␠ p o r c h
+   65 74 74 61 2e 0a |   e t t a . ␊
 ```
 
-You can also pipe input to STDIN:
+Here's a screenshot of a zsh session that shows the highlighting:
+
+![](images/usage_example.png)
+
+You can also pipe input from STDIN:
 
 ```bash
 > echo "Put something into STDIN" | fd -w 5
 STDIN
-50 75 74 20 73 |    P    u    t   __    s
-6f 6d 65 74 68 |    o    m    e    t    h
-69 6e 67 20 69 |    i    n    g   __    i
-6e 74 6f 20 53 |    n    t    o   __    S
-54 44 49 4e 0a |    T    D    I    N   LF
+50 75 74 20 73 | P u t ␠ s
+6f 6d 65 74 68 | o m e t h
+69 6e 67 20 69 | i n g ␠ i
+6e 74 6f 20 53 | n t o ␠ S
+54 44 49 4e 0a | T D I N ␊
 ```
 
 ## Development

data/fd.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Stephan Kämper']
   spec.email         = ['the.tester@seasidetesting.com']
 
-  spec.summary       = 'fd is a simple (currently simplistic) tool to dump file contents in binary & text format - side by side'
+  spec.summary       = 'fd is a simple tool to dump file contents in binary & text format side by side'
   spec.description   = 'fd prints the given file in two columns: Hex values in the left column and the textual representations in the right column.'
   spec.homepage      = 'https://github.com/s2k/fd'
   spec.license       = 'MIT'
@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'terminal-notifier'
   spec.add_development_dependency 'terminal-notifier-guard'
+  spec.add_development_dependency 'mutex_m'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/fd/version.rb

@@ -4,7 +4,7 @@
 # All other code is in lib/fd.rb
 #
 class Fd
-  VERSION = '0.5.0'
+  VERSION = '1.0.0'
 
   def self.version
     VERSION

data/lib/fd.rb

@@ -7,6 +7,8 @@ require_relative 'fd/version'
 class Fd
   class Error < StandardError; end
 
+  ESCAPE_CHARACTERS = %w[␀ ␇ ␈ ␉ ␊ ␋ ␌ ␍ ␡ ␛ ␠]
+
   attr_reader :line_length, :char_table
 
   # _line_length_ sets how many characters are displayed per @line.
@@ -44,6 +46,10 @@ class Fd
     @char_table[32] = '␠'
   end
 
+  def add_esc_sequence(chr)
+    "\e[31m#{chr}\e[0m"
+  end
+
   # dumps the given file _file_name_ to stdout.
   def dump(content)
     raise "Not the expected encoding of UFT-8, got #{content.encoding}" unless content.encoding == Encoding::UTF_8
@@ -104,6 +110,8 @@ class Fd
   end
 
   def print_single_line
-    puts("#{format("%#{(3 * line_length) - 1}s", hex_values.join(' '))} |#{format("%#{2 * line_length}s", line)}")
+    puts("#{format("%#{(3 * line_length) - 1}s", hex_values.join(' '))} |#{format("%#{2 * line_length}s", line)}".
+      gsub(/([#{ESCAPE_CHARACTERS.join('')}])/, add_esc_sequence('\1'))
+    )
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fd
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Stephan Kämper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-13 00:00:00.000000000 Z
+date: 2023-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard-bundler
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mutex_m
+  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: 'fd prints the given file in two columns: Hex values in the left column
   and the textual representations in the right column.'
 email:
@@ -173,6 +187,7 @@ files:
 - bin/fd
 - bin/setup
 - fd.gemspec
+- images/usage_example.png
 - lib/fd.rb
 - lib/fd/version.rb
 homepage: https://github.com/s2k/fd
@@ -198,9 +213,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
-summary: fd is a simple (currently simplistic) tool to dump file contents in binary
-  & text format - side by side
+summary: fd is a simple tool to dump file contents in binary & text format side by
+  side
 test_files: []