ask-schema 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5a9c41e5de3b5e4c3bdaad787059efa89197dc88048cb24b4f545a34adfd060
-  data.tar.gz: 2f3dc5d00239bf5364ffd0894feb138a060cca73359310aee1b576ac2f6a77bb
+  metadata.gz: 5f2ef95da38b7caac722010a37b4b1ac4432518cc038bfab88578d4f5398eb2f
+  data.tar.gz: 8c9d76ec1d43750ae4d6d17886762894683dac987614ec07b445a9ffaf6c627c
 SHA512:
-  metadata.gz: e05cfa19bd6d8160fb98c14b46a39dd5cc69970dacd1e571cb813c27b1f73454d73ce7bf74dfaa7e14ad1399ec0fd3f93bfe193aaf4e0939f6ccae59beeb0636
-  data.tar.gz: bc91c29e8bcea693ed199cccea34a6581f4289b2ddf1420634fc1b0b32e7828b591a7bc1addc28cd028a99fbd888b2e5ebf5e6a97a432e7985ac88b67e16ee4f
+  metadata.gz: 9b461dc547ad617f95e7d2de6069eca9cd714dfa3761cdf71535090eec069e2892a56164e704888306ae570117cb3d942789b9f316ff9e1b22a3ae8a60f33347
+  data.tar.gz: d6235cc63c273f88ed8552d3e40968a9b325aa9f84b03dd0990aa44e18255e619318b8883163c26d108bab4686b8ff823c07acc67cde72ff962ec238f16431de

data/CHANGELOG.md

@@ -0,0 +1,44 @@
+## [0.1.1] - 2026-06-25
+
+### Changed
+- Robustness suite (11 tests): empty schemas, edge cases, schema isolation. Infrastructure: rubocop, overcommit, bin/setup, CI matrix, gemspec test.
+# Changelog
+
+## [0.1.0] - 2026-06-21
+
+### Added
+
+- Initial release of `ask-schema` — a zero-dependency Ruby DSL for building JSON Schema documents.
+- Ported from `ruby_llm-schema` v0.4.0 with namespace repackage (`RubyLLM::Schema` → `Ask::Schema`).
+
+### Features
+
+- **Block-based DSL** — `Ask::Schema.create { string(:name); integer(:age) }` for inline schema definitions
+- **Class-based DSL** — `class Product < Ask::Schema; string :name; end` for reusable schema classes
+- **Primitive types** — `string`, `number`, `integer`, `boolean`, `null` with full constraint support
+- **Complex types** — `object`, `array`, `any_of`, `one_of`, `enum`, `const`
+- **Composition** — `define`/`reference` for named sub-schemas with `$defs` and `$ref`
+- **Conditionals** — `given`/`then`/`else` for conditional validation, `dependent` for property dependencies
+- **Validation** — Circular reference detection via DFS topological sort
+- **JSON output** — `to_json_schema` (hash) and `to_json` (pretty-printed JSON string)
+- **Strict mode** — `strict`, `additionalProperties` controls with sensible defaults
+- **Modifiers** — `description`, `default`, `minimum`, `maximum`, `pattern`, `format`, `min_length`, `max_length`, `enum`, `multiple_of`, `min_items`, `max_items`
+- **Optional fields** — `required: false` and `optional { ... }` helper for nullable properties
+- **Dependencies** — Zero runtime dependencies. stdlib only (`json`).
+- **Ruby 3.2+** — Uses anonymous block forwarding, endless methods, and modern Ruby idioms.
+
+### Ported modules
+
+| Module | Source | Lines |
+|---|---|---|
+| `Ask::Schema` | `lib/ask/schema.rb` | 99 |
+| DSL assembly | `lib/ask/schema/dsl.rb` | 19 |
+| Schema builders | `lib/ask/schema/dsl/schema_builders.rb` | 186 |
+| Primitive types | `lib/ask/schema/dsl/primitive_types.rb` | 29 |
+| Complex types | `lib/ask/schema/dsl/complex_types.rb` | 32 |
+| Conditionals | `lib/ask/schema/dsl/conditionals.rb` | 169 |
+| Utilities | `lib/ask/schema/dsl/utilities.rb` | 62 |
+| JSON output | `lib/ask/schema/json_output.rb` | 37 |
+| Validator | `lib/ask/schema/validator.rb` | 81 |
+| Errors | `lib/ask/schema/errors.rb` | 30 |
+| Helpers | `lib/ask/schema/helpers.rb` | 12 |

data/README.md

@@ -1,11 +1,17 @@
 # ask-schema
 
-A compact Ruby DSL for building standards-compliant JSON Schema documents. Zero dependencies.
+[![Gem Version](https://badge.fury.io/rb/ask-schema.svg)](https://badge.fury.io/rb/ask-schema)
+
+A compact Ruby DSL for building standards-compliant JSON Schema documents. Zero dependencies. ask-schema powers tool parameter schemas in ask-tools.
+
+## Installation
 
 ```ruby
 gem "ask-schema"
 ```
 
+## Quick Start
+
 ```ruby
 require "ask-schema"
 
@@ -15,221 +21,45 @@ schema = Ask::Schema.create do
   boolean :active, required: false
 end
 
-schema.new("user", description: "A user profile").to_json
-# => {
-#   "name": "user",
-#   "description": "A user profile",
-#   "schema": {
-#     "type": "object",
-#     "properties": {
-#       "name": { "type": "string", "description": "Full name" },
-#       "age": { "type": "integer", "description": "Age in years", "minimum": 0 },
-#       "active": { "type": "boolean" }
-#     },
-#     "required": ["name", "age"],
-#     "additionalProperties": false,
-#     "strict": true
-#   }
-# }
-```
-
-## Quick Start
-
-### Block-based DSL
-
-```ruby
-schema = Ask::Schema.create do
-  string :name, description: "The user's name"
-  integer :age, description: "Age in years"
-  boolean :active, required: false
-end
-
-instance = schema.new("user_profile", description: "A user profile")
+instance = schema.new("user", description: "A user profile")
 instance.to_json_schema
-# => { name: "user_profile", description: "A user profile", schema: { ... } }
-```
-
-### Class-based DSL
-
-```ruby
-class Address < Ask::Schema
-  string :street
-  string :city
-  string :zip
-  string :country, required: false
-end
-
-class User < Ask::Schema
-  string :name, description: "Full name"
-  string :email, format: "email"
-  integer :age
-  object :address, of: Address
-end
-
-User.new("user").to_json_schema
-```
-
-## Primitive Types
-
-Each primitive type supports standard JSON Schema constraints.
-
-### String
-
-```ruby
-string :username,
-  description: "Username",
-  enum: %w[admin user guest],
-  min_length: 3,
-  max_length: 50,
-  pattern: "^[a-zA-Z0-9_]+$",
-  format: "email"
-```
-
-### Number
-
-```ruby
-number :price,
-  description: "Price in USD",
-  minimum: 0,
-  maximum: 999999.99,
-  multiple_of: 0.01
-```
-
-### Integer
-
-```ruby
-integer :age,
-  minimum: 0,
-  maximum: 150
-```
-
-### Boolean
-
-```ruby
-boolean :active, description: "Is the user active?"
-```
-
-### Null
-
-```ruby
-null :deleted_at, description: "When the record was deleted"
-```
-
-## Complex Types
-
-### Object
-
-```ruby
-# Inline object
-object :address do
-  string :street
-  string :city
-  string :zip
-end
-
-# Reference to a defined schema
-define(:address) do
-  string :street
-  string :city
-end
-object :billing, of: :address
-
-# Reference to a Schema class
-object :shipping, of: Address
-```
-
-### Array
-
-```ruby
-# Array of primitive type
-array :tags, of: :string, description: "List of tags"
+# => { name: "user", description: "A user profile", schema: { type: "object", ... } }
 
-# Array with min/max items
-array :prices, of: :number, min_items: 1, max_items: 100
-
-# Array with complex items (block)
-array :contacts do
-  object do
-    string :name
-    string :email
-  end
-end
-
-# Array with any_of items
-array :identifiers do
-  any_of do
-    string
-    integer
-  end
-end
-```
-
-### any_of / one_of
-
-```ruby
-any_of :contact do
-  string description: "Phone number"
-  object do
-    string :email
-  end
-end
-
-one_of :payment_method do
-  string :credit_card
-  string :paypal
-end
+instance.to_json   # pretty-printed JSON string
 ```
 
-### Optional (nullable)
+`Ask::Schema.create` returns a schema class. Instantiate it with `.new("name")` and call `to_json_schema` (a Hash with `:name`, `:description`, `:schema` keys) or `to_json` (pretty-printed JSON). Class-based usage works the same way: `class Product < Ask::Schema` with the same DSL, instantiated with `Product.new("product")`.
 
-```ruby
-optional :nickname do
-  string
-end
-# Produces: anyOf: [{ type: "string" }, { type: "null" }]
-```
+## Types and keywords
 
-## Named Definitions and References
+| Category | DSL methods |
+|---|---|
+| Primitives | `string`, `number`, `integer`, `boolean`, `null` |
+| Complex | `object`, `array`, `any_of`, `one_of`, `optional` (nullable via `anyOf` + `null`) |
+| Named sub-schemas | `define(:address) { ... }`, referenced with `object :billing, of: :address` |
 
-Use `define` to create reusable named sub-schemas and `reference` (or `of:`) to reference them:
+Keywords: `description:`, `required:` (default `true`), `enum:`, `minimum:` / `maximum:` / `multiple_of:`, `min_length:` / `max_length:` / `pattern:` / `format:`, `min_items:` / `max_items:`.
 
 ```ruby
-class User < Ask::Schema
+schema = Ask::Schema.create do
+  string :username, description: "Username", enum: %w[admin user guest], min_length: 3
+  number :price, minimum: 0, maximum: 999_999.99
+  array :tags, of: :string, min_items: 1
   define(:address) do
     string :street
     string :city
-    string :zip
   end
-
-  string :name
-  object :home_address, of: :address
-  object :work_address, of: :address
+  object :billing, of: :address
+  optional :nickname do
+    string
+  end
 end
 ```
 
-Output includes proper `$defs` and `$ref`:
-
-```json
-{
-  "type": "object",
-  "properties": {
-    "name": { "type": "string" },
-    "home_address": { "$ref": "#/$defs/address" },
-    "work_address": { "$ref": "#/$defs/address" }
-  },
-  "$defs": {
-    "address": {
-      "type": "object",
-      "properties": { "street": { "type": "string" }, ... }
-    }
-  }
-}
-```
+Named definitions are emitted under `$defs` and referenced with `$ref`.
 
 ## Conditionals
 
-### If/Then/Else
-
 ```ruby
 schema = Ask::Schema.create do
   integer :age
@@ -237,98 +67,34 @@ schema = Ask::Schema.create do
 
   given(age: 18, country: "US") do
     requires :license_number
-    validates :license_number, type: :string, pattern: /^[A-Z]{2}\d{6}$/
     otherwise do
       requires :country_name
     end
   end
-end
-```
-
-### Dependent Required
 
-```ruby
-dependent :shipping_address do
-  requires :name, :street, :city
+  dependent :shipping_address do
+    requires :name, :street, :city
+  end
 end
 ```
 
-### Coercion rules
-
-| Ruby value | JSON Schema |
-|---|---|
-| `18` (scalar) | `{ const: 18 }` |
-| `["admin", "user"]` (Array) | `{ enum: ["admin", "user"] }` |
-| `/^[A-Z]+$/` (Regexp) | `{ pattern: "^[A-Z]+$" }` |
-| `{ minimum: 0 }` (Hash) | Passed through as-is |
+Values in `given` are coerced automatically: scalars become `const`, arrays become `enum`, Regexps become `pattern`. `requires` marks fields as required, `validates` adds per-field constraints.
 
 ## Validation
 
 ```ruby
-schema = Ask::Schema.create { string :name }
-schema.valid? # => true
-schema.validate! # => nil (or raises Ask::Schema::ValidationError)
-
-# Circular reference detection
 schema = Ask::Schema.create do
   define(:a) { object :b, of: :b }
   define(:b) { object :a, of: :a }
 end
-schema.valid? # => false
-schema.validate! # => raises Ask::Schema::ValidationError
-```
-
-## Output Formats
 
-```ruby
-instance.to_json_schema
-# => Hash with :name, :description, :schema keys
-
-instance.to_json
-# => Pretty-printed JSON string
+schema.valid?      # => false (circular reference)
+schema.validate!   # raises Ask::Schema::ValidationError
 ```
 
-## Configuration
+## Full documentation
 
-```ruby
-class StrictSchema < Ask::Schema
-  string :name
-  strict true              # defaults to true
-  additional_properties false  # defaults to false
-end
-```
-
-## Integration with ask-tools
-
-`ask-schema` powers tool parameter schemas in `ask-tools`:
-
-```ruby
-class WeatherTool < Ask::Tool
-  description "Get weather for a location"
-
-  params do
-    string :location, description: "City name"
-    string :unit, enum: %w[celsius fahrenheit]
-  end
-
-  def execute(location:, unit: "celsius")
-    # ...
-  end
-end
-```
-
-Under the hood, `Ask::Schema.create` is used to build the JSON Schema for tool parameters.
-
-## Error Types
-
-| Error | When |
-|---|---|
-| `Ask::Schema::InvalidArrayTypeError` | Invalid type for array `:of` |
-| `Ask::Schema::InvalidObjectTypeError` | Invalid type for object `:of` |
-| `Ask::Schema::ValidationError` | Schema validation fails (e.g., circular refs) |
-| `Ask::Schema::InvalidSchemaTypeError` | Unknown schema type specified |
-| `Ask::Schema::InvalidSchemaError` | Schema definition is invalid |
-| `Ask::Schema::LimitExceededError` | Maximum limits exceeded |
+The full ask-rb documentation lives at https://ask-rb.github.io/ask-docs. [ask-schema in depth](https://ask-rb.github.io/ask-docs/core/schema) covers the complete DSL. API reference: https://ask-rb.github.io/ask-docs/reference/api.
 
 ## Development
 
@@ -337,14 +103,6 @@ bundle install
 bundle exec rake test
 ```
 
-## Status
-
-**Phase 3** of the ask-rb ecosystem migration. This gem replaces `ruby_llm-schema`
-in the ask-rb stack. It should be built after `ask-core` and `ask-llm-providers`
-are stable.
-
-Current state: v0.1.0 — initial port complete with full feature parity.
-
 ## License
 
 MIT

data/lib/ask/schema/dsl/complex_types.rb

@@ -13,6 +13,10 @@ module Ask
         # @param options [Hash] Additional options (of:, reference:)
         # @param block [Proc] Inline property definitions
         def object(name, description: nil, required: true, requires: nil, **options, &block)
+          if options[:of].nil? && block.nil?
+            raise ArgumentError,
+              "object :#{name} needs a block (inline properties) or of: (a named definition)"
+          end
           add_property(name, object_schema(description: description, **options, &block), required: required, requires: requires)
         end
 
@@ -24,6 +28,9 @@ module Ask
         # @param options [Hash] Additional options (of:, min_items:, max_items:)
         # @param block [Proc] Block for complex item definitions
         def array(name, description: nil, required: true, requires: nil, **options, &block)
+          if options[:of].nil? && block.nil?
+            raise ArgumentError, "array :#{name} needs of: :<item type> (e.g. of: :string) or a block"
+          end
           add_property(name, array_schema(description: description, **options, &block), required: required, requires: requires)
         end
 

data/lib/ask/schema/version.rb

@@ -2,6 +2,6 @@
 
 module Ask
   class Schema
-    VERSION = "0.1.0"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ask-schema
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Kaka Ruto
@@ -59,6 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 - lib/ask-schema.rb
@@ -76,7 +77,10 @@ files:
 homepage: https://github.com/ask-rb/ask-schema
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/ask-rb/ask-schema
+  source_code_uri: https://github.com/ask-rb/ask-schema
+  changelog_uri: https://github.com/ask-rb/ask-schema/blob/master/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -91,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.18
 specification_version: 4
 summary: JSON Schema DSL for Ruby
 test_files: []