structify 0.1.0 → 0.3.0

data/lib/structify.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 require_relative "structify/version"
+require_relative "structify/schema_serializer"
 require_relative "structify/model"
 
 # Structify is a DSL for defining extraction schemas for LLM-powered models.
 # It provides a simple way to integrate with Rails models for LLM extraction,
-# including versioning, assistant prompts, and more.
+# allowing for schema versioning and evolution.
 #
 # @example
 #   class Article < ApplicationRecord
@@ -15,8 +16,6 @@ require_relative "structify/model"
 #       title "Article Extraction"
 #       description "Extract article metadata"
 #       version 1
-#       assistant_prompt "Extract the following fields from the article"
-#       llm_model "gpt-4"
 #
 #       field :title, :string, required: true
 #       field :summary, :text, description: "A brief summary of the article"
@@ -24,6 +23,93 @@ require_relative "structify/model"
 #     end
 #   end
 module Structify
+  # Configuration class for Structify
+  class Configuration
+    # @return [Symbol] The default container attribute for JSON fields
+    attr_accessor :default_container_attribute
+    
+    def initialize
+      @default_container_attribute = :json_attributes
+    end
+  end
+  
+  # @return [Structify::Configuration] The current configuration
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+  
+  # Configure Structify
+  # @yield [config] The configuration block
+  # @yieldparam config [Structify::Configuration] The configuration object
+  # @return [Structify::Configuration] The updated configuration
+  def self.configure
+    yield(configuration) if block_given?
+    configuration
+  end
+  # Base error class for Structify
   class Error < StandardError; end
-  # Your code goes here...
+  
+  # Error raised when trying to access a field that doesn't exist in the record's version
+  class MissingFieldError < Error
+    attr_reader :field_name, :record_version, :schema_version
+    
+    def initialize(field_name, record_version, schema_version)
+      @field_name = field_name
+      @record_version = record_version
+      @schema_version = schema_version
+      
+      message = "Field '#{field_name}' does not exist in version #{record_version}. " \
+                "It was introduced in version #{schema_version}. " \
+                "To access this field, upgrade the record by setting new field values and saving."
+      
+      super(message)
+    end
+  end
+  
+  # Error raised when trying to access a field that has been removed in the current schema version
+  class RemovedFieldError < Error
+    attr_reader :field_name, :removed_in_version
+    
+    def initialize(field_name, removed_in_version)
+      @field_name = field_name
+      @removed_in_version = removed_in_version
+      
+      message = "Field '#{field_name}' has been removed in version #{removed_in_version}. " \
+                "This field is no longer available in the current schema."
+      
+      super(message)
+    end
+  end
+  
+  # Error raised when trying to access a field outside its specified version range
+  class VersionRangeError < Error
+    attr_reader :field_name, :record_version, :valid_versions
+    
+    def initialize(field_name, record_version, valid_versions)
+      @field_name = field_name
+      @record_version = record_version
+      @valid_versions = valid_versions
+      
+      message = "Field '#{field_name}' is not available in version #{record_version}. " \
+                "This field is only available in versions: #{format_versions(valid_versions)}."
+      
+      super(message)
+    end
+    
+    private
+    
+    def format_versions(versions)
+      if versions.is_a?(Range)
+        if versions.end.nil?
+          "#{versions.begin} and above"
+        else
+          "#{versions.begin} to #{versions.end}#{versions.exclude_end? ? ' (exclusive)' : ''}"
+        end
+      elsif versions.is_a?(Array)
+        versions.join(", ")
+      else
+        "#{versions} and above"  # Single integer means this version and onwards
+      end
+    end
+  end
 end

data/structify.gemspec

@@ -19,13 +19,13 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) || f.end_with?('.gem') }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   # Runtime dependencies
-  spec.add_dependency "activesupport", "~> 7.1"
+  spec.add_dependency "activesupport", "~> 8"
   spec.add_dependency "attr_json", "~> 2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: structify
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kieran Klaassen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-03 00:00:00.000000000 Z
+date: 2025-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: attr_json
   requirement: !ruby/object:Gem::Requirement
@@ -49,6 +49,8 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
+- CLAUDE.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -59,6 +61,7 @@ files:
 - bin/setup
 - lib/structify.rb
 - lib/structify/model.rb
+- lib/structify/schema_serializer.rb
 - lib/structify/version.rb
 - structify.gemspec
 homepage: https://github.com/kieranklaassen/structify