lutaml 0.10.18 → 0.11.2

data/examples/lur_basic_usage.rb

@@ -1,220 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-# Example: Basic LUR Repository Operations
-#
-# This example demonstrates basic repository operations including:
-# - Loading from XMI or LUR files
-# - Finding packages and classes
-# - Navigating inheritance hierarchies
-# - Querying associations
-
-# Load local development version
-$LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
-
-require "lutaml"
-require "lutaml/uml_repository/repository"
-
-# Example 1: Load from XMI file
-puts "=" * 80
-puts "Example 1: Load from XMI"
-puts "=" * 80
-
-# Build repository from XMI (slow, 5-8 seconds for large models)
-# repo = Lutaml::UmlRepository::Repository.from_xmi("model.xmi")
-
-# Or use smart file detection (auto-detects .xmi or .lur)
-# repo = Lutaml::UmlRepository::Repository.from_file("model.xmi")
-
-# For this example, we'll show the API without actual file
-puts "repo = Lutaml::UmlRepository::Repository.from_xmi('model.xmi')"
-puts "# Builds indexes from XMI (5-8s for large models)"
-puts
-
-# Example 2: Load from LUR package (fast loading)
-puts "=" * 80
-puts "Example 2: Load from LUR package (< 100ms)"
-puts "=" * 80
-
-puts "repo = Lutaml::UmlRepository::Repository.from_package('model.lur')"
-puts "# Fast loading from pre-indexed package"
-puts
-
-# Example 3: Smart caching
-puts "=" * 80
-puts "Example 3: Smart caching"
-puts "=" * 80
-
-puts "repo = Lutaml::UmlRepository::Repository.from_file_cached('model.xmi')"
-puts "# Uses cached .lur if newer than .xmi, otherwise rebuilds"
-puts
-
-# For demonstration, let's use a QEA file if available
-qea_file = Dir.glob("examples/qea/*.qea").first
-puts "=" * 80
-if qea_file
-  puts "Example 4: Loading from QEA file (10-20x faster than XMI)"
-  puts "=" * 80
-  puts "QEA file found: #{qea_file}"
-
-  # Parse QEA directly
-  document = Lutaml::Qea.parse(qea_file)
-  repo = Lutaml::UmlRepository::Repository.new(document: document)
-
-  puts "Loaded successfully!"
-  puts
-
-  # Example 5: Finding packages
-  puts "=" * 80
-  puts "Example 5: Finding packages"
-  puts "=" * 80
-
-  # Find root package
-  root = repo.find_package("ModelRoot")
-  if root
-    puts "Root package: #{root.name}"
-    puts "Root type: #{root.class}"
-  end
-  puts
-
-  # List top-level packages
-  packages = repo.list_packages("ModelRoot", recursive: false)
-  puts "Top-level packages (#{packages.size}):"
-  packages.first(5).each do |pkg|
-    puts "  - #{pkg.name}"
-  end
-  puts "  ..." if packages.size > 5
-  puts
-
-  # Example 6: Finding classes
-  puts "=" * 80
-  puts "Example 6: Finding classes"
-  puts "=" * 80
-
-  # Get all classes
-  all_classes = repo.classes_index
-  puts "Total classes: #{all_classes.size}"
-  puts
-
-  # Find by stereotype
-  if all_classes.any?
-    first_class = all_classes.first
-    puts "First class: #{first_class.name}"
-    if first_class.respond_to?(:stereotype) && first_class.stereotype
-      puts "  Stereotype: #{first_class.stereotype}"
-    end
-  end
-  puts
-
-  # Example 7: Working with associations
-  puts "=" * 80
-  puts "Example 7: Associations"
-  puts "=" * 80
-
-  associations = repo.associations_index
-  puts "Total associations: #{associations.size}"
-
-  if associations.any?
-    assoc = associations.first
-    puts "\nFirst association:"
-    member_end = assoc.member_end
-    if member_end.is_a?(Array) && member_end.any?
-      puts "  Name: #{member_end.first&.name || 'unnamed'}"
-    elsif member_end.respond_to?(:name)
-      puts "  Name: #{member_end.name}"
-    else
-      puts "  Name: unnamed"
-    end
-
-    member_end_type = assoc.member_end_type
-    if member_end_type.is_a?(Array) && member_end_type.any?
-      puts "  Type: #{member_end_type.first}"
-    elsif member_end_type
-      puts "  Type: #{member_end_type}"
-    end
-  end
-  puts
-
-  # Example 8: Statistics
-  puts "=" * 80
-  puts "Example 8: Repository statistics"
-  puts "=" * 80
-
-  stats = repo.statistics
-  puts "Packages: #{stats[:total_packages]}"
-  puts "Classes: #{stats[:total_classes]}"
-  puts "Associations: #{stats[:total_associations]}"
-  puts "Diagrams: #{stats[:total_diagrams]}"
-
-  if stats[:classes_by_stereotype]
-    puts "\nClasses by stereotype:"
-    stats[:classes_by_stereotype].first(5).each do |stereotype, count|
-      puts "  #{stereotype}: #{count}"
-    end
-  end
-  puts
-
-  # Example 9: Search
-  puts "=" * 80
-  puts "Example 9: Search"
-  puts "=" * 80
-
-  # Search for elements
-  results = repo.search("Object", types: [:class])
-  puts "Search for 'Object' in class names:"
-  puts "  Found #{results[:total]} matches"
-  if results[:classes]
-    puts "  Classes (#{results[:classes].size}):"
-    results[:classes].first(3).each do |result|
-      puts "    - #{result.element.name}"
-    end
-  end
-  puts
-
-else
-  puts "No QEA files found in examples/qea/"
-  puts "=" * 80
-  puts
-  puts "To use this example:"
-  puts "1. Place a .qea or .xmi file in examples/qea/"
-  puts "2. Or modify the script to point to your model file"
-  puts
-  puts "Example API usage (without actual file):"
-  puts <<~RUBY
-
-    # Load repository
-    repo = Lutaml::UmlRepository::Repository.from_xmi("model.xmi")
-
-    # Find package
-    package = repo.find_package("ModelRoot::MyPackage")
-
-    # Find class
-    klass = repo.find_class("ModelRoot::MyPackage::MyClass")
-
-    # Get class attributes
-    klass.attributes.each do |attr|
-      puts "\#{attr.name}: \#{attr.type}"
-    end
-
-    # Find by stereotype
-    feature_types = repo.find_classes_by_stereotype("featureType")
-
-    # Get inheritance
-    parent = repo.supertype_of(klass)
-    children = repo.subtypes_of(klass)
-
-    # Get associations
-    assocs = repo.associations_of(klass)
-
-    # Search
-    results = repo.search("Building")
-
-    # Get statistics
-    stats = repo.statistics
-    puts "Total classes: \#{stats[:total_classes]}"
-  RUBY
-end
-
-puts "=" * 80
-puts "Example complete!"
-puts "=" * 80

data/examples/lur_cli_workflow.rb

@@ -1,262 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-# Example: CLI Workflow Patterns
-#
-# This example demonstrates common command-line workflow patterns for
-# working with LUR packages, including building, validation, and export.
-
-# Load local development version
-$LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
-
-require "lutaml"
-require "lutaml/uml_repository/repository"
-require "fileutils"
-
-puts "=" * 80
-puts "LUR CLI Workflow Examples"
-puts "=" * 80
-puts
-
-# Setup: Find a test file
-qea_file = Dir.glob("examples/qea/*.qea").first
-xmi_file = Dir.glob("examples/qea/*.xmi").first
-test_file = qea_file || xmi_file
-
-unless test_file
-  puts "No test files found in examples/qea/"
-  puts
-  puts "This example demonstrates CLI workflows. To run:"
-  puts "  1. Place a .qea or .xmi file in examples/qea/"
-  puts "  2. Or use the CLI commands directly:"
-  puts
-  puts "CLI command examples:"
-  puts <<~TEXT
-    # Build LUR package from XMI
-    $ lutaml uml build model.xmi -o model.lur
-
-    # Build from QEA (10-20x faster)
-    $ lutaml uml build model.qea -o model.lur
-
-    # Show package info
-    $ lutaml uml info model.lur
-
-    # List packages
-    $ lutaml uml ls model.lur
-
-    # Show package tree
-    $ lutaml uml tree model.lur --depth 3
-
-    # Search
-    $ lutaml uml search model.lur "Building"
-
-    # Find by stereotype
-    $ lutaml uml find model.lur --stereotype featureType
-
-    # Get statistics
-    $ lutaml uml stats model.lur
-
-    # Validate
-    $ lutaml uml validate model.lur
-
-    # Export to CSV
-    $ lutaml uml export model.lur --format csv -o classes.csv
-
-    # Generate documentation site
-    $ lutaml uml docs model.lur -o docs/
-
-    # Start interactive shell
-    $ lutaml uml repl model.lur
-
-    # Watch mode (auto-rebuild on changes)
-    $ lutaml uml watch model.xmi -o model.lur
-  TEXT
-  exit 0
-end
-
-puts "Test file found: #{test_file}"
-puts "File size: #{File.size(test_file) / 1024}KB"
-puts
-
-# Workflow 1: Build LUR package
-puts "=" * 80
-puts "Workflow 1: Building LUR package"
-puts "=" * 80
-
-lur_output = "examples/workflow_test.lur"
-FileUtils.rm_f(lur_output)
-
-puts "Loading from: #{test_file}"
-start_time = Time.now
-
-# Parse the source file
-if test_file.end_with?(".qea")
-  puts "Parsing QEA file (fast)..."
-  document = Lutaml::Qea.parse(test_file)
-elsif test_file.end_with?(".xmi")
-  puts "Parsing XMI file..."
-  document = Lutaml::Parser.parse([File.new(test_file)]).first
-else
-  puts "Unknown file type"
-  exit 1
-end
-
-parse_time = Time.now - start_time
-puts "Parsed in #{parse_time.round(2)}s"
-
-# Build repository
-puts "Building repository..."
-repo = Lutaml::UmlRepository::Repository.new(document: document)
-build_time = Time.now - start_time - parse_time
-puts "Built in #{build_time.round(2)}s"
-
-# Export to LUR package
-puts "Exporting to LUR package..."
-export_start = Time.now
-repo.export_to_package(lur_output,
-                       name: "Test Model",
-                       version: "1.0",
-                       serialization_format: :marshal)
-export_time = Time.now - export_start
-puts "Exported in #{export_time.round(2)}s"
-puts "Package created: #{lur_output} (#{File.size(lur_output) / 1024}KB)"
-puts
-
-# Workflow 2: Load from LUR (fast)
-puts "=" * 80
-puts "Workflow 2: Fast loading from LUR"
-puts "=" * 80
-
-load_start = Time.now
-loaded_repo = Lutaml::UmlRepository::Repository.from_package(lur_output)
-load_time = Time.now - load_start
-puts "Loaded in #{load_time.round(2)}s (vs #{parse_time.round(2)}s for parsing)"
-puts "Speedup: #{(parse_time / load_time).round(1)}x faster"
-puts
-
-# Workflow 3: Validation
-puts "=" * 80
-puts "Workflow 3: Model validation"
-puts "=" * 80
-
-result = loaded_repo.validate
-puts "Validation result: #{result.valid? ? 'VALID ✓' : 'INVALID ✗'}"
-puts "Errors: #{result.errors.size}"
-puts "Warnings: #{result.warnings.size}"
-
-if result.errors.any?
-  puts "\nFirst 3 errors:"
-  result.errors.first(3).each do |error|
-    puts "  - #{error}"
-  end
-end
-
-if result.warnings.any?
-  puts "\nFirst 3 warnings:"
-  result.warnings.first(3).each do |warning|
-    puts "  - #{warning}"
-  end
-end
-puts
-
-# Workflow 4: Statistics
-puts "=" * 80
-puts "Workflow 4: Model statistics"
-puts "=" * 80
-
-stats = loaded_repo.statistics
-puts "Model overview:"
-puts "  Packages: #{stats[:total_packages]}"
-puts "  Classes: #{stats[:total_classes]}"
-puts "  Data types: #{stats[:total_data_types]}"
-puts "  Enumerations: #{stats[:total_enums]}"
-puts "  Associations: #{stats[:total_associations]}"
-puts "  Diagrams: #{stats[:total_diagrams]}"
-
-if stats[:max_package_depth]
-  puts "\nPackage structure:"
-  puts "  Max depth: #{stats[:max_package_depth]}"
-end
-
-if stats[:classes_by_stereotype]
-  puts "\nTop stereotypes:"
-  stats[:classes_by_stereotype].first(5).each do |stereotype, count|
-    puts "  #{stereotype}: #{count}"
-  end
-end
-puts
-
-# Workflow 5: Query and export
-puts "=" * 80
-puts "Workflow 5: Query and export"
-puts "=" * 80
-
-# Find all classes
-all_classes = loaded_repo.classes_index
-puts "Found #{all_classes.size} classes"
-
-if all_classes.any?
-  # Sample some classes
-  sample_classes = all_classes.first(5)
-  puts "\nSample classes:"
-  sample_classes.each do |klass|
-    puts "  - #{klass.name}"
-    if klass.respond_to?(:stereotype) && klass.stereotype
-      puts "    Stereotype: #{klass.stereotype}"
-    end
-    if klass.respond_to?(:attributes) && klass.attributes
-      puts "    Attributes: #{klass.attributes.size}"
-    end
-  end
-
-  # Search example
-  puts "\nSearch for 'Object':"
-  results = loaded_repo.search("Object", types: [:class])
-  puts "  Found #{results[:total]} matches in class names"
-end
-puts
-
-# Workflow 6: Smart caching demonstration
-puts "=" * 80
-puts "Workflow 6: Smart caching"
-puts "=" * 80
-
-puts "Smart caching automatically uses LUR if newer than source:"
-puts
-puts "# First run - builds from source"
-puts "repo = Repository.from_file_cached('#{test_file}')"
-puts "# Creates #{test_file.sub(/\.(xmi|qea)$/, '.lur')}"
-puts
-puts "# Subsequent runs - loads from cache"
-puts "repo = Repository.from_file_cached('#{test_file}')"
-puts "# Uses cached .lur (< 100ms)"
-puts
-
-# Cleanup
-puts "=" * 80
-puts "Cleanup"
-puts "=" * 80
-FileUtils.rm_f(lur_output)
-puts "Removed test file: #{lur_output}"
-puts
-
-puts "=" * 80
-puts "Workflow examples complete!"
-puts "=" * 80
-puts
-puts "Summary of CLI commands:"
-puts "  build      - Build LUR package from XMI/QEA"
-puts "  info       - Show package metadata"
-puts "  validate   - Validate model integrity"
-puts "  ls         - List elements"
-puts "  tree       - Show package hierarchy"
-puts "  inspect    - Show element details"
-puts "  search     - Full-text search"
-puts "  find       - Find by criteria"
-puts "  stats      - Model statistics"
-puts "  export     - Export to various formats"
-puts "  docs       - Generate documentation site"
-puts "  serve      - Start web UI"
-puts "  repl       - Interactive shell"
-puts
-puts "Run 'lutaml uml --help' for full command reference"