uri-ni 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eff8af7f69a76b24ce06948c53ad963d39552ec2dee0b08179496a1a8eb5d2a1
-  data.tar.gz: d7d285ac8eb47acf9acd0cd3de7dbcad6110c9e80f1860817534b18c1e25d87c
+  metadata.gz: e205294ee6b137c97fca41dfe3017b8fcfe41e28ba949002ba00167d216c3dd8
+  data.tar.gz: d81cbabc67dc1ed564d790232011119e1b3eec87044531680e6db77f2bc728a6
 SHA512:
-  metadata.gz: 4bbdf0f3d6fd23db734e13403e20d96f6e29730c43f93351556a47ab10250508b743497c02870bcb7447d643e31254686a889277e5bbf10941caef329b6b71d2
-  data.tar.gz: b777dc59e94aff9e947cfd4661b64aecc727baeae4a2c5cc14fed58c8b59fd4495bb6ae935864a2e61a8fb9dbb86098e3665475baa2c59127975d97b734f5046
+  metadata.gz: 85745faf2e879e90a233f60f937b9f55adcfcca2cb06e4871ebfab119ba98bc88517b8907baafb50412cbdd6af7342dbdadc1f0652382ad96a614cd64084b56c
+  data.tar.gz: fe3bd0a1fef2939489dc31dc463e7038f632a771f0d9feb17b72617c37bc19cfae78eb19d304b7f06f85694114ea6cafb34d0065e664147c9516bd0078cfe97e

data/lib/uri/ni/version.rb

@@ -3,7 +3,7 @@ require 'uri/generic'
 
 module URI
   class NI < Generic
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 
   # might as well put this here

data/lib/uri/ni.rb

@@ -161,8 +161,18 @@ class URI::NI < URI::Generic
   public
 
   # Compute an RFC6920 URI from a data source.
+  #
   # @param data [#to_s, IO, Digest, nil]
-  # @param algorithm [Symbol] See algorithms
+  # @param algorithm [Symbol] See available algorithms. Default: +:"sha-256"+
+  # @param blocksize [Integer] The number or bytes per call to the Digest
+  # @param authority [String, nil] Optional authority (user, host, port)
+  # @param query [String, nil] Optional query string
+  # @yield [ctx, buf] Passes the Digest and (maybe) the buffer
+  # @yieldparam ctx [Digest::Instance] The digest instance to the block
+  # @yieldparam buf [String, nil] The current read buffer (if +data+ is set)
+  # @yieldreturn [nil] The result of the block is ignored
+  # 
+  # @return [URI::NI] 
   def self.compute data = nil, algorithm: :"sha-256", blocksize: 65536,
       authority: nil, query: nil, &block
 
@@ -170,6 +180,21 @@ class URI::NI < URI::Generic
       blocksize: blocksize, authority: authority, query: query, &block
   end
 
+  # Return a Digest::Instance for a supported algorithm.
+  # @param  [#to_s, #to_sym]  The algorithm
+  # @return [Digest:Instance] The digest context
+  # @raise  [ArgumentError] if the algorithm is unrecognized
+  def self.context algorithm
+    raise ArgumentError, "Cannot coerce #{algorithm} to a symbol" unless
+      algorithm.respond_to(:to_s) # cheat: symbols respond to to_s
+    algorithm = algorithm.to_s.to_sym unless algorithm.is_a? Symbol
+    raise ArgumentError, "Unsupported digest algorithm #{algorithm}" unless
+      ctx = DIGESTS[algorithm]
+    ctx.new
+  end
+  
+  # (Re)-compute a digest using existing information from an instance.
+  # @see .compute
   def compute data = nil, algorithm: nil, blocksize: 65536,
       authority: nil, query: nil, &block
 
@@ -186,7 +211,7 @@ class URI::NI < URI::Generic
       data = nil # unset data
     else
       # make sure we're all on the same page hurr
-      self.algorithm = algorithm ||= self.algorithm
+      self.algorithm = algorithm ||= self.algorithm || :"sha-256"
       raise URI::InvalidComponentError,
         "Can't resolve a Digest context for the algorithm #{algorithm}." unless
         ctx = DIGESTS[algorithm]
@@ -288,7 +313,7 @@ class URI::NI < URI::Generic
 
   # Set the digest to the data, with an optional radix. Data may
   # either be a +Digest::Instance+—in which case the radix is
-  # ignored–a string, or +nil+. +Digest::Instance+ objects will
+  # ignored—a string, or +nil+. +Digest::Instance+ objects will
   # just be run through #compute, with all that entails.
   #
   # @param value [String, nil, Digest::Instance] The new digest

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uri-ni
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Dorian Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-06 00:00:00.000000000 Z
+date: 2020-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler