base45 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 391fbba1f795babf955ab02b30fbe0f9016cd4440d33727bf76883feeb6a341d
-  data.tar.gz: c533882b3b041d2d5d5c5e6e68830900bc5ff63a42ea1c7c17b8d5867c5a7888
+  metadata.gz: 90f2a21cb5b510525fc9936d7513f1279398b029ed20ba64835ad6e6cb5c1540
+  data.tar.gz: 86d3fbe7bbb9fbf152732cf2dff58904d8ae94e4b2c8aab3ef5d75913bc13a44
 SHA512:
-  metadata.gz: 86c794ec6a105a7db8a7eab5d934d9bcccb2d6d58d38d75ab75fc2ff57047363f43fed0b025947fb92418b4c138b41e87e0b1ce1e42123d7fca3d4df1e285056
-  data.tar.gz: 937cad72b4c7b54d87f23eb8484a76a6589e029e3e8eb8afc0be86de63974f0c7bd44ecf15905d5c1253d32d3796c005cd6c20a9e0c19caba465afd0115f14df
+  metadata.gz: 65c5af1e33830c554e4d047a2f2f40e40037043e5d97242717f4f62bf302bf95890533bc07f1957799cea32a9a5575e2e791bab16fdb254920fbf60e5ab7dd9e
+  data.tar.gz: 021a2e76f56bd6038af906bd76c5bf32bf1ceb840f63741f05617f34adbd97647e27cb78ab22956c94a249b89cf8bf8cc1784ec47ac0db6aa74ae46a989859cf

data/.rubocop.yml

@@ -1,13 +1,12 @@
 AllCops:
   TargetRubyVersion: 3.0.2
 
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
 Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
 
 Layout/LineLength:
   Max: 120
+
+Metrics/BlockLength:
+  ExcludedMethods: ['describe']

data/Gemfile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
 
-gem "rake", "~> 13.0"
+gem 'rake', '~> 13.0'
 
-gem "rspec", "~> 3.0"
+gem 'rspec', '~> 3.2'
 
-gem "rubocop", "~> 1.7"
+gem 'rubocop', '~> 1.7'

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    base45 (0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.22.3)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.12.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  base45!
+  rake (~> 13.0)
+  rspec (~> 3.2)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.27

data/README.md

@@ -3,12 +3,6 @@
 The Base45 module provides for the encoding (#encode) and
 decoding (#decode) of binary data using a Base45 representation.
 
-Some resources used:
-
-* [Base 45 Draft](https://datatracker.ietf.org/doc/draft-faltstrom-base45/)
-* [A JS Base 45 implementation](http://base45-decode-encode.net/)
-* [SO question](https://stackoverflow.com/questions/68114693/decode-base45-string)
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -59,3 +53,9 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/wattsw
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Resources used
+
+* [Base 45 Draft](https://datatracker.ietf.org/doc/draft-faltstrom-base45/)
+* [A JS Base 45 implementation](http://base45-decode-encode.net/)
+* [SO question](https://stackoverflow.com/questions/68114693/decode-base45-string)

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 

data/base45.gemspec

@@ -1,22 +1,22 @@
 # frozen_string_literal: true
 
-require_relative "lib/base45/version"
+require_relative 'lib/base45/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "base45"
+  spec.name          = 'base45'
   spec.version       = Base45::VERSION
-  spec.authors       = ["Wattswing"]
-  spec.email         = ["wattswing@gmail.com"]
+  spec.authors       = ['Wattswing']
+  spec.email         = ['wattswing@gmail.com']
 
-  spec.summary       = "Decode / encode in base 45"
+  spec.summary       = 'Decode / encode in base 45'
   spec.description   = spec.summary
 
-  spec.homepage      = "https://github.com/wattswing/base45"
-  spec.license       = "MIT"
-  spec.required_ruby_version = ">= 3.0.2"
+  spec.homepage      = 'https://github.com/wattswing/base45'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 3.0.2'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_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.
@@ -25,7 +25,8 @@ Gem::Specification.new do |spec|
       (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
     end
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+  spec.add_development_dependency 'rspec', '~> 3.2'
 end

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
-require "base45"
+require 'bundler/setup'
+require 'base45'
 
 # 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.
@@ -11,5 +11,5 @@ require "base45"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/base45/encoding_table.rb

@@ -1,53 +1,11 @@
 # frozen_string_literal: true
 
 module Base45
-  BASE_45_TABLE = {
-    "00" => "0",
-    "01" => "1",
-    "02" => "2",
-    "03" => "3",
-    "04" => "4",
-    "05" => "5",
-    "06" => "6",
-    "07" => "7",
-    "08" => "8",
-    "09" => "9",
-    "10" => "A",
-    "11" => "B",
-    "12" => "C",
-    "13" => "D",
-    "14" => "E",
-    "15" => "F",
-    "16" => "G",
-    "17" => "H",
-    "18" => "I",
-    "19" => "J",
-    "20" => "K",
-    "21" => "L",
-    "22" => "M",
-    "23" => "N",
-    "24" => "O",
-    "25" => "P",
-    "26" => "Q",
-    "27" => "R",
-    "28" => "S",
-    "29" => "T",
-    "30" => "U",
-    "31" => "V",
-    "32" => "W",
-    "33" => "X",
-    "34" => "Y",
-    "35" => "Z",
-    "36" => " ",
-    "37" => "$",
-    "38" => "%",
-    "39" => "*",
-    "40" => "+",
-    "41" => "-",
-    "42" => ".",
-    "43" => "/",
-    "44" => ":"
-  }.freeze
+  BASE_45_TABLE = [
+    *('0'..'9').to_a,
+    *('A'..'Z').to_a,
+    ' ', '$', '%', '*', '+', '-', '.', '/', ':'
+  ].each_with_object({}).with_index { |(index, memo), i| memo[i] = index }
 
   INVERTED_BASE_45_TABLE = BASE_45_TABLE.invert.freeze
 end

data/lib/base45/errors.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Base45
+  class IllegalCharacterError < StandardError; end
+
+  class ForbiddenLengthError < StandardError; end
+
+  class OverflowError < StandardError; end
+end

data/lib/base45/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Base45
-  VERSION = "0.1.0"
+  VERSION = '0.3.0'
 end

data/lib/base45.rb

@@ -7,83 +7,78 @@
 # The Base45 module provides for the encoding (#encode) and
 # decoding (#decode) of binary data using a Base45 representation.
 
-require_relative "base45/version"
-require_relative "base45/encoding_table"
+require_relative 'base45/version'
+require_relative 'base45/encoding_table'
+require_relative 'base45/errors'
 
 # Exposes two methods to decode and encode in base 45
 module Base45
-  class Error < StandardError; end
+  SQUARE_45 = 45**2
 
   class << self
     # Returns the Base45-encoded version of +payload+
     #
     #    require 'base45'
-    #    Base45.encode("Encoding in base 45 !")
+    #    Base45.encode('Encoding in base 45 !')
     #
     # <i>Generates:</i>
     #
     #    :Y8UPCAVC3/DH44M-DUJCLQE934AW6X0
     def encode(payload)
-      return if payload.length.zero?
-
-      return encode_for_single_char(payload) if payload.bytesize < 2
+      sliced_bytes = payload.each_byte.each_slice(2)
+      base45_bytes = sliced_bytes.flat_map do |byte_a, byte_b|
+        byte_b ? encode_two_bytes(byte_a, byte_b) : encode_one_byte(byte_a)
+      end
 
-      encode_for_multipe_chars(payload)
+      base45_bytes.map do |byte45|
+        BASE_45_TABLE[byte45]
+      end.join
     end
 
     # Returns the Base45-decoded version of +payload+
     #
     #    require 'base45'
-    #    Base45.encode(":Y8UPCAVC3/DH44M-DUJCLQE934AW6X0")
+    #    Base45.encode(':Y8UPCAVC3/DH44M-DUJCLQE934AW6X0')
     #
     # <i>Generates:</i>
     #
     #    Encoding in base 45 !
     def decode(payload)
-      return if payload.length < 2
+      map45_chars(payload).each_slice(3).flat_map do |c, d, e|
+        raise ForbiddenLengthError if d.nil?
 
-      lookup = sliced_payload(payload)
-      base45_vals = lookup.map { |c, d, e| c + d * 45 + (e ? e * 45**2 : 0) }
-
-      base45_vals.pack("S>*").gsub(/\x00/, "")
+        v = c + d * 45
+        bytes_from_base45(e, v)
+      end.pack('C*')
     end
 
     private
 
-    def sliced_payload(payload)
-      payload.chars.each_slice(3).map do |slice|
-        slice.map { |char| INVERTED_BASE_45_TABLE[char]&.to_i }
-      end
-    end
+    def bytes_from_base45(last_triplet_byte, factor45)
+      return [factor45] unless last_triplet_byte
 
-    def encode_for_single_char(payload)
-      keys = payload.bytes[0].divmod(45).reverse
+      factor45 += last_triplet_byte * SQUARE_45
+      x, y = factor45.divmod(256)
+      raise OverflowError unless x < 256
 
-      keys.map { |i| BASE_45_TABLE[i.to_s.rjust(2, "0")] }.join
+      [x, y]
     end
 
-    def encode_for_multipe_chars(payload)
-      # 16-bit unsigned (unsigned char) - except big endian
-      bytes16 = payload.unpack("S>*")
-
-      is_odd = payload.bytesize.odd? && payload.bytes[-1] < 256
-      bytes16 << payload.bytes[-1] if is_odd
+    def encode_one_byte(byte)
+      byte.divmod(45).reverse
+    end
 
-      modulo45_bytes = modulo45_array(bytes16)
+    def encode_two_bytes(first_byte, second_byte)
+      x = (first_byte << 8) + second_byte
+      e, x = x.divmod(SQUARE_45)
+      d, c = x.divmod(45)
 
-      modulo45_bytes.flatten.map do |i|
-        BASE_45_TABLE[i.to_s.rjust(2, "0")]
-      end.join
+      [c, d, e]
     end
 
-    def modulo45_array(bytes16)
-      bytes16.map do |byte|
-        arr = []
-        multiplier, rest = byte.divmod(45**2)
-        arr << multiplier if multiplier.positive?
-        arr.push(*rest.divmod(45))
-
-        arr.reverse
+    def map45_chars(string)
+      string.chars.map do |char|
+        INVERTED_BASE_45_TABLE[char] || raise(IllegalCharacterError, char)
       end
     end
   end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: base45
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Wattswing
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-02 00:00:00.000000000 Z
-dependencies: []
+date: 2024-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
 description: Decode / encode in base 45
 email:
 - wattswing@gmail.com
@@ -20,6 +34,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -28,6 +43,7 @@ files:
 - bin/setup
 - lib/base45.rb
 - lib/base45/encoding_table.rb
+- lib/base45/errors.rb
 - lib/base45/version.rb
 homepage: https://github.com/wattswing/base45
 licenses:
@@ -50,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.29
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Decode / encode in base 45