viewchars 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 79a4fd4d68a2317fa6f6727ec7ed45de9728c9326af516046bdb1bd61e71b354
+  data.tar.gz: 03a8e8e5a6f40d76f47528a0c0942530306b813d10cfcf636d911fd145a2f852
+SHA512:
+  metadata.gz: fe44a0d3fd947369105cc592e444e3b6c83e41f5c114ff8d381d0143048a5ad6358c2cbe82224897e4b3b6e87b3369507a298f7143940d1f257315ccacf239ff
+  data.tar.gz: db2f7b66dc2f970b2dad6370012eadb6b4a52dfb88bbd90d539d821d4f6caa23abc598d16a455e69c28b29d7a415ff343c8db5295d89a76e129b38fa3ffe4289

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in viewchars.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'slop'
+gem 'colorize'
+gem 'unicode-name'
+gem 'tty-table'

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    viewchars (0.1.0)
+      colorize
+      slop
+      tty-table
+      unicode-name
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.8.1)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    rake (13.0.6)
+    slop (4.9.1)
+    strings (0.2.1)
+      strings-ansi (~> 0.2)
+      unicode-display_width (>= 1.5, < 3.0)
+      unicode_utils (~> 1.4)
+    strings-ansi (0.2.0)
+    tty-color (0.6.0)
+    tty-screen (0.8.1)
+    tty-table (0.12.0)
+      pastel (~> 0.8)
+      strings (~> 0.2.0)
+      tty-screen (~> 0.8)
+    unicode-display_width (2.1.0)
+    unicode-name (1.10.0)
+      unicode-types (~> 1.7)
+    unicode-types (1.7.0)
+    unicode_utils (1.4.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  colorize
+  rake (~> 13.0)
+  slop
+  tty-table
+  unicode-name
+  viewchars!
+
+BUNDLED WITH
+   2.2.28

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 J. R. Schmid
+
+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,21 @@
+# Viewchars
+
+## Installation
+
+- Windows: [install Windows Subsystem For Linux](https://docs.microsoft.com/en-us/windows/wsl/install) and a distribution of your choice, then from within that, follow the instructions for Linux.
+- Linux: follow your distribution's instructions for installing Rubygems. For example, in Ubuntu it's `sudo apt install rubygems` or in Manjaro it's `pacman -Sy rubygems`. Afterwards, install _Viewchars_ with `gem install viewchars`.
+- macOS: [install Brew](https://brew.sh/), then open a terminal and install Rubygems with `brew update` followed by `brew install brew-gem`. Afterwards, install _Viewchars_ with `brew gem install viewchars`.
+
+## Usage
+
+Simply `viewchars` will output a short help message.
+
+Try e.g. `viewchars mary had a little lamb` or `viewchars -c -d forward -b dec 109 97 114 121 32 104 97 100 32 97 32 108 105 116 116 108 101 32 108 97 109 98` for either of the two usage modes, respectively.
+
+## Contributing
+
+Bug reports and pull requests are more than welcome at https://github.com/sixtyfive/viewchars.
+
+## License
+
+This gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "viewchars"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/viewchars

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+# -----------------------------------------------------------------------------
+# viewchars: interpret bin/oct/dec/hex number(s) in specified character
+#        encoding and try to convert to UTF-8, then display the result
+#        if possible.
+# (C) 2021 J. R. Schmid <jrs@weitnahbei.de>
+# May be shared and used according to CC BY-SA 4.0
+# (https://creativecommons.org/licenses/by-sa/4.0/)
+# -----------------------------------------------------------------------------
+
+if __FILE__.match(/exe\/viewchars$/) 
+  require_relative '../lib/viewchars'
+else
+  require 'viewchars'
+end
+
+Viewchars::CLI.start

data/lib/viewchars/core.rb

@@ -0,0 +1,102 @@
+require 'tty/table'
+
+module Viewchars
+  class CLI
+    def basex2dec(n)
+      base = case @opts[:base].to_sym
+        when :bin then 2
+        when :oct then 8
+        when :dec then return n.to_i
+        when :hex then 16
+        else print_usage
+      end
+      n.to_s.to_i(base)
+    end
+
+    def encode_with(i, encoding)
+      begin
+        i.chr(encoding)
+      rescue
+        '-'
+      end
+    end
+
+    def utf8_reencode(ch)
+      begin
+        ch.encode(Encoding::UTF_8)
+      rescue
+        '-'
+      end
+    end
+
+    def unicode_name(ch)
+      begin
+        Unicode::Name.of(ch).split(' ').map(&:capitalize).join(' ')
+      rescue
+        nil
+      end
+    end
+
+    def dec2code(n)
+      "U+#{n.to_s(16).rjust(4,'0')}".upcase
+    end
+    
+    def build_info_list(codepoints, encoding)
+      info = []
+      codepoints.each do |n|
+        n_dec = basex2dec(n.downcase.gsub(/([\da-f]+)/, '\1'))
+        ch = encode_with(n_dec, encoding)
+        ch_utf8 = utf8_reencode(ch)
+        code = dec2code(n_dec)
+        name = unicode_name(ch)
+        unless name
+          ch = ch_utf8 = '-'
+          name = '(not a Unicode codepoint)' 
+        end
+        info << [ch, ch_utf8, n, code, name]
+      end
+      info
+    end
+
+    def prepare_output(lists)
+      lists.each do |encoding,info|
+        # -c|--codes and/or -n|--names
+        # -t|--tabular (default)
+        _ch      = encoding
+        _ch_utf8 = 'Forced'
+        _n       = @opts[:base].capitalize
+        _code    = 'Code'
+        _name    = 'Name'
+        header = []
+        rows = []
+        if @opts[:tabular]
+          header = [_ch, _ch_utf8, _n, _code, _name]
+          rows = info
+        else
+          header = nil
+          rows = info.map do |e|
+            r = [e.first] if @opts[:codes]
+            r = [e.last] if @opts[:names]
+            r = [e.first, e.last] if @opts[:codes] and @opts[:names]
+            r
+          end
+        end
+        table = TTY::Table.new(header, rows)
+        puts TTY::Table::Renderer::Basic.new(table).render
+      end
+    end
+
+    def chars2codepoints(chars)
+      @opts[:base] ||= 'dec'
+      codepoints = @opts.arguments.join(' ').codepoints.map(&:to_s)
+      info_lists = @requested_encodings.map{|e| [e, build_info_list(codepoints, e)]}.to_h
+      prepare_output(info_lists)
+    end
+
+    def codepoints2chars(codepoints)
+      @opts[:base] ||= 'hex'
+      info_lists = @requested_encodings.map{|e| [e, build_info_list(codepoints, e)]}.to_h
+      prepare_output(info_lists)
+    end
+  end
+end

data/lib/viewchars/version.rb

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

data/lib/viewchars.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative 'viewchars/version'
+require_relative 'viewchars/core'
+
+require 'slop'         # gem install slop
+require 'colorize'     # gem install colorize
+require 'unicode/name' # gem install unicode-name
+require 'pp'
+
+module Viewchars
+  class Error < StandardError; end
+
+  class CLI
+    def print_usage
+      warn "Usage: #{File.basename(__FILE__)} [options] <arg1> <arg2> <...>"
+      warn ""
+      warn "  where arguments depend on direction: strings for 'reverse', numbers for 'forward'"
+      warn "  and where options may be:"
+      warn ""
+      warn "  -l|--list-encodings: do nothing except list all known encodings"
+      warn ""
+      warn "  -d|--direction: <reverse|forward> chars to codepoints (default) or vice versa"
+      warn ""
+      warn "  -e|--encoding <comma separated list | all> (default: utf-8)"
+      warn "  -b|--base <bin|oct|dec|hex> (default: numbers are interpreted as hexadecimals)"
+      warn ""
+      warn "  -t|--tabular: output codepoints in input base and base 10, requested-encoding, forced utf8, and name (default)"
+      warn "  -c|--codes: output each char's code point as a hex number (can be combined with -n)"
+      warn "  -n|--names: if applicable, show the Unicode Character Name for each codepoint (can be combined with -c)"
+      warn ""
+      exit
+    end
+
+    def list_known_encodings
+      @known_encodings.each{|k,v| puts k}
+    end
+
+    def initialize
+      begin
+        @opts = Slop.parse do |o|
+          o.bool   '-l', '--list-encodings', ''
+          o.string '-e', '--encoding',       ''
+          o.string '-b', '--base',           ''
+          o.bool   '-c', '--codes',          ''
+          o.bool   '-n', '--names',          ''
+          o.bool   '-t', '--tabular',        ''
+          o.string '-d', '--direction',      ''
+        end
+      rescue Slop::UnknownOption, Slop::MissingArgument, Slop::MissingRequiredOption
+        print_usage
+      end
+
+      @opts[:direction] ||= 'reverse'
+      @opts[:encoding] ||= 'UTF-8'
+      @opts[:tabular] = true if !(@opts[:codes] || @opts[:names])
+
+      @known_encodings = Encoding.list.map{|e| [e.to_s.downcase, e.to_s]}.to_h.sort.to_h
+      @requested_encodings = []
+      @opts[:encoding].split(',').each do |encoding|
+        (@requested_encodings = @known_encodings.values; break) if encoding == 'all'
+        if @known_encodings[encoding.downcase]
+          @requested_encodings << @known_encodings[encoding.downcase]
+        else
+          warn "Error: No such encoding: #{encoding}"
+          exit
+        end
+      end
+
+      if @opts[:list_encodings]
+        list_known_encodings
+        exit
+      else
+        print_usage unless @opts.arguments.any?
+        case @opts[:direction]
+          when 'reverse' then
+            chars = @opts.arguments.join(' ').chars
+            chars2codepoints(chars)
+          when 'forward' then
+            codepoints = @opts.arguments
+            codepoints2chars(codepoints)
+        end
+      end
+    end
+
+    def self.start; new; end
+  end
+end

data/viewchars.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/viewchars/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "viewchars"
+  spec.version       = Viewchars::VERSION
+  spec.authors       = ["J. R. Schmid"]
+  spec.email         = ["jrs+git@weitnahbei.de"]
+
+  spec.summary       = "Little command line tool to help find the way through the character jungle ... or jumble"
+  spec.description   = "See what codepoints are hiding behind a string, or what string might be hiding behind a list of numbers."
+  spec.homepage      = "https://github.com/sixtyfive/viewchars"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/sixtyfive/viewchars.git"
+
+  # 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 do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'slop'
+  spec.add_dependency 'colorize'
+  spec.add_dependency 'unicode-name'
+  spec.add_dependency 'tty-table'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: viewchars
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- J. R. Schmid
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: unicode-name
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: See what codepoints are hiding behind a string, or what string might
+  be hiding behind a list of numbers.
+email:
+- jrs+git@weitnahbei.de
+executables:
+- viewchars
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/viewchars
+- lib/viewchars.rb
+- lib/viewchars/core.rb
+- lib/viewchars/version.rb
+- viewchars.gemspec
+homepage: https://github.com/sixtyfive/viewchars
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/sixtyfive/viewchars
+  source_code_uri: https://github.com/sixtyfive/viewchars.git
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.21
+signing_key:
+specification_version: 4
+summary: Little command line tool to help find the way through the character jungle
+  ... or jumble
+test_files: []