tool_tailor 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abc31d6d69830be0126f8b6f61aee408be9e17bdb91423b68e9166f30efaf21f
-  data.tar.gz: 7eb42498a63836eeac46c6996d2e32f34303430b58dcdd36cb89d833cbadeaef
+  metadata.gz: 33d87f65353ea72f0715a86b7759529f68f6678eb6a24d47fac0547bade1b59e
+  data.tar.gz: 874c949f555e93aa445147d89981e1207e11fdc4520977a668e9724354ca7d95
 SHA512:
-  metadata.gz: 04d10928c7453fbd20980d3c23a6bbbe8cf000baa25f2ffce903910b21607088762f300fde528ee4c7f0b8673ba58a65224926c261486ff033d87c5d25601468
-  data.tar.gz: 779238cd2409d9d6c669cab52f0d286fc79cf3c9335082d88bf62d871f23ec6439fe479f465d25fab0bd13d2285e6522ee026ea9e5257b019cda483244c28664
+  metadata.gz: 4500dc6778e3bb5373a4630160b22a2ad7f0669ddb097d221eb93b3f1c27a93b48310ef4fcc434ec2c154ea004beb84d157bd1550d4ada0eb1e8fe7b8daa83da
+  data.tar.gz: 036f48ffa4b31354b24c85392cf52520215afcb02afac201289e19e650f4491be5fa0122aca606fc6d421d833ee2b8a64533b53a5936ea90608d2197caecd2b2

data/Gemfile

@@ -5,3 +5,5 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
+
+gem "super_diff", "~> 0.9.0", :group => :test

data/Gemfile.lock

@@ -1,13 +1,17 @@
 PATH
   remote: .
   specs:
-    tool_tailor (0.1.2)
+    tool_tailor (0.1.3)
       yard (~> 0.9.36)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    attr_extras (7.1.0)
     diff-lcs (1.5.1)
+    optimist (3.1.0)
+    patience_diff (1.2.0)
+      optimist (~> 3.0)
     rake (12.3.3)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
@@ -22,6 +26,10 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
+    super_diff (0.9.0)
+      attr_extras (>= 6.2.4)
+      diff-lcs
+      patience_diff
     yard (0.9.36)
 
 PLATFORMS
@@ -30,6 +38,7 @@ PLATFORMS
 DEPENDENCIES
   rake (~> 12.0)
   rspec (~> 3.0)
+  super_diff (~> 0.9.0)
   tool_tailor!
 
 BUNDLED WITH

data/README.md

@@ -26,12 +26,15 @@ class TestClass
   #
   # @param location [String] The city and state, e.g., San Francisco, CA.
   # @param unit [String] The unit of temperature, either 'celsius' or 'fahrenheit'.
-  def get_current_weather(location, unit = 'celsius')
+  def get_current_weather(location:, unit: 'celsius')
     # Function implementation goes here
   end
 end
 
-# Unbound method
+# Simple
+ToolTailor.convert(TestClass.instance_method(:get_current_weather))
+
+# Unbound method with to_json_schema
 TestClass.instance_method(:get_current_weather).to_json_schema # => {
 #   "type" => "function",
 #   "function" => {
@@ -57,7 +60,7 @@ TestClass.instance_method(:get_current_weather).to_json_schema # => {
 #     }
 #   }
 
-# Bound method
+# Bound method with to_json_schema
 example_instance = TestClass.new
 example_instance.method(:get_current_weather).to_json_schema # => {
 #   "type" => "function",

data/lib/tool_tailor/version.rb

@@ -1,3 +1,3 @@
 module ToolTailor
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/tool_tailor.rb

@@ -10,28 +10,53 @@ module ToolTailor
   # @param function [Method, UnboundMethod] The function to convert.
   # @return [String] The JSON schema representation of the function.
   # @raise [ArgumentError] If the provided object is not a Method or UnboundMethod.
+  #
+  # @example
+  #   def example_method(param1, param2)
+  #     # method implementation
+  #   end
+  #
+  #   ToolTailor.convert(method(:example_method))
   def self.convert(function)
     unless function.is_a?(Method) || function.is_a?(UnboundMethod)
       raise ArgumentError, "Unsupported object type: #{function.class}"
     end
 
+    # Ensure only named arguments are allowed
+    unless function.parameters.all? { |type, _| type == :keyreq || type == :key }
+      raise ArgumentError, "Only named arguments are supported"
+    end
+
     file_path, line_number = function.source_location
     YARD.parse(file_path)
 
     method_path = "#{function.owner}##{function.name}"
     yard_object = YARD::Registry.at(method_path)
-    raise "Documentation for #{method_path} not found." if yard_object.nil?
 
-    function_description = yard_object.docstring
-
-    parameters = yard_object.tags("param").map do |tag|
+    # Extract parameters from the function definition
+    parameters = function.parameters.map do |_, name|
       {
-        name: tag.name,
-        type: type_mapping(tag.types.first),
-        description: tag.text
+        name: name.to_s,
+        type: "string",
+        description: ""
       }
     end
 
+    function_description = ""
+
+    if yard_object
+      function_description = yard_object.docstring
+
+      yard_object.tags("param").each do |tag|
+        param_name = tag.name.chomp(':')
+        param = parameters.find { |p| p[:name] == param_name }
+        if param
+          param[:type] = type_mapping(tag.types.first)
+          param[:description] = tag.text
+        end
+      end
+    end
+
     {
       type: "function",
       function: {
@@ -48,7 +73,7 @@ module ToolTailor
               }
             ]
           end.to_h,
-          required: parameters.map { |param| param[:name].to_s }
+          required: function.parameters.select { |type, _| type == :keyreq }.map { |_, name| name.to_s }
         }
       }
     }.to_json

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tool_tailor
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Kieran Klaassen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-23 00:00:00.000000000 Z
+date: 2024-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard