ob64 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d1111a285be1731afda3a4b3040eb9150109a6022eaea13d007004e5d51dcfe
-  data.tar.gz: e3a298f4286ac95e6656cd0ba0fdebefa1e7f180eec6f4ca0b3f7def4de64122
+  metadata.gz: 4697c65d1300ef0e6ec98cd12884ea07b3ab33a2a2b398a2a19ccb02d43d46d6
+  data.tar.gz: ce016702f7b2c43c183c43ab87974d74fe8efc56ba1e983e465f66e69f9edba2
 SHA512:
-  metadata.gz: b5992c541b3d46c846bb3e22f8e7e01aed89b8a8760ce3ca401263ebfebbd9130cfba69eacee46e288fdba44ed5319ee1086ff55e9e0b0b6791254def2577632
-  data.tar.gz: 3e77098bab5a772fdab9cf3cc0d987ee18e7a64748dd3fda9bc970cc29b15e48f2fa6b2f24d1ba9b8bb4e41c24bea9fac4041834214d638a17bf0b7c2776fe5b
+  metadata.gz: ca030510d227fac302d0dcf723bb78ff43f0e093b164293512d2fe5989fd05c43fb05c10ea5e2bbca5b3f31a8692b144979e80c956da54e03344ce5785c787a8
+  data.tar.gz: d9cf2b043bf838add8daec7ef0882ab204b23d35ce1b019a5aa614621fba5c7e83234579ba8b1d3372fd7e9f477a3a2c9af8c7b96a63f78d865a2f1a09e7fbf5

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/{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.1.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 = false
+$run_decode_benchmark = false
+$run_urlsafe_encode_benchmark = false
+$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/lib/ob64/version.rb

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

data/lib/ob64.rb

@@ -3,20 +3,45 @@
 require_relative "ob64/version"
 require_relative "ob64_ext"
 
+# Methods for base64-encoding and -decoding strings.
 module Ob64
   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 +49,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 +71,19 @@ module Ob64
     __decode(string)
   end
 
+  # Returns the length of the Base64-encoded version of +bin+.
+  #
+  # @param bin [String]
+  # @param paddding [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+.
+  #
+  # @param string [String]
+  # @return [Integer]
   def decoded_length_of(string)
     __decoded_length_of(string)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ob64
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - João Fernandes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-25 00:00:00.000000000 Z
+date: 2021-09-26 00:00:00.000000000 Z
 dependencies: []
 description: A fast Base64 encoder and decoder that makes use of SIMD extensions.
 email:
@@ -30,7 +30,7 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - benchmark.rb