injalid_dejice 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 810e98c784de94eb504872bdb8bc8dd7eadcb948c40b40b77ddc8050b787da31
+  data.tar.gz: fe8a847cfdcf4c8e631e1ce1759fe4d68ebf9e166d79873d223e9ebf330e060b
+SHA512:
+  metadata.gz: 9e4ff10a85b68e80f8c099abd8083c7df0ab556ce88eba41e9ff2118ed868a341cfe9cfd2e5e0fd803e9ae801bfe5e6aee28bb0cb8e2100356ec9aa6585ade33
+  data.tar.gz: eb223603c6d2b4788b66dde0011a56dce5618c16ae620ad6aa501a6f69b15f6752e79d20a88bff3ef7f1c8125b9bdd42f11d27ff8016e32540a0a6723142ce74

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.vscode/launch.json

@@ -0,0 +1,21 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "rdbg",
+      "name": "Debug current file with rdbg",
+      "request": "launch",
+      "script": "${file}",
+      "args": [],
+      "askParameters": true
+    },
+    {
+      "type": "rdbg",
+      "name": "Attach with rdbg",
+      "request": "attach"
+    }
+  ]
+}

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2024-01-11
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 8bit-m8
+
+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,57 @@
+# injalid_dejice.rb
+
+Convets UTF-8 strings to the legacy KOI-7 encoding.
+
+**KOI-7** (Russian: КОИ-7) was a 7-bit character encoding developed in the USSR and based on the US-ASCII encoding.
+
+US-ASCII has only 128 code points, which is enough to encode the Latin alphabet (with numbers and most common punctuation marks), but not enough to encode both Latin and Cyrillic alphabets with the full set of characters (uppercase and lowercase). In order to add the Cyrillic alphabet support, but also remain the US-ASCII compatibility, KOI-7 designers came up with a “hack”, in which both Cyrillic and Latin characters were encoded with the same code points, while the ASCII control characters 0x0E and 0x0F were adapted to switch between the Cyrillic and the Latin code pages respectively.
+
+That led to funny bugs when a message was displayed with an incorrect code page. The «**иНЖАЛИД ДЕЖИЦЕ**» message (pronounced as “injalid dejitze”) was the most memorable, and it became somewhat a meme (hence the name of the gem). In fact, it was an incorrectly displayed English message, that simply stated: “Invalid device”.
+
+KOI-7 was widely used on the Soviet PDP-11 clones, notably the DVK systems and the Elektronika MK90 portable computer.
+
+## Installation
+
+Add this line to your application"s Gemfile:
+
+```ruby
+gem "injalid_dejice"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install injalid_dejice
+
+## Usage
+
+```ruby
+require "injalid_dejice"
+
+# Encode:
+str_to_encode = "Пользователи ДВК помнят 'инжалид дежице'!"
+InjalidDejice.utf_to_koi(str_to_encode)
+# => "\x0EpOLXZOWATELI dwk POMNQT 'INVALID DEVICE'!\x0F"
+
+# Decode:
+str_to_decode = "In KOI-7, two control characters can turn 'bhc' into '\x0Ebhc\x0F'!"
+InjalidDejice.koi_to_utf(str_to_decode)
+# => "In KOI-7, two control characters can turn 'bhc' into 'БХЦ'!"
+```
+
+## 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/8bit-mate/injalid_dejice.rb.
+
+## 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,16 @@
+# 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
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/injalid_dejice.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/injalid_dejice/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "injalid_dejice"
+  spec.version = InjalidDejice::VERSION
+  spec.authors = ["8bit-m8"]
+  spec.email = ["you@example.com"]
+
+  spec.summary = "UTF-8 <-> KOI-7 encoder/decoder."
+  spec.homepage = "https://github.com/8bit-mate/injalid_dejice.rb"
+  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"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/injalid_dejice/decoder.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module InjalidDejice
+  #
+  # Decodes an US-ASCII (KOI-7-compatible) string to the UTF-8 encoding.
+  #
+  class Decoder
+    OUTPUT_ENCODING = "UTF-8"
+
+    #
+    # Encode US-ANSII (KOI-7-compatible) string to the UTF-8.
+    #
+    # @param [String] input_string
+    #
+    # @return [String] modified_string
+    #
+    # @raise [ArgumentError]
+    #   Found the beginning of the Cyrillic sub-string, but couldn't find the end.
+    #
+    def call(input_string)
+      modified_string = input_string.dup
+      start_idx = nil
+
+      input_string.each_char.with_index do |char, idx|
+        # Everything above the 0x7F cannot be in the KOI-7,
+        # so just get rid of it.
+        modified_string[idx] = UNKNOWN_CHAR if char.ord > 127
+
+        # Found beginning of a Cyr. sub-string.
+        start_idx = idx if char == CYR_CHAR
+
+        # Found end of a Cyr. sub-string. Decode everything between the
+        # control characters.
+        if char == LATIN_CHAR
+          # Decode characters only if 'start_idx' was set.
+          if start_idx
+            (start_idx + 1..idx).each do |sub_idx|
+              if modified_string[sub_idx].ord >= SHARED_CHARS_LIMIT
+                modified_string[sub_idx] = (LAT_TO_CYR_DICT[modified_string[sub_idx]] || UNKNOWN_CHAR)
+              end
+            end
+          end
+          start_idx = nil
+        end
+      end
+
+      # Found the beginning of the Cyr. sub-string, but couldn't find the end (the LATIN_CHAR marker),
+      # probably that means an unexpected end of the string. Raise an error.
+      raise ArgumentError, "unexpected end of the string" if start_idx
+
+      # Before the return remove control characters with the regex, and set the encoding.
+      modified_string.gsub(/[#{LATIN_CHAR}#{CYR_CHAR}]/, "").force_encoding(OUTPUT_ENCODING)
+    end
+  end
+end

data/lib/injalid_dejice/encoder.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module InjalidDejice
+  #
+  # Encodes a UTF-8 string to the KOI-7 encoding.
+  #
+  class Encoder
+    OUTPUT_ENCODING = "US-ASCII"
+
+    #
+    # Encode 'input_string' to the KOI-7 encoding.
+    #
+    # @param [String] input_string
+    #   A UTF-8 string.
+    #
+    # @return [String]
+    #   An ASCII string, KOI-7-compatible.
+    #
+    def call(input_string)
+      non_latin_indexes = _search_non_latin_indexes(input_string)
+
+      result = if non_latin_indexes.empty?
+                 # No non-Latin characters were found, so no futher action needed.
+                 input_string.dup
+               else
+                 _insert_shift_chars(
+                   _handle_replacements(input_string),
+                   non_latin_indexes
+                 )
+               end
+
+      result.force_encoding(OUTPUT_ENCODING)
+    end
+
+    private
+
+    #
+    # Replace all non-Latin characters in the 'input_string'.
+    #
+    # @param [String] input_string
+    # @param [Array<Array<Integer>>] non_latin_indexes
+    #
+    # @return [String] modified_string
+    #
+    def _handle_replacements(input_string)
+      encoding_options = {
+        invalid: :replace,
+        fallback: lambda { |char|
+          CYR_TO_LAT_DICT.fetch(char, UNKNOWN_CHAR)
+        }
+      }
+
+      input_string.encode(Encoding.find("US-ASCII"), **encoding_options)
+    end
+
+    #
+    # Insert SO & SI control characters to the string.
+    #
+    # @param [String] input_string
+    # @param [Array<Array<Integer>>] non_latin_indexes
+    #
+    # @return [String] input_string
+    #   Modified string.
+    #
+    def _insert_shift_chars(input_string, non_latin_indexes)
+      i = 0 # Counter of insertions.
+
+      non_latin_indexes.each do |start_idx, end_idx|
+        # Add a Cyrillic code page marker (SO) at the beginning of the Cyrillic sub-string.
+        # + 2 * i since each i-th Cyrillic sub-string gets wrapped with two chars (SO + SI),
+        # so all indexes get shifted.
+        input_string.insert(start_idx + 2 * i, CYR_CHAR)
+
+        # Add a Latin code page marker (SI) at the end of the Cyrillic sub-string.
+        # + (end_idx + 2) since #insert method inserts a sub-string *before* the character at
+        # the given index, so +1 to insert it *after*. Another +1 as we've just insert SO
+        # character, so all indexes were shifted.
+        input_string.insert((end_idx + 2) + 2 * i, LATIN_CHAR)
+        i += 1
+      end
+
+      input_string
+    end
+
+    #
+    # Return start and end indexes for all so-called "non-Latin" sub-strings of the
+    # input string. Numbers and some punctuation characters can be part of both Latin,
+    # and non-Latin sub-strings. The "locale" of these characters is defined by the
+    # preceding character. E.g., in the string "привет-123 hello-456" the "-123 " chunk
+    # (note the trailing space) would be considered as a part of the non-Latin sub-
+    # string, while the "-456" chunk as a part of the Latin sub-string.
+    #
+    # @param [String] input_string
+    #
+    # @return [Array<Array<Integer>>] non_latin_indexes
+    #   Pairs of non-Latin character indexes.
+    #   Example: [[2, 5], [9, 14]], i.e. 'input_string' has two non-Latin sub-strings.
+    #   The first one occupies characters from 2-nd to 5-th, the second one from 9-th
+    #   to 14-th. If there's no such sub-string, the 'non_latin_indexes' is an empty
+    #   array.
+    #
+    def _search_non_latin_indexes(input_string)
+      non_latin_indexes = []
+      start_index = nil
+
+      input_string.each_char.with_index do |char, idx|
+        if char.ord < SHARED_CHARS_LIMIT
+          # Skip, no action needed, as the character is shared by both
+          # Latin & Cyrillic charsets.
+        elsif char.ord >= SHARED_CHARS_LIMIT && char.ord <= ASCII_CHARS_LIMIT
+          # Latin character.
+
+          # If the current character is Latin and 'start_index' is set,
+          # it means the Cyrillic substring has ended.
+          if start_index
+            non_latin_indexes << [start_index, idx - 1]
+            start_index = nil
+          end
+        elsif start_index.nil?
+          start_index = idx
+        end
+        # Cyrillic character (or possibly other unsupported non-ASCII).
+      end
+
+      # Handle the last sub-string.
+      non_latin_indexes << [start_index, input_string.length - 1] if start_index
+
+      non_latin_indexes
+    end
+  end
+end

data/lib/injalid_dejice/injalid_dejice.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module InjalidDejice
+  # Cyrillic char. => Latin char. KOI-7 conversion dictionary.
+  CYR_TO_LAT_DICT = {
+    "ю" => "@",
+    "а" => "A",
+    "б" => "B",
+    "ц" => "C",
+    "д" => "D",
+    "е" => "E",
+    "ф" => "F",
+    "г" => "G",
+    "х" => "H",
+    "и" => "I",
+    "й" => "J",
+    "к" => "K",
+    "л" => "L",
+    "м" => "M",
+    "н" => "N",
+    "о" => "O",
+    "п" => "P",
+    "я" => "Q",
+    "р" => "R",
+    "с" => "S",
+    "т" => "T",
+    "у" => "U",
+    "ж" => "V",
+    "в" => "W",
+    "ь" => "X",
+    "ы" => "Y",
+    "з" => "Z",
+    "ш" => "[",
+    "э" => "\\",
+    "щ" => "]",
+    "ч" => "^",
+    "ъ" => "_",
+    "Ю" => "`",
+    "А" => "a",
+    "Б" => "b",
+    "Ц" => "c",
+    "Д" => "d",
+    "Е" => "e",
+    "Ф" => "f",
+    "Г" => "g",
+    "Х" => "h",
+    "И" => "i",
+    "Й" => "j",
+    "К" => "k",
+    "Л" => "l",
+    "М" => "m",
+    "Н" => "n",
+    "О" => "o",
+    "П" => "p",
+    "Я" => "q",
+    "Р" => "r",
+    "С" => "s",
+    "Т" => "t",
+    "У" => "u",
+    "Ж" => "v",
+    "В" => "w",
+    "Ь" => "x",
+    "Ы" => "y",
+    "З" => "z",
+    "Ш" => "{",
+    "Э" => "|",
+    "Щ" => "}",
+    "Ч" => "~"
+  }.freeze
+
+  # Latin char. => Cyrillic char. KOI-7 conversion dictionary.
+  LAT_TO_CYR_DICT = CYR_TO_LAT_DICT.invert.freeze
+
+  # ASCII characters from 0 to 64 are shared by both Latin (KOI-7 N0) & Cyrillic (KOI-7 N1)
+  # KOI-7 code pages.
+  SHARED_CHARS_LIMIT = 64
+
+  # ASCII highest possible character code.
+  ASCII_CHARS_LIMIT = 127
+
+  # Character to use if no replacement was found in the CYR_TO_LAT_DICT dictionary.
+  UNKNOWN_CHAR = "?"
+
+  # Swithes encoding to the Cyrillic KOI-7 code page. Also known as "Shift Out" (SO) character.
+  CYR_CHAR = 0x0E.chr
+
+  # Swithes encoding to the Latin KOI-7 code page. Also known as "Shift In" (SI) character.
+  LATIN_CHAR = 0x0F.chr
+end

data/lib/injalid_dejice/version.rb

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

data/lib/injalid_dejice.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "injalid_dejice/encoder"
+require_relative "injalid_dejice/decoder"
+require_relative "injalid_dejice/injalid_dejice"
+require_relative "injalid_dejice/version"
+
+#
+# UTF-8 <-> KOI-7 encoder/decoder.
+#
+module InjalidDejice
+  class Error < StandardError; end
+
+  #
+  # Encode 'utf_string' to the KOI-7 encoding.
+  #
+  # @param [String] utf_string
+  #   A UTF-8 string.
+  #
+  # @return [String]
+  #   An US-ASCII string, KOI-7-compatible.
+  #
+  def self.utf_to_koi(utf_string)
+    Encoder.new.call(utf_string)
+  end
+
+  def self.koi_to_utf(koi_string)
+    Decoder.new.call(koi_string)
+  end
+end

data/sig/injalid_dejice.rbs

@@ -0,0 +1,4 @@
+module InjalidDejice
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: injalid_dejice
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- 8bit-m8
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-01-10 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- you@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".vscode/launch.json"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- injalid_dejice.gemspec
+- lib/injalid_dejice.rb
+- lib/injalid_dejice/decoder.rb
+- lib/injalid_dejice/encoder.rb
+- lib/injalid_dejice/injalid_dejice.rb
+- lib/injalid_dejice/version.rb
+- sig/injalid_dejice.rbs
+homepage: https://github.com/8bit-mate/injalid_dejice.rb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/8bit-mate/injalid_dejice.rb
+  source_code_uri: https://github.com/8bit-mate/injalid_dejice.rb
+  changelog_uri: https://github.com/8bit-mate/injalid_dejice.rb
+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.4.10
+signing_key: 
+specification_version: 4
+summary: UTF-8 <-> KOI-7 encoder/decoder.
+test_files: []