dec_radix_50 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af13bb1390881961f4adcce1eef072dd44973202c75fba11bc05104be52761d1
-  data.tar.gz: abb419dfd9e600d6cc8f62e5a0bdc07bc424c7a5f2e079f50466bb92ca2abaf1
+  metadata.gz: 9ad5e6f71065350c8189ad0bc85012d93048e96232e04769ebebd500568602a6
+  data.tar.gz: 05a18a04c41cb74c12f4cb6d19ccd184059e0f5066a2f66920c7fd1a68067a4a
 SHA512:
-  metadata.gz: 15cf0eb15e0dc49f14b2f4fde2ea77babfe76f32dfc9c340dd566f95edc244e85b9e7057955a4c379491e8750d567892832c84f16bf8ea79f2447d3cf580880a
-  data.tar.gz: 6b48b614e5c58b48e054e145991e43e6eb52dab8718fbb87ac832a239d41f5e701f1f0f3e8b56cb3bb0d80b28ad63b9ae6d03a4520cca45370aac47b920c1e59
+  metadata.gz: be68f943d6e821e21133f97ab14906294b270de2874617206a28b28d6858a9a0ce2e46d66948860f4681da38f2ed6109d8fc4bfa88bdeba5941134c3253e6cd7
+  data.tar.gz: 30ae149e388de3e15bc0d2d3660fc7e75b88fabfb6dc893183da7990e244a1d2421958830d746708b96067db3ef62ba48f438c125dbdaef586d28f1df97c0da2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.2.0] - 2024-01-31
+
+- Decoding is supported now.
+
 ## [0.1.0] - 2024-01-02
 
 - Initial release (only encoding is supported).

data/README.md

@@ -26,11 +26,13 @@ Or install it yourself as:
 
 ## Usage
 
-DECRadix50.encode(charset, string \[, replace_char = " "\]) => Array\<Integer\>
+### Encoding
+
+DECRadix50.encode(charset, string \[, replace_char\]) => Array\<Integer\>
 
 ### Arguments
 
-+ **charset**: character set, should be 40 characters long.
++ **charset**: character set, should be 40 characters long for the DEC RADIX-50. The charset string length defines the base.
 
   The gem comes with two predefined characters sets:
 
@@ -44,7 +46,7 @@ DECRadix50.encode(charset, string \[, replace_char = " "\]) => Array\<Integer\>
 
 + **string**: string to encode.
 
-+ **replace_char**: replaces unsupported characters. Default value is " " (a space).
++ **replace_char**: replaces unsupported characters in the input string. Should be included in the charset. Default value is " " (a space).
 
 ### Returns
 
@@ -59,6 +61,29 @@ DECRadix50.encode(DECRadix50::MK90_CHARSET, "ABCDEF")
 # => [1683, 6606]
 ```
 
+### Decoding
+
+DECRadix50.decode(charset, encoded_values) => String
+
+### Arguments
+
++ **charset**: character set, should be 40 characters long for the DEC RADIX-50. The charset string length defines the base.
+
++ **encoded_values**: array of integers that represent an encoded string.
+
+### Returns
+
++ String.
+
+### Example:
+
+```ruby
+require "dec_radix_50"
+
+DECRadix50.decode(DECRadix50::MK90_CHARSET, [2092, 1015, 34_320, 3259, 8001, 29_000, 3412, 24_567, 815, 859, 0])
+=> "ALL YOUR BASE ARE BELONG TO US   "
+```
+
 ## 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.

data/lib/dec_radix_50/decoder.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module DECRadix50
+  #
+  # Encodes strings to the DEC Radix-50 encoding.
+  #
+  class Decoder
+    def initialize(charset, encoded_values)
+      @charset = charset
+      @encoded_values = encoded_values
+      @base = charset.length
+
+      _validate_input_parameters
+    end
+
+    def decode
+      charset_values = @charset.split(//).each_with_index.to_h.invert
+
+      @encoded_values.map do |value|
+        x = charset_values[(value / @base / @base) % @base]
+        y = charset_values[(value / @base) % @base]
+        z = charset_values[value % @base]
+        "#{x}#{y}#{z}"
+      end.join
+    end
+
+    private
+
+    def _validate_input_parameters
+      raise DECRadix50::ArgumentError, "charset cannot be empty" if @charset.empty?
+      raise DECRadix50::ArgumentError, "input array cannot be empty" if @encoded_values.empty?
+
+      max_value = @base * @base * @base
+      in_range = @encoded_values.all? { |e| e < max_value }
+
+      raise DECRadix50::ArgumentError, "encoded values should be less than #{max_value}" unless in_range
+    end
+  end
+end

data/lib/dec_radix_50/encoder.rb

@@ -10,6 +10,7 @@ module DECRadix50
 
       @charset = charset
       @string = string.upcase.gsub(/[^#{charset}]/, replace_char)
+      @base = charset.length
     end
 
     # Based on the @jgn/radix50.rb
@@ -17,15 +18,15 @@ module DECRadix50
     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))
+        (((charset_values[x] || 0) * @base + (charset_values[y] || 0)) * @base + (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, "charset cannot be empty" if charset.empty?
+      raise DECRadix50::ArgumentError, "string cannot be empty" if string.empty?
       raise DECRadix50::ArgumentError, "replace_char should be exactly 1 character long" unless replace_char.length == 1
     end
   end

data/lib/dec_radix_50/version.rb

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

data/lib/dec_radix_50.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "dec_radix_50/decoder"
 require_relative "dec_radix_50/encoder"
 require_relative "dec_radix_50/version"
 
@@ -20,14 +21,14 @@ module DECRadix50
   # 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.
+  #   charset, they will be replaced with the replace_char. replace_char
+  #   should be part of the charset.
   #
   # @return [Array<Integer>]
   #   Radix-50 (decimal numeral system).
@@ -35,4 +36,18 @@ module DECRadix50
   def self.encode(charset, string, replace_char = " ")
     Encoder.new(charset, string, replace_char).encode
   end
+
+  #
+  # Decode array of integers to a string.
+  #
+  # @param [String] charset
+  #
+  # @param [Array<Integer>] int_array
+  #   Integer values to decode.
+  #
+  # @return [String]
+  #
+  def self.decode(charset, int_array)
+    Decoder.new(charset, int_array).decode
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dec_radix_50
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - 8bit-m8
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-02 00:00:00.000000000 Z
+date: 2024-01-31 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -25,6 +25,7 @@ files:
 - Rakefile
 - dec_radix_50.gemspec
 - lib/dec_radix_50.rb
+- lib/dec_radix_50/decoder.rb
 - lib/dec_radix_50/encoder.rb
 - lib/dec_radix_50/version.rb
 - sig/dec_radix_50.rbs