multicodecs 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cbc0820c14127379a2a107103b88cfa5201c3f22d3942adcf35f5f0a1cb22ae
-  data.tar.gz: 59245217741f176d4b6c07095efa14bf1abf02dae2ef1b0accbe230611512b1a
+  metadata.gz: c00bbb236838d2e04b43906e147ba2c3572ccec437c4c50b58c74446a04a6c08
+  data.tar.gz: f6a5ecbb16cdf71dba833efe72b9f1b53585f590f56d1ad5b09ab6ac03939189
 SHA512:
-  metadata.gz: c2bbbd3a0b3c79d2a1e5281142b3366b55156da6fb300869253366e1a35d37914462dacb74c66da6847c993dfa6816aeb86d8d54040d337f43aa1e1d22f68c31
-  data.tar.gz: c9c3fc2b00c4cc40a23d1151454fe15235b8bedd0aaccecc3dc002071b3ce79fdba37b2331e9cfd92aedfa86a31f014b144ef5fe518543eddc2eeac3bb0e7a9e
+  metadata.gz: 226df7a1dcb3ab951fe86c15f13cb532619602c735455b5a0ee9902b7574e28baea8df7cb312efc3db03fea272a0d32444e87d460dccaa1867b84a00f4c93dcd
+  data.tar.gz: e61b4b1d0a58fe12145adc89787cc893e5508244f47ad8212c61b5c158fa0a9bdb543db150f2a046c191c0f4faed7f334844092d61ad4c309af0d4e14423d438

data/Gemfile

@@ -1,4 +1,4 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in multicodecs.gemspec
 gemspec

data/README.md

@@ -1,19 +1,25 @@
 # Multicodecs
 
-[![Build Status](https://travis-ci.com/SleeplessByte/ruby-multicodec.svg?token=FpDLv4Yva15pzqYpq9Hk&branch=master)][shield-link-travis]
+[![Build Status](https://travis-ci.com/SleeplessByte/ruby-multicodec.svg?branch=master)][shield-link-travis]
 [![Gem Version](https://badge.fury.io/rb/multicodecs.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/-/maintainability)][shield-link-codeclimate]
+[![Maintainability](https://api.codeclimate.com/v1/badges/e5b0e892f0c098edd78c/maintainability)][shield-link-codeclimate]
 
 [shield-link-travis]: https://travis-ci.com/SleeplessByte/ruby-multicodec
 [shield-link-gem]: https://badge.fury.io/rb/multicodecs
 [shield-link-license]: http://opensource.org/licenses/MIT
-[shield-link-codeclimate]: https://codeclimate.com/repos/-/maintainability
+[shield-link-codeclimate]: https://codeclimate.com/github/SleeplessByte/ruby-multicodec/maintainability
 
 > Canonical table of of codecs used by various multiformats
 
 `Multicodecs` is the ruby implementation of [multiformats/multicodec][spec].
 
+> 🙌🏽 This is called `multicodecs` instead of the singular form, to stay
+> consistent with the `multihashes` gem, which was _forced_ to take a different
+> name has `multihash` was already taken, which is also the case for `multibase`
+> and others. In the future, this might be renamed to `multiformats-codec`, with
+> a backwards-compatible interface.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -79,6 +85,7 @@ Convenience methods exist:
 ## Related
 
 - [`multiformats/multicodec`][git-multicodec]: the spec repository
+- [`multiformats/ruby-multiaddr`][git-ruby-multiaddr]: the ruby implementation of [`multiformats/multiaddr`][git-multiaddr]
 - [`multiformats/ruby-multibase`][git-ruby-multibase]: the ruby implementation of [`multiformats/multibase`][git-multibase]
 - [`multiformats/ruby-multihash`][git-ruby-multihash]: the ruby implementation of [`multiformats/multihash`][git-multihash]
 
@@ -116,13 +123,14 @@ The gem is available as open source under the terms of the [MIT License][web-mit
 
 ## Code of Conduct
 
-Everyone interacting in the Shrine::ConfigurableStorage project’s codebases,
-issue trackers, chat rooms and mailing lists is expected to follow the
-[code of conduct][git-self-coc].
+Everyone interacting in this project’s codebases, issue trackers, chat rooms and
+mailing lists is expected to follow the [code of conduct][git-self-coc].
 
 [spec]: https://github.com/multiformats/multicodec
 [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-multiaddr]: https://github.com/SleeplessByte/ruby-multiaddr
+[git-multiaddr]: https://github.com/multiformats/multiaddr
 [git-ruby-multicodec]: https://github.com/SleeplessByte/ruby-multicodec
 [git-multicodec-table]: https://github.com/multiformats/multicodec/blob/master/multicodec.csv
 [git-multicodec]:  https://github.com/multiformats/multicodec

data/Rakefile

@@ -1,10 +1,10 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
 Rake::Task.define_task(:update) do |t|
@@ -12,8 +12,8 @@ Rake::Task.define_task(:update) do |t|
 
   SOURCE_FILE = 'https://raw.githubusercontent.com/multiformats/multicodec/master/table.csv'
 
-  File.open(File.join(__dir__, 'lib', 'table.csv'), "wb") do |saved_file|
-    open(SOURCE_FILE, "rb") do |read_file|
+  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

data/bin/console

@@ -1,14 +1,15 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "multicodecs"
+require 'bundler/setup'
+require 'multicodecs'
 
 # 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"
+# require 'pry'
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/multicodecs/bare.rb

@@ -9,10 +9,14 @@ module Multicodecs
   def load_csv(csv, radix: 16)
     csv.each do |row|
       name  = row['name'] || row[0]
-      tag   = row['tag'] || row[1]
+      tag   = row['tag']  || row[1]
       code  = row['code'] || row[2]
 
-      Multicodecs.register(name: name.strip, tag: tag.strip, code: code.strip.to_i(16))
+      Multicodecs.register(
+        name: name.strip,
+        tag: tag.strip,
+        code: code.strip.to_i(16)
+      )
     end
   end
 end

data/lib/multicodecs/registry.rb

@@ -1,8 +1,16 @@
 # frozen_string_literal: true
 
 module Multicodecs
+  class AutoHashCollection < Hash
+    def [](key)
+      self[key] = [] unless key?(key)
+      super
+    end
+  end
+
   # rubocop:disable Style/MutableConstant
   REGISTRATIONS = {}
+  REGISTRATIONS_PER_TAG = AutoHashCollection.new
   # rubocop:enable Style/MutableConstant
 
   Registration = Struct.new(:code, :name, :tag) do
@@ -29,11 +37,10 @@ module Multicodecs
   end
 
   def register(code:, name:, tag:)
-    Multicodecs::REGISTRATIONS[name] = Registration.new(
-      code,
-      name,
-      tag
-    )
+    Registration.new(code, name, tag).tap do |registration|
+      Multicodecs::REGISTRATIONS[name] = registration
+      Multicodecs::REGISTRATIONS_PER_TAG[tag] << registration
+    end
   end
 
   def fetch_by!(code: nil, name: nil)
@@ -57,4 +64,22 @@ module Multicodecs
   def names
     Multicodecs::REGISTRATIONS.keys
   end
+
+  def tags
+    Multicodecs::REGISTRATIONS_PER_TAG.keys
+  end
+
+  def where(tag:)
+    Multicodecs::REGISTRATIONS_PER_TAG[tag]
+  end
+
+  def each(tag: nil)
+    arr = tag.nil? ? Multicodecs::REGISTRATIONS.values : Multicodecs.where(tag: tag)
+
+    if block_given?
+      return arr.each { |registration| yield registration }
+    end
+
+    arr.each
+  end
 end

data/lib/multicodecs/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multicodecs
 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-20 00:00:00.000000000 Z
+date: 2019-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler