tool_tailor 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 840fcc0f9e8a7f5ccd4db0d8f4a8d88f2f344225d8f759442dc11f625d243300
-  data.tar.gz: 53289290ee809ea4e18acf08de8115d4c259b337823fd9ad506de6c335eb12db
+  metadata.gz: 908a6461c07d131d14e6bd8be1a3fa6fa578e4f0261110d084238dbc657e8f33
+  data.tar.gz: 65541821e6c287d82e1bffd57e04da0c541654ea3e8edc84621cc0fbfbe11604
 SHA512:
-  metadata.gz: 682eea6fb802c1a1444cafbe077577594cd682c7e02071313b56c7e737c738575b82098cbc6a4a63287edf449a0cd0aed9c4dcb225386350e4b2653270dac585
-  data.tar.gz: 8606a2abd5309a6ab9f7d7fdfa1910c953d674708aa9dce5c2e9fee29168f979632b3f4b8567dd2c5aba68d6fdfc18a2aebc000f464d63f20cc005c7c0452925
+  metadata.gz: 798fb99b7ac1fba192eec08684ac51d1f39f11e7bb6ff79757987a2aaabba1bb749ed865278dc37639e08ef6cd04b11de68f461ebbb0ee09433db3cb3d090f97
+  data.tar.gz: 4a2aeda57a2757776a05845d29fb1a09c479d2352820d5be0930c6b7b75c01c59f4712cd9367cda3e758e5c1d3c6d00385080b1768be256a1fde20ea73eb871d

data/README.md

@@ -29,21 +29,22 @@ class WeatherService
   # Get the current weather in a given location.
   #
   # @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')
+  # @param unit [String] The temperature unit to use. Infer this from the user's location.
+  # @values unit ["Celsius", "Fahrenheit"]
+  def get_current_temperature(location:, unit:)
     # Function implementation goes here
   end
 end
 
 # Convert an instance method
-schema = ToolTailor.convert(WeatherService.instance_method(:get_current_weather))
+schema = ToolTailor.convert(WeatherService.instance_method(:get_current_temperature))
 
 # Using to_json_schema on an unbound method
-schema = WeatherService.instance_method(:get_current_weather).to_json_schema
+schema = WeatherService.instance_method(:get_current_temperature).to_json_schema
 
 # Using to_json_schema on a bound method
 weather_service = WeatherService.new
-schema = weather_service.method(:get_current_weather).to_json_schema
+schema = weather_service.method(:get_current_temperature).to_json_schema
 ```
 
 ### Converting Classes

data/lib/tool_tailor/version.rb

@@ -1,3 +1,3 @@
 module ToolTailor
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/tool_tailor.rb

@@ -1,6 +1,7 @@
 require "tool_tailor/version"
 require "json"
 require "yard"
+require "yard_custom_tags"
 
 module ToolTailor
   class Error < StandardError; end
@@ -58,7 +59,8 @@ module ToolTailor
       {
         name: name.to_s,
         type: "string",
-        description: ""
+        description: "",
+        enum: nil
       }
     end
 
@@ -75,6 +77,12 @@ module ToolTailor
           param[:description] = tag.text
         end
       end
+
+      yard_object.tags("values").each do |tag|
+        param_name = tag.name.chomp(':')
+        param = parameters.find { |p| p[:name] == param_name }
+        param[:enum] = tag.text if param
+      end
     end
 
     {
@@ -89,8 +97,9 @@ module ToolTailor
               param[:name],
               {
                 type: param[:type],
-                description: param[:description]
-              }
+                description: param[:description],
+                enum: param[:enum]
+              }.compact
             ]
           end.to_h,
           required: method.parameters.select { |type, _| type == :keyreq }.map { |_, name| name.to_s }

data/lib/yard_custom_tags.rb

@@ -0,0 +1,46 @@
+require "yard"
+
+module YARD
+  module Tags
+    # Custom tag class for handling `@values` tags.
+    class ValuesTag < YARD::Tags::Tag
+      TAG_FORMAT = /^(\S+)\s+\[(.+)\]$/
+
+      def initialize(tag_name, text)
+        name, values = parse_text(text)
+        super(tag_name, values, nil, name)
+      end
+
+      private
+
+      # Parses the text to match the expected format and extract the name and values.
+      def parse_text(text)
+        match = text.match(TAG_FORMAT)
+        unless match
+          raise ArgumentError, "Invalid @values tag format. Expected: @values <name> [value1, value2, ...]. Values should be a JSON array."
+        end
+
+        name, values_text = match.captures
+        values = parse_values(values_text)
+        [name, values]
+      end
+
+      # Parses the values text as a JSON array to ensure correct types.
+      def parse_values(values_text)
+        json_text = "[#{values_text}]"
+        JSON.parse(json_text)
+      rescue JSON::ParserError => e
+        raise ArgumentError, "Invalid values format: #{e.message}"
+      end
+    end
+
+    class Library
+      def self.define_custom_tag
+        # Defines a new custom tag `@values` using the ValuesTag class.
+        YARD::Tags::Library.define_tag("Values", :values, ValuesTag)
+      end
+    end
+  end
+end
+
+YARD::Tags::Library.define_custom_tag

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tool_tailor
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Kieran Klaassen
@@ -45,6 +45,7 @@ files:
 - bin/setup
 - lib/tool_tailor.rb
 - lib/tool_tailor/version.rb
+- lib/yard_custom_tags.rb
 - tool_tailor.gemspec
 homepage: https://github.com/kieranklaassen/tool_tailor
 licenses: