berkeley_library-marc 0.2.0

data/lib/berkeley_library/marc/field_info/var_fields/data/var_fields_tind_reserved.txt

@@ -0,0 +1,44 @@
+// Adapted from https://docs.tind.io/article/vwihxqwp67-marc-fields-used-by-tind
+// Retrieved 2021-01-15
+
+// Note: this only includes fields relevant to our TIND/DA implementation.
+
+035 - EXTERNAL IDENTIFIER (NR)
+   Indicators
+      First - Undefined
+         # - Undefined
+      Second - Undefined
+         # - Undefined
+   Subfield Codes
+      $a - External identifier (NR)
+
+// TODO: is (NR) correct for $p and $q?
+909 - OAI REPOSITORY METADATA (NR)
+  Indicators
+     First - ???
+        C - ??? // Yes, caps should be invalid; yes, TIND does it anyway
+     Second - ???
+        0 - ???
+  Subfield Codes
+     $o - OAI URI for the record (oai:<hostname>:<record ID>) (NR)
+     $p - setSpec for current valid sets (NR)
+     $q - setSpec for previously valid sets (NR)
+
+// TODO: is (R) correct here?
+980 - COLLECTION QUERY TAG (R)
+   Indicators
+      First - Undefined
+         # - Undefined
+      Second - Undefined
+         # - Undefined
+   Subfield Codes
+      $a - Collection identifier
+
+991 - RESTRICTION STATUS (NR)
+   Indicators
+      First - Undefined
+         # - Undefined
+      Second - Undefined
+         # - Undefined
+   Subfield Codes
+      $a - Restriction tag

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

@@ -0,0 +1,30 @@
+module BerkeleyLibrary
+  module Marc
+    module FieldInfo
+      module VarFields
+        TIND_RESERVED_PARSED =
+          [{ doc_comments: [{ comment: 'Adapted from https://docs.tind.io/article/vwihxqwp67-marc-fields-used-by-tind' },
+                            { comment: 'Retrieved 2021-01-15' }] },
+           { comment: 'Note: this only includes fields relevant to our TIND/DA implementation.' },
+           { sections: [{ var_fields: [{ tag: '035',
+                                         desc: 'EXTERNAL IDENTIFIER (NR)',
+                                         indicators: [{ desc: 'Undefined',
+                                                        ind1: [{ val: '#', desc: 'Undefined' }] },
+                                                      { desc: 'Undefined',
+                                                        ind2: [{ val: '#', desc: 'Undefined' }] }],
+                                         subfield_codes: [{ code: 'a',
+                                                            desc: 'External identifier (NR)',
+                                                            values: [] }] },
+                                       { tag: '991',
+                                         desc: 'RESTRICTION STATUS (NR)',
+                                         indicators: [{ desc: 'Undefined',
+                                                        ind1: [{ val: '#',
+                                                                 desc: 'Undefined' }] },
+                                                      { desc: 'Undefined',
+                                                        ind2: [{ val: '#', desc: 'Undefined' }] }],
+                                         subfield_codes: [{ code: 'a', desc: 'Restriction tag',
+                                                            values: [] }] }] }] }].freeze
+      end
+    end
+  end
+end

data/lib/berkeley_library/marc/field_info/var_fields/data/var_fields_ucblit_tind.txt

@@ -0,0 +1,105 @@
+// Adapted from https://docs.google.com/spreadsheets/d/1QbIxsJGosgzKYBXhDhJJlTZtvCRjz75TRecn1cbDhm8/edit
+// Retrieved 2021-01-15
+
+// TODO: check Google Sheets automatically for updates
+
+852 - LOCATION (R)
+   Indicators
+      First - Undefined
+         # - Undefined
+      Second - Undefined
+         # - Undefined
+   Subfield Codes
+      $c - Location/Archive/Repository
+
+901 - IDENTIFIERS [INTERNAL] (NR) [REQUIRED WHEN APPLICABLE]
+   Indicators
+      First - Undefined
+         # - Undefined
+      Second - Undefined
+         # - Undefined
+   Subfield Codes
+      $a - Ark identifier for METS file [REQUIRED WHEN APPLICABLE]
+      $f - Ark identifier for finding aid
+      $g - PJID:DBID from GenDB [REQUIRED WHEN APPLICABLE]
+      $m - Millennium record number
+      $o - OCLC Number
+
+902 - RECORD CREATION DETAILS [INTERNAL] (NR) [REQUIRED]
+   Indicators
+      First - Undefined
+         # - Undefined
+      Second - Undefined
+         # - Undefined
+   Subfield Codes
+      $d - Date of batch file creation [REQUIRED]
+      $f - METS filename or other file used as source of data [REQUIRED WHEN APPLICABLE]
+      $n - Batch uploader's initials [REQUIRED]
+      $p - Description of the process and programs used
+
+903 - BIBLIOGRAPHIC CODES FROM MARC RECORD (NR)
+   Indicators
+      First - Undefined
+         # - Undefined
+      Second - Undefined
+         # - Undefined
+   Subfield Codes
+      $b - Bibliographic codes
+
+950 - Local/Administrative Notes (R)
+   Indicators
+      First - Undefined
+         # - Undefined
+      Second - Undefined
+         # - Undefined
+   Subfield Codes
+      $a - Notes
+      $3 - Note type
+
+982 - COLLECTION / PROJECT NAME (R) [REQUIRED]
+   Indicators
+      First - Undefined
+         # - Undefined
+      Second - Undefined
+         # - Undefined
+   Subfield Codes
+      $a - Short collection name (displays in facet) [REQUIRED]
+      $b - Long collection name (displays in record) [REQUIRED]
+      $p - Project Name
+
+991 - RESTRICTION STATUS (NR)
+   Indicators
+      First - Undefined
+         # - Undefined
+      Second - Undefined
+         # - Undefined
+   Subfield Codes
+      $a - Restricted collection identifier
+
+998 - AV TRACK INFO (R)
+   Indicators
+      First - Undefined
+         # - Undefined
+      Second - Undefined
+         # - Undefined
+   Subfield Codes
+      $a - Duration (hh:mm:ss)
+      $t - Title
+      $g - Relative path [REQUIRED]
+
+// Note: 856 is not documented in the spreadsheet, but inferred from use
+
+856 - ELECTRONIC LOCATION AND ACCESS (R)
+   Indicators
+      First - Access method
+         4 - HTTP
+      Second - Relationship
+         # - Content file
+         1 - Library catalog record
+         2 - Related resource
+   Subfield Codes
+      $s - File size (NR)
+      $u - Uniform Resource Identifier (NR) [REQUIRED]
+      $y - Link text (NR)
+      $z - Comment (NR)
+      $9 - Checksum (NR)

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

@@ -0,0 +1,114 @@
+# rubocop:disable Metrics/ModuleLength
+module BerkeleyLibrary
+  module Marc
+    module FieldInfo
+      module VarFields
+        UCBLIT_TIND_PARSED =
+          [{ doc_comments: [{ comment: 'Adapted from https://docs.google.com/spreadsheets/d/1QbIxsJGosgzKYBXhDhJJlTZtvCRjz75TRecn1cbDhm8/edit' },
+                            { comment: 'Retrieved 2021-01-15' }] },
+           { comment: 'TODO: check Google Sheets automatically for updates' },
+           { sections: [{ var_fields: [{ tag: '852',
+                                         desc: 'LOCATION (R)',
+                                         indicators: [{ desc: 'Undefined',
+                                                        ind1: [{ val: '#', desc: 'Undefined' }] },
+                                                      { desc: 'Undefined',
+                                                        ind2: [{ val: '#', desc: 'Undefined' }] }],
+                                         subfield_codes: [{ code: 'c',
+                                                            desc: 'Location/Archive/Repository',
+                                                            values: [] }] },
+                                       { tag: '901',
+                                         desc: 'IDENTIFIERS [INTERNAL] (NR) [REQUIRED WHEN APPLICABLE]',
+                                         indicators: [{ desc: 'Undefined',
+                                                        ind1: [{ val: '#',
+                                                                 desc: 'Undefined' }] },
+                                                      { desc: 'Undefined',
+                                                        ind2: [{ val: '#', desc: 'Undefined' }] }],
+                                         subfield_codes: [{ code: 'a',
+                                                            desc: 'Ark identifier for METS file [REQUIRED WHEN APPLICABLE]',
+                                                            values: [] },
+                                                          { code: 'f',
+                                                            desc: 'Ark identifier for finding aid',
+                                                            values: [] },
+                                                          { code: 'g',
+                                                            desc: 'PJID:DBID from GenDB [REQUIRED WHEN APPLICABLE]',
+                                                            values: [] },
+                                                          { code: 'm', desc: 'Millennium record number', values: [] },
+                                                          { code: 'o', desc: 'OCLC Number', values: [] }] },
+                                       { tag: '902',
+                                         desc: 'RECORD CREATION DETAILS [INTERNAL] (NR) [REQUIRED]',
+                                         indicators: [{ desc: 'Undefined',
+                                                        ind1: [{ val: '#',
+                                                                 desc: 'Undefined' }] },
+                                                      { desc: 'Undefined',
+                                                        ind2: [{ val: '#', desc: 'Undefined' }] }],
+                                         subfield_codes: [{ code: 'd',
+                                                            desc: 'Date of batch file creation [REQUIRED]',
+                                                            values: [] },
+                                                          { code: 'f',
+                                                            desc: 'METS filename or other file used as source of data [REQUIRED WHEN APPLICABLE]',
+                                                            values: [] },
+                                                          { code: 'n',
+                                                            desc: "Batch uploader's initials [REQUIRED]",
+                                                            values: [] },
+                                                          { code: 'p',
+                                                            desc: 'Description of the process and programs used',
+                                                            values: [] }] },
+                                       { tag: '903',
+                                         desc: 'BIBLIOGRAPHIC CODES FROM MARC RECORD (NR)',
+                                         indicators: [{ desc: 'Undefined',
+                                                        ind1: [{ val: '#',
+                                                                 desc: 'Undefined' }] },
+                                                      { desc: 'Undefined',
+                                                        ind2: [{ val: '#', desc: 'Undefined' }] }],
+                                         subfield_codes: [{ code: 'b', desc: 'Bibliographic codes',
+                                                            values: [] }] },
+                                       { tag: '950',
+                                         desc: 'Local/Administrative Notes (R)',
+                                         indicators: [{ desc: 'Undefined',
+                                                        ind1: [{ val: '#',
+                                                                 desc: 'Undefined' }] },
+                                                      { desc: 'Undefined',
+                                                        ind2: [{ val: '#', desc: 'Undefined' }] }],
+                                         subfield_codes: [{ code: 'a', desc: 'Notes', values: [] },
+                                                          { code: '3', desc: 'Note type', values: [] }] },
+                                       { tag: '982',
+                                         desc: 'COLLECTION / PROJECT NAME (R) [REQUIRED]',
+                                         indicators: [{ desc: 'Undefined',
+                                                        ind1: [{ val: '#',
+                                                                 desc: 'Undefined' }] },
+                                                      { desc: 'Undefined',
+                                                        ind2: [{ val: '#', desc: 'Undefined' }] }],
+                                         subfield_codes: [{ code: 'a',
+                                                            desc: 'Short collection name (displays in facet) [REQUIRED]',
+                                                            values: [] },
+                                                          { code: 'b',
+                                                            desc: 'Long collection name (displays in record) [REQUIRED]',
+                                                            values: [] },
+                                                          { code: 'p', desc: 'Project Name', values: [] }] },
+                                       { tag: '991',
+                                         desc: 'RESTRICTION STATUS (NR)',
+                                         indicators: [{ desc: 'Undefined',
+                                                        ind1: [{ val: '#',
+                                                                 desc: 'Undefined' }] },
+                                                      { desc: 'Undefined',
+                                                        ind2: [{ val: '#', desc: 'Undefined' }] }],
+                                         subfield_codes: [{ code: 'a',
+                                                            desc: 'Restricted collection identifier',
+                                                            values: [] }] },
+                                       { tag: '998',
+                                         desc: 'AV TRACK INFO (R)',
+                                         indicators: [{ desc: 'Undefined',
+                                                        ind1: [{ val: '#',
+                                                                 desc: 'Undefined' }] },
+                                                      { desc: 'Undefined',
+                                                        ind2: [{ val: '#', desc: 'Undefined' }] }],
+                                         subfield_codes: [{ code: 'a', desc: 'Duration (hh:mm:ss)', values: [] },
+                                                          { code: 't', desc: 'Title', values: [] },
+                                                          { code: 'g',
+                                                            desc: 'Relative path [REQUIRED]',
+                                                            values: [] }] }] }] }].freeze
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/ModuleLength

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

@@ -0,0 +1,39 @@
+require 'berkeley_library/marc/field_info/var_fields/ind_val_def'
+require 'berkeley_library/marc/field_info/var_fields/obsolescible'
+
+module BerkeleyLibrary
+  module Marc
+    module FieldInfo
+      module VarFields
+        class IndDef
+          # TODO: include Comparable
+          include Obsolescible
+
+          POS_NAMES = { 1 => 'First', 2 => 'Second' }.freeze
+
+          attr_reader :pos
+          attr_reader :desc
+          attr_reader :val_defs
+
+          def initialize(pos:, desc:, val_defs:)
+            raise ArgumentError, "Not a valid indicator position: #{pos.inspect}" unless [1, 2].include?(pos)
+
+            @pos = pos
+            @desc = desc
+            @val_defs = val_defs
+          end
+
+          def reject_obsoletes
+            IndDef.new(pos: pos, desc: desc, val_defs: _reject_obsolete(val_defs))
+          end
+
+          def to_s
+            lines = ["#{POS_NAMES[pos]} - #{desc}"]
+            val_defs.each { |v| lines << "   #{v}" }
+            lines.join("\n")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+require 'berkeley_library/marc/field_info/var_fields/obsolescible'
+
+module BerkeleyLibrary
+  module Marc
+    module FieldInfo
+      module VarFields
+        class IndValDef
+          # TODO: include Comparable
+          include Obsolescible
+
+          attr_reader :val
+          attr_reader :desc
+
+          # TODO: destructure range values in some useful way (e.g. 130)
+          def initialize(val:, desc:)
+            @val = val
+            @desc = desc
+          end
+
+          def to_s
+            "#{val} - #{desc}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require 'berkeley_library/marc/field_info/var_fields/obsolescible'
+
+module BerkeleyLibrary
+  module Marc
+    module FieldInfo
+      module VarFields
+        class InstrumentOrVoicesCode
+          # TODO: include Comparable
+          include Obsolescible
+
+          attr_reader :val
+          attr_reader :desc
+
+          def initialize(val:, desc:)
+            @val = val
+            @desc = desc
+          end
+
+          def to_s
+            "#{val} - #{desc}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+module BerkeleyLibrary
+  module Marc
+    module FieldInfo
+      module VarFields
+        # Mixin for possibly-obsolete members of a MARC field info tree
+        module Obsolescible
+
+          # Description marker for obsolete elements in a MARC field list
+          OBSOLETE = '[OBSOLETE]'.freeze
+
+          # Return true if this Obsolescible's description marks
+          # it as obsolete, false otherwise
+          # @return [Boolean] true if obsolete, false otherwise
+          def obsolete?
+            return unless respond_to?(:desc)
+
+            desc&.include?(OBSOLETE)
+          end
+
+          # Return a copy of this object with all obsolete nodes
+          # in its subtree removed, or the object itself if it has
+          # no descendants. Note that in the (pathological) situation
+          # of a non-obsolete, non-leaf node with no non-obsolete
+          # descendants, an empty object will be returned.
+          def reject_obsoletes
+            # default implementation for leaf nodes
+            self
+          end
+
+          # Return true if this object's subtree is empty, false if
+          # this object is a leaf node or has a non-empty subtree.
+          def empty?
+            # default implementation for leaf nodes
+            false
+          end
+
+          protected
+
+          # Utility method for deep-rejecting obsolete members and their
+          # obsolete descendants from a list of Obsolescibles.
+          # @param obs [Array<Obsolescible>] a list of Obsolescibles.
+          # @return [Array<Obsolescible>] a filtered list with no obsolete nodes,
+          #   and no non-leaf nodes with only obsolete descendants
+          def _reject_obsolete(obs)
+            obs.lazy
+              .reject(&:obsolete?)
+              .map(&:reject_obsoletes)
+              .reject(&:empty?)
+              .to_a
+          end
+        end
+      end
+    end
+  end
+end