ollama_chat 0.0.62 → 0.0.63

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c3a369c576e25ace4f2d8eeac73b7fe180e80008fc287713f85a0db18d65873
-  data.tar.gz: 4b141d5b9e14fa584b87d5b09e9d6a2c13d1d0f13da197e7b76f659c8fe696ab
+  metadata.gz: 5d207c29d7838f0cb8bb885dfc93038d2c246eb63d829d0af2e0cdef4c404d3f
+  data.tar.gz: 3b70df18f2d302506614a56556ec0f98d2e814a3558a7bc141b73cc0716c5158
 SHA512:
-  metadata.gz: 7923dac4d8370ee08e5c6169cbcb7b3d5ad23c2fbfeb7cca43511bd371f47107e1dcd9fd804c6270d5f28943d8b38c0786d459d13bc74e969295e4833cf57a80
-  data.tar.gz: ec11915e20d4f5013c7d1850bcc10ac04133dfcc12dd29c77176abd1fdfa8ff44db416e4adea6ee40862fc8c59a9dd2d67ee8e073f8493b1bf1b3f626c4a4bec
+  metadata.gz: 9b2647b7371490991e879f6f48682a7e7e2a2c3d7ab0fafd41fc7275cd204f9bb288b0ca0e8b11d5be9b0c23b54c93d141e418f0495ce4782de2b0165df1a703
+  data.tar.gz: 83fa7ff6da22352d5d5af335e98975d423641ab3969e51f311068fd0912f4fb3494c22058c1a66e892cf1d11574cc705d9dc3c714ef50123ad555ca67011311b

data/CHANGES.md

@@ -1,5 +1,40 @@
 # Changes
 
+## 2026-02-09 v0.0.63
+
+- Added `OllamaChat::Utils::PathValidator` module with `assert_valid_path`
+  helper and `OllamaChat::InvalidPathError` exception
+- Refactored `FileContext`, `ReadFile`, and `WriteFile` tools to use new path
+  validation logic
+- Simplified `OllamaChat::Tools::FileContext` to use glob pattern only,
+  removing the `path` parameter
+- Added `ignore_case` flag to `execute_grep` tool with dynamic command
+  construction using `eval_template`
+- Renamed tool classes and files to more descriptive names:
+  - `browser.rb` → `browse.rb` (class `Browser` → `Browse`)
+  - `grep.rb` → `execute_grep.rb` (class `Grep` → `ExecuteGrep`)
+  - `weather.rb` → `get_current_weather.rb` (class `Weather` → `GetCurrentWeather`)
+  - `cve.rb` → `get_cve.rb` (class `CVE` → `GetCVE`)
+  - `endoflife.rb` → `get_endoflife.rb` (class `EndOfLife` → `GetEndoflife`)
+  - `location.rb` → `get_location.rb` (class `Location` → `GetLocation`)
+  - `file_reader.rb` → `read_file.rb` (class `FileReader` → `ReadFile`)
+  - `file_writer.rb` → `write_file.rb` (class `FileWriter` → `WriteFile`)
+- Updated `follow_chat.rb` to use `require_confirmation?` instead of `confirm?`
+  when checking tool confirmation
+- Added scheme whitelist to `ImportURL` tool with `schemes: [http, https]`
+  configuration
+- Introduced `read_file` tool with path validation and error handling
+- Added `run_tests` tool for executing RSpec or Test-Unit test suites with
+  configurable runner and coverage reporting
+- Added `vim_open_file` tool for remote Vim file opening with line range
+  support
+- Enhanced `OllamaChat::Vim` class with file opening and line/range selection
+  capabilities
+- Added `GemPathLookup` tool to find gem installation paths using Bundler
+- Added `valid_json?` method to `OllamaChat::Tools::Concern` for consistent
+  JSON validation
+- Implemented `ImportURL` tool for fetching web content
+
 ## 2026-02-07 v0.0.62
 
 **Tool Execution**  

data/lib/ollama_chat/chat.rb

@@ -95,27 +95,21 @@ class OllamaChat::Chat
     connect_ollama
     @model           = choose_model(@opts[?m], config.model.name)
     @model_options   = Ollama::Options[config.model.options]
-    model_system     = pull_model_unless_present(@model, @model_options)
-    embedding_enabled.set(config.embedding.enabled && !@opts[?E])
+    @model_system    = pull_model_unless_present(@model, @model_options)
     if @opts[?c]
       messages.load_conversation(@opts[?c])
     else
-      default = config.system_prompts.default? || model_system
-      if @opts[?s] =~ /\A\?/
-        change_system_prompt(default, system: @opts[?s])
-      else
-        system = OllamaChat::Utils::FileArgument.get_file_argument(@opts[?s], default:)
-        system.present? and messages.set_system_prompt(system)
-      end
+      setup_system_prompt
     end
+    embedding_enabled.set(config.embedding.enabled && !@opts[?E])
     @documents            = setup_documents
     @cache                = setup_cache
     @images               = []
     @kramdown_ansi_styles = configure_kramdown_ansi_styles
+    @enabled_tools        = default_enabled_tools
+    @tool_call_results    = {}
     init_chat_history
     @opts[?S] and init_server_socket
-    @enabled_tools = config.tools.to_h.map { |n, v| n.to_s if v[:default] }.compact
-    @tool_call_results = {}
   rescue ComplexConfig::AttributeMissing, ComplexConfig::ConfigurationSyntaxError => e
     fix_config(e)
   end
@@ -208,6 +202,25 @@ class OllamaChat::Chat
     interact_with_user
   end
 
+  # The vim method creates and returns a new Vim instance for interacting with
+  # a Vim server.
+  #
+  # This method initializes a Vim client that can be used to insert text into
+  # Vim buffers or open files in a running Vim server. It derives the server
+  # name from the provided argument or uses a default server name based on the
+  # current working directory.
+  #
+  # @param server_name [ String, nil ] the name of the Vim server to connect to
+  #   If nil or empty, a default server name is derived from the current
+  #   working directory
+  #
+  # @return [ OllamaChat::Vim ] a new Vim instance configured with the
+  #   specified server name
+  def vim(server_name = nil)
+    clientserver = config.vim?&.clientserver
+    OllamaChat::Vim.new(server_name, clientserver:)
+  end
+
   private
 
   # Handles user input commands and processes chat interactions.
@@ -248,7 +261,7 @@ class OllamaChat::Chat
       messages.list_conversation(n)
       :next
     when %r(^/last(?:\s+(\d*))?$)
-      n = $1.to_i if $1
+      n = $1.to_i.clamp(1..)
       messages.show_last(n)
       :next
     when %r(^/clear(?:\s+(messages|links|history|tags|all))?$)
@@ -370,8 +383,7 @@ class OllamaChat::Chat
       :next
     when %r(^/vim(?:\s+(.+))?$)
       if message = messages.last
-        clientserver = config.vim?&.clientserver
-        OllamaChat::Vim.new($1, clientserver:).insert message.content
+        vim($1).insert message.content
       else
         STDERR.puts "Warning: No message found to insert into Vim"
       end
@@ -702,8 +714,6 @@ class OllamaChat::Chat
     save_history
   end
 
-  private
-
   # The base_url method returns the Ollama server URL from command-line options
   # or environment configuration.
   #
@@ -738,6 +748,26 @@ class OllamaChat::Chat
     @ollama
   end
 
+  # Sets up the system prompt for the chat session.
+  #
+  # This method determines whether to use a default system prompt or a custom
+  # one specified via command-line options. If a custom system prompt is
+  # provided with a regex selector (starting with ?), it invokes the
+  # change_system_prompt method to handle the selection. Otherwise, it
+  # retrieves the system prompt from a file or uses the default value, then
+  # sets it in the message history.
+  #
+  # @return [ void ] this method returns nil after setting up the system prompt
+  def setup_system_prompt
+    default = config.system_prompts.default? || @model_system
+    if @opts[?s] =~ /\A\?/
+      change_system_prompt(default, system: @opts[?s])
+    else
+      system = OllamaChat::Utils::FileArgument.get_file_argument(@opts[?s], default:)
+      system.present? and messages.set_system_prompt(system)
+    end
+  end
+
   # The setup_documents method initializes the document processing pipeline by
   # configuring the embedding model and database connection.
   # It then loads specified documents into the system and returns the

data/lib/ollama_chat/env_config.rb

@@ -51,6 +51,14 @@ module OllamaChat
       end
     end
 
+    BROWSER = set do
+      description 'Browser to use'
+
+      default do
+        %w[ open xdg-open ].find { `which #{_1}` }.full?(:chomp)
+      end
+    end
+
     DIFF_TOOL = set do
       description 'Diff tool to apply changes with'
 
@@ -128,6 +136,16 @@ module OllamaChat
           description 'File to save the chat history in'
           default     XDG_CACHE_HOME + 'history.json'
         end
+
+        module TOOLS
+          description 'Tool specific configuration settings'
+
+          RUN_TESTS_TEST_RUNNER = set do
+            description 'Configured test runner for run_tests tool function'
+            default     'rspec'
+            required     true
+          end
+        end
       end
     end
   end

data/lib/ollama_chat/follow_chat.rb

@@ -103,43 +103,46 @@ class OllamaChat::FollowChat
     response.message.tool_calls.each do |tool_call|
       name = tool_call.function.name
       unless @chat.config.tools.attribute_set?(name)
-        STDERR.printf("Unknown tool named %s ignored => Skip.\n", name)
+        STDERR.printf("Unconfigured tool named %s ignored => Skip.\n", name)
+        next
+      end
+      unless OllamaChat::Tools.registered?(name)
+        STDERR.printf("Unregistered tool named %s ignored => Skip.\n", name)
         next
       end
       STDOUT.puts
       confirmed = true
-      if @chat.config.tools[name].confirm?
-        prompt = "I want to execute tool %s(%s)\n\nConfirm? (y/n) " % [
+      args = JSON.pretty_generate(tool_call.function.arguments)
+      if @chat.config.tools[name].require_confirmation?
+        prompt = "I want to execute tool %s\n%s\nConfirm? (y/n) " % [
           bold { name },
-          italic { JSON(tool_call.function.arguments) },
+          italic { args  },
         ]
         confirmed = @chat.ask?(prompt:) =~ /\Ay/i
+      else
+        STDOUT.puts "Executing tool %s\n%s" % [
+          bold { name },
+          italic { args  },
+        ]
       end
-      Infobar.busy(
-        label: 'Executing tool %s' % name,
-        frames: :braille7,
-        output: STDOUT,
-      ) do
-        result = nil
-        if confirmed
-          infobar.printf(
-            "%s Execution of tool %s(%s) confirmed.\n",
-            ?✅,
-            bold { name },
-            italic { JSON(tool_call.function.arguments) }
-          )
-          result = OllamaChat::Tools.registered[name].
-            execute(tool_call, chat: @chat, config: @chat.config)
-        else
-          result = JSON(
-            message: 'User denied confirmation!',
-            resolve: 'You **MUST** ask the user for instructions on how to proceed!!!',
-          )
-        end
-        @chat.tool_call_results[name] = result
+      result = nil
+      if confirmed
+        STDOUT.printf(
+          "\n%s Execution of tool %s confirmed.\n\n", ?✅, bold { name }
+        )
+        result = OllamaChat::Tools.registered[name].
+          execute(tool_call, chat: @chat, config: @chat.config)
+      else
+        result = JSON(
+          message: 'User denied confirmation!',
+          resolve: 'You **MUST** ask the user for instructions on how to proceed!!!',
+        )
+        STDOUT.printf(
+          "\n%s Execution of tool %s denied by user.\n", ?🚫, bold { name }
+        )
+        sleep 1
       end
-      infobar.finish message: "Executed tool #{bold { name }} %te %s"
-      infobar.newline
+      @chat.tool_call_results[name] = result
     end
   end
 

data/lib/ollama_chat/message_list.rb

@@ -113,7 +113,9 @@ class OllamaChat::MessageList
     end
     @messages =
       File.open(filename, 'r') do |output|
-        JSON(output.read).map { Ollama::Message.from_hash(_1) }
+        JSON(output.read).map {
+          Ollama::Message.from_hash(_1 | { 'content' => nil })
+        }
       end
     self
   end

data/lib/ollama_chat/ollama_chat_config/default_config.yml

@@ -98,13 +98,45 @@ tools:
     default: true
   file_context:
     default: false
-    confirm: true
+    require_confirmation: true
+    allowed:
+      - ./spec
   directory_structure:
     default: false
-    confirm: true
+    require_confirmation: true
     exclude:
       - corpus
       - pkg
   execute_grep:
     default: true
-    cmd: 'grep -m %{max_results} -r %{pattern} %{path}'
+    cmd: |
+      grep #{'-i' if ignore_case} -m #{max_results} -r #{pattern} #{path}
+  browse:
+    default: false
+  write_file:
+    default: false
+    require_confirmation: true
+    allowed:
+      - ./tmp
+  read_file:
+    default: false
+    require_confirmation: false
+    allowed:
+      - ./tmp
+      - ./lib
+      - ./spec
+  search_web:
+    default: true
+  import_url:
+    default: true
+    require_confirmation: true
+    schemes:
+      - http
+      - https
+  gem_path_lookup:
+    default: true
+  vim_open_file:
+    default: true
+  run_tests:
+    require_confirmation: true
+    default: true

data/lib/ollama_chat/tool_calling.rb

@@ -13,6 +13,27 @@ module OllamaChat::ToolCalling
     @enabled_tools.map { OllamaChat::Tools.registered[it]&.to_hash }.compact
   end
 
+  # The default_enabled_tools method returns an array of tool names that are
+  # configured as default tools.
+  #
+  # This method iterates through the configured tools and collects those that
+  # are registered and have the default flag set to true. Unregistered tools
+  # are skipped with a warning message.
+  #
+  # @return [Array<String>] a sorted array of tool names that are configured as
+  #   default tools
+  def default_enabled_tools
+    result = []
+    config.tools.each { |n, v|
+      if OllamaChat::Tools.registered?(n)
+        result << n.to_s if v.default
+      else
+        STDERR.puts "Skipping configuration for unregistered tool %s" % bold { n }
+      end
+    }
+    result
+  end
+
   # The configured_tools method returns an array of tool names configured for
   # the chat session.
   #
@@ -39,7 +60,11 @@ module OllamaChat::ToolCalling
   def list_tools
     configured_tools.each do |tool|
       enabled = @enabled_tools.member?(tool) ? ?✓ : ?☐
-      printf "%s %s\n", enabled, (enabled ? bold { tool } : tool)
+      require_confirmation = config.tools[tool].require_confirmation? ? ?? : ?☐
+      printf(
+        "%s %s %s\n",
+        enabled, require_confirmation, (enabled ? bold { tool } : tool)
+      )
     end
   end
 

data/lib/ollama_chat/tools/browse.rb

@@ -0,0 +1,86 @@
+require "shellwords"
+
+# A tool for opening URLs/files in the user's default browser application.
+#
+# This tool enables the chat client to open web URLs or local files in the
+# user's default browser, allowing users to view content directly in their
+# browser environment. It integrates with the Ollama tool calling system to
+# provide
+# seamless web browsing capabilities during chat interactions.
+class OllamaChat::Tools::Browse
+  include OllamaChat::Tools::Concern
+
+  def self.register_name = 'browse'
+
+  # Creates and returns a tool definition for opening URLs/files in the browser.
+  #
+  # This method constructs the function signature that describes what the tool
+  # does, its parameters, and required fields. The tool expects a URL parameter
+  # to be provided.
+  #
+  # @return [Ollama::Tool] a tool definition for opening URLs/files in the browser
+  def tool
+    Tool.new(
+      type: 'function',
+      function: Tool::Function.new(
+        name:,
+        description: <<~EOT,
+          Open a URL or file in the user\'s default browser application so they
+          can view the content directly
+        EOT
+        parameters: Tool::Function::Parameters.new(
+          type: 'object',
+          properties: {
+            url: Tool::Function::Parameters::Property.new(
+              type: 'string',
+              description: <<~EOT,
+                The URL or file to open in the user\'s browser for them to view
+                directly
+              EOT
+            ),
+          },
+          required: %w[url]
+        )
+      )
+    )
+  end
+
+  # Executes the browser opening operation.
+  #
+  # This method opens the specified URL or file in the user's default browser
+  # application. It handles the system call and returns the result status.
+  #
+  # @param tool_call [Ollama::Tool::Call] the tool call object containing function details
+  # @param opts [Hash] additional options
+  # @return [String] the execution result as JSON string
+  # @raise [StandardError] if there's an issue with opening the URL/file
+  def execute(tool_call, **opts)
+    url    = tool_call.function.arguments.url
+    result = browse_url(url)
+    {
+      success:    result.success?,
+      exitstatus: result.exitstatus,
+      message:    'opening URL/file',
+      url:        ,
+    }.to_json
+  rescue => e
+    { error: e.class, message: e.message }.to_json
+  end
+
+  private
+
+  # Opens a URL or file in the system browser.
+  #
+  # This method uses the system's default browser to open the provided URL or file.
+  # It respects the BROWSER environment variable if set, otherwise defaults to "open".
+  #
+  # @param url [String] the URL or file path to open
+  # @return [Process::Status] the process status of the system call
+  def browse_url(url)
+    browser = OllamaChat::EnvConfig::BROWSER? || "open"
+    system %{#{browser} #{Shellwords.escape(url)}}
+    $?
+  end
+
+  self
+end.register

data/lib/ollama_chat/tools/concern.rb

@@ -34,6 +34,22 @@ module OllamaChat::Tools::Concern
     self.class.register_name
   end
 
+  # The valid_json? method returns a proc that validates JSON data from a
+  # temporary file.
+  #
+  # @return [Proc] a proc that takes a temporary file and returns its JSON
+  #   content or raises an error
+  def valid_json?
+    -> tmp {
+      if data = tmp.read.full?
+        JSON.parse(data)
+        return data
+      else
+        raise JSON::ParserError, 'require JSON data'
+      end
+    }
+  end
+
   # The to_hash method converts the tool to a hash representation.
   #
   # @return [ Hash ] a hash representation of the tool

data/lib/ollama_chat/tools/endoflife.rb

@@ -1,74 +0,0 @@
-# A tool for fetching endoflife.date product information.
-#
-# This tool allows the chat client to retrieve endoflife.date information
-# for software products by ID. It integrates with the Ollama tool calling
-# system to provide lifecycle and support information to the language model.
-class OllamaChat::Tools::EndOfLife
-  include OllamaChat::Tools::Concern
-
-  def self.register_name = 'get_endoflife'
-
-  # Creates and returns a tool definition for getting endoflife information.
-  #
-  # This method constructs the function signature that describes what the tool
-  # does, its parameters, and required fields. The tool expects a product name
-  # parameter to be provided.
-  #
-  # @return [Ollama::Tool] a tool definition for retrieving endoflife information
-  def tool
-    Tool.new(
-      type: 'function',
-      function: Tool::Function.new(
-        name:,
-        description: 'Get the endoflife information for a product as JSON',
-        parameters: Tool::Function::Parameters.new(
-          type: 'object',
-          properties: {
-            product: Tool::Function::Parameters::Property.new(
-              type: 'string',
-              description: 'The product name to get endoflife information for'
-            ),
-          },
-          required: %w[product]
-        )
-      )
-    )
-  end
-
-  # Executes the endoflife lookup operation.
-  #
-  # This method fetches endoflife data from the endoflife.date API using the
-  # provided product name. It handles the HTTP request, parses the JSON response,
-  # and returns the structured data.
-  #
-  # @param tool_call [Ollama::Tool::Call] the tool call object containing function details
-  # @param opts [Hash] additional options
-  # @option opts [ComplexConfig::Settings] :config the configuration object
-  # @return [Hash, String] the parsed endoflife data as a hash or an error message
-  # @raise [StandardError] if there's an issue with the HTTP request or JSON parsing
-  def execute(tool_call, **opts)
-    config = opts[:config]
-    product = tool_call.function.arguments.product
-
-    # Construct the URL for the endoflife API
-    url = config.tools.get_endoflife.url % { product: }
-
-    # Fetch the data from endoflife.date API
-    OllamaChat::Utils::Fetcher.get(
-      url,
-      headers: {
-        'Accept' => 'application/json',
-        'User-Agent' => OllamaChat::Chat.user_agent
-      },
-      debug: OllamaChat::EnvConfig::OLLAMA::CHAT::DEBUG
-    ) do |tmp|
-      # Parse the JSON response
-      data = JSON.parse(tmp.read, object_class: JSON::GenericObject)
-      return data
-    end
-  rescue => e
-    "Failed to fetch endoflife data for #{product}: #{e.class}: #{e.message}"
-  end
-
-  self
-end.register

data/lib/ollama_chat/tools/{grep.rb → execute_grep.rb}

@@ -3,7 +3,7 @@
 # This tool allows the chat client to execute grep commands to search for
 # patterns in files. It integrates with the Ollama tool calling system to
 # provide file search capabilities within the language model's context.
-class OllamaChat::Tools::Grep
+class OllamaChat::Tools::ExecuteGrep
   include OllamaChat::Tools::Concern
 
   def self.register_name = 'execute_grep'
@@ -34,6 +34,10 @@ class OllamaChat::Tools::Grep
             max_results: Tool::Function::Parameters::Property.new(
               type: 'integer',
               description: 'Maximum number of matches to return (optional)'
+            ),
+            ignore_case: Tool::Function::Parameters::Property.new(
+              type: 'boolean',
+              description: 'Matches ignore case if true, (default: false)'
             )
           },
           required: %w[pattern]
@@ -54,20 +58,36 @@ class OllamaChat::Tools::Grep
   # @param tool_call [OllamaChat::Tool::Call] The tool call with arguments
   # @param opts [Hash] Additional options
   # @option opts [Hash] :config Configuration options including tool settings
-  # @return [Hash] The execution result with command and output
-  # @raise [StandardError] If the command execution fails
+  # @return [String] The execution result with command and output as JSON string
   def execute(tool_call, **opts)
     config      = opts[:config]
     args        = tool_call.function.arguments
     pattern     = Shellwords.escape(args.pattern)
     path        = Shellwords.escape(Pathname.new(args.path || '.').expand_path)
     max_results = args.max_results || 100
-    cmd         = config.tools.execute_grep.cmd % { max_results:, path:, pattern: }
+    ignore_case = args.ignore_case || false
+    cmd         = eval_template(config, pattern, path, max_results, ignore_case)
     result      = OllamaChat::Utils::Fetcher.execute(cmd, &:read)
     { cmd:, result: }.to_json
   rescue => e
     { error: e.class, message: e.message }.to_json
   end
 
+  private
+
+  # Evaluates a template string using the provided configuration and
+  # parameters.
+  #
+  # @param config [Object] the configuration object containing tool settings
+  # @param pattern [String] the regex pattern to search for
+  # @param path [String] the file or directory path to search in
+  # @param max_results [Integer] the maximum number of matches to return
+  # @param ignore_case [Boolean] whether to ignore case when searching
+  #
+  # @return [String] the evaluated template string with substituted variables
+  def eval_template(config, pattern, path, max_results, ignore_case)
+    eval('"%s"' % config.tools.execute_grep.cmd.chomp)
+  end
+
   self
 end.register