fd 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 867ca2b5b5c93216fffa4486285d16f53a066f1b98359c18781c954abdc42071
-  data.tar.gz: f56557d88d4e1ff44cc5702e6fa2dc7f24c518f7035b3e1ed677c378b678e98a
+  metadata.gz: 79678d50cb3a33dd8db130fb309a9a7636511cfdc1b0f803c15a16af05811b59
+  data.tar.gz: '069fb8252dd99e14d04dcce97d795f13c60d1574d428e4e6d731364caf562088'
 SHA512:
-  metadata.gz: 0ee0824ce6e7b1cefa11dba4ffbd06b514e8f3f7f82d56d0f77c5aa0003dc85df293c5dbd04bbb0d9c67f03db4e2d00f89e8466c1a67a45a4560fb76ab808462
-  data.tar.gz: f8a1ac2e48b72124faa67d9667ba37694b1e26e480a1a278c7f2f95d0aa9f10c2bd788475a7849f7794a87a3b2c76210a118023b9ba55a39e33550307e80c408
+  metadata.gz: 5ee3d3708e6eef81509591e96d608781307273309b53888d745e4274437db5f2d84300a2058a9fcc241a9f21338107d3fbb27de4744e128dae9a070f9b7a556d
+  data.tar.gz: 806bacb747669e0e5ddc58e9b80d905d9cbae12acf78ba80ff731e93807e2b6ee31d344ce57964d9d09c28a00c0fcc980b3e8bfb4f42689729990f1662b6f3fe

data/.github/workflows/main.yml

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

data/.rubocop.yml

@@ -0,0 +1,20 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+
+Style/OpenStructUse:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.4.1

data/Gemfile

@@ -4,3 +4,24 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in fd.gemspec
 gemspec
+
+group :development, :test do
+  gem 'guard-bundler'
+  gem 'guard-minitest'
+  gem 'logger'
+  gem 'minitest'
+  gem 'minitest-reporters'
+  gem 'mutex_m'
+  gem 'ostruct'
+  gem 'pry'
+  gem 'pry-doc'
+  gem 'rake'
+  gem 'rb-fsevent'
+  gem 'rubocop'
+  gem 'rubocop-minitest', require: false
+  gem 'rubocop-performance', require: false
+  gem 'rubocop-rake', require: false
+  gem 'simplecov'
+  gem 'terminal-notifier'
+  gem 'terminal-notifier-guard'
+end

data/README.md

@@ -9,7 +9,7 @@
 `fd` reads files (or STDIN) _as a sequence of (UTF-8) characters_ and dumps the content to _STDOUT_, thus the name `fd`. It does so in two columns, the left one will display the hex values of the bytes in the file, the right one will display the characters.
 
 ## History
- 
+
 I created this tool **back in 2004**. It was programmed in a different world: On another operating system, using another file system (which most notably didn't have the concept of case-sensitive file names). This version originally used ISO-8859-1 as the default (and only) encoding, while it now assumes UTF-8.
 
 The early versions had it easy: Each character was assumed to use one byte in the file. This made displaying it in rows with a constant number of characters easy. Nowadays, however, a singe character may be composed of a (varying) number of bytes, making it impossible to always display the same number of characters in each row.
@@ -26,11 +26,15 @@ gem 'fd'
 
 Then execute:
 
-    $ bundle install
+```bash
+    bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install fd
+```bash
+gem install fd
+```
 
 Also see the [fd page on rubygems.org](https://rubygems.org/gems/fd)
 
@@ -38,7 +42,7 @@ Also see the [fd page on rubygems.org](https://rubygems.org/gems/fd)
 
 You can pass _file names_ on the command line:
 
-```
+```bash
 fd [-w number] [file_names]
 ```
 

data/Rakefile

@@ -2,6 +2,8 @@
 
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'rubocop'
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
@@ -9,4 +11,8 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task default: :test
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-rake'
+end
+
+task default: %i[test rubocop]

data/bin/fd

@@ -11,7 +11,9 @@ arguments.width = 10
 options = OptionParser.new do |opts|
   opts.banner = "Usage: #{File.basename __FILE__} [options] [file_names]"
 
-  opts.on('-w', '--width=WIDTH [Integer]', Integer, 'Display upto _width_ bytes per row, optional, default is 10') do |width|
+  opts.on('-w',
+          '--width=WIDTH [Integer]',
+          Integer, 'Display upto _width_ bytes per row, optional, default is 10') do |width|
     arguments.width = width
   end
 
@@ -43,5 +45,5 @@ if ARGV.size.positive?
     file_dumper.dump_file(fn)
   end
 else
-  file_dumper.dump_stdin(STDIN.read)
+  file_dumper.dump_stdin($stdin.read)
 end

data/fd.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['the.tester@seasidetesting.com']
 
   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.description   = 'fd prints the given file in 2 columns (left: hex values left / right: / textual representations'
   spec.homepage      = 'https://github.com/s2k/fd'
   spec.license       = 'MIT'
   spec.required_ruby_version = '>= 3.1.0'
@@ -20,18 +20,6 @@ Gem::Specification.new do |spec|
   spec.metadata['source_code_uri'] = 'https://github.com/s2k/fd'
   # spec.metadata['changelog_uri'] = "TODO: Put your gem's CHANGELOG.md URL here."
 
-  spec.add_development_dependency 'guard-bundler'
-  spec.add_development_dependency 'guard-minitest'
-  spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'pry-doc'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rb-fsevent'
-  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.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do

data/lib/fd/version.rb

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

data/lib/fd.rb

@@ -7,9 +7,23 @@ require_relative 'fd/version'
 class Fd
   class Error < StandardError; end
 
-  ESCAPE_CHARACTERS = %w[␀ ␇ ␈ ␉ ␊ ␋ ␌ ␍ ␡ ␛ ␠]
-
-  attr_reader :line_length, :char_table
+  ESCAPE_CHARACTERS = %w[␀ ␇ ␈ ␉ ␊ ␋ ␌ ␍ ␡ ␛ ␠].freeze
+
+  CHAR_TABLE = {
+    0 => '␀',
+    7 => '␇',
+    8 => '␈',
+    9 => '␉',
+    10 => '␊',
+    11 => '␋',
+    12 => '␌',
+    13 => '␍',
+    16 => '␡',
+    27 => '␛',
+    32 => '␠'
+  }.freeze
+
+  attr_reader :line_length
 
   # _line_length_ sets how many characters are displayed per @line.
   # Some <i>special non-printable/invisible characters</i> are displayed as their names.
@@ -28,22 +42,12 @@ class Fd
   # __   :: 32
   #
   def initialize(line_length)
-    raise ArgumentError,
-          "Line width must be a positive integer, was given '#{line_length}'" unless line_length.is_a?(Integer) && line_length.positive?
+    unless line_length.is_a?(Integer) && line_length.positive?
+      raise ArgumentError,
+            "Line width must be a positive integer, was given '#{line_length}'"
+    end
 
     @line_length = line_length
-    @char_table = {}
-    @char_table[0]  = '␀'
-    @char_table[7]  = '␇'
-    @char_table[8]  = '␈'
-    @char_table[9]  = '␉'
-    @char_table[10] = '␊'
-    @char_table[11] = '␋'
-    @char_table[12] = '␌'
-    @char_table[13] = '␍'
-    @char_table[16] = '␡'
-    @char_table[27] = '␛'
-    @char_table[32] = '␠'
   end
 
   def add_esc_sequence(chr)
@@ -101,7 +105,7 @@ class Fd
   def append_to_line(bytes, char)
     @byte_count_in_line += bytes.size
     bytes.each { |bt| @hex_values << format('%02x', bt) }
-    @line       += format('%2s', (char_table[char.ord] || char))
+    @line       += format('%2s', (CHAR_TABLE[char.ord] || char))
     @char_index += 1
   end
 
@@ -110,8 +114,7 @@ class Fd
   end
 
   def print_single_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'))
-    )
+    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,171 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: fd
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Stephan Kämper
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-27 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: guard-bundler
-  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: guard-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
-  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
-  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: 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: rb-fsevent
-  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: simplecov
-  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: terminal-notifier
-  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: terminal-notifier-guard
-  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: 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.'
+date: 2024-12-27 00:00:00.000000000 Z
+dependencies: []
+description: 'fd prints the given file in 2 columns (left: hex values left / right:
+  / textual representations'
 email:
 - the.tester@seasidetesting.com
 executables:
@@ -178,6 +23,8 @@ files:
 - ".github/workflows/codeql-analysis.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -198,7 +45,6 @@ metadata:
   homepage_uri: https://github.com/s2k/fd
   source_code_uri: https://github.com/s2k/fd
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -213,8 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: fd is a simple tool to dump file contents in binary & text format side by
   side