ob64 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d1111a285be1731afda3a4b3040eb9150109a6022eaea13d007004e5d51dcfe
-  data.tar.gz: e3a298f4286ac95e6656cd0ba0fdebefa1e7f180eec6f4ca0b3f7def4de64122
+  metadata.gz: cf866c04fac9e6cf9d4f8c98741f17e2109e0bd5fd545d2d0482b4c28a6dd61a
+  data.tar.gz: e6ee12aebbece01e6e1ce8181aafdfe9b32b7fbd2d1307c07d7af02d46b73f4e
 SHA512:
-  metadata.gz: b5992c541b3d46c846bb3e22f8e7e01aed89b8a8760ce3ca401263ebfebbd9130cfba69eacee46e288fdba44ed5319ee1086ff55e9e0b0b6791254def2577632
-  data.tar.gz: 3e77098bab5a772fdab9cf3cc0d987ee18e7a64748dd3fda9bc970cc29b15e48f2fa6b2f24d1ba9b8bb4e41c24bea9fac4041834214d638a17bf0b7c2776fe5b
+  metadata.gz: 280e35ae08985662cc05a26c5f30ef5e9897b8d7a641a83e7a0bc8bf91a1790dbf8c36f5129ff7dface1e5eeb8d286ef43387688202b26a254a6bad860faa65d
+  data.tar.gz: f246fed35467cce900ffb7664ca62012c6d0e7bda5c2180a99814fba558331f83ab33d21a1868a0d850fa39b59eec223e39445584703f0302f339e159ce9be83

data/.github/workflows/main.yml

@@ -10,9 +10,25 @@ jobs:
         ruby: ['2.5', '2.6', '2.7', '3.0']
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: ruby/setup-ruby@v1
+      - name: repository checkout
+        uses: actions/checkout@v2
+        with:
+          submodules: true
+
+      - name: load ruby
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          bundler-cache: false
-      - run: bundle exec rake spec
+
+      - name: RubyGems, Bundler Update
+        run: gem update --system --no-document --conservative
+
+      - name: bundle install
+        run: bundle install --path .bundle/gems --without development
+
+      - name: compile
+        run: bundle exec rake compile
+
+      - name: test
+        run: bundle exec rake spec
+        timeout-minutes: 10

data/.gitignore

@@ -12,6 +12,8 @@
 *.a
 mkmf.log
 Gemfile.lock
+.envrc
+.byebug_history
 
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 ## [Unreleased]
 
-## [0.1.0] - 2021-09-21
+# [0.5.0] - 2021-09-29
+
+- Ignore all previous versions as they weren't including libbase64 (:
+
+# [0.4.0] - 2021-09-28
+
+- Detail gemspec. Ignore.
+
+## [0.3.0] - 2021-09-28
+
+- Raise error when attempting to get the base64-decoded length of an invalid (in
+  length) base64-encoded payload.
+
+## [0.2.0] - 2021-09-26
+
+- Add yard documention
+
+## [0.1.0] - 2021-09-25
 
 - Initial release

data/{LICENSE.txt → LICENSE}

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Joao Fernandes
+Copyright (c) 2021 João Fernandes
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,5 +1,9 @@
 # Ob64 gem
 
+[![Gem Version](https://badge.fury.io/rb/ob64.svg)](http://rubygems.org/gems/ob64)
+[![Build Status](https://github.com/jcmfernandes/ob64/workflows/Test/badge.svg?branch=master&event=push)](https://github.com/jcmfernandes/ob64/actions?query=workflow:Test)
+[![Yard Docs](https://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/ob64/0.5.0)
+
 A *fast* Base64 encoder and decoder as a Ruby gem.
 
 How fast? Try it yourself, execute:
@@ -39,7 +43,6 @@ require "ob64"
 
 bin1 = "This is data!"
 string = Ob64.encode(bin1)
-
 # string = "VGhpcyBpcyBkYXRhIQ=="
 
 bin2 = Ob64.decode(string)
@@ -82,7 +85,36 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/jcmfer
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Released under the MIT License. See [{file:LICENSE}](LICENSE).
+
+Copyright (c) 2021, João Fernandes
+
+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.
+
+### libbase64
+
+Released under the BSD 2-clause License. See [LICENSE](https://github.com/jcmfernandes/base64-cmake/blob/feature/cmake/LICENSE).
+
+Copyright (c) 2005-2007, Nick Galbreath  
+Copyright (c) 2013-2019, Alfred Klomp  
+Copyright (c) 2015-2017, Wojciech Mula  
+Copyright (c) 2016-2017, Matthieu Darbois  
 
 ## Code of Conduct
 

data/benchmark.rb

@@ -4,6 +4,11 @@ require "securerandom"
 require "ob64"
 require "base64"
 
+$run_encode_benchmark = true
+$run_decode_benchmark = true
+$run_urlsafe_encode_benchmark = true
+$run_urlsafe_decode_benchmark = true
+
 def to_size(bytes)
   bytes >= 2**20 ? "#{bytes / 2**20} MB" : "#{bytes / 2**10} kB"
 end
@@ -59,7 +64,7 @@ encode_benchmark do
 
     x.compare!
   end
-end
+end if $run_encode_benchmark
 
 decode_benchmark do
   Benchmark.ips do |x|
@@ -71,9 +76,43 @@ decode_benchmark do
     end
 
     x.report("ob64 .decode") do
-      Ob64.encode($encoded)
+      Ob64.decode($encoded)
     end
 
     x.compare!
   end
-end
+end if $run_decode_benchmark
+
+encode_benchmark do
+  Benchmark.ips do |x|
+    x.time = 5
+    x.warmup = 2
+
+    x.report("base64 .urlsafe_encode64") do
+      Base64.urlsafe_encode64($unencoded)
+    end
+
+    x.report("ob64 .urlsafe_encode") do
+      Ob64.urlsafe_encode($unencoded)
+    end
+
+    x.compare!
+  end
+end if $run_urlsafe_encode_benchmark
+
+decode_benchmark do
+  Benchmark.ips do |x|
+    x.time = 5
+    x.warmup = 2
+
+    x.report("base64 .urlsafe_decode64") do
+      Base64.urlsafe_decode64($encoded)
+    end
+
+    x.report("ob64 .urlsafe_decode") do
+      Ob64.urlsafe_decode($encoded)
+    end
+
+    x.compare!
+  end
+end if $run_urlsafe_decode_benchmark

data/ext/ob64/ob64_ext.c

@@ -69,13 +69,15 @@ size_t __encoded_length_of(VALUE bin, bool withPadding)
 
 size_t __decoded_length_of(VALUE string)
 {
+  char *string_ptr = StringValuePtr(string);
   size_t string_len = RSTRING_LEN(string);
-  if (string_len < 2) return 0;
-
   size_t padding = 0;
-  char* string_ptr = StringValuePtr(string);
   if (string_ptr[string_len - 1] == '=') padding++;
   if (string_ptr[string_len - 2] == '=') padding++;
 
+  if ((string_len - padding) % 4 == 1) {
+    rb_raise(rb_eArgError, "invalid base64");
+  }
+
   return (3 * (string_len - padding)) / 4;
 }

data/lib/ob64/core_ext.rb

@@ -24,4 +24,6 @@ module Ob64
 
   ::Base64.prepend(CoreExt)
   ::Base64.singleton_class.prepend(CoreExt)
+
+  private_constant :CoreExt
 end

data/lib/ob64/version.rb

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

data/lib/ob64.rb

@@ -3,20 +3,48 @@
 require_relative "ob64/version"
 require_relative "ob64_ext"
 
+# Methods for base64-encoding and -decoding strings.
 module Ob64
+  # The glue between Ruby and libbase64. See +../ext/libbase64/ob64/ob64_ext.c+.
+  module LibBase64; end
+
   include LibBase64
   extend LibBase64
 
   module_function
 
+  # Returns the Base64-encoded version of +bin+.
+  # This method complies with RFC 4648.
+  # No line feeds are added.
+  #
+  # @param bin [String]
+  # @return [String]
   def encode(bin)
     __encode(bin)
   end
 
+  # Returns the Base64-decoded version of +string+.
+  # This method complies with RFC 4648.
+  # ArgumentError is raised if +string+ is incorrectly padded or contains
+  # non-alphabet characters. Note that CR or LF are also rejected.
+  #
+  # @param string [String]
+  # @return [String]
+  # @raise [ArgumentError] if +string+ cannot be decoded
   def decode(string)
     __decode(string)
   end
 
+  # Returns the Base64-encoded version of +bin+.
+  # This method complies with ``Base 64 Encoding with URL and Filename Safe
+  # Alphabet'' in RFC 4648.
+  # The alphabet uses '-' instead of '+' and '_' instead of '/'.
+  # Note that the result can still contain '='.
+  # You can remove the padding by setting +padding+ as false.
+  #
+  # @param bin [String]
+  # @param padding [Boolean] - if the output must be padded
+  # @return [String]
   def urlsafe_encode(bin, padding: true)
     string = __encode(bin)
     string.chomp!("==") || string.chomp!("=") unless padding
@@ -24,6 +52,18 @@ module Ob64
     string
   end
 
+  # Returns the Base64-decoded version of +string+.
+  # This method complies with ``Base 64 Encoding with URL and Filename Safe
+  # Alphabet'' in RFC 4648.
+  # The alphabet uses '-' instead of '+' and '_' instead of '/'.
+  #
+  # The padding character is optional.
+  # This method accepts both correctly-padded and unpadded input.
+  # Note that it still rejects incorrectly-padded input.
+  #
+  # @param string [String]
+  # @return [String]
+  # @raise [ArgumentError] if +string+ cannot be decoded
   def urlsafe_decode(string)
     if !string.end_with?("=") && string.length % 4 != 0
       string = string.ljust((string.length + 3) & ~3, "=")
@@ -34,10 +74,22 @@ module Ob64
     __decode(string)
   end
 
+  # Returns the length of the Base64-encoded version of +bin+.
+  #
+  # @param bin [String]
+  # @param padding [Boolean] - if the Base64-encoded version of +bin+ will be padded
+  # @return [Integer]
   def encoded_length_of(bin, padding: true)
     __encoded_length_of(bin, padding)
   end
 
+  # Returns the length of the Base64-decoded version of +string+.
+  #
+  # ArgumentError is raised if +string+ has an invalid length.
+  #
+  # @param string [String]
+  # @return [Integer]
+  # @raise [ArgumentError] if +string+ has an invalid length
   def decoded_length_of(string)
     __decoded_length_of(string)
   end

data/ob64.gemspec

@@ -9,20 +9,26 @@ Gem::Specification.new do |spec|
   spec.authors = ["João Fernandes"]
   spec.email = ["joao.fernandes@ist.utl.pt"]
   spec.homepage = "https://github.com/jcmfernandes/ob64"
-
+  spec.license = "MIT"
   spec.summary = "A fast Base64 encoder and decoder."
   spec.description = "A fast Base64 encoder and decoder that makes use of SIMD extensions."
 
-  spec.license = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
-
-  spec.metadata["homepage_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 { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end + Dir.chdir(File.join(File.expand_path(__dir__), "vendor", "libbase64")) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }.map! { |f| "vendor/libbase64/#{f}" }
   end
   spec.require_paths = ["lib"]
   spec.extensions = ["ext/ob64/extconf.rb"]
+
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "changelog_uri" => spec.homepage + "/blob/master/CHANGELOG.md",
+    "documentation_uri" => "https://www.rubydoc.info/gems/ob64/#{spec.version}",
+    "source_code_uri" => spec.homepage + "/tree/v#{spec.version}"
+  }
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 end

data/vendor/libbase64/.gitignore

@@ -0,0 +1,12 @@
+*.o
+bin/base64
+lib/config.h
+test/benchmark
+test/test_base64
+
+# visual studio symbol db, etc.
+.vs/
+# build directory used by CMakePresets
+out/
+# private cmake presets
+CMakeUserPresets.json

data/vendor/libbase64/.travis.yml

@@ -0,0 +1,71 @@
+language: c
+services: docker
+
+jobs:
+  allow_failures:
+    - os: osx
+    - arch: ppc64le
+
+  include:
+    - name: linux-amd64-gcc
+      os: linux
+      arch: amd64
+      compiler: gcc
+      script: test/ci/amd64.sh
+
+    - name: linux-amd64-gcc +openmp
+      os: linux
+      arch: amd64
+      compiler: gcc
+      env: OPENMP=1 OMP_NUM_THREADS=4
+      script: test/ci/amd64.sh
+
+    - name: linux-amd64-clang
+      os: linux
+      arch: amd64
+      compiler: clang
+      script: test/ci/amd64.sh
+
+    - name: linux-arm32-gcc
+      compiler: gcc
+      script: test/ci/docker-arm32.sh
+
+    - name: linux-arm32-clang
+      compiler: clang
+      script: test/ci/docker-arm32.sh
+
+    - name: linux-powerpc-gcc
+      compiler: gcc
+      script: test/ci/docker-powerpc.sh
+
+    - name: linux-arm64-gcc
+      os: linux
+      arch: arm64
+      compiler: gcc
+      env: NEON64_CFLAGS="-march=armv8-a"
+      script: test/ci/generic.sh
+
+    - name: linux-arm64-clang
+      os: linux
+      arch: arm64
+      compiler: clang
+      env: NEON64_CFLAGS="-march=armv8-a"
+      script: test/ci/generic.sh
+
+    - name: linux-s390x-gcc
+      os: linux
+      arch: s390x
+      compiler: gcc
+      script: test/ci/generic.sh
+
+    - name: linux-ppc64le-gcc
+      os: linux
+      arch: ppc64le
+      compiler: gcc
+      script: test/ci/generic.sh
+
+    - name: osx-amd64-clang
+      os: osx
+      arch: amd64
+      compiler: clang
+      script: test/ci/amd64.sh