multibases 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57c641bb941bf22ba1e15624ec2f798ccfdbda9c349f8abaa18bc6ef39275008
-  data.tar.gz: 5dd0cbd27ac8ee91362505fa0ab64b021856109ce61ca8d1815242d21a2f347e
+  metadata.gz: e2b0dd76dacf9936bc730a2568740868ffd7da45d0d341bfbde1e7884ccfd162
+  data.tar.gz: b494e77003851e5cc216a163d2b75ef443a05609789de4f4070ed3fa2cc3d3cb
 SHA512:
-  metadata.gz: 4ebd6b9d19633242cf696170912d7897c2ebc40321b92a3f717d918d1adad0d65ab2cbd9c50dca09497917221236c6110ffcf65f2be93fa690b6df9c658018d6
-  data.tar.gz: 59e4ddce0a22b82771c695e7f50e9da0653af855cd09e6be53329539a0115ac85329606ce15ff03ca28c0eb1cf07fbda45c4005975cbaf633c84d4763d729b74
+  metadata.gz: 2c15a0d0e856d94c6edf60c2e2a83d722c2c67527cd1c07b28bb917cb5e73572e834d3662352c3b0afe895e0109fb11d3848194a66477ca28565dabaa99ef925
+  data.tar.gz: 61b9616e4627224d15d76f04c75e621f16059de0128cd2a4f4a7b49cf62513200ef5c418495526b2cb65eebb1fc271cdb27620156c0ce388fa4a550972be4d38

data/.gitignore

@@ -1,9 +1,9 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-Gemfile.lock
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 0.2.0
+
+- Add convenience methods to registry, like `multicodecs`
+- Change tests to use fixture files and add `rake` task to update these
+
+## 0.1.0
+
+:baby: intial release

data/README.md

@@ -1,9 +1,14 @@
 # Multibases
 
-[![Build Status: master](https://travis-ci.com/SleeplessByte/ruby-multibase.svg?branch=master)](https://travis-ci.com/SleeplessByte/ruby-multibase)
-[![Gem Version](https://badge.fury.io/rb/ruby-multibase.svg)](https://badge.fury.io/rb/ruby-multibase)
-[![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
-[![Maintainability](https://api.codeclimate.com/v1/badges/1e5600a4be90eec063e0/maintainability)](https://codeclimate.com/repos/5d094b036bd112014f005f98/maintainability)
+[![Build Status](https://travis-ci.com/SleeplessByte/ruby-multibase.svg?branch=master)][shield-link-travis]
+[![Gem Version](https://badge.fury.io/rb/multibases.svg)][shield-link-gem]
+[![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)][shield-link-license]
+[![Maintainability](https://api.codeclimate.com/v1/badges/1253cc22b664d27d4052/maintainability)][shield-link-codeclimate]
+
+[shield-link-travis]: https://travis-ci.com/SleeplessByte/ruby-multibase
+[shield-link-gem]: https://badge.fury.io/rb/multibases
+[shield-link-license]: http://opensource.org/licenses/MIT
+[shield-link-codeclimate]: https://codeclimate.com/github/SleeplessByte/ruby-multibase/maintainability
 
 > Multibase is a protocol for disambiguating the encoding of base-encoded
 > (e.g., base32, base64, base58, etc.) binary appearing in text.
@@ -283,6 +288,7 @@ expected == Multibases::Base16.encode(Multibases::ByteArray.new("abc".bytes))
 ## Related
 
 - [`multiformats/multibase`][git-multibase]: the spec repository
+- [`multiformats/ruby-multicodec`][git-ruby-multicodec]: the ruby implementation of [`multiformats/multicodec`][git-multicodec]
 - [`multiformats/ruby-multihash`][git-ruby-multihash]: the ruby implementation of [`multiformats/multihash`][git-multihash]
 
 ## Development
@@ -298,7 +304,7 @@ push git commits and tags, and push the `.gem` file to [rubygems.org][web-rubyge
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at [SleeplessByte/commmand][git-self].
+Bug reports and pull requests are welcome on GitHub at [SleeplessByte/ruby-multibase][git-self].
 This project is intended to be a safe, welcoming space for collaboration, and
 contributors are expected to adhere to the [Contributor Covenant][web-coc] code
 of conduct.
@@ -316,6 +322,8 @@ issue trackers, chat rooms and mailing lists is expected to follow the
 [spec]: https://github.com/multiformats/multibase
 [git-self-coc]: https://github.com/SleeplessByte/ruby-multibase/blob/master/CODE_OF_CONDUCT.md
 [git-self]: https://github.com/SleeplessByte/ruby-multibase
+[git-ruby-multicodec]: https://github.com/SleeplessByte/ruby-multicodec
+[git-multicodec]:  https://github.com/multiformats/multicodec
 [git-multibase]:  https://github.com/multiformats/multibase
 [git-multibase-table]: https://github.com/multiformats/multibase/blob/master/multibase.csv
 [git-ruby-multihash]: https://github.com/multiformats/ruby-multihash

data/Rakefile

@@ -9,4 +9,25 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
+Rake::Task.define_task(:update) do |t|
+  require 'open-uri'
+
+  SOURCE_FILE = 'https://raw.githubusercontent.com/multiformats/multibase/master/multibase.csv'
+  SPEC_FILE_FORMAT = 'https://raw.githubusercontent.com/multiformats/multibase/master/tests/test%<index>d.csv'
+
+  File.open(File.join(__dir__, 'lib', 'table.csv'), "wb") do |saved_file|
+    open(SOURCE_FILE, "rb") do |read_file|
+      saved_file.write(read_file.read)
+    end
+  end
+
+  (1..6).each do |index|
+    File.open(File.join(__dir__, 'test', 'fixtures', format('test%<index>s.csv', index: index)), "wb") do |saved_file|
+      open(format(SPEC_FILE_FORMAT, index: index), "rb") do |read_file|
+        saved_file.write(read_file.read)
+      end
+    end
+  end
+end
+
 task :default => :test

data/bin/setup

@@ -1,8 +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
+#!/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/lib/multibases/registry.rb

@@ -23,6 +23,10 @@ module Multibases
 
   module_function
 
+  def [](entry)
+    find_by(code: entry, encoding: entry)
+  end
+
   def implement(encoding, code, implementation = nil, alphabet = nil)
     Multibases::IMPLEMENTATIONS[encoding] = Registration.new(
       code,
@@ -45,6 +49,14 @@ module Multibases
     end
   end
 
+  def codes
+    Multicodecs::REGISTRATIONS.values.map(&:code)
+  end
+
+  def names
+    Multicodecs::REGISTRATIONS.keys
+  end
+
   def multibase_version(multibase_semver = nil)
     return @multibase_version if multibase_semver.nil?
 

data/lib/multibases/version.rb

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

data/lib/multibases.rb

@@ -11,8 +11,6 @@ require 'multibases/base32'
 require 'multibases/base64'
 
 module Multibases
-  class Error < StandardError; end
-
   # https://github.com/multiformats/multibase#multibase-table-v100-rc-semver
   multibase_version '1.0.0'
 

data/lib/table.csv

@@ -0,0 +1,23 @@
+encoding,           code, description
+identity,           0x00, 8-bit binary (encoder and decoder keeps data unmodified)
+base1,              1,    unary (11111)
+base2,              0,    binary (01010101)
+base8,              7,    octal
+base10,             9,    decimal
+base16,             f,    hexadecimal
+base16upper,        F,    hexadecimal
+base32hex,          v,    rfc4648 no padding - highest char
+base32hexupper,     V,    rfc4648 no padding - highest char
+base32hexpad,       t,    rfc4648 with padding
+base32hexpadupper,  T,    rfc4648 with padding
+base32,             b,    rfc4648 no padding
+base32upper,        B,    rfc4648 no padding
+base32pad,          c,    rfc4648 with padding
+base32padupper,     C,    rfc4648 with padding
+base32z,            h,    z-base-32 (used by Tahoe-LAFS)
+base58flickr,       Z,    base58 flicker
+base58btc,          z,    base58 bitcoin
+base64,             m,    rfc4648 no padding
+base64pad,          M,    rfc4648 with padding - MIME encoding
+base64url,          u,    rfc4648 no padding
+base64urlpad,       U,    rfc4648 with padding

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multibases
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Derk-Jan Karrenbeld
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-19 00:00:00.000000000 Z
+date: 2019-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,6 +67,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -83,6 +84,7 @@ files:
 - lib/multibases/ord_table.rb
 - lib/multibases/registry.rb
 - lib/multibases/version.rb
+- lib/table.csv
 - multibases.gemspec
 homepage: https://github.com/SleeplessByte/ruby-multibase
 licenses: []
@@ -105,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby implementation of the multibase specification