base85 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 328dd90db168fa41b46bfe68fbee1fecf63547fa31cdae25a9405753c58cb8f3
+  data.tar.gz: 631040e522c72ec2191b709d024334f98a0c1caf1a71067ae3c63563d4eedc6b
+SHA512:
+  metadata.gz: 74fd0e3d3a76477ae6598e6665499150b3c874dc2e052d9797dc884a82a4736724a28647a16f7873cf502d8893f733b22b0cafb544097090de1ece7d81f0c6f2
+  data.tar.gz: 7d34cdcd2606ad5ed01f95875c4b1b3d183af6855dd0fda9f543fe179c63ac0d556f4ac500765f8b5cfd55bf3eacb762aece0f87bb29991d5721c42273ae220b

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,25 @@
+plugins:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 120
+
+RSpec/DescribedClass:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-06-14
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 TODO: Write your name
+
+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,45 @@
+# Base85
+
+Base85 is a pure Ruby gem to encode/decode data using Base85 encoding.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    bundle add base85
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    gem install base85
+
+## Usage
+
+To encode a string:
+
+```ruby
+require "base85"
+
+Base85.encode("test1")  #=> "FCfN80`"
+```
+
+To decode a string:
+
+```ruby
+require "base85"
+
+Base85.decode("!!!!!")  #=> "\u0000\u0000\u0000\u0000"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bundle exec 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 Codeberg at <https://codeberg.org/sd77/base85>.
+
+## 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/lib/base85/standard.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Base85
+  # Standard base85 encoding. This encoding uses '!' to 'u' ASCII characters to encode data.
+  # @author sd77
+  module Standard
+    # ASCII value for character '!'
+    BASE_ASCII_VALUE = "!".ord
+    # @private
+    LUT = (0..4).map { |count| 85**(4 - count) }.freeze
+
+    # @private
+    # Encode a single word
+    # @param [Integer] word
+    # @param [Integer] byte_count byte count of word. Must be in range 1..4
+    def self.encode_word(word, byte_count: 4)
+      encoded = "~" * 5
+      5.times do |i|
+        word, r = word.divmod(85)
+        encoded[-i - 1] = (BASE_ASCII_VALUE + r).chr
+      end
+      encoded[..byte_count]
+    end
+
+    # Encode data using standard base85 encoding
+    # @param [String] data
+    # @return [String]
+    def self.encode(data)
+      result = +""
+      data.unpack("N*").each do |word|
+        result << encode_word(word)
+      end
+
+      last_count = data.length % 4
+      return result if last_count.zero?
+
+      last_chars =  data[-last_count..] << ("\x00" * (4 - last_count))
+      result << encode_word(last_chars.unpack1("N"), byte_count: last_count)
+    end
+
+    # Decode data using standard base85 encoding
+    # @param [String] data
+    # @return [String]
+    # @raise [DecodeError] unknown character or invalid tuple
+    def self.decode(data)
+      result = +""
+      word = 0
+      count = 0
+      data.each_char do |c|
+        case c
+        when "!".."u" # rubocop:disable Lint/MixedCaseRange
+          idx = c.ord - BASE_ASCII_VALUE
+        else
+          raise DecodeError, "unknown character '#{c}'"
+        end
+
+        word += idx * LUT[count]
+        count += 1
+
+        if (count == 5) && (word > 0xffffffff)
+          raise DecodeError, "invalid tuple"
+        elsif count == 5
+          wordbuf = " " * 4
+          3.downto(0) do |i|
+            wordbuf.setbyte(i, word & 0xff)
+            word >>= 8
+          end
+          result << wordbuf
+          count = 0
+          word = 0
+        end
+      end
+
+      return result if count.zero?
+
+      count -= 1
+      word += LUT[count]
+      result << ((word >> 24) & 0xff).chr if count >= 1
+      result << ((word >> 16) & 0xff).chr if count >= 2
+      result << ((word >> 8) & 0xff).chr if count == 3
+      result
+    end
+  end
+end

data/lib/base85/version.rb

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

data/lib/base85.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "base85/version"
+require_relative "base85/standard"
+
+# Provide methods to encode/decode Base85 formatted data
+# @author sd77
+module Base85
+  # Base error for Base85
+  class Error < StandardError; end
+
+  # Error while decoding
+  class DecodeError < Error; end
+
+  # Unknown alphabet exception
+  class UnknownAlphabetError < Error
+    def initialize(name)
+      super
+      @name = name
+    end
+
+    def message
+      "Uknown alphabet '#{@name}'"
+    end
+  end
+
+  # Supported Base85 alphabets
+  SUPPORTED_ALPHABETS = %i[standard z85 rfc1924].freeze
+
+  def self.encode(data, alphabet: :standard)
+    case alphabet
+    when :standard
+      Standard.encode(data)
+    else
+      raise UnknownAlphabetError.new(alphabet)
+    end
+  end
+
+  def self.decode(data, alphabet: :standard)
+    case alphabet
+    when :standard
+      Standard.decode(data)
+    else
+      raise UnknownAlphabetError.new(alphabet)
+    end
+  end
+end

data/sig/base85.rbs

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

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: base85
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sd77
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-06-14 00:00:00.000000000 Z
+dependencies: []
+description: Encode and decode base85 data. Multiple alphabets are supported (standard,
+  Z85 or rfc1924)
+email:
+- sd@ld77.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/base85.rb
+- lib/base85/standard.rb
+- lib/base85/version.rb
+- sig/base85.rbs
+homepage: https://codeberg.org/sd77/base85
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://codeberg.org/sd77/base85
+  source_code_uri: https://codeberg.org/sd77/base85
+  changelog_uri: https://codeberg.org/sd77/base85/src/branch/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.15
+signing_key:
+specification_version: 4
+summary: Base85 encoding and decoding gem
+test_files: []