Class: Structify::SchemaBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/structify/model.rb

Overview

Builder class for constructing the schema

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(model) ⇒ SchemaBuilder

Initialize a new SchemaBuilder

Parameters:

  • The model class



123
124
125
126
127
128
 
# File 'lib/structify/model.rb', line 123

def initialize(model)
  @model = model
  @fields = []
  @version_number = 1
  @thinking_enabled = false
end

Instance Attribute Details

#description_str ⇒ Class, ... (readonly)

Returns:

  • The model class

  • The field definitions

  • The schema name

  • The schema description

  • The schema version

  • Whether thinking mode is enabled



118
119
120
 
# File 'lib/structify/model.rb', line 118

def description_str
  @description_str
end

#fields ⇒ Class, ... (readonly)

Returns:

  • The model class

  • The field definitions

  • The schema name

  • The schema description

  • The schema version

  • Whether thinking mode is enabled



118
119
120
 
# File 'lib/structify/model.rb', line 118

def fields
  @fields
end

#model ⇒ Class, ... (readonly)

Returns:

  • The model class

  • The field definitions

  • The schema name

  • The schema description

  • The schema version

  • Whether thinking mode is enabled



118
119
120
 
# File 'lib/structify/model.rb', line 118

def model
  @model
end

#name_str ⇒ Class, ... (readonly)

Returns:

  • The model class

  • The field definitions

  • The schema name

  • The schema description

  • The schema version

  • Whether thinking mode is enabled



118
119
120
 
# File 'lib/structify/model.rb', line 118

def name_str
  @name_str
end

#thinking_enabled ⇒ Class, ... (readonly)

Returns:

  • The model class

  • The field definitions

  • The schema name

  • The schema description

  • The schema version

  • Whether thinking mode is enabled



118
119
120
 
# File 'lib/structify/model.rb', line 118

def thinking_enabled
  @thinking_enabled
end

#version_number ⇒ Class, ... (readonly)

Returns:

  • The model class

  • The field definitions

  • The schema name

  • The schema description

  • The schema version

  • Whether thinking mode is enabled



118
119
120
 
# File 'lib/structify/model.rb', line 118

def version_number
  @version_number
end

Instance Method Details

#define_version_range_accessor(name, version_range) ⇒ void

This method returns an undefined value.

Define accessor for fields that are not in the current schema version These will raise an appropriate error when accessed

Parameters:

  • The field name

  • The versions this field is available in



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/structify/model.rb', line 373

def define_version_range_accessor(name, version_range)
  # Capture schema version to use in the eval block
  schema_version = @version_number
  
  # Handle different version range types
  version_range_type = case version_range
                      when Range
                        "range"
                      when Array
                        "array"
                      else
                        "integer"
                      end
                      
  # Extract begin/end values for ranges
  range_begin = case version_range
                when Range
                  version_range.begin
                when Array
                  version_range.min
                else
                  version_range
                end
                
  range_end = case version_range
              when Range
                version_range.end
              when Array
                version_range.max
              else
                version_range
              end
  
  model.class_eval "    # Define an accessor that raises an error when accessed\n    def \#{name}\n      # Based on the version_range type, create appropriate errors\n      case \"\#{version_range_type}\"\n      when \"range\"\n        if \#{range_begin} <= \#{schema_version} && \#{range_end} < \#{schema_version}\n          # Removed field\n          raise Structify::RemovedFieldError.new(\"\#{name}\", \#{range_end})\n        elsif \#{range_begin} > \#{schema_version}\n          # Field from future version\n          raise Structify::VersionRangeError.new(\"\#{name}\", \#{schema_version}, \#{version_range.inspect})\n        else\n          # Not in range for other reasons\n          raise Structify::VersionRangeError.new(\"\#{name}\", \#{schema_version}, \#{version_range.inspect})\n        end\n      when \"array\"\n        # For arrays, we can only check if the current version is in the array\n        raise Structify::VersionRangeError.new(\"\#{name}\", \#{schema_version}, \#{version_range.inspect})\n      else\n        # For integers, just report version mismatch\n        raise Structify::VersionRangeError.new(\"\#{name}\", \#{schema_version}, \#{version_range.inspect})\n      end\n    end\n    \n    # Define a writer that raises an error too\n    def \#{name}=(value)\n      # Use the same error logic as the reader\n      self.\#{name}\n    end\n  RUBY\nend\n", __FILE__, __LINE__ + 1

#define_version_range_accessors(name, type, version_range) ⇒ void

This method returns an undefined value.

Define accessor methods that check version compatibility using the new version ranges

Parameters:

  • The field name

  • The field type for attr_json

  • The versions this field is available in



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/structify/model.rb', line 300

def define_version_range_accessors(name, type, version_range)
  # Define the attr_json normally first
  model.attr_json name, type
  
  # Extract current version for error messages
  schema_version = @version_number
  
  # Then override the reader method to check versions
  model.class_eval "    # Store original method\n    alias_method :_original_\#{name}, :\#{name}\n    \n    # Override reader to check version compatibility\n    def \#{name}\n      # Get the container attribute and data\n      container_attribute = self.class.attr_json_config.default_container_attribute\n      record_data = self.send(container_attribute)\n      \n      # Get the version from the record data\n      record_version = record_data && record_data[\"version\"] ? \n                       record_data[\"version\"] : 1\n      \n      # Check if record version is compatible with field's version range\n      field_version_range = \#{version_range.inspect}\n      \n      # Handle field lifecycle based on version\n      unless version_in_range?(record_version, field_version_range)\n        # Check if this is a removed field (was valid in earlier versions but not current version)\n        if field_version_range.is_a?(Range) && field_version_range.begin <= record_version && field_version_range.end < \#{schema_version}\n          raise Structify::RemovedFieldError.new(\n            \"\#{name}\", \n            field_version_range.end\n          )\n        # Check if this is a new field (only valid in later versions)\n        elsif (field_version_range.is_a?(Range) && field_version_range.begin > record_version) ||\n              (field_version_range.is_a?(Integer) && field_version_range > record_version)\n          raise Structify::VersionRangeError.new(\n            \"\#{name}\", \n            record_version,\n            field_version_range\n          )\n        # Otherwise it's just not in the valid range\n        else\n          raise Structify::VersionRangeError.new(\n            \"\#{name}\", \n            record_version, \n            field_version_range\n          )\n        end\n      end\n      \n      # Check for deprecated fields and show warning\n      if field_version_range.is_a?(Range) && \n         field_version_range.begin < \#{schema_version} && \n         field_version_range.end < 999 && \n         field_version_range.cover?(record_version)\n        ActiveSupport::Deprecation.warn(\n          \"Field '\#{name}' is deprecated as of version \#{schema_version} and will be removed in version \\\#{field_version_range.end}.\"\n        )\n      end\n      \n      # Call original method\n      _original_\#{name}\n    end\n  RUBY\nend\n", __FILE__, __LINE__ + 1

#description(desc) ⇒ void

This method returns an undefined value.

Set the schema description

Parameters:

  • The description



155
156
157
 
# File 'lib/structify/model.rb', line 155

def description(desc)
  @description_str = desc
end

#field(name, type, required: false, description: nil, enum: nil, items: nil, properties: nil, min_items: nil, max_items: nil, unique_items: nil, versions: nil) ⇒ void

This method returns an undefined value.

Define a field in the schema

Parameters:

  • The field name

  • The field type

  • (defaults to: false)

    Whether the field is required

  • (defaults to: nil)

    The field description

  • (defaults to: nil)

    Possible values for the field

  • (defaults to: nil)

    For array type, defines the schema for array items

  • (defaults to: nil)

    For object type, defines the properties of the object

  • (defaults to: nil)

    For array type, minimum number of items

  • (defaults to: nil)

    For array type, maximum number of items

  • (defaults to: nil)

    For array type, whether items must be unique

  • (defaults to: nil)

    The versions this field is available in (default: current version onwards)



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/structify/model.rb', line 189

def field(name, type, required: false, description: nil, enum: nil, 
          items: nil, properties: nil, min_items: nil, max_items: nil, 
          unique_items: nil, versions: nil)
  
  # Handle version information
  version_range = if versions
                    # Use the versions parameter if provided
                    versions
                  else
                    # Default: field is available in all versions
                    1..999
                  end
  
  # Check if the field is applicable for the current schema version
  field_available = version_in_range?(@version_number, version_range)
  
  # Skip defining the field in the schema if it's not applicable to the current version
  unless field_available
    # Still define an accessor that raises an appropriate error
    define_version_range_accessor(name, version_range)
    return
  end
  
  # Calculate a simple introduced_in for backward compatibility
  effective_introduced_in = case version_range
                           when Range
                             version_range.begin
                           when Array
                             version_range.min
                           else
                             version_range
                           end
  
  field_definition = {
    name: name,
    type: type,
    required: required,
    description: description,
    version_range: version_range,
    introduced_in: effective_introduced_in
  }
  
  # Add enum if provided
  field_definition[:enum] = enum if enum
  
  # Array specific properties
  if type == :array
    field_definition[:items] = items if items
    field_definition[:min_items] = min_items if min_items
    field_definition[:max_items] = max_items if max_items
    field_definition[:unique_items] = unique_items if unique_items
  end
  
  # Object specific properties
  if type == :object
    field_definition[:properties] = properties if properties
  end
  
  fields << field_definition
  
  # Track field by its version range
  @fields_by_version ||= {}
  @fields_by_version[effective_introduced_in] ||= []
  @fields_by_version[effective_introduced_in] << name

  # Map JSON Schema types to Ruby/AttrJson types
  attr_type = case type
              when :integer, :number
                :integer
              when :array
                :json
              when :object
                :json
              when :boolean
                :boolean
              else
                type # string, text stay the same
              end

  # Define custom accessor that checks version compatibility
  define_version_range_accessors(name, attr_type, version_range)
end

#name(value) ⇒ void

This method returns an undefined value.

Set the schema name

Parameters:

  • The name



143
144
145
146
147
148
149
 
# File 'lib/structify/model.rb', line 143

def name(value)
  # Validate the name pattern (must match ^[a-zA-Z0-9_-]+$)
  unless value =~ /^[a-zA-Z0-9_-]+$/
    raise ArgumentError, "Schema name must only contain alphanumeric characters, underscores, and hyphens"
  end
  @name_str = value
end

#thinking(enabled) ⇒ void

This method returns an undefined value.

Enable or disable thinking mode When enabled, the LLM will be asked to provide chain of thought reasoning

Parameters:

  • Whether to enable thinking mode



135
136
137
 
# File 'lib/structify/model.rb', line 135

def thinking(enabled)
  @thinking_enabled = enabled
end

#to_json_schema ⇒ Hash

Generate the JSON schema representation

Returns:

  • The JSON schema



442
443
444
445
 
# File 'lib/structify/model.rb', line 442

def to_json_schema
  serializer = SchemaSerializer.new(self)
  serializer.to_json_schema
end

#version(num) ⇒ void

This method returns an undefined value.

Set the schema version

Parameters:

  • The version number



163
164
165
166
167
168
169
170
171
172
 
# File 'lib/structify/model.rb', line 163

def version(num)
  @version_number = num
  
  # Define version as an attr_json field so it's stored in extracted_data
  model.attr_json :version, :integer, default: num
  
  # Store mapping of fields to their introduction version
  @fields_by_version ||= {}
  @fields_by_version[num] ||= []
end

#version_in_range?(version, range) ⇒ Boolean

Check if a version is within a given range/array of versions

Parameters:

  • The version to check

  • The range, array, or single version to check against

Returns:

  • Whether the version is within the range



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/structify/model.rb', line 277

def version_in_range?(version, range)
  case range
  when Range
    # Handle endless ranges (Ruby 2.6+): 2.. means 2 and above
    if range.end.nil?
      version >= range.begin
    else
      range.cover?(version)
    end
  when Array
    range.include?(version)
  else
    # A single integer means "this version and onwards"
    version >= range
  end
end