base45 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 391fbba1f795babf955ab02b30fbe0f9016cd4440d33727bf76883feeb6a341d
+  data.tar.gz: c533882b3b041d2d5d5c5e6e68830900bc5ff63a42ea1c7c17b8d5867c5a7888
+SHA512:
+  metadata.gz: 86c794ec6a105a7db8a7eab5d934d9bcccb2d6d58d38d75ab75fc2ff57047363f43fed0b025947fb92418b4c138b41e87e0b1ce1e42123d7fca3d4df1e285056
+  data.tar.gz: 937cad72b4c7b54d87f23eb8484a76a6589e029e3e8eb8afc0be86de63974f0c7bd44ecf15905d5c1253d32d3796c005cd6c20a9e0c19caba465afd0115f14df

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Wattswing
+
+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,61 @@
+# Base45
+
+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:
+
+```ruby
+gem 'base45'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install base45
+
+## Usage
+
+Some simple encoding and decoding:
+
+```ruby
+require "base45"
+
+encoded = Base45.encode("The truth is out there")
+# => "8UADZCKWE8%EG7D+EDN448%ES44+8DZKE"
+
+decoded = Base45.decode(encoded)
+# => "The truth is out there"
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` 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/wattswing/base45.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/base45.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/base45/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "base45"
+  spec.version       = Base45::VERSION
+  spec.authors       = ["Wattswing"]
+  spec.email         = ["wattswing@gmail.com"]
+
+  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.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.
+  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"]
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+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.
+
+# (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/lib/base45/encoding_table.rb

@@ -0,0 +1,53 @@
+# 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
+
+  INVERTED_BASE_45_TABLE = BASE_45_TABLE.invert.freeze
+end

data/lib/base45/version.rb

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

data/lib/base45.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+#
+# = base45.rb: methods for base45-encoding and -decoding strings
+#
+
+# 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"
+
+# Exposes two methods to decode and encode in base 45
+module Base45
+  class Error < StandardError; end
+
+  class << self
+    # Returns the Base45-encoded version of +payload+
+    #
+    #    require 'base45'
+    #    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
+
+      encode_for_multipe_chars(payload)
+    end
+
+    # Returns the Base45-decoded version of +payload+
+    #
+    #    require 'base45'
+    #    Base45.encode(":Y8UPCAVC3/DH44M-DUJCLQE934AW6X0")
+    #
+    # <i>Generates:</i>
+    #
+    #    Encoding in base 45 !
+    def decode(payload)
+      return if payload.length < 2
+
+      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/, "")
+    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 encode_for_single_char(payload)
+      keys = payload.bytes[0].divmod(45).reverse
+
+      keys.map { |i| BASE_45_TABLE[i.to_s.rjust(2, "0")] }.join
+    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
+
+      modulo45_bytes = modulo45_array(bytes16)
+
+      modulo45_bytes.flatten.map do |i|
+        BASE_45_TABLE[i.to_s.rjust(2, "0")]
+      end.join
+    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
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: base45
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wattswing
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-11-02 00:00:00.000000000 Z
+dependencies: []
+description: Decode / encode in base 45
+email:
+- wattswing@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- base45.gemspec
+- bin/console
+- bin/setup
+- lib/base45.rb
+- lib/base45/encoding_table.rb
+- lib/base45/version.rb
+homepage: https://github.com/wattswing/base45
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wattswing/base45
+  source_code_uri: https://github.com/wattswing/base45
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.29
+signing_key:
+specification_version: 4
+summary: Decode / encode in base 45
+test_files: []