structify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eb04b492770cd56dc4378bb73de9ff1e0ee525e89f30c942f87f20314990bbc9
+  data.tar.gz: 5061d34d693c475070680501b3bf78f0634437cefc6da8b914fcda8a56ef3470
+SHA512:
+  metadata.gz: 0a1ee0ace2f35d460d244902a2de7699ce346ce2629c14e4151fb3d58e00f2f81444739faddd267f5eef2f53a9ecaf4334a1334e975b549fbf66993b7577c56f
+  data.tar.gz: 11cf2d7c6bbd538c8bc7fd944d289c3c303faa4e4fa08736ba0099ab276a4131ee973c2fc86a353e75c5ec13f25bb6a4409e4ee3c0a54b28be15167dbe3e3cdd

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,4 @@
+--require spec_helper
+--format documentation
+--color
+--order random

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 3.2.2
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kieranklaassen@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in structify.gemspec
+gemspec
+
+group :development, :test do
+  gem "rake", "~> 13.0"
+  gem "rspec", "~> 3.12"
+  gem "rspec-rails", "~> 6.1"
+  gem "activerecord", "~> 7.1.0"
+  gem "sqlite3", "~> 1.6.0" # For testing with ActiveRecord
+  gem "rubocop", "~> 1.21"
+  gem "rubocop-rspec", "~> 2.25"
+  gem "yard", "~> 0.9"
+  gem "debug", ">= 1.0.0"
+end

data/Gemfile.lock

@@ -0,0 +1,195 @@
+PATH
+  remote: .
+  specs:
+    structify (0.1.0)
+      activesupport (>= 7.1)
+      attr_json (~> 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.1.5.1)
+      actionview (= 7.1.5.1)
+      activesupport (= 7.1.5.1)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actionview (7.1.5.1)
+      activesupport (= 7.1.5.1)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activemodel (7.1.5.1)
+      activesupport (= 7.1.5.1)
+    activerecord (7.1.5.1)
+      activemodel (= 7.1.5.1)
+      activesupport (= 7.1.5.1)
+      timeout (>= 0.4.0)
+    activesupport (7.1.5.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      mutex_m
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    attr_json (2.5.0)
+      activerecord (>= 6.0.0, < 8.1)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
+    builder (3.3.0)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
+    crass (1.0.6)
+    date (3.4.1)
+    debug (1.10.0)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    erubi (1.13.1)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    io-console (0.8.0)
+    irb (1.15.1)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.9.1)
+    language_server-protocol (3.17.0.4)
+    logger (1.6.5)
+    loofah (2.24.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    minitest (5.25.4)
+    mutex_m (0.3.0)
+    nokogiri (1.18.2-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.26.3)
+    parser (3.3.7.0)
+      ast (~> 2.4.1)
+      racc
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    psych (5.2.3)
+      date
+      stringio
+    racc (1.8.1)
+    rack (3.1.9)
+    rack-session (2.1.0)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (7.1.5.1)
+      actionpack (= 7.1.5.1)
+      activesupport (= 7.1.5.1)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rdoc (6.11.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.10.0)
+    reline (0.6.0)
+      io-console (~> 0.5)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-rails (6.1.5)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      railties (>= 6.1)
+      rspec-core (~> 3.13)
+      rspec-expectations (~> 3.13)
+      rspec-mocks (~> 3.13)
+      rspec-support (~> 3.13)
+    rspec-support (3.13.2)
+    rubocop (1.71.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.0)
+      parser (>= 3.3.1.0)
+    rubocop-capybara (2.21.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.26.1)
+      rubocop (~> 1.61)
+    rubocop-rspec (2.31.0)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.29.1)
+      rubocop (~> 1.61)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    sqlite3 (1.6.9-x86_64-darwin)
+    stringio (3.1.2)
+    thor (1.3.2)
+    timeout (0.4.3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    yard (0.9.37)
+    zeitwerk (2.7.1)
+
+PLATFORMS
+  x86_64-darwin-22
+
+DEPENDENCIES
+  activerecord (~> 7.1.0)
+  debug (>= 1.0.0)
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  rspec-rails (~> 6.1)
+  rubocop (~> 1.21)
+  rubocop-rspec (~> 2.25)
+  sqlite3 (~> 1.6.0)
+  structify!
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.4.20

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Kieran Klaassen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,221 @@
+# Structify
+
+[![Gem Version](https://badge.fury.io/rb/structify.svg)](https://badge.fury.io/rb/structify)
+
+Structify is a Ruby gem that provides a simple DSL to define extraction schemas for LLM-powered models. It integrates seamlessly with Rails models, allowing you to specify versioning, assistant prompts, and field definitions—all in a clean, declarative syntax.
+
+## Features
+
+- 🎯 Simple DSL for defining LLM extraction schemas
+- 🔄 Built-in versioning for schema evolution
+- 📝 Support for custom assistant prompts
+- 🏗️ JSON Schema generation for LLM validation
+- 🔌 Seamless Rails/ActiveRecord integration
+- 💾 Automatic JSON attribute handling
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'structify'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install structify
+```
+
+## Usage
+
+### Basic Example
+
+Here's a simple example of using Structify in a Rails model:
+
+```ruby
+class Article < ApplicationRecord
+  include Structify::Model
+
+  schema_definition do
+    title "Article Extraction"
+    description "Extract key information from articles"
+    version 1
+
+    assistant_prompt "Extract the following fields from the article content"
+    llm_model "gpt-4"
+
+    field :title, :string, required: true
+    field :summary, :text, description: "A brief summary of the article"
+    field :category, :string, enum: ["tech", "business", "science"]
+  end
+end
+```
+
+### Advanced Example
+
+Here's a more complex example showing all available features:
+
+```ruby
+class EmailSummary < ApplicationRecord
+  include Structify::Model
+
+  schema_definition do
+    version 2  # Increment this when making breaking changes
+    title "Email Thread Extraction"
+    description "Extracts key information from email threads"
+
+    assistant_prompt <<~PROMPT
+      You are an assistant that extracts concise metadata from email threads.
+      Focus on producing a clear summary, action items, and sentiment analysis.
+      If there are multiple participants, include their roles in the conversation.
+    PROMPT
+
+    llm_model "gpt-4"  # Supports any LLM model
+
+    # Required fields
+    field :subject, :string,
+      required: true,
+      description: "The main topic or subject of the email thread"
+
+    field :summary, :text,
+      required: true,
+      description: "A concise summary of the entire thread"
+
+    # Optional fields with enums
+    field :sentiment, :string,
+      enum: ["positive", "neutral", "negative"],
+      description: "The overall sentiment of the conversation"
+
+    field :priority, :string,
+      enum: ["high", "medium", "low"],
+      description: "The priority level based on content and tone"
+
+    # Complex fields
+    field :participants, :json,
+      description: "List of participants and their roles"
+
+    field :action_items, :json,
+      description: "Array of action items extracted from the thread"
+
+    field :next_steps, :string,
+      description: "Recommended next steps based on the thread"
+  end
+
+  # You can still use regular ActiveRecord features
+  validates :subject, presence: true
+  validates :summary, length: { minimum: 10 }
+end
+```
+
+### Accessing Schema Information
+
+Structify provides several helper methods to access schema information:
+
+```ruby
+# Get the JSON Schema
+EmailSummary.json_schema
+# => {
+#   name: "Email Thread Extraction",
+#   description: "Extracts key information from email threads",
+#   parameters: {
+#     type: "object",
+#     required: ["subject", "summary"],
+#     properties: {
+#       subject: { type: "string" },
+#       summary: { type: "text" },
+#       sentiment: {
+#         type: "string",
+#         enum: ["positive", "neutral", "negative"]
+#       },
+#       # ...
+#     }
+#   }
+# }
+
+# Get the current version
+EmailSummary.extraction_version  # => 2
+
+# Get the assistant prompt
+EmailSummary.extraction_assistant_prompt
+# => "You are an assistant that extracts concise metadata..."
+
+# Get the LLM model
+EmailSummary.extraction_llm_model  # => "gpt-4"
+```
+
+### Working with Extracted Data
+
+Structify uses the `attr_json` gem to handle JSON attributes. All fields are stored in the `extracted_data` JSON column:
+
+```ruby
+# Create a new record with extracted data
+summary = EmailSummary.create(
+  subject: "Project Update",
+  summary: "Team discussed Q2 goals",
+  sentiment: "positive",
+  priority: "high",
+  participants: [
+    { name: "Alice", role: "presenter" },
+    { name: "Bob", role: "reviewer" }
+  ]
+)
+
+# Access fields directly
+summary.subject      # => "Project Update"
+summary.sentiment    # => "positive"
+summary.participants # => [{ name: "Alice", ... }]
+
+# Validate enum values
+summary.sentiment = "invalid"
+summary.valid?  # => false
+```
+
+## Database Setup
+
+Ensure your model has a JSON column named `extracted_data`:
+
+```ruby
+class CreateEmailSummaries < ActiveRecord::Migration[7.1]
+  def change
+    create_table :email_summaries do |t|
+      t.json :extracted_data  # Required by Structify
+      t.timestamps
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin feature/my-new-feature`)
+5. Create a new Pull Request
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kieranklaassen/structify.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Structify project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+```
+
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "structify"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/structify/model.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+require "active_support/core_ext/class/attribute"
+require "attr_json"
+
+module Structify
+  # The Model module provides a DSL for defining LLM extraction schemas in your Rails models.
+  # It allows you to define fields, versioning, and assistant prompts for LLM-based data extraction.
+  #
+  # @example
+  #   class Article < ApplicationRecord
+  #     include Structify::Model
+  #
+  #     schema_definition do
+  #       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"
+  #       field :category, :string, enum: ["tech", "business", "science"]
+  #     end
+  #   end
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+      include AttrJson::Record
+      class_attribute :schema_builder, instance_writer: false, default: nil
+
+      # Store all extracted data in the extracted_data JSON column
+      attr_json_config(default_container_attribute: :extracted_data)
+    end
+
+    # Class methods added to the including class
+    module ClassMethods
+      # Define the schema for LLM extraction
+      #
+      # @yield [void] The schema definition block
+      # @return [void]
+      def schema_definition(&block)
+        self.schema_builder ||= SchemaBuilder.new(self)
+        schema_builder.instance_eval(&block) if block_given?
+      end
+
+      # Get the JSON schema representation
+      #
+      # @return [Hash] The JSON schema
+      def json_schema
+        schema_builder&.to_json_schema
+      end
+
+      # Get the current extraction version
+      #
+      # @return [Integer] The version number
+      def extraction_version
+        schema_builder&.version_number
+      end
+
+      # Get the assistant prompt
+      #
+      # @return [String] The assistant prompt
+      def extraction_assistant_prompt
+        schema_builder&.assistant_prompt_str
+      end
+
+      # Get the LLM model name
+      #
+      # @return [String] The model name
+      def extraction_llm_model
+        schema_builder&.model_name
+      end
+    end
+  end
+
+  # Builder class for constructing the schema
+  class SchemaBuilder
+    # @return [Class] The model class
+    # @return [Array<Hash>] The field definitions
+    # @return [String] The schema title
+    # @return [String] The schema description
+    # @return [String] The assistant prompt
+    # @return [String] The LLM model name
+    # @return [Integer] The schema version
+    attr_reader :model, :fields, :title_str, :description_str,
+                :assistant_prompt_str, :model_name, :version_number
+
+    # Initialize a new SchemaBuilder
+    #
+    # @param model [Class] The model class
+    def initialize(model)
+      @model = model
+      @fields = []
+      @assistant_prompt_str = nil
+      @model_name = nil
+      @version_number = 1
+    end
+
+    # Set the schema title
+    #
+    # @param name [String] The title
+    # @return [void]
+    def title(name)
+      @title_str = name
+    end
+
+    # Set the schema description
+    #
+    # @param desc [String] The description
+    # @return [void]
+    def description(desc)
+      @description_str = desc
+    end
+
+    # Set the schema version
+    #
+    # @param num [Integer] The version number
+    # @return [void]
+    def version(num)
+      @version_number = num
+      model.attribute :version, :integer, default: num
+    end
+
+    # Set the assistant prompt
+    #
+    # @param prompt [String] The prompt text
+    # @return [void]
+    def assistant_prompt(prompt)
+      @assistant_prompt_str = prompt.strip
+    end
+
+    # Set the LLM model name
+    #
+    # @param name [String] The model name
+    # @return [void]
+    def llm_model(name)
+      @model_name = name
+    end
+
+    # Define a field in the schema
+    #
+    # @param name [Symbol] The field name
+    # @param type [Symbol] The field type
+    # @param required [Boolean] Whether the field is required
+    # @param description [String] The field description
+    # @param enum [Array] Possible values for the field
+    # @return [void]
+    def field(name, type, required: false, description: nil, enum: nil)
+      fields << {
+        name: name,
+        type: type,
+        required: required,
+        description: description,
+        enum: enum
+      }
+
+      model.attr_json name, type
+    end
+
+    # Generate the JSON schema representation
+    #
+    # @return [Hash] The JSON schema
+    def to_json_schema
+      required_fields = fields.select { |f| f[:required] }.map { |f| f[:name].to_s }
+      properties_hash = fields.each_with_object({}) do |f, hash|
+        prop = { type: f[:type].to_s }
+        prop[:description] = f[:description] if f[:description]
+        prop[:enum] = f[:enum] if f[:enum]
+        hash[f[:name].to_s] = prop
+      end
+
+      {
+        name: title_str,
+        description: description_str,
+        parameters: {
+          type: "object",
+          required: required_fields,
+          properties: properties_hash
+        }
+      }
+    end
+  end
+end

data/lib/structify/version.rb

@@ -0,0 +1,3 @@
+module Structify
+  VERSION = "0.1.0"
+end

data/lib/structify.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "structify/version"
+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.
+#
+# @example
+#   class Article < ApplicationRecord
+#     include Structify::Model
+#
+#     schema_definition do
+#       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"
+#       field :category, :string, enum: ["tech", "business", "science"]
+#     end
+#   end
+module Structify
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/structify.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/structify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "structify"
+  spec.version       = Structify::VERSION
+  spec.authors       = ["Kieran Klaassen"]
+  spec.email         = ["kieranklaassen@gmail.com"]
+
+  spec.summary       = %q{A DSL for defining extraction schemas for LLM-powered models}
+  spec.description   = %q{Structify provides a simple DSL to integrate with Rails models for LLM extraction, including versioning, assistant prompts, and more}
+  spec.homepage      = "https://github.com/kieranklaassen/structify"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # 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)/}) }
+  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 "attr_json", "~> 2.1"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: structify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kieran Klaassen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: attr_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Structify provides a simple DSL to integrate with Rails models for LLM
+  extraction, including versioning, assistant prompts, and more
+email:
+- kieranklaassen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/structify.rb
+- lib/structify/model.rb
+- lib/structify/version.rb
+- structify.gemspec
+homepage: https://github.com/kieranklaassen/structify
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kieranklaassen/structify
+  source_code_uri: https://github.com/kieranklaassen/structify
+  changelog_uri: https://github.com/kieranklaassen/structify/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A DSL for defining extraction schemas for LLM-powered models
+test_files: []