crockford 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e80b42112ca5bce44757787938cd25743febab88aba91f79dfe442755d64237
+  data.tar.gz: 3e9ab1459f544e4d4b9b3705bebf466b8dfbb5770c3460814500f29e846c946b
+SHA512:
+  metadata.gz: 02c36e35fa698a059b9b4a6ca736c0c027c1c733890d8bc7c379b0dfdb4594c2a3afc324b75672f1373b5c1d0386c65983f3f16db640f24b7a4e2db0e26ab3b6
+  data.tar.gz: 02aa929e0fcd02bb612cf9a0735ef6fd3e67f0544feca2d3a941c387725d1f9eef67eb493909d99b747e1a76b59f8b9cb4e1f6b20f675236d58a675d1b2ef52a

data/.github/workflows/main.yml

@@ -0,0 +1,22 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+
+    strategy:
+      matrix:
+        ruby-version: [2.6.7, 2.7.3, 3.0.1]
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

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,50 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  Exclude:
+    - bin/*
+    - vendor/**/*
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/NumericLiterals:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines_except_namespace
+
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines_except_namespace
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*_spec.rb"
+
+Metrics/MethodLength:
+  Max: 20
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/DescribedClass:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-05-05
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at iain@iain.nl. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in crockford.gemspec
+gemspec
+
+gem "pry"
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    crockford (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.14.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.5.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.3.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  crockford!
+  pry
+  rake
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+
+BUNDLED WITH
+   2.2.16

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Iain Hecker
+
+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,121 @@
+# Crockford
+
+Douglas Crockford has described an alternate version of Base32. This is **NOT** [RFC 4648](https://tools.ietf.org/html/rfc4648).
+
+It excludes the letters `I`, `L`, and `O`, to avoid confusion with digits. It
+also excludes the letter `U` to reduce the likelihood of accidental obscenity.
+
+Instead of rejecting the characters it excludes, it normalizes them. This means
+that if somebody mistook a `0` for a `O`, we correct it instead of rejecting it.
+This makes it great for cases where a person needs to type in the code by hand,
+like a serial number, or a token sent via SMS.
+
+For more information, see [Douglas Crockford's own website](https://www.crockford.com/base32.html).
+
+
+Note: Crockford's Base32 also allows for a checksum character. This
+functionality has not been implemented yet.
+
+## Requirements
+
+The encoding scheme is required to
+
+* Be human readable and machine readable.
+* Be compact. Humans have difficulty in manipulating long strings of arbitrary symbols.
+* Be error resistant. Entering the symbols must not require keyboarding gymnastics.
+* Be pronounceable. Humans should be able to accurately transmit the symbols to other humans using a telephone.
+
+## Usage
+
+Encoding and decoding numbers:
+
+```ruby
+Crockford.encode_number(1234) # => "16J"
+Crockford.decode_number("16J") # => 1234
+```
+
+You can split up longer codes with hyphens. Hyphens are ignored when decoding:
+
+```ruby
+Crockford.encode_number(1234567890, split: 4) # => "14S-C0PJ"
+Crockford.decode_number("14S-C0-PJ") # => 1234567890
+```
+
+Codes are automatically normalized (unknown characters will turn into `?`):
+
+```ruby
+Crockford.decode_number("oil") # => 33
+Crockford.decode_number("011") # => 33
+Crockford.normalize("oil") # => "011"
+Crockford.normalize("wrong@") # => "WR0NG?"
+Crockford.normalize("wrong@", unknown: "_") # => "WR0NG_"
+```
+
+You can encode and decode any string (or any raw bytes):
+
+```ruby
+data = SecureRandom.bytes(10) # => "\x06\x9D\xA5\xC1\x9C8\xA9W\xE9^"
+code = Crockford.encode_string(data, split: 4) # => "TET-BGCW-72MN-FTAY"
+Crockford.decode_string(code) == data # => true
+```
+
+Generate a code:
+
+```ruby
+Crockford.generate(length: 16, split: 4) # => "H222-WEQ8-RHE3-P707"
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'crockford'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install crockford
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake` 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 the created tag, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/iain/crockford. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [code of conduct](https://github.com/iain/crockford/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Crockford project's codebases, issue
+trackers, chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/iain/crockford/blob/main/CODE_OF_CONDUCT.md).
+
+## Prior art
+
+Some of these haven't been updated in over a decade:
+
+* [base32-crockford](https://rubygems.org/gems/base32-crockford)
+* [base32-multi](https://rubygems.org/gems/base32-multi)
+* [base32-url](https://rubygems.org/gems/base32-url)
+* [base32-alphabets](https://rubygems.org/gems/base32-alphabets)

data/Rakefile

@@ -0,0 +1,11 @@
+# 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/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "crockford"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/crockford.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/crockford/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "crockford"
+  spec.version = Crockford::VERSION
+  spec.authors = ["iain"]
+  spec.email = ["iain@iain.nl"]
+
+  spec.summary = "Crockford's Base32"
+  spec.description = "Crockford's Base32"
+  spec.homepage = "https://github.com/iain/crockford"
+  spec.license = "MIT"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = File.join(spec.homepage, "blob/HEAD/CHANGELOG.md")
+  spec.metadata["bug_tracker_uri"] = File.join(spec.homepage, "issues")
+
+  # 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
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/crockford.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative "crockford/version"
+
+# Encodes and decodes Crockford's Base32 variation.
+module Crockford
+
+  ENCODER = %w[0 1 2 3 4 5 6 7 8 9 A B C D E F G H J K M N P Q R S T V W X Y Z].freeze
+  DECODER = ENCODER.each_with_index.to_h.transform_keys(&:to_s).merge({ "I" => 1, "L" => 1, "O" => 0 }).freeze
+
+  class << self
+
+    def encode_number(number, **kwargs)
+      string = number.to_s(2).each_char.reverse_each.each_slice(5).map do |bits|
+        ENCODER[bits.reverse.join.to_i(2)]
+      end.reverse.join
+
+      format_code(string, **kwargs)
+    end
+
+    def decode_number(string)
+      clean_code(string).each_char.inject(0) do |result, char|
+        val = DECODER[char]
+        return nil if val.nil?
+
+        (result << 5) + val
+      end
+    end
+
+    def encode_string(string, **kwargs)
+      number = string.bytes.map { |byte| format("%08b", byte) }.join.to_i(2)
+      encode_number(number, **kwargs)
+    end
+
+    def decode_string(string)
+      number = decode_number(string)
+      return nil if number.nil?
+
+      number.to_s(2).each_char.reverse_each.each_slice(8).map do |byte|
+        byte.reverse.join.to_i(2)
+      end.reverse.pack("C*")
+    end
+
+    def normalize(string, unknown: "?", **kwargs)
+      string = clean_code(string).each_char.inject("") do |memo, char|
+        memo + ((index = DECODER[char]) ? ENCODER[index] : unknown)
+      end
+      format_code(string, **kwargs)
+    end
+
+    def valid?(string)
+      !decode_number(string).nil?
+    end
+
+    def generate(length:, split: false)
+      encode_number(SecureRandom.random_number(32**length), split: split, length: length)
+    end
+
+    private
+
+    def clean_code(string)
+      string.delete("-").upcase
+    end
+
+    def format_code(string, length: nil, split: false)
+      string = string.rjust(length, "0") if length
+
+      if split
+        string = string
+          .each_char
+          .reverse_each
+          .each_slice(split)
+          .map { |segment| segment.reverse.join }
+          .reverse
+          .join("-")
+      end
+
+      string
+    end
+
+  end
+
+end

data/lib/crockford/version.rb

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

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: crockford
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- iain
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-05-05 00:00:00.000000000 Z
+dependencies: []
+description: Crockford's Base32
+email:
+- iain@iain.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- crockford.gemspec
+- lib/crockford.rb
+- lib/crockford/version.rb
+homepage: https://github.com/iain/crockford
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/iain/crockford
+  source_code_uri: https://github.com/iain/crockford
+  changelog_uri: https://github.com/iain/crockford/blob/HEAD/CHANGELOG.md
+  bug_tracker_uri: https://github.com/iain/crockford/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.16
+signing_key:
+specification_version: 4
+summary: Crockford's Base32
+test_files: []