RubyGems - berkeley_library-util - Versions diffs - 0.1.0 → 0.1.3 - Mend

berkeley_library-util 0.1.0 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (15) hide show

checksums.yaml +4 -4
data/.idea/inspectionProfiles/Project_Default.xml +4 -0
data/.idea/util.iml +39 -36
data/CHANGES.md +15 -1
data/README.md +7 -3
data/lib/berkeley_library/util/files.rb +37 -0
data/lib/berkeley_library/util/module_info.rb +2 -4
data/lib/berkeley_library/util/paths.rb +8 -0
data/lib/berkeley_library/util/uris/appender.rb +2 -1
data/lib/berkeley_library/util/uris/requester.rb +23 -3
data/lib/berkeley_library/util/uris.rb +10 -0
data/spec/berkeley_library/util/files_spec.rb +115 -0
data/spec/berkeley_library/util/uris/requester_spec.rb +8 -11
data/spec/berkeley_library/util/uris_spec.rb +59 -10
metadata +5 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab2d3fd2a0a839a3d733b0280ebff5b9b260b4cec4c2b06c6bdbe065d1b25871
-  data.tar.gz: dcd700d56670c53e894e59239b9b90ab740d9761f7c80e67340428d357c290d1
+  metadata.gz: c52542412eba63da568f64ede565f97e941321d108f42e89920341df02a268b2
+  data.tar.gz: 3a56f6a5dd154c44d3d94e601f3093a8c4aca81e05fb3f7e18cd70ca6389f930
 SHA512:
-  metadata.gz: 662ad15a9f80a79a379d70aa7fb4672b2f6e7adf3232796b6e814d238cb984ee8ebbc8e481d188d9fa92316929eb9e826a569eb5ccf6eb5892d96e6f0fa37d60
-  data.tar.gz: 3bee84460660635c47f88102b0dc554ae0d5120089541d5733a45e785ab0ac8cfd56269beecf1d324b6174a594ab68b8133f4bc2a66db75d31d928c2c7390101
+  metadata.gz: 0ff8d42319d6faa217bb540d7276a7dd48499a9660242a3c875496594105a16a6bd63190ea234781b8950d269548d4400cabcf87292a161eb16cf8f5a3d205b8
+  data.tar.gz: ebfbe371422bbbb59587d583409200968742511013aa49df1f2922df5c9880102c3014ebe7622a7be663cd327a5a742f69c622e8369a912929edad1cc4a0b4fe

data/.idea/inspectionProfiles/Project_Default.xml CHANGED Viewed

@@ -11,6 +11,10 @@
     <inspection_tool class="PyUnresolvedReferencesInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
     <inspection_tool class="Rubocop" enabled="false" level="WARNING" enabled_by_default="false" />
     <inspection_tool class="RubyCaseWithoutElseBlockInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="RubyMismatchedReturnType" enabled="true" level="WARNING" enabled_by_default="true">
+      <option name="myCheckNilability" value="false" />
+    </inspection_tool>
+    <inspection_tool class="RubyNilAnalysis" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
     <inspection_tool class="RubyStringKeysInHashInspection" enabled="true" level="INFORMATION" enabled_by_default="true" />
     <inspection_tool class="SpellCheckingInspection" enabled="false" level="TYPO" enabled_by_default="false">
       <option name="processCode" value="true" />

data/.idea/util.iml CHANGED Viewed

@@ -1,28 +1,31 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
   <component name="NewModuleRootManager" inherit-compiler-output="true">
     <exclude-output />
     <content url="file://$MODULE_DIR$" />
     <orderEntry type="jdk" jdkName="RVM: ruby-2.7.4" jdkType="RUBY_SDK" />
     <orderEntry type="sourceFolder" forTests="false" />
-    <orderEntry type="library" scope="PROVIDED" name="actionpack (v6.1.4.1, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="actionview (v6.1.4.1, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="activesupport (v6.1.4.1, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="actionpack (v7.0.2.4, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="actionview (v7.0.2.4, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="activesupport (v7.0.2.4, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="addressable (v2.8.0, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="amazing_print (v1.3.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="amazing_print (v1.4.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ast (v2.4.2, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="berkeley_library-logging (v0.2.3, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="berkeley_library-logging (v0.2.6, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="builder (v3.2.4, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="bundle-audit (v0.1.0, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.2.14, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.2.31, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="bundler-audit (v0.9.0.1, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ci_reporter (v2.0.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ci_reporter_rspec (v1.0.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="colorize (v0.8.1, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="concurrent-ruby (v1.1.9, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="concurrent-ruby (v1.1.10, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="crack (v0.4.5, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="crass (v1.0.6, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.4.4, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.5.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="docile (v1.4.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="domain_name (v0.5.20190701, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="dotenv (v2.7.6, RVM: ruby-2.7.4) [gem]" level="application" />
@@ -30,55 +33,55 @@
     <orderEntry type="library" scope="PROVIDED" name="hashdiff (v1.0.1, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="http-accept (v1.7.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="http-cookie (v1.0.4, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="i18n (v1.8.10, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="lograge (v0.11.2, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="loofah (v2.12.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="i18n (v1.10.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="lograge (v0.12.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="loofah (v2.17.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="method_source (v1.0.0, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="mime-types (v3.3.1, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="mime-types-data (v3.2021.0901, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="minitest (v5.14.4, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="mime-types (v3.4.1, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="mime-types-data (v3.2022.0105, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="minitest (v5.15.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="netrc (v0.11.0, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="nokogiri (v1.12.4, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="oj (v3.13.7, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="nokogiri (v1.13.5, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="oj (v3.13.11, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ougai (v1.9.1, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="parallel (v1.21.0, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="parser (v3.0.2.0, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="public_suffix (v4.0.6, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="racc (v1.5.2, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parallel (v1.22.1, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parser (v3.1.2.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="public_suffix (v4.0.7, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="racc (v1.6.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rack (v2.2.3, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rack-test (v1.1.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rails-dom-testing (v2.0.3, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rails-html-sanitizer (v1.4.2, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="railties (v6.1.4.1, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rainbow (v3.0.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="railties (v7.0.2.4, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rainbow (v3.1.1, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rake (v13.0.6, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="regexp_parser (v2.1.1, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="request_store (v1.5.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="regexp_parser (v2.3.1, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="request_store (v1.5.1, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rest-client (v2.1.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rexml (v3.2.5, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec (v3.10.0, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.10.1, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.10.1, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.10.2, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.10.2, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec (v3.11.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.11.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.11.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.11.1, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.11.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rubocop (v1.11.0, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rubocop-ast (v1.11.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop-ast (v1.17.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rubocop-rake (v0.6.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rubocop-rspec (v2.4.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ruby-prof (v0.17.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ruby-progressbar (v1.11.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="simplecov (v0.21.2, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="simplecov-html (v0.12.3, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="simplecov-rcov (v0.2.3, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="simplecov_json_formatter (v0.1.3, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="thor (v1.1.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="simplecov-rcov (v0.3.1, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="simplecov_json_formatter (v0.1.4, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="thor (v1.2.1, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="typesafe_enum (v0.3.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="tzinfo (v2.0.4, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="unf (v0.1.4, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="unf_ext (v0.0.8, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="unf_ext (v0.0.8.1, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="unicode-display_width (v2.1.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="webmock (v3.14.0, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="zeitwerk (v2.4.2, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="zeitwerk (v2.5.4, RVM: ruby-2.7.4) [gem]" level="application" />
   </component>
   <component name="RModuleSettingsStorage">
     <LOAD_PATH number="2" string0="$MODULE_DIR$/lib" string1="$MODULE_DIR$/spec" />
@@ -95,7 +98,7 @@
           </RakeTaskImpl>
           <RakeTaskImpl description="Run all specs in spec directory, with coverage" fullCommand="coverage" id="coverage" />
           <RakeTaskImpl description="Run tests, check test coverage, check code style, check for vulnerabilities, build gem" fullCommand="default" id="default" />
-          <RakeTaskImpl description="Build berkeley_library-util.gemspec as berkeley_library-util-0.1.0.gem" fullCommand="gem" id="gem" />
+          <RakeTaskImpl description="Build berkeley_library-util.gemspec as berkeley_library-util-0.1.1.gem" fullCommand="gem" id="gem" />
           <RakeTaskImpl description="Run RuboCop with auto-correct, and output results to console" fullCommand="ra" id="ra" />
           <RakeTaskImpl description="Run rubocop with HTML output" fullCommand="rubocop" id="rubocop" />
           <RakeTaskImpl id="rubocop">

data/CHANGES.md CHANGED Viewed

@@ -1,3 +1,17 @@
+# 0.1.3 (2022-05-11)
+- Adds `URIs#get_response`, which returns a complete `RestClient::Response` rather than just
+  the response body.
+# 0.1.2 (2022-05-05)
+- Adds `BerkeleyLibrary::Files`, which contains file and IO utility methods
+# 0.1.1 (2021-09-23)
+- `URIs#append` now handles bare URLs with empty paths, with the caveat that
+  a root path `/` will always be added, even if there are no path elements to append.
 # 0.1.0 (2021-09-23)
-Initial extraction of code from [`berkeley_library/tind`](https://github.com/BerkeleyLibrary/tind).
+- Initial extraction of code from [`berkeley_library/tind`](https://github.com/BerkeleyLibrary/tind).

data/README.md CHANGED Viewed

@@ -7,15 +7,19 @@ Miscellaneous utility code for the UC Berkeley Library.
 ### Notable modules
-## [BerkeleyLibrary::Util::Arrays](lib/berkeley_library/util/arrays.rb)]
+## [BerkeleyLibrary::Util::Arrays](lib/berkeley_library/util/arrays.rb)
 Routines for comparing, merging, and examining the contents of arrays.
-## [BerkeleyLibrary::Util::Paths](lib/berkeley_library/util/paths.rb)]
+## [BerkeleyLibrary::Util::Paths](lib/berkeley_library/util/paths.rb)
 Routines for modifying paths separated by forward slashes,
 (such as URL paths), modeled on the [Go `path` package](https://golang.org/pkg/path/).
-## [BerkeleyLibrary::Util::URIs](lib/berkeley_library/util/uris.rb)]
+## [BerkeleyLibrary::Util::URIs](lib/berkeley_library/util/uris.rb)
 Routines for constructing, validating, and retrieving the content from URIs.
+## [BerkeleyLibrary::Util::Files](lib/berkeley_library/util/files.rb)
+Routines for working with file paths and IO objects.

data/lib/berkeley_library/util/files.rb ADDED Viewed

@@ -0,0 +1,37 @@
+module BerkeleyLibrary
+  module Util
+    module Files
+      class << self
+        include Files
+      end
+      def file_exists?(path)
+        (path.respond_to?(:exist?) && path.exist?) ||
+          (path.respond_to?(:to_str) && File.exist?(path))
+      end
+      def parent_exists?(path)
+        path.respond_to?(:parent) && path.parent.exist? ||
+          path.respond_to?(:to_str) && Pathname.new(path).parent.exist?
+      end
+      # Returns true if `obj` is close enough to an IO object for Nokogiri
+      # to parse as one.
+      #
+      # @param obj [Object] the object that might be an IO
+      # @see https://github.com/sparklemotion/nokogiri/blob/v1.11.1/lib/nokogiri/xml/sax/parser.rb#L81 Nokogiri::XML::SAX::Parser#parse
+      def reader_like?(obj)
+        obj.respond_to?(:read) && obj.respond_to?(:close)
+      end
+      # Returns true if `obj` is close enough to an IO object for Nokogiri
+      # to write to.
+      #
+      # @param obj [Object] the object that might be an IO
+      def writer_like?(obj)
+        obj.respond_to?(:write) && obj.respond_to?(:close)
+      end
+    end
+  end
+end

data/lib/berkeley_library/util/module_info.rb CHANGED Viewed

@@ -5,11 +5,9 @@ module BerkeleyLibrary
       AUTHOR = 'David Moles'.freeze
       AUTHOR_EMAIL = 'dmoles@berkeley.edu'.freeze
       SUMMARY = 'Miscellaneous Ruby utilities for the UC Berkeley Library'.freeze
-      DESCRIPTION = <<~DESC.gsub(/\s+/, ' ').strip
-        A collection of miscellaneous Ruby routines for the UC Berkeley Library.
-      DESC
+      DESCRIPTION = 'A collection of miscellaneous Ruby routines for the UC Berkeley Library.'.freeze
       LICENSE = 'MIT'.freeze
-      VERSION = '0.1.0'.freeze
+      VERSION = '0.1.3'.freeze
       HOMEPAGE = 'https://github.com/BerkeleyLibrary/util'.freeze
     end
   end

data/lib/berkeley_library/util/paths.rb CHANGED Viewed

@@ -55,6 +55,14 @@ module BerkeleyLibrary
         clean(joined_raw)
       end
+      def abs?(path)
+        path.to_s.start_with?('/')
+      end
+      def ensure_abs(path)
+        abs?(path) ? path : "/#{path}"
+      end
       private
       def process_next(r, dotdot, path, out)

data/lib/berkeley_library/util/uris/appender.rb CHANGED Viewed

@@ -35,7 +35,8 @@ module BerkeleyLibrary
         # @raise URI::InvalidComponentError if appending the specified elements would create an invalid URI
         def to_uri
           original_uri.dup.tap do |new_uri|
-            new_uri.path = Paths.join(original_uri.path, *path_elements)
+            new_path = Paths.join(new_uri.path, *path_elements)
+            new_uri.path = Paths.ensure_abs(new_path)
             new_uri.query = query unless query_elements.empty?
             new_uri.fragment = fragment unless fragment_elements.empty?
           end

data/lib/berkeley_library/util/uris/requester.rb CHANGED Viewed

@@ -10,7 +10,7 @@ module BerkeleyLibrary
         class << self
           include BerkeleyLibrary::Logging
-          # Performs a GET request.
+          # Performs a GET request and returns the response body as a string.
           #
           # @param uri [URI, String] the URI to GET
           # @param params [Hash] the query parameters to add to the URI. (Note that the URI may already include query parameters.)
@@ -18,18 +18,36 @@ module BerkeleyLibrary
           # @return [String] the body as a string.
           # @raise [RestClient::Exception] in the event of an error.
           def get(uri, params: {}, headers: {})
-            url_str = url_str_with_params(uri, params)
-            resp = get_or_raise(url_str, headers)
+            resp = make_get_request(uri, params, headers)
             resp.body
           end
+          # Performs a GET request and returns the response.
+          #
+          # @param uri [URI, String] the URI to GET
+          # @param params [Hash] the query parameters to add to the URI. (Note that the URI may already include query parameters.)
+          # @param headers [Hash] the request headers.
+          # @return [RestClient::Response] the body as a string.
+          def get_response(uri, params: {}, headers: {})
+            make_get_request(uri, params, headers)
+          rescue RestClient::Exception => e
+            e.response
+          end
           private
+          def make_get_request(uri, params, headers)
+            url_str = url_str_with_params(uri, params)
+            get_or_raise(url_str, headers)
+          end
           def url_str_with_params(uri, params)
             raise ArgumentError, 'uri cannot be nil' unless (url_str = Validator.url_str_or_nil(uri))
             elements = [].tap do |ee|
               ee << url_str
+              next if params.empty?
               ee << '?' unless url_str.include?('?')
               ee << URI.encode_www_form(params)
             end
@@ -38,6 +56,7 @@ module BerkeleyLibrary
             uri.to_s
           end
+          # @return [RestClient::Response]
           def get_or_raise(url_str, headers)
             resp = RestClient.get(url_str, headers)
             begin
@@ -45,6 +64,7 @@ module BerkeleyLibrary
               raise(exception_for(resp, status))
             ensure
+              # noinspection RubyMismatchedReturnType
               logger.info("GET #{url_str} returned #{status}")
             end
           end

data/lib/berkeley_library/util/uris.rb CHANGED Viewed

@@ -32,6 +32,16 @@ module BerkeleyLibrary
         Requester.get(uri, params: params, headers: headers)
       end
+      # Performs a GET request and returns the response.
+      #
+      # @param uri [URI, String] the URI to GET
+      # @param params [Hash] the query parameters to add to the URI. (Note that the URI may already include query parameters.)
+      # @param headers [Hash] the request headers.
+      # @return [RestClient::Response] the body as a string.
+      def get_response(uri, params: {}, headers: {})
+        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.

data/spec/berkeley_library/util/files_spec.rb ADDED Viewed

@@ -0,0 +1,115 @@
+require 'spec_helper'
+module BerkeleyLibrary
+  module Util
+    describe Files do
+      let(:basename) { File.basename(__FILE__, '.rb') }
+      attr_reader :tmpdir
+      before { @tmpdir = Dir.mktmpdir(basename) }
+      after { FileUtils.remove_entry(tmpdir) }
+      describe :file_exists? do
+        it 'returns true for files that exist' do
+          path = Pathname.new(tmpdir).join('exists').tap { |p| FileUtils.touch(p) }
+          expect(path.exist?).to eq(true) # just to be sure
+          path_str = path.to_s
+          expect(Files.file_exists?(path)).to eq(true)
+          expect(Files.file_exists?(path_str)).to eq(true)
+        end
+        it 'returns false for files that do not exist' do
+          path = Pathname.new(tmpdir).join('not-exists')
+          expect(path.exist?).to eq(false) # just to be sure
+          path_str = path.to_s
+          expect(Files.file_exists?(path)).to eq(false)
+          expect(Files.file_exists?(path_str)).to eq(false)
+        end
+      end
+      describe :parent_exists? do
+        it 'returns true for paths whose parent exists' do
+          parent = Pathname.new(tmpdir).join('parent').tap(&:mkdir)
+          expect(parent.exist?).to eq(true) # just to be sure
+          path = parent.join('child')
+          path_str = path.to_s
+          expect(Files.parent_exists?(path)).to eq(true)
+          expect(Files.parent_exists?(path_str)).to eq(true)
+        end
+        it 'returns false for paths whose parent does not' do
+          parent = Pathname.new(tmpdir).join('parent')
+          expect(parent.exist?).to eq(false) # just to be sure
+          path = parent.join('child')
+          path_str = path.to_s
+          expect(Files.parent_exists?(path)).to eq(false)
+          expect(Files.parent_exists?(path_str)).to eq(false)
+        end
+      end
+      describe :reader_like? do
+        it 'returns true for a readable file' do
+          filename = File.join(tmpdir, 'out')
+          FileUtils.touch(filename)
+          File.open(filename, 'rb') do |out|
+            expect(Files.reader_like?(out)).to eq(true)
+          end
+        end
+        it 'returns true for a StringIO' do
+          out = StringIO.new
+          expect(Files.reader_like?(out)).to eq(true)
+        end
+        it 'returns true for a Tempfile' do
+          out = Tempfile.new('out')
+          begin
+            expect(Files.reader_like?(out)).to eq(true)
+          ensure
+            out.close
+            out.unlink
+          end
+        end
+        it 'returns false for something that is not reader-like' do
+          expect(Files.reader_like?('not an IO')).to eq(false)
+        end
+      end
+      describe :writer_like? do
+        it 'returns true for a writable file' do
+          filename = File.join(tmpdir, 'out')
+          File.open(filename, 'wb') do |out|
+            expect(Files.writer_like?(out)).to eq(true)
+          end
+        end
+        it 'returns true for a StringIO' do
+          out = StringIO.new
+          expect(Files.writer_like?(out)).to eq(true)
+        end
+        it 'returns true for a Tempfile' do
+          out = Tempfile.new('out')
+          begin
+            expect(Files.writer_like?(out)).to eq(true)
+          ensure
+            out.close
+            out.unlink
+          end
+        end
+        it 'returns false for something that is not writer-like' do
+          expect(Files.writer_like?('not an IO')).to eq(false)
+        end
+      end
+    end
+  end
+end

data/spec/berkeley_library/util/uris/requester_spec.rb CHANGED Viewed

@@ -44,18 +44,15 @@ module BerkeleyLibrary
             expect(result).to eq(expected_body)
           end
-          it 'raises an error for a failure status' do
-            url = 'https://example.org/'
-            stub_request(:get, url).to_return(status: 404)
-            expect { Requester.get(url) }.to raise_error(RestClient::RequestFailed)
-          end
-          it 'raises an error for a weird non-failure status' do
-            url = 'https://example.org/'
-            stub_request(:get, url).to_return(status: 207)
+          it "raises #{RestClient::Exception} in the event of an invalid response" do
+            aggregate_failures 'responses' do
+              [207, 400, 401, 403, 404, 405, 418, 451, 500, 503].each do |code|
+                url = "http://example.edu/#{code}"
+                stub_request(:get, url).to_return(status: code)
-            expect { Requester.get(url) }.to raise_error(RestClient::RequestFailed)
+                expect { Requester.get(url) }.to raise_error(RestClient::Exception)
+              end
+            end
           end
           it 'handles redirects' do

data/spec/berkeley_library/util/uris_spec.rb CHANGED Viewed

@@ -9,6 +9,29 @@ module BerkeleyLibrary::Util
         expect(new_uri).to eq(URI('https://example.org/foo/bar/qux/corge/garply'))
       end
+      it 'appends paths to bare URIs without root' do
+        original_url = 'https://example.org'
+        new_uri = URIs.append(original_url, 'foo', 'bar')
+        expected_uri = URI('https://example.org/foo/bar')
+        expect(new_uri).to eq(expected_uri)
+      end
+      # TODO: make this work
+      xit "doesn't append to a bare URI when there's nothing to append" do
+        original_url = 'https://example.org'
+        new_uri = URIs.append(original_url)
+        expected_uri = URI(original_url)
+        expect(new_uri).to eq(expected_uri)
+      end
+      # TODO: make this work
+      xit "doesn't append to a bare URI when there's only a query string" do
+        original_url = 'https://example.org'
+        new_uri = URIs.append(original_url, '?foo=bar')
+        expected_uri = URI("#{original_url}?foo=bar")
+        expect(new_uri).to eq(expected_uri)
+      end
       it 'does not modify the original URI' do
         original_uri = URI('https://example.org/foo/bar')
         original_url = original_uri.to_s
@@ -115,18 +138,44 @@ module BerkeleyLibrary::Util
       end
     end
-    describe :get do
-      it 'makes a GET request' do
-        url = 'https://example.org/'
-        params = { p1: 1, p2: 2 }
-        headers = { 'X-help' => 'I am trapped in a unit test' }
+    describe 'requests' do
+      let(:url) { 'https://example.org/' }
+      let(:params) { { p1: 1, p2: 2 } }
+      let(:headers) { { 'X-help' => 'I am trapped in a unit test' } }
+      let(:url_with_query) { "#{url}?#{URI.encode_www_form(params)}" }
+      let(:expected_body) { 'Help! I am trapped in a unit test' }
+      describe :get do
+        it 'makes a GET request' do
+          stub_request(:get, url_with_query).with(headers: headers).to_return(body: expected_body)
+          result = URIs.get(url, params: params, headers: headers)
+          expect(result).to eq(expected_body)
+        end
+        it 'raises an error in the event of a 404' do
+          stub_request(:get, url_with_query).with(headers: headers).to_return(status: 404, body: expected_body)
+          expect { URIs.get(url, params: params, headers: headers) }.to raise_error(RestClient::NotFound)
+        end
+      end
+      describe :get_response do
+        it 'makes a GET request' do
+          stub_request(:get, url_with_query).with(headers: headers).to_return(body: expected_body)
+          response = URIs.get_response(url, params: params, headers: headers)
+          expect(response.body).to eq(expected_body)
+          expect(response.code).to eq(200)
+        end
-        url_with_query = "#{url}?#{URI.encode_www_form(params)}"
-        expected_body = 'Help! I am trapped in a unit test'
-        stub_request(:get, url_with_query).with(headers: headers).to_return(body: expected_body)
+        it 'returns the response even for errors' do
+          stub_request(:get, url_with_query).with(headers: headers).to_return(status: 404, body: expected_body)
-        result = URIs.get(url, params: params, headers: headers)
-        expect(result).to eq(expected_body)
+          response = URIs.get_response(url, params: params, headers: headers)
+          expect(response.body).to eq(expected_body)
+          expect(response.code).to eq(404)
+        end
       end
     end
   end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: berkeley_library-util
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - David Moles
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-23 00:00:00.000000000 Z
+date: 2022-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: berkeley_library-logging
@@ -260,6 +260,7 @@ files:
 - berkeley_library-util.gemspec
 - lib/berkeley_library/util.rb
 - lib/berkeley_library/util/arrays.rb
+- lib/berkeley_library/util/files.rb
 - lib/berkeley_library/util/module_info.rb
 - lib/berkeley_library/util/paths.rb
 - lib/berkeley_library/util/stringios.rb
@@ -277,6 +278,7 @@ files:
 - rakelib/spec.rake
 - spec/.rubocop.yml
 - spec/berkeley_library/util/arrays_spec.rb
+- spec/berkeley_library/util/files_spec.rb
 - spec/berkeley_library/util/paths_spec.rb
 - spec/berkeley_library/util/stringios_spec.rb
 - spec/berkeley_library/util/strings_spec.rb
@@ -311,6 +313,7 @@ summary: Miscellaneous Ruby utilities for the UC Berkeley Library
 test_files:
 - spec/.rubocop.yml
 - spec/berkeley_library/util/arrays_spec.rb
+- spec/berkeley_library/util/files_spec.rb
 - spec/berkeley_library/util/paths_spec.rb
 - spec/berkeley_library/util/stringios_spec.rb
 - spec/berkeley_library/util/strings_spec.rb