unitsdb 2.1.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b92f561a56f8cdd59a905cf7827c6ffda47acae64f1e31256f2c5efebfd81f2
-  data.tar.gz: 218a47cf5fb2c178f787f05e186c09f5b40d0f4914b81d6de5884759011621ef
+  metadata.gz: 7fda421d6dfc06976fad5da00dd85f0fb1dbb3dc4865e2904a28b237530ace05
+  data.tar.gz: 9e4fdd8395fab543936c4d4b415f05c468b788d287545d3ebfd774a53a9f766c
 SHA512:
-  metadata.gz: 82bd1ac58073379426b3378bda8b94e0bcdf46f954148d082b6008931d0c49c0c50d35b53ac64661a75e0f58bfedf46a5f53e0e948e5520584711a0260ebe638
-  data.tar.gz: ff4538f70410cc9572f7a7719bf32aa1324f6e2cdaf7fe95acbd6426b31168b9c4ba72271d81fe8a76dd1339aa0d3d3307424a878b4cb11e96be5af9897078b0
+  metadata.gz: 8453d7f411242d4fbf035b73cee6d968505c60e884606b872317a1fe53dd93b3e603a0497c1869b1768649dbf2c23a6fdcbe233dccf4eee95f482f1d440f2163
+  data.tar.gz: 5a7d1579b935b9afb7bb5e4c0ab8c25e943be6b525d401411bf97d8b3101061a0b211631af0740dcd3476fb012c2c3048dadc0399ec75f91ed425e8416bbd59e

data/.github/workflows/release.yml

@@ -2,12 +2,18 @@
 # See https://github.com/metanorma/cimas
 name: release
 
+permissions:
+  contents: write
+  packages: write
+  id-token: write
+
 on:
   workflow_dispatch:
     inputs:
       next_version:
         description: |
-          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
+          Next release version. Possible values: x.y.z, major, minor, patch (or pre|rc|etc).
+          Also, you can pass 'skip' to skip 'git tag' and do 'gem push' for the current version
         required: true
         default: 'skip'
   repository_dispatch:
@@ -18,6 +24,7 @@ jobs:
     uses: metanorma/ci/.github/workflows/rubygems-release.yml@main
     with:
       next_version: ${{ github.event.inputs.next_version }}
+      submodules: true
     secrets:
       rubygems-api-key: ${{ secrets.UNITSML_CI_RUBYGEMS_API_KEY }}
       pat_token: ${{ secrets.UNITSML_CI_PAT_TOKEN }}

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+Gemfile.lock

data/.gitmodules

@@ -1,3 +1,4 @@
-[submodule "spec/fixtures/unitsdb"]
-	path = spec/fixtures/unitsdb
-	url = https://github.com/unitsml/unitsdb/
+[submodule "data"]
+	path = data
+	url = https://github.com/unitsml/unitsdb.git
+	branch = refs/tags/v2.0.0

data/.rubocop.yml

@@ -1,10 +1,15 @@
-inherit_from: .rubocop_todo.yml
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/main/ci/rubocop.yml
+  - .rubocop_todo.yml
 
-AllCops:
-  TargetRubyVersion: 3.0
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
+plugins:
+- rubocop-performance
+- rubocop-rake
+- rubocop-rspec
 
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'
+    - 'data/**/*'

data/.rubocop_todo.yml

@@ -1,111 +1,305 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-05-20 11:22:36 UTC using RuboCop version 1.75.6.
+# on 2026-04-03 22:15:03 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/DuplicatedAssignment:
+Gemspec/RequiredRubyVersion:
   Exclude:
     - 'unitsdb.gemspec'
 
-# Offense count: 2
-Lint/ShadowingOuterLocalVariable:
+# Offense count: 9
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: with_first_argument, with_fixed_indentation
+Layout/ArgumentAlignment:
   Exclude:
+    - 'lib/unitsdb/commands/get.rb'
+    - 'lib/unitsdb/commands/release.rb'
     - 'lib/unitsdb/commands/search.rb'
+    - 'lib/unitsdb/commands/validate/identifiers.rb'
+    - 'lib/unitsdb/commands/validate/qudt_references.rb'
+    - 'lib/unitsdb/commands/validate/references.rb'
     - 'lib/unitsdb/commands/validate/si_references.rb'
+    - 'lib/unitsdb/commands/validate/ucum_references.rb'
+    - 'spec/unitsdb/commands/normalize_spec.rb'
+
+# Offense count: 6
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyleAlignWith.
+# SupportedStylesAlignWith: either, start_of_block, start_of_line
+Layout/BlockAlignment:
+  Exclude:
+    - 'spec/unitsdb/commands/normalize_spec.rb'
+    - 'spec/unitsdb/commands/qudt/update_spec.rb'
+    - 'spec/unitsdb/commands/search_spec.rb'
+    - 'spec/unitsdb/commands/validate/qudt_references_spec.rb'
+    - 'spec/unitsdb/commands/validate/ucum_references_spec.rb'
+
+# Offense count: 5
+# This cop supports safe autocorrection (--autocorrect).
+Layout/BlockEndNewline:
+  Exclude:
+    - 'spec/unitsdb/commands/normalize_spec.rb'
+    - 'spec/unitsdb/commands/qudt/update_spec.rb'
+    - 'spec/unitsdb/commands/search_spec.rb'
+    - 'spec/unitsdb/commands/validate/qudt_references_spec.rb'
+    - 'spec/unitsdb/commands/validate/ucum_references_spec.rb'
+
+# Offense count: 5
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
+# SupportedHashRocketStyles: key, separator, table
+# SupportedColonStyles: key, separator, table
+# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
+Layout/HashAlignment:
+  Exclude:
+    - 'lib/unitsdb/cli.rb'
+    - 'lib/unitsdb/commands/_modify.rb'
+    - 'lib/unitsdb/commands/qudt.rb'
+    - 'lib/unitsdb/commands/ucum.rb'
+    - 'lib/unitsdb/commands/validate.rb'
+
+# Offense count: 10
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Width, EnforcedStyleAlignWith, AllowedPatterns.
+# SupportedStylesAlignWith: start_of_line, relative_to_receiver
+Layout/IndentationWidth:
+  Exclude:
+    - 'spec/unitsdb/commands/normalize_spec.rb'
+    - 'spec/unitsdb/commands/qudt/update_spec.rb'
+    - 'spec/unitsdb/commands/search_spec.rb'
+    - 'spec/unitsdb/commands/validate/qudt_references_spec.rb'
+    - 'spec/unitsdb/commands/validate/ucum_references_spec.rb'
+
+# Offense count: 393
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Enabled: false
 
-# Offense count: 37
-# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+# Offense count: 9
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowInHeredoc.
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'lib/unitsdb/commands/get.rb'
+    - 'lib/unitsdb/commands/release.rb'
+    - 'lib/unitsdb/commands/search.rb'
+    - 'lib/unitsdb/commands/validate/identifiers.rb'
+    - 'lib/unitsdb/commands/validate/qudt_references.rb'
+    - 'lib/unitsdb/commands/validate/references.rb'
+    - 'lib/unitsdb/commands/validate/si_references.rb'
+    - 'lib/unitsdb/commands/validate/ucum_references.rb'
+    - 'spec/unitsdb/commands/normalize_spec.rb'
+
+# Offense count: 9
+# Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches, IgnoreDuplicateElseBranch.
+Lint/DuplicateBranch:
+  Exclude:
+    - 'lib/unitsdb/commands/check_si/si_formatter.rb'
+    - 'lib/unitsdb/commands/qudt/matcher.rb'
+    - 'lib/unitsdb/commands/ucum/matcher.rb'
+    - 'lib/unitsdb/database.rb'
+
+# Offense count: 82
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
-  Max: 169
+  Enabled: false
 
-# Offense count: 27
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# Offense count: 12
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 173
-
-# Offense count: 3
-# Configuration parameters: CountComments, CountAsOne.
-Metrics/ClassLength:
-  Max: 441
+  Max: 62
 
-# Offense count: 38
-# Configuration parameters: AllowedMethods, AllowedPatterns.
+# Offense count: 73
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/CyclomaticComplexity:
-  Max: 50
+  Enabled: false
 
-# Offense count: 47
+# Offense count: 110
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 169
-
-# Offense count: 3
-# Configuration parameters: CountComments, CountAsOne.
-Metrics/ModuleLength:
-  Max: 369
+  Max: 150
 
 # Offense count: 2
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
   Max: 6
 
-# Offense count: 33
-# Configuration parameters: AllowedMethods, AllowedPatterns.
+# Offense count: 64
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/PerceivedComplexity:
-  Max: 56
-
-# Offense count: 1
-Naming/AccessorMethodName:
-  Exclude:
-    - 'lib/unitsdb/commands/si_formatter.rb'
+  Enabled: false
 
 # Offense count: 3
 # Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
 # AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
 Naming/MethodParameterName:
   Exclude:
-    - 'lib/unitsdb/commands/si_ttl_parser.rb'
+    - 'lib/unitsdb/commands/check_si/si_ttl_parser.rb'
     - 'lib/unitsdb/utils.rb'
 
+# Offense count: 9
+# Configuration parameters: MinSize.
+Performance/CollectionLiteralInLoop:
+  Exclude:
+    - 'lib/unitsdb/commands/check_si/si_formatter.rb'
+    - 'lib/unitsdb/commands/check_si/si_matcher.rb'
+    - 'lib/unitsdb/commands/check_si/si_updater.rb'
+    - 'lib/unitsdb/database.rb'
+
+# Offense count: 2
+RSpec/BeforeAfterAll:
+  Exclude:
+    - '**/spec/spec_helper.rb'
+    - '**/spec/rails_helper.rb'
+    - '**/spec/support/**/*.rb'
+    - 'spec/unitsdb/commands/validate/references_spec.rb'
+
+# Offense count: 2
+# Configuration parameters: Prefixes, AllowedPatterns.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/unitsdb/commands/check_si_command_spec.rb'
+
+# Offense count: 2
+# Configuration parameters: IgnoredMetadata.
+RSpec/DescribeClass:
+  Exclude:
+    - '**/spec/features/**/*'
+    - '**/spec/requests/**/*'
+    - '**/spec/routing/**/*'
+    - '**/spec/system/**/*'
+    - '**/spec/views/**/*'
+    - 'spec/exe/unitsdb_spec.rb'
+    - 'spec/unitsdb/version_compatibility_spec.rb'
+
+# Offense count: 43
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 30
+
+# Offense count: 22
+RSpec/ExpectOutput:
+  Exclude:
+    - 'spec/unitsdb/commands/check_si_command_spec.rb'
+    - 'spec/unitsdb/commands/get_spec.rb'
+    - 'spec/unitsdb/commands/normalize_spec.rb'
+    - 'spec/unitsdb/commands/search_spec.rb'
+    - 'spec/unitsdb/commands/validate/identifiers_spec.rb'
+    - 'spec/unitsdb/commands/validate/si_references_spec.rb'
+
+# Offense count: 8
+RSpec/LeakyLocalVariable:
+  Exclude:
+    - 'spec/unitsdb/database_spec.rb'
+    - 'spec/unitsdb/dimensions_spec.rb'
+    - 'spec/unitsdb/prefixes_spec.rb'
+    - 'spec/unitsdb/quantities_spec.rb'
+    - 'spec/unitsdb/scales_spec.rb'
+    - 'spec/unitsdb/unit_spec.rb'
+    - 'spec/unitsdb/unit_systems_spec.rb'
+    - 'spec/unitsdb/units_spec.rb'
+
+# Offense count: 6
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Offense count: 52
+RSpec/MultipleExpectations:
+  Max: 15
+
+# Offense count: 3
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 6
+
+# Offense count: 2
+# Configuration parameters: AllowedGroups.
+RSpec/NestedGroups:
+  Max: 4
+
+# Offense count: 2
+RSpec/RepeatedExample:
+  Exclude:
+    - 'spec/exe/unitsdb_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: CustomTransform, IgnoreMethods, IgnoreMetadata, InflectorPath, EnforcedInflector.
+# SupportedInflectors: default, active_support
+RSpec/SpecFilePathFormat:
+  Exclude:
+    - '**/spec/routing/**/*'
+    - 'spec/unitsdb/bundled_data_spec.rb'
+
+# Offense count: 17
+# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/unitsdb/commands/validate/qudt_references_spec.rb'
+    - 'spec/unitsdb/commands/validate/references_spec.rb'
+    - 'spec/unitsdb/commands/validate/ucum_references_spec.rb'
+
+# Offense count: 5
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, AllowedMethods, AllowedPatterns, AllowBracesOnProceduralOneLiners, BracesRequiredMethods.
+# SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
+# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
+# FunctionalMethods: let, let!, subject, watch
+# AllowedMethods: lambda, proc, it
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/unitsdb/commands/normalize_spec.rb'
+    - 'spec/unitsdb/commands/qudt/update_spec.rb'
+    - 'spec/unitsdb/commands/search_spec.rb'
+    - 'spec/unitsdb/commands/validate/qudt_references_spec.rb'
+    - 'spec/unitsdb/commands/validate/ucum_references_spec.rb'
+
 # Offense count: 1
 # This cop supports unsafe autocorrection (--autocorrect-all).
 Style/CombinableLoops:
   Exclude:
-    - 'lib/unitsdb/commands/si_matcher.rb'
-
-# Offense count: 40
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
-  Enabled: false
+    - 'lib/unitsdb/commands/check_si/si_matcher.rb'
 
 # Offense count: 2
 # This cop supports unsafe autocorrection (--autocorrect-all).
 Style/IdenticalConditionalBranches:
   Exclude:
-    - 'lib/unitsdb/commands/si_formatter.rb'
+    - 'lib/unitsdb/commands/check_si/si_formatter.rb'
 
 # Offense count: 1
-Style/MultilineBlockChain:
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle, AllowedMethods, AllowedPatterns.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
   Exclude:
-    - 'lib/unitsdb/commands/normalize.rb'
+    - 'spec/**/*'
+    - 'exe/unitsdb'
 
-# Offense count: 5
+# Offense count: 14
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: respond_to_missing?
 Style/OptionalBooleanParameter:
   Exclude:
     - 'lib/unitsdb/commands/check_si.rb'
-    - 'lib/unitsdb/commands/si_updater.rb'
+    - 'lib/unitsdb/commands/check_si/si_updater.rb'
+    - 'lib/unitsdb/commands/qudt/check.rb'
+    - 'lib/unitsdb/commands/qudt/update.rb'
+    - 'lib/unitsdb/commands/qudt/updater.rb'
+    - 'lib/unitsdb/commands/ucum/check.rb'
+    - 'lib/unitsdb/commands/ucum/updater.rb'
 
-# Offense count: 6
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
-# URISchemes: http, https
-Layout/LineLength:
-  Max: 140
+# Offense count: 1
+# Configuration parameters: Max.
+Style/SafeNavigationChainLength:
+  Exclude:
+    - 'lib/unitsdb/commands/check_si/si_matcher.rb'

data/CLAUDE.md

@@ -0,0 +1,55 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Development Commands
+
+```bash
+bundle install          # Install dependencies
+bundle exec rake        # Run full default task (rspec + rubocop)
+bundle exec rspec       # Run all tests
+bundle exec rspec spec/path/to/file_spec.rb  # Run single spec
+bundle exec rubocop     # Lint all files
+bundle exec rake build  # Build the gem
+```
+
+## Architecture
+
+### Bundled Data
+
+The gem ships UnitsDB YAML data files in `data/` (a git submodule at https://github.com/unitsml/unitsdb). These are included in the published gem via `spec.files += Dir.glob("data/**/*.yaml")` in the gemspec.
+
+Two entry points for the bundled data:
+- `Unitsdb.data_dir` — path to the `data/` directory inside the gem
+- `Unitsdb.database` — pre-loaded `Database.from_db(data_dir)` instance (cached)
+
+The correspondence between gem version and data version is tracked via
+`Unitsdb::UNITS_DATA_VERSION` (e.g. `"2.0.0"`). **The UnitsDB data must be
+released (tagged) before the gem can be released with updated data.** When
+releasing with new data: tag the data in `unitsml/unitsdb`, then update
+`.gitmodules` (`branch = refs/tags/new-data-tag`) and bump both `VERSION` and
+`UNITS_DATA_VERSION` in `lib/unitsdb/version.rb`.
+
+### Core Classes
+
+- **`Unitsdb::Database`** — Loads all YAML files, provides `search`, `get_by_id`, `find_by_type`, `find_by_symbol`, `match_entities`, `validate_uniqueness`, `validate_references`
+- **`Unitsdb::Cli`** (Thor-based) — Command-line interface with subcommands: `validate`, `search`, `get`, `check_si`, `ucum`, `qudt`, `_modify`, `release`
+- **`lib/unitsdb/commands/base.rb`** — Base class for commands; provides `load_database` and `@options[:database]`
+
+### Model Pattern
+
+Entity types (Unit, Prefix, Dimension, Quantity, UnitSystem, etc.) are Lutaml::Model-serializable classes. They are loaded from YAML via `Database.from_db`, which validates `schema_version: "2.0.0"` across all files and merges them into a single object.
+
+### Workflow Files
+
+Workflows in `.github/workflows/` are auto-generated by **Cimas** (metanorma/cimas) and delegate to shared reusable workflows in `metanorma/ci`:
+- `rake.yml` → `generic-rake.yml@main` — runs tests/lint on push/PR
+- `release.yml` → `rubygems-release.yml@main` — builds and publishes gem
+- `dependent-gems.yml` → `dependent-rake.yml@main` — tests downstream consumers
+
+### Git Submodule
+
+`data/` is a git submodule pinned to a specific tag in https://github.com/unitsml/unitsdb
+(e.g. `branch = refs/tags/v2.0.0` in `.gitmodules`). The CI `rake.yml` uses
+`submodules: 'recursive'` so tests have the data available. The release workflow
+uses `submodules: true` to initialize the submodule during checkout.

data/Gemfile

@@ -5,8 +5,12 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in suma.gemspec
 gemspec
 
-gem "diffy"
+gem "canon"
+gem "lutaml-model", github: "lutaml/lutaml-model", branch: "main"
+gem "nokogiri"
 gem "rake"
 gem "rspec"
 gem "rubocop"
 gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"