easy_talk 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f412e6a4ef70f8a8912def5e60e4f9a2fbb80a47c0f22e7f46af9caed9d153fa
-  data.tar.gz: ee7bfc2e77fef086bff23db293eec6f6d7f47ed47488a803737e2831895feb88
+  metadata.gz: da6e2b2c29860236280b654d18e4df4af908ab0246f01e1e5e376805f8359d37
+  data.tar.gz: 1a36d4e08f82069391386c3b2bd03becfeaea198657b8db05ff2ebda793d4ec8
 SHA512:
-  metadata.gz: feb1884f28b4c0400ccbe3fb651f2d87e4650a25180ed804bab8c7b2493ebc7f0d7fb769271788a7dc0e0e6cdc6c2793fb1cbaa064df881aef2d797242b70860
-  data.tar.gz: 1c2ac812a423169c0bc0d43afac4f86711acad7bbab28aeb40e249df65258be4cb845903edc585d43f835b2717b9fc4003817b0ae2c704d20a28ff583290f3c5
+  metadata.gz: 9026006c5e296adf2f3a7c826757ffe4b17a1387c3621907442ac47293d2d7d89eb4779fe3863ef24f6a8fc34174a7b4e7e22d2aaf0a26a4534ddc65f08ab482
+  data.tar.gz: d3cd70fb2ac65241cf395606d0eae55e2282006578f4f78096f9e03256ae6fa91bd371b0874d20aa797667b4972be4ff91c5b38b4396ee1be89a3b4d057d4681

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,6 @@
+## [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/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/lib/easy_talk/builders/object_builder.rb

@@ -8,7 +8,7 @@ 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 },

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/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.8'
 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.8
 platform: ruby
 authors:
 - Sergio Bayona
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-16 00:00:00.000000000 Z
+date: 2024-04-24 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
@@ -93,7 +177,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- easy_talk.gemspec
 - lib/easy_talk.rb
 - lib/easy_talk/builders/all_of_builder.rb
 - lib/easy_talk/builders/any_of_builder.rb
@@ -146,7 +229,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.

data/easy_talk.gemspec

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/easy_talk/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'easy_talk'
-  spec.version = EasyTalk::VERSION
-  spec.authors = ['Sergio Bayona']
-  spec.email = ['bayona.sergio@gmail.com']
-
-  spec.summary = 'Generate json-schema from Ruby classes.'
-  spec.description = 'Generate json-schema from plain Ruby classes.'
-  spec.homepage = 'https://github.com/sergiobayona/easy_talk'
-  spec.license = 'MIT'
-  spec.required_ruby_version = '>= 3.2'
-
-  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/sergiobayona/easy_talk'
-  spec.metadata['changelog_uri'] = 'https://github.com/sergiobayona/easy_talk/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(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ spec/ .git .github Gemfile])
-    end
-  end
-
-  spec.require_paths = ['lib']
-
-  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 'rake', '~> 13.1'
-end