berkeley_library-tind 0.4.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbfd8d5b1299063dc4986ae86860bcd050d64f4d22d1592f6373f8cf9c661fd9
-  data.tar.gz: fefc0570733f3116aae9fe5377773d7fb327ba4f71ccfa15399bf5dae8a67ac5
+  metadata.gz: ade606682d0d814a4debfbe0be2a6741ae72977d710511d5df70118569dea764
+  data.tar.gz: 2da4f7cd4b7f0c1cf6f8dcf9bf3346d89599e9130f28a185cb0cab0a37a39d3d
 SHA512:
-  metadata.gz: 43a3e9e88ddacc0c37619b49b223a6fe4967d2bd13fb7a493514a72e7903cd0f54bfb92c052e347e4aebbf5cd33106410f39dff81936f606d25df21e7dc1f000
-  data.tar.gz: a0295b58cb6139205ccfc7e381f1c0111d8e125ab55b5d1109d467fee59b5a80436e06b2c6a77c1c11c6e38962ee19f91695640800658a00ba054608be423d56
+  metadata.gz: ed708269e8c628616c89643c49cb3394401febf8f9a0f4defde88abad17a8ac2f5b43663345cd0513aa2e7b02e41fb3475446f55aa7ad394aa83ad62ae114565
+  data.tar.gz: b4f851305ad936b9f7cb46c8a521358cdfff34f51aebfb6d121481545777476af8adce6c3b8c0042aeaeca2ee00a7d1826f955f46ee5ad1f11361c7ed1843b72

data/.github/workflows/build.yml

@@ -1,5 +1,5 @@
 name: Build
-on: [ push, pull_request ]
+on: [ push, pull_request, workflow_dispatch ]
 jobs:
   test:
     strategy:
@@ -10,9 +10,21 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
-      - uses: actions/checkout@v2
-      - uses: ruby/setup-ruby@v1
+      - name: Check out repository
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-      - run: bundle exec rake
+
+      - name: Run checks
+        run: bundle exec rake
+
+      - name: Upload artifacts
+        if: ${{ always() }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: artifacts
+          path: artifacts/**

data/.gitignore

@@ -7,6 +7,9 @@
 # Additional IDEA/RubyMine ignores
 .idea/.rakeTasks
 
+# Visual Studio Code ignores
+.vscode
+
 # Don't commit Gemfile.lock for libraries
 Gemfile.lock
 

data/.idea/inspectionProfiles/Project_Default.xml

@@ -10,6 +10,14 @@
     <inspection_tool class="LanguageDetectionInspection" enabled="false" level="WARNING" enabled_by_default="false" />
     <inspection_tool class="Rubocop" enabled="false" level="WARNING" enabled_by_default="false" />
     <inspection_tool class="RubyCaseWithoutElseBlockInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="RubyClassMethodNamingConvention" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
+    <inspection_tool class="RubyClassModuleNamingConvention" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
+    <inspection_tool class="RubyClassVariableNamingConvention" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
+    <inspection_tool class="RubyConstantNamingConvention" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
+    <inspection_tool class="RubyGlobalVariableNamingConvention" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
+    <inspection_tool class="RubyInstanceMethodNamingConvention" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
+    <inspection_tool class="RubyInstanceVariableNamingConvention" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
+    <inspection_tool class="RubyLocalVariableNamingConvention" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
     <inspection_tool class="RubyMismatchedArgumentType" enabled="true" level="WARNING" enabled_by_default="true">
       <option name="myCheckNilability" value="false" />
     </inspection_tool>
@@ -28,6 +36,8 @@
     <inspection_tool class="RubyMismatchedVariableType" enabled="true" level="WARNING" enabled_by_default="true">
       <option name="myCheckNilability" value="false" />
     </inspection_tool>
+    <inspection_tool class="RubyNilAnalysis" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
+    <inspection_tool class="RubyParameterNamingConvention" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
     <inspection_tool class="RubyStringKeysInHashInspection" enabled="true" level="INFORMATION" enabled_by_default="true" />
     <inspection_tool class="SpellCheckingInspection" enabled="false" level="TYPO" enabled_by_default="false">
       <option name="processCode" value="true" />

data/.idea/tind.iml

@@ -9,13 +9,14 @@
     </content>
     <orderEntry type="jdk" jdkName="RVM: ruby-2.7.5" jdkType="RUBY_SDK" />
     <orderEntry type="sourceFolder" forTests="false" />
-    <orderEntry type="library" scope="PROVIDED" name="actionpack (v6.1.4.4, RVM: ruby-2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="actionview (v6.1.4.4, RVM: ruby-2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="activesupport (v6.1.4.4, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="actionpack (v7.0.2.3, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="actionview (v7.0.2.3, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="activesupport (v7.0.2.3, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="addressable (v2.8.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="amazing_print (v1.4.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ast (v2.4.2, RVM: ruby-2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="berkeley_library-logging (v0.2.5, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="berkeley_library-alma (v0.0.4, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="berkeley_library-logging (v0.2.6, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="berkeley_library-marc (v0.3.1, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="berkeley_library-util (v0.1.1, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="builder (v3.2.4, RVM: ruby-2.7.5) [gem]" level="application" />
@@ -25,28 +26,29 @@
     <orderEntry type="library" scope="PROVIDED" name="ci_reporter (v2.0.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ci_reporter_rspec (v1.0.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="colorize (v0.8.1, RVM: ruby-2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="concurrent-ruby (v1.1.9, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="concurrent-ruby (v1.1.10, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="crack (v0.4.5, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="crass (v1.0.6, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.5.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="docile (v1.4.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="domain_name (v0.5.20190701, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="dotenv (v2.7.6, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="equivalent-xml (v0.6.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="erubi (v1.10.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="hashdiff (v1.0.1, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="http-accept (v1.7.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="http-cookie (v1.0.4, RVM: ruby-2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="i18n (v1.8.11, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="i18n (v1.10.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ice_nine (v0.11.2, RVM: ruby-2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="lograge (v0.11.2, RVM: ruby-2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="loofah (v2.13.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="lograge (v0.12.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="loofah (v2.15.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="marc (v1.1.1, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="method_source (v1.0.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="mime-types (v3.4.1, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="mime-types-data (v3.2022.0105, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="minitest (v5.15.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="netrc (v0.11.0, RVM: ruby-2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="nokogiri (v1.13.1, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="nokogiri (v1.13.3, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="oj (v3.13.11, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ougai (v1.9.1, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="parallel (v1.21.0, RVM: ruby-2.7.5) [gem]" level="application" />
@@ -58,25 +60,25 @@
     <orderEntry type="library" scope="PROVIDED" name="rack-test (v1.1.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rails-dom-testing (v2.0.3, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rails-html-sanitizer (v1.4.2, RVM: ruby-2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="railties (v6.1.4.4, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="railties (v7.0.2.3, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rainbow (v3.1.1, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rake (v13.0.6, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rchardet (v1.8.0, RVM: ruby-2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="regexp_parser (v2.2.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="regexp_parser (v2.2.1, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="request_store (v1.5.1, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rest-client (v2.1.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rexml (v3.2.5, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="roo (v2.8.3, RVM: ruby-2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec (v3.10.0, RVM: ruby-2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.10.1, RVM: ruby-2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.10.2, RVM: ruby-2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.10.2, RVM: ruby-2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.10.3, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec (v3.11.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.11.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.11.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.11.0, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.11.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rubocop (v1.11.0, RVM: ruby-2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rubocop-ast (v1.15.1, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop-ast (v1.15.2, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rubocop-rake (v0.6.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rubocop-rspec (v2.4.0, RVM: ruby-2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="ruby-marc-spec (v0.1.1, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ruby-marc-spec (v0.1.3, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ruby-prof (v0.17.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ruby-progressbar (v1.11.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rubyzip (v2.3.2, RVM: ruby-2.7.5) [gem]" level="application" />
@@ -84,15 +86,15 @@
     <orderEntry type="library" scope="PROVIDED" name="simplecov (v0.21.2, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="simplecov-html (v0.12.3, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="simplecov-rcov (v0.2.3, RVM: ruby-2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="simplecov_json_formatter (v0.1.3, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="simplecov_json_formatter (v0.1.4, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="thor (v1.2.1, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="typesafe_enum (v0.3.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="tzinfo (v2.0.4, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="unf (v0.1.4, RVM: ruby-2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="unf_ext (v0.0.8, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="unf_ext (v0.0.8.1, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="unicode-display_width (v2.1.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="webmock (v3.14.0, RVM: ruby-2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="zeitwerk (v2.5.3, RVM: ruby-2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="zeitwerk (v2.5.4, RVM: ruby-2.7.5) [gem]" level="application" />
   </component>
   <component name="RModuleSettingsStorage">
     <LOAD_PATH number="2" string0="$MODULE_DIR$/lib" string1="$MODULE_DIR$/spec" />
@@ -109,7 +111,7 @@
           </RakeTaskImpl>
           <RakeTaskImpl description="Run all specs in spec directory, with coverage" fullCommand="coverage" id="coverage" />
           <RakeTaskImpl description="Run tests, check test coverage, check code style, check for vulnerabilities, build gem" fullCommand="default" id="default" />
-          <RakeTaskImpl description="Build berkeley_library-tind.gemspec as berkeley_library-tind-0.4.3.gem" fullCommand="gem" id="gem" />
+          <RakeTaskImpl description="Build berkeley_library-tind.gemspec as berkeley_library-tind-0.6.0.gem" fullCommand="gem" id="gem" />
           <RakeTaskImpl description="Run RuboCop with auto-correct, and output results to console" fullCommand="ra" id="ra" />
           <RakeTaskImpl description="Run rubocop with HTML output" fullCommand="rubocop" id="rubocop" />
           <RakeTaskImpl id="rubocop">

data/CHANGES.md

@@ -1,3 +1,27 @@
+# 0.6.0 (2023-04-06)
+
+- Adds `BerkeleyLibrary::TIND::Mapping` module to map MARC records from Alma to TIND.
+- `BerkeleyLibrary::TIND::MARC::XMLWriter` now assumes that any object that response to `:write`
+  and `:close` is suffiently `IO`-like to write to.
+
+# 0.5.1 (2023-03-23)
+
+- Fix an issue where `BerkeleyLibrary::TIND::MARC::XMLWriter` would drop fields with nonstandard tags (e.g. `FFT` fields)
+  and would group and sort fields by tag instead of preserving the original order.
+
+# 0.5.0 (2022-01-17)
+
+- Adds a class `BerkeleyLibrary::TIND::MARC::XMLWriter` to write MARCXML in the format expected by the TIND batch uploader:
+
+  - MARC leader is written to control field 000 as required by TIND
+  - control fields (including the leader) use `\` (0x5c), not space (0x32), for unspecified positional
+    values
+
+  In addition, a `nil` or empty MARC leader is not written at all.
+- Modifies `BerkeleyLibrary::TIND::MARC::XMLReader` to take into account the same peculiarities:
+  control field 000 is read into the leader of the MARC record, and slashes in control field values
+  (including the leader) are replaced with spaces.
+
 # 0.4.3 (2022-01-26)
 
 - Pins `berkeley_library-marc` to version 0.3.x (0.3.1 or higher).

data/README.md

@@ -1,10 +1,24 @@
 # BerkeleyLibrary::TIND
 
 [![Build Status](https://github.com/BerkeleyLibrary/tind/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/BerkeleyLibrary/tind/actions/workflows/build.yml)
-[![Gem Version](https://img.shields.io/gem/v/berkeley_library-tind.svg)](https://github.com/BerkeleyLibrary/tind/releases)
+[![Gem Version](https://img.shields.io/gem/v/berkeley_library-tind.svg)](https://rubygems.org/gems/berkeley_library-tind)
 
 Utility gem for working with the TIND DA digital archive.
 
+## Installation
+
+In your Gemfile:
+
+```ruby
+gem 'berkeley_library-tind'
+```
+
+In your code:
+
+```ruby
+require 'berkeley_library/tind'
+```
+
 ## Configuration
 
 To access the TIND API, you will need to set:
@@ -16,7 +30,7 @@ To access the TIND API, you will need to set:
    it a "key", so that's the term we use here.)
 
 These can be set directly, via accessors in the `BerkeleyLibrary::TIND::Config` module;
-if they are not set, a value will be read from the environment, and if no 
+if they are not set, a value will be read from the environment, and if no
 value is present in the environment and Rails is loaded, from the Rails
 application configuration (`Rails.application.config`).
 
@@ -29,9 +43,18 @@ application configuration (`Rails.application.config`).
 object, but will always be returned as a `URI` object, and an invalid
 string setting will raise `URI::InvalidURIError`.
 
+### Alma configuration
+
+When mapping Alma records to TIND (see below), this gem uses 
+[`berkeley_library-alma`](https://github.com/BerkeleyLibrary/alma) to load
+Alma records. The scripts in the `bin` directory use the default Alma
+configuration; see the `berkeley_library-alma` 
+[README](https://github.com/BerkeleyLibrary/alma#configuration) for
+details.
+
 ## Command-line tool: `tind-export`
 
-The `tind-export` command allows you to list TIND collections, or to 
+The `tind-export` command allows you to list TIND collections, or to
 export a TIND collection from the command line. (If the gem is installed,
 `tind-export` should be in your `$PATH`. If you've cloned the gem source,
 you can invoke it with `bin/tind-export` from the project root directory.)
@@ -71,3 +94,113 @@ For the full list of options, type `tind-export --help`. Note that you can set
 the TIND base URL and API key either via the environment, as above, or as options
 passed to the `tind-export` command. If both an explicit option and an environment
 variable are set for either, the explicit option takes precedence.
+
+## Mapping MARC records from Alma to TIND
+
+### Transforming Class:
+
+1. BerkeleyLibrary::TIND::Mapping::AlmaSingleTIND    (Transforming one Alma record => One TIND record)
+2. BerkeleyLibrary::TIND::Mapping::AlmaMultipleTIND  (Transforming one Alma record => Multiple TIND records)
+
+### Source of TIND fields
+
+1. Mapped from an Alma record (automatically)
+
+2. Derived from collection information, mms_id, and date (automatically)
+
+    - 336$a
+    - 852$c
+    - 980$a
+    - 982$a,$b
+    - 991$a - (optional)
+    - 902$d
+    - 901$m
+    - 85641$u,$y
+
+3. Added at the time of transforming TIND record (fields of a collection or its record)
+
+    - FFT
+    - 035$a
+    - 998$a
+    - ...
+
+### Example
+
+1. Setup collection information
+   
+   - 336:  type of resource
+   - 852:  collection's repository name
+   - 980:  collection's 980 value
+   - 982:  collection's short name and long name
+   - 991:  collection' restricted name (optional)
+
+``` ruby
+
+def setup_collection
+  BerkeleyLibrary::TIND::Mapping::AlmaBase.collection_parameter_hash = {
+    '336' => ['Image'],
+    '852' => ['East Asian Library'],
+    '980' => ['pre_1912'],
+    '982' => ['Pre 1912 Chinese Materials - short name', 'Pre 1912 Chinese Materials - long name'],
+    '991' => []
+  }
+  
+  # BerkeleyLibrary::TIND::Mapping::AlmaBase.is_035_from_mms_id = true  
+
+  # Flag on getting Alma record using Barcode
+  BerkeleyLibrary::TIND::Mapping::AlmaBase.is_barcode = true           
+end
+```
+
+2. Praparing additional fields
+
+    Adding field using:
+    -  field methods from module:  BerkeleyLibrary::TIND::Mapping::TindField
+    -  Or the original method from Ruby Marc when field method found in above module  
+        ::MARC::DataField.new(tag, indicator1, indicator, [code1, value1], [code2, value2] ...)
+
+```ruby
+
+def additional_tind_fields_1
+  txt = 'v001_0064'
+  url = 'https://digitalassets.lib.berkeley.edu/pre1912ChineseMaterials/ucb/ready/991032333019706532/991032333019706532_v001_0064.jpg'
+  fft = BerkeleyLibrary::TIND::Mapping::TindField.f_fft(url, txt)
+
+  f = ::MARC::DataField.new('998', ' ', ' ', ['a', 'fake-value'])
+  [fft] << f
+end
+
+def additional_tind_fields_2
+  txt = 'v001_0065'
+  url = 'https://digitalassets.lib.berkeley.edu/pre1912ChineseMaterials/ucb/ready/991032333019706532/991032333019706532_v001_0065.jpg'
+  fft = BerkeleyLibrary::TIND::Mapping::TindField.f_fft(url, txt)
+  [fft]
+end
+```
+
+3. Transforming one Alma record => One TIND record
+
+```ruby
+setup_collection
+
+# id can be  1)mms_id;  2)Millennium no ; or 3)Barcode
+id = 'C084093187'
+
+alma_tind = BerkeleyLibrary::TIND::Mapping::AlmaSingleTIND.new
+tind_record = alma_tind.record(id, additional_tind_fields_1)
+```
+
+
+4. Or transforming one Alma record => Multiple TIND records
+
+``` ruby
+setup_collection
+
+# id can be 1) mms_id; 2) Millennium bib number; or 3) Item barcode
+# id = '991085821143406532'
+id = 'C084093187'
+
+alma_tind = BerkeleyLibrary::TIND::Mapping::AlmaMultipleTIND.new(id)
+tind_record_1 = alma_tind.record(additional_tind_fields_1)
+tind_record_2 = alma_tind.record(additional_tind_fields_2)
+```

data/berkeley_library-tind.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ruby_version
 
+  spec.add_dependency 'berkeley_library-alma', '~> 0.0.1'
   spec.add_dependency 'berkeley_library-logging', '~> 0.2'
   spec.add_dependency 'berkeley_library-marc', '~> 0.3.0', '>= 0.3.1'
   spec.add_dependency 'berkeley_library-util', '~> 0.1'
@@ -37,6 +38,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'ci_reporter_rspec', '~> 1.0'
   spec.add_development_dependency 'colorize', '~> 0.8'
   spec.add_development_dependency 'dotenv', '~> 2.7'
+  spec.add_development_dependency 'equivalent-xml', '~> 0.6'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'roo', '~> 2.8'
   spec.add_development_dependency 'rspec', '~> 3.10'

data/bin/alma-multiple-tind

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+begin
+  # This should work if (1) the gem is installed, or
+  # (2) we're in development and used `bundle exec`
+  require 'berkeley_library/tind'
+  require 'berkeley_library/alma'
+rescue LoadError
+  # If we're in development, `require 'bundler/setup'`
+  # is roughly equivalent to `bundle exec`
+  require 'bundler/setup'
+  require 'berkeley_library/tind'
+  require 'berkeley_library/alma'
+end
+
+def setup
+  # set collection name information
+  BerkeleyLibrary::TIND::Mapping::AlmaBase.collection_parameter_hash = {
+    '336' => ['Image'],
+    '852' => ['East Asian Library'],
+    '980' => ['pre_1912'],
+    '982' => ['Pre 1912 Chinese Materials - short name', 'Pre 1912 Chinese Materials - long name'],
+    '991' => []
+  }
+
+  # flag: set it to true if using barcode getting Alma record; default is false
+  # BerkeleyLibrary::TIND::Mapping::AlmaBase.is_barcode = true
+end
+
+def additional_tind_fields
+  txt = 'v001_0064'
+  url = 'https://digitalassets.lib.berkeley.edu/pre1912ChineseMaterials/ucb/ready/991032333019706532/991032333019706532_v001_0064.jpg'
+  fft = BerkeleyLibrary::TIND::Mapping::TindField.f_fft(url, txt)
+  datafields = [fft]
+
+  f_035 = BerkeleyLibrary::TIND::Mapping::TindField.f_035_from_alma_id('pre_1912', '991085821143406532')
+  datafields << f_035
+end
+
+###########  Use this, when creating multiple TIND records from a single Alma record  ############
+alma_id = '991085821143406532'
+# alma_id = '99108582114340653'  # a bad alma_id
+# alma_id = '991084606989706532' # Host histrical record
+
+setup
+
+BerkeleyLibrary::Alma::Config.default!
+alma_multiple_tind = BerkeleyLibrary::TIND::Mapping::AlmaMultipleTIND.new(alma_id)
+tind_record = alma_multiple_tind.record(additional_tind_fields)
+alma_multiple_tind.save_tind_record_to_file(tind_record, 'tmp/multiple.xml')

data/bin/alma-single-tind

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+
+begin
+  # This should work if (1) the gem is installed, or
+  # (2) we're in development and used `bundle exec`
+  require 'berkeley_library/tind'
+  require 'berkeley_library/alma'
+rescue LoadError
+  # If we're in development, `require 'bundler/setup'`
+  # is roughly equivalent to `bundle exec`
+  require 'bundler/setup'
+  require 'berkeley_library/tind'
+  require 'berkeley_library/alma'
+end
+
+def setup
+  BerkeleyLibrary::TIND::Mapping::AlmaBase.collection_parameter_hash = {
+    '336' => ['Image'],
+    '852' => ['East Asian Library'],
+    '980' => ['pre_1912'],
+    '982' => ['Pre 1912 Chinese Materials - short name', 'Pre 1912 Chinese Materials - long name'],
+    '991' => []
+  }
+  BerkeleyLibrary::TIND::Mapping::AlmaBase.is_035_from_mms_id = true
+  BerkeleyLibrary::TIND::Mapping::AlmaBase.is_barcode = false
+end
+
+def additional_tind_fields
+  txt = 'v001_0064'
+  url = 'https://digitalassets.lib.berkeley.edu/pre1912ChineseMaterials/ucb/ready/991032333019706532/991032333019706532_v001_0064.jpg'
+  fft = BerkeleyLibrary::TIND::Mapping::TindField.f_fft(url, txt)
+  f = ::MARC::DataField.new('998', ' ', ' ', ['a', 'fake-value'])
+  [fft] << f
+end
+
+############## Use this, when creating a TIND record from each Alma record ############
+# alma_id = '991085821143406532'
+# alma_id_bad = '99108582114340653' # a bad alma_id
+# alma_id_not_qualified = '991084606989706532' # Host historical record
+barcode = 'C084093187'
+
+id = barcode
+setup
+
+BerkeleyLibrary::Alma::Config.default!
+alma_single_tind = BerkeleyLibrary::TIND::Mapping::AlmaSingleTIND.new
+tind_record = alma_single_tind.record(id, additional_tind_fields)
+alma_single_tind.save_tind_record_to_file(id, tind_record, 'tmp/test_single.xml')

data/bin/save_tind_records

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+
+begin
+  # This should work if (1) the gem is installed, or
+  # (2) we're in development and used `bundle exec`
+  require 'berkeley_library/tind'
+  require 'berkeley_library/alma'
+rescue LoadError
+  # If we're in development, `require 'bundler/setup'`
+  # is roughly equivalent to `bundle exec`
+  require 'bundler/setup'
+  require 'berkeley_library/tind'
+  require 'berkeley_library/alma'
+end
+
+def setup
+  BerkeleyLibrary::TIND::Mapping::AlmaBase.collection_parameter_hash = {
+    '336' => ['Image'],
+    '852' => ['Bioscience, Natural Resources & Public Health Library'],
+    '980' => ['Forestry'],
+    '982' => ['Forestry', 'Forestry'],
+    '991' => []
+  }
+
+  # BerkeleyLibrary::TIND::Mapping::AlmaBase.is_barcode = true
+end
+
+def fake_additional_tind_fields1
+  fields = []
+  txt = '001'
+  url = 'https://digitalassets.lib.berkeley.edu/forestry/ucb/images/b142086125_i180839998/b142086125_i180839998_001.jpg'
+  fft = BerkeleyLibrary::TIND::Mapping::TindField.f_fft(url, txt)
+  f_998 = ::MARC::DataField.new('998', ' ', ' ', ['a', 'fake-value'])
+  f_035 = BerkeleyLibrary::TIND::Mapping::TindField.f_035('b142086125')
+  fields << f_998
+  fields << f_035
+  fields << fft
+end
+
+def fake_additional_tind_fields2
+  fields = []
+  txt = '002'
+  url = 'https://digitalassets.lib.berkeley.edu/forestry/ucb/images/b142086125_i180839998/b142086125_i180839998_002.jpg'
+  fft = BerkeleyLibrary::TIND::Mapping::TindField.f_fft(url, txt)
+
+  f_998 = ::MARC::DataField.new('998', ' ', ' ', ['a', 'fake-value'])
+
+  f_035 = BerkeleyLibrary::TIND::Mapping::TindField.f_035('b142107827')
+  fields << f_998
+  fields << f_035
+  fields << fft
+end
+
+def tind_records
+  records = []
+  alma_tind = BerkeleyLibrary::TIND::Mapping::AlmaSingleTIND.new
+
+  record1 = alma_tind.record('b142086125', fake_additional_tind_fields1)
+  record2 = alma_tind.record('b142107827', fake_additional_tind_fields2)
+  records << record1
+  records << record2
+end
+
+def save_batch(file, with_tind_xmlwritter)
+  setup
+  writer = ::MARC::XMLWriter.new(file)
+  writer = BerkeleyLibrary::TIND::MARC::XMLWriter.new(file) if with_tind_xmlwritter
+
+  tind_records.each do |record|
+    record.leader = nil if with_tind_xmlwritter
+    writer.write(record)
+  end
+  writer.close
+end
+
+# save with tind xmlwritter
+save_batch('tmp/test_tind_xmlwritter.xml', true)
+
+# save with Marc xmlwritter
+save_batch('tmp/test_marc_xmlwritter.xml', false)