sorbet-baml 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c97a86bec35a852f1d41ff171d595d2f414c999f0421cb19da7d825bc6af5ea6
-  data.tar.gz: bc9c45e02ac421d272572b4383c10d4bdf5d87db445be05998ea67cec97fdadc
+  metadata.gz: e6ebc9d978b525e29a1a19ef184f073393d6a588e54d84dc2b9fd7034d1fa40c
+  data.tar.gz: f7d5e028fe65a4a4cc9b19c60dc17dd65fd13353634e55201db5189bb457447a
 SHA512:
-  metadata.gz: c0ab662803d02f440767ea8385705ba0f00b4f54cd48343cee0ea067db2569d0b7845bce54882ea60d9a5e50ef3d6ef3688ed063e8720bedc0c5229a23901b95
-  data.tar.gz: e36a8d5726d4ef489e21350827b9b0707382fb4fea29714c0583fb8b58ba7806d10dad9e214e326fc023e3750d2711f59bacd79ffd0f0ce54de7368c032a73de
+  metadata.gz: 40b4736cc561b5135ee32e08543148c018ea9963e016c6cbb66697cd346ff7cf30f7438d370853c045b40d062a47f38d7aaa1a9c6c8e92f8e7f6721b495966e0
+  data.tar.gz: 0caf0a19906655bbfae88723bbe5b38301601c1523c3cc3b8dc31a15bf6bdd02ceacb790cf0d4bddf718c1162ba51d7b0fcd08110578616cd7c7ac27272bcd42

data/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

data/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,5 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+  </profile>
+</component>

data/CLAUDE.md

@@ -0,0 +1,94 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Development Commands
+
+**Running Tests:**
+```bash
+bundle exec rspec                    # Run all tests
+bundle exec rspec spec/path_spec.rb  # Run specific test file
+```
+
+**Type Checking:**
+```bash
+bundle exec srb tc                   # Run Sorbet type checker
+```
+
+**Development Setup:**
+```bash
+bundle install                       # Install dependencies
+bundle exec tapioca dsl             # Generate RBI files for gems
+bundle exec tapioca gem             # Generate RBI files for dependencies
+```
+
+**Linting:**
+```bash
+bundle exec rubocop                  # Run RuboCop linter
+bundle exec rubocop -a              # Auto-fix violations where possible
+```
+
+**Gem Tasks:**
+```bash
+bundle exec rake build              # Build the gem
+bundle exec rake install            # Install locally
+bundle exec rake release            # Release to RubyGems (maintainers only)
+```
+
+## Code Architecture
+
+### Core Components
+
+**Main Library Entry Point:**
+- `lib/sorbet_baml.rb` - Main module with public API methods and extension loading
+
+**Core Conversion System:**
+- `lib/sorbet_baml/converter.rb` - Main converter orchestrating BAML generation
+- `lib/sorbet_baml/type_mapper.rb` - Maps Sorbet type objects to BAML type strings
+- `lib/sorbet_baml/dependency_resolver.rb` - Handles topological sorting of dependencies
+
+**Ruby-Idiomatic API Extensions:**
+- `lib/sorbet_baml/struct_extensions.rb` - Adds `.to_baml` method to T::Struct
+- `lib/sorbet_baml/enum_extensions.rb` - Adds `.to_baml` method to T::Enum
+
+**Field Documentation:**
+- `lib/sorbet_baml/comment_extractor.rb` - Extracts comments from source for field descriptions
+
+### Key Design Patterns
+
+**Extension Pattern:** The gem extends T::Struct and T::Enum classes with `.to_baml` methods for a Ruby-idiomatic API.
+
+**Dependency Resolution:** Uses topological sorting to ensure dependencies are output before types that reference them, preventing forward reference issues.
+
+**Type Mapping:** Comprehensive mapping from Sorbet type system to BAML types:
+- `T::Struct` → BAML classes
+- `T::Enum` → BAML enums  
+- `T.nilable(T)` → optional types (`T?`)
+- `T::Array[T]` → array types (`T[]`)
+- `T::Hash[K,V]` → map types (`map<K,V>`)
+- `T.any(T1, T2)` → union types (`T1 | T2`)
+
+**Smart Defaults:** The API includes dependencies and field descriptions by default.
+
+### Type System Support
+
+The gem provides complete coverage of Sorbet's type system:
+- Basic types (String, Integer, Float, Boolean, Symbol, Date/Time)
+- Complex types (Arrays, Hashes, Unions, Nilable)
+- Structured types (T::Struct, T::Enum with full nesting support)
+- Circular reference handling to prevent infinite loops
+
+### Testing Structure
+
+- `spec/fixtures/` - Test data including complex type examples
+- `spec/integration/` - End-to-end feature tests
+- `spec/sorbet_baml/` - Unit tests for each component
+- Comprehensive test coverage includes edge cases, circular references, and complex type combinations
+
+## Development Guidelines
+
+**Type Safety:** All code uses `# typed: strict` and maintains full Sorbet compliance.
+
+**Ruby Idioms:** The public API follows Ruby conventions with `.to_baml` instance methods rather than static factory methods.
+
+**Field Descriptions:** Comments above field definitions are automatically extracted and included as BAML `@description` annotations for LLM context.