berkeley_library-marc 0.2.0

data/spec/marc_extensions/data_field_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe MARC::DataField do
+  let(:marc_record) { MARC::XMLReader.read('spec/data/record-187888.xml').first }
+
+  describe :subfield_codes do
+    it 'returns the subfield codes in order' do
+      expected_codes = %w[y 9 s u]
+
+      expect(marc_record['856'].subfield_codes).to eq(expected_codes)
+    end
+  end
+end

data/spec/marc_extensions/record_spec.rb

@@ -0,0 +1,211 @@
+require 'spec_helper'
+
+describe MARC::Record do
+  let(:marc_record) { MARC::XMLReader.read('spec/data/record-187888.xml').first }
+
+  describe :record_id do
+    it 'returns the 001 control field value, if present' do
+      expect(marc_record.record_id).to eq('187888')
+    end
+  end
+
+  describe :freeze do
+    it 'freezes the fields' do
+      expect(marc_record.fields).not_to be_frozen # just to be sure
+      marc_record.freeze
+      expect(marc_record.fields).to be_frozen
+    end
+
+    it 'freezes the leader' do
+      expect(marc_record.leader).not_to be_frozen # just to be sure
+      marc_record.freeze
+      expect(marc_record.leader).to be_frozen
+    end
+
+    it 'freezes the fields' do
+      marc_record.freeze
+      marc_record.fields.each do |df|
+        expect(df).to be_frozen
+      end
+    end
+
+    it 'does not clobber the data' do
+      expected = marc_record.to_hash
+      marc_record.freeze
+      expect(marc_record.to_hash).to eq(expected)
+    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]
+      dff = marc_record.data_fields
+      expect(dff.size).to eq(expected_tags.size)
+      expect(dff.map(&:tag)).to eq(expected_tags)
+    end
+
+    it 'returns the data fields in order as they appear' do
+      dff = marc_record.data_fields
+      dff_856 = dff.select { |df| df.tag == '856' }
+      expect(dff_856.size).to eq(2) # just to be sure
+      expected_sf9_values = %w[4a939fe2-2665-4c67-832b-b0e5267db449 0aacdd29-b467-4c5c-93ab-415069f431c0]
+      expected_sf9_values.each_with_index do |expected, i|
+        expect(dff_856[i]['9']).to eq(expected)
+      end
+    end
+
+    it 'groups fields by tag even when disordered' do
+      fields = marc_record.fields
+
+      df_852_ix = fields.find_index { |df| df.tag == '852' }
+      df_852 = fields.delete_at(df_852_ix)
+      expect(df_852.tag).to eq('852') # just to be sure
+
+      df_856_1, df_856_2 = fields[df_852_ix, 2]
+      [df_856_1, df_856_2].each { |df| expect(df.tag).to eq('856') } # just to be sure
+
+      fields.insert(df_852_ix + 1, df_852)
+      expect(fields[df_852_ix, 3]).to eq([df_856_1, df_852, df_856_2]) # just to be sure
+
+      dff = marc_record.data_fields
+      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
+  end
+
+  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)
+    end
+
+    it 'groups fields by tag even when disordered' do
+      fields = marc_record.fields
+
+      df_852_ix = fields.find_index { |df| df.tag == '852' }
+      df_852 = fields.delete_at(df_852_ix)
+      df_856_1, df_856_2 = fields[df_852_ix, 2]
+      fields.insert(df_852_ix + 1, df_852)
+
+      dff = marc_record.each_data_field.to_a
+      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
+  end
+
+  describe :each_sorted_by_tag do
+    let(:tags) do
+      %w[856 852] # NOTE: not sorted
+    end
+
+    let(:expected) do
+      [].tap do |ff|
+        ff << marc_record['852']
+        marc_record.each_by_tag('856') { |f| ff << f }
+      end
+    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 }
+      expect(result).to eq(expected)
+    end
+
+    it 'returns nil if passed a block' do
+      result = marc_record.each_sorted_by_tag(tags) { |_| next }
+      expect(result).to be_nil
+    end
+
+    it 'returns an enum if not passed a block' do
+      enum = marc_record.each_sorted_by_tag(tags)
+      expect(enum).to be_a(Enumerator::Lazy)
+      expect(enum.to_a).to eq(expected)
+    end
+  end
+
+  describe :data_fields_by_tag do
+    it 'groups fields by tag' do
+      fields = marc_record.fields
+
+      df_852_ix = fields.find_index { |df| df.tag == '852' }
+      df_852 = fields.delete_at(df_852_ix)
+      fields.insert(df_852_ix + 1, df_852)
+
+      t2df = marc_record.data_fields_by_tag
+      expect(t2df).to be_a(Hash)
+
+      expected = {
+        '024' => 1, '035' => 1,
+        '245' => 1,
+        '336' => 1,
+        '505' => 6, '540' => 1,
+        '852' => 1, '856' => 2,
+        '901' => 1, '902' => 2, '980' => 1, '982' => 1, '991' => 1
+      }
+
+      expected.each do |tag, count|
+        dff = t2df[tag]
+        expect(dff).to be_a(Array)
+        expect(dff.size).to eq(count)
+        dff.each { |df| expect(df.tag).to eq(tag) }
+      end
+    end
+
+    describe :each_sorted_by_tag do
+      it 'returns all tags if not passed a tag list' do
+        fields = marc_record.fields
+
+        expected = fields.each_with_object({}) do |f, ex|
+          (ex[f.tag] ||= []) << f
+        end.values.flatten
+
+        enum = marc_record.each_sorted_by_tag
+        expect(enum.to_a).to eq(expected)
+      end
+    end
+  end
+
+  describe :each_control_field do
+    it 'returns only the control fields' do
+      expected_tags = %w[001 005]
+      cff = marc_record.each_control_field.to_a
+      expect(cff.size).to eq(expected_tags.size)
+      expect(cff.map(&:tag)).to eq(expected_tags)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# ------------------------------------------------------------
+# Simplecov
+
+require 'colorize'
+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
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end
+
+# ------------------------------------------------------------
+# Code under test
+
+require 'berkeley_library/marc'

metadata

@@ -0,0 +1,354 @@
+--- !ruby/object:Gem::Specification
+name: berkeley_library-marc
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- David Moles
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: marc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundle-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: ci_reporter_rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+description: A gem providing MARC-related utility code and extensions to ruby-marc
+  for the UC Berkeley Library
+email: dmoles@berkeley.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/build.yml"
+- ".gitignore"
+- ".idea/inspectionProfiles/Project_Default.xml"
+- ".idea/marc.iml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/vcs.xml"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".simplecov"
+- ".yardopts"
+- CHANGES.md
+- Dockerfile
+- Gemfile
+- Jenkinsfile
+- LICENSE.md
+- README.md
+- Rakefile
+- berkeley_library-marc.gemspec
+- docker-compose.yml
+- lib/.rubocop.yml
+- lib/berkeley_library/marc.rb
+- lib/berkeley_library/marc/field_info.rb
+- lib/berkeley_library/marc/field_info/ctrl_fields/data/ctrl_fields_standard.txt
+- lib/berkeley_library/marc/field_info/leader/data/leader_standard.txt
+- lib/berkeley_library/marc/field_info/var_fields.rb
+- lib/berkeley_library/marc/field_info/var_fields/data.rb
+- lib/berkeley_library/marc/field_info/var_fields/data/mapping-orig.tsv
+- lib/berkeley_library/marc/field_info/var_fields/data/var_fields_berkeley_9xx.txt
+- lib/berkeley_library/marc/field_info/var_fields/data/var_fields_berkeley_9xx_parsed.rb
+- lib/berkeley_library/marc/field_info/var_fields/data/var_fields_standard.txt
+- lib/berkeley_library/marc/field_info/var_fields/data/var_fields_standard_parsed.rb
+- lib/berkeley_library/marc/field_info/var_fields/data/var_fields_tind_reserved.txt
+- lib/berkeley_library/marc/field_info/var_fields/data/var_fields_tind_reserved_parsed.rb
+- lib/berkeley_library/marc/field_info/var_fields/data/var_fields_ucblit_tind.txt
+- lib/berkeley_library/marc/field_info/var_fields/data/var_fields_ucblit_tind_parsed.rb
+- lib/berkeley_library/marc/field_info/var_fields/ind_def.rb
+- lib/berkeley_library/marc/field_info/var_fields/ind_val_def.rb
+- lib/berkeley_library/marc/field_info/var_fields/instrument_or_voices_code.rb
+- lib/berkeley_library/marc/field_info/var_fields/obsolescible.rb
+- lib/berkeley_library/marc/field_info/var_fields/section.rb
+- lib/berkeley_library/marc/field_info/var_fields/subfield_def.rb
+- lib/berkeley_library/marc/field_info/var_fields/subfield_val.rb
+- lib/berkeley_library/marc/field_info/var_fields/var_field_def.rb
+- lib/berkeley_library/marc/field_info/var_fields/var_field_list.rb
+- lib/berkeley_library/marc/field_info/var_fields/var_field_parser.rb
+- lib/berkeley_library/marc/field_info/var_fields/var_field_transform.rb
+- lib/berkeley_library/marc/module_info.rb
+- lib/marc_extensions.rb
+- lib/marc_extensions/data_field.rb
+- lib/marc_extensions/field_map.rb
+- lib/marc_extensions/record.rb
+- lib/marc_extensions/subfield.rb
+- lib/marc_extensions/xml_reader.rb
+- rakelib/bundle.rake
+- rakelib/coverage.rake
+- rakelib/gem.rake
+- rakelib/rubocop.rake
+- rakelib/spec.rake
+- spec/.rubocop.yml
+- spec/berkeley_library/marc/field_info/var_fields/var_field_def_spec.rb
+- spec/berkeley_library/marc/field_info/var_fields/var_field_parser_spec.rb
+- spec/berkeley_library/marc/field_info/var_fields/var_field_transform_spec.rb
+- spec/berkeley_library/marc/field_info/var_fields_spec.rb
+- spec/data/field_info/vf_046.txt
+- spec/data/field_info/vf_048.txt
+- spec/data/record-187888.xml
+- spec/marc_extensions/data_field_spec.rb
+- spec/marc_extensions/record_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/BerkeleyLibrary/marc
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: MARC utilities for the UC Berkeley Library
+test_files:
+- spec/.rubocop.yml
+- spec/berkeley_library/marc/field_info/var_fields/var_field_def_spec.rb
+- spec/berkeley_library/marc/field_info/var_fields/var_field_parser_spec.rb
+- spec/berkeley_library/marc/field_info/var_fields/var_field_transform_spec.rb
+- spec/berkeley_library/marc/field_info/var_fields_spec.rb
+- spec/data/field_info/vf_046.txt
+- spec/data/field_info/vf_048.txt
+- spec/data/record-187888.xml
+- spec/marc_extensions/data_field_spec.rb
+- spec/marc_extensions/record_spec.rb
+- spec/spec_helper.rb