berkeley_library-util 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c52542412eba63da568f64ede565f97e941321d108f42e89920341df02a268b2
-  data.tar.gz: 3a56f6a5dd154c44d3d94e601f3093a8c4aca81e05fb3f7e18cd70ca6389f930
+  metadata.gz: 57ff7fc89570ad61496f1587934e40dc18752df9cd99d766f591c4fe03fcde51
+  data.tar.gz: e0bc0403c067c04801683e12de79a569721332ac23c770a05a0a0fde41842214
 SHA512:
-  metadata.gz: 0ff8d42319d6faa217bb540d7276a7dd48499a9660242a3c875496594105a16a6bd63190ea234781b8950d269548d4400cabcf87292a161eb16cf8f5a3d205b8
-  data.tar.gz: ebfbe371422bbbb59587d583409200968742511013aa49df1f2922df5c9880102c3014ebe7622a7be663cd327a5a742f69c622e8369a912929edad1cc4a0b4fe
+  metadata.gz: 6f7786f78fd64266dab9e424f61c03a95dc5a7eb294990bfef1d124699d5e0f6db7b53eaa2d3ca84c77eea1e096b11a5d227c679f5994699973b6274e3d6afe0
+  data.tar.gz: a8a61db572a00d9d0ca6d41f23d2c76490196c14a6fdd8202b88d1f924fd5f9a32ebbea0e7811a4fba2a49a6fcec4ac40242cd79dfbaec8f37deaff046650436

data/CHANGES.md

@@ -1,3 +1,10 @@
+# 0.1.4 (2022-07-20)
+
+- Adds `URIs#safe_parse_uri`, which returns `nil` for invalid URLs (unlike `URIs#uri_or_nil`, which
+  raises `URI::InvalidURIError` for non-nil, non-parseable URLs)
+- Updates documentation for `URIs#uri_or_nil` and `Validator#uri_or_nil` to clarify that
+  `nil` is an acceptable argument.
+
 # 0.1.3 (2022-05-11)
 
 - Adds `URIs#get_response`, which returns a complete `RestClient::Response` rather than just

data/lib/berkeley_library/util/module_info.rb

@@ -7,7 +7,7 @@ module BerkeleyLibrary
       SUMMARY = 'Miscellaneous Ruby utilities for the UC Berkeley Library'.freeze
       DESCRIPTION = 'A collection of miscellaneous Ruby routines for the UC Berkeley Library.'.freeze
       LICENSE = 'MIT'.freeze
-      VERSION = '0.1.3'.freeze
+      VERSION = '0.1.4'.freeze
       HOMEPAGE = 'https://github.com/BerkeleyLibrary/util'.freeze
     end
   end

data/lib/berkeley_library/util/uris/validator.rb

@@ -6,10 +6,11 @@ module BerkeleyLibrary
       module Validator
         class << self
 
-          # Returns the specified URL as a URI.
-          # @param url [String, URI] the URL.
-          # @return [URI] the URI.
-          # @raise [URI::InvalidURIError] if `url` cannot be parsed as a URI.
+          # Returns the specified URL as a URI, or `nil` if the URI is `nil`.
+          # @param url [String, URI, nil] the URL.
+          # @return [URI] the URI, or `nil`.
+          # @raise [URI::InvalidURIError] if `url` is not `nil` and cannot be
+          #   parsed as a URI.
           def uri_or_nil(url)
             return unless url
 

data/lib/berkeley_library/util/uris.rb

@@ -1,3 +1,4 @@
+require 'berkeley_library/logging'
 require 'berkeley_library/util/uris/appender'
 require 'berkeley_library/util/uris/requester'
 require 'berkeley_library/util/uris/validator'
@@ -5,6 +6,8 @@ require 'berkeley_library/util/uris/validator'
 module BerkeleyLibrary
   module Util
     module URIs
+      include BerkeleyLibrary::Logging
+
       class << self
         include URIs
       end
@@ -42,13 +45,26 @@ module BerkeleyLibrary
         Requester.get_response(uri, params: params, headers: headers)
       end
 
-      # Returns the specified URL as a URI.
-      # @param url [String, URI] the URL.
-      # @return [URI] the URI.
-      # @raise [URI::InvalidURIError] if `url` cannot be parsed as a URI.
+      # Returns the specified URL as a URI, or `nil` if the URL is `nil`.
+      # @param url [String, URI, nil] the URL.
+      # @return [URI] the URI, or `nil`.
+      # @raise [URI::InvalidURIError] if `url` is not `nil` and cannot be
+      #   parsed as a URI.
       def uri_or_nil(url)
         Validator.uri_or_nil(url)
       end
+
+      # Returns the specified URL as a URI, or `nil` if the URL cannot
+      # be parsed.
+      # @param url [Object, nil] the URL.
+      # @return [URI, nil] the URI, or `nil`.
+      def safe_parse_uri(url)
+        # noinspection RubyMismatchedArgumentType
+        uri_or_nil(url)
+      rescue URI::InvalidURIError => e
+        logger.warn("Error parsing URL #{url.inspect}", e)
+        nil
+      end
     end
   end
 end

data/spec/berkeley_library/util/uris_spec.rb

@@ -178,5 +178,37 @@ module BerkeleyLibrary::Util
         end
       end
     end
+
+    describe :safe_parse_uri do
+      it 'returns a URI unchanged' do
+        uri = URI.parse('http://example.org/')
+        expect(URIs.safe_parse_uri(uri)).to be(uri)
+      end
+
+      it 'converts a string to a URI' do
+        url = 'http://example.org/'
+        expect(URIs.safe_parse_uri(url)).to eq(URI.parse(url))
+      end
+
+      it 'returns nil for nil' do
+        expect(URIs.safe_parse_uri(nil)).to be_nil
+      end
+
+      context 'invalid URL strings' do
+        it 'returns nil' do
+          bad_url = 'not a uri'
+          expect(URIs.safe_parse_uri(bad_url)).to be_nil
+        end
+
+        it 'logs a warning' do
+          logger = instance_double(Ougai::Logger)
+          allow(BerkeleyLibrary::Logging).to receive(:logger).and_return(logger)
+
+          bad_url = 'not a uri'
+          expect(logger).to receive(:warn).with(/#{bad_url}/, kind_of(URI::InvalidURIError))
+          expect(URIs.safe_parse_uri(bad_url)).to be_nil
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: berkeley_library-util
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - David Moles
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-11 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: berkeley_library-logging