easy_talk 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8455d741b05a1a65ca7ea3f7e2d529271414fb04881066cc81bbb444399e200c
-  data.tar.gz: 9814e429530dbb42da5a3cca3310175ebe98038d91d5b7deeddcd68aa90b3199
+  metadata.gz: d4dbef0c74efa9996294e1aa20f5beef89d7d418df8be196cd794ece88c5ec67
+  data.tar.gz: 79b1c90879f26967e94e56317fff93e39bc1735e41a5c5975a3a922e556c2291
 SHA512:
-  metadata.gz: 5a85e59b3eaa7e0e9c2d57eb0283f2b4a45e6dfeb88778682738969617f751149aaf99cd93b4760c323eb84da476ac0ee8aba59eef003156d8d82aae60a940fd
-  data.tar.gz: 0c382d7989016e5a1c376439c96cd8b1d4acb7a6758a8fb2b406239551445ede641fb3a3ed64f833ce591409a75eefb0f3023a4a60cfffc92ca49ee5827bc24d
+  metadata.gz: 053a079d3b233f70bd62f63708c008b2da133d2210dfdde206708a588387ee844cab5e8409a5ac7afc635ccb909dbfd82b952e6608ec79333781f2278b9c56ce
+  data.tar.gz: 9af64bd32362f6518c2576aa793047b4252e47b18a92e0edfae9b937c92d56c63ba0582146ddc86823c0cacd98ead9e4ecb83f01624e22ad93cf58d36b42c4d0

data/.rubocop.yml

@@ -27,4 +27,7 @@ Layout/LineLength:
   
 RSpec/DescribeClass:
   Exclude:
-    - 'spec/easy_talk/examples/**/*'
+    - 'spec/easy_talk/examples/**/*'
+
+RSpec/MultipleExpectations:
+  Max: 4

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [0.2.2] - 2024-05-17
+- Fixed a bug where optional properties were not excluded from the required list.
+
+## [0.2.1] - 2024-05-06
+- Run JSON Schema validations using ActiveModel's validations.
+
 ## [0.2.0] - 2024-05-01
 - Added ActiveModel::API functionality to EasyTalk::Model module. That means you get all the benefits of ActiveModel::API including attribute assignment, introspections, validations, translation (i18n) and more. See https://api.rubyonrails.org/classes/ActiveModel/API.html for more information.
 

data/README.md

@@ -1,6 +1,16 @@
 # EasyTalk
 
-EasyTalk is a Ruby library for defining and generating JSON Schema.
+EasyTalk is a Ruby library that simplifies defining and generating JSON Schema documents, and validates that JSON data conforms to these schemas.
+
+Key Features
+* Intuitive Schema Definition: Use Ruby classes and methods to define JSON Schema documents easily.
+* JSON Schema Compliance: Implements the JSON Schema specification to ensure compatibility and standards adherence.
+* LLM Function Support: Ideal for integrating with Large Language Models (LLMs) such as OpenAI's GPT-3.5-turbo and GPT-4. EasyTalk enables you to effortlessly create JSON Schema documents needed to describe the inputs and outputs of LLM function calls.
+* Validation: Validates JSON inputs and outputs against defined schemas to ensure they meet expected formats and types. Write custom validations using ActiveModel's validations.
+* Integration with ActiveModel: EasyTalk integrates with ActiveModel to provide additional functionality such as attribute assignment, introspections, validations, translation (i18n), and more.
+
+Inspiration
+Inspired by Python's Pydantic library, EasyTalk brings similar functionality to the Ruby ecosystem, providing a Ruby-friendly approach to JSON Schema operations.
 
 Example Use:
 

data/docs/.gitignore

@@ -0,0 +1,5 @@
+_site
+.sass-cache
+.jekyll-cache
+.jekyll-metadata
+vendor

data/docs/404.html

@@ -0,0 +1,25 @@
+---
+permalink: /404.html
+layout: default
+---
+
+<style type="text/css" media="screen">
+  .container {
+    margin: 10px auto;
+    max-width: 600px;
+    text-align: center;
+  }
+  h1 {
+    margin: 30px 0;
+    font-size: 4em;
+    line-height: 1;
+    letter-spacing: -1px;
+  }
+</style>
+
+<div class="container">
+  <h1>404</h1>
+
+  <p><strong>Page not found :(</strong></p>
+  <p>The requested page could not be found.</p>
+</div>

data/docs/Gemfile

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+# gem "jekyll", "~> 4.3.3"
+gem 'github-pages', group: :jekyll_plugins
+
+gem 'webrick'
+# This is the default theme for new Jekyll sites. You may change this to anything you like.
+gem 'minima', '~> 2.5'
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+# gem "github-pages", group: :jekyll_plugins
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem 'jekyll-feed', '~> 0.12'
+end
+
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+  gem 'tzinfo', '>= 1', '< 3'
+  gem 'tzinfo-data'
+end
+
+# Performance-booster for watching directories on Windows
+gem 'wdm', '~> 0.1.1', platforms: %i[mingw x64_mingw mswin]
+
+# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
+# do not have a Java counterpart.
+gem 'http_parser.rb', '~> 0.6.0', platforms: [:jruby]

data/docs/_config.yml

@@ -0,0 +1,53 @@
+# Welcome to Jekyll!
+#
+# This config file is meant for settings that affect your whole blog, values
+# which you are expected to set up once and rarely edit after that. If you find
+# yourself editing this file very often, consider using Jekyll's data files
+# feature for the data you need to update frequently.
+#
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
+#
+# If you need help with YAML syntax, here are some quick references for you:
+# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
+# https://learnxinyminutes.com/docs/yaml/
+#
+# Site settings
+# These are used to personalize your new site. If you look in the HTML files,
+# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+
+title: EasyTalk 
+email: bayona.sergio@gmail.com
+description: >- # this means to ignore newlines until "baseurl:"
+  EasyTalk: define and generate JSON Schema documents.
+baseurl: "/easy_talk" # the subpath of your site, e.g. /blog
+url: "https://sergiobayona.github.io" # the base hostname & protocol for your site, e.g. http://example.com
+twitter_username: sergiobayona
+github_username:  sergiobayona
+
+# Build settings
+theme: minima
+plugins:
+  - jekyll-feed
+
+# Exclude from processing.
+# The following items will not be processed, by default.
+# Any item listed under the `exclude:` key here will be automatically added to
+# the internal "default list".
+#
+# Excluded items can be processed by explicitly listing the directories or
+# their entries' file path in the `include:` list.
+#
+# exclude:
+#   - .sass-cache/
+#   - .jekyll-cache/
+#   - gemfiles/
+#   - Gemfile
+#   - Gemfile.lock
+#   - node_modules/
+#   - vendor/bundle/
+#   - vendor/cache/
+#   - vendor/gems/
+#   - vendor/ruby/

data/docs/_posts/2024-05-07-welcome-to-jekyll.markdown

@@ -0,0 +1,29 @@
+---
+layout: post
+title:  "Welcome to Jekyll!"
+date:   2024-05-07 18:39:19 -0500
+categories: jekyll update
+---
+You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated.
+
+Jekyll requires blog post files to be named according to the following format:
+
+`YEAR-MONTH-DAY-title.MARKUP`
+
+Where `YEAR` is a four-digit number, `MONTH` and `DAY` are both two-digit numbers, and `MARKUP` is the file extension representing the format used in the file. After that, include the necessary front matter. Take a look at the source for this post to get an idea about how it works.
+
+Jekyll also offers powerful support for code snippets:
+
+{% highlight ruby %}
+def print_hi(name)
+  puts "Hi, #{name}"
+end
+print_hi('Tom')
+#=> prints 'Hi, Tom' to STDOUT.
+{% endhighlight %}
+
+Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll’s GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll Talk][jekyll-talk].
+
+[jekyll-docs]: https://jekyllrb.com/docs/home
+[jekyll-gh]:   https://github.com/jekyll/jekyll
+[jekyll-talk]: https://talk.jekyllrb.com/

data/docs/about.markdown

@@ -0,0 +1,18 @@
+---
+layout: page
+title: About
+permalink: /about/
+---
+
+This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at [jekyllrb.com](https://jekyllrb.com/)
+
+You can find the source code for Minima at GitHub:
+[jekyll][jekyll-organization] /
+[minima](https://github.com/jekyll/minima)
+
+You can find the source code for Jekyll at GitHub:
+[jekyll][jekyll-organization] /
+[jekyll](https://github.com/jekyll/jekyll)
+
+
+[jekyll-organization]: https://github.com/jekyll

data/docs/index.markdown

@@ -0,0 +1,7 @@
+---
+# Feel free to add content and custom Front Matter to this file.
+# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
+
+layout: home
+---
+EasyTalk is a Ruby library that simplifies defining and generating JSON Schema documents, and validates that JSON data conforms to these schemas.

data/lib/easy_talk/builders/object_builder.rb

@@ -34,36 +34,49 @@ module EasyTalk
       private
 
       def properties_from_schema_definition
-        properties = schema.delete(:properties) || {}
-        properties.each_with_object({}) do |(property_name, options), context|
-          add_required_property(property_name, options)
-          context[property_name] = build_property(property_name, options)
+        @properties_from_schema_definition ||= begin
+          properties = schema.delete(:properties) || {}
+          properties.each_with_object({}) do |(property_name, options), context|
+            add_required_property(property_name, options)
+            context[property_name] = build_property(property_name, options)
+          end
         end
       end
 
       # rubocop:disable Style/DoubleNegation
       def add_required_property(property_name, options)
         return if options.is_a?(Hash) && !!(options[:type].respond_to?(:nilable?) && options[:type].nilable?)
-
         return if options.respond_to?(:optional?) && options.optional?
+        return if options.is_a?(Hash) && options.dig(:constraints, :optional)
 
         @required_properties << property_name
       end
       # rubocop:enable Style/DoubleNegation
 
       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])
+        @property_cache ||= {}
+
+        @property_cache[property_name] ||= if options.is_a?(EasyTalk::SchemaDefinition)
+                                             ObjectBuilder.new(options).build
+                                           else
+                                             handle_option_type(options)
+                                             Property.new(property_name, options[:type], options[:constraints])
+                                           end
+      end
+
+      def handle_option_type(options)
+        if options[:type].respond_to?(:nilable?) && options[:type].nilable? && options[:type].unwrap_nilable.class != T::Types::TypedArray
+          options[:type] = options[:type].unwrap_nilable.raw_type
         end
       end
 
       def subschemas_from_schema_definition
-        subschemas = schema.delete(:subschemas) || []
-        subschemas.each do |subschema|
-          add_definitions(subschema)
-          add_references(subschema)
+        @subschemas_from_schema_definition ||= begin
+          subschemas = schema.delete(:subschemas) || []
+          subschemas.each do |subschema|
+            add_definitions(subschema)
+            add_references(subschema)
+          end
         end
       end
 

data/lib/easy_talk/model.rb

@@ -7,48 +7,55 @@ require 'active_support/time'
 require 'active_support/concern'
 require 'active_support/json'
 require 'active_model'
-require 'json-schema'
+require 'json_schemer'
+require_relative 'schema_errors_mapper'
 require_relative 'builders/object_builder'
 require_relative 'schema_definition'
 
 module EasyTalk
-  # The Model module can be included in a class to add JSON schema definition and generation support.
+  # The `Model` module is a mixin that provides functionality for defining and accessing the schema of a model.
+  #
+  # It includes methods for defining the schema, retrieving the schema definition,
+  # and generating the JSON schema for the model.
+  #
+  # Example usage:
+  #
+  #   class Person
+  #     include EasyTalk::Model
+  #
+  #     define_schema do
+  #       property :name, String, description: 'The person\'s name'
+  #       property :age, Integer, description: 'The person\'s age'
+  #     end
+  #   end
+  #
+  #   Person.json_schema #=> returns the JSON schema for Person
+  #   jim = Person.new(name: 'Jim', age: 30)
+  #   jim.valid? #=> returns true
+  #
+  # @see SchemaDefinition
   module Model
-    # The `Model` module is a mixin that provides functionality for defining and accessing the schema of a model.
-    #
-    # It includes methods for defining the schema, retrieving the schema definition,
-    # and generating the JSON schema for the model.
-    #
-    # Example usage:
-    #
-    #   class Person
-    #     include EasyTalk::Model
-    #
-    #     define_schema do
-    #       property :name, String, description: 'The person\'s name'
-    #       property :age, Integer, description: 'The person\'s age'
-    #     end
-    #   end
-    #
-    #   Person.json_schema #=> returns the JSON schema for Person
-    #   jim = Person.new(name: 'Jim', age: 30)
-    #   jim.valid? #=> returns true
-    #
-    # @see SchemaDefinition
-    #
     def self.included(base)
       base.include ActiveModel::API # Include ActiveModel::API in the class including EasyTalk::Model
+      base.include ActiveModel::Validations
+      base.extend ActiveModel::Callbacks
+      base.validates_with SchemaValidator
       base.extend(ClassMethods)
     end
 
-    # Checks if the model is valid.
-    #
-    # This method calls the `validate_json` class method on the current class,
-    # passing the `properties` as the argument.
-    #
-    # @return [Boolean] true if the model is valid, false otherwise.
-    def valid?
-      self.class.validate_json(properties)
+    class SchemaValidator < ActiveModel::Validator
+      def validate(record)
+        result = schema_validation(record)
+        result.errors.each do |key, error_msg|
+          record.errors.add key.to_sym, error_msg
+        end
+      end
+
+      def schema_validation(record)
+        schema = JSONSchemer.schema(record.class.json_schema)
+        errors = schema.validate(record.properties)
+        SchemaErrorsMapper.new(errors)
+      end
     end
 
     # Returns the properties of the model as a hash with symbolized keys.
@@ -94,14 +101,6 @@ module EasyTalk
         end
       end
 
-      # Validates the given JSON against the model's JSON schema.
-      #
-      # @param json [Hash] The JSON to validate.
-      # @return [Boolean] `true` if the JSON is valid, `false` otherwise.
-      def validate_json(json)
-        JSON::Validator.validate(json_schema, json)
-      end
-
       # Returns the JSON schema for the model.
       #
       # @return [Hash] The JSON schema for the model.

data/lib/easy_talk/property.rb

@@ -76,10 +76,16 @@ module EasyTalk
     #
     # @return [Object] The built property.
     def build
-      return type.respond_to?(:schema) ? type.schema : 'object' unless builder
+      # return type.respond_to?(:schema) ? type.schema : 'object' unless builder
 
-      args = builder.collection_type? ? [name, type, constraints] : [name, constraints]
-      builder.new(*args).build
+      # args = builder.collection_type? ? [name, type, constraints] : [name, constraints]
+      # builder.new(*args).build
+      if builder
+        args = builder.collection_type? ? [name, type, constraints] : [name, constraints]
+        builder.new(*args).build
+      else
+        type.respond_to?(:schema) ? type.schema : 'object'
+      end
     end
 
     # Converts the object to a JSON representation.
@@ -97,7 +103,7 @@ module EasyTalk
     #
     # @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]
+      @builder ||= TYPE_TO_BUILDER[type.class.name.to_s] || TYPE_TO_BUILDER[type.name.to_s]
     end
   end
 end

data/lib/easy_talk/schema_errors_mapper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module EasyTalk
+  class SchemaErrorsMapper
+    def initialize(errors)
+      @errors = errors.to_a
+    end
+
+    def errors
+      @errors.each_with_object({}) do |error, hash|
+        if error['data_pointer'].present?
+          key = error['data_pointer'].split('/').compact_blank.join('.')
+          hash[key] = error['error']
+        else
+          error['details']['missing_keys'].each do |missing_key|
+            message = "#{error['error'].split(':').first}: #{missing_key}"
+            hash[missing_key] = message
+          end
+        end
+      end
+    end
+  end
+end

data/lib/easy_talk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_talk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Sergio Bayona
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-01 00:00:00.000000000 Z
+date: 2024-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: json-schema
+  name: json_schemer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -191,6 +191,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- docs/.gitignore
+- docs/404.html
+- docs/Gemfile
+- docs/_config.yml
+- docs/_posts/2024-05-07-welcome-to-jekyll.markdown
+- docs/about.markdown
+- docs/index.markdown
 - lib/easy_talk.rb
 - lib/easy_talk/builders/all_of_builder.rb
 - lib/easy_talk/builders/any_of_builder.rb
@@ -213,6 +220,7 @@ files:
 - lib/easy_talk/model.rb
 - lib/easy_talk/property.rb
 - lib/easy_talk/schema_definition.rb
+- lib/easy_talk/schema_errors_mapper.rb
 - lib/easy_talk/sorbet_extension.rb
 - lib/easy_talk/tools/function_builder.rb
 - lib/easy_talk/types/all_of.rb