change_the_subject 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fc12151448eefb6c74b96cdf7d03425d0ac843e90da4608cf4e7567d568c238
-  data.tar.gz: a6d7852e260bb44a45c6e022278d6d1e3ea73bd80e1ec081a316a55d053e2084
+  metadata.gz: 93a323c7be102c29ca27cedee07f7586bc3e88fb5829b2b4841f8e8ec903aebc
+  data.tar.gz: 7355143afda00985700ff78493630baff96bdc3055c46dac4d64f79aa5b0c69a
 SHA512:
-  metadata.gz: e4b297cf2edd0feb9bf8b0fd7834a1a557ccf36b0c8c085c53544fc1879c894f2087bb479fcd18cd0d542ab0715629be9d62067ddc85d649e4b9d6646ac4c269
-  data.tar.gz: c58101d47e8f0640d6e20a870145b8eadcf10e7334e0abfbce6ea072ee2c179a7c18bd08ebe421946b7a1cbec19e609670783600d96a33c691dad103e6225e66
+  metadata.gz: efb4a20422392edf75953446de51330ef54056fb24397fe6f9a7c5f42d50164f94ffe492c43a521989b4da053199feca10b81498ceb71f308f7e9aff7a7d3fe1
+  data.tar.gz: a15d48cf4ce21d3d8fcd35ab8ae63c5dd6b9a58370635c946e1eb0224749826ea0323cd97f786b8f3be1c967a48101f3aa8d511f8ecd5745bf5a74dc27cbd679

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    change_the_subject (0.3.2)
+    change_the_subject (0.3.3)
       yaml
 
 GEM

data/README.md

@@ -1,8 +1,8 @@
 # ChangeTheSubject
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/change_the_subject`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem is currently used to mask outdated Library of Congress Subject Headings in two different public access catalogs - [Princeton University Library Catalog](https://catalog.princeton.edu/) and [Princeton University Library Finding Aids](https://findingaids.princeton.edu/).
 
-TODO: Delete this and the text above, and describe your gem
+The code for this gem started in the [bibdata codebase](https://github.com/pulibrary/bibdata), the application that prepares metadata for use by the Catalog, and you can [see the gem's earlier history there](https://github.com/pulibrary/bibdata/commits/590d2437126150d66e40393724f9e11ba95c3328/marc_to_solr/lib/change_the_subject.rb).
 
 ## Installation
 
@@ -21,8 +21,15 @@ Or install it yourself as:
     $ gem install change_the_subject
 
 ## Usage
+The main api of the gem is the `ChangeTheSubject.fix` method, which takes an array of subject terms, compares them to the configuration (the default is in `config/change_the_subject.yml`), and replaces the configured terms. You can see how Bibdata uses the gem in its [traject_config.rb](https://github.com/pulibrary/bibdata/blob/main/marc_to_solr/lib/traject_config.rb).
 
-TODO: Write usage instructions here
+```ruby
+original_subjects = ["Something problematic", "Something not problematic"]
+subjects = ChangeTheSubject.fix(subject_terms: original_subjects)
+# outputs ["Something not problematic from config", "Something not problematic"]
+```
+
+The `ChangeTheSubject.fix` method also takes an optional `separators` argument, which you can [see in use in Pulfalight's implementation for eads](https://github.com/pulibrary/pulfalight/blob/main/lib/pulfalight/traject/ead2_config.rb).
 
 ## Development
 
@@ -31,5 +38,6 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
+The configuration for this gem is managed by the Inclusive and Reparative Metadata Working Group (IRMWG). Send questions or comments about the configuration to harmfullanguage@princeton.libanswers.com.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/change_the_subject.
+Bug reports and pull requests are welcome on GitHub at https://github.com/pulibrary/change_the_subject.

data/config/change_the_subject.yml

@@ -50,7 +50,7 @@
   replacement: "Enslaved children"
   rationale: "In addition to its usage by TRLN, this term falls in line with recommendations included in the community-sourced document P. Gabrielle Foreman, et al. \"Writing about Slavery/Teaching About Slavery: This Might Help\" and Archives for Black Lives in Philadelphia Anti-Racist Description Resources."
 "Indian slaves":
-  replacement: "Enslaved indigenous peoples"
+  replacement: "Enslaved Indigenous peoples"
   rationale: "In addition to its usage by TRLN, this term falls in line with recommendations included in the community-sourced document P. Gabrielle Foreman, et al. \"Writing about Slavery/Teaching About Slavery: This Might Help.\" Capitalization of \"Indigenous\" appears to be preferred by those from Indigenous communities, for example see https://www.lib.sfu.ca/about/branches-depts/slc/writing/inclusive-antiracist-writing/bipoc and https://www.ictinc.ca/blog/indigenous-peoples-terminology-guidelines-for-usage.  As this is a broad term, when possible, one should include the name of the community(ies) or nation(s) of the people in the record. "
 "Older slaves":
   replacement: "Enslaved older people"

data/lib/change_the_subject/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class ChangeTheSubject
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: change_the_subject
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Max Kadel
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-02 00:00:00.000000000 Z
+date: 2023-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yaml