sorbet-baml 0.0.1 → 0.2.0

data/lib/sorbet_baml.rb

@@ -5,6 +5,12 @@ require "sorbet-runtime"
 require_relative "sorbet_baml/version"
 require_relative "sorbet_baml/converter"
 require_relative "sorbet_baml/type_mapper"
+require_relative "sorbet_baml/dependency_resolver"
+require_relative "sorbet_baml/comment_extractor"
+require_relative "sorbet_baml/description_extractor"
+require_relative "sorbet_baml/description_extension"
+require_relative "sorbet_baml/struct_extensions"
+require_relative "sorbet_baml/enum_extensions"
 
 module SorbetBaml
   class Error < StandardError; end
@@ -23,3 +29,7 @@ module SorbetBaml
     Converter.from_structs(klasses, options)
   end
 end
+
+# Extend T::Struct and T::Enum with BAML conversion methods
+T::Struct.extend(SorbetBaml::StructExtensions)
+T::Enum.extend(SorbetBaml::EnumExtensions)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sorbet-baml
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Vicente Reig Rincon de Arellano
@@ -32,18 +32,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".idea/.gitignore"
+- ".idea/inspectionProfiles/Project_Default.xml"
 - ".rspec"
 - CHANGELOG.md
+- CLAUDE.md
 - LICENSE.txt
 - README.md
 - Rakefile
-- docs/README.md
-- docs/advanced-usage.md
-- docs/getting-started.md
-- docs/troubleshooting.md
-- docs/type-mapping.md
+- examples/description_parameters.rb
 - lib/sorbet_baml.rb
+- lib/sorbet_baml/comment_extractor.rb
 - lib/sorbet_baml/converter.rb
+- lib/sorbet_baml/dependency_resolver.rb
+- lib/sorbet_baml/description_extension.rb
+- lib/sorbet_baml/description_extractor.rb
+- lib/sorbet_baml/enum_extensions.rb
+- lib/sorbet_baml/struct_extensions.rb
 - lib/sorbet_baml/type_mapper.rb
 - lib/sorbet_baml/version.rb
 - sig/sorbet/baml.rbs

data/docs/README.md

@@ -1,67 +0,0 @@
-# sorbet-baml Documentation
-
-Developer documentation for the sorbet-baml gem.
-
-## For Users
-
-If you want to use this gem in your project:
-
-1. **[Getting Started](./getting-started.md)** - Installation and basic usage
-2. **[Type Mapping Reference](./type-mapping.md)** - Complete type conversion table
-3. **[Advanced Usage](./advanced-usage.md)** - Complex scenarios and integrations
-4. **[Troubleshooting](./troubleshooting.md)** - Common issues and solutions
-
-## For Contributors
-
-If you want to contribute to this gem:
-
-1. **[Architecture](./architecture.md)** - How the gem is structured
-2. **[Adding Type Support](./adding-types.md)** - How to add new type mappings
-3. **[Testing Guide](./testing.md)** - How to write and run tests
-
-## Quick Example
-
-```ruby
-# Define a Sorbet struct
-class User < T::Struct
-  const :name, String
-  const :age, Integer
-  const :email, T.nilable(String)
-end
-
-# Convert to BAML
-require 'sorbet-baml'
-puts SorbetBaml.from_struct(User)
-
-# Output:
-# class User {
-#   name string
-#   age int
-#   email string?
-# }
-```
-
-## Design Goals
-
-1. **Simplicity** - Easy to understand and use
-2. **Accuracy** - Correct type mappings
-3. **Efficiency** - Minimal token usage in output
-4. **Compatibility** - Works with existing Sorbet codebases
-
-## What This Is Not
-
-- Not a BAML runtime or executor
-- Not a JSON Schema generator (use sorbet-schema for that)
-- Not a Sorbet type checker
-- Not a serialization library
-
-## Why BAML?
-
-BAML (Boundary AI Markup Language) provides a concise way to define types for LLM consumption. Compared to JSON Schema:
-
-- ~60% fewer tokens
-- More readable
-- Better LLM comprehension
-- Simpler syntax
-
-Perfect for prompt engineering and structured output generation.

data/docs/advanced-usage.md

@@ -1,85 +0,0 @@
-# Advanced Usage
-
-## Converting Multiple Structs
-
-When you have related structs, convert them together to maintain relationships:
-
-```ruby
-class Address < T::Struct
-  const :street, String
-  const :city, String
-end
-
-class Company < T::Struct
-  const :name, String
-  const :address, Address
-end
-
-class User < T::Struct
-  const :name, String
-  const :company, Company
-end
-
-# Convert all at once
-baml = SorbetBaml.from_structs([Address, Company, User])
-```
-
-## Options
-
-### Include Descriptions
-
-```ruby
-# Future feature - not yet implemented
-baml = SorbetBaml.from_struct(User,
-  include_descriptions: true  # Will add @description annotations
-)
-```
-
-### Custom Indentation
-
-```ruby
-# Future feature - not yet implemented
-baml = SorbetBaml.from_struct(User,
-  indent_size: 4  # Use 4 spaces instead of 2
-)
-```
-
-## Working with Existing BAML Projects
-
-If you're already using BAML, you can generate type definitions to include in your `.baml` files:
-
-```ruby
-# Generate just the class definition
-definition = SorbetBaml.from_struct(MyStruct)
-
-# Write to a BAML file
-File.write("types/my_struct.baml", definition)
-```
-
-## Integration with LLM Libraries
-
-### With OpenAI
-
-```ruby
-require 'openai'
-require 'sorbet-baml'
-
-schema = SorbetBaml.from_struct(ResponseFormat)
-
-response = client.chat(
-  model: "gpt-4",
-  messages: [{
-    role: "system",
-    content: "You must respond with data matching this BAML schema:\n\n#{schema}"
-  }, {
-    role: "user", 
-    content: "Generate a sample user"
-  }]
-)
-```
-
-### With DSPy.rb
-
-```ruby
-# Coming soon - integration with DSPy.rb for automatic schema generation
-```

data/docs/getting-started.md

@@ -1,54 +0,0 @@
-# Getting Started
-
-## Prerequisites
-
-- Ruby 3.2+
-- Sorbet installed in your project
-- Basic familiarity with T::Struct
-
-## Quick Start
-
-### 1. Define your Sorbet types
-
-```ruby
-class User < T::Struct
-  const :id, Integer
-  const :name, String
-  const :email, T.nilable(String)
-end
-```
-
-### 2. Convert to BAML
-
-```ruby
-require 'sorbet-baml'
-
-baml = SorbetBaml.from_struct(User)
-puts baml
-# Output:
-# class User {
-#   id int
-#   name string
-#   email string?
-# }
-```
-
-### 3. Use with your LLM
-
-Include the BAML definition in your prompt:
-
-```ruby
-prompt = <<~PROMPT
-  Generate sample data matching this schema:
-  
-  #{baml}
-  
-  Return 3 examples.
-PROMPT
-```
-
-## Next Steps
-
-- [Type Mapping Reference](./type-mapping.md)
-- [Advanced Usage](./advanced-usage.md)
-- [Troubleshooting](./troubleshooting.md)

data/docs/troubleshooting.md

@@ -1,81 +0,0 @@
-# Troubleshooting
-
-## Common Issues
-
-### "undefined method `props' for Class"
-
-**Problem**: The class you're trying to convert is not a T::Struct.
-
-**Solution**: Ensure your class inherits from `T::Struct`:
-
-```ruby
-# ❌ Wrong
-class User
-  attr_reader :name
-end
-
-# ✅ Correct
-class User < T::Struct
-  const :name, String
-end
-```
-
-### Empty output
-
-**Problem**: The struct has no properties defined.
-
-**Solution**: Define at least one property using `const` or `prop`:
-
-```ruby
-class User < T::Struct
-  const :name, String  # Add properties
-end
-```
-
-### Circular dependency detected
-
-**Problem**: Two structs reference each other creating an infinite loop.
-
-**Solution**: This is not yet supported. Consider flattening the structure or using a different approach.
-
-## Type-Specific Issues
-
-### Arrays not converting correctly
-
-Ensure you're using the Sorbet array syntax:
-
-```ruby
-# ❌ Wrong
-const :items, Array
-
-# ✅ Correct
-const :items, T::Array[String]
-```
-
-### Optional fields showing as required
-
-Make sure to use `T.nilable`:
-
-```ruby
-# ❌ Wrong - will be required
-const :email, String
-
-# ✅ Correct - will be optional
-const :email, T.nilable(String)
-```
-
-## Getting Help
-
-1. Check the [Type Mapping Reference](./type-mapping.md)
-2. Review the examples in [Getting Started](./getting-started.md)
-3. File an issue at https://github.com/vicentereig/sorbet-baml/issues
-
-## Debug Mode
-
-To see detailed conversion information:
-
-```ruby
-# Future feature - not yet implemented
-SorbetBaml.debug = true
-baml = SorbetBaml.from_struct(MyStruct)
-```

data/docs/type-mapping.md

@@ -1,65 +0,0 @@
-# Type Mapping Reference
-
-Complete mapping between Sorbet types and BAML output.
-
-## Basic Types
-
-| Sorbet Type | BAML Output | Example |
-|-------------|-------------|---------|
-| `String` | `string` | `name string` |
-| `Integer` | `int` | `age int` |
-| `Float` | `float` | `price float` |
-| `T::Boolean` | `bool` | `active bool` |
-| `NilClass` | `null` | `null` |
-| `Symbol` | `string` | `status string` |
-
-## Optional Types
-
-| Sorbet Type | BAML Output | Example |
-|-------------|-------------|---------|
-| `T.nilable(String)` | `string?` | `email string?` |
-| `T.nilable(Integer)` | `int?` | `age int?` |
-
-## Collection Types
-
-| Sorbet Type | BAML Output | Example |
-|-------------|-------------|---------|
-| `T::Array[String]` | `string[]` | `tags string[]` |
-| `T::Array[T::Struct]` | `StructName[]` | `addresses Address[]` |
-
-## Nested Structures
-
-```ruby
-# Input
-class Address < T::Struct
-  const :street, String
-  const :city, String
-end
-
-class User < T::Struct
-  const :name, String
-  const :address, Address
-end
-
-# Output
-class Address {
-  street string
-  city string
-}
-
-class User {
-  name string
-  address Address
-}
-```
-
-## Not Yet Supported
-
-These types will be added in future versions:
-
-- `T::Hash[K, V]` → `map<K, V>`
-- `T.any(Type1, Type2)` → `Type1 | Type2`
-- `T::Enum` subclasses → `enum Name { ... }`
-- `T.type_alias` → `type Name = ...`
-- `T::Set[T]` → `T[]` (with uniqueness note)
-- `T::Range[T]` → Will need special handling