lutaml-store 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a51b678ada3133e9dec69b021b81f2f306f96839da6f6d3c6095542b4f1c518
-  data.tar.gz: 8157f4106efe708cc4b868ffa174004729e3e22a8a94ec519add41407d0c11a6
+  metadata.gz: 4917f68f56456a19670424157dd5001d243b9bd6d97618f445d306a7998e2a9f
+  data.tar.gz: 7076d765cf18cc91bfa9cf252bb0117ea8870c915bf1e7421648d9490de7e6a5
 SHA512:
-  metadata.gz: 639dcd3e75e7ec3c40128cf28c036aff3e003ab9db3460266260587c386aea5495bbe244376caef15b5555f541ff3715ce738b2ec93e501d622fafa290016881
-  data.tar.gz: 6942bb83e1ab2edb1c0a10afcdd7014baceb3c02319fc82714d54234e0a012105a3046adb76c09f12d9e861b9ea53b108bcfdb874836db81e8a08461d0237083
+  metadata.gz: 897f40bf4972373587528a80afcc44ab2b0c159f2bba63a97f39cb997eff97d3633d7e34cabeb0dac37e1b337781f0aef60b9ffaae2b3a3426d5624b35fb7950
+  data.tar.gz: 1b79b56672ace97f0b6e57715b1b56b7f4638b1d426db57b8f57c5ed21eb461a7fd2ff4181f57afaa094d85c9b7da37f9e3d4771c04afecfcef0c268e86ddcd7

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2026-06-03 01:47:04 UTC using RuboCop version 1.86.2.
+# on 2026-06-05 09:38:49 UTC using RuboCop version 1.87.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
@@ -11,131 +11,54 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'lutaml-store.gemspec'
 
-# Offense count: 15
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, IndentationWidth.
-# SupportedStyles: with_first_argument, with_fixed_indentation
-Layout/ArgumentAlignment:
-  Exclude:
-    - 'lib/lutaml/store/attribute_updater.rb'
-    - 'lib/lutaml/store/http_cache.rb'
-    - 'lib/lutaml/store/model_registry.rb'
-    - 'spec/lutaml/store/package_store_spec.rb'
-    - 'spec/lutaml/store/package_transport/directory_transport_spec.rb'
-    - 'spec/lutaml/store/package_transport/zip_transport_spec.rb'
-
-# Offense count: 8
-# This cop supports safe autocorrection (--autocorrect).
-Layout/EmptyLineAfterGuardClause:
-  Exclude:
-    - 'lib/lutaml/store/package_transport.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Layout/EmptyLines:
-  Exclude:
-    - 'lib/lutaml/store/package_store.rb'
-
-# Offense count: 3
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowForAlignment, AllowBeforeTrailingComments, ForceEqualSignAlignment.
-Layout/ExtraSpacing:
-  Exclude:
-    - 'lib/lutaml/store/package_store.rb'
-    - 'lib/lutaml/store/package_transport.rb'
-
-# Offense count: 3
-# 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:
-    - 'spec/lutaml/store/package_transport/directory_transport_spec.rb'
-    - 'spec/lutaml/store/package_transport/zip_transport_spec.rb'
-
-# Offense count: 13
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, IndentationWidth.
-# SupportedStyles: aligned, indented, indented_relative_to_receiver
-Layout/MultilineMethodCallIndentation:
-  Exclude:
-    - 'lib/lutaml/store/package_store.rb'
-    - 'lib/lutaml/store/package_transport.rb'
-
-# Offense count: 3
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleInsidePipes.
-# SupportedStylesInsidePipes: space, no_space
-Layout/SpaceAroundBlockParameters:
-  Exclude:
-    - 'lib/lutaml/store/package_store.rb'
-    - 'lib/lutaml/store/package_transport.rb'
-
-# Offense count: 5
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowInHeredoc.
-Layout/TrailingWhitespace:
-  Exclude:
-    - 'lib/lutaml/store/attribute_updater.rb'
-    - 'lib/lutaml/store/http_cache.rb'
-    - 'lib/lutaml/store/model_registry.rb'
-
-# Offense count: 1
-Lint/IneffectiveAccessModifier:
-  Exclude:
-    - 'lib/lutaml/store/package_store.rb'
-
-# Offense count: 30
+# Offense count: 29
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 112
 
-# Offense count: 56
+# Offense count: 57
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 315
+  Max: 387
 
-# Offense count: 17
+# Offense count: 16
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
   Max: 379
 
-# Offense count: 10
+# Offense count: 9
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
-  Max: 11
+  Max: 12
 
-# Offense count: 82
+# Offense count: 79
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 84
 
-# Offense count: 4
+# Offense count: 5
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
   Max: 8
 
-# Offense count: 6
+# Offense count: 4
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
-  Max: 11
+  Max: 12
 
 # Offense count: 1
 Naming/AccessorMethodName:
   Exclude:
     - 'lib/lutaml/store/adapter/sqlite.rb'
 
-# Offense count: 12
+# 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:
     - 'demo/vcard_models.rb'
     - 'demo/vcard_store_demo.rb'
-    - 'lib/lutaml/store/package_transport.rb'
 
 # Offense count: 1
 # Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros, UseSorbetSigs.
@@ -161,94 +84,7 @@ Security/MarshalLoad:
   Exclude:
     - 'lib/lutaml/store/format/marshal_format.rb'
 
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: separated, grouped
-Style/AccessorGrouping:
-  Exclude:
-    - 'lib/lutaml/store/package_store.rb'
-
-# Offense count: 2
-# 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/lutaml/store/package_definition_spec.rb'
-    - 'spec/lutaml/store/package_transport/directory_transport_spec.rb'
-
-# Offense count: 34
+# Offense count: 36
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Enabled: false
-
-# Offense count: 2
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: AllowedReceivers.
-# AllowedReceivers: Thread.current
-Style/HashEachMethods:
-  Exclude:
-    - 'lib/lutaml/store/cache_store.rb'
-    - 'lib/lutaml/store/database_store.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Style/KeywordParametersOrder:
-  Exclude:
-    - 'lib/lutaml/store/package_definition.rb'
-
-# Offense count: 5
-# This cop supports safe autocorrection (--autocorrect).
-Style/MultilineIfModifier:
-  Exclude:
-    - 'lib/lutaml/store/attribute_updater.rb'
-    - 'lib/lutaml/store/http_cache.rb'
-    - 'lib/lutaml/store/model_registry.rb'
-
-# Offense count: 2
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: SafeForConstants.
-Style/RedundantFetchBlock:
-  Exclude:
-    - 'spec/lutaml/store/cache_store_spec.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Style/RedundantRegexpEscape:
-  Exclude:
-    - 'lib/lutaml/store/package_transport.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, diff_comma, no_comma
-Style/TrailingCommaInArrayLiteral:
-  Exclude:
-    - 'spec/lutaml/store/format/yamls_spec.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, diff_comma, no_comma
-Style/TrailingCommaInHashLiteral:
-  Exclude:
-    - 'lib/lutaml/store/package_store.rb'
-
-# Offense count: 3
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, IgnoreClassMethods, AllowedMethods.
-# AllowedMethods: to_ary, to_a, to_c, to_enum, to_h, to_hash, to_i, to_int, to_io, to_open, to_path, to_proc, to_r, to_regexp, to_str, to_s, to_sym
-Style/TrivialAccessors:
-  Exclude:
-    - 'lib/lutaml/store/package_store.rb'
-
-# Offense count: 5
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
-# URISchemes: http, https
-Layout/LineLength:
-  Max: 148

data/CLAUDE.md

@@ -28,30 +28,43 @@ This is a Ruby gem (`lutaml-store`) providing a store-centric database-style API
 
 | Class | Role |
 |---|---|
-| `DatabaseStore` | High-level CRUD with model registry, composite models, polymorphism |
+| `DatabaseStore` | High-level CRUD with model registry, composite models, polymorphism, file I/O |
 | `BasicStore` | Low-level key-value store with optional cache/monitor/events |
 | `CacheStore` | TTL-aware cache store extending `BasicStore` |
+| `PackageStore` | Structured multi-model packages with directory/ZIP transport |
+| `PackageDefinition` | Declarative schema for package structure (models, assets, metadata) |
 | `ModelRegistry` / `ModelRegistration` | Register models with their key fields and polymorphic config |
 | `CompositeModelHandler` | Stores nested registered models independently, restores references |
 | `AttributeUpdater` | Processes updates including dot-notation paths and block-based updates |
-| `ModelSerializer` | Single point of serialization/deserialization for Lutaml::Model objects |
-| `Config` | Parses and validates store configuration (adapter, cache, monitoring, compression) |
+| `ModelSerializer` | Hash-based serialization/deserialization for key-value storage |
+| `FormatSerializer` | Bridges any Format handler to ModelSerializer interface for DatabaseStore |
+| `Format` | Multi-format file I/O (YAML, YAMLS, JSON, JSONL, Marshal, XML) |
+| `Adapter` | Storage adapter registry and factory (Memory, FileSystem, SQLite) |
+
+### Format handlers (`lib/lutaml/store/format/`)
+
+All inherit from `Format::Base`. Six formats: `Yaml`, `Yamls`, `Json`, `Jsonl`, `MarshalFormat`, `Xml`. Each implements `serialize`/`deserialize`, optional `serialize_many`/`deserialize_many`, `extension`, `glob_pattern`, and `binary?`. Registered in `Format::FORMATS` hash and resolved via `Format.resolve(:symbol)`.
 
 ### Storage adapters (`lib/lutaml/store/adapter/`)
 
-All inherit from `Adapter::Base`. Three backends: `Memory`, `FileSystem`, `SQLite`. The `DatabaseStore` creates the adapter internally via `BasicStore`; the adapter type is passed as `adapter: :memory`, `adapter: { type: :filesystem, path: "..." }`, etc.
+All inherit from `Adapter::Base`. Three backends: `Memory`, `FileSystem`, `SQLite`. Registered in `Adapter` module and resolved via `Adapter.resolve(:type, options)`. New adapters can be added with `Adapter.register(:custom, CustomClass)` without modifying existing code (OCP).
 
-### HTTP caching
+### PackageStore and transports
 
-`HttpCache` provides HTTP-aware caching with ETags, conditional requests (304), Cache-Control, and Vary header support. Used by lutaml-hal to avoid re-fetching HAL resources.
+`PackageStore` provides structured multi-model persistence. `PackageDefinition` declares which models, assets, and metadata the package contains. Transports (`DirectoryTransport`, `ZipTransport`) handle reading/writing to disk. Format handlers determine serialization per model entry.
 
-### Serialization & integrity
+### FormatSerializer pattern
+
+`FormatSerializer` wraps a Format handler to implement the serializer interface (serialize/deserialize). This enables `DatabaseStore` to use any format (YAMLS, XML, Marshal, etc.) for key-value storage instead of the default hash serialization. Used for Glossarist-like YAMLS patterns.
+
+### HTTP caching
 
-`Compression` adds gzip support. `Integrity` provides SHA256 checksums for data verification (used by the FileSystem adapter).
+`HttpCache` provides HTTP-aware caching with ETags, conditional requests (304), Cache-Control, and Vary header support. Uses `to_json`/`from_json` for model-driven serialization.
 
 ## Conventions
 
 - Double-quoted strings (Rubocop enforced)
 - Specs use `expect` syntax (no `should`)
-- Documentation is in AsciiDoc (README.adoc, plan.adoc)
+- Documentation is in AsciiDoc (README.adoc)
+- All library code uses Ruby `autoload` (no `require_relative` or internal `require`)
 - Error hierarchy: `Lutaml::Store::Error` → `ConfigurationError`, `BackendError`, `ModelNotRegisteredError`, `InvalidKeyError`, `PolymorphicUpdateError`, `CompositeModelError`