lutaml-store 0.1.1 → 0.2.1

data/lib/lutaml/store/package_transport/directory_transport.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+module Lutaml
+  module Store
+    module PackageTransport
+      class DirectoryTransport < Base
+        def read(path, package_store, format: nil)
+          definition = package_store.definition
+          global_format = format
+
+          read_metadata(path, package_store)
+
+          definition.model_entries.each do |entry|
+            fmt_name = global_format || entry.default_format
+            read_model_entry(path, entry, package_store, fmt_name)
+          end
+
+          definition.asset_entries.each do |entry|
+            read_asset_entry(path, entry, package_store)
+          end
+        end
+
+        def write(path, package_store, formats: {})
+          definition = package_store.definition
+          FileUtils.mkdir_p(path)
+
+          write_metadata(path, package_store)
+
+          definition.model_entries.each do |entry|
+            fmt_name = effective_format(entry, formats)
+            fmt = resolve_format(fmt_name)
+            write_model_entry(path, entry, package_store, fmt)
+          end
+
+          definition.asset_entries.each do |entry|
+            write_asset_entry(path, entry, package_store)
+          end
+        end
+
+        private
+
+        def read_metadata(path, package_store)
+          definition = package_store.definition
+          return unless definition.metadata_model && definition.metadata_file
+
+          file_path = File.join(path, definition.metadata_file)
+          return unless File.exist?(file_path)
+
+          fmt = format_for_file(definition.metadata_file)
+          raw = File.read(file_path, encoding: "utf-8")
+          metadata = fmt.deserialize(raw, definition.metadata_model)
+          package_store.metadata = metadata
+        end
+
+        def write_metadata(path, package_store)
+          return unless package_store.metadata
+
+          definition = package_store.definition
+          fmt = format_for_file(definition.metadata_file)
+          content = fmt.serialize(package_store.metadata)
+          file_path = File.join(path, definition.metadata_file)
+          FileUtils.mkdir_p(File.dirname(file_path))
+          File.write(file_path, content, encoding: "utf-8")
+        end
+
+        def read_model_entry(base_path, entry, package_store, fmt_name)
+          if entry.file
+            read_single_file_model(base_path, entry, package_store, fmt_name)
+          else
+            read_directory_models(base_path, entry, package_store, fmt_name)
+          end
+        end
+
+        def read_single_file_model(base_path, entry, package_store, fmt_name)
+          file_path = File.join(base_path, entry.file)
+          return unless File.exist?(file_path)
+
+          fmt = resolve_format(fmt_name)
+          raw = File.read(file_path, encoding: "utf-8")
+          model = fmt.deserialize(raw, entry.model)
+          package_store.add_model(model)
+        end
+
+        def read_directory_models(base_path, entry, package_store, fmt_name)
+          dir = entry.dir ? File.join(base_path, entry.dir) : base_path
+          return unless Dir.exist?(dir)
+
+          fmt = resolve_format(fmt_name)
+          glob = File.join(dir, fmt.glob_pattern)
+
+          Dir.glob(glob).sort.each do |file_path|
+            next unless File.file?(file_path)
+
+            raw = File.read(file_path, encoding: "utf-8")
+            next if raw.strip.empty?
+
+            begin
+              case entry.layout
+              when :grouped
+                fmt.deserialize_many(raw, entry.model).each do |m|
+                  set_key_from_filename(m, file_path, entry)
+                  package_store.add_model(m)
+                end
+              else
+                model = fmt.deserialize(raw, entry.model)
+                set_key_from_filename(model, file_path, entry)
+                package_store.add_model(model)
+              end
+            rescue StandardError => e
+              warn "PackageStore: failed to load #{file_path}: #{e.message}"
+            end
+          end
+        end
+
+        def write_model_entry(base_path, entry, package_store, fmt)
+          models = package_store.models_for(entry.model)
+          return if models.empty?
+
+          if entry.file
+            write_single_file_model(base_path, entry, models, fmt)
+          else
+            write_directory_models(base_path, entry, models, fmt)
+          end
+        end
+
+        def write_single_file_model(base_path, entry, models, fmt)
+          content = entry.layout == :grouped ? fmt.serialize_many(models) : fmt.serialize(models.first)
+          file_path = File.join(base_path, entry.file)
+          FileUtils.mkdir_p(File.dirname(file_path))
+          File.write(file_path, content, encoding: "utf-8")
+        end
+
+        def write_directory_models(base_path, entry, models, fmt)
+          dir = entry.dir ? File.join(base_path, entry.dir) : base_path
+          FileUtils.mkdir_p(dir)
+
+          case entry.layout
+          when :grouped
+            models.group_by { |m| extract_key(m, entry) }.each do |key, group|
+              file_path = File.join(dir, "#{sanitize_filename(key)}#{fmt.extension}")
+              File.write(file_path, fmt.serialize_many(group), encoding: "utf-8")
+            end
+          else
+            models.each do |model|
+              key = extract_key(model, entry)
+              file_path = File.join(dir, "#{sanitize_filename(key)}#{fmt.extension}")
+              File.write(file_path, fmt.serialize(model), encoding: "utf-8")
+            end
+          end
+        end
+
+        def read_asset_entry(base_path, entry, package_store)
+          full_path = File.join(base_path, entry.path)
+          case entry.type
+          when :file
+            return unless File.exist?(full_path)
+
+            package_store.add_asset(entry.path, File.binread(full_path))
+          when :directory
+            return unless Dir.exist?(full_path)
+
+            Dir.glob(File.join(full_path, "**", "*")).each do |file|
+              next unless File.file?(file)
+
+              relative = file.sub(%r{\A#{Regexp.escape(base_path)}/}, "")
+              package_store.add_asset(relative, File.binread(file))
+            end
+          end
+        end
+
+        def write_asset_entry(base_path, entry, package_store)
+          case entry.type
+          when :file
+            content = package_store.asset(entry.path)
+            return unless content
+
+            file_path = File.join(base_path, entry.path)
+            FileUtils.mkdir_p(File.dirname(file_path))
+            File.binwrite(file_path, content)
+          when :directory
+            package_store.asset_paths
+                         .select { |p| p.start_with?("#{entry.path}/") }
+                         .each do |asset_path|
+                           content = package_store.asset(asset_path)
+                           next unless content
+
+                           file_path = File.join(base_path, asset_path)
+                           FileUtils.mkdir_p(File.dirname(file_path))
+                           File.binwrite(file_path, content)
+                         end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lutaml/store/package_transport/zip_transport.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require "zip"
+
+module Lutaml
+  module Store
+    module PackageTransport
+      class ZipTransport < Base
+        def read(path, package_store, format: nil)
+          definition = package_store.definition
+          global_format = format
+
+          Zip::File.open(path) do |zip_file|
+            read_metadata_zip(zip_file, package_store)
+
+            definition.model_entries.each do |entry|
+              fmt_name = global_format || entry.default_format
+              read_model_entry_zip(zip_file, entry, package_store, fmt_name)
+            end
+
+            definition.asset_entries.each do |entry|
+              read_asset_entry_zip(zip_file, entry, package_store)
+            end
+          end
+        end
+
+        def write(path, package_store, formats: {})
+          definition = package_store.definition
+          FileUtils.mkdir_p(File.dirname(path))
+
+          Zip::File.open(path, create: true) do |zip_file|
+            write_metadata_zip(zip_file, package_store)
+
+            definition.model_entries.each do |entry|
+              fmt_name = effective_format(entry, formats)
+              fmt = resolve_format(fmt_name)
+              write_model_entry_zip(zip_file, entry, package_store, fmt)
+            end
+
+            write_assets_zip(zip_file, package_store)
+          end
+        end
+
+        private
+
+        def read_metadata_zip(zip_file, package_store)
+          definition = package_store.definition
+          return unless definition.metadata_model && definition.metadata_file
+
+          entry = zip_file.find_entry(definition.metadata_file)
+          return unless entry
+
+          fmt = format_for_file(definition.metadata_file)
+          raw = entry.get_input_stream.read
+          metadata = fmt.deserialize(raw, definition.metadata_model)
+          package_store.metadata = metadata
+        end
+
+        def write_metadata_zip(zip_file, package_store)
+          return unless package_store.metadata
+
+          definition = package_store.definition
+          fmt = format_for_file(definition.metadata_file)
+          content = fmt.serialize(package_store.metadata)
+          zip_file.get_output_stream(definition.metadata_file) { |f| f.write(content) }
+        end
+
+        def read_model_entry_zip(zip_file, entry, package_store, fmt_name)
+          fmt = resolve_format(fmt_name)
+
+          if entry.file
+            read_single_file_zip(zip_file, entry, package_store, fmt)
+          else
+            read_directory_zip(zip_file, entry, package_store, fmt)
+          end
+        end
+
+        def read_single_file_zip(zip_file, entry, package_store, fmt)
+          zip_entry = zip_file.find_entry(entry.file)
+          return unless zip_entry
+
+          raw = zip_entry.get_input_stream.read
+          model = fmt.deserialize(raw, entry.model)
+          package_store.add_model(model)
+        end
+
+        def read_directory_zip(zip_file, entry, package_store, fmt)
+          prefix = entry.dir ? "#{entry.dir}/" : ""
+
+          zip_file.entries.each do |zip_entry|
+            next unless zip_entry.name.start_with?(prefix)
+            next unless matches_format?(zip_entry.name, fmt)
+            next if zip_entry.name == prefix || zip_entry.name.end_with?("/")
+
+            raw = zip_entry.get_input_stream.read
+            next if raw.strip.empty?
+
+            begin
+              loaded = fmt.deserialize_many(raw, entry.model)
+              loaded = [loaded] unless loaded.is_a?(Array)
+              loaded.each do |m|
+                set_key_from_zip_path(m, zip_entry.name, entry, prefix)
+                package_store.add_model(m)
+              end
+            rescue StandardError => e
+              warn "PackageStore: failed to load #{zip_entry.name}: #{e.message}"
+            end
+          end
+        end
+
+        def write_model_entry_zip(zip_file, entry, package_store, fmt)
+          models = package_store.models_for(entry.model)
+          return if models.empty?
+
+          if entry.file
+            content = entry.layout == :grouped ? fmt.serialize_many(models) : fmt.serialize(models.first)
+            zip_file.get_output_stream(entry.file) { |f| f.write(content) }
+          else
+            write_directory_models_zip(zip_file, entry, models, fmt)
+          end
+        end
+
+        def write_directory_models_zip(zip_file, entry, models, fmt)
+          prefix = entry.dir ? "#{entry.dir}/" : ""
+
+          case entry.layout
+          when :grouped
+            models.group_by { |m| extract_key(m, entry) }.each do |key, group|
+              filename = "#{prefix}#{sanitize_filename(key)}#{fmt.extension}"
+              zip_file.get_output_stream(filename) { |f| f.write(fmt.serialize_many(group)) }
+            end
+          else
+            models.each do |model|
+              key = extract_key(model, entry)
+              filename = "#{prefix}#{sanitize_filename(key)}#{fmt.extension}"
+              zip_file.get_output_stream(filename) { |f| f.write(fmt.serialize(model)) }
+            end
+          end
+        end
+
+        def read_asset_entry_zip(zip_file, entry, package_store)
+          case entry.type
+          when :file
+            zip_entry = zip_file.find_entry(entry.path)
+            package_store.add_asset(entry.path, zip_entry.get_input_stream.read) if zip_entry
+          when :directory
+            prefix = entry.path.end_with?("/") ? entry.path : "#{entry.path}/"
+            zip_file.entries.each do |zip_entry|
+              next unless zip_entry.name.start_with?(prefix)
+              next if zip_entry.name == prefix || zip_entry.name.end_with?("/")
+
+              package_store.add_asset(zip_entry.name, zip_entry.get_input_stream.read)
+            end
+          end
+        end
+
+        def write_assets_zip(zip_file, package_store)
+          package_store.asset_paths.each do |asset_path|
+            content = package_store.asset(asset_path)
+            zip_file.get_output_stream(asset_path) { |f| f.write(content) } if content
+          end
+        end
+
+        def set_key_from_zip_path(model, zip_path, entry, prefix)
+          return if model.public_send(entry.key)
+
+          filename = zip_path.sub(prefix, "")
+          set_key_from_filename(model, filename, entry)
+        end
+
+        def matches_format?(name, fmt)
+          ext = File.extname(name)
+          ext == fmt.extension || (fmt.extension == ".yaml" && ext == ".yml")
+        end
+      end
+    end
+  end
+end

data/lib/lutaml/store/package_transport.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Lutaml
+  module Store
+    module PackageTransport
+      autoload :Base, "lutaml/store/package_transport/base"
+      autoload :DirectoryTransport, "lutaml/store/package_transport/directory_transport"
+      autoload :ZipTransport, "lutaml/store/package_transport/zip_transport"
+
+      TRANSPORTS = {
+        directory: "DirectoryTransport",
+        zip: "ZipTransport"
+      }.freeze
+
+      def self.resolve(transport)
+        entry = TRANSPORTS[transport.to_sym]
+        raise ConfigurationError, "Unknown transport: #{transport}" unless entry
+
+        const_get(entry).new
+      end
+    end
+  end
+end

data/lib/lutaml/store/version.rb

@@ -2,6 +2,6 @@
 
 module Lutaml
   module Store
-    VERSION = "0.1.1"
+    VERSION = "0.2.1"
   end
 end

data/lib/lutaml/store.rb

@@ -25,6 +25,9 @@ module Lutaml
     autoload :CompositeModelHandler, "lutaml/store/composite_model_handler"
     autoload :AttributeUpdater, "lutaml/store/attribute_updater"
     autoload :DatabaseStore, "lutaml/store/database_store"
+    autoload :PackageDefinition, "lutaml/store/package_definition"
+    autoload :PackageStore, "lutaml/store/package_store"
+    autoload :PackageTransport, "lutaml/store/package_transport"
     autoload :Adapter, "lutaml/store/adapter"
     autoload :StorageKey, "lutaml/store/storage_key"
     autoload :Format, "lutaml/store/format"

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lutaml-store
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Ronald Tse
+autorequire:
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lutaml-model
@@ -23,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.15
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 description: |
   Provides a unified store interface for Lutaml::Model objects with model registry,
   polymorphic support, composite relationships, and multiple storage backends
@@ -33,52 +48,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
-- ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - CLAUDE.md
 - CODE_OF_CONDUCT.md
-- CORRECTED_HTTP_CACHE_IMPLEMENTATION.md
-- CORRECTED_HTTP_CACHE_PLAN.md
-- Gemfile
-- Gemfile.lock
 - README.adoc
 - Rakefile
-- TODO.impl/0-lutaml-store-self-quality.md
-- TODO.impl/1-lutaml-hal-migration.md
-- TODO.impl/2-glossarist-migration.md
-- TODO.impl/3-lutaml-jsonschema-migration.md
-- bin/console
-- bin/setup
-- demo/Gemfile
-- demo/Gemfile.lock
-- demo/README.adoc
-- demo/data/vcards.db
-- demo/data/vcards/co/contact_10_thompson.data
-- demo/data/vcards/co/contact_10_thompson.meta
-- demo/data/vcards/co/contact_1_doe.data
-- demo/data/vcards/co/contact_1_doe.meta
-- demo/data/vcards/co/contact_2_smith.data
-- demo/data/vcards/co/contact_2_smith.meta
-- demo/data/vcards/co/contact_3_johnson.data
-- demo/data/vcards/co/contact_3_johnson.meta
-- demo/data/vcards/co/contact_4_garcia.data
-- demo/data/vcards/co/contact_4_garcia.meta
-- demo/data/vcards/co/contact_5_wilson.data
-- demo/data/vcards/co/contact_5_wilson.meta
-- demo/data/vcards/co/contact_6_brown.data
-- demo/data/vcards/co/contact_6_brown.meta
-- demo/data/vcards/co/contact_7_davis.data
-- demo/data/vcards/co/contact_7_davis.meta
-- demo/data/vcards/co/contact_8_anderson.data
-- demo/data/vcards/co/contact_8_anderson.meta
-- demo/data/vcards/co/contact_9_taylor.data
-- demo/data/vcards/co/contact_9_taylor.meta
-- demo/pottery_class_demo.rb
-- demo/vcard_models.rb
-- demo/vcard_store_demo.rb
 - lib/lutaml/store.rb
 - lib/lutaml/store/adapter.rb
 - lib/lutaml/store/adapter/base.rb
@@ -110,42 +86,24 @@ files:
 - lib/lutaml/store/model_registry.rb
 - lib/lutaml/store/model_serializer.rb
 - lib/lutaml/store/monitor.rb
+- lib/lutaml/store/package_definition.rb
+- lib/lutaml/store/package_store.rb
+- lib/lutaml/store/package_transport.rb
+- lib/lutaml/store/package_transport/base.rb
+- lib/lutaml/store/package_transport/directory_transport.rb
+- lib/lutaml/store/package_transport/zip_transport.rb
 - lib/lutaml/store/storage_key.rb
 - lib/lutaml/store/version.rb
-- lutaml-store.gemspec
-- plan.adoc
 - sig/lutaml/store.rbs
-- spec/lutaml/store/adapter_interface_spec.rb
-- spec/lutaml/store/anti_pattern_guard_spec.rb
-- spec/lutaml/store/anti_pattern_spec.rb
-- spec/lutaml/store/autoload_spec.rb
-- spec/lutaml/store/cache_store_spec.rb
-- spec/lutaml/store/compression_spec.rb
-- spec/lutaml/store/config_enhanced_spec.rb
-- spec/lutaml/store/corrected_http_cache_integration_spec.rb
-- spec/lutaml/store/custom_serializer_spec.rb
-- spec/lutaml/store/database_store_spec.rb
-- spec/lutaml/store/file_io_spec.rb
-- spec/lutaml/store/format_round_trip_spec.rb
-- spec/lutaml/store/format_spec.rb
-- spec/lutaml/store/http_cache_entry_spec.rb
-- spec/lutaml/store/http_cache_hal_integration_spec.rb
-- spec/lutaml/store/http_cache_spec.rb
-- spec/lutaml/store/http_header_processor_spec.rb
-- spec/lutaml/store/import_spec.rb
-- spec/lutaml/store/integrity_spec.rb
-- spec/lutaml/store/key_collision_serializer_spec.rb
-- spec/lutaml/store/load_save_spec.rb
-- spec/lutaml/store/lutaml_model_integration_spec.rb
-- spec/lutaml/store/model_serializer_spec.rb
-- spec/lutaml/store/store_spec.rb
-- spec/lutaml/store_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/lutaml/lutaml-store
 licenses:
 - BSD-2-Clause
 metadata:
+  homepage_uri: https://github.com/lutaml/lutaml-store
+  source_code_uri: https://github.com/lutaml/lutaml-store
+  changelog_uri: https://github.com/lutaml/lutaml-store
   rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -160,7 +118,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Store-centric database-style API for Lutaml::Model with multi-backend persistence.
 test_files: []

data/.github/workflows/main.yml

@@ -1,27 +0,0 @@
-name: Ruby
-
-on:
-  push:
-    branches:
-      - main
-
-  pull_request:
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    name: Ruby ${{ matrix.ruby }}
-    strategy:
-      matrix:
-        ruby:
-          - '3.3.2'
-
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-      - name: Run the default task
-        run: bundle exec rake

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-*.gem