multicodecs 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ae87450a3251c123d99fe7a050eaef36023d16a80c359030a366ae6b000e72d
-  data.tar.gz: 86afee1666905ea25f2e82b1b584a80a9baeb6e0faea9300eec60769090530ab
+  metadata.gz: bf3dc42c444e7e1b15dfe8fd6687e5d32956fa86b46bcabb4609733bf05ff5f3
+  data.tar.gz: ffc283a7ee473362b89cadaf90841a967c5340fcdb36047f046af120da42c432
 SHA512:
-  metadata.gz: 478732cd67ee4cb967239307a1497f56d02537798e28a0741341675278bb199e0b865d94c779cbb5544655b584a7326cacc9e7702a70f1b9086bbde84875f65e
-  data.tar.gz: 0f585a08ca3f75e07d2caf1a2fabdcc80af9582d6a0c09a4c3e51e89c5314beeb350e0b8297941304882fd766b4b473204651027b938d4dcec4a7ae8a7435b91
+  metadata.gz: 0b19f680c406fbabb5918243f6b959681d845dfe2416a334561c2c7cf059bb02c9edb58390cebba81fdb99a5d5c3385ad925d5d6380785210ba1298d8a3c79b1
+  data.tar.gz: 9b8d9da86ecf101230e4778a3c349b69f19a7856e4e04c88bc56f9c0868770118f93912059eb0d58d275c7f8e61a079b587e59134683c4ea74851f9ade5e724d

data/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  "cSpell.words": [
+    "kwargs",
+    "Multicodecs",
+    "multihash"
+  ]
+}

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.0.0
+
+- Update multicodec table
+- Implement `status` and `description`
+- Remove `Struct` usage
+
 ## 0.2.1
 
 - Fix deprecation warning in update rake task ([#3][pr-3])

data/README.md

@@ -58,20 +58,20 @@ also allows you to bring your own values.
 require 'multicodecs'
 
 Multicodecs['identity']
-# => #<struct Multicodecs::Registration code=0, name="identity", tag="multihash">
+# => 0x0 identity (multihash/permanent): raw binary
 
 Multicodecs[0x12]
-# => #<struct Multicodecs::Registration code=18, name="sha2-256", tag="multihash">
+# => 0x12 sha2-256 (multihash/permanent): (no description)
 
 Multicodecs.find_by(name: 'protobuf')
-# => #<struct Multicodecs::Registration code=80, name="protobuf", tag="serialization">
+# => 0x50 protobuf (serialization/draft): Protocol Buffers
 ```
 
 You can `register` your own values
 
 ```ruby
-Multicodecs.register(code: 0x12345, name: 'xxx', tag: 'vendor')
-# => #<struct Multicodecs::Registration code=74565, name="xxx", tag="vendor">
+Multicodecs.register(code: 0x12345, name: 'xxx', tag: 'vendor', status: 'draft', description: nil)
+# => 0x12345 xxx (vendor/draft): (no description)
 ```
 
 Convenience methods exist:
@@ -141,5 +141,3 @@ mailing lists is expected to follow the [code of conduct][git-self-coc].
 [web-coc]: http://contributor-covenant.org
 [web-mit]: https://opensource.org/licenses/MIT
 [web-rubygems]: https://rubygems.org
-
-

data/lib/multicodecs/bare.rb

@@ -8,14 +8,18 @@ module Multicodecs
 
   def load_csv(csv, radix: 16)
     csv.each do |row|
-      name  = row['name'] || row[0]
-      tag   = row['tag']  || row[1]
-      code  = row['code'] || row[2]
+      name = row['name'] || row[0]
+      tag = row['tag']  || row[1]
+      code = row['code'] || row[2]
+      status = row['status'] || row[3]
+      description = row['description'] || row[4]
 
       Multicodecs.register(
         name: name.strip,
         tag: tag.strip,
-        code: code.strip.to_i(16)
+        code: code.strip.to_i(16),
+        status: status.strip,
+        description: description&.strip
       )
     end
   end

data/lib/multicodecs/registry.rb

@@ -13,7 +13,28 @@ module Multicodecs
   REGISTRATIONS_PER_TAG = AutoHashCollection.new
   # rubocop:enable Style/MutableConstant
 
-  Registration = Struct.new(:code, :name, :tag) do
+  class Registration
+    STATUS_DRAFT = 'draft'
+    STATUS_PERMANENT = 'permanent'
+
+    attr_reader :code, :tag, :name, :status, :description
+
+    def initialize(code:, name:, tag:, status:, description:)
+      self.code = code
+      self.name = name
+      self.tag = tag
+      self.status = status
+      self.description = description
+    end
+
+    def permanent?
+      status == STATUS_PERMANENT
+    end
+
+    def draft?
+      status == STATUS_DRAFT
+    end
+
     def hash
       name.hash
     end
@@ -28,6 +49,18 @@ module Multicodecs
     def eql?(other)
       other.is_a?(Registration) && other.name == name
     end
+
+    def to_s
+      "0x#{code.to_s(16)}"
+    end
+
+    def inspect
+      "#{to_s} #{name} (#{tag}/#{status}): #{description || '(no description)'}"
+    end
+
+    private
+
+    attr_writer :code, :tag, :name, :status, :description
   end
 
   module_function
@@ -36,8 +69,8 @@ module Multicodecs
     find_by(code: entry, name: entry)
   end
 
-  def register(code:, name:, tag:)
-    Registration.new(code, name, tag).tap do |registration|
+  def register(name:, tag:, **kwargs)
+    Registration.new(name: name, tag: tag, **kwargs).tap do |registration|
       Multicodecs::REGISTRATIONS[name] = registration
       Multicodecs::REGISTRATIONS_PER_TAG[tag] << registration
     end
@@ -51,6 +84,8 @@ module Multicodecs
     end
   end
 
+  alias find_by! fetch_by!
+
   def find_by(code: nil, name: nil)
     Multicodecs::REGISTRATIONS.values.find do |v|
       v == code || v == name

data/lib/multicodecs/version.rb

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