pennmarc 0.0.1

data/spec/spec_helper.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(__dir__) unless $LOAD_PATH.include?(__dir__)
+
+Dir[File.join(__dir__, 'support', '**', '*.rb')].sort.each { |f| require f }
+
+require 'pennmarc'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # This allows you to limit a spec run to individual examples or groups
+  #   # you care about by tagging them with `:focus` metadata. When nothing
+  #   # is tagged with `:focus`, all examples get run. RSpec also provides
+  #   # aliases for `it`, `describe`, and `context` that include `:focus`
+  #   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  #   config.filter_run_when_matching :focus
+  #
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   # https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = "doc"
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end

data/spec/support/marc_spec_helpers.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+require 'marc'
+
+module MarcSpecHelpers
+  # Return a MARC::XMLReader that will parse a given file and return MARC::Record objects
+  # @param [String] filename of MARCXML fixture
+  # @return [MARC::Record, NilClass]
+  def record_from(filename)
+    MARC::XMLReader.new(marc_xml_path(filename)).first
+  end
+
+  # Get the path for a test MARC XML file
+  # @param [String] filename of MARCXML fixture
+  # @return [String] full path of MARCXML fixture
+  def marc_xml_path(filename)
+    File.join File.dirname(__FILE__), '..', 'fixtures', 'marcxml', filename
+  end
+
+  # Create an isolated MARC::Subfield object for use in specs or as part of a MARC::Field
+  # @param [String] code
+  # @param [String] value
+  # @return [MARC::Subfield]
+  def marc_subfield(code, value)
+    MARC::Subfield.new code.to_s, value
+  end
+
+  # Return a new ControlField (000-009)
+  # @param [String] tag
+  # @param [String] value
+  # @return [MARC::ControlField]
+  def marc_control_field(tag:, value:)
+    MARC::ControlField.new tag, value
+  end
+
+  # Create an isolated MARC::DataField object for use in specs
+  # Can pass in tag, indicators and subfields (using simple hash structure). E.g.,
+  # marc_field(tag: '650', indicator2: '7'),
+  #            subfields: { a: 'Tax planning',
+  #                         m: ['Multiple', 'Subfields']
+  #                         z: 'United States.',
+  #                         '0': http://id.loc.gov/authorities/subjects/sh2008112546 }
+  #            )
+  # @param [String (frozen)] tag MARC tag, e.g., 001, 665
+  # @param [String (frozen)] indicator1 MARC indicator, e.g., 0
+  # @param [String (frozen)] indicator2
+  # @param [Hash] subfields hash of subfield values as code => value or code => [value, value]
+  # @return [MARC::DataField]
+  def marc_field(tag: 'TST', indicator1: ' ', indicator2: ' ', subfields: {})
+    subfield_objects = subfields.each_with_object([]) do |(code, value), array|
+      Array.wrap(value).map { |v| array << marc_subfield(code, v) }
+    end
+    MARC::DataField.new tag, indicator1, indicator2, *subfield_objects
+  end
+
+  # Return a MARC::Record containing passed in DataFields
+  # @param [Array<MARC::DataField>] fields
+  # @param [String, nil] leader
+  # @return [MARC::Record]
+  def marc_record(fields: [], leader: nil)
+    record = MARC::Record.new
+    fields.each { |field| record << field }
+    record.leader = leader if leader
+    record
+  end
+
+  # Mock map for location lookup using Location helper
+  # The location codes :dent and :stor are the two outermost keys
+  # :specific_location, :library, :display are the inner keys that store location values
+  # @example
+  #   location_map[:stor][:library] #=> 'LIBRA'
+  # @return [Hash]
+  def location_map
+    {
+      dent: {  specific_location: 'Levy Dental Medicine Library - Stacks',
+               library: ['Health Sciences Libraries', 'Levy Dental Medicine Library'],
+               display: 'Levy Dental Medicine Library - Stacks' },
+      stor: { specific_location: 'LIBRA',
+              library: 'LIBRA',
+              display: 'LIBRA' }
+    }
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: pennmarc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mike Kanning
+- Amrey Mathurin
+- Patrick Perkins
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: marc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: upennlib-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Penn Libraries Catalog MARC parsing wisdom for cross-project usage
+email: mkanning@upenn.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- legacy/indexer.rb
+- legacy/marc.rb
+- legacy/test_file_output.json
+- lib/pennmarc.rb
+- lib/pennmarc/encoding_level.rb
+- lib/pennmarc/enriched_marc.rb
+- lib/pennmarc/heading_control.rb
+- lib/pennmarc/helpers/citation.rb
+- lib/pennmarc/helpers/creator.rb
+- lib/pennmarc/helpers/database.rb
+- lib/pennmarc/helpers/date.rb
+- lib/pennmarc/helpers/edition.rb
+- lib/pennmarc/helpers/format.rb
+- lib/pennmarc/helpers/genre.rb
+- lib/pennmarc/helpers/helper.rb
+- lib/pennmarc/helpers/identifier.rb
+- lib/pennmarc/helpers/language.rb
+- lib/pennmarc/helpers/link.rb
+- lib/pennmarc/helpers/location.rb
+- lib/pennmarc/helpers/note.rb
+- lib/pennmarc/helpers/production.rb
+- lib/pennmarc/helpers/relation.rb
+- lib/pennmarc/helpers/series.rb
+- lib/pennmarc/helpers/subject.rb
+- lib/pennmarc/helpers/title.rb
+- lib/pennmarc/mappings/language.yml
+- lib/pennmarc/mappings/locations.yml
+- lib/pennmarc/mappings/relator.yml
+- lib/pennmarc/parser.rb
+- lib/pennmarc/util.rb
+- pennmarc.gemspec
+- spec/fixtures/marcxml/test.xml
+- spec/lib/pennmarc/helpers/citation_spec.rb
+- spec/lib/pennmarc/helpers/creator_spec.rb
+- spec/lib/pennmarc/helpers/database_spec.rb
+- spec/lib/pennmarc/helpers/date_spec.rb
+- spec/lib/pennmarc/helpers/edition_spec.rb
+- spec/lib/pennmarc/helpers/format_spec.rb
+- spec/lib/pennmarc/helpers/genre_spec.rb
+- spec/lib/pennmarc/helpers/identifer_spec.rb
+- spec/lib/pennmarc/helpers/language_spec.rb
+- spec/lib/pennmarc/helpers/location_spec.rb
+- spec/lib/pennmarc/helpers/note_spec.rb
+- spec/lib/pennmarc/helpers/production_spec.rb
+- spec/lib/pennmarc/helpers/relation_spec.rb
+- spec/lib/pennmarc/helpers/subject_spec.rb
+- spec/lib/pennmarc/helpers/title_spec.rb
+- spec/lib/pennmarc/marc_util_spec.rb
+- spec/lib/pennmarc/parser_spec.rb
+- spec/spec_helper.rb
+- spec/support/marc_spec_helpers.rb
+homepage: https://gitlab.library.upenn.edu/dld/catalog/pennmarc
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Penn Libraries Catalog MARC parsing wisdom for cross-project usage
+test_files: []