radix_encoding 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '018a417a158a2d60b134e3bf6331a29dac60dd87833f9350820238e5cb3c000d'
+  data.tar.gz: c7194e2fe2bec7e3e7c3dc336e7556ed7cbd1a1add1c51843c1916fae4a0bd20
+SHA512:
+  metadata.gz: a53bc0cf4447a43587a810dab88c5a5c96fd1ba1ec25b932596f0cde2ff853a6afdda621bf2b150e5e3b89d1da18b53552cc9f1acd31ca0be7e2fea2e50802ba
+  data.tar.gz: 899028cec1af9736746d172df569d4522fe4c65a196c253214a5d4f9a1d6bbdd34fa7bdfa58a50c78b878de41427bd0b38ec47ef71c4b03f3871a58ecdf31926

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,57 @@
+inherit_mode:
+  merge:
+    - Include
+    - Exclude
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
+Naming/PredicateName:
+  ForbiddenPrefixes:
+    - is_
+    - have_
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+Changelog
+=========
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog],
+and this project adheres to [Semantic Versioning].
+
+
+Unreleased
+----------
+
+- Add standard Base16, Base32, and Base64, encoding and decoding.
+
+
+[Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
+[Semantic Versioning]: https://semver.org/spec/v2.0.0.html

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in radix_encoding.gemspec
+gemspec
+
+gem "faker", "~> 2.x"
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 0.82.0"

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    radix_encoding (0.1.0)
+      activesupport (>= 3.0)
+      subvisual-utils (~> 0.x)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.0)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    faker (2.11.0)
+      i18n (>= 1.6, < 2)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    minitest (5.14.0)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    ruby-progressbar (1.10.1)
+    subvisual-utils (0.3.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faker (~> 2.x)
+  radix_encoding!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.82.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2020 Subvisual, Lda
+
+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,101 @@
+RadixEncoding
+=============
+
+Encode and decode strings using standard or custom versions of radix-based
+encodings, such as Base16 (hexadecimal encoding), Base32 and Base64.
+
+Thought for flexibility.
+
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "radix_encoding"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install radix_encoding
+
+
+Usage
+-----
+
+
+### Using a standard encoding
+
+The following standard encodings are currently fully supported, and available
+through constants under `RadixEncoding`:
+- Standard Hexadecimal encoding through `RadixEncoding::BASE16` ([RFC4648]); 
+- Standard Base32 encoding through `RadixEncoding::BASE32` ([RFC4648]); 
+- Standard Base64 encoding through `RadixEncoding::BASE64` ([RFC4648]); 
+
+
+### Using a custom encoding
+
+To create your own encoding variant, use the `RadixEncoding::Encoding` class.
+
+```ruby
+digest_hexencode = Encoding.new(
+  alphabet: "abcdefghijklmnopqrstuvwxyz234567",
+  radix: 32,
+  padding: "=",
+)
+```
+
+:warning: Caveats for the current implementation:
+- `alphabet` is **only** validated to have a length greater or equal to `radix`;
+- `radix` **must** be a power of 2, or it fall-back to the greatest power of 2
+  which is less than `radix`;
+- `padding` **should** be a string with a single character, otherwise the
+  behaviour is unspecified.
+
+
+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 tags, and push the `.gem` file to [rubygems.org].
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/subvisual/ruby-radix-encoding.
+
+
+License
+-----
+
+RadixEncoding is copyright © 2020 Subvisual, Lda.
+
+It is open-source, made available for free, and is subject to the terms in
+its [license].
+
+
+About
+-----
+
+RadixEncoding was created and is maintained with :heart: by
+[Subvisual][subvisual].
+
+[![Subvisual][subvisual-logo]][subvisual]
+
+
+[RFC4648]: https://tools.ietf.org/html/rfc4648
+[license]: ./LICENSE.txt
+[rubygems.org]: https://rubygems.org
+[subvisual]: http://subvisual.com
+[subvisual-logo]: https://raw.githubusercontent.com/subvisual/guides/master/github/templates/logos/blue.png

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/radix_encoding/encoding/bits.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "subvisual/array_utils"
+
+module RadixEncoding
+  class Encoding
+    module Bits
+      def bits_for(bytes)
+        bytes.
+          map do |byte|
+            byte.
+              # Convert the byte (a number) to a string with its binary form
+              to_s(2).
+              # Pad the result with leading zeros to represent all the bits
+              rjust(8, "0")
+          end.
+          # Join all the bits strings
+          join.
+          # Split the string into an array of characters (each is a bit)
+          chars
+      end
+    end
+
+    def bytes_for(bits)
+      bits.each_slice(8).map do |byte_bits|
+        byte_bits.join.to_i(2)
+      end
+    end
+
+    def pad_bits(bits, padded_bitsize)
+      Subvisual::ArrayUtils.pad_right(bits, padded_bitsize, "0")
+    end
+
+    def unpad_bits(bits)
+      excess_bits = bits.size % 8
+
+      return bits if excess_bits.zero?
+
+      bits[0...-excess_bits]
+    end
+  end
+end

data/lib/radix_encoding/encoding/chunks.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RadixEncoding
+  class Encoding
+    module Chunks
+      def chunk_bitsize
+        raise NotImplementedError
+      end
+
+      def chunks_total_bitsize_for(bits)
+        count_chunks_in(bits) * chunk_bitsize
+      end
+
+      def count_chunks_in(bits)
+        (bits.size / chunk_bitsize.to_f).ceil
+      end
+    end
+  end
+end

data/lib/radix_encoding/encoding/encoded_points.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/object/blank"
+require "subvisual/array_utils"
+
+module RadixEncoding
+  class Encoding
+    module EncodedPoints
+      def alphabet
+        raise NotImplementedError
+      end
+
+      def clean_encoded_points(encoded_points, padding_size)
+        return encoded_points unless padding_size.positive?
+
+        encoded_points[0...-padding_size]
+      end
+
+      def count_encoded_points_in(bitsize)
+        bitsize / encoded_point_bitsize
+      end
+
+      def bits_from_encoded_points(encoded_points)
+        encoded_points.
+          map do |encoded_point|
+            alphabet.
+              index(encoded_point).
+              to_s(2).
+              rjust(encoded_point_bitsize, "0")
+          end.
+          join.
+          chars
+      end
+
+      def encoded_point_bitsize
+        raise NotImplementedError
+      end
+
+      def encoded_points_for(bits)
+        bits.
+          each_slice(encoded_point_bitsize).
+          map do |encoded_point_bits|
+            encoded_point_index = encoded_point_bits.join.to_i(2)
+
+            alphabet[encoded_point_index]
+          end
+      end
+
+      def pad_encoded_points(encoded_points, padding_size)
+        return encoded_points if padding.blank?
+
+        padded_size = encoded_points.size + padding_size
+
+        Subvisual::ArrayUtils.pad_right(encoded_points, padded_size, padding)
+      end
+
+      def padding
+        raise NotImplementedError
+      end
+
+      def unpad_encoded_points(encoded_points)
+        first_padding_index = encoded_points.index(padding)
+
+        return encoded_points if first_padding_index.nil?
+
+        encoded_points[0...first_padding_index]
+      end
+    end
+  end
+end

data/lib/radix_encoding/encoding/errors.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RadixEncoding
+  class Encoding
+    class AlphabetTooShortError < StandardError
+      def initialize(alphabet_bytesize:, radix:)
+        super <<~MESSAGE
+          The provided alphabet is too short. It has #{alphabet_bytesize}
+          bytes, must have at least #{radix} bytes.
+        MESSAGE
+      end
+    end
+
+    class DataTypeNotSupportedError < StandardError
+      def initialize(data_type:)
+        super <<~MESSAGE
+          The provided data is of a not supported type #{data_type}. Only
+          String is supported.
+        MESSAGE
+      end
+    end
+  end
+end

data/lib/radix_encoding/encoding/validations.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "radix_encoding/encoding/errors"
+
+module RadixEncoding
+  class Encoding
+    module Validations
+      def alphabet
+        raise NotImplementedError
+      end
+
+      def radix
+        raise NotImplementedError
+      end
+
+      def validate!
+        validate_alphabet_length!
+      end
+
+      def validate_alphabet_length!
+        return if alphabet.bytesize >= radix
+
+        raise AlphabetTooShortError.new(
+          alphabet_bytesize: alphabet.bytesize,
+          radix: radix,
+        )
+      end
+    end
+  end
+end

data/lib/radix_encoding/encoding.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "subvisual/math_utils"
+
+require "radix_encoding/encoding/bits"
+require "radix_encoding/encoding/chunks"
+require "radix_encoding/encoding/encoded_points"
+require "radix_encoding/encoding/errors"
+require "radix_encoding/encoding/validations"
+
+module RadixEncoding
+  class Encoding
+    include Bits
+    include Chunks
+    include EncodedPoints
+    include Validations
+
+    attr_reader :alphabet, :padding, :radix
+
+    def initialize(alphabet:, radix:, padding: nil)
+      @alphabet = alphabet
+      @padding = padding
+      @radix = radix
+
+      validate!
+    end
+
+    def decode(data)
+      decoded = data.chars
+      decoded = unpad_encoded_points(decoded)
+      decoded = bits_from_encoded_points(decoded)
+      decoded = unpad_bits(decoded)
+      decoded = bytes_for(decoded)
+      decoded = decoded.pack("c*")
+      decoded
+    end
+
+    def encode(data)
+      case data
+      when String
+        encode_bytes(data.bytes)
+      else
+        raise DataTypeNotSupportedError.new(data_type: data.class)
+      end
+    end
+
+    private
+
+    attr_reader :lower_bound, :upper_bound
+
+    def chunk_bitsize
+      @chunk_bitsize ||=
+        Subvisual::MathUtils.least_common_denominator(lower_power, 8)
+    end
+
+    def encode_bytes(bytes)
+      bits = bits_for(bytes)
+      padded_bitsize = chunks_total_bitsize_for(bits)
+      padding_count = count_encoded_points_in(padded_bitsize - bits.size)
+
+      encoded = pad_bits(bits, padded_bitsize)
+      encoded = encoded_points_for(encoded)
+      encoded = clean_encoded_points(encoded, padding_count)
+      encoded = pad_encoded_points(encoded, padding_count)
+      encoded = encoded.join
+      encoded
+    end
+
+    def encoded_point_bitsize
+      @encoded_point_bitsize ||= chunk_bitsize / encoded_points_per_chunk
+    end
+
+    def encoded_points_per_chunk
+      @encoded_points_per_chunk ||= chunk_bitsize / lower_power
+    end
+
+    def lower_power
+      @lower_power ||= if radix == 2**upper_power
+                         upper_power
+                       else
+                         upper_power - 1
+                       end
+    end
+
+    def upper_power
+      @upper_power ||= begin
+                         power = 0
+                         power += 1 while 2**power < radix
+                         power
+                       end
+    end
+  end
+end

data/lib/radix_encoding/version.rb

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

data/lib/radix_encoding.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "radix_encoding/encoding"
+require "radix_encoding/version"
+
+module RadixEncoding
+  # Standard Base16 encoding as defined in RFC 4648.
+  BASE16 = Encoding.new(
+    alphabet: "0123456789ABCDEF",
+    radix: 16,
+  )
+
+  # Standard Base32 encoding as defined in RFC 4648.
+  BASE32 = Encoding.new(
+    alphabet: "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567",
+    radix: 32,
+    padding: "=",
+  )
+
+  # Standard Base64 encoding as defined in RFC 4648.
+  BASE64 = Encoding.new(
+    alphabet: "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
+      "abcdefghijklmnopqrstuvwxyz" \
+      "0123456789" \
+      "+/",
+    radix: 64,
+    padding: "=",
+  )
+end

data/radix_encoding.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/radix_encoding/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "radix_encoding"
+  spec.version       = RadixEncoding::VERSION
+  spec.authors       = ["Pedro Costa"]
+  spec.email         = ["pedro@subvisual.com"]
+  spec.license       = "MIT"
+
+  spec.summary       = "Encode data in any base and alphabet"
+  spec.description   = <<~DESCRIPTION
+    Binary to text encoding of data is commonly used for transmission when the
+    channel does not support binary data. Common formats are Base16 (also known
+    as hexadecimal), Base32, and Base64.
+
+    However it is possible to encode data into any base, given an alphabet with
+    that length. This tool allows the creation of an encoder for any base and
+    alphabet, handling the special case where the base is not a power of 2.
+  DESCRIPTION
+  spec.homepage = "https://github.com/subvisual/ruby-radix-encoding"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/subvisual/ruby-radix-encoding"
+  spec.metadata["changelog_uri"] = "https://github.com/subvisual/ruby-radix-encoding/blob/master/CHANGELOG.md"
+
+  # 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 { |f| f.match(%r{^(bin|spec)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 3.0"
+  spec.add_dependency "subvisual-utils", "~> 0.x"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: radix_encoding
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pedro Costa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: subvisual-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.x
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.x
+description: |
+  Binary to text encoding of data is commonly used for transmission when the
+  channel does not support binary data. Common formats are Base16 (also known
+  as hexadecimal), Base32, and Base64.
+
+  However it is possible to encode data into any base, given an alphabet with
+  that length. This tool allows the creation of an encoder for any base and
+  alphabet, handling the special case where the base is not a power of 2.
+email:
+- pedro@subvisual.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/radix_encoding.rb
+- lib/radix_encoding/encoding.rb
+- lib/radix_encoding/encoding/bits.rb
+- lib/radix_encoding/encoding/chunks.rb
+- lib/radix_encoding/encoding/encoded_points.rb
+- lib/radix_encoding/encoding/errors.rb
+- lib/radix_encoding/encoding/validations.rb
+- lib/radix_encoding/version.rb
+- radix_encoding.gemspec
+homepage: https://github.com/subvisual/ruby-radix-encoding
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/subvisual/ruby-radix-encoding
+  source_code_uri: https://github.com/subvisual/ruby-radix-encoding
+  changelog_uri: https://github.com/subvisual/ruby-radix-encoding/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Encode data in any base and alphabet
+test_files: []