loc_mods 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 024d52ee3ab202df40aacd38b5e6a9cf91a199a64fe7021d38c09dd1054e7321
-  data.tar.gz: 29d07b4f6b1f1fb00491610033047039079e814316136286e880662bab2c94e0
+  metadata.gz: 169bec73df0640577af6a10da45138fa11502b00d8cb4f2d1152c2f360c02999
+  data.tar.gz: cf3045ea76530e0caba326d6ee326f5afc94e7f2022d00f850aa3800a58fa33b
 SHA512:
-  metadata.gz: 17fe60875e1e45382111972d8ace84fee39b86ff0326c4f08617de5dbcd66ffd12f65c674ebf513062df891019bac012248a0d41e9dac8804f3d25ca1e0c80fb
-  data.tar.gz: ceb304d8b6124c4982c1492b2c4b7d1af4d862379ae5b5f3c240b68701f6aee086c46713215884aa9953f50ebe87be7c287ea9aa3eb3466d2e8d9a299a82ca60
+  metadata.gz: c68a2d4981a688b61af9a329b7d0393d6f0f3f3f4ca56e4fca7ce1b5958227a5180d66be34de64ad34871dec37a341fde55e75581f7039706ba17f69936d7ed1
+  data.tar.gz: b3e6b998a759d09eec487fcc01ab4b3f1fb44c6df5457231c1fddde76f3c078676e5898bcd05bee6e46c0281ebb2f18c102df3d78feb0671ed79cf95d7f11494

data/.rubocop.yml

@@ -1,10 +1,19 @@
-inherit_from: .rubocop_todo.yml
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/main/ci/rubocop.yml
+  - .rubocop_todo.yml
 
-AllCops:
-  TargetRubyVersion: 3.0
+inherit_mode:
+  merge:
+    - Exclude
 
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
+# local repo-specific modifications
+# ...
+plugins:
+  - rubocop-rspec
+  - rubocop-performance
+  - rubocop-rake
 
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
+AllCops:
+  TargetRubyVersion: 3.0

data/.rubocop_todo.yml

@@ -1,18 +1,27 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-01-14 08:30:09 UTC using RuboCop version 1.70.0.
+# on 2026-03-24 02:27:27 UTC using RuboCop version 1.86.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 1
-# Configuration parameters: Severity, Include.
-# Include: **/*.gemspec
 Gemspec/RequiredRubyVersion:
   Exclude:
     - 'loc_mods.gemspec'
 
+# Offense count: 5
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Exclude:
+    - 'bin/update-nist-mods'
+    - 'lib/loc_mods/cli.rb'
+    - 'loc_mods.gemspec'
+    - 'spec/loc_mods/collection_spec.rb'
+
 # Offense count: 1
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: enums
@@ -20,31 +29,34 @@ Lint/ConstantDefinitionInBlock:
   Exclude:
     - 'spec/loc_mods/collection_spec.rb'
 
-# Offense count: 1
-# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+# Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
-  Max: 50
+  Exclude:
+    - 'lib/loc_mods/cli.rb'
 
 # Offense count: 1
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 32
+  Max: 30
 
 # Offense count: 2
-# Configuration parameters: AllowedMethods, AllowedPatterns.
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/CyclomaticComplexity:
-  Max: 15
+  Exclude:
+    - 'lib/loc_mods/cli.rb'
 
 # Offense count: 3
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 43
+  Max: 45
 
 # Offense count: 2
-# Configuration parameters: AllowedMethods, AllowedPatterns.
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/PerceivedComplexity:
-  Max: 16
+  Exclude:
+    - 'lib/loc_mods/cli.rb'
 
 # Offense count: 1
 # Configuration parameters: ForbiddenDelimiters.
@@ -54,34 +66,23 @@ Naming/HeredocDelimiterNaming:
     - 'bin/update-nist-mods'
 
 # Offense count: 1
-Security/Open:
-  Exclude:
-    - 'bin/update-nist-mods'
-
-# Offense count: 63
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
-  Enabled: false
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 7
 
 # Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Strict, AllowedNumbers, AllowedPatterns.
-Style/NumericLiterals:
-  MinDigits: 6
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInArguments:
+RSpec/LeakyConstantDeclaration:
   Exclude:
-    - 'lib/loc_mods/cli.rb'
     - 'spec/loc_mods/collection_spec.rb'
 
 # Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInArrayLiteral:
+# Configuration parameters: CustomTransform, IgnoreMethods, IgnoreMetadata, InflectorPath, EnforcedInflector.
+# SupportedInflectors: default, active_support
+RSpec/SpecFilePathFormat:
   Exclude:
-    - 'spec/loc_mods/collection_spec.rb'
+    - 'spec/loc_mods_spec.rb'
+
+# Offense count: 1
+Security/Open:
+  Exclude:
+    - 'bin/update-nist-mods'

data/README.adoc

@@ -119,6 +119,22 @@ metadata.
 bin/update-nist-mods
 ----
 
+=== Running tests
+
+Run all tests:
+
+[source,sh]
+----
+bundle exec rake spec
+----
+
+Run a single test by description:
+
+[source,sh]
+----
+bundle exec rspec spec/loc_mods/collection_spec.rb --example "991000197019708106"
+----
+
 == License
 
 Copyright Ribose.

data/lib/loc_mods/abstract.rb

@@ -13,8 +13,8 @@ module LocMods
     attribute :content_type, :string
 
     xml do
-      root "abstract"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "abstract"
+      namespace Namespace
 
       map_content to: :content
       map_attribute "displayLabel", to: :display_label

data/lib/loc_mods/access_condition.rb

@@ -15,8 +15,8 @@ module LocMods
     attribute :content_type, :string
 
     xml do
-      root "accessCondition"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "accessCondition"
+      namespace Namespace
 
       map_content to: :content
       map_attribute "displayLabel", to: :display_label

data/lib/loc_mods/alternative_name.rb

@@ -21,8 +21,8 @@ module LocMods
     attribute :name_identifier, Identifier, collection: true
 
     xml do
-      root "alternativeName"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "alternativeName"
+      namespace Namespace
 
       map_attribute "lang", to: :lang
       map_attribute "script", to: :script

data/lib/loc_mods/area.rb

@@ -10,8 +10,8 @@ module LocMods
     attribute :area_type, :string
 
     xml do
-      root "area"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "area"
+      namespace Namespace
 
       map_content to: :content
       map_attribute "areaType", to: :area_type

data/lib/loc_mods/cartographic_extension.rb

@@ -8,8 +8,8 @@ module LocMods
     attribute :display_label, :string
 
     xml do
-      root "cartographicExtension"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "cartographicExtension"
+      namespace Namespace
 
       map_content to: :content
       map_attribute "displayLabel", to: :display_label

data/lib/loc_mods/cartographics.rb

@@ -15,8 +15,8 @@ module LocMods
     attribute :cartographic_extension, CartographicExtension, collection: true
 
     xml do
-      root "cartographics"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "cartographics"
+      namespace Namespace
 
       map_attribute "authority", to: :authority
       map_attribute "authorityURI", to: :authority_uri

data/lib/loc_mods/city_section.rb

@@ -10,8 +10,8 @@ module LocMods
     attribute :city_section_type, :string
 
     xml do
-      root "citySection"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "citySection"
+      namespace Namespace
 
       map_content to: :content
       map_attribute "citySectionType", to: :city_section_type

data/lib/loc_mods/classification.rb

@@ -13,8 +13,8 @@ module LocMods
     attribute :generator, :string
 
     xml do
-      root "classification"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "classification"
+      namespace Namespace
 
       map_content to: :content
       map_attribute "authority", to: :authority

data/lib/loc_mods/cli.rb

@@ -5,9 +5,12 @@ require "loc_mods"
 
 module LocMods
   class Cli < Thor
-    desc "detect-duplicates PATH...", "Detect duplicate records in MODS XML files or directories"
-    method_option :show_unchanged, type: :boolean, default: false, desc: "Show unchanged attributes in the diff output"
-    method_option :highlight_diff, type: :boolean, default: false, desc: "Highlight only the differences"
+    desc "detect-duplicates PATH...",
+         "Detect duplicate records in MODS XML files or directories"
+    method_option :show_unchanged, type: :boolean, default: false,
+                                   desc: "Show unchanged attributes in the diff output"
+    method_option :highlight_diff, type: :boolean, default: false,
+                                   desc: "Highlight only the differences"
     method_option :color, type: :string, enum: %w[auto on off], default: "auto",
                           desc: "Use colors in the diff output (auto, on, off)"
 
@@ -27,7 +30,9 @@ module LocMods
 
       records_by_url = {}
       all_records.each do |record|
-        urls = record[:record].location.flat_map { |loc| loc.url.map(&:content) }.compact
+        urls = record[:record].location.flat_map do |loc|
+          loc.url.map(&:content)
+        end.compact
         unless urls.any?
           puts "Warning: Record without URL found in file: #{record[:file]}"
           next
@@ -54,7 +59,7 @@ module LocMods
             record2[:record],
             options[:show_unchanged],
             options[:highlight_diff],
-            color_enabled?
+            color_enabled?,
           )
           puts "\n"
         end
@@ -71,14 +76,15 @@ module LocMods
       end
     end
 
-    def print_differences(record1, record2, show_unchanged, highlight_diff, use_colors)
+    def print_differences(record1, record2, show_unchanged, highlight_diff,
+use_colors)
       diff_score, diff_tree = Lutaml::Model::Serialize.diff_with_score(
         record1,
         record2,
         show_unchanged: show_unchanged,
         highlight_diff: highlight_diff,
         use_colors: use_colors,
-        indent: "  "
+        indent: "  ",
       )
       similarity_percentage = (1 - diff_score) * 100
 
@@ -101,7 +107,7 @@ module LocMods
     def supports_color?
       return false unless $stdout.tty?
 
-      if RbConfig::CONFIG["host_os"] =~ /mswin|mingw|cygwin/
+      if /mswin|mingw|cygwin/.match?(RbConfig::CONFIG["host_os"])
         return true if ENV["ANSICON"]
         return true if ENV["ConEmuANSI"] == "ON"
         return true if ENV["TERM"] == "xterm"
@@ -109,7 +115,7 @@ module LocMods
 
       return true if ENV["COLORTERM"]
 
-      term = ENV["TERM"]
+      term = ENV.fetch("TERM", nil)
       return false if term.nil? || term.empty?
 
       color_terms = %w[ansi color console cygwin gnome konsole kterm

data/lib/loc_mods/collection.rb

@@ -9,8 +9,8 @@ module LocMods
     attribute :mods, Record, collection: true
 
     xml do
-      root "modsCollection"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "modsCollection"
+      namespace Namespace
 
       map_element "mods", to: :mods
     end

data/lib/loc_mods/copy_information.rb

@@ -19,8 +19,8 @@ module LocMods
     attribute :item_identifier, ItemIdentifier, collection: true
 
     xml do
-      root "copyInformation"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "copyInformation"
+      namespace Namespace
 
       map_element "form", to: :form
       map_element "subLocation", to: :sub_location

data/lib/loc_mods/date.rb

@@ -5,18 +5,18 @@ require "lutaml/model"
 module LocMods
   class Date < Lutaml::Model::Serializable
     attribute :content, :string
-    attribute :encoding, :string
+    attribute :encoding_code, :string
     attribute :qualifier, :string
     attribute :point, :string
     attribute :key_date, :string
     attribute :calendar, :string
 
     xml do
-      root "recordChangeDate"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "recordChangeDate"
+      namespace Namespace
 
       map_content to: :content
-      map_attribute "encoding", to: :encoding
+      map_attribute "encoding", to: :encoding_code
       map_attribute "qualifier", to: :qualifier
       map_attribute "point", to: :point
       map_attribute "keyDate", to: :key_date

data/lib/loc_mods/date_other.rb

@@ -10,8 +10,8 @@ module LocMods
     attribute :type, :string
 
     xml do
-      root "dateOther"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "dateOther"
+      namespace Namespace
 
       map_content to: :content
       map_attribute "type", to: :type

data/lib/loc_mods/detail.rb

@@ -11,8 +11,8 @@ module LocMods
     attribute :title, :string, collection: true
 
     xml do
-      root "detail"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "detail"
+      namespace Namespace
 
       map_attribute "type", to: :type
       map_attribute "level", to: :level

data/lib/loc_mods/edition.rb

@@ -9,8 +9,8 @@ module LocMods
     attribute :supplied, :string
 
     xml do
-      root "edition"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "edition"
+      namespace Namespace
 
       map_content to: :content
       map_attribute "supplied", to: :supplied

data/lib/loc_mods/enumeration_and_chronology.rb

@@ -8,8 +8,8 @@ module LocMods
     attribute :unit_type, :string
 
     xml do
-      root "enumerationAndChronology"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "enumerationAndChronology"
+      namespace Namespace
 
       map_content to: :content
       map_attribute "unitType", to: :unit_type

data/lib/loc_mods/extent.rb

@@ -8,8 +8,8 @@ module LocMods
     attribute :unit, :string
 
     xml do
-      root "extent"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "extent"
+      namespace Namespace
 
       map_content to: :content
       map_attribute "unit", to: :unit

data/lib/loc_mods/extent_definition.rb

@@ -11,8 +11,8 @@ module LocMods
     attribute :list, :string
 
     xml do
-      root "extentDefinition"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "extentDefinition"
+      namespace Namespace
 
       map_attribute "unit", to: :unit
       map_element "start", to: :start

data/lib/loc_mods/form.rb

@@ -9,8 +9,8 @@ module LocMods
     attribute :authority, :string
 
     xml do
-      root "form"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "form"
+      namespace Namespace
 
       map_content to: :content
       map_attribute "type", to: :type

data/lib/loc_mods/genre.rb

@@ -12,8 +12,8 @@ module LocMods
     attribute :authority, :string
 
     xml do
-      root "genre"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "genre"
+      namespace Namespace
 
       map_content to: :content
       map_attribute "type", to: :type

data/lib/loc_mods/geographic_code.rb

@@ -10,8 +10,8 @@ module LocMods
     attribute :authority, :string
 
     xml do
-      root "geographicCode"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "geographicCode"
+      namespace Namespace
 
       map_content to: :content
       map_attribute "authorityURI", to: :authority_uri

data/lib/loc_mods/hierarchical_geographic.rb

@@ -26,8 +26,8 @@ module LocMods
     attribute :area, Area, collection: true
 
     xml do
-      root "hierarchicalGeographic"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "hierarchicalGeographic"
+      namespace Namespace
 
       map_attribute "authority", to: :authority
       map_attribute "authorityURI", to: :authority_uri

data/lib/loc_mods/hierarchical_part.rb

@@ -12,8 +12,8 @@ module LocMods
     attribute :value_uri, :string
 
     xml do
-      root "territory"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "territory"
+      namespace Namespace
 
       map_content to: :content
       map_attribute "level", to: :level

data/lib/loc_mods/holding_simple.rb

@@ -9,8 +9,8 @@ module LocMods
     attribute :copy_information, CopyInformation, collection: true
 
     xml do
-      root "holdingSimple"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "holdingSimple"
+      namespace Namespace
 
       map_element "copyInformation", to: :copy_information
     end

data/lib/loc_mods/identifier.rb

@@ -12,8 +12,8 @@ module LocMods
     attribute :alt_rep_group, :string
 
     xml do
-      root "nameIdentifier"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "nameIdentifier"
+      namespace Namespace
 
       map_content to: :content
       map_attribute "displayLabel", to: :display_label

data/lib/loc_mods/item_identifier.rb

@@ -8,8 +8,8 @@ module LocMods
     attribute :type, :string
 
     xml do
-      root "itemIdentifier"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "itemIdentifier"
+      namespace Namespace
 
       map_content to: :content
       map_attribute "type", to: :type

data/lib/loc_mods/language.rb

@@ -18,8 +18,8 @@ module LocMods
     attribute :script_term, ScriptTerm, collection: true
 
     xml do
-      root "languageOfCataloging"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "languageOfCataloging"
+      namespace Namespace
 
       map_attribute "objectPart", to: :object_part
       map_attribute "lang", to: :lang

data/lib/loc_mods/language_term.rb

@@ -11,8 +11,8 @@ module LocMods
     attribute :type, :string
 
     xml do
-      root "languageTerm"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "languageTerm"
+      namespace Namespace
 
       map_content to: :content
       map_attribute "authorityURI", to: :authority_uri

data/lib/loc_mods/location.rb

@@ -21,8 +21,8 @@ module LocMods
     attribute :holding_external, CartographicExtension
 
     xml do
-      root "location"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "location"
+      namespace Namespace
 
       map_attribute "lang", to: :lang
       map_attribute "script", to: :script

data/lib/loc_mods/name.rb

@@ -29,15 +29,13 @@ module LocMods
     attribute :name_identifier, Identifier, collection: true
     attribute :alternative_name, AlternativeName, collection: true
     attribute :etal, :string
-    attribute :href, :string
+    attribute :href, XlinkHref
 
     xml do
-      root "name"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "name"
+      namespace Namespace
 
-      map_attribute "href", to: :href,
-                            namespace: "http://www.w3.org/1999/xlink",
-                            prefix: "xlink"
+      map_attribute "href", to: :href
 
       map_attribute "ID", to: :id
       map_attribute "authority", to: :authority

data/lib/loc_mods/name_part.rb

@@ -8,8 +8,8 @@ module LocMods
     attribute :type, :string
 
     xml do
-      root "namePart"
-      namespace "http://www.loc.gov/mods/v3", nil
+      element "namePart"
+      namespace Namespace
 
       map_content to: :content
       map_attribute "type", to: :type

data/lib/loc_mods/namespace.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module LocMods
+  class Namespace < Lutaml::Xml::Namespace
+    uri "http://www.loc.gov/mods/v3"
+    prefix_default "mods"
+    element_form_default :unqualified
+    attribute_form_default :unqualified
+  end
+end