bs62 0.1.0-x86_64-linux

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2c2de37c90f4905bb4e516c2008489d63876ac08d4bfc9440330f73290c08b1c
+  data.tar.gz: aee4f1d384c39c7226339a236cdf7acc3b66a53cf7e124ff36493ce69304e791
+SHA512:
+  metadata.gz: 14ebd675478c42504bdaab04467813f4c5cf879b0152263748a43f245b96ac2ebf896cb8d64b67e5c0d0b3fcd3258bc34804ed26d863f3ba6b843e928ace1608
+  data.tar.gz: 0b99228ec48dbb84c2509201219538e658a928374f8965b75444d5449fe72c92f809f2de1baed66dcfef433e1ae70af2920e79e2cd532ebbb1139a892d2713d3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Garen J. Torikian
+
+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,50 @@
+# Bs62
+
+Quick and easy Base62 encoder and decoder. The difference between this gem and many others is that it operates on an
+array of bytes.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add bs62
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install bs62
+
+## Usage
+
+Call `encode` to encode an array of bytes into Base62:
+
+```ruby
+require "bs62"
+
+bytes = SecureRandom.hex(4).bytes # [99, 56, 97, 54, 57, 101, 54, 97]
+
+Bs62.encode(bytes) # "jY45tzXOpUU"
+```
+
+Similarly, call `decode` to convert a Base62 string to an array of bytes:
+
+```ruby
+require "bs62"
+
+str = "jY45tzXOpUU"
+
+Bs62.decode(str) # [99, 56, 97, 54, 57, 101, 54, 97]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake compile test` 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 merge that change into `main`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gjtorikian/bs62.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/bs62/extension.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+begin
+  # native precompiled gems package shared libraries in <gem_dir>/lib/bs62/<ruby_version>
+  # load the precompiled extension file
+  ruby_version = /\d+\.\d+/.match(RUBY_VERSION)
+  require_relative "#{ruby_version}/bs62"
+rescue LoadError
+  # fall back to the extension compiled upon installation.
+  # use "require" instead of "require_relative" because non-native gems will place C extension files
+  # in Gem::BasicSpecification#extension_dir after compilation (during normal installation), which
+  # is in $LOAD_PATH but not necessarily relative to this file (see nokogiri#2300)
+  require "bs62/bs62"
+end

data/lib/bs62/version.rb

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

data/lib/bs62.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "bs62/extension"
+
+require "bs62/version"
+
+if ENV.fetch("DEBUG", false)
+  require "amazing_print"
+  require "debug"
+end
+
+class Bs62
+  class << self
+    def encode(bytes)
+      raise TypeError, "argument must be an array of bytes; got a #{bytes.class}!" unless bytes.is_a?(Array)
+
+      Bs62.perform_encode(bytes)
+    end
+
+    def decode(str)
+      raise TypeError, "argument must be a String; got a #{str.class}!" unless str.is_a?(String)
+
+      Bs62.perform_decode(str)
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: bs62
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: x86_64-linux
+authors:
+- Garen J. Torikian
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Base62 encoding and decoding with a focus on simplicity and performance.
+  Currently wraps the bs62 Rust crate.
+email:
+- gjtorikian@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/bs62.rb
+- lib/bs62/3.1/bs62.so
+- lib/bs62/3.2/bs62.so
+- lib/bs62/extension.rb
+- lib/bs62/version.rb
+homepage: https://github.com/gjtorikian/bs62
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  funding_uri: https://github.com/sponsors/gjtorikian/
+  source_code_uri: https://github.com/gjtorikian/bs62
+  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'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.3.dev
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.22
+requirements: []
+rubygems_version: 3.4.4
+signing_key: 
+specification_version: 4
+summary: Fast and lightweight Base62 encoder/decoder. Written in Rust, wrapped in
+  Ruby.
+test_files: []