fd 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f47b8695d25dbba024c4a5e44d471179919de3f7888a7dfac299d4b2f6e94224
+  data.tar.gz: 6f3fc8a90d2a5a355cfd3971fb795506ae875d80c1358687bcb299cad1c65052
+SHA512:
+  metadata.gz: 388945f903ac60a83c25d0ee8e5ed51ebabe28b9889bc138daa30f2af1e9c1eab8e603cece9f788782e7316ac7c3e154fad5ea6bc42cf039c8635d07555b78c6
+  data.tar.gz: d0c163a40a65fbc22059b6a116531e6a759dfa5b422e32c36deb5c53a12ab7b8f135295934616a84304b4fc63cd46502e8fb02d700d7b282ad69877a2cd4ed82

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL for 'fd'"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '23 0 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.1.0
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,49 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+*.gem
+*.rbc
+/.config
+/InstalledFiles
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+# Ignore Byebug command history file.
+.byebug_history
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# vendor/Pods/
+## Documentation cache and generated files:
+/.yardoc/
+/rdoc/
+## Environment normalization:
+/vendor/bundle
+/lib/bundler/man/
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fd.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+guard :minitest do
+  watch(%r{\Atest/(.*)/?(.*)test\.rb\Z}) { 'test' }
+  watch(%r{\Alib/(.*/)?([^/]+)\.rb\Z})   { 'test' }
+  watch(%r{\Abin/fd\Z})                  { 'test' }
+  watch(%r{\Atest/test_helper\.rb\Z})    { 'test' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Stephan Kämper
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# fd - A simple file dumping tool
+
+## GitHub Actions
+
+[![Main workflow: unit tests](https://github.com/s2k/fd/actions/workflows/main.yml/badge.svg)](https://github.com/s2k/fd/actions) <sup style="font-size:125%;">᛫</sup> [![CodeQL for 'fd'](https://github.com/s2k/fd/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/s2k/fd/actions/workflows/codeql-analysis.yml)
+
+## TL;DR
+
+`fd` reads the file _as a sequence of bytes_ and dumps the file 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.
+
+## Warning
+
+This is, essentially, the same version I created **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 encoding, while it's now UTF-8. But since it reads the file byte wise, some characters will not be displayed as you would see them in a modern text editor.
+
+In other words: It's a work in progress.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fd'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install fd
+
+
+## Usage
+
+```
+fd.rb [-w _number_] <em>file_name(s)</em>
+```
+
+Depending on your operating system, you may have to type a bit more...
+
+```
+ruby fd.rb [-w _number_] file_name(s)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/s2k/fd>.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'fd'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+Pry.start

data/bin/fd

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'fd'
+require 'optparse'
+require 'ostruct'
+
+arguments = OpenStruct.new
+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|
+    arguments.width = width
+  end
+
+  opts.on('-h', '--help', 'Display using this help') do
+    puts opts
+    exit
+  end
+
+  opts.on('-v', '--version', 'Display version info and quit') do
+    puts "fd version: #{Fd.version}"
+    exit
+  end
+end
+
+begin
+  ARGV.push('-h') if ARGV.empty?
+  options.parse!
+rescue OptionParser::InvalidArgument
+  puts "fd doesn't work, this way:"
+  options.parse %w[--help]
+  exit 1
+end
+
+file_dumper = Fd.new(arguments.width)
+
+ARGV.each do |fn|
+  file_dumper.dump(fn)
+end

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/fd.gemspec

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative 'lib/fd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fd'
+  spec.version       = Fd::VERSION
+  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.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'
+  spec.required_ruby_version = '>= 3.1.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  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'
+
+  # 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
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir = 'bin'
+  spec.executables = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/fd/version.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Here only the _VERSION_ of Fd is defined
+# All other code is in lib/fd.rb
+#
+class Fd
+  VERSION = '0.3.0'
+
+  def self.version
+    VERSION
+  end
+end

data/lib/fd.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative 'fd/version'
+
+# Fd dumps the content of a file to the standard output.
+#
+class Fd
+  class Error < StandardError; end
+
+  attr_reader :line_length, :char_table
+
+  # _line_length_ sets how many characters are displayed per line.
+  # Some <i>special non-printable/invisible characters</i> are displayed as their names.
+  #
+  # Name :: Char val
+  # NULL :: 0
+  # BEL  :: 7
+  # BS   :: 8
+  # TAB  :: 9
+  # LF   :: 10
+  # VT   :: 11
+  # FF   :: 12
+  # CR   :: 13
+  # DEL  :: 16
+  # ESC  :: 27
+  # __   :: 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?
+
+    @line_length = line_length
+    @char_table = {}
+    @char_table[0]  = 'NULL'
+    @char_table[7]  = 'BEL'
+    @char_table[8]  = 'BS'
+    @char_table[9]  = 'TAB'
+    @char_table[10] = 'LF'
+    @char_table[11] = 'VT'
+    @char_table[12] = 'FF'
+    @char_table[13] = 'CR'
+    @char_table[16] = 'DEL'
+    @char_table[27] = 'ESC'
+    @char_table[32] = '__'
+  end
+
+  # dumps the given file _file_name_ to stdout.
+  def dump(file_name)
+    puts file_name
+    content = File.read(file_name)
+    raise "Not the expected encoding of UFT-8, got #{content.encoding}" unless content.encoding == Encoding::UTF_8
+
+    chars = content.chars
+    byte_count_in_line = 0
+    line = ''
+    hex_values = []
+    char_index = 0
+    while char_index < chars.size
+      char = chars[char_index]
+      bytes = char.bytes
+      if enough_space_in_line?(byte_count_in_line, bytes)
+        # Next char fits in line => Add hex values & character to line
+        byte_count_in_line += bytes.size
+        bytes.each { |bt| hex_values << format('%02x', bt) }
+        line += format('%5s', (char_table[char.ord] || char))
+        char_index += 1
+      else
+        # Print a new line…
+        print_single_line(hex_values, line)
+        # …and reset line internal values
+        byte_count_in_line = 0
+        hex_values.clear
+        line = ''
+      end
+    end
+    print_single_line(hex_values, line) unless line.empty?
+  end
+
+  private
+
+  def enough_space_in_line?(byte_count_in_line, bytes)
+    byte_count_in_line + bytes.size <= line_length
+  end
+
+  def print_single_line(hex_values, line)
+    puts("#{format("%#{(3 * line_length) - 1}s", hex_values.join(' '))} |#{format("%#{5 * line_length}s", line)}")
+  end
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: fd
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Stephan Kämper
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-01-23 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'
+description: 'fd prints the given file in two columns: Hex values in the left column
+  and the textual representations in the right column.'
+email:
+- the.tester@seasidetesting.com
+executables:
+- console
+- fd
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/codeql-analysis.yml"
+- ".github/workflows/main.yml"
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/fd
+- bin/setup
+- fd.gemspec
+- lib/fd.rb
+- lib/fd/version.rb
+homepage: https://github.com/s2k/fd
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  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
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key:
+specification_version: 4
+summary: fd is a simple (currently simplistic) tool to dump file contents in binary
+  & text format - side by side
+test_files: []