easy_talk 0.1.7 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f412e6a4ef70f8a8912def5e60e4f9a2fbb80a47c0f22e7f46af9caed9d153fa
-  data.tar.gz: ee7bfc2e77fef086bff23db293eec6f6d7f47ed47488a803737e2831895feb88
+  metadata.gz: cac3597b203d800e1c15c79ea019a6d81080dd5c5ed669dc96500e262a32a505
+  data.tar.gz: 626bb67445db8ffa2d41df7a0b82ceba30db827ed0cb610f4d1b382d161a5191
 SHA512:
-  metadata.gz: feb1884f28b4c0400ccbe3fb651f2d87e4650a25180ed804bab8c7b2493ebc7f0d7fb769271788a7dc0e0e6cdc6c2793fb1cbaa064df881aef2d797242b70860
-  data.tar.gz: 1c2ac812a423169c0bc0d43afac4f86711acad7bbab28aeb40e249df65258be4cb845903edc585d43f835b2717b9fc4003817b0ae2c704d20a28ff583290f3c5
+  metadata.gz: e58629e7e0b4aff314f04d0a0d14f3129e0af8b54c23c1d061d57464648aa97caaf2db514353fcf34713d1d14113eb13c599ccc28b6106a3c5f06cd4197671af
+  data.tar.gz: f3ba1ec6c87ff2028a5bd26f22ebade4446717c8d9e27702c94f5e4080fd951885dd033a0d4f88078d44849cb7b251fc1dbb303f9da84b2a592bf85c1daaf9ef

data/.rubocop.yml

@@ -1,5 +1,17 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
   TargetRubyVersion: 3.2
+  
+RSpec/FilePath:
+  SpecSuffixOnly: true
+
+RSpec/ExampleLength:
+  Max: 10
+  Exclude:
+    - 'spec/easy_talk/examples/**/*'
 
 Metrics/BlockLength:
   Exclude:
@@ -11,4 +23,8 @@ Lint/ConstantDefinitionInBlock:
 
 Layout/LineLength:
   Exclude:
-    - 'spec/**/*'
+    - 'spec/**/*'
+  
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/easy_talk/examples/**/*'

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [0.1.9] - 2024-04-29
+- Added the ability to describe an object schema withing the define_schema block. Example:
+```ruby
+...
+property :email, :object do
+    property :address, :string
+    property :verified, :boolean
+end
+```
+
+## [0.1.8] - 2024-04-24
+- mostly refactoring without changes to the public API.
+
 ## [0.1.7] - 2024-04-16
 - general cleanup and refactoring.
 

data/README.md

@@ -12,7 +12,10 @@ class User
     title "User"
     description "A user of the system"
     property :name, String, description: "The user's name", title: "Full Name"
-    property :email, String, description: "The user's email", format: "email", title: "Email Address"
+    property :email, :object do
+      property :address, String, format: "email", description: "The user's email", title: "Email Address"
+      property :verified, T::Boolean, description: "Whether the email is verified"
+    end
     property :group, String, enum: [1, 2, 3], default: 1, description: "The user's group"
     property :age, Integer, minimum: 18, maximum: 100, description: "The user's age"
     property :tags, T::Array[String], min_items: 1, unique_item: true, description: "The user's tags"
@@ -34,10 +37,23 @@ Calling `User.json_schema` will return the JSON Schema for the User class:
             "type": "string"
         },
         "email": {
-            "title": "Email Address",
-            "description": "The user's email",
-            "type": "string",
-            "format": "email"
+            "type": "object",
+            "properties": {
+                "address": {
+                    "title": "Email Address",
+                    "description": "The user's email",
+                    "type": "string",
+                    "format": "email"
+                },
+                "verified": {
+                    "type": "boolean",
+                    "description": "Whether the email is verified"
+                }
+            },
+            "required": [
+                "address",
+                "verified"
+            ]
         },
         "group": {
             "type": "number",

data/Rakefile

@@ -2,11 +2,10 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require 'rubocop/rake_task'
-
 RuboCop::RakeTask.new
 
 task default: %i[spec rubocop]

data/easy_talk.gemspec

@@ -34,6 +34,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport', '~> 7.0'
   spec.add_dependency 'json-schema', '~> 4'
   spec.add_dependency 'sorbet-runtime', '~> 0.5'
-  spec.add_development_dependency 'pry-byebug', '>= 3.10.1'
+  spec.add_development_dependency 'pry-byebug', '>= 3.10'
   spec.add_development_dependency 'rake', '~> 13.1'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-json_expectations', '~> 2.0'
+  spec.add_development_dependency 'rspec-mocks', '~> 3.13'
+  spec.add_development_dependency 'rubocop', '~> 1.21'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.29'
 end

data/lib/easy_talk/builders/object_builder.rb

@@ -8,10 +8,10 @@ module EasyTalk
     class ObjectBuilder < BaseBuilder
       extend T::Sig
 
-      attr_reader :klass, :schema
+      attr_reader :schema
 
       VALID_OPTIONS = {
-        properties: { type: T::Hash[Symbol, T.untyped], key: :properties },
+        properties: { type: T::Hash[T.any(Symbol, String), T.untyped], key: :properties },
         additional_properties: { type: T::Boolean, key: :additionalProperties },
         subschemas: { type: T::Array[T.untyped], key: :subschemas },
         required: { type: T::Array[Symbol], key: :required },
@@ -33,42 +33,58 @@ module EasyTalk
 
       private
 
-      def properties_from_schema_definition(properties)
+      def properties_from_schema_definition
+        properties = schema.delete(:properties) || {}
         properties.each_with_object({}) do |(property_name, options), context|
-          @required_properties << property_name unless options[:type].respond_to?(:nilable?) && options[:type].nilable?
-          context[property_name] = Property.new(property_name, options[:type], options[:constraints])
+          add_required_property(property_name, options)
+          context[property_name] = build_property(property_name, options)
         end
       end
 
-      def subschemas_from_schema_definition(subschemas)
+      def add_required_property(property_name, options)
+        return unless options.is_a?(Hash) && !(options[:type].respond_to?(:nilable?) && options[:type].nilable?)
+
+        @required_properties << property_name
+      end
+
+      def build_property(property_name, options)
+        if options.is_a?(EasyTalk::SchemaDefinition)
+          ObjectBuilder.new(options).build
+        else
+          Property.new(property_name, options[:type], options[:constraints])
+        end
+      end
+
+      def subschemas_from_schema_definition
+        subschemas = schema.delete(:subschemas) || []
         subschemas.each do |subschema|
-          definitions = subschema.items.each_with_object({}) do |item, hash|
-            hash[item.name] = item.schema
-          end
-          schema[:defs] = definitions
-          references = subschema.items.map do |item|
-            { '$ref': item.ref_template }
-          end
-          schema[subschema.name] = references
+          add_definitions(subschema)
+          add_references(subschema)
+        end
+      end
+
+      def add_definitions(subschema)
+        definitions = subschema.items.each_with_object({}) do |item, hash|
+          hash[item.name] = item.schema
+        end
+        schema[:defs] = definitions
+      end
+
+      def add_references(subschema)
+        references = subschema.items.map do |item|
+          { '$ref': item.ref_template }
         end
+        schema[subschema.name] = references
       end
 
       def options
-        subschemas_from_schema_definition(subschemas)
         @options = schema
-        @options[:properties] = properties_from_schema_definition(properties)
+        subschemas_from_schema_definition
+        @options[:properties] = properties_from_schema_definition
         @options[:required] = @required_properties
         @options.reject! { |_key, value| [nil, [], {}].include?(value) }
         @options
       end
-
-      def properties
-        schema.delete(:properties) || {}
-      end
-
-      def subschemas
-        schema.delete(:subschemas) || []
-      end
     end
   end
 end

data/lib/easy_talk/property.rb

@@ -17,6 +17,16 @@ require_relative 'builders/union_builder'
 
 # frozen_string_literal: true
 
+# EasyTalk module provides classes for building JSON schema properties.
+#
+# This module contains the `Property` class, which is used to build a JSON schema property.
+# It also defines a constant `TYPE_TO_BUILDER` which maps property types to their respective builders.
+#
+# Example usage:
+#   property = EasyTalk::Property.new(:name, 'String', minLength: 3, maxLength: 50)
+#   property.build
+#
+# @see EasyTalk::Property
 module EasyTalk
   # Property class for building a JSON schema property.
   class Property
@@ -56,22 +66,36 @@ module EasyTalk
       raise ArgumentError, 'property type is missing' if type.blank?
     end
 
+    # Builds the property based on the specified type, constraints, and builder.
+    #
+    # If the type responds to the `schema` method, it returns the schema of the type.
+    # Otherwise, it returns 'object'.
+    #
+    # If a builder is specified, it uses the builder to build the property.
+    # The arguments passed to the builder depend on whether the builder is a collection type or not.
+    #
+    # @return [Object] The built property.
     def build
-      if builder
-        if builder.collection_type?
-          builder.new(name, type, constraints).build
-        else
-          builder.new(name, constraints).build
-        end
-      else
-        type.respond_to?(:schema) ? type.schema : 'object'
-      end
+      return type.respond_to?(:schema) ? type.schema : 'object' unless builder
+
+      args = builder.collection_type? ? [name, type, constraints] : [name, constraints]
+      builder.new(*args).build
     end
 
+    # Converts the object to a JSON representation.
+    #
+    # @param _args [Array] Optional arguments
+    # @return [Hash] The JSON representation of the object
     def as_json(*_args)
       build.as_json
     end
 
+    # Returns the builder associated with the property type.
+    #
+    # The builder is responsible for constructing the property based on its type.
+    # It looks up the builder based on the type's class name or name.
+    #
+    # @return [Builder] The builder associated with the property type.
     def builder
       TYPE_TO_BUILDER[type.class.name.to_s] || TYPE_TO_BUILDER[type.name.to_s]
     end

data/lib/easy_talk/schema_definition.rb

@@ -32,10 +32,19 @@ module EasyTalk
       @schema[:subschemas] += subschemas
     end
 
-    sig { params(name: Symbol, type: T.untyped, constraints: T.untyped).void }
-    def property(name, type, **constraints)
+    sig do
+      params(name: T.any(Symbol, String), type: T.untyped, constraints: T.untyped, blk: T.nilable(T.proc.void)).void
+    end
+    def property(name, type, **constraints, &blk)
       @schema[:properties] ||= {}
-      @schema[:properties][name] = { type:, constraints: }
+
+      if block_given?
+        property_schema = SchemaDefinition.new(name)
+        property_schema.instance_eval(&blk)
+        @schema[:properties][name] = property_schema
+      else
+        @schema[:properties][name] = { type:, constraints: }
+      end
     end
   end
 end

data/lib/easy_talk/tools/function_builder.rb

@@ -2,7 +2,13 @@
 
 module EasyTalk
   module Tools
+    # FunctionBuilder is a module that builds a hash with the function type and function details.
+    # The return value is typically passed as argument to LLM function calling APIs.
     module FunctionBuilder
+      # Creates a new function object based on the given model.
+      #
+      # @param [Model] model The EasyTalk model containing the function details.
+      # @return [Hash] The function object.
       def self.new(model)
         {
           type: 'function',

data/lib/easy_talk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EasyTalk
-  VERSION = '0.1.7'
+  VERSION = '0.1.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_talk
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
 platform: ruby
 authors:
 - Sergio Bayona
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-16 00:00:00.000000000 Z
+date: 2024-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.10.1
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.10.1
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,90 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-json_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.29'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.29'
 description: Generate json-schema from plain Ruby classes.
 email:
 - bayona.sergio@gmail.com
@@ -146,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Generate json-schema from Ruby classes.