dec_radix_50 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: af13bb1390881961f4adcce1eef072dd44973202c75fba11bc05104be52761d1
+  data.tar.gz: abb419dfd9e600d6cc8f62e5a0bdc07bc424c7a5f2e079f50466bb92ca2abaf1
+SHA512:
+  metadata.gz: 15cf0eb15e0dc49f14b2f4fde2ea77babfe76f32dfc9c340dd566f95edc244e85b9e7057955a4c379491e8750d567892832c84f16bf8ea79f2447d3cf580880a
+  data.tar.gz: 6b48b614e5c58b48e054e145991e43e6eb52dab8718fbb87ac832a239d41f5e701f1f0f3e8b56cb3bb0d80b28ad63b9ae6d03a4520cca45370aac47b920c1e59

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-02
+
+- Initial release (only encoding is supported).

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,74 @@
+# dec_radix_50.rb
+
+Encodes strings to the DEC Radix-50 encoding.
+
+**RADIX 50** is an uppercase-only character encoding created by Digital Equipment Corporation (DEC) for use on their PDP, and VAX computers. RADIX 50's 40-character repertoire (050 in octal) can encode three characters into one 16-bit word (PDP-11, VAX). It was also adapted for use on the Soviet PDP-11 clones, notably the Elektronika MK90 portable computer.
+
+The actual encoding differs between the systems.
+
+Learn more on the [Wikipedia](https://en.wikipedia.org/wiki/DEC_RADIX_50).
+
+## Installation
+
+Add this line to your application"s Gemfile:
+
+```ruby
+gem "dec_radix_50"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dec_radix_50
+
+## Usage
+
+DECRadix50.encode(charset, string \[, replace_char = " "\]) => Array\<Integer\>
+
+### Arguments
+
++ **charset**: character set, should be 40 characters long.
+
+  The gem comes with two predefined characters sets:
+
+  ```Ruby
+  # Elektronika MK90 filenames charset:
+  MK90_CHARSET = " ABCDEFGHIJKLMNOPQRSTUVWXYZ$./0123456789"
+
+  # RT-11 filenames charset:
+  RT11_CHARSET = " ABCDEFGHIJKLMNOPQRSTUVWXYZ$%*0123456789"
+  ```
+
++ **string**: string to encode.
+
++ **replace_char**: replaces unsupported characters. Default value is " " (a space).
+
+### Returns
+
++ Array of integers.
+
+### Example:
+
+```ruby
+require "dec_radix_50"
+
+DECRadix50.encode(DECRadix50::MK90_CHARSET, "ABCDEF")
+# => [1683, 6606]
+```
+
+## 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/dec_radix_50.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/dec_radix_50.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/dec_radix_50/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "dec_radix_50"
+  spec.version = DECRadix50::VERSION
+  spec.authors = ["8bit-m8"]
+  spec.email = ["you@example.com"]
+
+  spec.summary = "DEC RADIX 50 encoding."
+  spec.homepage = "https://github.com/8bit-mate/dec_radix_50.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/dec_radix_50/encoder.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module DECRadix50
+  #
+  # Encodes strings to the DEC Radix-50 encoding.
+  #
+  class Encoder
+    def initialize(charset, string, replace_char)
+      _validate_input_parameters(charset, string, replace_char)
+
+      @charset = charset
+      @string = string.upcase.gsub(/[^#{charset}]/, replace_char)
+    end
+
+    # Based on the @jgn/radix50.rb
+    # https://gist.github.com/jgn/707543
+    def encode
+      charset_values = @charset.split(//).each_with_index.to_h
+      @string.chars.each_slice(3).map do |x, y, z|
+        (((charset_values[x] || 0) * 40 + (charset_values[y] || 0)) * 40 + (charset_values[z] || 0))
+      end
+    end
+
+    private
+
+    def _validate_input_parameters(charset, string, replace_char)
+      raise DECRadix50::ArgumentError, "charset should be 40 characters long" unless charset.length == 40
+      raise DECRadix50::ArgumentError, "string shouldn't be empty" if string.empty?
+      raise DECRadix50::ArgumentError, "replace_char should be exactly 1 character long" unless replace_char.length == 1
+    end
+  end
+end

data/lib/dec_radix_50/version.rb

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

data/lib/dec_radix_50.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "dec_radix_50/encoder"
+require_relative "dec_radix_50/version"
+
+#
+# Encodes strings to the DEC Radix-50 encoding.
+#
+module DECRadix50
+  class Error < StandardError; end
+  class ArgumentError < StandardError; end
+
+  # Elektronika MK90 filenames charset:
+  MK90_CHARSET = " ABCDEFGHIJKLMNOPQRSTUVWXYZ$./0123456789"
+
+  # RT-11 filenames charset:
+  RT11_CHARSET = " ABCDEFGHIJKLMNOPQRSTUVWXYZ$%*0123456789"
+
+  #
+  # Encode a string to the DEC Radix-50 encoding.
+  #
+  # @param [String] charset
+  #   Should be 40 characters long.
+  #
+  # @param [String] string
+  #   String to encode.
+  #
+  # @option [String] replace_char (" ")
+  #   If a given string has characters that aren't included in the
+  #   charset, they will be replaced with the replace_char.
+  #
+  # @return [Array<Integer>]
+  #   Radix-50 (decimal numeral system).
+  #
+  def self.encode(charset, string, replace_char = " ")
+    Encoder.new(charset, string, replace_char).encode
+  end
+end

data/sig/dec_radix_50.rbs

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

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: dec_radix_50
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- 8bit-m8
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-01-02 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
+- dec_radix_50.gemspec
+- lib/dec_radix_50.rb
+- lib/dec_radix_50/encoder.rb
+- lib/dec_radix_50/version.rb
+- sig/dec_radix_50.rbs
+homepage: https://github.com/8bit-mate/dec_radix_50.rb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/8bit-mate/dec_radix_50.rb
+  source_code_uri: https://github.com/8bit-mate/dec_radix_50.rb
+  changelog_uri: https://github.com/8bit-mate/dec_radix_50.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: DEC RADIX 50 encoding.
+test_files: []