berkeley_library-marc 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c479c395bc201b47ebfc171b3ee402e5962a4111f618ee26473aeb6d689011d5
-  data.tar.gz: 3197dc1cfbc96c65a31f6528351ce1b39dbea33e8142245e7527c55342c98f26
+  metadata.gz: 25ed54f0bd91408a2bc16d7d51525e4bfe7086bf9b3a507b2e40a846432fff32
+  data.tar.gz: 135562e29c813d72f4830bfd8413a79c6480c2f7c5c396621a14ccdc22732432
 SHA512:
-  metadata.gz: c6e8adff15efbc36fea120f03481c59cc451831c40447a06c0451733d6660fb0fb2766ca0955a7214b0b941f861421f7d1ccfbacc41d37b6f8a012b67bddea1d
-  data.tar.gz: 62cb9959145a7b8a490b2cc7fe88657e6ca26233dc9dde6a7f8b9ec146fb5303bb17bdabcc8c96da97ac408aa3d795c46aa9954fd49d757acf049bd7c5829897
+  metadata.gz: 968f53042e1d9b390c842ecc30f2b531ac58a17b49670ede19d9458a5559d93bb7c689c3665028a5c77d80cd892112468ad20b424aac72b420850b759529d6c1
+  data.tar.gz: d454a28e68812c807dcab0908317a566ff7949a3c66e3d22bb2374a457cee4dcb86c2cbb78ea69bcc4cd855cd74cb3b5e27a4cad016faec80276d3eec4860d03

data/.idea/inspectionProfiles/Project_Default.xml

@@ -10,6 +10,9 @@
     <inspection_tool class="LanguageDetectionInspection" enabled="false" level="WARNING" enabled_by_default="false" />
     <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="RubyMismatchedArgumentType" enabled="true" level="WARNING" enabled_by_default="true">
+      <option name="myCheckNilability" value="false" />
+    </inspection_tool>
     <inspection_tool class="RubyStringKeysInHashInspection" enabled="true" level="INFORMATION" enabled_by_default="true" />
     <inspection_tool class="RubyUnnecessaryReturnStatement" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
     <inspection_tool class="SpellCheckingInspection" enabled="false" level="TYPO" enabled_by_default="false">

data/.idea/marc.iml

@@ -6,63 +6,65 @@
   <component name="NewModuleRootManager">
     <content url="file://$MODULE_DIR$">
       <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
-      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
       <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
       <excludeFolder url="file://$MODULE_DIR$/artifacts" />
     </content>
-    <orderEntry type="jdk" jdkName="RVM: ruby-2.7.4" jdkType="RUBY_SDK" />
+    <orderEntry type="jdk" jdkName="RVM: ruby-2.7.5" jdkType="RUBY_SDK" />
     <orderEntry type="sourceFolder" forTests="false" />
-    <orderEntry type="library" scope="PROVIDED" name="addressable (v2.8.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="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-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="crack (v0.4.5, 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="docile (v1.4.0, 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" />
-    <orderEntry type="library" scope="PROVIDED" name="ffi (v1.15.4, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="hashdiff (v1.0.1, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="listen (v3.1.5, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="marc (v1.1.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="parslet (v2.0.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="rainbow (v3.0.0, 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="rb-fsevent (v0.11.0, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rb-inotify (v0.10.1, 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="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="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-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-marc-spec (v0.1.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="ruby_dep (v1.5.0, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="scrub_rb (v1.0.1, 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="typesafe_enum (v0.3.0, 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="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="ast (v2.4.2, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="builder (v3.2.4, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundle-audit (v0.1.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.2.31, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler-audit (v0.9.0.1, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ci_reporter (v2.0.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ci_reporter_rspec (v1.0.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="colorize (v0.8.1, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.5.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="docile (v1.4.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="dotenv (v2.7.6, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ffi (v1.15.4, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="listen (v3.1.5, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="marc (v1.1.1, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="nokogiri (v1.13.1, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parallel (v1.21.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parser (v3.1.0.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parslet (v2.0.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="racc (v1.6.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rainbow (v3.0.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v13.0.6, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rb-fsevent (v0.11.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rb-inotify (v0.10.1, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="regexp_parser (v2.2.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rexml (v3.2.5, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec (v3.10.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.10.1, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.10.1, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.10.2, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.10.3, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop (v1.11.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop-ast (v1.15.1, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop-rake (v0.6.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop-rspec (v2.4.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ruby-marc-spec (v0.1.1, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ruby-prof (v0.17.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ruby-progressbar (v1.11.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ruby_dep (v1.5.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="scrub_rb (v1.0.1, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="simplecov (v0.21.2, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="simplecov-html (v0.12.3, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="simplecov-rcov (v0.2.3, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="simplecov_json_formatter (v0.1.3, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="thor (v1.1.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="typesafe_enum (v0.3.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="unf (v0.1.4, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="unf_ext (v0.0.8, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="unicode-display_width (v2.1.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="webrick (v1.7.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="yard (v0.9.27, RVM: ruby-2.7.5) [gem]" level="application" />
+  </component>
+  <component name="RModuleSettingsStorage">
+    <LOAD_PATH number="2" string0="$MODULE_DIR$/lib" string1="$MODULE_DIR$/spec" />
+    <I18N_FOLDERS number="0" />
   </component>
   <component name="RakeTasksCache">
     <option name="myRootTask">
@@ -75,7 +77,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-marc.gemspec as berkeley_library-marc-0.2.0.gem" fullCommand="gem" id="gem" />
+          <RakeTaskImpl description="Build berkeley_library-marc.gemspec as berkeley_library-marc-0.2.2.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/.ruby-version

@@ -1 +1 @@
-2.7
+2.7.5

data/.yardopts

@@ -1 +1,6 @@
---no-private --protected lib/**/*.rb -m markdown
+--no-private
+--protected
+-m markdown
+-o ./artifacts/doc
+--exclude lib/berkeley_library/marc/field_info/var_fields/data
+lib/**/*.rb

data/CHANGES.md

@@ -1,3 +1,21 @@
+# 0.3.0 (2022-01-25)
+
+Fixes:
+
+- Methods in `MARCExtensions::RecordExtensions` and `MARCExtensions::FieldMapExtensions`
+  now correctly return `Enumerator::Lazy` as documented.
+- Fix issue where `freeze:` option to `MARC::XMLReader#new` or `MARC::XMLReader#read`
+  was accepted, but not implemented
+- Test `MARC::XMLReader` extensions with both `MARC::REXMLReader` and `MARC::NokogiriReader`
+  - **Note:** the extensions _should_ work with `JREXMLReader`, `JRubyStaxReader`, and
+    `LibXMLReader`, but these have not been tested.
+
+Possible breaking changes:
+
+- The unused constant `MARCExtensions::FieldMapExtensions::VALID_TAGS` has been removed.
+- `MARC::XMLReader#read` now takes an `options` hash instead of a `freeze:` keyword
+  parameter for better compatibility with `MARC::XMLReader#new`, esp. in Ruby 2.x.
+
 # 0.2.1 (2021-10-16)
 
 - Add [MARC::Spec](https://github.com/BerkeleyLibrary/marc-spec)

data/LICENSE.md

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 
-Copyright © 2021 The Regents of the University of California
+Copyright © 2022 The Regents of the University of California
 
 Permission is hereby granted, free of charge, to any person obtaining a
 copy of this software and associated documentation files (the “Software”),

data/berkeley_library-marc.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'colorize', '~> 0.8'
   spec.add_development_dependency 'dotenv', '~> 2.7'
   spec.add_development_dependency 'listen', '>= 3.0.5', '< 3.2'
+  spec.add_development_dependency 'nokogiri', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.10'
   spec.add_development_dependency 'rubocop', '= 1.11'
@@ -39,5 +40,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'ruby-prof', '~> 0.17.0'
   spec.add_development_dependency 'simplecov', '~> 0.21'
   spec.add_development_dependency 'simplecov-rcov', '~> 0.2'
-  spec.add_development_dependency 'webmock', '~> 3.12'
+  spec.add_development_dependency 'yard', '~> 0.9.27'
 end

data/lib/berkeley_library/marc/field_info/var_fields/ind_def.rb

@@ -5,10 +5,12 @@ module BerkeleyLibrary
   module Marc
     module FieldInfo
       module VarFields
+        # An indicator definition.
         class IndDef
           # TODO: include Comparable
           include Obsolescible
 
+          # Human-readable position names
           POS_NAMES = { 1 => 'First', 2 => 'Second' }.freeze
 
           attr_reader :pos
@@ -23,10 +25,12 @@ module BerkeleyLibrary
             @val_defs = val_defs
           end
 
+          # @see Obsolescible#reject_obsoletes
           def reject_obsoletes
             IndDef.new(pos: pos, desc: desc, val_defs: _reject_obsolete(val_defs))
           end
 
+          # see Object#to_s
           def to_s
             lines = ["#{POS_NAMES[pos]} - #{desc}"]
             val_defs.each { |v| lines << "   #{v}" }

data/lib/berkeley_library/marc/field_info/var_fields/ind_val_def.rb

@@ -4,6 +4,7 @@ module BerkeleyLibrary
   module Marc
     module FieldInfo
       module VarFields
+        # An indicator value definition.
         class IndValDef
           # TODO: include Comparable
           include Obsolescible
@@ -17,6 +18,7 @@ module BerkeleyLibrary
             @desc = desc
           end
 
+          # see Object#to_s
           def to_s
             "#{val} - #{desc}"
           end

data/lib/berkeley_library/marc/field_info/var_fields/instrument_or_voices_code.rb

@@ -4,6 +4,7 @@ module BerkeleyLibrary
   module Marc
     module FieldInfo
       module VarFields
+        # An instrument or voices code.
         class InstrumentOrVoicesCode
           # TODO: include Comparable
           include Obsolescible
@@ -16,6 +17,7 @@ module BerkeleyLibrary
             @desc = desc
           end
 
+          # see Object#to_s
           def to_s
             "#{val} - #{desc}"
           end

data/lib/berkeley_library/marc/field_info/var_fields/section.rb

@@ -5,6 +5,7 @@ module BerkeleyLibrary
   module Marc
     module FieldInfo
       module VarFields
+        # A section of a MARC field list
         class Section
           include Enumerable
           include Obsolescible
@@ -17,20 +18,30 @@ module BerkeleyLibrary
             @var_fields = var_fields
           end
 
+          # Each variable field definition in this section.
+          # @overload each
+          #   An enumerator of the fields in this section.
+          #   @return [Enumerator<VarFieldDef>] the fields
+          # @overload each(&block)
+          #   Yields each field in this section.
+          #   @yieldparam vf [VarFieldDef] the field.
           def each(&block)
             return to_enum(:each) unless block_given?
 
             var_fields.each(&block)
           end
 
+          # The number of variable fields in this section.
           def size
             var_fields.size
           end
 
+          # Returns true if this section contains no variable fields.
           def empty?
             var_fields.empty?
           end
 
+          # @see Obsolescible#reject_obsoletes
           def reject_obsoletes
             Section.new(
               desc: desc,
@@ -38,6 +49,7 @@ module BerkeleyLibrary
             )
           end
 
+          # see Object#to_s
           def to_s
             blocks = ["--#{desc}--"]
             blocks.concat(var_fields.map(&:to_s))

data/lib/berkeley_library/marc/field_info/var_fields/subfield_def.rb

@@ -5,8 +5,9 @@ module BerkeleyLibrary
   module Marc
     module FieldInfo
       module VarFields
-        # TODO: destructure range codes in some useful way (e.g. 886a-z, 0-9)
+        # A subfield definition.
         class SubfieldDef
+          # TODO: destructure range codes in some useful way (e.g. 886a-z, 0-9)
           include Obsolescible
 
           attr_reader :code, :desc, :values
@@ -17,19 +18,29 @@ module BerkeleyLibrary
             @values = values
           end
 
+          # @see Obsolescible#reject_obsoletes
           def reject_obsoletes
             SubfieldDef.new(code: code, desc: desc, values: _reject_obsolete(values))
           end
 
+          # Each value definition for this subfield.
+          # @overload each
+          #   An enumerator of the value definitions for this subfield.
+          #   @return [Enumerator<SubfieldVal>] the subfields.
+          # @overload each(&block)
+          #   Yields each value definition for this subfield.
+          #   @yieldparam v [SubfieldVal] the subfield.
           def each_value(&block)
             return to_enum(:each_value) unless block_given?
 
+            # noinspection RubyMismatchedReturnType
             values.each(&block)
           end
 
           INDENT = '    '.freeze
           private_constant :INDENT
 
+          # see Object#to_s
           def to_s
             lines = ["$#{code_str} - #{desc}"]
             values.each { |v| lines << INDENT + v.to_s }

data/lib/berkeley_library/marc/field_info/var_fields/subfield_val.rb

@@ -2,6 +2,7 @@ module BerkeleyLibrary
   module Marc
     module FieldInfo
       module VarFields
+        # A subfield value definition.
         class SubfieldVal
           # TODO: include Comparable
           include Obsolescible
@@ -14,6 +15,7 @@ module BerkeleyLibrary
             @desc = desc
           end
 
+          # see Object#to_s
           def to_s
             "#{val} - #{desc}"
           end

data/lib/berkeley_library/marc/field_info/var_fields/var_field_def.rb

@@ -7,6 +7,7 @@ module BerkeleyLibrary
   module Marc
     module FieldInfo
       module VarFields
+        # A variable field definition.
         class VarFieldDef
           include Obsolescible
 
@@ -20,6 +21,7 @@ module BerkeleyLibrary
             @inst_or_voices_codes = inst_or_voices_codes
           end
 
+          # see Object#to_s
           def to_s
             blocks = ["#{tag} - #{desc}"]
 
@@ -30,6 +32,7 @@ module BerkeleyLibrary
             blocks.join("\n")
           end
 
+          # @see Obsolescible#reject_obsoletes
           def reject_obsoletes
             VarFieldDef.new(
               tag: tag,

data/lib/berkeley_library/marc/field_info/var_fields/var_field_list.rb

@@ -5,6 +5,7 @@ module BerkeleyLibrary
   module Marc
     module FieldInfo
       module VarFields
+        # A list of variable fields grouped into sections.
         class VarFieldList
           include Enumerable
           include Obsolescible
@@ -16,16 +17,25 @@ module BerkeleyLibrary
             @sections = sections
           end
 
+          # Each section in this list.
+          # @overload each
+          #   An enumerator of the sections in this list.
+          #   @return [Enumerator<Section>] the sections.
+          # @overload each(&block)
+          #   Yields each section in this list.
+          #   @yieldparam s [Section] the section.
           def each(&block)
             return to_enum(:each) unless block_given?
 
             sections.each { |section| section.each(&block) }
           end
 
+          # The number of sections in this list.
           def size
             sections.sum(&:size)
           end
 
+          # @see Obsolescible#reject_obsoletes
           def reject_obsoletes
             VarFieldList.new(
               desc: desc,
@@ -33,6 +43,7 @@ module BerkeleyLibrary
             )
           end
 
+          # see Object#to_s
           def to_s
             sections.map(&:to_s).join("\n")
           end

data/lib/berkeley_library/marc/field_info/var_fields/var_field_parser.rb

@@ -6,6 +6,9 @@ module BerkeleyLibrary
       module VarFields
 
         # rubocop:disable Style/BlockDelimiters
+
+        # Parses MARC documentation in the format used by the
+        # Library of Congress [field list](https://www.loc.gov/marc/bibliographic/ecbdlist.html).
         class VarFieldParser < Parslet::Parser
 
           # ------------------------------------------------------------
@@ -122,10 +125,27 @@ module BerkeleyLibrary
           # ------------------------------------------------------------
           # Parser
 
+          # Parses the specified field documentation.
+          # Usage:
+          #
+          # ```ruby
+          # parser = VarFieldParser.new
+          # parse_tree = parser.parse('docs.txt')
+          # xform = VarFieldTransform.new
+          # var_field_list = xform.apply(parse_tree)
+          # ```
+          #
+          # @param io [String, Source] input for the parse process
+          # @option options [Parslet::ErrorReporter] :reporter error reporter to use,
+          #   defaults to Parslet::ErrorReporter::Tree
+          # @option options [Boolean] :prefix Should a prefix match be accepted?
+          #   (default: false)
+          # @return [Hash] a parse tree suitable for input to {VarFieldTransform}
           def parse(io, options = nil)
             opts = { reporter: Parslet::ErrorReporter::Deepest.new }
             opts.merge!(options) if options
 
+            # noinspection RubyMismatchedReturnType
             super(io, opts)
           end
         end

data/lib/berkeley_library/marc/field_info/var_fields/var_field_transform.rb

@@ -7,8 +7,21 @@ module BerkeleyLibrary
       module VarFields
         # TODO: flag [OBSOLETE], (R), (NR)
         # rubocop:disable Style/BlockDelimiters
+
+        # Transformer converting {VarFieldParser} output to a {VarFieldList}.
+        # Usage:
+        #
+        # ```ruby
+        # parser = VarFieldParser.new
+        # parse_tree = parser.parse('docs.txt')
+        # xform = VarFieldTransform.new
+        # var_field_list = xform.apply(parse_tree)
+        # ```
         class VarFieldTransform < Parslet::Transform
 
+          # Intermediate representation of structures constisting of
+          # a `val` and a `desc` (includes {IndValDef}, {SubfieldVal},
+          # and {InstrumentOrVoicesCode}).
           class AnyValue
             attr_reader :val, :desc
 
@@ -17,14 +30,20 @@ module BerkeleyLibrary
               @desc = desc
             end
 
+            # Converts this {AnyValue} to an {IndValDef}.
+            # @return [IndValDef] the {IndValDef}
             def to_ind_val_def
               IndValDef.new(val: val, desc: desc)
             end
 
+            # Converts this {AnyValue} to an {SubfieldVal}.
+            # @return [SubfieldVal] the {SubfieldVal}
             def to_subfield_val
               SubfieldVal.new(val: val, desc: desc)
             end
 
+            # Converts this {AnyValue} to an {InstrumentOrVoicesCode}.
+            # @return [InstrumentOrVoicesCode] the {InstrumentOrVoicesCode}
             def to_ivc
               InstrumentOrVoicesCode.new(val: val, desc: desc)
             end

data/lib/berkeley_library/marc/field_info/var_fields.rb

@@ -4,13 +4,19 @@ require 'berkeley_library/marc/field_info/var_fields/data'
 module BerkeleyLibrary
   module Marc
     module FieldInfo
+      # Parsed documentation for variable fields.
       module VarFields
 
+        # Path to machine-readable field documentation directory.
         DATA_DIR = File.expand_path('var_fields/data', __dir__)
+
+        # Path to LOC standard variable field documentation.
         PATH_STANDARD = File.join(DATA_DIR, 'var_fields_standard.txt')
 
         class << self
 
+          # Return information on all LOC standard variable fields.
+          # @param obsolete [Boolean] whether to include fields documented as obsolete.
           def standard(obsolete: false)
             @standard_all ||= VarFieldTransform.new.apply(BerkeleyLibrary::Marc::FieldInfo::VarFields::STANDARD_PARSED)
             return @standard_all if obsolete
@@ -18,6 +24,8 @@ module BerkeleyLibrary
             @standard ||= @standard_all.reject_obsoletes
           end
 
+          # Return information on UC Berkeley special 9xx fields.
+          # @param obsolete [Boolean] whether to include fields documented as obsolete.
           def berkeley_9xx(obsolete: false)
             @berkeley_9xx_all ||= VarFieldTransform.new.apply(BerkeleyLibrary::Marc::FieldInfo::VarFields::BERKELEY_9XX_PARSED)
             return @berkeley_9xx_all if obsolete

data/lib/berkeley_library/marc/field_info.rb

@@ -1 +1,9 @@
+module BerkeleyLibrary
+  module Marc
+    # Experimental module for parsing MARC documentation in the format used by the
+    # Library of Congress [field list](https://www.loc.gov/marc/bibliographic/ecbdlist.html).
+    module FieldInfo; end
+  end
+end
+
 Dir.glob(File.expand_path('field_info/*.rb', __dir__)).sort.each(&method(:require))

data/lib/berkeley_library/marc/module_info.rb

@@ -1,13 +1,32 @@
+# Umbrella module for UC Berkeley Library Ruby code
 module BerkeleyLibrary
+  # MARC utilities for the UC Berkeley Library
   module Marc
+    # Build information for this module
     class ModuleInfo
+
+      # The gem name
       NAME = 'berkeley_library-marc'.freeze
+
+      # The author
       AUTHOR = 'David Moles'.freeze
+
+      # Author contact email
       AUTHOR_EMAIL = 'dmoles@berkeley.edu'.freeze
+
+      # Gem summary
       SUMMARY = 'MARC utilities for the UC Berkeley Library'.freeze
+
+      # Gem description
       DESCRIPTION = 'A gem providing MARC-related utility code and extensions to ruby-marc for the UC Berkeley Library'.freeze
+
+      # Gem license
       LICENSE = 'MIT'.freeze
-      VERSION = '0.2.1'.freeze
+
+      # Gem version
+      VERSION = '0.3.0'.freeze
+
+      # Gem homepage
       HOMEPAGE = 'https://github.com/BerkeleyLibrary/marc'.freeze
     end
   end

data/lib/berkeley_library/marc.rb

@@ -1,3 +1,8 @@
 require 'marc_extensions'
 
+module BerkeleyLibrary
+  # Umbrella module for UC Berkeley Library MARC code.
+  module Marc; end
+end
+
 Dir.glob(File.expand_path('marc/*.rb', __dir__)).sort.each(&method(:require))

data/lib/marc_extensions/data_field.rb

@@ -2,26 +2,39 @@ require 'marc'
 require 'marc_extensions/subfield'
 
 module MARCExtensions
+  # Extensions for [MARC::XMLReader](https://rubydoc.info/gems/marc/MARC/DataField).
   module DataFieldExtensions
+    # Returns a list of all the subfield codes in this data field.
+    # @return [Array] the subfield codes
     def subfield_codes
       subfields.map(&:code)
     end
 
+    # Whether this datafield and all its tag, indicators, and
+    # subfields are frozen.
+    #
+    # @return [Boolean] true if the field is frozen, false otherwise.
     def frozen?
-      [tag, indicator1, indicator2, subfields].all?(&:frozen?)
-      subfields.all?(&:frozen?)
+      [tag, indicator1, indicator2, subfields].all?(&:frozen?) &&
+        subfields.all?(&:frozen?) &&
+        super
     end
 
+    # Recursively freezes this datafield, along with its tag, indicators,
+    # and subfields.
+    #
+    # @return [MARC::DataField] this data field.
     def freeze
       [tag, indicator1, indicator2].each(&:freeze)
       subfields.each(&:freeze)
       subfields.freeze
-      self
+      super
     end
   end
 end
 
 module MARC
+  # Applies the extensions in {MARCExtensions::DataFieldExtensions}
   # @see https://rubydoc.info/gems/marc/MARC/DataField RubyGems documentation
   class DataField
     prepend MARCExtensions::DataFieldExtensions

data/lib/marc_extensions/field_map.rb

@@ -1,9 +1,9 @@
 require 'marc'
+
 module MARCExtensions
+  # Extensions to [MARC::FieldMap](https://rubydoc.info/gems/marc/MARC/FieldMap).
   module FieldMapExtensions
 
-    VALID_TAGS = ('000'..'999').freeze
-
     # Gets the specified fields in order by tag.
     #
     # @overload each_sorted_by_tag(tags, &block)
@@ -23,29 +23,33 @@ module MARCExtensions
     def each_sorted_by_tag(tags = nil, &block)
       reindex unless @clean
 
-      indices_for(tags).map { |i| self[i] }.each(&block)
+      indices = indices_for(tags)
+      fields = indices.map { |i| self[i] }
+      # noinspection RubyMismatchedReturnType
+      fields.each(&block)
+    end
+
+    # Recursively freezes all fields.
+    # @return [MARC::FieldMap] this FieldMap.
+    def freeze
+      unless frozen?
+        reindex unless @clean
+        each(&:freeze)
+      end
+
+      super
     end
 
     private
 
     def indices_for(tags)
-      return all_indices unless tags
-
-      sorted_tag_array(tags)
+      sorted_tag_array(tags || tag_list)
         .lazy                                      # prevent unnecessary allocations
         .map { |t| @tags[t] }                      # get indices for each tag
         .reject(&:nil?)                            # ignoring any tags we don't have fields for
         .flat_map { |x| x }                        # flatten list of indices -- equiv. Array#flatten
     end
 
-    def all_indices
-      [].tap do |a|
-        @tags.keys.sort.map do |t|
-          a.concat(@tags[t])
-        end
-      end
-    end
-
     def sorted_tag_array(tags)
       return Array(tags) if tags.is_a?(Range)
 
@@ -56,6 +60,7 @@ module MARCExtensions
 end
 
 module MARC
+  # Applies the extensions in {MARCExtensions::FieldMapExtensions}.
   # @see https://rubydoc.info/gems/marc/MARC/FieldMap RubyGems documentation
   class FieldMap
     prepend MARCExtensions::FieldMapExtensions

data/lib/marc_extensions/record.rb

@@ -4,6 +4,7 @@ require 'marc_extensions/field_map'
 require 'marc_extensions/data_field'
 
 module MARCExtensions
+  # Extensions to [MARC::Record](https://rubydoc.info/gems/marc/MARC/Record).
   module RecordExtensions
 
     # Gets the specified fields in order by tag.
@@ -38,6 +39,7 @@ module MARCExtensions
     #   Yields each control field.
     #   @yieldparam field [MARC::ControlField] Each control field.
     def each_control_field(&block)
+      # noinspection RubyMismatchedReturnType
       each_sorted_by_tag.take_while { |df| df.tag.to_i <= 10 }.each(&block)
     end
 
@@ -52,6 +54,7 @@ module MARCExtensions
     #   Yields each data field.
     #   @yieldparam field [MARC::DataField] Each data field.
     def each_data_field(&block)
+      # noinspection RubyMismatchedReturnType
       each_sorted_by_tag.select { |df| df.tag.to_i > 10 }.each(&block)
     end
 
@@ -72,20 +75,24 @@ module MARCExtensions
       data_fields_by_tag.values.flatten
     end
 
-    # Freezes the leader and fields.
+    # Recursively freezes this record, along with its leader and fields.
+    # @return [MARC::Record] this record.
     def freeze
+      return if frozen?
+
       leader.freeze
-      fields.each(&:freeze)
       fields.freeze
-      self
+      super
     end
 
+    # Whether this record, its fields, and leader are all frozen.
     # @return [Boolean] true if the fields and leader are frozen
     def frozen?
-      (fields.frozen? && leader.frozen?)
+      (fields.frozen? && leader.frozen?) && super
     end
 
-    # TODO: use info from parsed documentation? or move to TIND-specific extension
+    # Returns the canonical ID from the 001 control field.
+    # @return [String, nil] the 001 control field value, or nil if not present
     def record_id
       cf_001 = self['001']
       return cf_001.value if cf_001
@@ -102,7 +109,10 @@ module MARCExtensions
   end
 end
 
+# Extensions to [ruby-marc](https://rubydoc.info/gems/marc/)
+# @see https://rubydoc.info/gems/marc/MARC RubyGems documentation
 module MARC
+  # Applies the extensions in {MARCExtensions::RecordExtensions}.
   # @see https://rubydoc.info/gems/marc/MARC/Record RubyGems documentation
   class Record
     prepend MARCExtensions::RecordExtensions

data/lib/marc_extensions/subfield.rb

@@ -1,19 +1,27 @@
 require 'marc'
 
 module MARCExtensions
+  # Extensions to [MARC::Subfield](https://rubydoc.info/gems/marc/MARC/Subfield).
   module SubfieldExtensions
+
+    # Recursively freezes this subfield, including its code and value.
+    #
+    # @return [Boolean] true if this subfield is frozen, false otherwise
     def frozen?
-      [code, value].all?(&:frozen?)
+      [code, value].all?(&:frozen?) && super
     end
 
+    # Whether this subfield and its code and value are frozen.
+    # @return [MARC::Subfield] this subfield.
     def freeze
       [code, value].each(&:freeze)
-      self
+      super
     end
   end
 end
 
 module MARC
+  # Applies the extensions in {MARCExtensions::SubfieldExtensions}.
   # @see https://rubydoc.info/gems/marc/MARC/Subfield RubyGems documentation
   class Subfield
     prepend MARCExtensions::SubfieldExtensions

data/lib/marc_extensions/xml_reader.rb

@@ -2,16 +2,76 @@ require 'marc'
 require 'marc_extensions/record'
 
 module MARCExtensions
+  # Extends [MARC::XMLReader](https://rubydoc.info/gems/marc/MARC/XMLReader).
+  module XMLReaderExtensions
+    # Adds a `:freeze` option to [MARC::XMLReader](https://rubydoc.info/gems/marc/MARC/XMLReader)
+    # which freezes each record as it's constructed:
+    #
+    # ```ruby
+    # reader = MARC::XMLReader.new('marc.xml', { freeze: true })
+    # record = reader.first
+    # record.frozen?
+    # # => true
+    # ```
+    #
+    # @see MARCExtensions::RecordExtensions#freeze
+    def initialize(file, options = {})
+      @freeze = options[:freeze]
+      super(file, options)
+
+      # It's surprisingly tricky to get these into the general superclass
+      # chain, so instead we just prepend them to the eigenclass
+      if respond_to?(:yield_record)
+        class << self; prepend(MARCExtensions::YieldFrozenRecord); end
+      elsif respond_to?(:build_record, true)
+        class << self; prepend(MARCExtensions::BuildFrozenRecord); end
+      end
+    end
+  end
+
+  # Class extensions for [MARC::XMLReader](https://rubydoc.info/gems/marc/MARC/XMLReader).
   module XMLReaderClassExtensions
-    def read(file, freeze: false)
-      new(file, freeze: freeze)
+    # Reads MARC records from the specified file or IO
+    #
+    # @param file [String, IO] a string file path, or an IO object
+    # @return [MARC::XMLReader] a reader for the specified file or IO
+    def read(file, options = {})
+      new(file, options)
+    end
+  end
+
+  # Extends [MARC::GenericPullParser](https://rubydoc.info/gems/marc/MARC/GenericPullParser)
+  # to support `:freeze` option
+  module YieldFrozenRecord
+    # Builds a MARC record, freezing it if the `:freeze` option
+    # was passed to the reader.
+    # @@yieldparam record [MARC::Record] the record
+    def yield_record
+      @record[:record].freeze if @freeze
+      super
+    end
+  end
+
+  # Extends [MARC::REXMLReader](https://rubydoc.info/gems/marc/MARC/REXMLReader)
+  # and [MARC::LibXMLReader](https://rubydoc.info/gems/marc/MARC/LibXMLReader)
+  # to support `:freeze` option
+  module BuildFrozenRecord
+    # Builds a MARC record, freezing it if the `:freeze` option
+    # was passed to the reader.
+    # @return [MARC::Record] the record
+    def build_record
+      super.tap { |record| record.freeze if @freeze }
     end
   end
 end
 
 module MARC
+  # Applies the extensions in {MARCExtensions::XMLReaderExtensions}
+  # and {MARCExtensions::XMLReaderClassExtensions}.
   # @see https://rubydoc.info/gems/marc/MARC/XMLReader RubyGems documentation
   class XMLReader
+    prepend MARCExtensions::XMLReaderExtensions
+
     class << self
       prepend MARCExtensions::XMLReaderClassExtensions
     end

data/lib/marc_extensions.rb

@@ -1 +1,4 @@
+# Extensions to [ruby-marc](https://rubydoc.info/gems/marc/)
+module MARCExtensions; end
+
 Dir.glob(File.expand_path('marc_extensions/*.rb', __dir__)).sort.each(&method(:require))

data/spec/data/record-187888.xml

@@ -1,4 +1,3 @@
-
 <?xml version="1.0" encoding="UTF-8"?>
 <collection xmlns="http://www.loc.gov/MARC21/slim">
   <record>

data/spec/marc_extensions/record_spec.rb

@@ -36,42 +36,6 @@ describe MARC::Record do
     end
   end
 
-  describe :frozen? do
-    it 'returns false neither fields nor leader are frozen' do
-      expect(marc_record.leader).not_to be_frozen # just to be sure
-      expect(marc_record.fields).not_to be_frozen # just to be sure
-      expect(marc_record).not_to be_frozen
-    end
-
-    it 'returns false if only fields are frozen' do
-      expect(marc_record.leader).not_to be_frozen # just to be sure
-      expect(marc_record.fields).not_to be_frozen # just to be sure
-      marc_record.leader.freeze
-      expect(marc_record).not_to be_frozen
-    end
-
-    it 'returns false if only leader is frozen' do
-      expect(marc_record.leader).not_to be_frozen # just to be sure
-      expect(marc_record.fields).not_to be_frozen # just to be sure
-      marc_record.fields.freeze
-      expect(marc_record).not_to be_frozen
-    end
-
-    it 'returns false if neither fields nor leader are frozen' do
-      expect(marc_record.leader).not_to be_frozen # just to be sure
-      expect(marc_record.fields).not_to be_frozen # just to be sure
-      expect(marc_record).not_to be_frozen
-    end
-
-    it 'returns true if both fields and leader are frozen' do
-      expect(marc_record.leader).not_to be_frozen # just to be sure
-      expect(marc_record.fields).not_to be_frozen # just to be sure
-      marc_record.fields.freeze
-      marc_record.leader.freeze
-      expect(marc_record).to be_frozen
-    end
-  end
-
   describe :data_fields do
     it 'returns only the data fields' do
       expected_tags = %w[024 035 245 336 505 505 505 505 505 505 540 852 856 856 901 902 902 980 982 991]
@@ -111,7 +75,8 @@ describe MARC::Record do
 
   describe :each_data_field do
     it 'returns only the data fields, in order' do
-      expect(marc_record.each_data_field.to_a).to eq(marc_record.data_fields)
+      each_data_field = marc_record.each_data_field
+      expect(each_data_field.to_a).to eq(marc_record.data_fields)
     end
 
     it 'groups fields by tag even when disordered' do
@@ -126,6 +91,16 @@ describe MARC::Record do
       df_852_ix = dff.find_index { |df| df.tag == '852' }
       expect(dff[df_852_ix, 3]).to eq([df_852, df_856_1, df_856_2])
     end
+
+    it 'returns a lazy enumerator if not passed a block' do
+      en = marc_record.each_data_field
+      expect(en).to be_a(Enumerator::Lazy)
+    end
+
+    it 'returns nil if passed a block' do
+      result = marc_record.each_data_field { |_| next }
+      expect(result).to be_nil
+    end
   end
 
   describe :each_sorted_by_tag do
@@ -140,6 +115,14 @@ describe MARC::Record do
       end
     end
 
+    it 'returns a lazy enumerator' do
+      en = marc_record.each_sorted_by_tag
+      expect(en).to be_a(Enumerator::Lazy)
+
+      en = marc_record.each_sorted_by_tag(tags)
+      expect(en).to be_a(Enumerator::Lazy)
+    end
+
     it 'returns only fields with the specified tags, sorted, in original order' do
       result = []
       marc_record.each_sorted_by_tag(tags) { |f| result << f }
@@ -149,6 +132,9 @@ describe MARC::Record do
     it 'returns nil if passed a block' do
       result = marc_record.each_sorted_by_tag(tags) { |_| next }
       expect(result).to be_nil
+
+      result = marc_record.each_sorted_by_tag { |_| next }
+      expect(result).to be_nil
     end
 
     it 'returns an enum if not passed a block' do
@@ -207,6 +193,16 @@ describe MARC::Record do
       expect(cff.size).to eq(expected_tags.size)
       expect(cff.map(&:tag)).to eq(expected_tags)
     end
+
+    it 'returns nil if passed a block' do
+      result = marc_record.each_control_field { |_| next }
+      expect(result).to be_nil
+    end
+
+    it 'returns a lazy enumerator if not passed a block' do
+      en = marc_record.each_control_field
+      expect(en).to be_a(Enumerator::Lazy)
+    end
   end
 
   describe :spec do

data/spec/marc_extensions/xml_reader_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+module MARC
+  describe XMLReader do
+    let(:infile_path) { 'spec/data/record-187888.xml' }
+    describe :new do
+      # not our first choice, but it's the ruby-marc default behavior
+      it 'returns a REXMLParser by default' do
+        reader = XMLReader.new(infile_path)
+        expect(reader).to be_a(REXMLReader)
+      end
+
+      it 'works with Nokogiri' do
+        reader = XMLReader.new(infile_path, { parser: 'nokogiri' })
+        expect(reader).to be_a(NokogiriReader)
+      end
+    end
+
+    describe :read do
+      it 'reads a file' do
+        reader = XMLReader.read(infile_path)
+        expect(reader).to be_a(MARC::XMLReader)
+        record = reader.first
+        expect(record).to be_a(MARC::Record)
+      end
+
+      describe 'freeze: true' do
+        it 'works with REXML' do
+          reader = XMLReader.read(infile_path, { parser: 'rexml', freeze: true })
+          expect(reader).to be_a(MARC::REXMLReader)
+          record = reader.first
+          expect(record).to be_a(MARC::Record)
+          expect(record).to be_frozen
+        end
+
+        it 'works with Nokogiri' do
+          reader = XMLReader.read(infile_path, { parser: 'nokogiri', freeze: true })
+          expect(reader).to be_a(MARC::NokogiriReader)
+          record = reader.first
+          expect(record).to be_a(MARC::Record)
+          expect(record).to be_frozen
+        end
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -7,14 +7,10 @@ require 'simplecov' if ENV['COVERAGE']
 # ------------------------------------------------------------
 # RSpec
 
-require 'webmock/rspec'
-
 RSpec.configure do |config|
   config.color = true
   config.tty = true
   config.formatter = :documentation
-  config.before(:each) { WebMock.disable_net_connect!(allow_localhost: true) }
-  config.after(:each) { WebMock.allow_net_connect! }
   config.mock_with :rspec do |mocks|
     mocks.verify_partial_doubles = true
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: berkeley_library-marc
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - David Moles
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-16 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marc
@@ -128,6 +128,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -241,19 +255,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 0.9.27
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 0.9.27
 description: A gem providing MARC-related utility code and extensions to ruby-marc
   for the UC Berkeley Library
 email: dmoles@berkeley.edu
@@ -330,6 +344,7 @@ files:
 - spec/data/record-187888.xml
 - spec/marc_extensions/data_field_spec.rb
 - spec/marc_extensions/record_spec.rb
+- spec/marc_extensions/xml_reader_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/BerkeleyLibrary/marc
 licenses:
@@ -350,7 +365,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: MARC utilities for the UC Berkeley Library
@@ -365,4 +380,5 @@ test_files:
 - spec/data/record-187888.xml
 - spec/marc_extensions/data_field_spec.rb
 - spec/marc_extensions/record_spec.rb
+- spec/marc_extensions/xml_reader_spec.rb
 - spec/spec_helper.rb