pennmarc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5480cac8bd9e0c8ae5fe096945f7dccb9c56730ee33f9fa35cee0aaee202fa6b
+  data.tar.gz: 38c4aa42f396b061cc7813320cc714081b85563fc9bf2f689588887018610863
+SHA512:
+  metadata.gz: e577b914ce87e01bdc5ddd95680b7e547398d40c12bda4f52ebf258abd80882b87bd53948dd306a3fa82935694eb57f0196c86819f602f5049d8932a5a8529e3
+  data.tar.gz: ede363f6fffbd352cd8cdb6ad97290f97a1bd14f7665788a82303c75625244d78d2ef301497d3892ff2c886e6c04e0fa8fd1685d6bfdf2bd78486155c79da117

data/.gitignore

@@ -0,0 +1,6 @@
+
+# Ignore YARD products
+.yardoc
+doc/
+
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Gemfile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'activesupport', '~> 7'
+gem 'library_stdnums', '~> 1.6'
+gem 'marc', '~> 1.2'
+gem 'nokogiri', '~> 1.15'
+gem 'rake', '~> 13.0'
+
+group :test, :development do
+  gem 'rspec', '~> 3.12'
+end
+
+group :test do
+  gem 'simplecov', '~> 0.22'
+end
+
+group :development do
+  gem 'upennlib-rubocop', require: false
+  gem 'webrick', '~> 1.8'
+  gem 'yard', '~> 0.9'
+end

data/Gemfile.lock

@@ -0,0 +1,119 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    i18n (1.13.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    library_stdnums (1.6.0)
+    marc (1.2.0)
+      rexml
+      scrub_rb (>= 1.0.1, < 2)
+      unf
+    minitest (5.18.0)
+    nokogiri (1.15.2-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.2-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    racc (1.6.2)
+    rack (3.0.7)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.51.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-performance (1.18.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.19.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.22.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    scrub_rb (1.0.1)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+    unicode-display_width (2.4.2)
+    upennlib-rubocop (1.1.0)
+      rubocop (~> 1.24)
+      rubocop-capybara
+      rubocop-performance
+      rubocop-rails
+      rubocop-rake
+      rubocop-rspec
+    webrick (1.8.1)
+    yard (0.9.34)
+
+PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  activesupport (~> 7)
+  library_stdnums (~> 1.6)
+  marc (~> 1.2)
+  nokogiri (~> 1.15)
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  simplecov (~> 0.22)
+  upennlib-rubocop
+  webrick (~> 1.8)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.4.10

data/README.md

@@ -0,0 +1,82 @@
+# Penn Libraries MARC Parser
+
+This gem embodies the received and newfound wisdom of Penn Libraries MARC parsing practice. The values returned by this
+parser should be agnostic about the particular discovery system in which it is included. Most of this was extracted from
+the "Nouveau Franklin" project aka [discovery_app](https://gitlab.library.upenn.edu/franklin/discovery-app).
+
+When included in a project, it should be utilized like this:
+
+```ruby
+parser = PennMARC::Parser.new # eventually we will pass in some mappings...
+puts parser.title_show(marc_record) # Title intended for display
+```
+
+All methods will require a `MARC::Record` object. For more about these, see the 
+[ruby-marc](https://github.com/ruby-marc/ruby-marc) gem documentation
+
+## Development
+
+### Requirements
+- ruby 3.2.2, other versions will probably work
+
+### Setup
+
+After cloning the repository and setting up Ruby for the project, run `bundle install` to install the gems.
+
+### Organization
+
+Classes in the `helpers` directory bring together common fields that may share logic. `PennMARC::Util` holds methods 
+used for common tasks such as joining subfields.
+
+### Documentation
+
+Highly descriptive and accurate documentation of MARC parsing practices will improve developer happiness, as well as 
+that of library collaborators. To this end, developers should utilize
+[YARD documentation syntax](https://rubydoc.info/gems/yard/file/docs/GettingStarted.md) as appropriate.
+
+A YARD documentation server can be run during development and will reload with updated docs as you work:
+
+```bash
+yard server --reload
+```
+
+When successful, the documentation pages will be available at [http://localhost:8808](http://localhost:8808).
+
+### Style
+
+This gem utilizes the [upennlib-rubocop](https://gitlab.library.upenn.edu/dld/upennlib-rubocop) 
+gem to enforce a consistent style.
+
+To run rubocop with the configuration:
+
+```bash
+rubocop
+```
+
+### Testing
+
+Testing is done with `rspec`. Test coverage should approach 100% given the relative simplicity of this gem.
+
+To run the test suite:
+
+```bash
+rspec
+```
+
+## QA
+
+### Checking output of an arbitrary MARC XML file
+
+TODO
+
+```bash
+MARC_FILE=path/to/marc.xml bundle exec rake pennmarc:parse
+```
+
+## TODO
+ - rake task or some similar command to return a full set of values extracted from a specified marcxml file
+ - hosting of yard output files?
+ - mappings (locations, call number, languages)
+ - Pipeline to run tests and publish to Rubygems
+    - rubocop check
+    - rdoc/yard coverage checks?